fingerjam 0.3.0 → 0.4.0

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gem "rails", ">= 3.0.0"
 gem "jammit"
 gem "capistrano"
+gem "activesupport"
 
 group :development do
   gem "rspec", "~> 2.1.0"

data/Gemfile.lock

@@ -102,6 +102,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bundler (~> 1.0.0)
   capistrano
   jammit

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/fingerjam.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fingerjam}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Hoeksema"]
-  s.date = %q{2010-12-09}
+  s.date = %q{2011-01-27}
   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 = [
@@ -30,11 +30,12 @@ Gem::Specification.new do |s|
     "lib/fingerjam.rb",
     "lib/fingerjam/base.rb",
     "lib/fingerjam/capistrano.rb",
+    "lib/fingerjam/capistrano/configuration.rb",
+    "lib/fingerjam/capistrano/strategy.rb",
     "lib/fingerjam/fix_jammit_encoding.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"
   ]
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
       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_runtime_dependency(%q<activesupport>, [">= 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"])
@@ -64,6 +66,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rails>, [">= 3.0.0"])
       s.add_dependency(%q<jammit>, [">= 0"])
       s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 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"])
@@ -73,6 +76,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rails>, [">= 3.0.0"])
     s.add_dependency(%q<jammit>, [">= 0"])
     s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 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"])

data/lib/fingerjam/base.rb

@@ -1,49 +1,154 @@
-require "digest/md5"
-require "yaml"
-
 module Fingerjam
   class Base
 
+    cattr_accessor :protocol
     cattr_accessor :host
-    cattr_accessor :lockfile
+    cattr_accessor :cache_prefix
+
+    cattr_accessor :root_path
+    cattr_accessor :assets_yml_path
+    cattr_accessor :lock_yml_path
+    cattr_accessor :public_path
+    cattr_accessor :packages_path
+    cattr_accessor :cache_path
+
+    cattr_accessor :cached_paths
+    cattr_accessor :cached_urls
+
     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
+      def configure(options = {})
+        self.protocol        = options.delete(:protocol)     || "https"
+        self.host            = options.delete(:host)         || "www.example.com"
+        self.cache_prefix    = options.delete(:cache_prefix) || "/cache/"
+
+        self.root_path       = options.delete(:root_path)
+        self.assets_yml_path = options.delete(:assets_yml_path) || File.join(root_path, "config", "assets.yml")
+        self.lock_yml_path   = options.delete(:lock_yml_path)   || File.join(root_path, "config", "assets.lock.yml")
+        self.public_path     = options.delete(:public_path)     || File.join(root_path, "public")
+        self.packages_path   = options.delete(:packages_path)   || File.join(public_path, "packages")
+        self.cache_path      = options.delete(:cache_path)      || File.join(public_path, cache_prefix)
+
+        self.cached_paths    = {}
+
+        begin
+          self.cached_urls   = YAML.load_file(lock_yml_path)
+        rescue
+          self.cached_urls   = {}
+        end
+
+        self.enabled         = !cached_urls.empty? && Rails.env.production?
+
+        Jammit.const_set("ASSET_ROOT", root_path)
       end
 
       def enabled?
         enabled
       end
 
-      def hashed?(relative_path)
-        hashes.has_key?(relative_path)
+      def cached?(relative_path)
+        self.cached_urls.include?(relative_path)
       end
 
-      def hashed_path(relative_path)
-        generate_path(relative_path, hashes[relative_path])
+      def cached_url(relative_path)
+        self.cached_urls[relative_path]
       end
 
-      def generate_path(relative_path, hash)
-        "http://%s/%s%s" % [host, hashes[relative_path], relative_path]
+      def save_cached_url_from_path(relative_path, absolute_path)
+        save_cached_path_from_path(relative_path, absolute_path)
+        generate_cached_url(relative_path)
       end
 
-      def extensions
-        %w{js css png jpg gif}
+      def package_and_lock!
+        package
+        scan_public
+        symlink
+        write_lockfile
       end
 
-      def generate_hash(absolute_path)
-        Digest::MD5.hexdigest(absolute_path.to_s)
-      end
+      private
+
+        def extensions
+          %w{js css png jpg gif}
+        end
+
+        def save_cached_path_from_path(relative_path, absolute_path)
+          self.cached_paths[relative_path] = generate_cached_path_from_absolute(relative_path, absolute_path)
+          self.cached_paths[relative_path]
+        end
+
+        def calculate_hash(absolute_path)
+          Digest::MD5.file(absolute_path.to_s).hexdigest
+        end
+
+        def generate_cached_path_from_absolute(relative_path, absolute_path)
+          hash = calculate_hash(absolute_path)
+          generate_cached_path_from_hash(relative_path, hash)
+        end
+
+        def generate_cached_path_from_hash(relative_path, hash)
+          extname = File.extname(relative_path)
+          "%s%s%s" % [cache_prefix, hash, extname]
+        end
+
+        def generate_cached_url(relative_path)
+          cached_path = self.cached_paths[relative_path]
+          "%s://%s%s" % [protocol, host, cached_path]
+        end
+
+        def package
+          Jammit.package!({
+            :config_path   => assets_yml_path,
+            :output_folder => packages_path,
+            :force         => true
+          })
+        end
+
+        def public_pathname
+          Pathname.new(public_path)
+        end
+
+        def cacheable_public_files
+          Pathname.glob(public_pathname + "**" + "*.{#{extensions.join(",")}}")
+        end
+
+        def scan_public
+          cacheable_public_files.each do |absolute_pathname|
+            relative_path = "/" + absolute_pathname.relative_path_from(public_pathname).to_s
+            save_cached_path_from_path(relative_path, absolute_pathname.to_s)
+          end
+        end
+
+        def symlink
+          cached_paths.each_pair do |relative_path, cached_path|
+            # Strip leading / from relative path to determine absolute path
+            src_u_path = File.join(public_path, relative_path[1..relative_path.length])
+            dst_u_path = File.join(public_path, cached_path[1..cached_path.length])
+
+            # Gzip version of asset
+            src_c_path = File.join(public_path, (relative_path[1..relative_path.length] + ".gz"))
+            dst_c_path = File.join(public_path, (cached_path[1..cached_path.length] + ".gz"))
+
+            # Create root directory
+            FileUtils.mkdir_p(File.dirname(dst_u_path))
+
+            # Create relative symlink from RAILS_ROOT/public/cache/$MD5SUM.$EXT to original file
+            File.symlink(".." + relative_path, dst_u_path.to_s) if !File.exists?(dst_u_path)
+            File.symlink(".." + relative_path, dst_c_path.to_s) if !File.exists?(dst_c_path) && File.exists?(src_c_path)
+
+            cached_urls[relative_path] = generate_cached_url(relative_path)
+          end
+        end
+
+        def write_lockfile
+          puts "writing lockfile #{lock_yml_path}"
+
+          File.open(lock_yml_path, "w") do |lockfile|
+            lockfile.puts cached_urls.to_yaml
+          end
+        end
 
     end
 

data/lib/fingerjam/capistrano/configuration.rb

@@ -0,0 +1,9 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  set :strategy, Capistrano::Deploy::Strategy::Fingerjam.new(self)
+  set :copy_cache, true
+
+  _cset(:cache_host) { "www.example.com" }
+
+end
+

data/lib/fingerjam/capistrano/strategy.rb

@@ -0,0 +1,75 @@
+require "pathname"
+require "jammit"
+require "fingerjam"
+require "capistrano/recipes/deploy/strategy/copy"
+
+module Capistrano
+  module Deploy
+    module Strategy
+      class Fingerjam < Copy
+
+        def deploy!
+          if File.exists?(copy_cache)
+            logger.debug "refreshing local cache to revision #{revision} at #{copy_cache}"
+            system(source.sync(revision, copy_cache))
+          else
+            logger.debug "preparing local cache at #{copy_cache}"
+            system(source.checkout(revision, copy_cache))
+          end
+
+          # Check the return code of last system command and rollback if not 0
+          unless $? == 0
+            raise Capistrano::Error, "shell command failed with return code #{$?}"
+          end
+
+          logger.debug "copying cache to deployment staging area #{destination}"
+          Dir.chdir(copy_cache) do
+            FileUtils.mkdir_p(destination)
+            queue = Dir.glob("*", File::FNM_DOTMATCH)
+            while queue.any?
+              item = queue.shift
+              name = File.basename(item)
+
+              next if name == "." || name == ".."
+              next if copy_exclude.any? { |pattern| File.fnmatch(pattern, item) }
+
+              if File.symlink?(item)
+                FileUtils.ln_s(File.readlink(File.join(copy_cache, item)), File.join(destination, item))
+              elsif File.directory?(item)
+                queue += Dir.glob("#{item}/*", File::FNM_DOTMATCH)
+                FileUtils.mkdir(File.join(destination, item))
+              else
+                FileUtils.ln(File.join(copy_cache, item), File.join(destination, item))
+              end
+            end
+          end
+
+          File.open(File.join(destination, "REVISION"), "w") { |f| f.puts(revision) }
+
+          fingerjam
+
+          logger.trace "compressing #{destination} to #{filename}"
+          Dir.chdir(tmpdir) { system(compress(File.basename(destination), File.basename(filename)).join(" ")) }
+
+          upload(filename, remote_filename)
+          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+        ensure
+          FileUtils.rm filename rescue nil
+          FileUtils.rm_rf destination rescue nil
+        end
+
+        def fingerjam
+          logger.trace "packaging assets with fingerjam for #{cache_host} to #{destination}"
+
+          ::Fingerjam::Base.configure(
+            :host      => cache_host,
+            :root_path => destination
+          )
+
+          ::Fingerjam::Base.package_and_lock!
+         end
+
+      end
+    end
+  end
+end

data/lib/fingerjam/capistrano.rb

@@ -1,34 +1,3 @@
-Capistrano::Configuration.instance(:must_exist).load do
+require "fingerjam/capistrano/strategy"
+require "fingerjam/capistrano/configuration"
 
-  namespace :fingerjam do
-
-    desc "Package, lock and upload assets"
-    task :upload_public, { :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
-
-    desc "Upload lockfile"
-    task :upload_lockfile, { :roles => :app } do
-      lockfile = File.realpath(File.join("config", "assets.lock.yml"))
-      top.upload(lockfile, File.join(release_path, "config", "assets.lock.yml"))
-    end
-
-  end
-
-  after "deploy:finalize_update", "fingerjam:upload_public"
-  after "deploy:finalize_update", "fingerjam:upload_lockfile"
-
-end

data/lib/fingerjam/helpers.rb

@@ -3,19 +3,21 @@ module Fingerjam
 
     # 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
+      if Fingerjam::Base.enabled? && Fingerjam::Base.cached?(source)
+        Fingerjam::Base.cached_url(source)
       else
-        source + "?#{asset_id}"
+        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
 

data/lib/fingerjam/jammit.rb

@@ -2,11 +2,8 @@ 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}"
+    def rewrite_asset_path(relative_path, absolute_path)
+      Fingerjam::Base.save_cached_url_from_path(relative_path, absolute_path)
     end
 
   end

data/lib/fingerjam/railtie.rb

@@ -6,9 +6,5 @@ module Fingerjam
     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

@@ -1,3 +1,7 @@
+require "active_support/core_ext/class/attribute_accessors"
+require "digest/md5"
+require "yaml"
+
 require "fingerjam/base"
 require "fingerjam/helpers"
 require "fingerjam/jammit"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Steve Hoeksema
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-09 00:00:00 +13:00
+date: 2011-01-27 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,8 +59,21 @@ dependencies:
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activesupport
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -72,10 +85,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -87,10 +100,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -102,10 +115,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -115,7 +128,7 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 description: Fingerjam uploads your Jammit-compressed assets with fingerprinted filenames so they can be cached indefinitely
 email: steve@seven.net.nz
 executables: []
@@ -139,11 +152,12 @@ files:
 - lib/fingerjam.rb
 - lib/fingerjam/base.rb
 - lib/fingerjam/capistrano.rb
+- lib/fingerjam/capistrano/configuration.rb
+- lib/fingerjam/capistrano/strategy.rb
 - lib/fingerjam/fix_jammit_encoding.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
@@ -160,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2735618090215588831
+      hash: -4335170652372307643
       segments: 
       - 0
       version: "0"

data/lib/tasks/fingerjam.rake

@@ -1,28 +0,0 @@
-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