middleman-favicon-maker 0.0.6 → 3.0.0

data/.gitignore

@@ -1,5 +1,53 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
 *.gem
 .bundle
 Gemfile.lock
-pkg/*
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
 .rvmrc

data/Gemfile

@@ -1,4 +1,15 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Specify your gem's dependencies in middleman-favicon-maker.gemspec
 gemspec
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.4"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Andreas Follmann
+Copyright (c) 2012 Kematzy, 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

@@ -1,10 +1,22 @@
 middleman-favicon-maker
 =======================
-Generate favicon files in various sizes from a base image in your middleman project.
+Generate favicon files in various sizes from a base image in your [Middleman](http://middlemanapp.com/) project.
+
+This gem integrates []FaviconMaker](https://github.com/follmann/favicon_maker) effortless into your [Middleman](https://github.com/middleman/middleman) project.
+
+
+## IMPORTANT:
+
+**Updated to support Middleman version 3.0.0 and above.**
+
+Due to Middleman code changes **this version is NOT compatible with version 2.x installs of Middleman**.
+
+Use version **0.0.6** of the `middleman-favicon-maker` gem for version 2.x installs of Middleman.
+
 
-This gem integrates [FaviconMaker](https://github.com/follmann/favicon_maker) effortless into your [Middleman](https://github.com/tdreyno/middleman) project.
 
 ## Install
+
 ### Standalone
     gem install middleman-favicon-maker
 
@@ -12,8 +24,9 @@ This gem integrates [FaviconMaker](https://github.com/follmann/favicon_maker) ef
     gem "middleman-favicon-maker"
 
 ## How to integrate into a middleman project
-1. Put a file called favicon_base.png into your source folder (ideally with the dimensions of 114x114 pixels)
-2. In your config.rb extend the configure :build block with:
+1. Put a file called **favicon_base.png** into your source folder (ideally with the **dimensions of 114x114 pixels**)
+<br><br>
+2. In your config.rb extend the `configure :build` block with:
 
         configure :build do
           ...
@@ -21,7 +34,7 @@ This gem integrates [FaviconMaker](https://github.com/follmann/favicon_maker) ef
           ...
         end
 
-That results in the following files being created on middleman build:
+That results in the following files being created in your middleman build directory:
 
     build/apple-touch-icon-57x57-precomposed.png
     build/apple-touch-icon-72x72-precomposed.png
@@ -34,18 +47,25 @@ That results in the following files being created on middleman build:
 **NOTE: The base image will not be copied to the build folder.**
 
 ## Customise integration
-You can set the following options for favicon-maker:
-
-    :favicon_root_dir  # default: app.root
-    :favicon_input_dir # default: app.views -> source/
-    :favicon_output_dir # default: app.build_dir -> build/
-    :favicon_base_image # default: "favicon_base.png"
-    :favicon_versions # default: ::FaviconMaker::Generator::ICON_VERSIONS.keys
-    :favicon_custom_versions # default: {}
+
+
+**NOTE! v3.x of this gem uses a `favicon_maker_` prefix on the configuration options, whereas v.0.0.6 uses a `favicon_` prefix only.**
+
+**Why the change?  Consistency with the official activation keyword `:favicon_maker`.**
+
+
+You can set the following options for `middleman-favicon-maker`:
+
+    :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: ::FaviconMaker::Generator::ICON_VERSIONS.keys
+    :favicon_maker_custom_versions # default: {}
     
     e.g.
-    set :favicon_input_dir, "favicons"
-    set :favicon_custom_versions, {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
+    set :favicon_maker_input_dir, "favicons"
+    set :favicon_maker_custom_versions, {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
 
 ## Copyright
 

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "middleman-favicon-maker"
+  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}
+  gem.description = %q{Generate favicon files in various sizes from a base image in your Middleman project}
+  gem.authors     = ["Andreas Follmann", "Kematzy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "middleman-favicon-maker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+3.0.0

data/lib/middleman-favicon-maker.rb

@@ -1,39 +1,6 @@
-module Middleman
-  module Features
-    module FaviconMaker
-      class << self
-        def registered(app)
-          require "favicon_maker"
-      
-          app.set :favicon_root_dir, app.root
-          app.set :favicon_input_dir, app.views
-          app.set :favicon_output_dir, app.build_dir
-          app.set :favicon_base_image, "favicon_base.png"
-          app.set :favicon_versions, ::FaviconMaker::Generator::ICON_VERSIONS.keys
-          app.set :favicon_custom_versions, {}
-          
-          app.after_build do
-            ::FaviconMaker::Generator.create_versions({
-              :root_dir => app.settings.favicon_root_dir,
-              :input_dir => app.settings.favicon_input_dir,
-              :output_dir => app.settings.favicon_output_dir,
-              :base_image => app.settings.favicon_base_image,
-              :versions => app.settings.favicon_versions,
-              :custom_versions => app.settings.favicon_custom_versions,
-            }) do |filepath|
-              say_status :generated, filepath.gsub(app.root + "/", "")
-            end
-          end
-      
-          # exclude favicon_base_image from being copied to build dir
-          app.build_reroute do |destination, request_path|
-            if request_path.include? app.settings.favicon_base_image
-              throw
-            end
-          end
-        end
-        alias :included :registered
-      end
-    end
-  end
+require "middleman-core"
+
+::Middleman::Extensions.register(:favicon_maker) do
+  require "middleman-favicon-maker/extension"
+  ::Middleman::FaviconMaker
 end

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

@@ -0,0 +1,56 @@
+module Middleman
+  module FaviconMaker
+    class << self
+      def registered(app, options={})
+        app.set :favicon_maker_root_dir,        ""
+        app.set :favicon_maker_input_dir,       ""
+        app.set :favicon_maker_output_dir,      ""
+        app.set :favicon_maker_base_image,      "favicon_base.png"
+        app.set :favicon_maker_versions,        []
+        app.set :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
+          app.set :favicon_maker_root_dir,    root                if favicon_maker_root_dir.empty?
+          app.set :favicon_maker_input_dir,   source              if favicon_maker_input_dir.empty?
+          app.set :favicon_maker_output_dir,  build_dir           if favicon_maker_output_dir.empty?
+          app.set :favicon_maker_base_image,  "favicon_base.png"  if favicon_maker_base_image.empty?
+          
+          unless favicon_maker_root_dir.empty?
+            require "favicon_maker"
+            if favicon_maker_versions.empty?
+              app.set :favicon_maker_versions,    ::FaviconMaker::Generator::ICON_VERSIONS.keys
+            end
+          end
+          
+        end
+        
+        app.after_build do |builder|
+          
+          ::FaviconMaker::Generator.create_versions({
+            :root_dir => favicon_maker_root_dir,
+            :input_dir => favicon_maker_input_dir,
+            :output_dir => favicon_maker_output_dir,
+            :base_image => favicon_maker_base_image,
+            :versions => favicon_maker_versions,
+            :custom_versions => favicon_maker_custom_versions,
+            :copy => true
+          }) do |f|
+            builder.say_status :generated, f.gsub(root + "/", "")
+          end
+          
+          # remove favicon_base_image from the build dir
+          builder.remove_file File.join(favicon_maker_root_dir, favicon_maker_output_dir, favicon_maker_base_image)
+          
+        end
+        
+      end
+      alias :included :registered
+      
+    end
+    
+  end
+  
+end

data/lib/{version.rb → middleman-favicon-maker/version.rb}

@@ -1,5 +1,5 @@
 module Middleman
   module FaviconMaker
-    VERSION = "0.0.6"
+    VERSION = "3.0.0"
   end
 end

data/middleman-favicon-maker.gemspec

@@ -1,21 +1,23 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "version"
+require "middleman-favicon-maker/version"
 
 Gem::Specification.new do |s|
   s.name        = "middleman-favicon-maker"
   s.version     = Middleman::FaviconMaker::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Andreas Follmann"]
+  s.authors     = ["Andreas Follmann", "Kematzy"]
   #s.email       = [""]
   s.homepage    = "https://github.com/follmann/middleman-favicon-maker"
-  s.summary     = %q{Generate favicon files in various sizes from a base image in your middleman project}
-  s.description = %q{Generate favicon files in various sizes from a base image in your middleman project}
+  s.summary     = %q{Generate favicon files in various sizes from a base image in your Middleman project}
+  s.description = %q{Generate favicon files in various sizes from a base image in your Middleman project}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency("favicon_maker", ["~>0.0.5"])
-end
+  # Additional dependencies
+  s.add_runtime_dependency("middleman-core", [">= 3.0.0"])
+  s.add_runtime_dependency("favicon_maker", ["~>0.0.7"])
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'middleman-favicon-maker'
+
+class Test::Unit::TestCase
+end

data/test/test_middleman-favicon-maker.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMiddlemanFaviconMaker < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -1,28 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: middleman-favicon-maker
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
 - Andreas Follmann
+- Kematzy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: favicon_maker
-  requirement: &70209257017680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70209257017680
-description: Generate favicon files in various sizes from a base image in your middleman
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: Generate favicon files in various sizes from a base image in your Middleman
   project
 email: 
 executables: []
@@ -33,10 +55,15 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- VERSION
 - lib/middleman-favicon-maker.rb
-- lib/middleman_init.rb
-- lib/version.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
 homepage: https://github.com/follmann/middleman-favicon-maker
 licenses: []
 post_install_message: 
@@ -57,9 +84,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Generate favicon files in various sizes from a base image in your middleman
+summary: Generate favicon files in various sizes from a base image in your Middleman
   project
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_middleman-favicon-maker.rb