rails_generators_test_case_modules 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_generators_test_case_modules.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pablo Herrero
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+rails_generators_test_case_modules
+==================================
+# RailsGeneratorsTestCaseModules
+
+Backports for Rails::Generator::TestCase helper modules for railties 3.2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_generators_test_case_modules'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_generators_test_case_modules
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails/generators/testing/assertions.rb

@@ -0,0 +1,121 @@
+module Rails
+  module Generators
+    module Testing
+      module Assertions
+        # Asserts a given file exists. You need to supply an absolute path or a path relative
+        # to the configured destination:
+        #
+        #   assert_file "config/environment.rb"
+        #
+        # You can also give extra arguments. If the argument is a regexp, it will check if the
+        # regular expression matches the given file content. If it's a string, it compares the
+        # file with the given string:
+        #
+        #   assert_file "config/environment.rb", /initialize/
+        #
+        # Finally, when a block is given, it yields the file content:
+        #
+        #   assert_file "app/controllers/products_controller.rb" do |controller|
+        #     assert_instance_method :index, controller do |index|
+        #       assert_match(/Product\.all/, index)
+        #     end
+        #   end
+        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|
+            case content
+              when String
+                assert_equal content, read
+              when Regexp
+                assert_match content, read
+            end
+          end
+        end
+        alias :assert_directory :assert_file
+
+        # Asserts a given file does not exist. You need to supply an absolute path or a
+        # path relative to the configured destination:
+        #
+        #   assert_no_file "config/random.rb"
+        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
+
+        # Asserts a given migration exists. You need to supply an absolute path or a
+        # path relative to the configured destination:
+        #
+        #   assert_migration "db/migrate/create_products.rb"
+        #
+        # This method manipulates the given path and tries to find any migration which
+        # matches the migration name. For example, the call above is converted to:
+        #
+        #   assert_file "db/migrate/003_create_products.rb"
+        #
+        # Consequently, assert_migration accepts the same arguments has assert_file.
+        def assert_migration(relative, *contents, &block)
+          file_name = migration_file_name(relative)
+          assert file_name, "Expected migration #{relative} to exist, but was not found"
+          assert_file file_name, *contents, &block
+        end
+
+        # Asserts a given migration does not exist. You need to supply an absolute path or a
+        # path relative to the configured destination:
+        #
+        #   assert_no_migration "db/migrate/create_products.rb"
+        def assert_no_migration(relative)
+          file_name = migration_file_name(relative)
+          assert_nil file_name, "Expected migration #{relative} to not exist, but found #{file_name}"
+        end
+
+        # Asserts the given class method exists in the given content. This method does not detect
+        # class methods inside (class << self), only class methods which starts with "self.".
+        # When a block is given, it yields the content of the method.
+        #
+        #   assert_migration "db/migrate/create_products.rb" do |migration|
+        #     assert_class_method :up, migration do |up|
+        #       assert_match(/create_table/, up)
+        #     end
+        #   end
+        def assert_class_method(method, content, &block)
+          assert_instance_method "self.#{method}", content, &block
+        end
+
+        # Asserts the given method exists in the given content. When a block is given,
+        # it yields the content of the method.
+        #
+        #   assert_file "app/controllers/products_controller.rb" do |controller|
+        #     assert_instance_method :index, controller do |index|
+        #       assert_match(/Product\.all/, index)
+        #     end
+        #   end
+        def assert_instance_method(method, content)
+          assert content =~ /(\s+)def #{method}(\(.+\))?(.*?)\n\1end/m, "Expected to have method #{method}"
+          yield $3.strip if block_given?
+        end
+        alias :assert_method :assert_instance_method
+
+        # Asserts the given attribute type gets translated to a field type
+        # properly:
+        #
+        #   assert_field_type :date, :date_select
+        def assert_field_type(attribute_type, field_type)
+          assert_equal(field_type, create_generated_attribute(attribute_type).field_type)
+        end
+
+        # Asserts the given attribute type gets a proper default value:
+        #
+        #   assert_field_default_value :string, "MyString"
+        def assert_field_default_value(attribute_type, value)
+          assert_equal(value, create_generated_attribute(attribute_type).default)
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/testing/behaviour.rb

@@ -0,0 +1,103 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/kernel/reporting'
+require 'active_support/concern'
+require 'rails/generators'
+
+module Rails
+  module Generators
+    module Testing
+      module Behaviour
+        extend ActiveSupport::Concern
+
+        included do
+          class_attribute :destination_root, :current_path, :generator_class, :default_arguments
+
+          # Generators frequently change the current path using +FileUtils.cd+.
+          # So we need to store the path at file load and revert back to it after each test.
+          self.current_path = File.expand_path(Dir.pwd)
+          self.default_arguments = []
+        end
+
+        module ClassMethods
+          # Sets which generator should be tested:
+          #
+          #   tests AppGenerator
+          def tests(klass)
+            self.generator_class = klass
+          end
+
+          # Sets default arguments on generator invocation. This can be overwritten when
+          # invoking it.
+          #
+          #   arguments %w(app_name --skip-active-record)
+          def arguments(array)
+            self.default_arguments = array
+          end
+
+          # Sets the destination of generator files:
+          #
+          #   destination File.expand_path("../tmp", File.dirname(__FILE__))
+          def destination(path)
+            self.destination_root = path
+          end
+        end
+
+        # Runs the generator configured for this class. The first argument is an array like
+        # command line arguments:
+        #
+        #   class AppGeneratorTest < Rails::Generators::TestCase
+        #     tests AppGenerator
+        #     destination File.expand_path("../tmp", File.dirname(__FILE__))
+        #     teardown :cleanup_destination_root
+        #
+        #     test "database.yml is not created when skipping Active Record" do
+        #       run_generator %w(myapp --skip-active-record)
+        #       assert_no_file "config/database.yml"
+        #     end
+        #   end
+        #
+        # You can provide a configuration hash as second argument. This method returns the output
+        # printed by the generator.
+        def run_generator(args=self.default_arguments, config={})
+          capture(:stdout) { self.generator_class.start(args, config.reverse_merge(destination_root: destination_root)) }
+        end
+
+        # Instantiate the generator.
+        def generator(args=self.default_arguments, options={}, config={})
+          @generator ||= self.generator_class.new(args, options, config.reverse_merge(destination_root: destination_root))
+        end
+
+        # Create a Rails::Generators::GeneratedAttribute by supplying the
+        # attribute type and, optionally, the attribute name:
+        #
+        #   create_generated_attribute(:string, 'name')
+        def create_generated_attribute(attribute_type, name = 'test', index = nil)
+          Rails::Generators::GeneratedAttribute.parse([name, attribute_type, index].compact.join(':'))
+        end
+
+        protected
+
+          def destination_root_is_set? # :nodoc:
+            raise "You need to configure your Rails::Generators::TestCase destination root." unless destination_root
+          end
+
+          def ensure_current_path # :nodoc:
+            cd current_path
+          end
+
+          def prepare_destination # :nodoc:
+            rm_rf(destination_root)
+            mkdir_p(destination_root)
+          end
+
+          def migration_file_name(relative) # :nodoc:
+            absolute = File.expand_path(relative, destination_root)
+            dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '')
+            Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
+          end
+      end
+    end
+  end
+end

data/lib/rails/generators/testing/setup_and_teardown.rb

@@ -0,0 +1,18 @@
+module Rails
+  module Generators
+    module Testing
+      module SetupAndTeardown
+        def setup # :nodoc:
+          destination_root_is_set?
+          ensure_current_path
+          super
+        end
+
+        def teardown # :nodoc:
+          ensure_current_path
+          super
+        end
+      end
+    end
+  end
+end

data/lib/rails_generators_test_case_modules/version.rb

@@ -0,0 +1,3 @@
+module RailsGeneratorsTestCaseModules
+  VERSION = "0.1.0"
+end

data/lib/rails_generators_test_case_modules.rb

@@ -0,0 +1,5 @@
+require "rails_generators_test_case_modules/version"
+
+require "rails/generators/testing/behaviour"
+require "rails/generators/testing/setup_and_teardown"
+require "rails/generators/testing/assertions"

data/rails_generators_test_case_modules.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_generators_test_case_modules/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_generators_test_case_modules"
+  spec.version       = RailsGeneratorsTestCaseModules::VERSION
+  spec.authors       = ["Pablo Herrero"]
+  spec.email         = ["pablodherrero@gmail.com"]
+  spec.description   = %q{Backports for Rails::Generator::TestCase helper modules for Rails 3.2}
+  spec.summary       = %q{Backports for Rails::Generator::TestCase helper modules for Rails 3.2}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties', ['>= 3.2', '< 4.0']
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rails_generators_test_case_modules
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Pablo Herrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    none: false
+  prerelease: false
+  name: railties
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Backports for Rails::Generator::TestCase helper modules for Rails 3.2
+email:
+- pablodherrero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/generators/testing/assertions.rb
+- lib/rails/generators/testing/behaviour.rb
+- lib/rails/generators/testing/setup_and_teardown.rb
+- lib/rails_generators_test_case_modules.rb
+- lib/rails_generators_test_case_modules/version.rb
+- rails_generators_test_case_modules.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 538841381395110015
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 538841381395110015
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Backports for Rails::Generator::TestCase helper modules for Rails 3.2
+test_files: []