middleman-favicon-maker 3.4.1 → 3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ea8530b747f81bb37285af745a28e9afbbf6839
-  data.tar.gz: 2fda3e341b19b0e4641ca26126c37bcfa8b33c65
+  metadata.gz: 9fa52aace31c3229aadff949f52cba09aac233f8
+  data.tar.gz: c04dc678fcf570072041acd4776778a48ff691f4
 SHA512:
-  metadata.gz: ee2937349abc27e83d203ea5cde1613d64b2a1f97c24b6cb4e8d9963ed2cc40143690fb00888ae67590ff2a9727ec8dc984280dbb4bc27ddced0a89b96493753
-  data.tar.gz: f9e07b9ec637f2d0f44c44216befadc282e590cdb3ac03dca7e909e64cb279f1e7e2ff6d9889784e9b1ed6a53f01a247966d0345b42c739e87d017a4197750c1
+  metadata.gz: 4225513d005709c6e3854e18f1795790801dbe3ee80a61c5dc0fe8b9cff8e545e13c5b77e4b04a4ee45bbd177571a73ef66d967f498f7db82bffa25eccab3aeb
+  data.tar.gz: fae09d7a7d7599a58724c4168127a6d03e71f172f9265dac5edbb3fa13c3f859f63b02c14e71e69f0d98674c0a341e3a15960836135a6c56fa0d616a70fc392f

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Kematzy, Andreas Follmann, Thomas Reynolds
+Copyright (c) 2012-2014 Andreas Follmann, Thomas Reynolds
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -12,68 +12,61 @@ Before you can use FaviconMaker, you need to install [ImageMagick](http://www.im
 brew install imagemagick
 ```
 
-### Using Bundler (recommended)
+### Using Bundler
 
 ``` ruby
-gem "middleman-favicon-maker", "~> 3.2"
+gem "middleman-favicon-maker", "~> 3.5"
 ```
 
 If you're using Middleman version 2.x, use version 0.0.6 of middleman-favicon-maker.
 
-### Standalone
-
-``` shell
-gem install middleman-favicon-maker
-```
-
 ## Integrating with Middleman
 
-Create a favicon_base.png image and place it in your source directory. Ideally, this image's dimensions would be 144 x 144. In config.rb, extend the `configure :build` block:
+Create a favicon_template.png image and place it in your source directory. Ideally, this image's dimensions would be 152 x 152. In config.rb, extend the `configure :build` block:
+
+### Simple config
+This config assumes that a PNG file named favicon_template.png lives in the source folder. The generated icons are stored in the build folder root.
 
 ``` ruby
 configure :build do
   ...
-  activate :favicon_maker
+  activate :favicon_maker, :icons => {
+    "favicon_template.png" => [
+      { icon: "apple-touch-icon-152x152-precomposed.png" },
+      { icon: "apple-touch-icon-114x114-precomposed.png" },
+      { icon: "apple-touch-icon-72x72-precomposed.png" },
+    ]
+  }
   ...
 end
 ```
 
-When you build your Middleman project, middleman-favicon-maker will generate the following files  in your build directory:
-
-* apple-touch-icon-144x144-precomposed.png
-* apple-touch-icon-120x120-precomposed.png
-* apple-touch-icon-114x114-precomposed.png
-* apple-touch-icon-72x72-precomposed.png
-* apple-touch-icon-57x57-precomposed.png
-* apple-touch-icon-precomposed.png
-* apple-touch-icon.png
-* favicon.ico
-* favicon.png
-
-The base image will not be copied into the build folder.
-
-## Customizing middleman-favicon-maker
-
-Version 3.x of this gem uses the `favicon_maker_` prefix for configuration options to be consistent with the activation keyword `:favicon_maker`. Previously the `favicon_` prefix was used.
-
-You can set the following options for middleman-favicon-maker:
-
-``` ruby
-:favicon_maker_root_dir        # default: app.root
-:favicon_maker_input_dir       # default: app.views -> source/
-:favicon_maker_output_dir      # default: app.build_dir -> build/
-:favicon_maker_base_image      # default: "favicon_base.png"
-:favicon_maker_versions        # default: [ :fav_png, :fav_ico ]
-:favicon_maker_custom_versions # default: {}
-```
-
-For example:
+### Advanced config
+Using all configuration options. The template_dir/output_dir require absolute paths. You can use multiple template files that suit the different resolutions better. ```format``` and ```size``` are optional and only required when the size of the icon and/or the file format is not encoded in the filename. Multiple resolutions in one file is only supported for the .ico format.
 
 ``` ruby
-activate :favicon_maker,
-  :favicon_maker_input_dir       =>"favicons"
-  :favicon_maker_custom_versions => {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
+configure :build do
+  ...
+  activate :favicon_maker do |f|
+    f.template_dir  = File.join(root, 'source')
+    f.output_dir    = File.join(root, 'build')
+    f.icons = {
+      "favicon_template_hires.png" => [
+        { icon: "apple-touch-icon-152x152-precomposed.png" },
+        { icon: "apple-touch-icon-114x114-precomposed.png" },
+        { icon: "apple-touch-icon-72x72-precomposed.png" },
+        { icon: "mstile-144x144", format: :png },
+      ],
+      "favicon_template_lores.png" => [
+        { icon: "favicon.png", size: "16x16" },
+        { icon: "favicon.ico", size: "64x64,32x32,24x24,16x16" },
+      ]
+    }
+  end
+  ...
+end
 ```
+The template images are deleted from the build folder (Middleman copies them) after all icons have been generated.
 
 ## Markup meta links
 
@@ -93,6 +86,7 @@ Specifying meta links is only necessary if you want to support non-iOS devices.
 ### HAML
 
 ``` haml
+%link{ rel: "apple-touch-icon", sizes: "152x152", href: "apple-touch-icon-144x144-precomposed.png" }
 %link{ rel: "apple-touch-icon", sizes: "144x144", href: "apple-touch-icon-144x144-precomposed.png" }
 %link{ rel: "apple-touch-icon", sizes: "114x114", href: "apple-touch-icon-114x114-precomposed.png" }
 %link{ rel: "apple-touch-icon", sizes: "72x72", href: "apple-touch-icon-72x72-precomposed.png" }
@@ -103,4 +97,4 @@ Specifying meta links is only necessary if you want to support non-iOS devices.
 
 ## Copyright
 
-© 2011-2013 Andreas Follmann. See LICENSE for details.
+© 2011-2014 Andreas Follmann. See LICENSE for details.

data/lib/middleman-favicon-maker/extension.rb

@@ -1,43 +1,46 @@
+require "favicon_maker"
+
 module Middleman
   module FaviconMaker
-    class << self
-      def registered(app, options={})
-        require "favicon_maker"
-
-        options[:favicon_maker_root_dir]        ||= ''
-        options[:favicon_maker_input_dir]       ||= ''
-        options[:favicon_maker_output_dir]      ||= ''
-        options[:favicon_maker_base_image]      ||= 'favicon_base.png'
-        options[:favicon_maker_versions]        ||= [ :fav_png, :fav_ico ]
-        options[:favicon_maker_custom_versions] ||= {}
-
-        app.after_configuration do
-          # configs are either default or set by user in config.rb
-          # due to Middleman extension limitations, we need to ensure they are sane
-          # before we continue
-          options[:favicon_maker_root_dir]   = root      if options[:favicon_maker_root_dir].empty?
-          options[:favicon_maker_input_dir]  = source    if options[:favicon_maker_input_dir].empty?
-          options[:favicon_maker_output_dir] = build_dir if options[:favicon_maker_output_dir].empty?
-        end
+    class FaviconMakerExtension < Extension
+
+      option :template_dir, nil, "Template dir for icon templates"
+      option :output_dir,   nil, "Output dir for generated icons"
+      option :icons,        {}, "Hash with template filename (key) and Array of Hashes with icon configs"
+
+      def after_configuration
+        options[:template_dir]  ||= File.join(app.root, app.settings[:source])    if options[:template_dir].nil?
+        options[:output_dir]    ||= File.join(app.root, app.settings[:build_dir]) if options[:output_dir].nil?
+      end
+
+      def after_build(builder)
 
-        app.after_build do |builder|
-          ::FaviconMaker::Generator.create_versions({
-            :root_dir =>        options[:favicon_maker_root_dir],
-            :input_dir =>       options[:favicon_maker_input_dir],
-            :output_dir =>      options[:favicon_maker_output_dir],
-            :base_image =>      options[:favicon_maker_base_image],
-            :versions =>        options[:favicon_maker_versions],
-            :custom_versions => options[:favicon_maker_custom_versions],
-            :copy =>            true
-          }) do |f, status|
-            builder.say_status status, f.gsub(root + "/", "")
+        template_files = []
+        ::FaviconMaker.generate do
+          setup do
+            template_dir  options[:template_dir]
+            output_dir    options[:output_dir]
           end
 
-          # remove favicon_base_image from the build dir
-          builder.remove_file File.join(options[:favicon_maker_root_dir], options[:favicon_maker_output_dir], options[:favicon_maker_base_image])
+          options[:icons].each do |input_filename, icon_configs|
+            from input_filename do
+              icon_configs.each do |icon_config|
+                icon icon_config.delete(:icon), icon_config
+              end
+            end
+          end
+
+          each_icon do |filepath, template_filepath|
+            builder.say_status :generate, filepath.gsub(options[:output_dir] + "/", "")
+            template_files << template_filepath
+          end
         end
+
+        template_files.uniq.each do |template_filepath|
+          builder.remove_file template_filepath.gsub(options[:template_dir], options[:output_dir])
+        end
+
       end
-      alias :included :registered
     end
   end
-end
+end

data/lib/middleman-favicon-maker/version.rb

@@ -1,8 +1,8 @@
 module Middleman
   module FaviconMaker
     MAJOR = 3
-    MINOR = 4
-    PATCH = 1
+    MINOR = 5
+    PATCH = nil
     BUILD = nil
 
     VERSION = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/middleman-favicon-maker.rb

@@ -1,6 +1,8 @@
 require "middleman-core"
+require "middleman-favicon-maker/version"
 
 ::Middleman::Extensions.register(:favicon_maker) do
   require "middleman-favicon-maker/extension"
-  ::Middleman::FaviconMaker
-end
+  ::Middleman::FaviconMaker::FaviconMakerExtension
+end
+

data/middleman-favicon-maker.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["hello@toyrocketscience.com"]
   gem.version       = Middleman::FaviconMaker::VERSION
   gem.platform      = Gem::Platform::RUBY
-  gem.authors       = ["Andreas Follmann", "Kematzy"]
+  gem.authors       = ["Andreas Follmann"]
   gem.email         = ["andreas@toyrocketscience.com"]
   gem.homepage      = "https://github.com/follmann/middleman-favicon-maker"
   gem.summary       = %q{Generate favicon files in various sizes from a base image in your Middleman project}
@@ -20,5 +20,5 @@ Gem::Specification.new do |gem|
 
   # Additional dependencies
   gem.add_runtime_dependency("middleman-core", [">= 3.0.0"])
-  gem.add_runtime_dependency("favicon_maker", ["~> 0.3"])
+  gem.add_runtime_dependency("favicon_maker", ["~> 1.0"])
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-favicon-maker
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: '3.5'
 platform: ruby
 authors:
 - Andreas Follmann
-- Kematzy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -31,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 description: Generate favicon files in various sizes from a base image in your Middleman
   project
 email:
@@ -55,7 +54,6 @@ files:
 - lib/middleman-favicon-maker.rb
 - lib/middleman-favicon-maker/extension.rb
 - lib/middleman-favicon-maker/version.rb
-- lib/middleman_extension.rb
 - middleman-favicon-maker.gemspec
 - test/helper.rb
 - test/test_middleman-favicon-maker.rb

data/lib/middleman_extension.rb

@@ -1 +0,0 @@
-require "middleman-favicon-maker"