publicious 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin French
+
+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.textile

@@ -0,0 +1,82 @@
+h1. Publicious
+
+It's a plugin for plugins.  It allows plugin engine[http://guides.rubyonrails.org/2_3_release_notes.html] developers to supply image, javascript and stylesheet assets in a public directory inside their plugin that "just work" without having to copy those assets over to the app's main public directory with rake tasks or installation scripts, which is stupid.
+
+In short, it responds to "missing" asset URLs (like /stylesheets/foo.css, /images/foo.png, /javascripts/foo.js) when the web server can't find the file in the public directory, and tries to find a matching file in your plugins and pass that back to the browser through Rails. 
+
+
+h2. Example
+
+Let's assume you have the following plugins installed:
+
+* RAILS_ROOT/vendor/plugins/plugin_123
+* RAILS_ROOT/vendor/gems/plugin_456
+
+Rails would establish the following view paths:
+
+* RAILS_ROOT/app/views
+* RAILS_ROOT/vendor/plugins/plugin_123/app/views
+* RAILS_ROOT/vendor/gems/plugin_456/app/views
+
+PluginAssets takes these "view paths" and builds the same thing for "public paths" (public directories inside plugins), like this:
+
+* RAILS_ROOT/vendor/plugins/plugin_123/public
+* RAILS_ROOT/vendor/gems/plugin_456/public
+
+Given a request for "/stylesheets/foo/bah.css", the web server would first look for "bah.css" in "RAILS_ROOT/public/foo/bah.css".  If that resource doesn't exist, the request would usually be passed through to Rails, which will try to route the request to a controller action and eventually respond with a 404 (file not found).
+
+Instead, this plugin intercepts the requests for these missing assets with a piece of middleware, searching through the installed plugins.  In this case, it would search for "bah.css" in the following locations:
+
+* RAILS_ROOT/vendor/plugins/plugin_123/public/stylesheets/foo/bah.css
+* RAILS_ROOT/vendor/plugins/plugin_456/public/stylesheets/foo/bah.css
+
+As soon as a matching file is found, it's passed back to the browser with the correct mime type.  If none of the plugins have such a file, the request is passed onto Rails, which will handle the 404 like it usually does.
+
+It works for plugins and gem plugins. It works for the following URLs:
+
+* @/images/*@
+* @/stylesheets/*@
+* @/javascripts/*@
+
+One day I'll make it configurable for other assets, but in the meantime it's easy to hack/fork.
+
+
+h2. Installation
+
+The gem is hosted on gemcutter, so *if you haven't already*, add it as a gem source:
+
+<pre>
+  sudo gem sources -a http://gemcutter.org/
+</pre>
+
+Then install the Publicious gem:
+
+<pre>
+  sudo gem install publicious
+</pre>
+
+
+
+h2. Caveats
+
+Publicious leverages the view_paths array used by Rails plugins that supply their own views.  Rails plugins and gems are only added to the view_paths array automatically if there's an app/views directory inside the plugin.  If you're supplying public assets, chances are pretty good you're supplying views too, so that probably isn't a big deal.
+
+
+h2. Isn't it inefficient?
+
+Yes, it's probably inefficient to go looking through the filesystem and pass the asset back through a Rails request over and over, but this problem should be solved with caching and appropriate response headers, not by copying files around through rake tasks and installer scripts.
+
+
+h2. There's Still Plenty To Do!
+
+I wrote this on the train this morning as a proof of concept, so there's a long list:
+
+* It should be a gem plugin, so that other gem plugins can list it as a dependency
+* I haven't tackled caching yet (probably need to do both page caching and header response caching)
+
+I actually want to see this in Rails core, so help me make it awesome!
+
+
+h2. Etc
+
+Publicious is Copyright (c) 2009 Justin French, released under the MIT license.  Your feedback, forkings and contributions are greatly welcomed.  Many thanks to Daniel Neighman (hassox) for his help converting Publicious to Rack middleware rather than a regular Rails routing and controller stack.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the Publicious plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/*_test.rb'
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "publicious"
+  gemspec.summary = "A Rails gem plugin for plugins to serve images, javascripts and stylesheets from thier own public directory"
+  gemspec.description = "A Rails gem plugin for plugins to serve images, javascripts and stylesheets from thier own public directory"
+  gemspec.email = "justin@indent.com.au"
+  gemspec.homepage = "http://github.com/justinfrench/publicious"
+  gemspec.authors = ["Justin French", "Daniel Neighman"]
+end
+
+desc 'Generate documentation for the Publicious plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Publicious'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_files.include('test/*.rb')
+  rdoc.rdoc_files.include('rails/init.rb')
+end

data/VERSION

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

data/app/metal/publicious_metal.rb

@@ -0,0 +1,49 @@
+class PubliciousMetal
+  
+  def self.call(env)
+    request = Rack::Request.new(env)
+    if request.path_info =~  %r{^\/(#{allowed_dirs.join("|")})}
+      file_name = nil
+      path = nil
+
+      public_paths.detect do |pub_path|
+        path = pub_path
+        fp   = File.join(pub_path, request.path_info)
+        file_name = fp if File.file?(fp)
+      end
+      
+      return respond_not_found! unless file_name
+
+      # Make sure pricks aren't ../../config/database.yml ing us
+      respond_not_found! unless file_name.gsub(%r[^#{path}], "") == request.path_info
+
+      Rack::Response.new(
+        File.open(file_name),
+        200,'Content-Type' => content_type_for_file(file_name)
+      ).finish
+    else
+      respond_not_found!
+    end
+  end
+
+  def self.respond_not_found!
+    Rack::Response.new("Not Found", 404).finish
+  end
+
+  def self.allowed_dirs
+    %w(stylesheets javascripts images)
+  end
+
+  def self.content_type_for_file(name)
+    file_name = File.basename(name).split(".").last.to_s
+    Mime::Type.lookup_by_extension(file_name).to_s
+  end
+
+  def self.public_paths
+    ActionController::Base.view_paths.map do |vp|
+      full_path = File.expand_path(vp.to_s, RAILS_ROOT)
+      full_path.sub("app/views", "public") if full_path =~ /vendor/
+    end.compact
+  end
+  
+end

data/lib/publicious.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "../rails/init")

data/rails/init.rb

@@ -0,0 +1,3 @@
+Mime::Type.register "image/jpeg", :jpg
+Mime::Type.register "image/gif", :gif
+Mime::Type.register "image/png", :png

data/test/css_test.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class CssTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    super
+    
+    setup_plugin :my_plugin
+
+    @path           = 'foo/bah.css'
+    @filename       = "/tmp/vendor/my_plugin/public/stylesheets/#{@path}"
+    @filecontents   = "hello from stylesheet"
+    FileUtils.mkdir(File.dirname(@filename))
+    File.open(@filename, 'w') do |file|
+      file << @filecontents
+    end
+    
+    get "/stylesheets/#{@path}"
+  end
+  
+  def test_responds_ok
+    assert last_response.ok?
+  end
+  
+  def test_responds_with_css_content_type
+    assert_equal "text/css", last_response.content_type
+  end
+  
+end

data/test/image_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class ImageTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    super
+    
+    setup_plugin :my_plugin
+
+    @gif_path       = 'foo/bah.gif'
+    @jpg_path       = 'foo/bah.jpg'
+    @png_path       = 'foo/bah.png'
+    
+    @gif_filename   = "/tmp/vendor/my_plugin/public/images/#{@gif_path}"
+    @jpg_filename   = "/tmp/vendor/my_plugin/public/images/#{@jpg_path}"
+    @png_filename   = "/tmp/vendor/my_plugin/public/images/#{@png_path}"
+
+    @gif_filecontents   = "hello from GIF"
+    @jpg_filecontents   = "hello from JPG"
+    @png_filecontents   = "hello from PNG"
+    
+    FileUtils.mkdir(File.dirname(@jpg_filename))
+    
+    File.open(@jpg_filename, 'w') do |file|
+      file << @jpg_filecontents
+    end
+    
+    File.open(@gif_filename, 'w') do |file|
+      file << @gif_filecontents
+    end
+    
+    File.open(@png_filename, 'w') do |file|
+      file << @png_filecontents
+    end
+  end
+  
+  def test_responds_ok
+    get "/images/#{@gif_path}"
+    assert last_response.ok?
+    
+    get "/images/#{@jpg_path}"
+    assert last_response.ok?
+    
+    get "/images/#{@png_path}"
+    assert last_response.ok?
+    
+  end
+  
+  def test_responds_with_css_content_type
+    get "/images/#{@gif_path}"
+    assert_equal "image/gif", last_response.content_type
+    
+    get "/images/#{@png_path}"
+    assert_equal "image/png", last_response.content_type
+    
+    get "/images/#{@jpg_path}"
+    assert_equal "image/jpeg", last_response.content_type
+  end
+  
+end

data/test/javascript_test.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class JavascriptTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    super
+    
+    setup_plugin :my_plugin
+
+    @path           = 'foo/bah.js'
+    @filename       = "/tmp/vendor/my_plugin/public/javascripts/#{@path}"
+    @filecontents   = "hello from javascript"
+    FileUtils.mkdir(File.dirname(@filename))
+    File.open(@filename, 'w') do |file|
+      file << @filecontents
+    end
+    
+    get "/javascripts/#{@path}"
+  end
+  
+  def test_responds_ok
+    assert last_response.ok?
+  end
+  
+  def test_responds_with_css_content_type
+    assert_equal "text/javascript", last_response.content_type
+  end
+  
+end

data/test/multiple_match_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class MultipleMatchesTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    super
+    
+    setup_plugin :no_file_here
+    setup_plugin :my_plugin
+    setup_plugin :your_plugin
+
+    @path           = 'foo/bah.css'
+    
+    @filename_1     = "/tmp/vendor/my_plugin/public/stylesheets/#{@path}"
+    @filecontents_1 = "hello from my stylesheet"
+    FileUtils.mkdir(File.dirname(@filename_1))
+    File.open(@filename_1, 'w') do |file|
+      file << @filecontents_1
+    end
+    
+    @filename_2     = "/tmp/vendor/your_plugin/public/stylesheets/#{@path}"
+    @filecontents_2 = "hello from your stylesheet"
+    FileUtils.mkdir(File.dirname(@filename_2))
+    File.open(@filename_2, 'w') do |file|
+      file << @filecontents_2
+    end
+    
+    get "/stylesheets/#{@path}"
+  end
+  
+  def test_should_respond_with_success
+    assert last_response.ok?
+  end
+  
+  def test_view_paths_should_contain_three_items
+    assert_equal 4, ActionController::Base.view_paths.size
+  end
+  
+  def test_public_paths_should_contain_two_items
+    assert_equal 3, app.public_paths.size # one less that view_paths
+  end
+
+  def test_public_paths_should_contain_the_plugins_public_dir
+    assert_equal "/tmp/vendor/my_plugin/public", app.public_paths.second
+  end
+  
+  def test_should_respond_with_first_file_contents
+    assert_equal File.read(@filename_1), last_response.body
+    assert_equal @filecontents_1, last_response.body
+  end
+  
+end

data/test/no_match_test.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class NoMatchTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def test_responds_with_not_found
+    get "/stylesheets/not_here.css"
+    assert last_response.not_found?
+  end
+
+end

data/test/single_match_test.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class SingleMatchTest < Test::Unit::TestCase
+  
+  include TestHelper
+  
+  def setup
+    super
+
+    setup_plugin :my_plugin
+
+    @path           = 'foo/bah.css'
+    @filename       = "/tmp/vendor/my_plugin/public/stylesheets/#{@path}"
+    @filecontents   = "hello from stylesheet"
+    FileUtils.mkdir(File.dirname(@filename))
+    File.open(@filename, 'w') do |file|
+      file << @filecontents
+    end
+    
+    get "/stylesheets/#{@path}"
+  end
+  
+  def test_should_respond_with_success
+    assert last_response.ok?
+  end
+  
+  def test_view_paths_should_contain_three_items
+    assert_equal 2, ActionController::Base.view_paths.size
+  end
+  
+  def test_public_paths_should_contain_two_items
+    assert_equal 1, app.public_paths.size # one less that view_paths
+  end
+
+  def test_public_paths_should_contain_the_plugins_public_dir
+    assert_equal "/tmp/vendor/my_plugin/public", app.public_paths.first
+  end
+  
+  def test_should_respond_with_first_file_contents
+    assert_equal File.read(@filename), last_response.body
+    assert_equal @filecontents, last_response.body
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'test/unit'
+require "rack/test"
+require "action_controller"
+require File.join(File.dirname(__FILE__), "../app/metal/publicious_metal")
+require File.join(File.dirname(__FILE__), "../rails/init")
+
+RAILS_ROOT = "/tmp"
+
+module TestHelper
+  include Rack::Test::Methods
+  
+  def app
+    PubliciousMetal
+  end
+  
+  def setup_vendor_dir
+    unless @vendor_dir
+      @vendor_dir = "/tmp/vendor"
+      FileUtils.mkdir(@vendor_dir)
+    end
+  end
+  
+  def teardown_vendor_dir
+    if @vendor_dir
+      begin
+        FileUtils.rm_r(@vendor_dir)
+      rescue StandardError => e
+        puts "Error while removing #{@vendor_dir}"
+      end
+    end
+  end
+  
+  def setup_standard_view_paths
+    ActionController::Base.view_paths = ['/tmp/app/views']
+  end
+  
+  def setup
+    setup_vendor_dir
+    setup_standard_view_paths
+  end
+  
+  def teardown
+    teardown_vendor_dir
+    setup_standard_view_paths
+  end
+  
+  def setup_plugin(*plugin_names)
+    plugin_names.each do |plugin_name|
+      plugin_name = plugin_name.to_s
+      
+      ActionController::Base.view_paths << File.join(@vendor_dir, plugin_name, 'app', 'views')
+  
+      FileUtils.mkdir(File.join(@vendor_dir, plugin_name))
+      FileUtils.mkdir(File.join(@vendor_dir, plugin_name, 'public'))
+      FileUtils.mkdir(File.join(@vendor_dir, plugin_name, 'public', 'stylesheets'))
+      FileUtils.mkdir(File.join(@vendor_dir, plugin_name, 'public', 'images'))
+      FileUtils.mkdir(File.join(@vendor_dir, plugin_name, 'public', 'javascripts'))
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: publicious
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin French
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-23 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: A Rails gem plugin for plugins to serve images, javascripts and stylesheets from thier own public directory
+email: justin@indent.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- app/metal/publicious_metal.rb
+- lib/publicious.rb
+- rails/init.rb
+- test/css_test.rb
+- test/image_test.rb
+- test/javascript_test.rb
+- test/multiple_match_test.rb
+- test/no_match_test.rb
+- test/single_match_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/justinfrench/publicious
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails gem plugin for plugins to serve images, javascripts and stylesheets from thier own public directory
+test_files: 
+- test/css_test.rb
+- test/image_test.rb
+- test/javascript_test.rb
+- test/multiple_match_test.rb
+- test/no_match_test.rb
+- test/single_match_test.rb
+- test/test_helper.rb