engine-assets 0.4.2 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/app/controllers/engine_assets/assets_controller.rb

@@ -1,4 +1,4 @@
-class EngineAssets::AssetsController < ActionController::Base
+class EngineAssets::AssetsController < ApplicationController
   layout        nil
   before_filter :expire, :set_headers
   after_filter  :cache
@@ -6,9 +6,15 @@ class EngineAssets::AssetsController < ActionController::Base
   def show
     flat_file = EngineAssets::PublicLocator.locate(File.join(controller_name, [params[:path], params[:format]].join('.')))
     if(flat_file)
+      # TODO: consider sending IO, rather than rendering
       render(:file => flat_file)
     else
       begin
+        # TODO:
+        #   * consider removing the engine_assets dir to get:
+        #     /javascripts/path/file.js.erb
+        #   * consider (resourceful):
+        #     /path/file.js.erb
         render(:template => File.join('engine_assets', controller_name, params[:path]), :layout => false)
       rescue ActionView::MissingTemplate
         head :not_found

data/config/routes.rb

@@ -3,7 +3,18 @@ ActionController::Routing::Routes.draw do |map|
     map.send(type, "#{type}/:path.:format", {
       :controller => "engine_assets/#{type}",
       :action     => :show,
-      :path       => /[A-Za-z0-9\/._-]+?/   # e.g., path/to/file.ext
+      :path       => /[A-Za-z0-9\/._-]+?/ # e.g., javascripts/path/file.js
     })
   end
 end
+
+# TODO: consider the following for Rails 3 (the abover works for now):
+# Rails.application.routes.draw do |map|
+#   [:javascripts, :stylesheets].each do |type|
+#     match "#{type}/:path" => "engine_assets/#{type}#show",
+#       :as          => type,
+#       :constraints => {
+#         :path   => /[A-Za-z0-9\/._-]+\.(css|js)$/
+#       }
+#   end
+# end

data/engine-assets.gemspec

@@ -1,46 +1,62 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{engine-assets}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Innis"]
-  s.date = %q{2010-08-11}
+  s.date = %q{2010-09-17}
   s.description = %q{A Rails Engine, which enables Rails Engines to provide assets (javascript, css and images)}
   s.email = %q{support@coolerator.net}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
-     "README.rdoc",
+     "RAILS_VERSIONS",
+     "README.md",
      "Rakefile",
-     "TODO.md",
      "VERSION",
      "app/controllers/engine_assets/assets_controller.rb",
      "app/controllers/engine_assets/javascripts_controller.rb",
      "app/controllers/engine_assets/stylesheets_controller.rb",
      "config/routes.rb",
      "engine-assets.gemspec",
+     "features/rails.feature",
+     "features/step_definitions/rails_steps.rb",
+     "features/support/env.rb",
+     "features/support/rails.rb",
+     "features/support/terminal.rb",
+     "init.rb",
      "lib/engine-assets.rb",
+     "lib/engine_assets/engine.rb",
      "lib/engine_assets/extensions/rails/assets.rb",
      "lib/engine_assets/public_locator.rb",
-     "rails/init.rb",
-     "spec/controllers/javascripts_controller_spec.rb",
-     "spec/controllers/stylesheets_controller_spec.rb",
+     "spec/app/controllers/engine_assets/javascripts_controller_spec.rb",
+     "spec/app/controllers/engine_assets/stylesheets_controller_spec.rb",
+     "spec/lib/engine-assets_spec.rb",
      "spec/lib/engine_assets/public_locator_spec.rb",
      "spec/routing/javascripts_routing_spec.rb",
      "spec/routing/stylesheets_routing_spec.rb",
+     "spec/shared/assets_controller_spec.rb",
+     "spec/shared/assets_routing_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "spec/spec_suite.rb",
+     "spec/support/Gemfile-2.3.5",
+     "spec/support/Gemfile-2.3.5.lock",
+     "spec/support/Gemfile-2.3.9",
+     "spec/support/Gemfile-2.3.9.lock",
+     "spec/support/Gemfile-3.0.0",
+     "spec/support/Gemfile-3.0.0.lock",
      "spec/support/fixtures/app/views/engine_assets/javascripts/dual.js.erb",
      "spec/support/fixtures/app/views/engine_assets/javascripts/solo.js.erb",
      "spec/support/fixtures/app/views/engine_assets/stylesheets/dual.css.erb",
@@ -49,8 +65,8 @@ Gem::Specification.new do |s|
      "spec/support/fixtures/public/stylesheets/dual.css",
      "spec/support/helpers/fixture_helper.rb",
      "spec/support/helpers/textmate_helper.rb",
-     "spec/support/shared/assets_controller_spec.rb",
-     "spec/support/shared/assets_routing_spec.rb"
+     "spec/support/rails.rb",
+     "spec/support/terminal.rb"
   ]
   s.homepage = %q{http://github.com/coreyti/engine-assets}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -58,17 +74,19 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rails Engines with assets.}
   s.test_files = [
-    "spec/controllers/javascripts_controller_spec.rb",
-     "spec/controllers/stylesheets_controller_spec.rb",
+    "spec/app/controllers/engine_assets/javascripts_controller_spec.rb",
+     "spec/app/controllers/engine_assets/stylesheets_controller_spec.rb",
+     "spec/lib/engine-assets_spec.rb",
      "spec/lib/engine_assets/public_locator_spec.rb",
      "spec/routing/javascripts_routing_spec.rb",
      "spec/routing/stylesheets_routing_spec.rb",
+     "spec/shared/assets_controller_spec.rb",
+     "spec/shared/assets_routing_spec.rb",
      "spec/spec_helper.rb",
-     "spec/spec_suite.rb",
      "spec/support/helpers/fixture_helper.rb",
      "spec/support/helpers/textmate_helper.rb",
-     "spec/support/shared/assets_controller_spec.rb",
-     "spec/support/shared/assets_routing_spec.rb"
+     "spec/support/rails.rb",
+     "spec/support/terminal.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -76,12 +94,27 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_development_dependency(%q<cucumber>, ["~> 0.8.5"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_development_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_dependency(%q<cucumber>, ["~> 0.8.5"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<rr>, ["~> 1.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.8"])
+    s.add_dependency(%q<cucumber>, ["~> 0.8.5"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<rr>, ["~> 1.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+    s.add_dependency(%q<term-ansicolor>, ["~> 1.0.5"])
   end
 end
 

data/features/rails.feature

@@ -0,0 +1,127 @@
+Feature: Install this Gem in a Rails application
+
+  Background:
+    Given I have built and installed the "engine-assets" gem
+
+  Scenario: Use the gem un-vendored in a Rails application
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I check the configured gem version
+    Then I should see "Current version: 0.5.0"
+
+  Scenario: Send a request for an application-host dynamic asset
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I save the following as "app/views/engine_assets/javascripts/example.js.erb"
+      """
+      // example.js (application - <%= "dynamic" -%>)
+      """
+    And  I perform a request to "http://example.com:1234/javascripts/example.js"
+    Then I should receive a response matching the following:
+      | 200 | // example.js (application - dynamic) |
+
+  Scenario: Send a request for an engine-hosted static asset
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I generate a new "example_plugin" plugin
+    And  I save the following as "vendor/plugins/example_plugin/init.rb"
+      """
+      require 'engine-assets'
+      EngineAssets::PublicLocator.register(File.join(File.dirname(__FILE__)))
+      """
+    And  I save the following as "vendor/plugins/example_plugin/public/javascripts/example.js"
+      """
+      // example.js (plugin - static)
+      """
+    And  I perform a request to "http://example.com:1234/javascripts/example.js"
+    Then I should receive a response matching the following:
+      | 200 | // example.js (plugin - static) |
+
+  Scenario: Send a request for an engine-hosted dynamic asset
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I generate a new "example_plugin" plugin
+    And  I save the following as "vendor/plugins/example_plugin/init.rb"
+      """
+      require 'engine-assets'
+      EngineAssets::PublicLocator.register(File.join(File.dirname(__FILE__)))
+      """
+    And  I save the following as "vendor/plugins/example_plugin/app/views/engine_assets/javascripts/example.js.erb"
+      """
+      // example.js (plugin - dynamic)
+      """
+    And  I perform a request to "http://example.com:1234/javascripts/example.js"
+    Then I should receive a response matching the following:
+      | 200 | // example.js (plugin - dynamic) |
+
+  Scenario: Send a development request for an application webpage which references an engine-hosted asset
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I configure my application to run in the "development" environment
+    And  I save the following as "config/initializers/assets.rb"
+      """
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion :defaults => [
+        'example.js'
+      ]
+      """
+    And  I generate a new "example" scaffold
+    And  I save the following as "app/views/layouts/examples.html.erb"
+      """
+      <html>
+      <head>
+        <%= javascript_include_tag :all, :cache => true, :recursive => true -%>
+      </head>
+      <body></body>
+      </html>
+      """
+    And  I generate a new "example_plugin" plugin
+    And  I save the following as "vendor/plugins/example_plugin/init.rb"
+      """
+      require 'engine-assets'
+      EngineAssets::PublicLocator.register(File.join(File.dirname(__FILE__)))
+      """
+    And  I save the following as "vendor/plugins/example_plugin/public/javascripts/example.js"
+      """
+      // example.js content
+      """
+    And  I perform a request to "http://example.com:1234/examples"
+    Then I should receive a response matching the following:
+      | 200 | /javascripts/example.js |
+
+  Scenario: Send a production request for an application webpage which references an engine-hosted asset
+    When I generate a new Rails application
+    And  I configure my application to require the "engine-assets" gem
+    And  I configure my application to run in the "production" environment
+    And  I save the following as "config/initializers/assets.rb"
+      """
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion :defaults => [
+        'example.js'
+      ]
+      """
+    And  I generate a new "example" scaffold
+    And  I save the following as "app/views/layouts/examples.html.erb"
+      """
+      <html>
+      <head>
+        <%= javascript_include_tag :all, :cache => true, :recursive => true -%>
+      </head>
+      <body></body>
+      </html>
+      """
+    And  I generate a new "example_plugin" plugin
+    And  I save the following as "vendor/plugins/example_plugin/init.rb"
+      """
+      require 'engine-assets'
+      EngineAssets::PublicLocator.register(File.join(File.dirname(__FILE__)))
+      """
+    And  I save the following as "vendor/plugins/example_plugin/public/javascripts/example.js"
+      """
+      // example.js content
+      """
+    And  I perform a request to "http://example.com:1234/examples"
+    Then I should receive a response matching the following:
+      | 200 | /javascripts/all.js |
+    And  The first line of the "public/javascripts/all.js" file should be
+      """
+      // example.js content
+      """

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,112 @@
+Given /^I have built and installed the "([^"]*)" gem$/ do |gem_name|
+  @terminal.build_and_install(File.join(PROJECT_ROOT, "#{gem_name}.gemspec"))
+end
+
+When /^I generate a new Rails application$/ do
+  @terminal.cd(TEMP_DIR)
+
+  version = ENV['RAILS_VERSION']
+  rails3  = version =~ /^3/
+
+  if rails3
+    rails_create_command = 'new'
+  else
+    rails_create_command = ''
+  end
+
+  load_rails = <<-RUBY
+    gem 'rails', '#{version}'; \
+    load Gem.bin_path('rails', 'rails', '#{version}')
+  RUBY
+
+  @terminal.run(%{ruby -rubygems -e "#{load_rails.strip!}" #{rails_create_command} rails_root})
+
+  if rails_root_exists?
+    @terminal.echo("Generated a Rails #{version} application")
+  else
+    raise "Unable to generate a Rails application:\n#{@terminal.output}"
+  end
+end
+
+When /^I configure my application to require the "([^"]*)" gem$/ do |gem_name|
+  if rails_manages_gems?
+    config_gem(gem_name)
+  elsif bundler_manages_gems?
+    bundle_gem(gem_name)
+  else
+    File.open(environment_path, 'a') do |file|
+      file.puts
+      file.puts("require 'example-engine'")
+      file.puts("require 'example-engine/rails'") # ???
+    end
+
+    # unless rails_finds_generators_in_gems?
+    #   FileUtils.cp_r(File.join(PROJECT_ROOT, 'generators'), File.join(RAILS_ROOT, 'lib'))
+    # end
+  end
+end
+
+When /^I configure my application to run in the "([^"]*)" environment$/ do |environment|
+  @rails_environment = environment
+end
+
+When /^I check the configured gem version$/ do
+  version = ENV['RAILS_VERSION']
+  rails3  = version =~ /^3/
+
+  if rails3
+    command = 'rails runner'
+  else
+    command = 'script/runner'
+  end
+
+  @terminal.cd(RAILS_ROOT)
+  @terminal.run(%Q{#{command} 'puts "Current version: #\{EngineAssets.version\}"'})
+end
+
+When /^I generate a new "([^"]*)" ([^\s]*)$/ do |name, generator|
+  rails_generate("#{generator} #{name}")
+end
+
+When /^I save the following as "([^\"]*)"$/ do |path, string|
+  FileUtils.mkdir_p(File.join(RAILS_ROOT, File.dirname(path)))
+  File.open(File.join(RAILS_ROOT, path), 'w') { |file| file.write(string) }
+end
+
+When /^I perform a request to "([^\"]*)"$/ do |uri|
+  perform_request(uri)
+end
+
+Then /^I should receive a response matching the following:$/ do |table|
+  hash   = table.transpose.hashes.first
+  result = JSON.parse(@terminal.result)
+
+  if hash['200']
+    result['status'].should == 200
+
+    if (header = result['headers']['X-Sendfile'])
+      # Rack middleware (likely Rails 3)
+      content = File.readlines(header).join
+      content.should include(hash['200'])
+    else
+      result['body'].should include(hash['200'])
+    end
+  else
+    raise "Don't know how to handle #{hash.inspect}"
+  end
+end
+
+Then /^The first line of the "([^"]*)" file should be$/ do |path, string|
+  lines = File.readlines(File.join(RAILS_ROOT, path))
+  lines[0].strip.should == string
+end
+
+Then /^I should see "([^\"]*)"$/ do |expected_text|
+  unless @terminal.output.include?(expected_text)
+    raise("Got terminal output:\n#{@terminal.output}\n\nExpected output:\n#{expected_text}")
+  end
+end
+
+Then /^the command should have run successfully$/ do
+  @terminal.status.exitstatus.should == 0
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'spec'
+
+PROJECT_ROOT   = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+TEMP_DIR       = File.join(PROJECT_ROOT, 'tmp').freeze
+RAILS_ROOT     = File.join(TEMP_DIR, 'rails_root').freeze
+BUILT_GEM_ROOT = File.join(TEMP_DIR, 'built_gems').freeze
+LOCAL_GEM_ROOT = File.join(TEMP_DIR, 'local_gems').freeze
+
+Before do
+  FileUtils.mkdir_p TEMP_DIR
+  FileUtils.rm_rf   BUILT_GEM_ROOT
+  FileUtils.rm_rf   RAILS_ROOT
+  FileUtils.mkdir_p BUILT_GEM_ROOT
+end

data/features/support/rails.rb

@@ -0,0 +1,125 @@
+require 'uri'
+
+module RailsHelpers
+  def rails_root_exists?
+    File.exists?(environment_path)
+  end
+
+  def rails3?
+    rails_version =~ /^3/
+  end
+
+  def rails_uses_rack?
+    rails3? || rails_version =~ /^2\.3/
+  end
+
+  def rails_version
+    @rails_version ||= begin
+      if bundler_manages_gems?
+        rails_version = open(gemfile_path).read.match(/gem.*rails["'].*["'](.+)["']/)[1]
+      else
+        environment_file = File.join(RAILS_ROOT, 'config', 'environment.rb')
+        rails_version = `grep RAILS_GEM_VERSION #{environment_file}`.match(/[\d.]+/)[0]
+      end
+    end
+  end
+
+  def rails_environment
+    @rails_environment ||= 'production'
+  end
+
+  def bundler_manages_gems?
+    File.exists?(gemfile_path)
+  end
+
+  def gemfile_path
+    gemfile = File.join(RAILS_ROOT, 'Gemfile')
+  end
+
+  def rails_manages_gems?
+    rails_version =~ /^2\.[123]/
+  end
+
+  def environment_path
+    File.join(RAILS_ROOT, 'config', 'environment.rb')
+  end
+
+  def rails_generate(arguments)
+    command = rails3? ? 'rails generate' : 'script/generate'
+
+    @terminal.cd(RAILS_ROOT)
+    @terminal.run("#{command} #{arguments}")
+    @terminal.run("RAILS_ENV=#{rails_environment} rake db:migrate")
+  end
+
+  def bundle_gem(gem_name)
+    File.open(gemfile_path, 'a') do |file|
+      file.puts("gem '#{gem_name}'")
+    end
+  end
+
+  def config_gem(gem_name)
+    run = "Rails::Initializer.run do |config|"
+    insert = "  config.gem '#{gem_name}'"
+    content = File.read(environment_path)
+    if content.sub!(run, "#{run}\n#{insert}")
+      File.open(environment_path, 'wb') { |file| file.write(content) }
+    else
+      raise "Couldn't find #{run.inspect} in #{environment_path}"
+    end
+  end
+
+  def perform_request(uri)
+    # NOTE (CTI):
+    # modified from thoughtbot's original to return headers and status.
+    if rails3?
+      request_script = <<-SCRIPT
+        require 'config/environment'
+
+        env = Rack::MockRequest.env_for(#{uri.inspect})
+        status, headers, body = RailsRoot::Application.call(env)
+
+        response = {
+          :body    => body.is_a?(Array) ? body.join : body.body,
+          :headers => headers,
+          :status  => status
+        }
+
+        puts response.to_json
+      SCRIPT
+      File.open(File.join(RAILS_ROOT, 'request.rb'), 'w') { |file| file.write(request_script) }
+      @terminal.cd(RAILS_ROOT)
+      @terminal.run("./script/rails runner -e #{rails_environment} request.rb")
+    elsif rails_uses_rack?
+      request_script = <<-SCRIPT
+        require 'config/environment'
+
+        env = Rack::MockRequest.env_for(#{uri.inspect})
+        app = Rack::Lint.new(ActionController::Dispatcher.new)
+
+        status, headers, body = app.call(env)
+
+        response = {
+          :body    => "",
+          :headers => headers,
+          :status  => status
+        }
+
+        if body.respond_to?(:to_str)
+          response[:body] << body
+        else
+          body.each { |part| response[:body] << part }
+        end
+
+        puts response.to_json
+      SCRIPT
+      File.open(File.join(RAILS_ROOT, 'request.rb'), 'w') { |file| file.write(request_script) }
+      @terminal.cd(RAILS_ROOT)
+      @terminal.run("./script/runner -e #{rails_environment} request.rb")
+    else
+      raise "Rails versions earlier than 2.3 are not supported"
+    end
+  end
+end
+
+World(RailsHelpers)