engine_cart 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c695e53c52d0eb9f6425fa2fcd099c1a6167aa
-  data.tar.gz: f9959acabcbd5ca9c548cf4b59cb420339953952
+  metadata.gz: cfba3a7001960007e707eeb273a884ea0660d53e
+  data.tar.gz: 85c1f0df4dd3264fd0aecf3927b5c61cace587f5
 SHA512:
-  metadata.gz: d960a6dc51b4bc4fb8a8b488b5d73f53c852cab6aa0c9b7341570739ebb5cc21626463e38401d18f26ff84d55d16c8db795ea3e58f83ddf7d2812f4a361b6ca0
-  data.tar.gz: d62b6950005fe35a516a987547e2e6dbca1d571c1867bf1d12aa83584ed4b4f2261dfe18bf50b55ce0ead81464c001fbdcf585cfbc4d68c502abb82cad604a6d
+  metadata.gz: b245365eed9f9bb511641d9f543e48281e6e406b3a6394be326892294933fe7515b699d83fefaead2c8e9dd57d8073bf1205ef4319e8840dca0bc2eff6f8fef4
+  data.tar.gz: e28e5f5c22d33c4805fb01b0d9ef378d8c9255da47f25f4b772de4786937268df63ba426924ef58a3e16dea76fad26d897499602001d9f5558e33a6978d7e08b

data/README.md

@@ -1,6 +1,17 @@
 # EngineCart
 
-TODO: Write a gem description
+Rake tasks to generate a test application for a Rails Engine gem.
+
+If you have a Rails Engine and want to test it, the suggested approach is a small dummy application that loads up a Rails application with your engine loaded. This dummy application is usually checked into source control and maintained with the application. This works great, until you want to test:
+
+ - different versions of Ruby (e.g. MRI and JRuby)
+ - different versions of Rails (Rails 3.x, 4.0 and 4.1)
+ - different deployment environments (with and without devise, etc)
+
+where each scenario may involve different configurations, Gemfiles, etc. 
+
+EngineCart helps by adding Rake tasks to your Engine that builds a test application for you using Rails generators (and/or application templates). 
+
 
 ## Installation
 
@@ -16,17 +27,22 @@ Or install it yourself as:
 
     $ gem install engine_cart
 
-
 ## Usage
 
+Engine Cart comes with a generator to set up your engine to use Engine Cart. It is also packaged as a rake task:
+
+```
+$ rake engine_cart:prepare
+```
+
 In your Rakefile you can generate the Rails application using, e.g.:
 
 ```ruby
-    require 'engine_cart/rake_task'
+require 'engine_cart/rake_task'
 
-    task :ci => ['engine_cart:generate'] do
-      # run the tests
-    end
+task :ci => ['engine_cart:generate'] do
+  # run the tests
+end
 ```
 
 And in your e.g. spec_helper.rb, initialize EngineCart:
@@ -37,19 +53,14 @@ And in your e.g. spec_helper.rb, initialize EngineCart:
 
 ## Configuration
 
-You can configure where the test app is created by setting the `TEST_APP` constant, e.g.:
+You can configure where the test app is created by setting the `ENGINE_CART_DESTINATION` env variable, e.g.:
 
 ```ruby
-  TEST_APP = "/tmp/generate-the-test-app-into-tmp-instead-of-your-app
+ENGINE_CART_DESTINATION="/tmp/generate-the-test-app-into-tmp-instead-of-your-app" rake ci
 ```
 
-You can also inject additional gems, or run other Rails generators by adding files to the `TEST_APP_TEMPLATES` directory.
-
-Gemfile.extra
-
-test_app generator
+After creating the test application, Engine Cart will run the test app generator (located in ./spec/test_app_templates/lib/generators). By default, it will attempt to run the `install` generator for your engine. If you do not have an `install` generator, or want to add additional steps (e.g. to install additional gems), you can add them to the `TestAppGenerator`.
 
-within_test_app
 
 ## Contributing
 

data/Rakefile

@@ -13,15 +13,31 @@ task :generate_test_gem => ['engine_cart:setup'] do
   system("rails plugin new spec/internal_gem")
   system("mv spec/internal_gem spec/internal")
   Rake::Task['engine_cart:inject_gemfile_extras'].invoke
-  within_test_app do
+  EngineCart.within_test_app do
     system "git init"
     FileUtils.touch('.gitignore')
     Dir.mkdir('spec')
+    File.open('spec/spec_helper.rb', 'w') do |f|
+      f.puts <<-EOF
+        require 'engine_cart'
+        EngineCart.load_application!
+
+        require 'rspec/rails'
+        require 'rspec/autorun'
+
+        require 'internal_gem'
+        RSpec.configure do |config|
+
+        end
+      EOF
+    end
+
     system "bundle install"
     system "echo 'require \"engine_cart/rake_task\"\n' >> Rakefile"
 
     system("rake engine_cart:prepare")
-    system("rake engine_cart:generate")
+    system "echo '\ngem \"rspec-rails\"\n' >> Gemfile"
+    system "bundle install"
   end
 end
 

data/lib/engine_cart.rb

@@ -1,8 +1,53 @@
 require "engine_cart/version"
+
 module EngineCart
   require "engine_cart/engine" if defined? Rails
-  
+
+  class << self
+
+    ##
+    # Name of the engine we're testing
+    attr_accessor :engine_name
+
+    ##
+    # Destination to generate the test app into
+    attr_accessor :destination
+
+    ##
+    # Path to a Rails application template
+    attr_accessor :template
+
+    ##
+    # Path to test app templates to make available to
+    # the test app generator
+    attr_accessor :templates_path
+
+
+    ##
+    # Additional options when generating a test rails application
+    attr_accessor :rails_options
+
+  end
+
+  self.engine_name = ENV["CURRENT_ENGINE_NAME"]
+  self.destination = ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || "./spec/internal"
+  self.template = ENV["ENGINE_CART_TEMPLATE"] || (File.expand_path('template.rb') if File.exists? 'template.rb')
+  self.templates_path = ENV['ENGINE_CART_TEMPLATES_PATH'] || "./spec/test_app_templates"
+  self.rails_options = ENV['ENGINE_CART_RAILS_OPTIONS']
+
+  def self.current_engine_name
+    engine_name || File.basename(Dir.glob("*.gemspec").first, '.gemspec')
+  end
+
   def self.load_application! path = nil
-    require File.expand_path("config/environment", path || ENV['RAILS_ROOT'] || "./spec/internal")
+    require File.expand_path("config/environment", path || EngineCart.destination)
+  end
+
+  def self.within_test_app
+    Dir.chdir(EngineCart.destination) do
+      Bundler.with_clean_env do
+        yield
+      end
+    end
   end
 end

data/lib/engine_cart/tasks/engine_cart.rake

@@ -1,22 +1,23 @@
+require 'engine_cart'
+require 'generators/engine_cart/install_generator'
+
 namespace :engine_cart do
 
   desc "Prepare a gem for using engine_cart"
   task :prepare do
-    require 'generators/engine_cart/engine_cart_generator'
-    generator = EngineCartGenerator.new
+    generator = EngineCart::InstallGenerator.new
     generator.create_test_app_templates
     generator.ignore_test_app
+    generator.add_gemfile_include
   end
 
   task :setup do
-    TEST_APP_TEMPLATES = 'spec/test_app_templates' unless defined? TEST_APP_TEMPLATES
-    TEST_APP = 'spec/internal' unless defined? TEST_APP
   end
 
   desc "Clean out the test rails app"
   task :clean => [:setup] do
     puts "Removing sample rails app"
-    `rm -rf #{TEST_APP}`
+    `rm -rf #{EngineCart.destination}`
   end
 
   task :create_test_rails_app => [:setup] do
@@ -28,59 +29,60 @@ namespace :engine_cart do
         end
 
         Bundler.with_clean_env do
-          `rails #{version} new internal`
+          `rails #{version} new internal #{EngineCart.rails_options} #{"-m #{EngineCart.template}" if EngineCart.template}`
         end
+
         unless $?
           raise "Error generating new rails app. Aborting."
         end
       end
 
-      FileUtils.move "#{dir}/internal", "#{TEST_APP}"
+      FileUtils.move "#{dir}/internal", "#{EngineCart.destination}"
 
     end
   end
 
   task :inject_gemfile_extras => [:setup] do
     # Add our gem and extras to the generated Rails app
-    open(File.expand_path('Gemfile', TEST_APP), 'a') do |f|
-      gemfile_extras_path = File.expand_path("Gemfile.extra", TEST_APP_TEMPLATES)
+    open(File.expand_path('Gemfile', EngineCart.destination), 'a') do |f|
+      gemfile_extras_path = File.expand_path("Gemfile.extra", EngineCart.templates_path)
 
       f.write <<-EOF
-        gem '#{current_engine_name}', :path => '#{File.expand_path('.')}'
-
-        if File.exists?("#{gemfile_extras_path}")
-          eval File.read("#{gemfile_extras_path}"), nil, "#{gemfile_extras_path}"
-        end
+        gem '#{EngineCart.current_engine_name}', :path => '#{File.expand_path('.')}'
 EOF
     end
   end
 
   desc "Create the test rails app"
   task :generate => [:setup] do
+    return if File.exists? File.expand_path('.generated_engine_cart', EngineCart.destination)
 
-    unless File.exists? File.expand_path('Rakefile', TEST_APP)
-      # Create a new test rails app
-      Rake::Task['engine_cart:create_test_rails_app'].invoke
-      Rake::Task['engine_cart:inject_gemfile_extras'].invoke
-
-      # Copy our test app generators into the app and prepare it
-      system "cp -r #{TEST_APP_TEMPLATES}/lib/generators #{TEST_APP}/lib"
-      within_test_app do
-        system "bundle install"
-        system "rails generate test_app"
-        system "rake db:migrate db:test:prepare"
-      end
-      puts "Done generating test app"
+    # Create a new test rails app
+    Rake::Task['engine_cart:create_test_rails_app'].invoke
+
+    system "bundle install"
+
+    Rake::Task['engine_cart:inject_gemfile_extras'].invoke
+
+    # Copy our test app generators into the app and prepare it
+    if File.exists? "#{EngineCart.templates_path}/lib/generators"
+      system "cp -r #{EngineCart.templates_path}/lib/generators #{EngineCart.destination}/lib"
     end
-  end
-end
 
-def current_engine_name
-  ENV["CURRENT_ENGINE_NAME"] || File.basename(Dir.glob("*.gemspec").first, '.gemspec')
+    within_test_app do
+      system "bundle install"
+      system "(rails g | grep test_app) && rails generate test_app"
+      system "rake db:migrate db:test:prepare"
+    end
+
+    File.open(File.expand_path('.generated_engine_cart', EngineCart.destination), 'w') { |f| f.puts true }
+
+    puts "Done generating test app"
+  end
 end
 
 def within_test_app
-  Dir.chdir(TEST_APP) do
+  Dir.chdir(EngineCart.destination) do
     Bundler.with_clean_env do
       yield
     end

data/lib/engine_cart/version.rb

@@ -1,3 +1,3 @@
 module EngineCart
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/generators/engine_cart/install_generator.rb

@@ -0,0 +1,60 @@
+require 'rails/generators'
+
+##
+# EngineCartGenerator sets up an engine to 
+# use engine_cart-generated test apps
+module EngineCart
+  class InstallGenerator < Rails::Generators::Base
+    def create_test_app_templates
+      empty_directory EngineCart.templates_path
+
+      empty_directory File.expand_path("lib/generators", EngineCart.templates_path)
+
+      create_file File.expand_path("lib/generators/test_app_generator.rb", EngineCart.templates_path), :skip => true do
+        <<-EOF
+        require 'rails/generators'
+
+        class TestAppGenerator < Rails::Generators::Base
+          source_root "#{EngineCart.templates_path}"
+
+          # if you need to generate any additional configuration
+          # into the test app, this generator will be run immediately
+          # after setting up the application
+
+          def install_engine
+            generate '#{EngineCart.current_engine_name}:install'
+          end
+        end
+
+        EOF
+      end
+    end
+
+    def ignore_test_app
+      # Ignore the generated test app in the gem's .gitignore file
+      git_root = (`git rev-parse --show-toplevel` rescue '.').strip
+
+      # If we don't have a .gitignore file already, don't worry about it
+      return unless File.exists? File.expand_path('.gitignore', git_root)
+
+      # If the directory is already ignored (somehow) don't worry about it
+      return if (system('git', 'check-ignore', TEST_APP, '-q') rescue false)
+
+      append_file  File.expand_path('.gitignore', git_root) do 
+        "#{EngineCart.destination}\n"
+      end 
+    end
+
+    def add_gemfile_include
+      append_file "Gemfile" do
+        <<-EOF
+  file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+  if File.exists?(file)
+    puts "Loading \#{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+    instance_eval File.read(file)
+  end
+        EOF
+      end
+    end
+  end
+end

data/spec/integration/engine_cart_spec.rb

@@ -12,10 +12,57 @@ describe "EngineCart powered application" do
   end
 
   it "should have a engine_cart:generate rake task available" do
-
+    EngineCart.within_test_app do
+      `rake -T | grep "engine_cart:generate"`
+      expect($?).to eq 0
+    end
   end
 
   it "should create a rails app when the engine_cart:generate is invoked" do
+    EngineCart.within_test_app do
+      `rake engine_cart:generate`
+      expect(File).to exist(File.expand_path("spec/internal"))
+    end
+  end
+
+  it "should be able to test the application controller from the internal app" do
+    EngineCart.within_test_app do    
+      File.open('spec/some_spec.rb', 'w') do |f|
+        f.puts <<-EOF
+          require 'spec_helper'
+
+          describe ApplicationController do
+            it "should be able to test the application controller from the internal app" do
+              expect(subject).to be_a_kind_of(ActionController::Base)
+            end
+          end
+
+        EOF
+      end
+
+      `bundle exec rspec spec/some_spec.rb`
+      expect($?).to eq 0
+    end
+  end
+
+  it "should be able to run specs that reference gems provided by the test app" do
+    EngineCart.within_test_app do
+      File.open('spec/require_spec.rb', 'w') do |f|
+        f.puts <<-EOF
+          require 'spec_helper'
+          require 'coffee-rails'
+
+          describe ApplicationController do
+            it "should be able to run specs that reference gems provided by the test app" do
+              expect(true).to be_true
+            end
+          end
+
+        EOF
+      end
 
+      `bundle exec rspec spec/require_spec.rb`
+      expect($?).to eq 0
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: engine_cart
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,11 +84,9 @@ files:
 - lib/engine_cart/rake_task.rb
 - lib/engine_cart/tasks/engine_cart.rake
 - lib/engine_cart/version.rb
-- lib/generators/engine_cart/engine_cart_generator.rb
+- lib/generators/engine_cart/install_generator.rb
 - spec/integration/engine_cart_spec.rb
 - spec/spec_helper.rb
-- spec/test_app_templates/Gemfile.extra
-- spec/test_app_templates/lib/generators/test_app_generator.rb
 homepage: https://github.com/cbeer/engine_cart
 licenses:
 - MIT
@@ -109,13 +107,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Helper for testing Rails Engines sanely
 test_files:
 - spec/integration/engine_cart_spec.rb
 - spec/spec_helper.rb
-- spec/test_app_templates/Gemfile.extra
-- spec/test_app_templates/lib/generators/test_app_generator.rb
-has_rdoc: 

data/lib/generators/engine_cart/engine_cart_generator.rb

@@ -1,42 +0,0 @@
-require 'rails/generators'
-
-class EngineCartGenerator < Rails::Generators::Base
-  TEST_APP_TEMPLATES = 'spec/test_app_templates' unless defined? TEST_APP_TEMPLATES
-  TEST_APP = 'spec/internal' unless defined? TEST_APP
-
-  def create_test_app_templates
-    empty_directory TEST_APP_TEMPLATES
-    create_file File.expand_path("Gemfile.extra", TEST_APP_TEMPLATES), :skip => true do
-      "# extra gems to load into the test app go here"
-    end
-
-    empty_directory File.expand_path("lib/generators", TEST_APP_TEMPLATES)
-
-    create_file File.expand_path("lib/generators/test_app_generator.rb", TEST_APP_TEMPLATES), :skip => true do
-      <<-EOF
-      require 'rails/generators'
-
-      class TestAppGenerator < Rails::Generators::Base
-        source_root "#{TEST_APP_TEMPLATES}"
-
-      end
-
-      EOF
-    end
-  end
-
-  def ignore_test_app
-    # Ignore the generated test app in the gem's .gitignore file
-    git_root = (`git rev-parse --show-toplevel` rescue '.').strip
-
-    # If we don't have a .gitignore file already, don't worry about it
-    return unless File.exists? File.expand_path('.gitignore', git_root)
-
-    # If the directory is already ignored (somehow) don't worry about it
-    return if (system('git', 'check-ignore', TEST_APP, '-q') rescue false)
-
-    append_file  File.expand_path('.gitignore', git_root) do 
-      "#{TEST_APP}\n"
-    end 
-  end
-end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -1,7 +0,0 @@
-      require 'rails/generators'
-
-      class TestAppGenerator < Rails::Generators::Base
-        source_root "spec/test_app_templates"
-
-      end
-