adamh-asset_library 0.1.4 → 0.2.0

data/README.rdoc

@@ -32,7 +32,7 @@ Once configured, asset_library provides two helper methods for your views:
 
   <%# outputs library.ie6.css (production) or its files (development) %>
   <!--[if lte IE 6]>
-    <%= asset_library_stylesheet_tags(:stylesheets, 'ie6') %>
+    <%= asset_library_stylesheet_tags(:stylesheets, :ie6) %>
   <![endif]-->
 
 Both helpers behave differently depending on whether
@@ -92,7 +92,10 @@ should be in <tt>config/asset_library.yml</tt>.
     cache: library
     base: stylesheets
     suffix: css
-    extra_suffixes: [ie6, ie7, ie8]
+    formats:
+      - ie6: [null, ie8, ie7, ie6]
+      - ie7: [null, ie8, ie7]
+      - ie8: [null, ie8]
     files:
       - reset
       - application
@@ -104,7 +107,9 @@ should be in <tt>config/asset_library.yml</tt>.
   #  cache: cache_file
   #  base: base_path_of_assets_in_web_root
   #  suffix: suffix ("css" or "js")
-  #  extra_suffixes: ["other_bundle_suffix_1", "other_bundle_suffix_2"]
+  #  formats:
+  #    format1: ["extra_suffix_1", "extra_suffix_2"]
+  #    format2: [null, "extra_suffix3"]
   #  optional_suffix: optional_suffix
   #  files:
   #    - file1_relative_to_base
@@ -128,14 +133,14 @@ should be <tt>stylesheets</tt>.
 <tt>suffix</tt> is either "js" or "css", depending on whether you are including
 JavaScript or CSS files.
 
-<tt>extra_suffixes</tt> allows construction of parallel modules. If you specify
-<tt>extra_suffixes</tt> as ['ie6', 'ie7'], <tt>files</tt> as <tt>file1</tt> and
-<tt>file2</tt>, <tt>module_name</tt> as <tt>module</tt>, and <tt>suffix</tt> as
-<tt>css</tt>, then three modules will be created (ignoring nonexistent files):
-
-* <tt>module.css</tt>, the concatenation of <tt>file1.css</tt> and <tt>file2.css</tt>
-* <tt>module.ie6.css</tt>, the concatenation of <tt>file1.ie6.css</tt> and <tt>file2.ie6.css</tt>
-* <tt>module.ie7.css</tt>, the concatenation of <tt>file1.ie7.css</tt> and <tt>file2.ie7.css</tt>
+<tt>formats</tt> allows construction of parallel modules. By default, for a
+module named <tt>styles</tt> will use <tt>*.css</tt> (where <tt>*</tt> is
+specified by the <tt>files</tt> option) to generate <tt>styles.css</tt>; but
+filenames of the format <tt>*.suffix.css</tt> will be ignored in that search.
+If a <tt>format</tt> called <tt>format1</tt> is specified as
+<tt>[suffix1, suffix2]</tt>, then <tt>*.suffix1.css</tt> and
+<tt>*.suffix2.css</tt> will be included, but not <tt>*.css</tt>. (To specify
+<tt>*.css</tt>, put <tt>null</tt> in the format list.)
 
 <tt>optional_suffix</tt> will cause asset_library to check for the existence of
 files with <tt>optional_suffix</tt> suffixes, falling back to files without
@@ -152,9 +157,8 @@ directory, and they will be included instead, for optimal download speed.
 <tt>files</tt> is a list of files, relative to <tt>base</tt>. File globbing is
 allowed; <tt>**</tt> expands to "any nesting of directories". Files which do
 not exist will be excluded; globbing will include/exclude files with
-<tt>extra_suffixes</tt> as appropriate; and files without
-<tt>optional_suffix</tt> will not be output alongside files with the same name
-endowed with the suffix.
+<tt>formats</tt> as appropriate; and files without <tt>optional_suffix</tt>
+will not be output alongside files with the same name endowed with the suffix.
 
 == Copyright
 

data/lib/asset_library/asset_module.rb

@@ -12,7 +12,19 @@ class AssetLibrary
     #
     # Arguments:
     #   extra_suffix: if set, finds files with the given extra suffix
-    def assets(extra_suffix = nil)
+    def assets(format = nil)
+      if format
+        assets_with_format(format)
+      else
+        assets_with_extra_suffix(nil)
+      end
+    end
+
+    # Returns an Array of Assets to include.
+    #
+    # Arguments:
+    #   extra_suffix: if set, finds files with the given extra suffix
+    def assets_with_extra_suffix(extra_suffix)
       return nil unless config
 
       ret = []
@@ -23,10 +35,23 @@ class AssetLibrary
       ret
     end
 
-    def contents(extra_suffix = nil)
+    # Returns an Array of Assets to include.
+    #
+    # Calls assets_with_extra_suffix for each suffix in the given format
+    #
+    # Arguments:
+    #   format: format specified in the config
+    def assets_with_format(format)
+      return nil unless config
+
+      extra_suffixes = config[:formats][format.to_sym]
+      extra_suffixes.inject([]) { |r, s| r.concat(assets_with_extra_suffix(s)) }
+    end
+
+    def contents(format = nil)
       s = StringIO.new
 
-      assets(extra_suffix).each do |asset|
+      assets(format).each do |asset|
         File.open(asset.absolute_path, 'r') do |infile|
           s.write(infile.read)
         end
@@ -37,21 +62,21 @@ class AssetLibrary
     end
 
     # Returns an Asset representing the cache file
-    def cache_asset(extra_suffix = nil)
-      extra = extra_suffix ? ".#{extra_suffix}" : ''
+    def cache_asset(format = nil)
+      extra = format ? ".#{format}" : ''
       Asset.new(File.join(AssetLibrary.root, config[:base], "#{config[:cache]}#{extra}.#{config[:suffix]}"))
     end
 
-    def write_cache(extra_suffix = nil)
-      File.open(cache_asset(extra_suffix).absolute_path, 'w') do |outfile|
-        outfile.write(contents(extra_suffix).read)
+    def write_cache(format = nil)
+      File.open(cache_asset(format).absolute_path, 'w') do |outfile|
+        outfile.write(contents(format).read)
       end
     end
 
     def write_all_caches
-      cache_suffixes = [ nil ] + (config[:extra_suffixes] || [])
-      cache_suffixes.each do |extra_suffix|
-        write_cache(extra_suffix)
+      write_cache
+      (config[:formats] || {}).keys.each do |format|
+        write_cache(format)
       end
     end
 
@@ -87,9 +112,9 @@ class AssetLibrary
     def path_contains_extra_dot?(path, requested_file, extra_suffix)
       allowed_suffixes = []
 
-      allowed_suffixes << "\\.#{Regexp.quote(extra_suffix)}" if extra_suffix
-      allowed_suffixes << "(\\.#{Regexp.quote(config[:optional_suffix])})?" if config[:optional_suffix]
-      allowed_suffixes << "\\.#{Regexp.quote(config[:suffix])}" if config[:suffix]
+      allowed_suffixes << "\\.#{Regexp.quote(extra_suffix.to_s)}" if extra_suffix
+      allowed_suffixes << "(\\.#{Regexp.quote(config[:optional_suffix].to_s)})?" if config[:optional_suffix]
+      allowed_suffixes << "\\.#{Regexp.quote(config[:suffix].to_s)}" if config[:suffix]
 
       basename = File.basename(path)
       requested_basename = File.basename(requested_file)

data/lib/asset_library/helpers.rb

@@ -1,22 +1,22 @@
 class AssetLibrary
   module Helpers
-    def asset_library_javascript_tags(module_key)
+    def asset_library_javascript_tags(module_key, format = nil)
       m = AssetLibrary.asset_module(module_key)
       if AssetLibrary.cache
         @@asset_library_javascript_tags_cache ||= {}
         @@asset_library_javascript_tags_cache[module_key] ||= script_tag(m.cache_asset.relative_url)
       else
-        m.assets.collect{|a| script_tag(a.relative_url)}.join("\n")
+        m.assets(format).collect{|a| script_tag(a.relative_url)}.join("\n")
       end
     end
 
-    def asset_library_stylesheet_tags(module_key, extra_suffix = nil)
+    def asset_library_stylesheet_tags(module_key, format = nil)
       m = AssetLibrary.asset_module(module_key)
       if AssetLibrary.cache
         @@asset_library_stylesheet_tags_cache ||= {}
-        @@asset_library_stylesheet_tags_cache[[module_key, extra_suffix]] ||= style_tag(m.cache_asset(extra_suffix).relative_url)
+        @@asset_library_stylesheet_tags_cache[[module_key, format]] ||= style_tag(m.cache_asset(format).relative_url)
       else
-        import_styles_tag(m.assets(extra_suffix).collect{|a| a.relative_url})
+        import_styles_tag(m.assets(format).collect{|a| a.relative_url})
       end
     end
 

data/spec/asset_library/asset_module_spec.rb

@@ -58,17 +58,32 @@ describe(AssetLibrary::AssetModule) do
 
     it('should pick files with :extra_suffix') do
       stub_fs([ '/c/file1.e.css' ])
-      m(css_config(:files => ['file1'])).assets('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.css' ]
+      m(css_config(:files => ['file1'])).assets_with_extra_suffix('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.css' ]
     end
 
     it('should ignore non-suffixed files when :extra_suffix is set') do
       stub_fs([ '/c/file1.css' ])
-      m(css_config(:files => ['file1'])).assets('e').collect{|a| a.absolute_path}.should == []
+      m(css_config(:files => ['file1'])).assets_with_extra_suffix('e').collect{|a| a.absolute_path}.should == []
+    end
+
+    it('should use extra suffixes with format') do
+      stub_fs([ '/c/file1.e1.css', '/c/file1.e2.css' ])
+      m(css_config(:files => ['file1'], :formats => { :f1 => [ 'e1', 'e2' ] })).assets_with_format(:f1).collect{|a| a.absolute_path}.should == [ '/c/file1.e1.css', '/c/file1.e2.css' ]
+    end
+
+    it('should ignore extra suffixes unspecified in format') do
+      stub_fs([ '/c/file1.e1.css', '/c/file1.e2.css' ])
+      m(css_config(:files => ['file1'], :formats => { :f1 => [ 'e1' ] })).assets_with_format(:f1).collect{|a| a.absolute_path}.should == [ '/c/file1.e1.css' ]
+    end
+
+    it('should allow nil suffixes in format') do
+      stub_fs([ '/c/file1.css', '/c/file1.e1.css' ])
+      m(css_config(:files => ['file1'], :formats => { :f1 => [nil, 'e1'] })).assets_with_format(:f1).collect{|a| a.absolute_path}.should == ['/c/file1.css', '/c/file1.e1.css' ]
     end
 
     it('should combine :extra_suffix with :optional_suffix') do
       stub_fs([ '/c/file1.e.css', '/c/file1.e.o.css' ])
-      m(css_config(:files => ['file1'], :optional_suffix => 'o')).assets('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.o.css' ]
+      m(css_config(:files => ['file1'], :optional_suffix => 'o')).assets_with_extra_suffix('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.o.css' ]
     end
 
     it('should ignore too many dots when globbing') do
@@ -78,7 +93,7 @@ describe(AssetLibrary::AssetModule) do
 
     it('should pick files with :extra_suffix when globbing') do
       stub_fs([ '/c/file1.e.css', '/c/file2.css' ])
-      m(css_config(:files => ['file*'])).assets('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.css' ]
+      m(css_config(:files => ['file*'])).assets_with_extra_suffix('e').collect{|a| a.absolute_path}.should == [ '/c/file1.e.css' ]
     end
 
     it('should pick files with :optional_suffix when globbing') do
@@ -88,7 +103,7 @@ describe(AssetLibrary::AssetModule) do
 
     it('should pick files with both :extra_suffix and :optional_suffix when globbing') do
       stub_fs([ '/c/file.css', '/c/file.e.css', '/c/file.e.o.css' ])
-      m(css_config(:optional_suffix => 'o', :files => ['file*'])).assets('e').collect{|a| a.absolute_path}.should == [ '/c/file.e.o.css' ]
+      m(css_config(:optional_suffix => 'o', :files => ['file*'])).assets_with_extra_suffix('e').collect{|a| a.absolute_path}.should == [ '/c/file.e.o.css' ]
     end
   end
 
@@ -109,8 +124,8 @@ describe(AssetLibrary::AssetModule) do
       m(css_config).cache_asset.absolute_path.should == '/c/cache.css'
     end
 
-    it('should use :extra_suffix if set') do
-      m(css_config).cache_asset('e').absolute_path.should == '/c/cache.e.css'
+    it('should use :format if set') do
+      m(css_config).cache_asset(:e).absolute_path.should == '/c/cache.e.css'
     end
   end
 
@@ -129,25 +144,25 @@ describe(AssetLibrary::AssetModule) do
       f.read.should == '/c/file1.css/c/file2.css'
     end
 
-    it('should use :extra_suffix to determine CSS output file') do
+    it('should use :format to determine CSS output file') do
       File.should_receive(:open).with('/c/cache.e.css', 'w')
-      m(css_config).write_cache('e')
+      m(css_config).write_cache(:e)
     end
   end
 
   describe('#write_all_caches') do
-    it('should write cache.css (no :extra_suffix)') do
+    it('should write cache.css (no :format)') do
       File.should_receive(:open).with('/c/cache.css', 'w')
       m(css_config).write_all_caches
     end
 
-    it('should write no-extra_suffix and all extra_suffix files') do
-      suffixes = [ 'e1', 'e2' ]
+    it('should write no-format and all format files') do
+      formats = { :e1 => [], :e2 => [] }
       File.should_receive(:open).with('/c/cache.css', 'w')
-      suffixes.each do |suffix|
-        File.should_receive(:open).with("/c/cache.#{suffix}.css", 'w')
+      formats.keys.each do |format|
+        File.should_receive(:open).with("/c/cache.#{format}.css", 'w')
       end
-      m(css_config(:extra_suffixes => suffixes)).write_all_caches
+      m(css_config(:formats => formats)).write_all_caches
     end
   end
 

data/spec/asset_library/helpers_spec.rb

@@ -75,11 +75,11 @@ describe(AssetLibrary::Helpers) do
         h.asset_library_stylesheet_tags(:m).should == "<style type=\"text/css\">\n@import \"\/f.css?123\";\n</style>"
       end
 
-      it('should append extra_suffix to the cache filename') do
+      it('should use formats to find cache filename') do
         m = mock
-        m.should_receive(:assets).with('e').and_return([a('f.e.css')])
+        m.should_receive(:assets).with(:e).and_return([a('f.e.css')])
         AssetLibrary.stub!(:asset_module).and_return(m)
-        h.asset_library_stylesheet_tags(:m, 'e').should == "<style type=\"text/css\">\n@import \"f.e.css?123\";\n</style>"
+        h.asset_library_stylesheet_tags(:m, :e).should == "<style type=\"text/css\">\n@import \"f.e.css?123\";\n</style>"
       end
 
       it('should output a single <script> tag with 30 @import') do
@@ -106,11 +106,11 @@ describe(AssetLibrary::Helpers) do
         h.asset_library_stylesheet_tags(:m).should == '<link rel="stylesheet" type="text/css" href="/cache.css?123" />'
       end
 
-      it('should append extra_suffix to the cache filename') do
+      it('should use format for the cache filename') do
         m = mock
-        m.should_receive(:cache_asset).with('e').and_return(a('/cache.e.css'))
+        m.should_receive(:cache_asset).with(:e).and_return(a('/cache.e.css'))
         AssetLibrary.stub!(:asset_module).and_return(m)
-        h.asset_library_stylesheet_tags(:m, 'e').should == '<link rel="stylesheet" type="text/css" href="/cache.e.css?123" />'
+        h.asset_library_stylesheet_tags(:m, :e).should == '<link rel="stylesheet" type="text/css" href="/cache.e.css?123" />'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adamh-asset_library
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - adamh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-21 00:00:00 -07:00
+date: 2009-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/adamh/asset_library
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Manage and bundle CSS and JavaScript files