enginex 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 José Valim http://blog.plataformatec.com.br
+
+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.rdoc

@@ -0,0 +1,18 @@
+== Enginex
+
+This is a tool which creates a Rails 3 Engine with Rakefile, Gemfile and a ready to run test suite on top of a vendored Rails application.
+
+Enginex is going to be used in José Valim's upcoming book for Rails 3.
+
+== Usage
+
+  $ enginex ENGINE_NAME
+
+== Bugs and Feedback
+
+If you discover any bugs, feel free to send me a message or create an issue on GitHub tracker:
+
+http://github.com/josevalim
+http://github.com/josevalim/enginex/issues
+
+MIT License. Copyright 2010 José Valim. http://blog.plataformatec.com.br

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'enginex')
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Enginex'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "enginex"
+    s.version = Enginex::VERSION
+    s.summary = "Creates a Rails 3 engine with Rakefile, Gemfile and running tests"
+    s.email = "jose.valim@plataformatec.com.br"
+    s.homepage = "http://github.com/josevalim/enginex"
+    s.description = "Creates a Rails 3 engine with Rakefile, Gemfile and running tests"
+    s.authors = ['José Valim']
+    s.files =  FileList["[A-Z]*", "lib/**/*"]
+    s.bindir = "bin"
+    s.executables = %w(enginex)
+    s.add_dependency("thor", "~> 0.13.0")
+    s.add_dependency("bundler", "~> 0.9.0")
+    s.add_dependency("rails", "~> 3.0.0")
+    s.add_dependency("rake", "~> 0.8")
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/bin/enginex

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'enginex'
+Enginex.start

data/lib/enginex.rb

@@ -0,0 +1,119 @@
+require "thor/group"
+require "active_support"
+require "active_support/version"
+require "active_support/core_ext/string"
+
+require "rails/generators"
+require "generators/rails/app/app_generator"
+
+# TODO Remove webrat hack file
+# TODO Remove Rails 3 application hack
+class Enginex < Thor::Group
+  VERSION = "0.1.0".freeze
+
+  include Thor::Actions
+  check_unknown_options!
+
+  def self.source_root
+    @_source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def self.say_step(message)
+    @step = (@step || 0) + 1
+    class_eval <<-METHOD, __FILE__, __LINE__ + 1
+      def step_#{@step}
+        #{"puts" if @step > 1}
+        say_status "STEP #{@step}", #{message.inspect}
+      end
+    METHOD
+  end
+
+  argument :path, :type => :string,
+                  :desc => "Path to the engine to be created"
+
+  desc "Creates a Rails 3 engine with Rakefile, Gemfile and running tests."
+
+  say_step "Creating gem skeleton"
+
+  def create_root
+    self.destination_root = File.expand_path(path, destination_root)
+    set_accessors!
+
+    directory "root", "."
+    FileUtils.cd(destination_root)
+  end
+
+  def copy_gitignore
+    copy_file "gitignore", ".gitignore"
+  end
+
+  say_step "Vendoring Rails application at test/dummy"
+
+  def invoke_rails_app_generator
+    invoke Rails::Generators::AppGenerator,
+      [ File.expand_path("test/dummy", destination_root) ]
+  end
+
+  say_step "Configuring Rails application"
+
+  def change_config_files
+    store_application_definition!
+    template "rails/boot.rb", "test/dummy/config/boot.rb", :force => true
+    template "rails/application.rb", "test/dummy/config/application.rb", :force => true
+  end
+
+  def rails_3_beta_fix
+    inject_into_class "test/dummy/config/application.rb", "Application",
+      "    config.root = File.expand_path('../..', __FILE__)\n\n"
+  end
+
+  say_step "Removing unneeded files"
+
+  def remove_uneeded_rails_files
+    inside "test/dummy" do
+      remove_file "db/seeds.rb"
+      remove_file "doc"
+      remove_file "Gemfile"
+      remove_file "lib/tasks"
+      remove_file "public/images/rails.png"
+      remove_file "public/index.html"
+      remove_file "public/robots.txt"
+      remove_file "Rakefile"
+      remove_file "README"
+      remove_file "test"
+      remove_file "vendor"
+    end
+  end
+
+  protected
+
+    def self.banner
+      self_task.formatted_usage(self, false)
+    end
+
+    def application_definition
+      @application_definition ||= begin
+        contents = File.read(File.expand_path("test/dummy/config/application.rb", destination_root))
+        contents[(contents.index("module Dummy"))..-1]
+      end
+    end
+    alias :store_application_definition! :application_definition
+
+    # Cache accessors since we are changing the directory
+    def set_accessors!
+      self.name
+      self.class.source_root
+    end
+
+    def name
+      @name ||= File.basename(destination_root)
+    end
+
+    def camelized
+      @camelized ||= name.camelize
+    end
+
+    def underscored
+      @underscored ||= name.underscore
+    end
+end

data/lib/templates/gitignore

@@ -0,0 +1,5 @@
+.bundle/
+db/*.sqlite3
+log/*.log
+tmp/**/*
+pkg/

data/lib/templates/rails/application.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "<%= underscored %>"
+
+<%= application_definition %>

data/lib/templates/rails/boot.rb

@@ -0,0 +1,9 @@
+begin
+  require File.expand_path("../../../../.bundle/environment", __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/lib/templates/root/Gemfile.tt

@@ -0,0 +1,9 @@
+source "http://gemcutter.org"
+
+gem "rails", "<%= ActiveSupport::VERSION::STRING %>"
+gem "webrat", "0.7"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+if RUBY_VERSION < '1.9'
+  gem "ruby-debug", ">= 0.10.3"
+end

data/lib/templates/root/Rakefile.tt

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = '<%= camelized %>'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = "<%= underscored %>"
+  s.summary = "Insert <%= camelized %> summary."
+  s.description = "Insert <%= camelized %> description."
+  s.files =  FileList["[A-Z]*", "lib/**/*"]
+  s.version = "0.0.1"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+desc "Install the gem #{spec.name}-#{spec.version}.gem"
+task :install do
+  system("gem install pkg/#{spec.name}-#{spec.version}.gem --no-ri --no-rdoc")
+end

data/lib/templates/root/lib/%underscored%.rb.tt

@@ -0,0 +1,2 @@
+module <%= camelized %>
+end

data/lib/templates/root/test/%underscored%_test.rb.tt

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class <%= camelized %>Test < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, <%= camelized %>
+  end
+end

data/lib/templates/root/test/integration/navigation_test.rb.tt

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NagivationTest < ActionController::IntegrationTest
+  test "truth" do
+    assert_kind_of Dummy::Application, Rails.application
+  end
+end

data/lib/templates/root/test/test_helper.rb

@@ -0,0 +1,18 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+$:.unshift File.dirname(__FILE__)
+
+Webrat.configure do |config|
+  config.mode = :rails
+  config.open_error_files = false
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/lib/templates/root/test/webrat/integrations/rails.rb

@@ -0,0 +1,31 @@
+require 'webrat/core/elements/field'
+
+module Webrat
+  Field.class_eval do
+    def parse_rails_request_params(params)
+      Rack::Utils.parse_nested_query(params)
+    end
+  end
+end
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Matchers
+ 
+    # The Rails version of within supports passing in a model and Webrat
+    # will apply a scope based on Rails' dom_id for that model.
+    #
+    # Example:
+    #   within User.last do
+    #     click_link "Delete"
+    #   end
+    def within(selector_or_object, &block)
+      if selector_or_object.is_a?(String)
+        super
+      else
+        super('#' + RecordIdentifier.dom_id(selector_or_object), &block)
+      end
+    end
+  end
+end

data/test/enginex_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class EnginexTest < ActiveSupport::TestCase
+  test "enginex skeleton" do
+    run_enginex do
+      # Root
+      assert_file "Rakefile"
+      assert_file "Gemfile", /gem "rails"/, /gem "webrat"/
+      assert_file ".gitignore", /\.bundle/, /db\/\*\.sqlite3/
+
+      # Lib
+      assert_file "lib/demo_engine.rb", /module DemoEngine\nend/
+
+      # Test
+      assert_file "test/test_helper.rb"
+      assert_directory "test/support/"
+      assert_directory "test/integration/"
+
+      assert_file "test/demo_engine_test.rb", /assert_kind_of Module, DemoEngine/
+      assert_file "test/integration/navigation_test.rb", /assert_kind_of Dummy::Application, Rails.application/
+
+      # Vendored Rails
+      assert_file "test/dummy/config/application.rb"
+    end
+  end
+
+  test "enginex rakefile can create a gem" do
+    run_enginex do
+      execute("rake gem")
+      assert_file "pkg/demo_engine-0.0.1.gem"
+    end
+  end
+
+  test "enginex can run tests" do
+    run_enginex do
+      assert_match /2 tests, 2 assertions, 0 failures, 0 errors/, execute("rake test")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+
+begin
+  gem "test-unit"
+rescue LoadError
+end
+
+ENV["RAILS_ENV"] ||= "test"
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+
+$counter = 0
+LIB_PATH = File.expand_path('../../lib', __FILE__)
+BIN_PATH = File.expand_path('../../bin/enginex', __FILE__)
+
+DESTINATION_ROOT = File.expand_path('../enginex', __FILE__)
+FileUtils.rm_rf(DESTINATION_ROOT)
+
+$:.unshift LIB_PATH
+require 'enginex'
+
+
+class ActiveSupport::TestCase
+  def run_enginex
+    $counter += 1
+    `ruby -I#{LIB_PATH} -rrubygems #{BIN_PATH} #{destination_root}`
+    yield
+    FileUtils.rm_rf(File.dirname(destination_root))
+  rescue Exception => e
+    puts "Error happened. #{destination_root.inspect} left for inspecting."
+    raise e
+  end
+
+  def destination_root
+    File.join(DESTINATION_ROOT, $counter.to_s, "demo_engine")
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+  end
+  alias :silence :capture
+
+  def assert_file(relative, *contents)
+    absolute = File.expand_path(relative, destination_root)
+    assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not"
+
+    read = File.read(absolute) if block_given? || !contents.empty?
+    yield read if block_given?
+
+    contents.each do |content|
+      assert_match content, read
+    end
+  end
+  alias :assert_directory :assert_file
+
+  def assert_no_file(relative)
+    absolute = File.expand_path(relative, destination_root)
+    assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does"
+  end
+  alias :assert_no_directory :assert_no_file
+
+  def execute(command)
+    current_path = Dir.pwd
+    FileUtils.cd destination_root
+    `#{command}`
+  ensure
+    FileUtils.cd current_path
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: enginex
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-25 00:00:00 +01:00
+default_executable: enginex
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.13.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+    version: 
+description: Creates a Rails 3 engine with Rakefile, Gemfile and running tests
+email: jose.valim@plataformatec.com.br
+executables: 
+- enginex
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/enginex.rb
+- lib/templates/gitignore
+- lib/templates/rails/application.rb
+- lib/templates/rails/boot.rb
+- lib/templates/root/Gemfile.tt
+- lib/templates/root/Rakefile.tt
+- lib/templates/root/lib/%underscored%.rb.tt
+- lib/templates/root/test/%underscored%_test.rb.tt
+- lib/templates/root/test/integration/navigation_test.rb.tt
+- lib/templates/root/test/test_helper.rb
+- lib/templates/root/test/webrat/integrations/rails.rb
+has_rdoc: true
+homepage: http://github.com/josevalim/enginex
+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: Creates a Rails 3 engine with Rakefile, Gemfile and running tests
+test_files: 
+- test/enginex_test.rb
+- test/test_helper.rb