Class: JekyllImgFlow::ManifestManager

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll-imgflow/manifest_manager.rb

Overview

Manages the manifest of generated images Tracks default vs specialized versions and page usage for cleanup

Constant Summary collapse

VERSION_TYPES = 
%w[default specialized].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site) ⇒ ManifestManager

Returns a new instance of ManifestManager.



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 14

def initialize(site)
  @site = site
  # Place manifest in _site - rebuilt on each Jekyll build
  @manifest_path = File.join(@site.dest, "assets", "images", "imgflow-manifest.json")
  @manifest = load_manifest
  @current_provider = current_provider

  # Check if provider changed and invalidate cache if needed
  handle_provider_change if provider_changed?
end

Instance Attribute Details

#manifest_path ⇒ Object (readonly)

Returns the value of attribute manifest_path.



12
13
14
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 12

def manifest_path
  @manifest_path
end

Instance Method Details

#cleanup_deleted_originals(current_originals) ⇒ Object

Clean up manifest entries for deleted original images

Parameters:

  • current_originals (Array<String>) —

    Array of current original image basenames



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 72

def cleanup_deleted_originals(current_originals)
  current_set = current_originals.to_set

  @manifest.each_key do |original_name|
    # Extract basename without extension
    basename = File.basename(original_name, ".*")

    # If original no longer exists, remove from manifest
    unless current_set.include?(basename)
      @manifest.delete(original_name)
      Jekyll.logger.debug "🗑️  Removed manifest entry for deleted original: #{original_name}"
    end
  end
end

#cleanup_orphans ⇒ Object

Cleanup orphaned specialized images



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 259

def cleanup_orphans
  orphans = find_orphans
  cleaned = []

  orphans.each do |orphan|
    output_file = if orphan["output"].start_with?("/")
                    orphan["output"]
                  else
                    File.join(@site.dest,
                              orphan["output"])
                  end
    if File.exist?(output_file)
      File.delete(output_file)
      cleaned << orphan["output"]
      Jekyll.logger.info "🗑️  Cleaned orphaned image: #{orphan['output']}"
    end

    # Remove from manifest
    versions = @manifest.dig(orphan["original"], "versions", "specialized") || []
    versions.reject! { |v| v["operations"] == orphan["operations"] }
  end

  cleaned
end

#current_provider ⇒ Object

Get current provider from site config



64
65
66
67
68
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 64

def current_provider
  config = JekyllImgFlow::Config.new(@site)
  # Get first available provider from backend_priority
  config.backend_priority&.first || "unknown"
end

#default_version?(original_name, operations) ⇒ Boolean

Check if image version is default type

Returns:

  • (Boolean) 


219
220
221
222
223
224
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 219

def default_version?(original_name, operations)
  return false unless @manifest[original_name]

  versions = @manifest.dig(original_name, "versions", "default") || []
  versions.any? { |v| v["operations"] == operations }
end

#find_orphans ⇒ Object

Find orphaned specialized images (not used on any page)



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 227

def find_orphans
  orphans = []

  @manifest.each do |original_name, data|
    specialized = data.dig("versions", "specialized") || []
    specialized.each do |version|
      next unless version["used_on"].nil? || version["used_on"].empty?

      orphans << {
        "original" => original_name,
        "output" => version["output"],
        "operations" => version["operations"]
      }
    end
  end

  orphans
end

#get_version_output(original_name, operations, type = :specialized) ⇒ Object

Get output path for a specific version



145
146
147
148
149
150
151
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 145

def get_version_output(original_name, operations, type = :specialized)
  return unless @manifest[original_name]

  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  version = versions.find { |v| v["operations"] == operations }
  version&.dig("output")
end

#get_versions(original_name) ⇒ Object

Get all versions for an original image



285
286
287
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 285

def get_versions(original_name)
  @manifest.dig(original_name, "versions") || { "default" => [], "specialized" => [] }
end

#handle_provider_change ⇒ Object

Handle provider change by invalidating cache and cleaning optimized directory



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 110

def handle_provider_change
  Jekyll.logger.warn "ImgFlow:",
                     "Provider changed from '#{@cached_provider}' to '#{@current_provider}'"
  Jekyll.logger.warn "ImgFlow:", "Invalidating cache and cleaning optimized directory..."

  # Get optimized directory path
  config = JekyllImgFlow::Config.new(@site)
  optimized_dir = File.join(@site.dest, config.output)

  # Safety guard: prevent deletion of _site itself
  raise "Refusing to delete optimized directory: path resolves to site dest or is empty" if optimized_dir == @site.dest || optimized_dir.empty?

  # Delete all files in optimized directory
  if Dir.exist?(optimized_dir)
    deleted_count = 0
    Dir.glob(File.join(optimized_dir, "**", "*")).each do |file|
      if File.file?(file)
        File.delete(file)
        deleted_count += 1
      end
    end
    Jekyll.logger.warn "ImgFlow:",
                       "Deleted #{deleted_count} cached images from optimized directory"
  end

  # Clear manifest cache
  @manifest.clear
  Jekyll.logger.warn "ImgFlow:",
                     "Manifest cache cleared - all images will be regenerated with '#{@current_provider}'"

  # Update cached provider to current
  @cached_provider = @current_provider
end

#load_manifest ⇒ Object

Load existing manifest or create new one



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 26

def load_manifest
  if File.exist?(@manifest_path)
    begin
      data = JSON.parse(File.read(@manifest_path))

      # Handle new format with provider at top level
      if data.is_a?(Hash) && data.key?("images")
        @cached_provider = data["provider"]
        data["images"] || {}
      else
        # Old format - just image data
        @cached_provider = nil
        data
      end
    rescue JSON::ParserError => e
      Jekyll.logger.warn "ImgFlow: Corrupt manifest file, starting fresh: #{e.message}"
      @cached_provider = nil
      {}
    end
  else
    @cached_provider = nil
    {}
  end
end

#provider_changed? ⇒ Boolean

Check if the provider has changed since the manifest was created

Returns:

  • (Boolean) 


101
102
103
104
105
106
107
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 101

def provider_changed?
  # If no cached provider, this is a new manifest
  return false if @cached_provider.nil?

  # Provider changed if current doesn't match cached
  @cached_provider != @current_provider
end

#register_version(original_name, output_path, operations, type, page_path, file_digest = nil, provider = nil) ⇒ Object

Register a new image version



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 175

def register_version(original_name, output_path, operations, type, page_path,
                     file_digest = nil, provider = nil)
  @manifest[original_name] ||= {
    "versions" => { "default" => [], "specialized" => [] },
    "file_digest" => file_digest # Store SHA256 digest of original file
  }

  # Update file digest if provided
  @manifest[original_name]["file_digest"] = file_digest if file_digest

  versions = @manifest[original_name]["versions"][type.to_s] ||= []

  # Find or create version entry
  version = versions.find { |v| v["operations"] == operations }

  # Normalize page_path to array
  page_paths = if page_path.is_a?(Array)
                 page_path
               else
                 (page_path ? [page_path] : [])
               end

  if version
    # Add pages to used_on list if not already present
    version["used_on"] ||= []
    page_paths.each do |path|
      version["used_on"] << path if path && !version["used_on"].include?(path)
    end
    # Update provider if provided
    version["provider"] = provider if provider
  else
    # Create new version entry
    versions << {
      "output" => output_path,
      "operations" => operations,
      "type" => type.to_s,
      "used_on" => page_paths,
      "created_at" => Time.now.to_i,
      "provider" => provider
    }
  end
end

#remove_page_usage(page_path) ⇒ Object

Remove page from all image version usage tracking



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 247

def remove_page_usage(page_path)
  @manifest.each_value do |data|
    VERSION_TYPES.each do |type|
      versions = data.dig("versions", type) || []
      versions.each do |version|
        version["used_on"]&.delete(page_path)
      end
    end
  end
end

#save ⇒ Object

Save manifest to disk



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 52

def save
  # Store current provider at top level of manifest
  manifest_data = {
    "provider" => @current_provider,
    "images" => @manifest
  }

  FileUtils.mkdir_p(File.dirname(@manifest_path))
  File.write(@manifest_path, JSON.pretty_generate(manifest_data))
end

#update_page_usage(original_name, operations, type, page_path) ⇒ Object

Update page usage for an existing version This is a convenience method that calls register_version



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 155

def update_page_usage(original_name, operations, type, page_path)
  Jekyll.logger.debug "🔍 update_page_usage: original_name=#{original_name}, operations=#{operations.inspect}, type=#{type}, page_path=#{page_path}"

  # Get the existing version's output path (already relative)
  output_path = get_version_output(original_name, operations, type)
  Jekyll.logger.debug "🔍 update_page_usage: output_path=#{output_path}"
  return unless output_path

  # Get the existing version to preserve provider
  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  version = versions.find { |v| v["operations"] == operations }
  provider = version&.dig("provider")
  Jekyll.logger.debug "🔍 update_page_usage: provider=#{provider}, current used_on=#{version&.dig('used_on')&.inspect}"

  # Call register_version to update page usage (output_path is already relative)
  register_version(original_name, output_path, operations, type, page_path, nil, provider)
  Jekyll.logger.debug "🔍 update_page_usage: completed register_version call"
end

#version_exists?(original_name, operations, type = :specialized) ⇒ Boolean

Check if a specific image version exists and is up-to-date

Returns:

  • (Boolean) 


88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 88

def version_exists?(original_name, operations, type = :specialized)
  return false unless @manifest[original_name]

  # Provider change is already handled in initialize, so just check operations
  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  Jekyll.logger.debug "🔍 ManifestManager: Looking for operations: #{operations.inspect} in #{versions.length} #{type} versions"

  result = versions.any? { |v| v["operations"] == operations }
  Jekyll.logger.debug "🔍 ManifestManager: Final result: #{result}"
  result
end

#versions?(original_name) ⇒ Boolean

Check if original image has any versions

Returns:

  • (Boolean) 


290
291
292
293
294
295
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 290

def versions?(original_name)
  return false unless @manifest[original_name]

  versions = @manifest[original_name]["versions"]
  (versions["default"]&.any? || false) || (versions["specialized"]&.any? || false)
end