fingerjam 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.0"
+gem "jammit"
+gem "capistrano"
+
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.2)
+      actionpack (= 3.0.2)
+      mail (~> 2.2.9)
+    actionpack (3.0.2)
+      activemodel (= 3.0.2)
+      activesupport (= 3.0.2)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.2)
+      activesupport (= 3.0.2)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.2)
+      activemodel (= 3.0.2)
+      activesupport (= 3.0.2)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.2)
+      activemodel (= 3.0.2)
+      activesupport (= 3.0.2)
+    activesupport (3.0.2)
+    arel (2.0.2)
+    builder (2.1.2)
+    capistrano (2.5.19)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.0.0)
+    closure-compiler (0.3.3)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    highline (1.6.1)
+    i18n (0.4.2)
+    jammit (0.5.4)
+      closure-compiler (>= 0.1.0)
+      yui-compressor (>= 0.9.1)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.9.1)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.0.23)
+    net-ssh-gateway (1.0.1)
+      net-ssh (>= 1.99.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.2)
+      actionmailer (= 3.0.2)
+      actionpack (= 3.0.2)
+      activerecord (= 3.0.2)
+      activeresource (= 3.0.2)
+      activesupport (= 3.0.2)
+      bundler (~> 1.0.0)
+      railties (= 3.0.2)
+    railties (3.0.2)
+      actionpack (= 3.0.2)
+      activesupport (= 3.0.2)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    thor (0.14.4)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    yui-compressor (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  capistrano
+  jammit
+  jeweler (~> 1.5.1)
+  rails (>= 3.0.0)
+  rcov
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Steve Hoeksema
+
+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.rdoc

@@ -0,0 +1,36 @@
+= fingerjam
+
+Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely.
+
+Fingerjam will install a capistrano task to package assets with Jammit, write config/assets.lock.yml, and upload the files to the web.
+
+== Usage
+
+* Configure Capistrano & Jammit
+
+* Add code similar to the following to config/deploy.rb:
+
+    set :cache_to, "/srv/www/cache.example.com/public/"
+    require "fingerjam/capistrano"
+
+* Add code similar to the following to config/initializers/fingerjam.rb:
+
+    Fingerjam::Base.configure(:host => "cache.example.com")
+
+* Execute cap deploy
+
+    bundle exec cap deploy
+
+== Contributing to fingerjam
+
+* 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) 2010 Steve Hoeksema. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fingerjam"
+  gem.homepage = "http://github.com/steveh/fingerjam"
+  gem.license = "MIT"
+  gem.summary = %Q{Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely}
+  gem.description = %Q{Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely}
+  gem.email = "steve@seven.net.nz"
+  gem.authors = ["Steve Hoeksema"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fingerjam #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fingerjam.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fingerjam}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Hoeksema"]
+  s.date = %q{2010-11-16}
+  s.description = %q{Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely}
+  s.email = %q{steve@seven.net.nz}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fingerjam.gemspec",
+    "lib/fingerjam.rb",
+    "lib/fingerjam/base.rb",
+    "lib/fingerjam/capistrano.rb",
+    "lib/fingerjam/helpers.rb",
+    "lib/fingerjam/jammit.rb",
+    "lib/fingerjam/railtie.rb",
+    "lib/tasks/fingerjam.rake",
+    "spec/fingerjam_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/steveh/fingerjam}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely}
+  s.test_files = [
+    "spec/fingerjam_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<jammit>, [">= 0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<jammit>, [">= 0"])
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<jammit>, [">= 0"])
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/fingerjam/base.rb

@@ -0,0 +1,51 @@
+require "digest/md5"
+require "yaml"
+
+module Fingerjam
+  class Base
+
+    cattr_accessor :host
+    cattr_accessor :lockfile
+    cattr_accessor :enabled
+    cattr_accessor :hashes
+
+    class << self
+
+      def configure(opts = {})
+        self.host = opts.delete(:host)
+        self.lockfile = opts.delete(:lockfile) || File.join(Rails.root, "config", "assets.lock.yml")
+        self.hashes = YAML.load_file(lockfile)
+        self.enabled = hashes.present? && Rails.env.production?
+      rescue Errno::ENOENT
+        self.hashes = {}
+        self.enabled = false
+      end
+
+      def enabled?
+        enabled
+      end
+
+      def hashed?(relative_path)
+        hashes.has_key?(relative_path)
+      end
+
+      def hashed_path(relative_path)
+        generate_path(relative_path, hashes[relative_path])
+      end
+
+      def generate_path(relative_path, hash)
+        "http://%s/%s%s" % [host, hashes[relative_path], relative_path]
+      end
+
+      def extensions
+        %w{js css png jpg gif}
+      end
+
+      def generate_hash(absolute_path)
+        Digest::MD5.hexdigest(absolute_path.to_s)
+      end
+
+    end
+
+  end
+end

data/lib/fingerjam/capistrano.rb

@@ -0,0 +1,27 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :fingerjam do
+
+    desc "Package, lock and upload assets"
+    task :upload, { :roles => :web } do
+      run_locally "rake fingerjam:package"
+      run_locally "rake fingerjam:lock"
+
+      lockfile = File.realpath(File.join("config", "assets.lock.yml"))
+      public_path = File.realpath(File.join("public"))
+
+      YAML.load_file(lockfile).each do |path, hash|
+        local_path = File.join(public_path, path)
+        remote_path = File.join(cache_to, hash, path)
+        run "mkdir -p #{File.dirname(remote_path)}"
+        top.upload(local_path, remote_path)
+      end
+
+      top.upload(lockfile, File.join(release_path, "config", "assets.lock.yml"))
+    end
+
+  end
+
+  after "deploy:finalize_update", "fingerjam:upload"
+
+end

data/lib/fingerjam/helpers.rb

@@ -0,0 +1,23 @@
+module Fingerjam
+  module Helpers
+
+    # Used by Rails view helpers
+    def rewrite_asset_path(source, path = nil)
+      return Fingerjam::Base.hashed_path(source) if Fingerjam::Base.enabled? && Fingerjam::Base.hashed?(source)
+
+      if path && path.respond_to?(:call)
+        return path.call(source)
+      elsif path && path.is_a?(String)
+        return path % [source]
+      end
+
+      asset_id = rails_asset_id(source)
+      if asset_id.blank?
+        source
+      else
+        source + "?#{asset_id}"
+      end
+    end
+
+  end
+end

data/lib/fingerjam/jammit.rb

@@ -0,0 +1,13 @@
+module Jammit
+  class Compressor
+
+    # Used by rake fingerjam:package
+    def rewrite_asset_path(path, file_path)
+      return Fingerjam::Base.generate_path(path, Fingerjam::Base.generate_hash(file_path))
+
+      asset_id = rails_asset_id(file_path)
+      (!asset_id || asset_id == '') ? path : "#{path}?#{asset_id}"
+    end
+
+  end
+end

data/lib/fingerjam/railtie.rb

@@ -0,0 +1,14 @@
+require "fingerjam"
+require "rails"
+
+module Fingerjam
+  class Railtie < Rails::Railtie
+    initializer "fingerjam.configure_rails_initialization" do
+      ActionView::Base.send(:include, Fingerjam::Helpers)
+    end
+
+    rake_tasks do
+      load "tasks/fingerjam.rake"
+    end
+  end
+end

data/lib/fingerjam.rb

@@ -0,0 +1,4 @@
+require "fingerjam/base"
+require "fingerjam/helpers"
+require "fingerjam/jammit"
+require "fingerjam/railtie.rb"

data/lib/tasks/fingerjam.rake

@@ -0,0 +1,28 @@
+require "pathname"
+require "yaml"
+require "jammit"
+
+namespace :fingerjam do
+
+  desc "Package assets with Jammit"
+  task :package => :environment do
+    Jammit.package!(:force => true)
+  end
+
+  desc "Lock packages to assets.lock.yml"
+  task :lock => :environment do
+    relative_root = Pathname.new(Rails.root) + "public"
+
+    hashes = {}
+
+    Pathname.glob(relative_root + "**" + "*.{#{Fingerjam::Base.extensions.join(",")}}").each do |absolute_path|
+      relative_path = "/" + absolute_path.relative_path_from(relative_root).to_s
+      hashes[relative_path] = Fingerjam::Base.generate_hash(absolute_path)
+    end
+
+    File.open(Fingerjam::Base.lockfile, "w") do |lockfile|
+      lockfile.puts hashes.to_yaml
+    end
+  end
+
+end

data/spec/fingerjam_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Fingerjam" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fingerjam'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification 
+name: fingerjam
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Hoeksema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-16 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jammit
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely
+email: steve@seven.net.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fingerjam.gemspec
+- lib/fingerjam.rb
+- lib/fingerjam/base.rb
+- lib/fingerjam/capistrano.rb
+- lib/fingerjam/helpers.rb
+- lib/fingerjam/jammit.rb
+- lib/fingerjam/railtie.rb
+- lib/tasks/fingerjam.rake
+- spec/fingerjam_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/steveh/fingerjam
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3890504782789243124
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely
+test_files: 
+- spec/fingerjam_spec.rb
+- spec/spec_helper.rb