genspec 0.1.1 → 0.2.0.prerails3.1

data/README.rdoc

@@ -1,14 +1,19 @@
 = genspec
 
-Simple, expressive Rails generator testing for RSpec.
+Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.
 
 == Installation
 
-  sudo gem install genspec
+  sudo gem install genspec --pre
 
-...then, in your config/environments/test.rb...
+...then, in your Gemfile...
 
-  config.gem 'genspec'
+  group :test do
+    config.gem 'genspec'
+  end
+  
+Warning: The prerelease version is for Rails 3.0 and is NOT compatible with 2.x! See the master branch
+for the Rails 2.3 version.
   
 == Usage
 
@@ -35,6 +40,49 @@ A basic generator spec might look something like this:
     end
   end
   
+=== Specifying Arguments
+
+You may have noticed in the example above that we used _with_args_ to set up arguments passed into the generator. We
+can also pass any options we wish into that array. For instance, to pretend the _--verbose_ option was passed, we
+could use the following spec:
+
+  describe :custom_controller do
+    context "with --verbose option" do
+      with_args "--verbose"
+      
+      # . . .
+    end
+  end
+  
+Here is another example using _with_args_:
+
+  describe :custom_controller do
+    context "with a users controller and index, new, edit actions" do
+      with_args :users, :index, :new, :edit
+      
+      # . . .
+    end
+  end
+
+Note that no matter what you specify as arguments, they'll be converted to an array of Strings -- because this is what
+gets passed into the generator if you run it from the command line. You can bypass that by passing an :object => true
+option as the last argument:
+
+  describe :custom_controller do
+    with_args MyFancyObject.new, :object => true
+    # . . .
+  end
+
+Finally, you can also let with_args generate a context for you:
+
+  describe :custom_controller do
+    with_args :users, :index, :new, :edit do
+      # . . .
+    end
+  end
+  
+This will generate an RSpec context that reads something like, "...with arguments [:users, :index, :new, :edit]".
+
 === Checking for Output
 
 If you need to test the generator's feedback rather than the generator's results, you can use the _output_ matcher to
@@ -62,8 +110,8 @@ as passing the name of the file you expected to be generated:
     subject.should generate("README")
   end
   
-You can also check the generated file's content by simply passing a block. The argument in the block is the plaintext
-content of the file:
+You can also check the generated file's content by simply passing a block. The _content_ argument in the block is
+a simple String containing the content of the file:
 
   it "should generate a model called 'user'" do
     subject.should generate("app/models/user.rb") { |content|
@@ -73,40 +121,40 @@ content of the file:
 
 === Checking Generation Methods
 
-This is the most intrusive form of generation matching, and should be avoided where possible. However, in some cases
-you just can't check behavior directly (migrations are a case in point, because the version number is unpredictable).
-In that case, you can verify that a particular method is called within the generator's manifest like so:
+This is the most intrusive form of generation matching. While powerful, it will also make your tests brittle, because
+there's a high likelihood that even minor changes to your generators will require you to update the spec to match.
+
+However, sometimes you need to verify that some action occurs which can't be validated using the methods above, such
+as adding a gem source to the Gemfile. You can use the generation method matcher for this.
 
-  it "should generate a user migration template" do
-    subject.should generate(:migration_template, "migration_template.erb", "db/migrate", :migration_file => "create_users")
+  it "should add a gem source" do
+    subject.should generate(:add_source, "http://gems.github.com")
   end
   
-You can stop passing arguments at any time. This has the effect of widening the range of acceptable parameters. For
-instance, the following example does the same thing but will accept _any_ migration file name in _any_ destination
-directory, as long as the "migration_template.erb" file is used for the source:
+  # -or-
+  it "should add a gem source" do
+    subject.should call_action(:add_source, "http://gems.github.com")
+  end
 
-  it "should generate a migration template" do
-    subject.should generate(:migration_template, "migration_template.rb")
+  # -or-
+  it "should add a gem source" do
+    subject.should add_source("http://gems.github.com")
   end
+  
+Note that all three of the above examples accomplish exactly the same task. Use whichever is most expressive for you.
 
-Any method that is normally available to Rails generators can be tested in this way:
+You can stop passing arguments at any time. This has the effect of widening the range of acceptable parameters. For
+instance, the following example does the same thing but will accept _any_ source URL, as long as the _add_source_
+action is called:
 
-  it "should test one of each generation type" do
-    subject.should generate(:directory, "db/migrate")
-    subject.should generate(:file, "input_file", "output_file")
-    subject.should generate(:template, "input_template", "output_template")
-    subject.should generate(:class_collisions, 'ActionController::Base')
-    subject.should generate(:migration_template, "file", "directory", :migration_file_name => "filename")
-    subject.should generate(:resource_routes, 'model_name')
-    subject.should generate(:readme, "README")
+  it "should add a gem source" do
+    subject.should generate(:add_source)
   end
-  
-But again... Use these as last resorts, for the most part. Technically, you will probably need this for
-:migration_template and :resource_routes, but anything else should really be tested for _behavior_. Like any other
-class, you should really only care about how the generator interacts with other objects -- in this case, your file
-system -- and not so much about what it's doing on the inside.
 
-  
+Any method added to Thor, the backend code that drives Rails generators, should be picked up automatically by
+GenSpec.
+
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,18 +1,49 @@
 require 'rubygems'
 require 'rake'
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+rescue MissingSourceFile
+  module RSpec
+    module Core
+      class RakeTask
+        def initialize(name)
+          task name do
+            # if rspec-rails is a configured gem, this will output helpful material and exit ...
+            require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+
+            # ... otherwise, do this:
+            raise <<-MSG
+
+#{"*" * 80}
+*  You are trying to run an rspec rake task defined in
+*  #{__FILE__},
+*  but rspec can not be found in vendor/gems, vendor/plugins or system gems.
+#{"*" * 80}
+MSG
+          end
+        end
+      end
+    end
+  end
+end
+
+def rcov_opts
+  IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+end
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "genspec"
-    gem.summary = "Simple, expressive Rails generator testing for RSpec."
-    gem.description = "Just like rspec-rails uses the structure of your spec/ directory to infer which test is being run (controllers, helpers, lib, etc.), you just need to create a spec/generators directory and put your generator specs in there."
+    gem.summary = "Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x."
+    gem.description = "Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x."
     gem.email = "sinisterchipmunk@gmail.com"
     gem.homepage = "http://www.thoughtsincomputation.com"
     gem.authors = ["Colin MacKenzie IV"]
     gem.files = FileList['**/*']
-    gem.add_dependency "rspec"
-    gem.add_dependency "sc-core-ext", ">= 1.2.0"
+    gem.add_dependency "rspec", ">= 2.0.0.beta.14" # TODO add version info when rspec isn't beta any more (it interferes with dep resolution)
+    gem.add_dependency "sc-core-ext", ">= 1.2.1"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -20,29 +51,45 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rcov = false
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+desc "Spec coverage"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = 'vendor/cache/genspec/spec/**/*_spec.rb'
+#  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov = true
+  t.rcov_path = 'coverage'
+  t.rcov_opts = rcov_opts
 end
 
-task :test => :check_dependencies
+task :default => [:check_dependencies, :spec]
 
-task :default => :test
+#desc "rebuilds the package and then copies the .gem file back a directory"
+#task :bundle => :build do
+#  Dir["../cache/genspec-*.gem"].each { |f| rm File.expand_path(f) }
+#  Dir["pkg/*.gem"].each { |f| cp File.expand_path(f), File.expand_path('../cache') }
+#end
+#
+#namespace :bundle do
+#  desc "builds and installs the gem, then runs bundle package, then uninstalls the gem"
+#  task :lock => [:install, :rebundle, :uninstall]
+#  
+#  desc "runs 'bundle package' in the rails project"
+#  task :rebundle do
+#    chdir File.expand_path(File.join(File.dirname(__FILE__), "../..")) do
+#      system("bundle package")
+#    end
+#  end
+#  
+#  desc "uninstalls the gem"
+#  task :uninstall do
+#    system("gem uninstall genspec")
+#  end
+#end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0.prerails3.1

data/genspec.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{genspec}
-  s.version = "0.1.1"
+  s.version = "0.2.0.prerails3.1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Colin MacKenzie IV"]
-  s.date = %q{2010-06-21}
-  s.description = %q{Just like rspec-rails uses the structure of your spec/ directory to infer which test is being run (controllers, helpers, lib, etc.), you just need to create a spec/generators directory and put your generator specs in there.}
+  s.date = %q{2010-07-01}
+  s.description = %q{Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.}
   s.email = %q{sinisterchipmunk@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,62 +22,53 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "genspec.gemspec",
+     "lib/gen_spec.rb",
      "lib/genspec.rb",
-     "lib/genspec/generation_matchers.rb",
-     "lib/genspec/generation_matchers/generation_matcher.rb",
-     "lib/genspec/generation_matchers/result_matcher.rb",
      "lib/genspec/generator_example_group.rb",
-     "pkg/genspec-0.0.0.gem",
-     "pkg/genspec-0.1.0.gem",
-     "rdoc/classes/GenSpec.html",
-     "rdoc/classes/GenSpec/GenerationMatchers.html",
-     "rdoc/classes/GenSpec/GenerationMatchers/GenerationMatcher.html",
-     "rdoc/classes/GenSpec/GenerationMatchers/ResultMatcher.html",
-     "rdoc/classes/GenSpec/GeneratorExampleGroup.html",
-     "rdoc/created.rid",
-     "rdoc/files/README_rdoc.html",
-     "rdoc/files/lib/genspec/generation_matchers/generation_matcher_rb.html",
-     "rdoc/files/lib/genspec/generation_matchers/result_matcher_rb.html",
-     "rdoc/files/lib/genspec/generation_matchers_rb.html",
-     "rdoc/files/lib/genspec/generator_example_group_rb.html",
-     "rdoc/files/lib/genspec_rb.html",
-     "rdoc/fr_class_index.html",
-     "rdoc/fr_file_index.html",
-     "rdoc/fr_method_index.html",
-     "rdoc/index.html",
-     "rdoc/rdoc-style.css",
+     "lib/genspec/matchers.rb",
+     "lib/genspec/matchers/base.rb",
+     "lib/genspec/matchers/generation_method_matcher.rb",
+     "lib/genspec/matchers/output_matcher.rb",
+     "lib/genspec/matchers/result_matcher.rb",
+     "lib/genspec/shell.rb",
+     "pkg/genspec-0.1.1.gem",
+     "pkg/genspec-0.2.0.pre1.gem",
+     "pkg/genspec-0.2.0.prerails3.1.gem",
      "spec/environment_spec.rb",
-     "spec/generators/test_spec.rb",
+     "spec/generators/test_rails3_spec.rb",
+     "spec/rcov.opts",
+     "spec/rspec.opts",
      "spec/spec_helper.rb",
-     "spec/support/generators/test/templates/file",
-     "spec/support/generators/test/test_generator.rb"
+     "spec/support/generators/test_rails3/USAGE",
+     "spec/support/generators/test_rails3/templates/file",
+     "spec/support/generators/test_rails3/test_rails3_generator.rb"
   ]
   s.homepage = %q{http://www.thoughtsincomputation.com}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Simple, expressive Rails generator testing for RSpec.}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.}
   s.test_files = [
     "spec/environment_spec.rb",
-     "spec/generators/test_spec.rb",
+     "spec/generators/test_rails3_spec.rb",
      "spec/spec_helper.rb",
-     "spec/support/generators/test/test_generator.rb"
+     "spec/support/generators/test_rails3/test_rails3_generator.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rspec>, [">= 0"])
-      s.add_runtime_dependency(%q<sc-core-ext>, [">= 1.2.0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, [">= 2.0.0.beta.14"])
+      s.add_runtime_dependency(%q<sc-core-ext>, [">= 1.2.1"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<sc-core-ext>, [">= 1.2.0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.14"])
+      s.add_dependency(%q<sc-core-ext>, [">= 1.2.1"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<sc-core-ext>, [">= 1.2.0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.14"])
+    s.add_dependency(%q<sc-core-ext>, [">= 1.2.1"])
   end
 end
 

data/lib/gen_spec.rb

@@ -0,0 +1 @@
+require 'genspec'

data/lib/genspec.rb

@@ -1,14 +1,29 @@
-require 'spec'
+if defined?(RAILS_ROOT)
+  if Rails::VERSION::MAJOR == 2
+    raise "Use genspec 0.1.0 for Rails 2; this version is for Rails 3."
+  elsif Rails::VERSION::MAJOR == 3
+    require 'rails/generators'
+  else
+    raise "Unsupported Rails version: #{Rails::VERSION::STRING}"
+  end
+end
+
+begin
+  require 'rspec/core'
+rescue LoadError
+  raise "GenSpec requires RSpec v2.0."
+end
+
 require 'fileutils'
 
 require 'sc-core-ext'
-
-require 'genspec/generation_matchers'
+require 'genspec/shell'
+require 'genspec/matchers'
 require 'genspec/generator_example_group'
 
-if defined?(RAILS_ROOT)
-  require 'rails_generator'
-  require 'rails_generator/scripts/generate'
-end
+Thor::Base.shell = GenSpec::Shell.new
 
-Spec::Example::ExampleGroupFactory.register(:generator, GenSpec::GeneratorExampleGroup)
+# RSpec 2.0 compat
+RSpec.configure do |config|
+  config.include GenSpec::GeneratorExampleGroup, :example_group => { :file_path => /spec[\/]generators/ }
+end

data/lib/genspec/generator_example_group.rb

@@ -1,71 +1,66 @@
 module GenSpec
-  class GeneratorExampleGroup
-    extend Spec::Example::ExampleGroupMethods
-    include Spec::Example::ExampleMethods
-    include GenSpec::GenerationMatchers
-    delegate :generator_arguments, :generator_options, :generator_args, :to => "self.class"
-    
-    class << self
-      def generator_arguments
-        @generator_args.dup? || []
-      end
-      
-      def generator_options
-        @generator_options.dup? || {}
-      end
-      
-      def with_arguments(*args, &block)
+  module GeneratorExampleGroup
+    include RSpec::Matchers
+    include GenSpec::Matchers
+
+    def self.included(base)
+      base.send(:extend, GenSpec::GeneratorExampleGroup::ClassMethods)
+      base.send(:subject) { self.class.generator_descriptor }
+    end
+
+    module ClassMethods
+      # Sets the list of arguments for this generator.
+      #
+      # * All arguments will be converted to Strings, because that's how
+      #   they'd enter the generator from a command line. To avoid this,
+      #   pass :object => true at the end;
+      #
+      # Ex:
+      #  
+      def with_args(*args, &block)
+        options = args.extract_options!
+        args = args.flatten.collect { |c| c.to_s } unless options[:object]
         if block_given?
           context "with arguments #{args.inspect}" do
-            with_arguments(*args)
+            with_args(args, options)
             instance_eval(&block)
           end
         else
-          @generator_args = args.flatten.collect { |c| c.to_s }
+          metadata[:generator_args] = args
         end
       end
       
-      def with_options(hash, &block)
-        if block_given?
-          context "with options #{hash.inspect}" do
-            with_options(hash)
-            instance_eval(&block)
-          end
+      def generator_args
+        return metadata[:generator_args] if metadata[:generator_args]
+        
+        metadata[:generator_args] = if genspec_subclass?
+          superclass.generator_args
         else
-          @generator_options = hash
+          []
         end
       end
       
-      alias_method :generator_args, :generator_arguments
-      alias_method :with_args, :with_arguments
-    end
-    
-    def subject(&block)
-      block.nil? ?
-        explicit_subject || implicit_subject : @explicit_subject_block = block
-    end
-  
-    private
-    def explicit_subject
-      group = self
-      while group.respond_to?(:explicit_subject_block)
-        return group.explicit_subject_block if group.explicit_subject_block
-        group = group.superclass
-      end
-    end
-  
-    def implicit_subject
-      target = example_group_hierarchy[1].described_class || example_group_hierarchy[1].description_args.first
+      alias with_arguments      with_args
+      alias generator_arguments generator_args
       
-      if target.kind_of?(Symbol) || target.kind_of?(String)
-        target = self.class.lookup_missing_generator("#{target.to_s.underscore}_generator".camelize)
+      def generator_descriptor
+        {
+          :described => target_generator,
+          :args => generator_args
+        }
       end
-      target.new(generator_args, generator_options)
-    rescue Rails::Generator::GeneratorError, Rails::Generator::UsageError
-      # let them pass, so the user can test the output.
-      # TODO: Make this disable-able via configuration.
       
-      $! # return this because it is the content we'll check against.
+      def target_generator
+        if genspec_subclass?
+          superclass.target_generator
+        else
+          describes || description
+        end
+      end
+
+      def genspec_subclass?
+        superclass.include?(GenSpec::GeneratorExampleGroup)
+      end
     end
   end
 end