genspec 0.2.4 → 0.2.5

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    genspec (0.2.2)
+    genspec (0.2.4)
       i18n (>= 0.5.0)
-      rspec (~> 2.6.0)
+      rspec (~> 2)
       sc-core-ext (~> 1.2.1)
       thor (~> 0.14.6)
 
@@ -79,14 +79,14 @@ GEM
     rake (0.9.2.2)
     rdoc (3.11)
       json (~> 1.4)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec-mocks (2.8.0)
     sc-core-ext (1.2.1)
       activesupport (>= 2.3.5)
     sprockets (2.0.3)

data/README.rdoc

@@ -199,6 +199,23 @@ Finally, you can also choose to use +with_args+ without a block, in which case i
       # . . .
     end
   end
+  
+  
+=== Passing Options
+
+Sometimes you need to change the behavior of the generator itself, by passing options directly into the generator instance that you couldn't normally pass from the command line. A perfect example is when you want to test what would happen when the generator's behavior is set to :revoke, which is equivalent to the +rails destroy+ command. 
+
+Here's an example that verifies that a file is created by the generator, but that the same file is deleted when the generator's behavior is set to +:revoke+:
+
+  describe :controller do
+    with_args "welcome" do
+      it { should generate("app/controllers/welcome_controller.rb") }
+    
+      with_options :behavior => :revoke do
+        it { should delete("app/controllers/welcome_controller.rb") }
+      end
+    end
+  end
 
 === Fixtures
 

data/lib/genspec/generator_example_group.rb

@@ -5,7 +5,36 @@ module GenSpec
 
     def self.included(base)
       base.send(:extend, GenSpec::GeneratorExampleGroup::ClassMethods)
-      base.send(:subject) { self.class.generator_descriptor }
+      base.send(:subject) { generator_descriptor }
+    end
+    
+    def within_source_root(&block)
+      generator_init_blocks << block
+    end
+    
+    def generator_init_blocks
+      @generator_init_blocks ||= self.class.generator_init_blocks.dup
+    end
+    
+    # A hash containing the following:
+    #
+    #   :described   - the generator to be tested, or the string/symbol representing it
+    #   :args        - any arguments to be used when invoking the generator
+    #   :input       - a string to be used as an input stream, or nil
+    #   :init_blocks - an array of blocks to be invoked prior to running the generator
+    #   :generator_options - a hash of options to be passed into the generator
+    #
+    # This hash represents the +subject+ of the spec and this is the object that will
+    # ultimately be passed into the GenSpec matchers.
+    #
+    def generator_descriptor
+      {
+        :described => self.class.target_generator,
+        :args => self.class.generator_args,
+        :input => self.class.generator_input,
+        :init_blocks => generator_init_blocks,
+        :generator_options => self.class.generator_options
+      }
     end
 
     module ClassMethods
@@ -41,6 +70,27 @@ module GenSpec
         end
       end
       
+      # Allows you to pass options directly into the generator, such as
+      # :shell, :behavior, etc.
+      #
+      # Ex:
+      #
+      #   # simulate a destroy generator, per `rails destroy controller ...`
+      #   with_generator_options :behavior => :revoke do
+      #     # . . .
+      #   end
+      #
+      def with_generator_options(options, &block)
+        if block_given?
+          context "with generator options #{options.inspect}" do
+            with_generator_options options
+            instance_eval &block
+          end
+        else
+          generator_options.merge! options
+        end
+      end
+      
       # Sets the input stream for this generator.
       #
       # Ex:
@@ -113,6 +163,17 @@ module GenSpec
         end
       end
       
+      # Returns the hash of options to be passed into the generator in this context.
+      def generator_options
+        return metadata[:generator_options] if metadata[:generator_options]
+        
+        metadata[:generator_options] = if genspec_subclass?
+          superclass.generator_options.dup
+        else
+          { }
+        end
+      end
+      
       # Returns the input stream to be used for this context. If this context doesn't
       # have an input stream, its superclass is checked, and so on until either the
       # parent isn't a GenSpec or an input stream is found. Only the closest input
@@ -132,25 +193,6 @@ module GenSpec
       alias with_arguments      with_args
       alias generator_arguments generator_args
       
-      # A hash containing the following:
-      #
-      #   :described   - the generator to be tested, or the string/symbol representing it
-      #   :args        - any arguments to be used when invoking the generator
-      #   :input       - a string to be used as an input stream, or nil
-      #   :init_blocks - an array of blocks to be invoked prior to running the generator
-      #
-      # This hash represents the +subject+ of the spec and this is the object that will
-      # ultimately be passed into the GenSpec matchers.
-      #
-      def generator_descriptor
-        {
-          :described => target_generator,
-          :args => generator_args,
-          :input => generator_input,
-          :init_blocks => generator_init_blocks
-        }
-      end
-      
       # Traverses up the context tree to find the topmost description, which represents
       # the controller to be tested or the string/symbol representing it.
       def target_generator

data/lib/genspec/matchers.rb

@@ -22,6 +22,22 @@ module GenSpec
       end
     end
     
+    # Makes sure that the generator deletes the named file. This is done by first ensuring that the
+    # file exists in the first place, and then ensuring that it does not exist after the generator
+    # completes its run.
+    #
+    # Example:
+    #   subject.should delete("path/to/file")
+    #
+    def delete(filename)
+      within_source_root do
+        FileUtils.mkdir_p File.dirname(filename)
+        FileUtils.touch   filename
+      end
+      
+      generate { File.should_not exist(filename) }
+    end
+    
     # ex:
     #   subject.should call_action(:create_file, ...)
     #

data/lib/genspec/matchers/base.rb

@@ -21,6 +21,7 @@ module GenSpec
       def matches?(generator)
         @described = generator[:described]
         @args = generator[:args]
+        @generator_options = generator[:generator_options]
         @shell = GenSpec::Shell.new("", generator[:input] || "")
         @init_blocks = generator[:init_blocks]
         
@@ -103,11 +104,10 @@ module GenSpec
             end
           
             @destination_root = tempdir
-            @generator.start(@args || [], {
+            @generator.start(@args || [], @generator_options.reverse_merge(
               :shell => @shell,
               :destination_root => destination_root
-            })
-          
+            ))
             check_for_errors
             generated
           end

data/lib/genspec/version.rb

@@ -2,7 +2,7 @@ module GenSpec
   class Version
     MAJOR = 0
     MINOR = 2
-    PATCH = 4
+    PATCH = 5
     RELEASE = nil
     
     STRING = (RELEASE ? [MAJOR, MINOR, PATCH, RELEASE] : [MAJOR, MINOR, PATCH]).join('.')

data/spec/generators/test_rails3_spec.rb

@@ -80,12 +80,30 @@ describe :test_rails3 do
     end
   end
 
-  # FIXME: Uh, how best to write a spec around this? I'm actually trying to test #with_args with a block...
   with_args :test_arg do
     it "should generate file 'test_arg'" do
       subject.should generate('test_arg')
     end
     
+    it "should not generate template_name" do
+      # because that option hasn't been given in this context.
+      subject.should_not generate('template_name')
+    end
+    
+    with_generator_options :behavior => :revoke do
+      it "should delete file 'test_arg'" do
+        subject.should generate {
+          File.should_not exist("test_arg")
+        }
+      end
+      
+      # demonstrate use of the `delete` matcher, which is equivalent to
+      # above:
+      it "should destroy file 'test_arg'" do
+        subject.should delete("test_arg")
+      end
+    end
+    
     # ...and a test of nested args
     with_args "template_name" do
       it "should generate file 'test_arg'" do

metadata

@@ -2,7 +2,7 @@
 name: genspec
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Colin MacKenzie IV