generator_spec 0.0.3 → 0.8.0

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec
+
+gem "fakefs"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    generator_spec (0.0.1)
+    generator_spec (0.0.3)
       rails (~> 3.0)
       rspec-rails
 
@@ -40,6 +40,7 @@ GEM
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
+    fakefs (0.3.1)
     i18n (0.5.0)
     mail (2.2.15)
       activesupport (>= 2.3.6)
@@ -89,4 +90,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  fakefs
   generator_spec!

data/README.md

@@ -1,17 +1,23 @@
 # Generator Spec
 
-Allows testing of Rails generators inside RSpec using standard Rails::Generators::TestCase assertion methods.
+Test Rails generators with RSpec using the standard Rails::Generators::TestCase assertion methods.
 
 # Usage
 
-Add 'generator_spec' to Gemfile and use just like you would test generators in test unit:
+Gemfile:
+
+    group :test do
+      gem "generator_spec"
+    end
+
+Spec:
 
     # spec/lib/generators/test/test_generator_spec.rb
     
-    require "generator_spec/generator_example_group"
+    require "generator_spec/test_case"
     
     describe TestGenerator do
-      include GeneratorSpec::GeneratorExampleGroup
+      include GeneratorSpec::TestCase
 
       destination File.expand_path("../../tmp", __FILE__)
 
@@ -28,7 +34,7 @@ Add 'generator_spec' to Gemfile and use just like you would test generators in t
 An RSpec file matching DSL is also provided, taken with permission from [beard](https://github.com/carlhuda/beard/blob/master/spec/support/matcher.rb) by [carlhuda](https://github.com/carlhuda).
 
     describe TestGenerator, "using custom matcher" do
-      include GeneratorSpec::GeneratorExampleGroup
+      include GeneratorSpec::TestCase
 
       destination File.expand_path("../../tmp", __FILE__)
       

data/lib/generator_spec/matcher.rb

@@ -1,7 +1,6 @@
 module GeneratorSpec
   module Matcher
-    # Author: Yahuda Katz
-    # Taken (with permission) from beard:
+    # Taken (with permission) from beard by Yahuda Katz
     # https://github.com/carlhuda/beard
   
     class File

data/lib/generator_spec/test_case.rb

@@ -0,0 +1,48 @@
+require "rspec/rails"
+require "rails/generators/test_case"
+require "fileutils"
+require "generator_spec/matcher"
+
+module GeneratorSpec
+  module TestCase
+    extend ActiveSupport::Concern
+    include RSpec::Rails::RailsExampleGroup
+    include Matcher
+    include FileUtils
+  
+    included do
+      cattr_accessor :test_case, :test_case_instance
+      self.test_case = Class.new(Rails::Generators::TestCase)
+      self.test_case.tests subject.call.class
+      self.test_case_instance = self.test_case.new(:test)
+    end
+  
+    module ClassMethods
+      def tests(klass)
+        self.test_case.generator_class = klass
+      end
+
+      def arguments(array)
+        self.test_case.default_arguments = array
+      end
+
+      def destination(path)
+        self.test_case.destination_root = path
+      end
+    end
+  
+    module InstanceMethods
+      def method_missing(method_sym, *arguments, &block)
+        self.test_case_instance.send(method_sym, *arguments, &block)
+      end
+      
+      def respond_to?(method_sym, include_private = false)
+        if self.test_case_instance.respond_to?(method_sym)
+          true
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/generator_spec/version.rb

@@ -1,3 +1,3 @@
 module GeneratorSpec
-  VERSION = "0.0.3"
+  VERSION = "0.8.0"
 end

data/spec/generator_spec/matcher_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe TestGenerator, "using custom matcher" do
-  include GeneratorSpec::GeneratorExampleGroup
+  include GeneratorSpec::TestCase
 
   destination File.expand_path("../../tmp", __FILE__)
 
@@ -30,4 +30,241 @@ describe TestGenerator, "using custom matcher" do
       end
     }
   end
+end
+
+TMP_ROOT = Pathname.new(File.expand_path("../../tmp"))
+
+module GeneratorSpec::Matcher
+  describe File do
+    describe "#matches?" do
+      include FakeFS::SpecHelpers
+      
+      before do
+        @file = File.new("test_file")
+        @location = TMP_ROOT.join("test_file")
+      end
+      
+      context "with no contains" do
+        it "doesn't throw if the file exists" do
+          write_file(@location, "")
+          expect {
+            @file.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+      
+        it "throws :failure if it doesn't exist" do
+          expect {
+            @file.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+      
+      context "with contains" do
+        before do
+          write_file(@location, "class CreatePosts")
+        end
+
+        it "doesn't throw if the content includes the string" do
+          @file.contains "CreatePosts"
+          expect {
+            @file.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+
+        it "throws :failure if the contents don't include the string" do
+          @file.contains "PostsMigration"
+          expect {
+            @file.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+    end
+  end
+  
+  describe Migration do
+    include FakeFS::SpecHelpers
+    
+    describe "#matches?" do
+      before do
+        @migration = Migration.new("create_posts")
+        @location = TMP_ROOT.join("123456_create_posts.rb")
+      end
+
+      context "with no contains" do
+        it "doesn't throw if the migration exists" do
+          write_file(@location, "class CreatePosts")
+          expect {
+            @migration.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+        
+        it "throws :failure if it doesn't exist" do
+          expect {
+            @migration.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+      
+      context "with contains" do
+        before do
+          write_file(@location, "class CreatePosts")
+        end
+        
+        it "doesn't throw if the migration includes the given content" do
+          @migration.contains("CreatePosts")
+          expect {
+            @migration.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+        
+        it "throws failure if the migration doesn't include the given content" do
+          @migration.contains("CreateNotes")
+          expect {
+            @migration.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+    end
+  end
+  
+  describe Directory do
+    include FakeFS::SpecHelpers
+    
+    describe "#location" do
+      it "equals the full path" do
+        Directory.new("test").location("test_2").should eq("test/test_2")
+      end
+    end
+    
+    describe "#directory" do
+      context "without a block" do
+        it "adds a directory name to the tree" do
+          dir = Directory.new "test" do
+            directory "dir"
+          end
+          dir.tree["dir"].should eq(false)
+        end
+      end
+      
+      context "with a block" do
+        it "add a directory object to the tree" do
+          dir = Directory.new "test" do
+            directory "dir" do
+              directory "test_2"
+            end
+          end
+          dir.tree["dir"].should be_an_instance_of(Directory)
+          dir.tree["dir"].tree["test_2"].should eq(false)
+        end
+      end
+    end
+    
+    describe "#file" do
+      it "adds it to the tree" do
+        dir = Directory.new "test" do
+          file "test_file"
+        end
+        dir.tree["test_file"].should be_an_instance_of(File)
+      end
+    end
+    
+    describe "#file" do
+      it "adds it to the tree" do
+        dir = Directory.new "test" do
+          migration "test_file"
+        end
+        dir.tree["test_file"].should be_an_instance_of(Migration)
+        dir.tree["test_file"].instance_variable_get("@name").should eq("test/test_file")
+      end
+    end
+    
+    describe "#matches?" do
+      context "with a directory name" do
+        before do
+          @dir = Directory.new "test" do
+            directory "test_2"
+          end
+        end
+        
+        it "doesn't throw if the directory exists" do
+          write_directory(TMP_ROOT.join("test/test_2"))
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+        
+        it "throws :failure if it doesn't exist" do
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+      
+      context "with a directory object" do
+        before do
+          @dir = Directory.new "test" do
+            directory "test_2" do
+              file "test_file"
+            end
+          end
+          write_directory(TMP_ROOT.join("test/test_2"))
+        end
+        
+        it "doesn't throw if the file exists" do
+          write_file(TMP_ROOT.join("test/test_2/test_file"), "")
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+        
+        it "throws :failure if it doesn't exist" do
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+      
+      context "#no_file" do
+        before do
+          @dir = Directory.new "test" do
+            no_file "test_file"
+          end
+          write_directory(TMP_ROOT.join("test"))
+        end
+        
+        it "doesn't throw if the file exist" do
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to_not throw_symbol
+        end
+        
+        it "throws if the file exists" do
+          write_file(TMP_ROOT.join("test/test_file"), "")
+          expect {
+            @dir.matches?(TMP_ROOT)
+          }.to throw_symbol(:failure)
+        end
+      end
+    end
+    
+  end
+  
+  describe Root do
+    describe "#matches?" do
+      before do
+        @root = Root.new "test" do
+          directory "test_dir"
+        end
+      end
+      
+      it "returns false on no failures" do
+        write_directory(TMP_ROOT.join("test/test_dir"))
+        @root.matches?(TMP_ROOT).should be_true
+      end
+      
+      it "returns true on failures" do
+        @root.matches?(TMP_ROOT).should be_false
+      end
+    end
+  end
 end

data/spec/generator_spec/test_case_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+class TestClass
+  
+end
+
+describe GeneratorSpec::TestCase do
+  before do
+    @klass = Class.new do
+      self.should_receive(:subject).and_return(Proc.new {TestClass.new})
+      include GeneratorSpec::TestCase
+    end
+    @klass.test_case_instance = mock
+  end
+  
+  it "passes unknown messages on to test_case_instance" do
+    @klass.test_case_instance.should_receive(:assert_file).with("test")
+    @klass.new.assert_file("test")
+  end
+  
+  it "handles respond_to accordingly" do
+    @klass.test_case_instance.should_receive(:respond_to?).with(:assert_no_file).and_return(true)
+    @klass.new.respond_to?(:assert_no_file).should be_true
+  end
+end
+
+describe TestGenerator, "using normal assert methods" do
+  include GeneratorSpec::TestCase
+
+  destination File.expand_path("../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "creates a test initializer" do
+    assert_file "config/initializers/test.rb", "# Initializer"
+  end
+
+  it "creates a migration" do
+    assert_migration "db/migrate/create_tests.rb"
+  end
+
+  it "removes files" do
+    assert_no_file ".gitignore"
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'bundler/setup'
 require 'rails/all'
 require 'rspec/rails'
-require 'generator_spec/generator_example_group'
+require 'generator_spec/test_case'
+require 'fakefs/spec_helpers'
 
-Dir[Pathname.new(File.expand_path("../", __FILE__)).join("support/*/*.rb")].each {|f| require f}
+Dir[Pathname.new(File.expand_path("../", __FILE__)).join("support/**/*.rb")].each {|f| require f}
 
 RSpec.configure do |config|
-  
+  config.include Helpers::FileSystem
 end

data/spec/support/file_system.rb

@@ -0,0 +1,11 @@
+module Helpers
+  module FileSystem
+    def write_file(file_name, contents)
+      ::File.open(file_name.to_s, 'w') {|f| f.write(contents) }
+    end
+    
+    def write_directory(name)
+      FileUtils.mkdir_p(name)
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: generator_spec
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.8.0
 platform: ruby
 authors: 
 - Steve Hodgkiss
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +00:00
+date: 2011-03-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,12 +53,13 @@ files:
 - Rakefile
 - generator_spec.gemspec
 - lib/generator_spec.rb
-- lib/generator_spec/generator_example_group.rb
 - lib/generator_spec/matcher.rb
+- lib/generator_spec/test_case.rb
 - lib/generator_spec/version.rb
-- spec/generator_spec/generator_example_group_spec.rb
 - spec/generator_spec/matcher_spec.rb
+- spec/generator_spec/test_case_spec.rb
 - spec/spec_helper.rb
+- spec/support/file_system.rb
 - spec/support/test_generator/templates/initializer.rb
 - spec/support/test_generator/templates/migration.rb
 - spec/support/test_generator/test_generator.rb
@@ -91,9 +92,10 @@ signing_key:
 specification_version: 3
 summary: Test Rails generators with RSpec
 test_files: 
-- spec/generator_spec/generator_example_group_spec.rb
 - spec/generator_spec/matcher_spec.rb
+- spec/generator_spec/test_case_spec.rb
 - spec/spec_helper.rb
+- spec/support/file_system.rb
 - spec/support/test_generator/templates/initializer.rb
 - spec/support/test_generator/templates/migration.rb
 - spec/support/test_generator/test_generator.rb

data/lib/generator_spec/generator_example_group.rb

@@ -1,254 +0,0 @@
-require "rspec/rails"
-require "rails/generators/test_case"
-require "fileutils"
-require "generator_spec/matcher"
-
-# Adapted from Rails::Generators::TestCase
-# https://github.com/rails/rails/blob/master/railties/lib/rails/generators/test_case.rb
-
-module GeneratorSpec
-  module GeneratorExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include Matcher
-    include FileUtils
-  
-    included do
-      class_attribute :destination_root, :current_path, :generator_class, :default_arguments
-      delegate :destination_root, :current_path, :generator_class, :default_arguments, :to => :'self.class'
-    
-      self.current_path = ::File.expand_path(Dir.pwd)
-      self.default_arguments = []
-    
-      setup :destination_root_is_set?, :ensure_current_path
-      teardown :ensure_current_path
-    
-      tests subject.call.class
-    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
-  
-    module InstanceMethods
-      # Captures the given stream and returns it:
-      #
-      #   stream = capture(:stdout){ puts "Cool" }
-      #   stream # => "Cool\n"
-      #
-      def capture(stream)
-        begin
-          stream = stream.to_s
-          eval "$#{stream} = StringIO.new"
-          yield
-          result = eval("$#{stream}").string
-        ensure
-          eval("$#{stream} = #{stream.upcase}")
-        end
-
-        result
-      end
-      alias :silence :capture
-
-      # 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/controller/products_controller.rb" do |controller|
-      #     assert_instance_method :index, content 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 file does not exist. 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_file "config/random.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/controller/products_controller.rb" do |controller|
-      #     assert_instance_method :index, content do |index|
-      #       assert_match /Product\.all/, index
-      #     end
-      #   end
-      #
-      def assert_instance_method(method, content)
-        assert content =~ /def #{method}(\(.+\))?(.*?)\n  end/m, "Expected to have method #{method}"
-        yield $2.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_type :string, "MyString"
-      #
-      def assert_field_default_value(attribute_type, value)
-        assert_equal(value, create_generated_attribute(attribute_type).default)
-      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')
-        Rails::Generators::GeneratedAttribute.new(name, attribute_type.to_s)
-      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
-          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

data/spec/generator_spec/generator_example_group_spec.rb

@@ -1,24 +0,0 @@
-require "spec_helper"
-
-describe TestGenerator, "using normal assert methods" do
-  include GeneratorSpec::GeneratorExampleGroup
-
-  destination File.expand_path("../../tmp", __FILE__)
-
-  before(:all) do
-    prepare_destination
-    run_generator
-  end
-
-  it "creates a test initializer" do
-    assert_file "config/initializers/test.rb", "# Initializer"
-  end
-
-  it "creates a migration" do
-    assert_migration "db/migrate/create_tests.rb"
-  end
-
-  it "removes files" do
-    assert_no_file ".gitignore"
-  end
-end