rapper_lite 0.1.0 → 0.1.1

data/Gemfile

@@ -7,4 +7,7 @@ group :development do
   gem "rdiscount", "~> 1.6.8"
   gem "jeweler", "~> 1.6.4"
   gem "yui-compressor", "~> 0.9.6"
+  gem "fssm", "~> 0.2.7"
+  gem "rb-fsevent"
+  gem "coffee-script", "~> 2.2.0"
 end

data/Gemfile.lock

@@ -5,13 +5,22 @@ GEM
       Platform (>= 0.4.0)
       open4
     Platform (0.4.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.2)
+    execjs (1.2.9)
+      multi_json (~> 1.0)
+    fssm (0.2.7)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    multi_json (1.0.3)
     open4 (1.0.1)
     rake (0.9.2)
+    rb-fsevent (0.4.3.1)
     rdiscount (1.6.8)
     rspec (1.3.2)
     yard (0.6.4)
@@ -23,8 +32,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coffee-script (~> 2.2.0)
+  fssm (~> 0.2.7)
   jeweler (~> 1.6.4)
   rake (~> 0.9.2)
+  rb-fsevent
   rdiscount (~> 1.6.8)
   rspec (~> 1.3.2)
   yard

data/README.markdown

@@ -1,6 +1,6 @@
 # rapper_lite #
 
-Bare-bones static asset packager and compressor. Currently supports CSS and JavaScript. Uses MD5 versioning to avoid re-compressing packages that don't need to be re-compressed. Uses a simple config file so that you don't have to wrangle wacky comment DSLs in your source code just to join and compress a few files.
+Bare-bones static asset packager and compressor. Currently supports CSS, JavaScript, and CoffeeScript. Uses MD5 versioning to avoid re-compressing packages that don't need to be re-compressed. Uses a simple config file so that you don't have to wrangle wacky comment DSLs in your source code just to join and compress a few files.
 
 ## Packaging assets without wanting to claw your eyes out
 
@@ -33,7 +33,18 @@ Bare-bones static asset packager and compressor. Currently supports CSS and Java
 
 2. Run rapper lite:
 
-        $ rapper_lite config/assets.yml
+        $ rapper_lite config/static_assets.yml
+
+    Watch for changes:
+
+        $ rapper_lite --watch config/static_assets.yml
+
+    If no config file is passed in, RapperLite will search for the config file:
+
+        ./rapper.yml
+        ./assets.yml
+        ./config/rapper.yml
+        ./config/assets.yml
 
 3. That's it.
 
@@ -53,6 +64,8 @@ Rapper's got a Gemfile. You know what to do.
 
 ## Version history
 
+* **0.1.1** - Turns out you can only release `master`, which `jeweler` doesn't tell you. Oops.
+* **0.1.0** - Add CoffeeScript support. Re-write `rapper_lite` command to allow watching for changes. Add watch support to Rake task.
 * **0.0.2** - Fix gem homepage link.
 * **0.0.1** - Initial release.
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.1

data/bin/rapper_lite

@@ -1,19 +1,44 @@
 #!/usr/bin/env ruby
-# 
+
 require File.join( File.expand_path( File.dirname(__FILE__) ), '../lib/rapper_lite' )
+require "optparse"
+require "fssm"
+require "rb-fsevent"
 
-def config_path
-  return ARGV[0] if ARGV[0]
-  ["", "config/"].each do |folder|
-    ["rapper.yml", "assets.yml"].each do |file|
-      path = File.expand_path( file, folder )
-      return path if File.exists?( path )
+module RapperLite
+  class CommandLine
+    
+    attr_reader :rapper
+    
+    def initialize
+      args, options = self.parse_args
+      @config_path = args.first || RapperLite::Engine.find_config_path
+      @rapper = self.build_rapper_engine
+      options[:watch] ? @rapper.watch : @rapper.noisy_package
+    end
+    
+    def build_rapper_engine
+      puts "Loading RapperLite with #{@config_path}"
+      RapperLite::Engine.new( @config_path )
+    end
+    
+    protected
+    
+    def parse_args
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename(__FILE__)} [-w|--watch] [-h|--help] [configfile]"
+        opts.on( "-h", "--help", "Print this message") do
+          p opts
+          exit 1
+        end
+        opts.on( "-w", "--watch", "Watch files for changes") do
+          options[:watch] = true
+        end
+      end.parse!
+      [ARGV, options]
     end
   end
-  raise "No config file found."
 end
 
-config = config_path
-puts "Packaging assets, using: #{config}"
-RapperLite::Engine.new( config_path ).package
-puts "Done!"
+RapperLite::CommandLine.new

data/lib/rapper_lite.rb

@@ -1,10 +1,12 @@
+require "rubygems"
+require "bundler/setup"
 require 'yaml'
 
 module RapperLite; end
 Dir[File.expand_path( "#{File.dirname( __FILE__ )}/rapper_lite/*.rb" )].each do |file|
   require file
 end
-# TODO: Re-enable
+# TODO: Re-enable?
 # require File.dirname( __FILE__ ) + "/tasks.rb"
 
 # No batteries included, and no strings attached /
@@ -12,34 +14,35 @@ end
 # Gots to get the loot so I can bring home the bacon
 module RapperLite
   class Engine
+    include RapperLite::Build
+    include RapperLite::Compressors
     include RapperLite::Config
     include RapperLite::Utils
-    include RapperLite::Compressors
     include RapperLite::Versioning
     
     def initialize( config_path )
-      @config = {}
-      @definitions = Struct.new( :css, :js ).new
       self.load_config( config_path )
     end
     
+    def self.find_config_path
+      ["./", "config/"].each do |folder|
+        ["rapper.yml", "assets.yml"].each do |file|
+          path = File.expand_path( file, folder )
+          return path if File.exists?( path )
+        end
+      end
+      raise "No config file found."
+    end
+    
     def package
       [:js, :css].each do |type|
         definition = @definitions[type]
         source = File.expand_path( self.root( type ) )
         
         definition.each do |name, spec|
-          next if name == "root" || name == "destination"
+          next if self.config_key?( name ) # Skip config settings
           next unless self.needs_packaging?( type, name )
-          
-          source_files = self.file_paths( type, name )
-          destination_file = self.destination_path( type, name )
-          
-          self.join_files( source_files, destination_file )
-          
-          if self.compress?
-            self.compress( destination_file )
-          end
+          self.build_package( type, name )
         end
       end
       

data/lib/rapper_lite/build.rb

@@ -0,0 +1,31 @@
+require "coffee-script"
+
+module RapperLite::Build
+  
+  def build_package( type, name )
+    source_paths = self.file_paths( type, name )
+    destination_file = self.destination_path( type, name )
+    tempfiles = []
+    
+    # Convert any CoffeeScript to JS
+    if type == :js
+      source_paths.map! do |source_path|
+        if File.extname( source_path ) == ".coffee"
+          tempfile = Tempfile.new( "rapper_lite_coffee" )
+          tempfile.write( CoffeeScript.compile( File.read( source_path ) ) )
+          tempfile.close
+          tempfile.path
+        else
+          source_path
+        end
+      end
+    end
+    
+    # Join files and compress if needed
+    self.join_files( source_paths, destination_file )
+    self.compress( destination_file ) if self.compress?( type )
+    
+    # Cleanup
+    tempfiles.each{ |tempfile| tempfile.unlink }
+  end
+end

data/lib/rapper_lite/compressors.rb

@@ -9,11 +9,11 @@ rescue LoadError; end
 module RapperLite::Compressors
   
   # Compress a file in-place. Relies on the file's suffix to determine type.
-  def compress( file )
+  def compress( file_path )
     opts = {}
     # TODO: Someday this goes away.
-    opts = self.yui_config if file =~ /\.js/
-    RapperLite::Compressors::Compressor.compress( file, opts )
+    opts = self.yui_config if file_path =~ /\.js/
+    RapperLite::Compressors::Compressor.compress( file_path, opts )
   end
   
   protected

data/lib/rapper_lite/config.rb

@@ -1,32 +1,18 @@
 module RapperLite::Config
   
-  protected
-  
-  def load_config( config_path )
-    @config_path = config_path
-    @config = YAML.load_file( config_path )
-    @definitions.css = @config["css"]
-    @definitions.js = @config["js"]
-  end
-  
-  def save_config
-    File.open( @config_path, "w" ) do |file|
-      file.puts @config.to_yaml
-    end
-  end
-  
+  # Source path for files of the given type.
   def root( type )
-    assert_type!( type )
-    @definitions.send( type )["root"] || @config["root"] || "."
+    self.config_or_default( "root", type, "." )
   end
   
+  # Destination path for files of the given type.
   def destination( type )
-    assert_type!( type )
-    @definitions.send( type )["destination"] || @config["destination"] || "."
+    self.config_or_default( "destination", type, "." )
   end
   
-  def compress?
-    @config.key?( "compress" ) ? @config["compress"] : false
+  # True if we should compress files of the given type.
+  def compress?( type )
+    self.config_or_default( "compress", type, false )
   end
   
   def yui_config
@@ -40,13 +26,16 @@ module RapperLite::Config
   
   # Array of source files for the given asset package.
   def file_paths( type, name )
-    definition = @definitions[type][name]
-    root = self.root( type )
-    definition["files"].map do |file|
+    @definitions[type][name]["files"].map do |file|
       if file[0] == "+"
+        # Include other asset package
         self.file_paths( type, file[1..-1] )
+      elsif type == :js
+        coffee_path = File.join( self.root( type ), "#{file}.coffee" )
+        js_path = File.join( self.root( type ), "#{file}.js" )
+        File.exists?( coffee_path ) ? coffee_path : js_path
       else
-        File.join( root, "#{file}.#{type}" )
+        File.join( self.root( type ), "#{file}.#{type}" )
       end
     end.flatten
   end
@@ -55,7 +44,29 @@ module RapperLite::Config
     File.join( self.destination( type ), "#{name}.#{type}" )
   end
   
-  def assert_type!( type )
-    raise "wat." unless type == :css || type == :js
+  protected
+  
+  def load_config( config_path )
+    @config_path = config_path
+    @config = YAML.load_file( @config_path )
+    @definitions = {
+      :css => @config["css"],
+      :js => @config["js"]
+    }
+  end
+  
+  # Write in-memory config to file (i.e. just update version strings).
+  def save_config
+    File.open( @config_path, "w" ) do |file|
+      file.puts( @config.to_yaml )
+    end
+  end
+  
+  def config_or_default( key, type, default )
+    if @definitions[type].key?( key )
+      @definitions[type][key]
+    else
+      @config.key?( key ) ? @config[key] : default
+    end
   end
 end

data/lib/rapper_lite/utils.rb

@@ -1,19 +1,23 @@
-# Rapper-wide utility methods for working with paths, files, etc.
 module RapperLite::Utils
-  
+
   protected
-  
-  # Concatenate one or more files. Uses <code>cat</code>.
-  # 
-  # @param [Array<String>,String] source_files A  path or array of paths to
-  # files to concatenate.
-  # 
-  # @param [String] destination_file Destination for concatenated output.
-  def join_files( source_files, destination_file )
-    source_files = Array( source_files )
-    source_files.any? do |path|
+
+  # Concatenate one or more files by shelling out to `cat`.
+  def join_files( source_paths, destination_path )
+    source_paths = Array( source_paths )
+    source_paths.each do |path|
       raise "#{path} doesn't exist." unless File.exists?( path )
     end
-    system "cat #{source_files.join( " " )} > #{destination_file}"
+    
+    system "cat #{source_paths.join( " " )} > #{destination_path}"
+  end
+
+  # True if the given string is a reserved config key name.
+  def config_key?( key )
+    self.config_keys.include?( key )
+  end
+  
+  def config_keys
+    %w( root destination compress )
   end
 end

data/lib/rapper_lite/versioning.rb

@@ -4,35 +4,29 @@ require 'tempfile'
 # Asset versioning methods.
 module RapperLite::Versioning
   
+  def needs_packaging?( type, name )
+    return true unless File.exists?( self.destination_path( type, name ) )
+    self.version( type, name ) != @definitions[type][name]["version"]
+  end
+  
   protected
   
-  def needs_packaging?( type, name )
-    definition = @definitions[type][name]
-    destination_file = self.destination_path( type, name )
-    return true unless File.exists?( destination_file )
-    
-    current_version = definition["version"]
-    new_version = self.version( type, name )
-    new_version != current_version
+  # MD5 version of the concatenated raw asset package.
+  def version( type, name )
+    source_paths = self.file_paths( type, name )
+    destination_file = Tempfile.new( 'rapper' )
+    self.join_files( source_paths, destination_file.path )
+    version = Digest::MD5.file( destination_file.path ).to_s[0,7]
+    destination_file.unlink
+    version
   end
   
   def refresh_versions
     [:css, :js].each do |type|
       @definitions[type].each do |name, spec|
-        next if name == "root" || name == "destination"
+        next if self.config_key?( name )
         @definitions[type][name]["version"] = self.version( type, name )
       end
     end
   end
-  
-  # MD5 version of the concatenated asset package.
-  def version( type, name )
-    definition = @definitions[type][name]
-    source_files = self.file_paths( type, name )
-    destination_file = Tempfile.new( 'rapper' )
-    self.join_files( source_files, destination_file.path )
-    version = Digest::MD5.file( destination_file.path ).to_s[0,4]
-    destination_file.unlink
-    version
-  end
 end

data/lib/rapper_lite/watch_support.rb

@@ -0,0 +1,46 @@
+module RapperLite
+  class Engine
+    
+    def watch
+      rapper = self
+      rapper.noisy_package
+      FSSM.monitor( rapper.common_root, '**/*.{css,js,coffee}' ) do
+        component_files = rapper.all_component_paths
+        update do |base, relative|
+          if component_files.include?( File.join( base, relative) )
+            rapper.noisy_package
+          end
+        end
+      end
+    end
+    
+    def noisy_package
+      print( "Compiling static assets..." ) && STDOUT.flush
+      self.package
+      puts " Done!"
+    end
+    
+    # LCD for JS and CSS roots
+    def common_root
+      js_path = File.expand_path( self.root( :js ) ).split( "/" )
+      css_path = File.expand_path( self.root( :css ) ).split( "/" )
+      path = []
+      while js_component = js_path.shift && css_component = css_path.shift
+        break if js_component != css_component
+        path << js_component
+      end
+      path.join( "/" )
+    end
+    
+    # All absolute file paths for the component files
+    def all_component_paths
+      [:css, :js].map do |type|
+        (@definitions[type].keys - self.config_keys).map do |name|
+          self.file_paths( type, name )
+        end
+      end.flatten.uniq.map do |path|
+        File.expand_path( path )
+      end
+    end
+  end
+end

data/lib/tasks.rb

@@ -1,4 +1,4 @@
-module Rapper
+module RapperLite
   
   # Rake tasks for building / refreshing packages
   class Tasks
@@ -31,6 +31,16 @@ module Rapper
         task :package do
           @rapper.package
         end
+        
+        desc "Watch static assets and re-package when necessary"
+        task :watch do
+          begin
+            RapperLite::Engine.method( :watch )
+          rescue NameError
+            raise "You need to `require 'rapper_lite/watch_support'`, first."
+          end
+          @rapper.watch
+        end
       end
     end
   end

data/rapper_lite.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rapper_lite"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tyson Tate"]
@@ -26,13 +26,16 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/rapper_lite",
     "lib/rapper_lite.rb",
+    "lib/rapper_lite/build.rb",
     "lib/rapper_lite/compressors.rb",
     "lib/rapper_lite/config.rb",
     "lib/rapper_lite/utils.rb",
     "lib/rapper_lite/versioning.rb",
+    "lib/rapper_lite/watch_support.rb",
     "lib/tasks.rb",
     "lib/yui/css_compressor.rb",
     "rapper_lite.gemspec",
+    "spec/fixtures/src/coffeescript.coffee",
     "spec/fixtures/src/simple_1.css",
     "spec/fixtures/src/simple_1.js",
     "spec/fixtures/src/simple_2.css",

data/spec/fixtures/src/coffeescript.coffee

@@ -0,0 +1 @@
+x: -> true

data/spec/fixtures/testcases/combination/expected/base_combined.js

@@ -1 +1 @@
-a=1;b=2;function b(){return false}var x=1;var y=2;function a(){return true}a=1;b=2;function b(){return false};
+a=1;b=2;function b(){return false}var x=1;var y=2;function a(){return true}a=1;b=2;function b(){return false}(function(){({x:function(){return true}})}).call(this);

data/spec/fixtures/testcases/combination/rapper.yml

@@ -7,20 +7,21 @@
     - files:
       - simple_1
       - simple_2
-    - version: 683e
+    - version: 683e7ae
   - base_combined: !omap
     - files:
       - +base
       - simple_1
-    - version: 0bb9
+    - version: 0bb9443
 - js: !omap
   - base: !omap
     - files:
       - simple_1
       - subfolder/simple_2
-    - version: f3d9
+    - version: f3d92a9
   - base_combined: !omap
     - files:
       - subfolder/simple_2
       - +base
-    - version: ccfc
+      - coffeescript
+    - version: 75d7058

data/spec/fixtures/testcases/concatenation/expected/base_combined.js

@@ -13,3 +13,10 @@ b = 2;
 function b() {
   return false;
 }
+(function() {
+  ({
+    x: function() {
+      return true;
+    }
+  });
+}).call(this);

data/spec/fixtures/testcases/concatenation/rapper.yml

@@ -7,20 +7,21 @@
     - files:
       - simple_1
       - simple_2
-    - version: 683e
+    - version: 683e7ae
   - base_combined: !omap
     - files:
       - +base
       - simple_1
-    - version: 0bb9
+    - version: 0bb9443
 - js: !omap
   - base: !omap
     - files:
       - simple_1
       - subfolder/simple_2
-    - version: f3d9
+    - version: f3d92a9
   - base_combined: !omap
     - files:
       - subfolder/simple_2
       - +base
-    - version: ccfc
+      - coffeescript
+    - version: 75d7058

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapper_lite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70109260465380 !ruby/object:Gem::Requirement
+  requirement: &70105090745260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70109260465380
+  version_requirements: *70105090745260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70109260464820 !ruby/object:Gem::Requirement
+  requirement: &70105090744000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70109260464820
+  version_requirements: *70105090744000
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70109260464280 !ruby/object:Gem::Requirement
+  requirement: &70105090743240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109260464280
+  version_requirements: *70105090743240
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70109260463420 !ruby/object:Gem::Requirement
+  requirement: &70105090742340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.8
   type: :development
   prerelease: false
-  version_requirements: *70109260463420
+  version_requirements: *70105090742340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70109260462240 !ruby/object:Gem::Requirement
+  requirement: &70105090741660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70109260462240
+  version_requirements: *70105090741660
 - !ruby/object:Gem::Dependency
   name: yui-compressor
-  requirement: &70109260461600 !ruby/object:Gem::Requirement
+  requirement: &70105090740380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.9.6
   type: :development
   prerelease: false
-  version_requirements: *70109260461600
+  version_requirements: *70105090740380
 - !ruby/object:Gem::Dependency
   name: fssm
-  requirement: &70109260460580 !ruby/object:Gem::Requirement
+  requirement: &70105090739480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.2.7
   type: :development
   prerelease: false
-  version_requirements: *70109260460580
+  version_requirements: *70105090739480
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70109260459860 !ruby/object:Gem::Requirement
+  requirement: &70105090737600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109260459860
+  version_requirements: *70105090737600
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &70109260458840 !ruby/object:Gem::Requirement
+  requirement: &70105090735640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70109260458840
+  version_requirements: *70105090735640
 description: Simple static asset packaging. Compresses files only when they're updated.
 email: tyson@tysontate.com
 executables:
@@ -127,13 +127,16 @@ files:
 - VERSION
 - bin/rapper_lite
 - lib/rapper_lite.rb
+- lib/rapper_lite/build.rb
 - lib/rapper_lite/compressors.rb
 - lib/rapper_lite/config.rb
 - lib/rapper_lite/utils.rb
 - lib/rapper_lite/versioning.rb
+- lib/rapper_lite/watch_support.rb
 - lib/tasks.rb
 - lib/yui/css_compressor.rb
 - rapper_lite.gemspec
+- spec/fixtures/src/coffeescript.coffee
 - spec/fixtures/src/simple_1.css
 - spec/fixtures/src/simple_1.js
 - spec/fixtures/src/simple_2.css
@@ -220,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 819027011091602425
+      hash: 3082783424749448526
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: