engine_cart 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fd5cf56f5fd88e6c9c18b2fe3151450027a1492
-  data.tar.gz: 5956ec04b0713e1c2d7ca8de696efd823aca7e10
+  metadata.gz: 227eee21a510de7524b223c48ad1c60dc06aeef2
+  data.tar.gz: 7db8fb738878c4915e558b09f207706d8392a894
 SHA512:
-  metadata.gz: 0c865ee31d20c689fdeb02f5222ead8797cf11942f3548e911985a08af6529c09ae9c3e18e410f6530a8a14aeca44416e3321f32c013c6f65035a27e53080742
-  data.tar.gz: b53c73fd101daaeb7d828765b11b11935c2175bb7d0394b389f1b69d96d66c214d176b754ead3de6f5a62ecaf41c576fadf0bd1761ba2eedf2346c15f469925c
+  metadata.gz: fabe070a9189917f8900285c0adc015736387a7e351b661ecfd9d55febd54c0ee17aca00223beaeb1e403460c3c4b9f2b056648d18202169d710936f07b1ff44
+  data.tar.gz: 5e42eb9eddf3ad41ca26520aca754b9f96b9392c8703bca26db6f35ca4ea0ec0dbea9a64ac8020b5219e2a9147b8596fbeff2697da9ae97862459f28dd52d6c8

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/internal

data/README.md

@@ -19,26 +19,37 @@ Or install it yourself as:
 
 ## Usage
 
-Add this to your Rakefile:
+In your Rakefile you can generate the Rails application using, e.g.:
 
-    # Path to the test app
-    # TEST_APP = 'spec/internal'
-    # Path to files to include in the test app
-    # TEST_APP_TEMPLATES = 'spec/test_app_templates'
+```ruby
     require 'engine_cart/rake_task'
 
-In your rake tasks, you can require the test app get build first:
-
     task :ci => ['engine_cart:generate'] do
       # run the tests
     end
+```
 
+And in your e.g. spec_helper.rb, initialize EngineCart:
 
-And in your e.g. spec_helper:
-
-  require 'engine_cart'
+```ruby
   EngineCart.load_application!
+```
+
+## Configuration
+
+You can configure where the test app is created by setting the `TEST_APP` constant, e.g.:
+
+```ruby
+  TEST_APP = "/tmp/generate-the-test-app-into-tmp-instead-of-your-app
+```
+
+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
 
+within_test_app
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,28 @@
 require "bundler/gem_tasks"
+require 'engine_cart/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :ci => ['generate_test_gem', 'spec'] do
+
+end
+
+task :generate_test_gem => ['engine_cart:setup'] do
+  system("rm -rf spec/internal")
+  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
+    system "git init"
+    FileUtils.touch('.gitignore')
+    Dir.mkdir('spec')
+    system "bundle install"
+    system "echo 'require \"engine_cart/rake_task\"\n' >> Rakefile"
+
+    system("rake engine_cart:prepare")
+    system("rake engine_cart:generate")
+  end
+end
+
+task :default => :ci

data/engine_cart.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/engine_cart/engine.rb

@@ -0,0 +1,8 @@
+module EngineCart
+  require 'rails'
+  class Engine < Rails::Engine
+    rake_tasks do
+      load "engine_cart/tasks/engine_cart.rake"
+    end
+  end
+end

data/lib/engine_cart/tasks/engine_cart.rake

@@ -1,5 +1,13 @@
 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.create_test_app_templates
+    generator.ignore_test_app
+  end
+
   task :setup do
     TEST_APP_TEMPLATES = 'spec/test_app_templates' unless defined? TEST_APP_TEMPLATES
     TEST_APP = 'spec/internal' unless defined? TEST_APP
@@ -11,23 +19,34 @@ namespace :engine_cart do
     `rm -rf #{TEST_APP}`
   end
 
-  desc "Create the test rails app"
-  task :generate => [:setup] do
+  task :create_test_rails_app => [:setup] do
+    system "rails new #{TEST_APP}"
+  end
 
-    unless File.exists? File.expand_path('Rakefile', TEST_APP)
-      system "rails new #{TEST_APP}"
-      open(File.expand_path('Gemfile', TEST_APP), 'a') do |f|
-        gemfile_extras_path = File.expand_path("Gemfile.extra", TEST_APP_TEMPLATES)
+  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)
 
-        f.write <<-EOF
-        gem '#{current_engine_name}', :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
 EOF
-      end
+    end
+  end
+
+  desc "Create the test rails app"
+  task :generate => [:setup] do
 
+    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"
@@ -44,9 +63,9 @@ def current_engine_name
 end
 
 def within_test_app
-  FileUtils.cd(TEST_APP)
-  Bundler.with_clean_env do
-    yield
+  Dir.chdir(TEST_APP) do
+    Bundler.with_clean_env do
+      yield
+    end
   end
-  FileUtils.cd(APP_ROOT)
 end

data/lib/engine_cart/version.rb

@@ -1,3 +1,3 @@
 module EngineCart
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/engine_cart.rb

@@ -1,7 +1,7 @@
 require "engine_cart/version"
-
 module EngineCart
-  # Your code goes here...
+  require "engine_cart/engine"
+  
   def self.load_application! path = nil
     require File.expand_path("config/environment", path || ENV['RAILS_ROOT'] || "./spec/internal")
   end

data/lib/generators/engine_cart/engine_cart_generator.rb

@@ -0,0 +1,42 @@
+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/integration/engine_cart_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "EngineCart powered application" do
+  TEST_APP = File.expand_path("../internal", File.dirname(__FILE__))
+  it "should have the test_app_templates pre-generated" do
+    expect(File).to exist File.expand_path("spec/test_app_templates", TEST_APP)
+  end
+
+  it "should ignore the test app" do
+    git_ignore = File.expand_path(".gitignore", TEST_APP)
+    expect(File.read(git_ignore)).to match /spec\/internal/
+  end
+
+  it "should have a engine_cart:generate rake task available" do
+
+  end
+
+  it "should create a rails app when the engine_cart:generate is invoked" do
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'engine_cart'
+require 'rspec'
+
+RSpec.configure do |config|
+
+end

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

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: engine_cart
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Helper for testing Rails Engines sanely
 email:
 - cabeer@stanford.edu
@@ -52,9 +80,15 @@ files:
 - Rakefile
 - engine_cart.gemspec
 - lib/engine_cart.rb
+- lib/engine_cart/engine.rb
 - 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
+- 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
@@ -79,4 +113,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Helper for testing Rails Engines sanely
-test_files: []
+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