rack-pack 0.3.0 → 0.3.1

data/lib/rack/pack.rb

@@ -7,51 +7,79 @@ module Rack
     autoload :Stylesheet, 'rack/pack/stylesheet'
     autoload :Version,    'rack/pack/version'
     
-    DEFAULT_OPTIONS = {
+    class << self
+      attr_accessor :packages, :environment, :options
+    end
+    
+    # Setup the defaults
+    @packages    = {}
+    @environment = 'development'
+    @options     = {
       :public_dir           => 'public',
+      :add_default_packages => true,
       :always_update        => false,
       :always_compress      => false,
       :js_compression       => {},
-      :css_compression      => {},
-      :environment          => :development,
-      :add_default_packages => true
-    }.freeze
+      :css_compression      => {}
+    }
     
     class << self
-      attr_accessor :packages, :options, :environment
-      
+      # Sets up Rack::Pack, optionally adding packages.
+      #
+      # @param [Hash] options
+      # @option options [String] :public_dir ('public') The directory to output the packaged file.
+      # @option options [Boolean] :add_default_packages (true) Wether or not to add the default packages.
+      # @option options [Boolean] :always_update (false) Updates the packages on every request.
+      # @option options [Boolean] :always_compress (false) Compress the packages on every request.
+      # @option options [Hash] :js_compression Options to pass directly
+      #   to the Javascript compression engine.
+      # @option options [Hash] :css_compression Options to pass directly
+      #   to the Stylesheet compression engine.
+      # @option options [String] :environment Manually set the environment.
       def configure(options = {})
-        self.packages = {}
-        self.options  = DEFAULT_OPTIONS.dup
-      
         self.options.each_key do |key|
           self.options[key] = options.delete(key) if options.key?(key)
         end
         
-        unless self.options[:add_default_packages] == false
-          add_package 'javascripts/application.js',  '{vendor,app,.}/javascripts/*.js'
-          add_package 'stylesheets/application.css', '{vendor,app,.}/stylesheets/*.css'
-        end
+        self.environment = options.delete(:environment) if options.key?(:environment)
+        
+        add_default_packages if self.options[:add_default_packages]
       
         options.each do |to_file, from_files|
           add_package(to_file, from_files)
         end
       end
       
+      # Determines if we're running in a production environment.
       def production?
         self.environment.to_s == 'production'
       end
     
+      # Adds a new Package for Rack::Pack to update.
+      # The Package class is determined based on the filename.
+      #
+      # @param [String] output_file The path to the file the Package will output.
+      # @param [Array, String] source_files The source files to package. Can be either
+      #   an Array of individual source files or a string that will be used in a glob.
       def add_package(output_file, source_files)
         if source_files.nil?
           packages.delete(output_file)
         else
-          public_output_file    = ::File.join(self.options[:public_dir], output_file.to_s)
+          public_output_file    = ::File.join(options[:public_dir], output_file.to_s)
           package_class         = Package[output_file]
           packages[output_file] = package_class.new(public_output_file, source_files)
         end
       end
       
+      # Adds the default Packages, which essentially look in the `vendor`, `app`,
+      # and current directories for javascripts & stylesheets and packages them into
+      # `javascripts/application.js` & `stylesheets/application.css`
+      def add_default_packages
+        add_package 'javascripts/application.js',  '{vendor,app,.}/javascripts/*.js'
+        add_package 'stylesheets/application.css', '{vendor,app,.}/stylesheets/*.css'
+      end
+      
+      # Loops through each added Package and updates them when stale.
       def update_packages
         Pack.packages.each_value do |package|
           package.update if package.stale?
@@ -59,6 +87,9 @@ module Rack
       end
     end
     
+    # Interface for creating the Rack::Pack middleware.
+    #
+    # @param []
     def initialize(app, options = {})
       @app = app
       Pack.configure(options)

data/lib/rack/pack/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Pack
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/spec/rack/pack_spec.rb

@@ -14,17 +14,24 @@ describe Rack::Pack do
   end
   alias_method :request, :request_for
   
+  describe '.add_default_packages' do
+    it 'adds default packages' do
+      Rack::Pack.add_default_packages
+      Rack::Pack.packages['javascripts/application.js'].should be_an_instance_of(Rack::Pack::Javascript)
+      Rack::Pack.packages['stylesheets/application.css'].should be_an_instance_of(Rack::Pack::Stylesheet)
+    end
+  end
+  
   describe '.configure' do
     it 'sets the given options' do
       Rack::Pack.configure(:public_dir => '_site', :always_compress => true, :environment => :production)
       Rack::Pack.options.should == {
         :public_dir           => '_site',
+        :add_default_packages => true,
         :always_update        => false,
         :always_compress      => true,
         :js_compression       => {},
-        :css_compression      => {},
-        :environment          => :production,
-        :add_default_packages => true
+        :css_compression      => {}
       }
     end
     

data/spec/spec_helper.rb

@@ -23,13 +23,19 @@ $hidden_consts = {}
   Object.send :remove_const, const
 end
 
+$default_config = {
+  :packages    => Rack::Pack.packages,
+  :environment => Rack::Pack.environment,
+  :options     => Rack::Pack.options
+}
+
 RSpec.configure do |config|
   config.include Construct::Helpers
   
   config.after do
-    Rack::Pack.packages    = nil
-    Rack::Pack.options     = nil
-    Rack::Pack.environment = nil
+    $default_config.each do |key, value|
+      Rack::Pack.send("#{key}=", value.dup)
+    end
   end
   
   def reveal_const(const)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-pack
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Pete Browne