middleman-simple-thumbnailer 1.0.2 → 1.4.0

data/lib/middleman-simple-thumbnailer.rb

@@ -2,4 +2,7 @@ require 'mini_magick'
 require "middleman-core"
 require "middleman-simple-thumbnailer/version"
 require "middleman-simple-thumbnailer/image"
-require "middleman-simple-thumbnailer/extension"
+require "middleman-simple-thumbnailer/image_store"
+require "middleman-simple-thumbnailer/extension"
+require "middleman-simple-thumbnailer/resource"
+require "middleman-simple-thumbnailer/rack"

data/lib/middleman-simple-thumbnailer/extension.rb

@@ -1,5 +1,9 @@
-#
-# add resize_to param to image_tag to create thumbnails 
+require 'tmpdir'
+require 'yaml'
+require 'json'
+require 'tempfile'
+require 'uri'
+# add resize_to param to image_tag to create thumbnails
 #
 #
 # Usage:
@@ -9,37 +13,159 @@ module MiddlemanSimpleThumbnailer
   class Extension < Middleman::Extension
 
     option :cache_dir, 'tmp/simple-thumbnailer-cache', 'Directory (relative to project root) for cached thumbnails.'
+    option :use_specs, false, 'Wether or not use the specification data file'
+    option :specs_data, 'simple_thumbnailer', 'name of the specification data file. Must follow middleman data file name convention'
+    option :specs_data_default_format, 'yaml', 'defaut specification file format (and extension). Can be yaml, yml or json'
+    option :specs_data_save_old, true, 'save previous specification data file '
+    option :update_specs, true, 'Warn about missing image file in specification and add them to teh spec file'
+    option :use_cache_dev, false, 'In development, add a Rack middleware to serve the resized image from cache'
 
     def initialize(app, options_hash={}, &block)
-      super
-      app.after_build do |builder|
-        MiddlemanSimpleThumbnailer::Image.all_objects.each do |image| 
-          builder.say_status :create, "#{image.resized_img_path}"
-          image.save!
+        super
+        @images_store = MiddlemanSimpleThumbnailer::ImageStore.new
+        @resize_specs = app.data[options.specs_data] || []
+        if @resize_specs.length == 0
+          @resize_specs = []
+        end
+        if !%w(yaml yml json).include?(options.specs_data_default_format)
+          raise "value assigned to option specs_data_default_format is not correct. should be one of json, yaml, or yml"
         end
-      end
     end
 
     def after_configuration
-      MiddlemanSimpleThumbnailer::Image.options = options
+      if app.development? && options.use_cache_dev
+        app.use MiddlemanSimpleThumbnailer::Rack, options, app, options
+      end
+    end
+
+    def store_resized_image(img_path, resize_to)
+      @images_store.store(img_path, resize_to)
+    end
+
+    def check_image_in_specs(img_path, resize_to)
+      @resize_specs.each do |resize_spec|
+        if resize_to == resize_spec.resize_to && File.fnmatch(resize_spec.path, img_path)
+          return true
+        end
+      end
+      return false
+    end
+
+    def manipulate_resource_list(resources)
+      return resources unless options.use_specs
+      resources + @resize_specs.reduce([]) do |res, resize_spec|
+        Dir.chdir(File.absolute_path(File.join(app.root, app.config[:source], app.config[:images_dir]))) do
+          Dir.glob(resize_spec.path) do |image_file|
+            store_resized_image(image_file, resize_spec.resize_to)
+            img = MiddlemanSimpleThumbnailer::Image.new(image_file, resize_spec.resize_to, app, options).tap do |i|
+              i.prepare_thumbnail
+            end
+            resized_image_path = File.join(app.config[:images_dir],img.resized_img_path)
+            new_resource = MiddlemanSimpleThumbnailer::Resource.new(
+              app.sitemap,
+              resized_image_path,
+              img.cached_resized_img_abs_path,
+            )
+            res.push(new_resource)
+          end
+        end
+        res
+      end
+    end
+
+    def after_build(builder)
+      resize_specs_modified = false
+      @images_store.each do |img_path, resize_to|
+        if options.use_specs && options.update_specs && !check_image_in_specs(img_path, resize_to)
+          builder.thor.say_status :warning, "#{img_path}:#{resize_to} not in resize spec", :yellow
+          @resize_specs.push(Middleman::Util::EnhancedHash.new({'path': img_path, 'resize_to': resize_to}))
+          resize_specs_modified = true
+        end
+        img = MiddlemanSimpleThumbnailer::Image.new(img_path, resize_to, builder.app, options)
+        if !File.exists?(img.resized_img_abs_path)
+          builder.thor.say_status :create, "#{img.resized_img_abs_path}"
+          img.save!
+        end
+      end
+      @images_store.delete
+      if options.update_specs && resize_specs_modified
+        builder.thor.say_status :warning, "Resize specs modified, rewrite", :yellow
+        write_specs_file
+      end
+    end
+
+    def get_data_file_path_ext
+      specs_data_list = Dir.glob(File.absolute_path(File.join(app.root, app.config[:data_dir],"#{options.specs_data}.{json,yml,yaml}")))
+      if specs_data_list.length > 0
+        return specs_data_list[0], File.extname(specs_data_list[0])[1..-1]
+      else
+        return File.absolute_path(File.join(app.root, app.config[:data_dir],"#{options.specs_data}.#{options.specs_data_default_format}")), options.specs_data_default_format
+      end
     end
 
+    def write_specs_file
+      data_file, ext = get_data_file_path_ext
+      FileUtils.mkdir_p File::dirname(data_file)
+      if File.exists?(data_file) && options.specs_data_save_old
+        i = 1
+        old_data_file = "#{data_file}.#{i}"
+        while File.exists?(old_data_file) && (i+=1) < ((2**16)-1)
+          old_data_file = "#{data_file}.#{i}"
+        end
+        raise "Middleman-simple-thumbnailer : could not find a filename for saving the data file " if i == ((2**16)-1)
+        FileUtils.cp(data_file, old_data_file)
+      end
+      new_specs = @resize_specs.map do |resize_spec|
+        resize_spec.to_hash
+      end
+      File.open(data_file, 'w') {|f| f.write ((%w(yaml yml).include?(ext))?new_specs.to_yaml():JSON.pretty_generate(new_specs)) }
+    end
+
+
+    private :check_image_in_specs, :get_data_file_path_ext, :write_specs_file
+
     helpers do
 
-      def image_tag(path, options={})
-        resize_to = options.delete(:resize_to)
-        return super(path, options) unless resize_to
+      def resized_image_path(path, resize_to=nil)
+        return path unless resize_to
 
-        image = MiddlemanSimpleThumbnailer::Image.new(path, resize_to, self.config)
-        if environment == :development
-          super("data:#{image.mime_type};base64,#{image.base64_data}", options)
+        ext = app.extensions[:middleman_simple_thumbnailer]
+
+        image = MiddlemanSimpleThumbnailer::Image.new(path, resize_to, app, ext.options)
+        if app.development?
+          if ext.options.use_cache_dev
+            [path, {"simple-thumbnailer" => "#{path}|#{resize_to}"}]
+          else
+            ["data:#{image.mime_type};base64,#{image.base64_data}", {}]
+          end
         else
-          super(image.resized_img_path, options)
+          ext.store_resized_image(path, resize_to)
+          [image.resized_img_path, {}]
+        end
+      end
+
+      def image_tag(path, options={})
+        resize_to = options.delete(:resize_to)
+        new_path, query_params = resize_to ? resized_image_path(path, resize_to) : [path, {}]
+        if(!query_params.empty?)
+          new_path = "#{new_path}?#{URI.encode_www_form(query_params)}"
         end
+        super(new_path, options)
       end
 
+      def image_path(path, options={})
+        resize_to = options.delete(:resize_to)
+        new_path, query_params = resize_to ? resized_image_path(path, resize_to) : [path, {}]
+        res = super(new_path)
+        if(!query_params.empty?)
+          res = "#{res}?#{URI.encode_www_form(query_params)}"
+        end
+        res
+      end
+    
     end
+
   end
 end
 
-::Middleman::Extensions.register(:middleman_simple_thumbnailer, MiddlemanSimpleThumbnailer::Extension)
+::Middleman::Extensions.register(:middleman_simple_thumbnailer, MiddlemanSimpleThumbnailer::Extension)

data/lib/middleman-simple-thumbnailer/image.rb

@@ -1,18 +1,17 @@
-require "digest"
+require 'digest'
+require 'base64'
 
 module MiddlemanSimpleThumbnailer
   class Image
-    @@all_objects = []
-    @@options = nil
 
     attr_accessor :img_path, :middleman_config, :resize_to
 
-    def initialize(img_path, resize_to, middleman_config)
-      @@all_objects << self
-
+    def initialize(img_path, resize_to, app, options_hash)
       @img_path = img_path
       @resize_to = resize_to
-      @middleman_config = middleman_config
+      @middleman_config = app.config
+      @app = app
+      @options = options_hash
     end
 
     def mime_type
@@ -24,29 +23,48 @@ module MiddlemanSimpleThumbnailer
     end
 
     def base64_data
+      prepare_thumbnail
+      Base64.strict_encode64(File.read(cached_resized_img_abs_path))
+    end
+
+    def prepare_thumbnail
       unless cached_thumbnail_available?
         resize!
         save_cached_thumbnail
       end
-      Base64.encode64(File.read(cached_resized_img_abs_path))
     end
 
+    def render
+      prepare_thumbnail
+      File.read(cached_resized_img_abs_path)
+    end
+
+
     def save!
-      resize!
-      image.write(resized_img_abs_path)
+      prepare_thumbnail
+      FileUtils.copy_file(cached_resized_img_abs_path, resized_img_abs_path)
+    end
+
+    def resized_img_abs_path
+      File.join(build_dir, middleman_abs_path).gsub(image_name, resized_image_name)
     end
 
-    def self.all_objects
-      @@all_objects
+    def middleman_resized_abs_path
+      middleman_abs_path.gsub(image_name, resized_image_name)
     end
 
-    def self.options=(options)
-      @@options = options
+    def middleman_abs_path
+      img_path.start_with?('/') ? img_path : File.join(images_dir, img_path)
     end
-    
-    
+
+    def cached_resized_img_abs_path
+      File.join(cache_dir, middleman_abs_path).gsub(image_name, resized_image_name).split('.').tap { |a|
+        a.insert(-2, image_checksum)
+      }.join('.')
+    end
+
     private
-    
+
     def resize!
       unless @already_resized
         image.resize(resize_to)
@@ -66,40 +84,31 @@ module MiddlemanSimpleThumbnailer
       File.basename(abs_path)
     end
 
+    def original_mtime
+     File.mtime abs_path
+    end
+
     def resized_image_name
       image_name.split('.').tap { |a| a.insert(-2, resize_to) }.join('.') # add resize_to sufix
-          .gsub(/[%@!<>^]/, '>' => 'gt', '<' => 'lt', '^' => 'c')                     # sanitize file name
+          .gsub(/[%@!<>^]/, '>' => 'gt', '<' => 'lt', '^' => 'c')         # sanitize file name
     end
 
     def abs_path
       File.join(source_dir, middleman_abs_path)
     end
 
-    def middleman_abs_path
-      img_path.start_with?('/') ? img_path : File.join(images_dir, img_path) 
-    end
-
-    def resized_img_abs_path
-      File.join(build_dir, middleman_abs_path).gsub(image_name, resized_image_name)
-    end
-
-    def cached_resized_img_abs_path
-      File.join(cache_dir, middleman_abs_path).gsub(image_name, resized_image_name).split('.').tap { |a|
-        a.insert(-2, image_checksum)
-      }.join('.')
-    end
-    
     def cached_thumbnail_available?
       File.exist?(cached_resized_img_abs_path)
     end
-   
+
     def save_cached_thumbnail
       FileUtils.mkdir_p(File.dirname(cached_resized_img_abs_path))
       image.write(cached_resized_img_abs_path)
+      File.utime(original_mtime, original_mtime, cached_resized_img_abs_path)
     end
-    
+
     def source_dir
-      middleman_config[:source]
+      File.absolute_path(middleman_config[:source], @app.root)
     end
 
     def images_dir
@@ -111,7 +120,7 @@ module MiddlemanSimpleThumbnailer
     end
 
     def cache_dir
-      @@options.cache_dir
+      File.absolute_path(@options.cache_dir, @app.root)
     end
   end
-end
+end

data/lib/middleman-simple-thumbnailer/image_store.rb

@@ -0,0 +1,42 @@
+module MiddlemanSimpleThumbnailer
+
+  class ImageStore
+
+    attr_reader :tmp_path
+
+    def initialize
+      @tmp_path =  Dir::Tmpname.create('thumbnail', nil) {}
+    end
+
+    def store(img_path, resize_to)
+      File.open(@tmp_path, File::RDWR|File::CREAT, 0644) do |f|
+        f.flock(File::LOCK_EX)
+        resized_images = f.size > 0 ? Marshal.load(f) : {}
+        file_key = "#{img_path}.#{resize_to}"
+        if ! resized_images.has_key?(file_key)
+          resized_images[file_key] = [img_path, resize_to]
+          f.rewind
+          Marshal.dump(resized_images,f)
+          f.flush
+          f.truncate(f.pos)
+        end
+      end
+    end
+
+    def each
+      return unless File.exist?(@tmp_path)
+      File.open(@tmp_path, "r") do |f|
+        f.flock(File::LOCK_SH)
+        resized_images = f.size > 0 ? Marshal.load(f) : {}
+        resized_images.values.each do |store_entry|
+          yield *store_entry
+        end
+      end
+    end
+
+    def delete
+      File.delete(@tmp_path) if File.exist?(@tmp_path)
+    end
+
+  end
+end

data/lib/middleman-simple-thumbnailer/rack.rb

@@ -0,0 +1,42 @@
+require 'rack/utils'
+require 'cgi'
+
+module MiddlemanSimpleThumbnailer
+  class Rack
+    def initialize(app, options= {}, middleman_app, config)
+      @app = app
+      @options = options
+      @config = config
+      @middleman_app = middleman_app
+    end
+
+    def call(env)
+      path_info = env["PATH_INFO"]
+      query_str = env["QUERY_STRING"]
+      environment = @middleman_app.config[:environment]
+      status = -1
+      
+      if(environment === :development && !query_str.empty?)
+        query_hash = CGI::parse(query_str)
+        if(query_hash.key?('simple-thumbnailer'))
+            path, resize_to = query_hash['simple-thumbnailer'][0].split('|')
+            image = MiddlemanSimpleThumbnailer::Image.new(path, resize_to, @middleman_app, @config)
+            status = 200
+            file_data = image.render
+            headers = {
+                "Content-Length" => file_data.bytesize.to_s,
+                "Content-Type" => image.mime_type
+            }
+            response = [file_data]
+        end
+      end
+
+      if status === -1
+        status, headers, response = @app.call(env)
+      end
+
+      [status, headers, response]
+    end
+  
+  end
+end

data/lib/middleman-simple-thumbnailer/resource.rb

@@ -0,0 +1,19 @@
+module MiddlemanSimpleThumbnailer
+  class Resource < ::Middleman::Sitemap::Resource
+    def initialize(store, path, source)
+      super(store, path, source)
+    end
+
+    def ignored?
+      false
+    end
+
+    def template?
+      false
+    end
+
+    def binary?
+      true
+    end
+  end
+end

data/lib/middleman-simple-thumbnailer/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanSimpleThumbnailer
-  VERSION = '1.0.2'
+  VERSION = '1.4.0'
 end