middleman-thumbnailer 0.1.2

data/lib/middleman-thumbnailer.rb

@@ -0,0 +1,8 @@
+require "middleman-core"
+
+require "middleman-thumbnailer/version"
+
+::Middleman::Extensions.register(:thumbnailer) do
+  require "middleman-thumbnailer/extension"
+  ::Middleman::Thumbnailer
+end

data/lib/middleman-thumbnailer/extension.rb

@@ -0,0 +1,192 @@
+require 'fileutils'
+require 'mime-types'
+
+require 'middleman-thumbnailer/thumbnail-generator'
+
+module Middleman
+  module Thumbnailer
+    class << self
+
+      attr_accessor :options
+
+      def registered(app, options={})
+
+        options[:filetypes] ||= [:jpg, :jpeg, :png]
+        options[:include_data_thumbnails] = false unless options.has_key? :include_data_thumbnails
+        options[:namespace_directory] = ["**"] unless options.has_key? :namespace_directory
+
+        Thumbnailer.options = options
+
+        app.helpers Helpers
+
+        options[:middleman_app] = app
+
+        app.after_configuration do
+
+          options[:build_dir] = build_dir
+
+          #stash the source images dir in options for the Rack middleware
+          options[:images_source_dir] = File.join(source_dir, images_dir)
+          options[:source_dir] = source_dir
+
+          dimensions = options[:dimensions]
+          namespace = options[:namespace_directory]
+
+          app.before_build do
+            dir = File.join(source_dir, images_dir)
+
+
+            files = DirGlob.glob(dir, namespace, options[:filetypes])
+
+            files.each do |file|
+              path = file.gsub(source_dir, '')
+              specs = ThumbnailGenerator.specs(path, dimensions)
+              ThumbnailGenerator.generate(source_dir, File.join(root, build_dir), path, specs)
+            end
+          end
+
+          sitemap.register_resource_list_manipulator(:thumbnailer, SitemapExtension.new(self), true)
+
+          app.use Rack, options
+        end
+      end
+      alias :included :registered
+    end
+
+    module Helpers
+      def thumbnail_specs(image, name)
+        dimensions = Thumbnailer.options[:dimensions]
+        ThumbnailGenerator.specs(image, dimensions)
+      end
+
+      def thumbnail_url(image, name, options = {})
+        include_images_dir = options.delete :include_images_dir
+
+        url = thumbnail_specs(image, name)[name][:name]
+        url = File.join(images_dir, url) if include_images_dir
+
+        url
+      end
+
+      def thumbnail(image, name, html_options = {})
+        specs_for_data_attribute = thumbnail_specs(image, name).map {|name, spec| "#{name}:#{spec[:name]}"}
+
+        html_options.merge!({'data-thumbnails' => specs_for_data_attribute.join('|')}) if Thumbnailer.options[:include_data_thumbnails]
+
+        image_tag(thumbnail_url(image, name), html_options)
+      end
+    end
+
+    class DirGlob
+      def self.glob(root, namespaces, filetypes)
+        filetypes_with_capitals = filetypes.reduce([]) { |memo, file| memo.concat [file, file.upcase] }
+        glob_str = "#{root}/{#{namespaces.join(',')}}/**/*.{#{filetypes_with_capitals.join(',')}}"
+        Dir[glob_str]
+      end
+    end
+
+    class SitemapExtension
+      def initialize(app)
+        @app = app
+      end
+
+      # Add sitemap resource for every image in the sprockets load path
+      def manipulate_resource_list(resources)
+
+        images_dir_abs = File.join(@app.source_dir, @app.images_dir)
+
+        images_dir = @app.images_dir
+
+        options = Thumbnailer.options
+        dimensions = options[:dimensions]
+        namespace = options[:namespace_directory].join(',')
+
+        files = DirGlob.glob(images_dir_abs, options[:namespace_directory], options[:filetypes])
+
+        resource_list = files.map do |file|
+          path = file.gsub(@app.source_dir + File::SEPARATOR, '')
+          specs = ThumbnailGenerator.specs(path, dimensions)
+          specs.map do |name, spec|
+            resource = nil
+            resource = Middleman::Sitemap::Resource.new(@app.sitemap, spec[:name], File.join(options[:build_dir], spec[:name])) unless name == :original
+          end
+        end.flatten.reject {|resource| resource.nil? }
+
+        resources + resource_list
+      end
+
+    end
+
+
+    # Rack middleware to convert images on the fly
+    class Rack
+
+      # Init
+      # @param [Class] app
+      # @param [Hash] options
+      def initialize(app, options={})
+        @app = app
+        @options = options
+
+        files = DirGlob.glob(options[:images_source_dir], options[:namespace_directory], options[:filetypes])
+
+        @original_map = ThumbnailGenerator.original_map_for_files(files, options[:dimensions])
+
+      end
+
+      # Rack interface
+      # @param [Rack::Environmemt] env
+      # @return [Array]
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        path = env["PATH_INFO"]
+
+        absolute_path = File.join(@options[:source_dir], path)
+
+        root_dir =  @options[:middleman_app].root 
+
+        tmp_dir = File.join(root_dir, 'tmp', 'middleman-thumbnail-cache')
+
+        if original_specs = @original_map[absolute_path]
+          thumbnail_path = Pathname.new original_specs[:spec][:name]
+          #the name for the generate spec filename is relative to the source dir, remove this
+          thumbnail_path = thumbnail_path.relative_path_from Pathname.new(@options[:source_dir])
+
+          cache_file = File.join tmp_dir, thumbnail_path.to_s
+          cache_dir = File.dirname cache_file
+          FileUtils.mkdir_p(cache_dir) unless Dir.exist?(cache_dir)
+
+          file_info = nil
+          file_data = nil
+
+          original_file = original_specs[:original]
+          original_mtime = File.mtime original_file
+          if File.exist?(cache_file) && (original_mtime == File.mtime(cache_file))
+            file_data = IO.read(cache_file)
+            file_info = {length: ::Rack::Utils.bytesize(file_data).to_s, mime_type: ::MIME::Types.type_for(cache_file).first.to_s}
+          else
+            image = ThumbnailGenerator.image_for_spec(original_file, original_specs[:spec])
+            file_data = image.to_blob
+
+            file_info = {length: ::Rack::Utils.bytesize(file_data).to_s, mime_type: image.mime_type}
+
+            File.open(cache_file, 'wb') do |file|
+              file.write file_data
+            end
+
+            File.utime(original_mtime, original_mtime, cache_file)
+
+            image.destroy!
+          end
+
+          status = 200
+          headers["Content-Length"] = file_info[:length]
+          headers["Content-Type"] = file_info[:mime_type]
+          response = [file_data]
+        end
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/middleman-thumbnailer/thumbnail-generator.rb

@@ -0,0 +1,78 @@
+require 'RMagick'
+require 'fileutils'
+
+module Middleman
+  #actually creates the thumbnail names
+  class ThumbnailGenerator
+    class << self
+
+      def specs(origin, dimensions)
+        ret = {original: {name: origin}}
+        file_parts = origin.split('.')
+        basename = file_parts[0..-2].join('.')
+        ext = file_parts.last
+
+        dimensions.each do |name, dimension|
+          ret[name] = {name: "#{basename}-#{name}-#{dimension}.#{ext}", dimensions: dimension}
+        end
+
+        ret
+      end
+
+      def generate(source_dir, output_dir, origin, specs)
+        origin_absolute = File.join(source_dir, origin)
+        yield_images(origin_absolute, specs) do |img, spec|
+          output_file = File.join(output_dir, spec[:name])
+          origin_mtime = File.mtime origin_absolute
+          #FIXME: this sucks & I should be shot, however in before_build, we havend created the build dir
+          # therefor we will have to create it here
+          output_file_immediate_dir = File.dirname output_file
+          FileUtils.mkdir_p output_file_immediate_dir unless Dir.exist? output_file_immediate_dir
+          if !File.exist?(output_file) || origin_mtime != File.mtime(output_file) then
+            #puts "writing #{output_file}"
+            img.write output_file 
+          end
+          File.utime(origin_mtime, origin_mtime, output_file)
+       end
+      end
+
+      def yield_images(origin, specs)
+        image = ::Magick::Image.read(origin).first
+        specs.each do |name, spec|
+          if spec.has_key? :dimensions then
+            image.change_geometry(spec[:dimensions]) do |cols, rows, img|
+              img = img.resize(cols, rows)
+              img = img.sharpen(0.5, 0.5)
+              yield img, spec
+            end
+          end
+        end
+      end
+
+      def image_for_spec(origin, spec)
+        image = ::Magick::Image.read(origin).first
+
+        if spec.has_key? :dimensions then
+          image.change_geometry(spec[:dimensions]) do |cols, rows, img|
+            img = img.resize(cols, rows)
+            img = img.sharpen(0.5, 0.5)
+            return img
+          end 
+        end
+        return image
+      end
+
+
+      #This returns a reverse mapping from a thumbnail's filename to the original filename, and the thumbnail's specs
+      def original_map_for_files(files, specs)
+        map = files.inject({}) do |memo, file|
+          generated_specs = self.specs(file, specs)
+          generated_specs.each do |name, spec|
+            memo[spec[:name]] = {:original => generated_specs[:original][:name], :spec => spec}
+          end
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/middleman-thumbnailer/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Thumbnailer
+    VERSION = "0.1.2"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-thumbnailer"

data/middleman-thumbnailer.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("./lib")
+require "middleman-thumbnailer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-thumbnailer"
+  s.version     = Middleman::Thumbnailer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nicholas Hemsley"]
+  s.email       = ["nick.hems@gmail.com"]
+  s.homepage    = "https://github.com/nhemsley/middleman-thumbnailer"
+  s.licenses    = ['MIT']
+  s.summary     = %q{Generate thumbnail versions of image files}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("middleman", ["~> 3.4.1"])
+  s.add_runtime_dependency("rake", ['<= 11.0'])
+  s.add_runtime_dependency("rmagick", ["~> 2.16.0"])
+  s.add_runtime_dependency("mime-types", ["~> 2.1"])
+end

data/spec/thumbnail-generator_spec.rb

@@ -0,0 +1,22 @@
+# require 'spec_helper'
+require 'middleman-thumbnailer'
+
+require "middleman-thumbnailer/thumbnail-generator"
+
+describe ::Middleman::ThumbnailGenerator do
+  let(:klass) { Middleman::ThumbnailGenerator }
+  let(:filename) {'test.jpg'}
+  describe "#specs" do
+
+    # it "should always return the original filename in :original" do 
+    #   dimensions = {:small => '100x100'}
+    #   klass.generate(filename, dimensions).should include(:original => filename)
+    # end
+
+    # it "should always return the original filename in :original" do 
+    #   dimensions = {:small => '100x100'}
+    #   klass.generate(filename, dimensions).should include(:small => 'test-small-100x100.jpg')
+    # end
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: middleman-thumbnailer
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Nicholas Hemsley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Generate thumbnail versions of image files
+email:
+- nick.hems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- features/namespace.feature
+- features/step_definitions/server_steps.rb
+- features/support/env.rb
+- features/thumbnails.feature
+- fixtures/namespace/config.rb
+- fixtures/namespace/source/images/background.png
+- fixtures/namespace/source/images/middleman.png
+- fixtures/namespace/source/images/test/background.png
+- fixtures/namespace/source/images/test1/background.png
+- fixtures/namespace/source/index.html.erb
+- fixtures/namespace/source/javascripts/all.js
+- fixtures/namespace/source/layouts/layout.erb
+- fixtures/namespace/source/stylesheets/all.css
+- fixtures/namespace/source/stylesheets/normalize.css
+- fixtures/thumbnails/config.rb
+- fixtures/thumbnails/source/images/background.png
+- fixtures/thumbnails/source/images/middleman.png
+- fixtures/thumbnails/source/index.html.erb
+- fixtures/thumbnails/source/javascripts/all.js
+- fixtures/thumbnails/source/layouts/layout.erb
+- fixtures/thumbnails/source/stylesheets/all.css
+- fixtures/thumbnails/source/stylesheets/normalize.css
+- lib/middleman-thumbnailer.rb
+- lib/middleman-thumbnailer/extension.rb
+- lib/middleman-thumbnailer/thumbnail-generator.rb
+- lib/middleman-thumbnailer/version.rb
+- lib/middleman_extension.rb
+- middleman-thumbnailer.gemspec
+- spec/thumbnail-generator_spec.rb
+homepage: https://github.com/nhemsley/middleman-thumbnailer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Generate thumbnail versions of image files
+test_files:
+- features/namespace.feature
+- features/step_definitions/server_steps.rb
+- features/support/env.rb
+- features/thumbnails.feature
+- spec/thumbnail-generator_spec.rb