statica 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+
+*.swp
+
+pkg
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# statica
+
+Statica is a static asset caching solution.
+
+# Note
+
+Not quite ready for production use, but not far off either. I will remove this notice when I feel it's production ready.
+
+TODO:
+
+* Keep track of assets Statica already has the digest for [production setting]
+* Finish the README
+* More tests
+
+# Synopsis
+
+The goal is to achieve the simplicity of appending a query parameter and the precision offered by implementing a per file digest system.
+
+In order to achieve this, Statica takes the simple approach of appendin the hex digest to the end of the static asset path like so:
+
+    > Statica.digest_url("/javascripts/application.js")
+    =>"/javascripts/application.js/d79dbf6e6c051b22f1ab91fec4cf81855883cc7d0a3f3e242b56b97fbcd756cb"
+
+Notice how the file name does not change. We are simply appending a qualifier to the resource for caching. In order to serve the asset, Statica comes with Rack middleware that simply removes the digest portion allowing your application to serve the asset as normal.
+
+    # If Statica path, remove the digest portion, allow app to serve normally
+    use Rack::StaticaServer
+
+If you want an HTTP Server like [Apache](http://httpd.apache.org/) or [Nginx](http://wiki.nginx.org/Main) you can setup rules to ignore the digest and server the asset. I'll sample rules here later.
+
+# About
+
+More to come...
+
+# Acknowledgement
+
+Huge thanks to my company, [Primedia](http://primedia.com) for encouraging open source contributions.
+
+# Contributors
+
+I highly value contributions and will happily list all those who submit accepted pull requests.

data/Rakefile

@@ -0,0 +1,46 @@
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue Exception => e
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = Dir.glob('test/**/test_*.rb')
+  t.verbose = true
+end
+
+task 'test:ci' do |t|
+  Rake::Task[ENV['TASK']].execute
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'lib' << 'test'
+    t.test_files = Dir.glob('test/**/test_*.rb')
+    t.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: gem install rcov"
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w(lib/**/*.rb)
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end
+
+desc "Generate Documentation"
+task :doc => :yard
+
+task :default => 'test'

data/lib/rack/statica_server.rb

@@ -0,0 +1,20 @@
+require 'rack'
+require 'statica'
+
+module Rack
+  class StaticaServer
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      env['PATH_INFO'] = Statica.resolve(env['PATH_INFO'])
+
+      @app.call(env)
+    end
+  end
+end

data/lib/statica.rb

@@ -0,0 +1,49 @@
+require 'digest/sha2'
+
+module Statica
+  class ResourceNotFoundError < StandardError; end
+
+  extend self
+
+  # Fully qualified path to the root directory
+  attr_accessor :root_dir
+
+  def digest_class=(klass)
+    @digest = klass
+  end
+
+  def digest
+    (@digest || ::Digest::SHA256).new
+  end
+
+  def sub_dirs
+    @sub_dirs ||= %w{javascripts stylesheets images}
+  end
+
+  def sub_dirs=(array)
+    @sub_dirs = array
+  end
+
+  def digest_for(path)
+    path.chop! if path.end_with?("/")
+    fname = File.join(root_dir, path)
+
+    raise ResourceNotFoundError, "#{fname} not found!" unless File.exist?(fname)
+
+    digest.file(fname).hexdigest
+  end
+
+  def digest_url(url)
+    "#{url}/#{digest_for(url)}"
+  end
+
+  def resolve(path)
+    (path =~ regex) ? path.sub($2, '') : path
+  end
+
+  def regex
+    leaders = sub_dirs.collect{|t| Regexp.escape(t)}.join("|")
+    @regex ||= /\A\/?(#{leaders})\S*(\/[a-z0-9]+\/?)\Z/
+  end
+
+end

data/lib/statica/version.rb

@@ -0,0 +1,5 @@
+module Statica
+  # Statica version string
+  # @api public
+  VERSION = '0.1.0'
+end

data/statica.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.dirname(__FILE__) + '/lib/statica/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name              = 'statica'
+  s.version           = Statica::VERSION
+  s.date              = Date.today.to_s
+  s.authors           = ['Andrew Stone']
+  s.email             = ['andy@stonean.com']
+  s.summary           = 'Statica is a static asset caching solution.'
+  s.homepage          = 'http://github.com/stonean/statica'
+  s.extra_rdoc_files  = %w(README.md)
+  s.rdoc_options      = %w(--charset=UTF-8)
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w(lib)
+end

data/test/helper.rb

@@ -0,0 +1,52 @@
+require 'minitest/unit'
+require 'statica'
+
+MiniTest::Unit.autorun
+
+module R
+  extend self
+
+  def tmp_dir
+    File.join(File.dirname(__FILE__), '..', 'tmp')
+  end
+
+  def maybe_mkdir(dir)
+    Dir.mkdir(dir) unless Dir.exist?(dir)
+  end
+
+  def test_file(name = 'test.txt')
+    out_dir = tmp_dir
+
+    maybe_mkdir(out_dir)
+
+    parts = name.split('/').delete_if{ |a| a.empty? }
+    name  = parts.pop
+
+    parts.each do |subdir|
+      out_dir = File.join(out_dir, subdir)
+      maybe_mkdir(out_dir)
+    end
+
+    fname = File.join(out_dir, name)
+    f = File.open( fname, 'w')
+
+    letters  =  [('a'..'z'),('A'..'Z')].map{|i| i.to_a}.flatten
+    contents = []
+    (0..rand(1000)).each do
+      contents << (0..rand(12)).map{ letters[rand(letters.length)]  }.join
+    end
+
+    f.write contents.join(' ')
+    f.flush
+    f.close
+
+    yield f
+  end
+end
+
+
+class TestBase < MiniTest::Unit::TestCase
+  def setup
+    Statica.root_dir = R.tmp_dir
+  end
+end

data/test/test_statica.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+class TestStatica < TestBase
+
+  def test_digest_for_raises_error_on_resource_not_found
+    assert_raises Statica::ResourceNotFoundError do
+      Statica.digest_for('/javascripts/foo.js')
+    end
+  end
+
+  def test_digests_are_unique
+    digest1 = ''
+    digest2 = ''
+
+    path = "/javascripts/application.js"
+
+    R.test_file(path){ |f| digest1 = Statica.digest_for(path) }
+    R.test_file(path){ |f| digest2 = Statica.digest_for(path) }
+
+    refute_equal digest1, digest2
+  end
+
+  def test_digest_path_format
+    url     = "/javascripts/application.js"
+    digest  = ""
+    buster  = ""
+
+    R.test_file(url) do |f|
+      digest = Statica.digest_for(url)
+      buster = Statica.digest_url(url)
+    end
+
+    assert_equal "#{url}/#{digest}", buster
+  end
+
+  def test_resolve_on_non_match
+    url     = "/js/application.js"
+    assert_equal url, Statica.resolve(url)
+  end
+
+  def test_resolve_match_no_digest
+    url     = "/javascripts/application.js"
+    assert_equal url, Statica.resolve(url)
+  end
+
+  def test_resolve_match_no_digest_no_leading_slash
+    url     = "javascripts/application.js"
+    assert_equal url, Statica.resolve(url)
+  end
+
+  def test_resolve
+    urls =  %w{
+                javascripts/application.js
+                /javascripts/third-party.js/
+                /images/home/logo.png
+                /stylesheets/CrazyStylz.css
+                /stylesheets/CrazyStylz.css
+                /images/my_precious.gif
+              }
+
+    urls.each do |url|
+      R.test_file(url) do |f|
+        assert_equal url, Statica.resolve( Statica.digest_url(url) )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: statica
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Stone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- andy@stonean.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack/statica_server.rb
+- lib/statica.rb
+- lib/statica/version.rb
+- statica.gemspec
+- test/helper.rb
+- test/test_statica.rb
+homepage: http://github.com/stonean/statica
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: statica
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Statica is a static asset caching solution.
+test_files: []