stapler 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Rykov
+
+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.md

@@ -0,0 +1,47 @@
+= stapler 
+
+== DESCRIPTION:
+
+Stapler uses YUI Compressor to automatically compress cached assets in Rails
+
+== FEATURES/PROBLEMS:
+
+* Support both CSS and Javascript 
+
+== REQUIREMENTS:
+
+* yuicompressor gem
+
+== INSTALL:
+
+* gem install stapler
+
+== REFERENCES:
+
+  * YUI Compressor
+    http://developer.yahoo.com/yui/compressor/ 
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009  Michael Rykov 
+
+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/Rakefile

@@ -0,0 +1,7 @@
+task :default => :spec
+task :test    => :spec
+
+desc "Run specs"
+task :spec do
+  exec "spec spec/stapler_spec.rb"
+end

data/lib/stapler.rb

@@ -0,0 +1,16 @@
+#--
+# Copyright (c) 2009 Michael Rykov
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'yuicompressor'
+require 'stapler/config'
+require 'stapler/compressor'
+require 'stapler/stapler'
+require 'stapler/helper'
+require 'stapler/middleware'
+
+if defined?(::ActionView::Helpers)
+  ::ActionView::Helpers.send(:include, Stapler::Helper)
+end

data/lib/stapler/compressor.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright (c) 2009 Michael Rykov
+#++
+
+module Stapler
+  class Compressor
+    def initialize(from, to)
+      @from_path = from
+      @to_path = to
+    end
+
+    def compress!
+      compress(@from_path, @to_path)
+      logger.info("[Stapler] Compressed #{@from_path}")
+    rescue => e
+      logger.warn("[Stapler] Compression failure for #{@from_path}: #{e}")
+      FileUtil.cp(@from_path, @to_path)
+    end
+
+  protected
+    def compress(from, to)
+      out = File.open(from) do |from_file|
+        if from =~ /\.css$/
+          YUICompressor.compress_css(from_file)
+        elsif from =~ /\.js$/
+          YUICompressor.compress_js(from_file, :munge => true)
+        else
+          raise StandardError.new("Unrecognized file type")
+        end
+      end
+
+      File.open(to, 'w') { |f| f.write(out) }
+    end
+
+    def logger
+      Rails.logger
+    end
+  end
+end
+

data/lib/stapler/config.rb

@@ -0,0 +1,15 @@
+#--
+# Copyright (c) 2009 Michael Rykov
+#
+# TODO: Make path selectors configurable
+#++
+
+module Stapler
+  module Config
+    WHITELIST = [%r{^/javascripts/.*\.js$}, %r{^/stylesheets/.*\.css$}]
+
+    def self.stapleable?(source)
+      ActionController::Base.perform_caching && WHITELIST.any? { |re| source =~ re }
+    end
+  end
+end

data/lib/stapler/helper.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2009 Michael Rykov
+#++
+
+module Stapler
+  module Helper
+    StaplerRoot = "/stapler"
+
+    def self.included(base)
+      base.send :alias_method_chain, :rewrite_asset_path, :stapler
+      #base.send :alias_method_chain, :compute_asset_host, :stapler
+    end
+
+  private
+    def rewrite_asset_path_with_stapler(source)
+      if Config.stapleable?(source)
+        @@stapler ||= Stapler.new
+        stapled_source = "#{StaplerRoot}#{source}"
+        stapled_path = asset_file_path(stapled_source)
+
+        if @@stapler.ready?(stapled_path)
+          source = stapled_source
+        else
+          @@stapler.process(asset_file_path(source), stapled_path)
+        end
+      end
+
+      rewrite_asset_path_without_stapler(source)
+    end
+
+    #def compute_asset_host_with_stapler(source)
+    #  compute_asset_host_without_stapler(source)
+    #end
+  end
+end

data/lib/stapler/middleware.rb

@@ -0,0 +1,35 @@
+module Stapler
+  class Middleware
+    ASSETS_DIR = defined?(Rails.public_path) ? Rails.public_path : "public"
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      path = env['PATH_INFO']
+      puts "LOOKING AT PATH #{path}"
+
+      if path =~ %r(^/stapler/(.*)$)
+        stapler_call(env, $1)
+      else
+        @app.call(env)
+      end
+    end
+
+  private
+    def stapler_call(env, path)
+      file_path = asset_file_path(path)
+
+      if File.file?(file_path)
+        [200, {"Content-Type" => "text/plain"}, ['NOT DONE!']]
+      else
+        [404, {"Content-Type" => "text/html"}, ["Not Found!"]]
+      end
+    end
+
+    def asset_file_path(path)
+      File.join(ASSETS_DIR, path.split('?').first)
+    end
+  end
+end

data/lib/stapler/stapler.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2009 Michael Rykov
+#++
+
+module Stapler
+  class Stapler
+
+    def initialize
+      @in_progress = {}
+      @in_progress_guard = Mutex.new
+    end
+
+    def ready?(path)
+      !@in_progress[path] && File.exists?(path)
+    end
+
+    def process(from, to)
+      @in_progress_guard.synchronize do
+        return if @in_progress[to]
+        @in_progress[to] = true
+      end
+
+      Thread.new { self.compress(from, to) }
+    end
+
+  protected
+    def compress(from, to)
+      FileUtils.mkdir_p(File.dirname(to))
+      Compressor.new(from, to).compress!
+      @in_progress.delete(to)
+    end
+  end
+end

data/lib/tasks/stapler.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'tasks')

data/lib/tasks/tasks.rb

@@ -0,0 +1,24 @@
+# Re-definitions are appended to existing tasks
+task :environment
+task :merb_env
+
+namespace :stapler do
+  PUBLIC_DIR = "#{RAILS_ROOT}/public"
+  STAPLE_DIR = "#{PUBLIC_DIR}/stapler"
+  
+  desc "Staple all files"
+  task :run => [:merb_env, :environment, :clean] do
+    file_list = FileList["#{PUBLIC_DIR}/javascripts/**/*.js", "#{PUBLIC_DIR}/stylesheets/**/*.css"]
+    file_list.each do |from|
+      to = from.gsub(/#{PUBLIC_DIR}/, STAPLE_DIR)
+      FileUtils.mkdir_p(File.dirname(to))
+      puts "[Stapler] Stapling #{from} to #{to}"
+      Stapler::Compressor.new(from, to).compress!
+    end
+  end
+
+  task :clean => [:merb_env, :environment] do |t, args|
+    puts "[Stapler] Cleaning #{STAPLE_DIR}"
+    FileUtils.rm_rf(STAPLE_DIR)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: stapler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Rykov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yuicompressor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
+description: |
+  Dynamic asset compression for Rails using YUI Compressor
+
+email: mrykov@gmail
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/stapler/compressor.rb
+- lib/stapler/config.rb
+- lib/stapler/helper.rb
+- lib/stapler/middleware.rb
+- lib/stapler/stapler.rb
+- lib/stapler.rb
+- lib/tasks/stapler.rake
+- lib/tasks/tasks.rb
+has_rdoc: false
+homepage: http://github.com/rykov/stapler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Dynamic asset compression for Rails
+test_files: []
+