iconoclast 0.0.1 → 0.1.0

data/README.rdoc

@@ -2,9 +2,13 @@
 
 Description goes here.
 
-Call like this:
-<%= IconHelper.icon 'key' %>
-http://robots.thoughtbot.com/post/159808152/disambiguate-rails-helpers
+In application_controller.rb:
+helper Iconoclast::IconHelper
+
+In your views:
+<%= icon 'name' %>
+<%= icon 'name', 'alt text' %>
+<%= icon 'name', 'alt text', { :border => 1 } %>
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -1,3 +1,5 @@
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
 require 'rubygems'
 require 'rake'
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bin/iconify

@@ -12,19 +12,19 @@ Main do
   EOS
 
   examples <<-EOS
-    To add famfamfam icons to your app
+    To add icons to your app
 
     	cd /your/rails/app/dir  
 
-    	famify #copies icons to public/images
+    	iconify #copies icons to public/images
 
-    	famify my_images/icons #copies icons to /your/rails/apps/dir/myimages/icons
+    	iconify my_images/icons #copies icons to /your/rails/apps/dir/myimages/icons
 
-    To remove famfamfam icons from your app (and only famfamfam icons)
+    To remove icons from your app (and only famfamfam icons)
 
-    	famify remove #removes only famfamfam icons from public/images
+    	iconify remove #removes only famfamfam icons from public/images
 
-    	famify remove my_images/icons #removes only famfamfam icons from /your/rails/apps/dir/myimages/icons
+    	iconify remove my_images/icons #removes only famfamfam icons from /your/rails/apps/dir/myimages/icons
 
   EOS
 
@@ -35,27 +35,58 @@ Main do
       default File.expand_path("." + "/public/images")
     end
   end
+  
+  mixin :collection_option do
+    option "collection" do
+      argument_optional
+      attribute
+      default 'famfamfam'
+    end
+  end
+  
+  mixin :set_option do
+    option "set" do
+      argument_optional
+      attribute
+      default 'silk'
+    end
+  end
+
+  mixin :format_option do
+    option "format" do
+      argument_optional
+      attribute
+      default 'png'
+    end
+  end
 
   mode "remove" do
     mixin :path_argument
+    mixin :collection_option
+    mixin :set_option
+    mixin :format_option
     run do
-      Iconoclast.remove_icons path
+      Iconoclast.remove_icons path, {:collection => collection, :set => set, :format => format}
     end
   end
 
   mode "refresh" do
     mixin :path_argument
+    mixin :collection_option
+    mixin :set_option
+    mixin :format_option
     run do
-      Iconoclast.remove_icons path
-      Iconoclast.copy_icons path
+      Iconoclast.remove_icons path, {:collection => collection, :set => set, :format => format}
+      Iconoclast.install_icons path, {:collection => collection, :set => set, :format => format}
     end
   end
 
   mixin :path_argument
+  mixin :collection_option
+  mixin :set_option
+  mixin :format_option
 
   run do
-    Iconoclast.copy_icons path
+    Iconoclast.install_icons path, {:collection => collection, :set => set, :format => format}
   end
 end
-
-end

data/features/version.feature

@@ -5,4 +5,4 @@ Feature: Version
   
   Scenario: Get application version
     When I call the Iconoclast version method
-    Then the result should be 0.0.1
+    Then the result should be 0.1.0

data/iconoclast.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{iconoclast}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Dennis"]
-  s.date = %q{2009-11-29}
+  s.date = %q{2009-12-17}
   s.description = %q{Rails icon library and helpers}
   s.email = %q{e@wb.com}
   s.executables = ["iconify", "test.rb"]
@@ -1530,7 +1530,10 @@ Gem::Specification.new do |s|
      "lib/tasks/cucumber.rake",
      "rails/init.rb",
      "tasks/iconoclast.rake",
-     "test/helper.rb",
+     "test/fixtures/content/icon.html.erb",
+     "test/fixtures/layouts/iconoclast.html.erb",
+     "test/test_helper.rb",
+     "test/test_icon_helper.rb",
      "test/test_iconoclast.rb"
   ]
   s.homepage = %q{http://github.com/threetee/iconoclast}
@@ -1539,7 +1542,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Rails icon library and helpers}
   s.test_files = [
-    "test/helper.rb",
+    "test/test_helper.rb",
+     "test/test_icon_helper.rb",
      "test/test_iconoclast.rb"
   ]
 

data/lib/iconoclast/icon_helper.rb

@@ -8,14 +8,24 @@ module Iconoclast
     #    <%= icon :information, "Information icon", :border => 0 %>
     # will generate:
     #    <img src="../icons/information.png" alt="Information icon" border="0" />
-    def self.icon(name, alt = nil, opts = {})
+    def icon(name, alt = nil, opts = {})
+      # Set up some defaults
+      collection = 'famfamfam'
+      family = 'silk'
+      format = 'png'
+      
+      # Replace the defaults if specified
+      ['collection', 'family', 'format'].each do |var|
+        eval("#{var} = opts[:#{var}] unless opts[:#{var}].nil?")
+        eval("opts.delete #{var}")
+      end
+      
       opts[:border] ||= 0
       opts[:align] ||= "bottom"
       opts[:alt] ||= alt
 
-      image_tag "../icons/#{name}.png", opts
+      image_tag "icons/#{collection}/#{family}/#{format}/#{name}.png", opts
     end
-    
   end
   
 end

data/lib/iconoclast.rb

@@ -16,6 +16,7 @@ unless defined? Iconoclast
           case arg
             when String, Symbol
               file_name = 'iconoclast/' + arg.to_s.underscore
+              print "setting up helper for file_name = #{file_name}"
               helper(file_name)
             else
               helper(arg, &block)
@@ -31,18 +32,46 @@ unless defined? Iconoclast
       VERSION
     end
 
-    def self.icons ( options = {} )
-      options[:provider] ||= 'famfamfam'
-      options[:set] ||= 'silk'
-      options[:format] ||= 'png'
-#      print options.inspect
-      globpath = ::File.join(libpath, 'iconoclast/icons', options[:provider], options[:set], options[:format], '*')
-#      print "#{globpath}\n"
+    # Installs the specified icon set into the specified directory
+    def self.install_icons( dest_dir, opts = {} )
+      opts[:provider] ||= 'famfamfam'
+      opts[:set] ||= 'silk'
+      opts[:format] ||= 'png'
+      
+      action_dir = File.join(dest_dir, 'icons', opts[:provider], opts[:set], opts[:format])
+      puts "=="*45
+      puts "making dir #{action_dir}" unless File.exists? action_dir
+      puts "copying icons to #{action_dir}"
+      puts "=="*45
+      FileUtils.mkdir_p action_dir unless File.exists? action_dir
+      FileUtils.cp(Iconoclast.icons(opts), action_dir) 
+    end
+
+    def self.remove_icons( dest_dir, opts = {} )
+      opts[:provider] ||= 'famfamfam'
+      opts[:set] ||= 'silk'
+      opts[:format] ||= 'png'
+      
+      action_dir = File.join(dest_dir, 'icons', opts[:provider], opts[:set], opts[:format])
+      puts "=="*45
+      puts "removing icons from #{action_dir}"
+      puts "=="*45
+      icons = icon_names(opts)
+      icons.collect!{|icon| action_dir + "/" + icon}
+      FileUtils.rm(icons)
+      # TODO: remove any empty directories in the structure
+    end
+
+    def self.icons ( opts = {} )
+      opts[:provider] ||= 'famfamfam'
+      opts[:set] ||= 'silk'
+      opts[:format] ||= 'png'
+      globpath = ::File.join(libpath, 'iconoclast/icons', opts[:provider], opts[:set], opts[:format], '*')
       Dir[globpath]
     end
 
-    def self.icon_names ( options = {} )
-      icons = self.icons(options)
+    def self.icon_names ( opts = {} )
+      icons = self.icons(opts)
       icons.collect!{|icon| File.basename(icon)}
     end
   

data/test/fixtures/content/icon.html.erb

@@ -0,0 +1 @@
+<%= icon('zoom') %>

data/test/fixtures/layouts/iconoclast.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/{helper.rb → test_helper.rb}

@@ -22,7 +22,7 @@ ActionController::Routing::Routes.reload rescue nil
 
 #$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 #$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'iconoclast'
+#require 'iconoclast'
 
-class Test::Unit::TestCase
-end
+#class Test::Unit::TestCase
+#end

data/test/test_icon_helper.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'iconoclast'
+
+class IconHelperTest < ActionView::TestCase
+  context "The iconoclast view helper" do
+    tests Iconoclast::IconHelper
+
+    setup do
+      IconTag = {
+        %(icon('zoom')) => %(<img align="bottom" alt="Zoom" border="0" src="/images/icons/famfamfam/silk/png/zoom.png" />),
+        %(icon('zoom', 'alttext')) => %(<img align="bottom" alt="alttext" border="0" src="/images/icons/famfamfam/silk/png/zoom.png" />),
+        %(icon('zoom', 'alttext', { :border => 1 })) => %(<img align="bottom" alt="alttext" border="1" src="/images/icons/famfamfam/silk/png/zoom.png" />),
+      }
+    end
+
+    should "return the proper HTML" do
+      IconTag.each do |method, tag|
+        assert_dom_equal(tag, eval(method))
+      end
+    end
+  end
+end

data/test/test_iconoclast.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require 'test_helper'
 
 class TestIconoclast < Test::Unit::TestCase
   # Tests:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iconoclast
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Eric Dennis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-29 00:00:00 -08:00
+date: 2009-12-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -1565,7 +1565,10 @@ files:
 - lib/tasks/cucumber.rake
 - rails/init.rb
 - tasks/iconoclast.rake
-- test/helper.rb
+- test/fixtures/content/icon.html.erb
+- test/fixtures/layouts/iconoclast.html.erb
+- test/test_helper.rb
+- test/test_icon_helper.rb
 - test/test_iconoclast.rb
 has_rdoc: true
 homepage: http://github.com/threetee/iconoclast
@@ -1596,5 +1599,6 @@ signing_key:
 specification_version: 3
 summary: Rails icon library and helpers
 test_files: 
-- test/helper.rb
+- test/test_helper.rb
+- test/test_icon_helper.rb
 - test/test_iconoclast.rb