rapper_lite 0.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rake", "~> 0.9.2"
+  gem "rspec", "~> 1.3.2"
+  gem "yard"
+  gem "rdiscount", "~> 1.6.8"
+  gem "jeweler", "~> 1.6.4"
+  gem "yui-compressor", "~> 0.9.6"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    POpen4 (0.1.4)
+      Platform (>= 0.4.0)
+      open4
+    Platform (0.4.0)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    open4 (1.0.1)
+    rake (0.9.2)
+    rdiscount (1.6.8)
+    rspec (1.3.2)
+    yard (0.6.4)
+    yui-compressor (0.9.6)
+      POpen4 (>= 0.1.4)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.6.4)
+  rake (~> 0.9.2)
+  rdiscount (~> 1.6.8)
+  rspec (~> 1.3.2)
+  yard
+  yui-compressor (~> 0.9.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tyson Tate
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,65 @@
+# 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.
+
+## Packaging assets without wanting to claw your eyes out
+
+1. Create a config file:
+
+        --- !omap
+        - root: public/javascripts/
+        - destination: public/assets/
+        - compress: true
+        - css: !omap
+          - base: !omap
+            - files:
+              - reset
+              - layout
+              - typography
+              - colores
+            - version: 683e
+        - js: !omap
+          - mootools: !omap
+            - files:
+              - mootools-core
+              - mootools-more
+            - version: f3d9
+          - base_combined: !omap
+            - files:
+              - preloader
+              - +mootools
+              - widgets
+            - version: ccfc
+
+2. Load `rapper` with the config path:
+
+        engine = Rapper::Engine.new( "config/rapper.yml" )
+
+3. Then package the assets:
+
+        engine.package
+
+# Development
+
+Rapper's got a Gemfile. You know what to do.
+
+    bundle package
+    bundle exec rake spec
+
+## Version history
+
+* **0.0.1** - Initial release.
+
+## Contributing to rapper_lite
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Tyson Tate. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,31 @@
+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.name = "rapper_lite"
+  gem.homepage = "http://tysontate.github.com/rapper_lite/"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple static asset packaging.}
+  gem.description = %Q{Simple static asset packaging. Compresses files only when they're updated.}
+  gem.email = "tyson@tysontate.com"
+  gem.authors = ["Tyson Tate"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/rapper_lite

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# 
+require File.join( File.expand_path( File.dirname(__FILE__) ), '../lib/rapper_lite' )
+
+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 )
+    end
+  end
+  raise "No config file found."
+end
+
+config = config_path
+puts "Packaging assets, using: #{config}"
+RapperLite::Engine.new( config_path ).package
+puts "Done!"

data/lib/rapper_lite/compressors.rb

@@ -0,0 +1,109 @@
+require File.expand_path( File.dirname( __FILE__ ) + "/../yui/css_compressor.rb" )
+require 'fileutils'
+begin
+  require "yui/compressor"
+rescue LoadError; end
+
+# Compression handlers for various types of assets. And by "various" I mean
+# JavaScript and CSS.
+module RapperLite::Compressors
+  
+  # Compress a file in-place. Relies on the file's suffix to determine type.
+  def compress( file )
+    opts = {}
+    # TODO: Someday this goes away.
+    opts = self.yui_config if file =~ /\.js/
+    RapperLite::Compressors::Compressor.compress( file, opts )
+  end
+  
+  protected
+  
+  # Base class for a compression handler.
+  class Compressor
+    class << self
+      
+      # Compress a file. Raises an error if it doesn't know how to compress a
+      # file with the given file's file extension.
+      def compress( file_path, opts={} )
+        unless compressor = @extensions[File.extname( file_path )]
+          raise "RapperLite doesn't know how to compress #{file_path}"
+        end
+        
+        compressor.do_compress( file_path, opts )
+      end
+      
+      protected
+      
+      attr_accessor :extensions
+      
+      # Register `self` as a file compressor for the given file extension.
+      def register( extension )
+        superclass.extensions ||= {}
+        superclass.extensions[extension] = self
+      end
+      
+      def do_compress( file_path )
+        raise NotImplementedError
+      end
+      
+      def read_file( file_path )
+        File.read( file_path )
+      end
+      
+      # Get a writable file instance with 0644 permissions.
+      def writable_file( file_path )
+        File.new( file_path, 'w', 0644 )
+      end
+    end
+  end
+  
+  # Use Richard Hulse's Ruby port of the YUI CSS Compressor to compress the
+  # contents of a CSS file.
+  class CSSCompressor < Compressor
+    register ".css"
+    
+    def self.do_compress( file_path, opts={} )
+      return unless compressor_available?
+      
+      css = read_file( file_path )
+      css = YUI::CSS.compress( css )
+      destination = writable_file( file_path )
+      
+      destination.write( css )
+      destination.write "\n"
+      destination.close
+    end
+    
+    def self.compressor_available?
+      YUI::CSS.is_a?( Class )
+    rescue NameError
+      false
+    end
+  end
+  
+  # Uses YUI Compressor (via Sam Stephenson's yui-compressor gem) to compress
+  # JavaScrpt.
+  class JSCompressor < Compressor
+    register ".js"
+    
+    def self.do_compress( file_path, opts={} )
+      return unless compressor_available?
+      
+      compressor = YUI::JavaScriptCompressor.new( opts )
+      
+      js = read_file( file_path )
+      destination = writable_file( file_path )
+      
+      destination.write( compressor.compress( js ) )
+      destination.write "\n"
+      destination.close
+    end
+    
+    def self.compressor_available?
+      YUI::JavaScriptCompressor.is_a?( Class )
+    rescue NameError
+      false
+    end
+  end
+  
+end

data/lib/rapper_lite/config.rb

@@ -0,0 +1,61 @@
+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
+  
+  def root( type )
+    assert_type!( type )
+    @definitions.send( type )["root"] || @config["root"] || "."
+  end
+  
+  def destination( type )
+    assert_type!( type )
+    @definitions.send( type )["destination"] || @config["destination"] || "."
+  end
+  
+  def compress?
+    @config.key?( "compress" ) ? @config["compress"] : false
+  end
+  
+  def yui_config
+    @yui_config ||= {
+      "line_break" => 2000,
+      "munge" => false,
+      "optimize" => true,
+      "preserve_semicolons" => false
+    }.merge( @config["yui_compressor"] || {} )
+  end
+  
+  # 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|
+      if file[0] == "+"
+        self.file_paths( type, file[1..-1] )
+      else
+        File.join( root, "#{file}.#{type}" )
+      end
+    end.flatten
+  end
+  
+  def destination_path( type, name )
+    File.join( self.destination( type ), "#{name}.#{type}" )
+  end
+  
+  def assert_type!( type )
+    raise "wat." unless type == :css || type == :js
+  end
+end

data/lib/rapper_lite/utils.rb

@@ -0,0 +1,19 @@
+# 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|
+      raise "#{path} doesn't exist." unless File.exists?( path )
+    end
+    system "cat #{source_files.join( " " )} > #{destination_file}"
+  end
+end

data/lib/rapper_lite/versioning.rb

@@ -0,0 +1,38 @@
+require 'digest/md5'
+require 'tempfile'
+
+# Asset versioning methods.
+module RapperLite::Versioning
+  
+  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
+  end
+  
+  def refresh_versions
+    [:css, :js].each do |type|
+      @definitions[type].each do |name, spec|
+        next if name == "root" || name == "destination"
+        @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.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+
+module RapperLite; end
+Dir[File.expand_path( "#{File.dirname( __FILE__ )}/rapper_lite/*.rb" )].each do |file|
+  require file
+end
+# TODO: Re-enable
+# require File.dirname( __FILE__ ) + "/tasks.rb"
+
+# No batteries included, and no strings attached /
+# No holds barred, no time for move fakin' /
+# Gots to get the loot so I can bring home the bacon
+module RapperLite
+  class Engine
+    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 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 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
+        end
+      end
+      
+      self.refresh_versions
+      self.save_config
+    end
+  end
+end

data/lib/tasks.rb

@@ -0,0 +1,37 @@
+module Rapper
+  
+  # Rake tasks for building / refreshing packages
+  class Tasks
+    
+    # Set up rapper asset packaging Rake tasks.
+    # 
+    # @param [Symbol] namespace The Rake namespace to put the generated
+    # tasks under.
+    # 
+    # @yield [config] Configuration hash. `:path` should be the path to the
+    # configuration YAML file. `:env` is the optional environment. Defaults to
+    # `:production`.
+    def initialize( namespace = :rapper, &block )
+      @namespace = namespace
+      @config = {
+        :path => "rapper.yml"
+      }
+      yield @config
+      @rapper = RapperLite::Engine.new( @config[:path] )
+      self.define
+    end
+    
+    private
+    
+    # Creates all rapper rake tasks: package all assets, package assets for
+    # each type.
+    def define
+      namespace @namespace do
+        desc "Package static assets that need re-packaging"
+        task :package do
+          @rapper.package
+        end
+      end
+    end
+  end
+end