combustion 0.3.3 → 0.4.0

data/HISTORY

@@ -1,3 +1,14 @@
+0.4.0 - March 16th 2013
+* Don't delete the SQLite test database if it doesn't exist (Michael Gee, Alexander Rozumiy).
+* Support for secret_key_base for Rails 4 apps (Philip Arndt).
+* eager_load is set to true when using the production environment (Philip Arndt).
+* whiny_nils is not set if using Rails 4 (Philip Arndt).
+* Mysql2 can raise Mysql::Error with JRuby (Philip Arndt).
+* Whitelist attributes typo is fixed (Geoff Hodgson).
+* Mass assignment checks are now turned on, so errors are raised. This matches Rails' defaults for test environments (Josh Adams).
+* Combustion no longer loads all of the Rails stack by default, just Railties and ActiveSupport. A combustion-rails gem will be created that uses all of Rails by default (Philip Arndt).
+* Combustion classes now all define the outer module, so each can be required by themselves, should you desire (Philip Arndt).
+
 0.3.3 - December 23rd 2012
 * Removing version file - version number can just live in the gemspec.
 * Load ActionController and ActionMailer via their Railties, not non-existent Engines (Chris Beer).
@@ -7,7 +18,7 @@
 * Correctly drop the test database when using SQLite (Warren Seen).
 * Don't attempt to load sprockets for Rails 3.0.x (Alex Rozumey).
 
-0.3.2 - March 3rd 2011
+0.3.2 - March 3rd 2012
 * Tentative Rails 3.0 and migrations support.
 * Allow for different internal app directory.
 

data/README.textile

@@ -11,14 +11,14 @@ Get the gem into either your gemspec or your Gemfile, depending on how you manag
 <pre><code># gemspec
 gem.add_development_dependency 'combustion', '~> 0.3.1'
 # Gemfile
-gem 'combustion', '~> 0.3.1', :group => :development</code></pre>
+gem 'combustion', '~> 0.3.1', :group => :test</code></pre>
 
 In your @spec_helper.rb@, get Combustion to set itself up - which has to happen before you introduce @rspec/rails@ and - if being used - @capybara/rails@. Here's an example within context:
 
 <pre><code>require 'rubygems'
 require 'bundler'
 
-Bundler.require :default, :development
+Bundler.require :default, :test
 
 require 'capybara/rspec'
 
@@ -50,10 +50,24 @@ Combustion.initialize!</code></pre>
 
 h3. Configuring which Rails modules should be loaded.
 
-By default, Combustion assumes you want the full Rails stack. You can customise this though - just pass in what you'd like loaded to the @Combustion.initialize!@ call:
+By default, Combustion doesn't come with any of the Rails stack. You can customise this though - just pass in what you'd like loaded to the @Combustion.initialize!@ call:
 
-<pre><code>Combustion.initialize! :active_record, :action_controller,
-  :action_view, :sprockets</code></pre>
+<pre><code>
+Combustion.initialize! :active_record, :action_controller,
+                       :action_view, :sprockets
+</code></pre>
+
+And then in your engine's Gemfile:
+
+<pre><code>
+group :test do
+  gem 'activerecord'
+  gem 'actionpack' # action_controller, action_view
+  gem 'sprockets'
+end
+</code></pre>
+
+Make sure to specify the appropriate version that you want to use.
 
 ActiveSupport is always loaded, as it's an integral part of Rails.
 
@@ -95,6 +109,10 @@ end</code></pre>
 
 Just like in a standard Rails app, if you have a mounted engine, then its routes are accessible through whatever it has been loaded as.
 
+h3. Using other Rails-focused libraries
+
+Be aware that other gems may require parts of Rails when they're loaded, and this could cause some issues with Combustion's own setup. You may need to manage the loading yourself by setting @:require@ to false in your Gemfile for the gem in question, and then requiring it manually in your spec_helper. View "this issue":https://github.com/pat/combustion/issues/33 for an example with FactoryGirl.
+
 h3. Environment and Logging
 
 Your tests will execute within the test environment for the internal Rails app - and so logs are available at @spec/internal/log/test.log@. You should probably create that log directory so Rails doesn't complain.

data/combustion.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'combustion'
-  s.version     = '0.3.3'
+  s.version     = '0.4.0'
   s.authors     = ['Pat Allan']
   s.email       = ['pat@freelancing-gods.com']
   s.homepage    = ''
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'rails', '>= 3.0.0'
+  s.add_runtime_dependency 'activesupport', '>= 3.0.0'
+  s.add_runtime_dependency 'railties', '>= 3.0.0'
   s.add_runtime_dependency 'thor',  '>= 0.14.6'
 end

data/lib/combustion.rb

@@ -1,9 +1,9 @@
 require 'rails'
 require 'active_support/dependencies'
 
-module Combustion  
+module Combustion
   mattr_accessor :path, :schema_format
-  
+
   self.path          = '/spec/internal'
   self.schema_format = :ruby
 
@@ -15,22 +15,22 @@ module Combustion
   end
 
   def self.initialize!(*modules)
-    modules = Modules if modules.empty? || modules == [:all]
+    modules = Modules if modules == [:all]
     modules.each { |mod| require "#{mod}/railtie" }
 
     Combustion::Application.configure_for_combustion
     Combustion::Application.initialize!
 
-    if modules.include?('active_record') || modules.include?(:active_record)
+    if modules.map(&:to_s).include? 'active_record'
       Combustion::Database.setup
     end
 
     RSpec.configure do |config|
       include_capybara_into config
 
-      config.include(Combustion::Application.routes.url_helpers)
+      config.include Combustion::Application.routes.url_helpers
       if Combustion::Application.routes.respond_to?(:mounted_helpers)
-        config.include(Combustion::Application.routes.mounted_helpers)
+        config.include Combustion::Application.routes.mounted_helpers
       end
     end if defined?(RSpec) && RSpec.respond_to?(:configure)
   end

data/lib/combustion/application.rb

@@ -1,34 +1,43 @@
-Rails.env = 'test'
+require 'securerandom'
+Rails.env = ENV['RAILS_ENV'] || 'test'
 
-class Combustion::Application < Rails::Application
-  # Core Settings
-  config.cache_classes               = true
-  config.whiny_nils                  = true
-  config.consider_all_requests_local = true
-  config.secret_token                = Digest::SHA1.hexdigest Time.now.to_s
+module Combustion
+  class Application < Rails::Application
+    # Core Settings
+    config.cache_classes               = true
+    config.whiny_nils                  = true if Rails.version < '4.0.0'
+    config.consider_all_requests_local = true
+    config.secret_token                = Digest::SHA1.hexdigest Time.now.to_s
+    config.eager_load                  = Rails.env.production?
+    config.secret_key_base             = SecureRandom.hex if Rails.version >= '4.0.0'
 
-  # ActiveSupport Settings
-  config.active_support.deprecation = :stderr
+    # ActiveSupport Settings
+    config.active_support.deprecation = :stderr
 
-  # Some settings we're not sure if we want, so let's not load them by default.
-  # Instead, wait for this method to be invoked (to get around load-order
-  # complications).
-  def self.configure_for_combustion
-    config.root = File.expand_path File.join(Dir.pwd, Combustion.path)
+    # Turn on ActiveRecord attribute whitelisting
+    # This way the dummy app matches new rails apps re: this setting
+    config.active_record.whitelist_attributes = true if config.respond_to? :active_record
 
-    if defined?(ActionController) && defined?(ActionController::Railtie)
-      config.action_dispatch.show_exceptions            = false
-      config.action_controller.perform_caching          = false
-      config.action_controller.allow_forgery_protection = false
-    end
+    # Some settings we're not sure if we want, so let's not load them by default.
+    # Instead, wait for this method to be invoked (to get around load-order
+    # complications).
+    def self.configure_for_combustion
+      config.root = File.expand_path File.join(Dir.pwd, Combustion.path)
 
-    if defined?(ActionMailer) && defined?(ActionMailer::Railtie)
-      config.action_mailer.delivery_method     = :test
-      config.action_mailer.default_url_options = {:host => 'www.example.com'}
-    end
+      if defined? ActionController::Railtie
+        config.action_dispatch.show_exceptions            = false
+        config.action_controller.perform_caching          = false
+        config.action_controller.allow_forgery_protection = false
+      end
+
+      if defined? ActionMailer::Railtie
+        config.action_mailer.delivery_method     = :test
+        config.action_mailer.default_url_options = {:host => 'www.example.com'}
+      end
 
-    if defined?(Sprockets)
-      config.assets.enabled = true
+      if defined? Sprockets
+        config.assets.enabled = true
+      end
     end
   end
 end

data/lib/combustion/database.rb

@@ -1,166 +1,168 @@
-class Combustion::Database
-  def self.setup
-    silence_stream(STDOUT) do
-      reset_database
-      load_schema
-      migrate
+module Combustion
+  class Database
+    def self.setup
+      silence_stream(STDOUT) do
+        reset_database
+        load_schema
+        migrate
+      end
     end
-  end
 
-  def self.reset_database
-    abcs = ActiveRecord::Base.configurations
-    case abcs['test']['adapter']
-    when /mysql/
-      ActiveRecord::Base.establish_connection(:test)
-      ActiveRecord::Base.connection.recreate_database(abcs['test']['database'],
-        mysql_creation_options(abcs['test']))
-      ActiveRecord::Base.establish_connection(:test)
-    when /postgresql/
-      ActiveRecord::Base.clear_active_connections!
-      drop_database(abcs['test'])
-      create_database(abcs['test'])
-    when /sqlite/
-      drop_database(abcs['test'])
-      create_database(abcs['test'])
-    when 'sqlserver'
-      test = abcs.deep_dup['test']
-      test_database = test['database']
-      test['database'] = 'master'
-      ActiveRecord::Base.establish_connection(test)
-      ActiveRecord::Base.connection.recreate_database!(test_database)
-    when "oci", "oracle"
-      ActiveRecord::Base.establish_connection(:test)
-      ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl|
-        ActiveRecord::Base.connection.execute(ddl)
+    def self.reset_database
+      abcs = ActiveRecord::Base.configurations
+      case abcs['test']['adapter']
+      when /mysql/
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.recreate_database(abcs['test']['database'],
+          mysql_creation_options(abcs['test']))
+        ActiveRecord::Base.establish_connection(:test)
+      when /postgresql/
+        ActiveRecord::Base.clear_active_connections!
+        drop_database(abcs['test'])
+        create_database(abcs['test'])
+      when /sqlite/
+        drop_database(abcs['test'])
+        create_database(abcs['test'])
+      when 'sqlserver'
+        test = abcs.deep_dup['test']
+        test_database = test['database']
+        test['database'] = 'master'
+        ActiveRecord::Base.establish_connection(test)
+        ActiveRecord::Base.connection.recreate_database!(test_database)
+      when "oci", "oracle"
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl|
+          ActiveRecord::Base.connection.execute(ddl)
+        end
+      when 'firebird'
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.recreate_database!
+      else
+        raise "Cannot reset databases for '#{abcs['test']['adapter']}'"
       end
-    when 'firebird'
-      ActiveRecord::Base.establish_connection(:test)
-      ActiveRecord::Base.connection.recreate_database!
-    else
-      raise "Cannot reset databases for '#{abcs['test']['adapter']}'"
     end
-  end
 
-  def self.load_schema
-    case Combustion.schema_format
-    when :ruby
-      load Rails.root.join('db', 'schema.rb')
-    when :sql
-      ActiveRecord::Base.connection.execute(
-        File.read(Rails.root.join('db', 'structure.sql'))
-      )
-    else
-      raise "Unknown schema format: #{Combustion.schema_format}"
+    def self.load_schema
+      case Combustion.schema_format
+      when :ruby
+        load Rails.root.join('db', 'schema.rb')
+      when :sql
+        ActiveRecord::Base.connection.execute(
+          File.read(Rails.root.join('db', 'structure.sql'))
+        )
+      else
+        raise "Unknown schema format: #{Combustion.schema_format}"
+      end
     end
-  end
 
-  def self.migrate
-    migrator = ActiveRecord::Migrator
-    paths    = Array('db/migrate/')
+    def self.migrate
+      migrator = ActiveRecord::Migrator
+      paths    = Array('db/migrate/')
 
-    if migrator.respond_to?(:migrations_paths)
-      paths = migrator.migrations_paths
+      if migrator.respond_to?(:migrations_paths)
+        paths = migrator.migrations_paths
+      end
+      # Append the migrations inside the internal app's db/migrate directory
+      paths << File.join(Rails.root, 'db/migrate')
+      migrator.migrate paths, nil
     end
-    # Append the migrations inside the internal app's db/migrate directory
-    paths << File.join(Rails.root, 'db/migrate')
-    migrator.migrate paths, nil
-  end
 
-  private
+    private
 
-  def self.create_database(config)
-    begin
-      if config['adapter'] =~ /sqlite/
-        if File.exist?(config['database'])
-          $stderr.puts "#{config['database']} already exists"
+    def self.create_database(config)
+      begin
+        if config['adapter'] =~ /sqlite/
+          if File.exist?(config['database'])
+            $stderr.puts "#{config['database']} already exists"
+          else
+            begin
+              # Create the SQLite database
+              ActiveRecord::Base.establish_connection(config)
+              ActiveRecord::Base.connection
+            rescue Exception => e
+              $stderr.puts e, *(e.backtrace)
+              $stderr.puts "Couldn't create database for #{config.inspect}"
+            end
+          end
+          return # Skip the else clause of begin/rescue
         else
+          ActiveRecord::Base.establish_connection(config)
+          ActiveRecord::Base.connection
+        end
+      rescue
+        case config['adapter']
+        when /^(jdbc)?mysql/
+          if config['adapter'] =~ /jdbc/
+            #FIXME After Jdbcmysql gives this class
+            require 'active_record/railties/jdbcmysql_error'
+            error_class = ArJdbcMySQL::Error
+          else
+            error_class = config['adapter'] =~ /mysql2/ && defined?(Mysql2) ? Mysql2::Error : Mysql::Error
+          end
+          access_denied_error = 1045
+          begin
+            ActiveRecord::Base.establish_connection(config.merge('database' => nil))
+            ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
+            ActiveRecord::Base.establish_connection(config)
+          rescue error_class => sqlerr
+            if sqlerr.errno == access_denied_error
+              print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
+              root_password = $stdin.gets.strip
+              grant_statement = "GRANT ALL PRIVILEGES ON #{config['database']}.* " \
+                "TO '#{config['username']}'@'localhost' " \
+                "IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;"
+              ActiveRecord::Base.establish_connection(config.merge(
+                  'database' => nil, 'username' => 'root', 'password' => root_password))
+              ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
+              ActiveRecord::Base.connection.execute grant_statement
+              ActiveRecord::Base.establish_connection(config)
+            else
+              $stderr.puts sqlerr.error
+              $stderr.puts "Couldn't create database for #{config.inspect}, charset: #{config['charset'] || @charset}, collation: #{config['collation'] || @collation}"
+              $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
+            end
+          end
+        when /^(jdbc)?postgresql$/
+          @encoding = config['encoding'] || ENV['CHARSET'] || 'utf8'
           begin
-            # Create the SQLite database
+            ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+            ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => @encoding))
             ActiveRecord::Base.establish_connection(config)
-            ActiveRecord::Base.connection
           rescue Exception => e
             $stderr.puts e, *(e.backtrace)
             $stderr.puts "Couldn't create database for #{config.inspect}"
           end
         end
-        return # Skip the else clause of begin/rescue
       else
-        ActiveRecord::Base.establish_connection(config)
-        ActiveRecord::Base.connection
+        $stderr.puts "#{config['database']} already exists"
       end
-    rescue
+    end
+
+    def self.drop_database(config)
       case config['adapter']
       when /^(jdbc)?mysql/
-        if config['adapter'] =~ /jdbc/
-          #FIXME After Jdbcmysql gives this class
-          require 'active_record/railties/jdbcmysql_error'
-          error_class = ArJdbcMySQL::Error
-        else
-          error_class = config['adapter'] =~ /mysql2/ ? Mysql2::Error : Mysql::Error
-        end
-        access_denied_error = 1045
-        begin
-          ActiveRecord::Base.establish_connection(config.merge('database' => nil))
-          ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
-          ActiveRecord::Base.establish_connection(config)
-        rescue error_class => sqlerr
-          if sqlerr.errno == access_denied_error
-            print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
-            root_password = $stdin.gets.strip
-            grant_statement = "GRANT ALL PRIVILEGES ON #{config['database']}.* " \
-              "TO '#{config['username']}'@'localhost' " \
-              "IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;"
-            ActiveRecord::Base.establish_connection(config.merge(
-                'database' => nil, 'username' => 'root', 'password' => root_password))
-            ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
-            ActiveRecord::Base.connection.execute grant_statement
-            ActiveRecord::Base.establish_connection(config)
-          else
-            $stderr.puts sqlerr.error
-            $stderr.puts "Couldn't create database for #{config.inspect}, charset: #{config['charset'] || @charset}, collation: #{config['collation'] || @collation}"
-            $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
-          end
-        end
+        ActiveRecord::Base.establish_connection(config)
+        ActiveRecord::Base.connection.drop_database config['database']
+      when /^(jdbc)?sqlite/
+        require 'pathname'
+        path = Pathname.new(config['database'])
+        file = path.absolute? ? path.to_s : File.join(Rails.root, path)
+
+        FileUtils.rm_f(file) if File.exist?(file)
       when /^(jdbc)?postgresql$/
-        @encoding = config['encoding'] || ENV['CHARSET'] || 'utf8'
-        begin
-          ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
-          ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => @encoding))
-          ActiveRecord::Base.establish_connection(config)
-        rescue Exception => e
-          $stderr.puts e, *(e.backtrace)
-          $stderr.puts "Couldn't create database for #{config.inspect}"
-        end
+        ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+        ActiveRecord::Base.connection.drop_database config['database']
       end
-    else
-      $stderr.puts "#{config['database']} already exists"
     end
-  end
 
-  def self.drop_database(config)
-    case config['adapter']
-    when /^(jdbc)?mysql/
-      ActiveRecord::Base.establish_connection(config)
-      ActiveRecord::Base.connection.drop_database config['database']
-    when /^(jdbc)?sqlite/
-      require 'pathname'
-      path = Pathname.new(config['database'])
-      file = path.absolute? ? path.to_s : File.join(Rails.root, path)
+    def self.mysql_creation_options(config)
+      @charset   = ENV['CHARSET']   || 'utf8'
+      @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
 
-      FileUtils.rm(file)
-    when /^(jdbc)?postgresql$/
-      ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
-      ActiveRecord::Base.connection.drop_database config['database']
+      {
+        :charset   => (config['charset']   || @charset),
+        :collation => (config['collation'] || @collation)
+      }
     end
   end
-
-  def self.mysql_creation_options(config)
-    @charset   = ENV['CHARSET']   || 'utf8'
-    @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
-
-    {
-      :charset   => (config['charset']   || @charset),
-      :collation => (config['collation'] || @collation)
-    }
-  end
 end

data/lib/combustion/generator.rb

@@ -1,28 +1,30 @@
 require 'thor/group'
 
-class Combustion::Generator < Thor::Group
-  include Thor::Actions
+module Combustion
+  class Generator < Thor::Group
+    include Thor::Actions
 
-  def self.source_root
-    File.expand_path File.join(File.dirname(__FILE__), '..', '..')
-  end
+    def self.source_root
+      File.expand_path File.join(File.dirname(__FILE__), '..', '..')
+    end
 
-  def create_directories
-    empty_directory 'spec/internal'
-    empty_directory 'spec/internal/config'
-    empty_directory 'spec/internal/db'
-    empty_directory 'spec/internal/log'
-    empty_directory 'spec/internal/public'
-  end
+    def create_directories
+      empty_directory 'spec/internal'
+      empty_directory 'spec/internal/config'
+      empty_directory 'spec/internal/db'
+      empty_directory 'spec/internal/log'
+      empty_directory 'spec/internal/public'
+    end
 
-  def create_files
-    template 'templates/routes.rb',    'spec/internal/config/routes.rb'
-    template 'templates/database.yml', 'spec/internal/config/database.yml'
-    template 'templates/schema.rb',    'spec/internal/db/schema.rb'
-    template 'templates/config.ru',    'config.ru'
-    create_file                        'spec/internal/public/favicon.ico'
-    create_file                        'spec/internal/log/.gitignore' do
-      '*.log'
+    def create_files
+      template 'templates/routes.rb',    'spec/internal/config/routes.rb'
+      template 'templates/database.yml', 'spec/internal/config/database.yml'
+      template 'templates/schema.rb',    'spec/internal/db/schema.rb'
+      template 'templates/config.ru',    'config.ru'
+      create_file                        'spec/internal/public/favicon.ico'
+      create_file                        'spec/internal/log/.gitignore' do
+        '*.log'
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: combustion
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: