genspec 0.2.0.prerails3.2 → 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+.idea
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+-c

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+

data/Gemfile

@@ -0,0 +1,5 @@
+source :gemcutter
+
+gemspec
+
+gem 'rails'

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    genspec (0.2.0)
+      i18n (~> 0.5.0)
+      rspec (~> 2.6.0)
+      sc-core-ext (~> 1.2.1)
+      thor (~> 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    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)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sc-core-ext (1.2.1)
+      activesupport (>= 2.3.5)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.0.15)
+  genspec!
+  rails

data/README.rdoc

@@ -1,20 +1,21 @@
-= genspec
+= GenSpec
 
-Simple, expressive Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.
+Simple, expressive generator testing for RSpec. This version of GenSpec supports testing either Thor generators (in standalone applications/gems) or Rails 3 generators for Rails apps.
 
-== Installation
+For the Rails 2.3 version, use genspec 0.1.x. Note that it is no longer actively maintained; only bug fixes will be committed to the Rails 2.3 version of this gem.
 
-  sudo gem install genspec --pre
+== Installation
 
-...then, in your Gemfile...
+In your Gemfile...
 
   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.
-  
+
+Or, the manual way:
+
+  sudo gem install genspec --pre
+
 == Usage
 
 Just like rspec-rails uses the structure of your spec/ directory to infer which test is being run (controllers,
@@ -31,128 +32,204 @@ A basic generator spec might look something like this:
       end
     end
     
-    context "with a name argument" do
-      with_args :users
-      
+    with_args :users do
       it "should generate a UsersController" do
-        subject.should generate("app/controllers/users_controller.rb")
+        subject.should generate("app/controllers/users_controller.rb") { |content|
+          content.should =~ /class UserController/
+        }
       end
     end
   end
   
-=== Specifying Arguments
+=== Checking Generated Files
 
-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:
+This is the preferred way to test files that were generated, because this matcher checks your generator's *behavior*. The test won't care _how_ a file is generated, as long as it _is_ generated. It's as simple as passing the name of the file you expected to be generated:
 
-  describe :custom_controller do
-    context "with --verbose option" do
-      with_args "--verbose"
-      
-      # . . .
-    end
+  it "should generate a readme file" do
+    subject.should generate("README")
+  end
+
+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|
+      content.should =~ /class User < ActiveRecord\:\:Base/
+    }
+  end
+
+You can also very simply ensure that the generator runs without error, without any further validation, by omitting all arguments:
+
+  it "should generate successfully" do
+    subject.should generate
+  end
+
+Finally, you could pass a block but no other arguments to +generate+ in order to check the generator's results the old-fashioned way:
+
+  it "should generate a model called 'user'" do
+    subject.should generate {
+      File.read("app/models/user.rb").should =~ /class User < ActiveRecord\:\:Base/
+    }
   end
   
-Here is another example using _with_args_:
+=== Checking Generator Actions
 
-  describe :custom_controller do
-    context "with a users controller and index, new, edit actions" do
-      with_args :users, :index, :new, :edit
-      
-      # . . .
-    end
+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. You can use the generation method matcher for this.
+
+All 3 of the following examples perform exactly the same test. Use whichever seems the most expressive to you. (I prefer the first one.)
+
+  it "should add a gem source" do
+    subject.should add_source("http://gems.github.com")
   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:
+  # -or-
+  it "should add a gem source" do
+    subject.should call_action(:add_source, "http://gems.github.com")
+  end
 
-  describe :custom_controller do
-    with_args MyFancyObject.new, :object => true
-    # . . .
+  # -or-
+  it "should add a gem source" do
+    subject.should generate(:add_source, "http://gems.github.com")
   end
 
-Finally, you can also let with_args generate a context for you:
+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:
 
-  describe :custom_controller do
-    with_args :users, :index, :new, :edit do
-      # . . .
-    end
+  it "should add a gem source" do
+    subject.should generate(:add_source)
   end
   
-This will generate an RSpec context that reads something like, "...with arguments [:users, :index, :new, :edit]".
+Similarly, you can get away with specifying only the some of a sequence of arguments; the omitted arguments will accept any value, while the specified ones will be tested. Another example:
+
+  it "should inject into file" do
+    subject.should inject_into_file("config/environment.rb", "config.gem :thor")
+  end
+  
+  # if the generator includes the following action, the test will
+  # pass even though the +after+ option wasn't specified in the spec:
+  #
+  # inject_into_file "config/environment.rb", "config.gem :thor",
+  #                  :after => "Rails::Initializer.run do |config|\n"
+  #
+
+You can test in this way using any public instance method in the +Thor::Actions+, +Rails::Generators::Actions+
+or +Rails::Generators::Migration+ modules. You can change this behavior by modifying the
++GenSpec::Matchers::GenerationMethodMatchers::GENERATION_CLASSES+ array.
 
 === 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
-assert that your generator has produced some specific content in its output (which would be either a logger of some
-sort or $stdout). This is helpful for making sure your help message is accurate, for instance.
+If you need to test the generator's feedback rather than the generator's results, you can use the _output_ matcher to assert that your generator has produced some specific content in its output. This is helpful for making sure your help message is accurate, for instance.
 
-  # Ex 1: String
+  # Example 1: String
   it "should generate a help message" do
     subject.should output("A Help Message")
   end
-  
-  # Ex 2: Regular Expression
+
+  # Example 2: Regular Expression
   it "should generate a help message" do
     subject.should output(/A [hH]elp Message/)
   end
 
 
-=== Checking Generated Files
+== More Advanced Usage
 
-This is the preferred way to test which files were actually generated, because this matcher checks your
-generator's *behavior*. That means it won't care _how_ a file is generated, as long as it _is_ generated. It's as simple
-as passing the name of the file you expected to be generated:
+=== Preparing Input
 
-  it "should generate a readme file" do
-    subject.should generate("README")
+Sometimes your generator needs to prompt for input. For instance, maybe it's encountered a file that is about
+to be overwritten and needs to check whether the user really wants to commit to the changes. You can prepare input streams like so:
+
+  with_input "y\n" do
+    it "should do something" do
+      # . . .
+    end
   end
-  
-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|
-      content.should =~ /class User < ActiveRecord\:\:Base/
-    }
+  with_input <<-end_input do
+    y
+    n
+    a
+  end_input
+    it "should do a particular set of somethings" do
+      # . . .
+    end
   end
 
-=== Checking Generation Methods
+Of course, preparing an input stream requires for you to know in advance which questions the generator will be asking, but your specs should be testing exactly this behavior, so this is not an issue.
 
-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.
+=== Specifying Arguments
 
-  it "should add a gem source" do
-    subject.should generate(:add_source, "http://gems.github.com")
+You can pass any combination of command line arguments or options to your generator using +with_args+. For instance, to pretend the _--verbose_ option was passed, we could use the following spec:
+
+  describe :custom_controller do
+    with_args "--verbose" do
+      it "should produce verbose output" do
+        # . . .
+      end
+    end
   end
   
-  # -or-
-  it "should add a gem source" do
-    subject.should call_action(:add_source, "http://gems.github.com")
+Here is another example using +with_args+:
+
+  describe :custom_controller do
+    with_args :users, :index, :new, :edit do
+      it "should produce an index action" do
+        # . . .
+      end
+    end
   end
 
-  # -or-
-  it "should add a gem source" do
-    subject.should add_source("http://gems.github.com")
+Note that no matter what you specify as arguments, by default they'll be initially converted to an array of Strings because that's what gets passed into the generator if you run it from the command line. You can bypass this behavior by passing an <em>:object => true</em> option as the last argument:
+
+  describe :custom_controller do
+    with_args MyFancyObject.new, :object => true do
+      # . . .
+    end
   end
-  
-Note that all three of the above examples accomplish exactly the same task. Use whichever is most expressive for you.
 
-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:
+Finally, you can also choose to use +with_args+ without a block, in which case it will be applied to the current context:
 
-  it "should add a gem source" do
-    subject.should generate(:add_source)
+  describe :custom_controller do
+    context "a Users controller with index, new, and edit actions" do
+      with_args :users, :index, :new, :edit
+    
+      # . . .
+    end
   end
 
-Any method added to Thor, the backend code that drives Rails generators, should be picked up automatically by
-GenSpec.
+=== Fixtures
+
+Most generators will assume you have some basic file structure in place. For instance, a controller generator that automatically adds routes for the controller may assume that a +config/routes.rb+ file exists prior to running it. Constructing a dummy file structure prior to testing is a necessity in such scenarios. Luckily, GenSpec provides an easy way to do just that:
+
+  describe :custom_controller do
+    within_source_root do
+      mkdir_p "config"
+      touch "config/routes.rb"
+    end
+    
+    # . . .
+  end
+  
+You can even nest such structures within various contexts:
+
+  describe :custom_controller do
+    within_source_root { mkdir_p "config" }
+  
+    context "with a routes file" do
+      within_source_root { touch "config/routes.rb" }
+      
+      it "should insert the new route" do
+        subject.should generate {
+          File.read("config/routes.rb").should_not be_blank
+        }
+      end
+    end
+  end
+  
+Fixture generation will always happen in the same order -- from the top-level context to the bottom-level context -- which means you are free to build the dummy file system incrementally, as needed, without worrying about order of operation.
 
 
 == Note on Patches/Pull Requests
@@ -167,4 +244,4 @@ GenSpec.
 
 == Copyright
 
-Copyright (c) 2010 Colin MacKenzie IV. See LICENSE for details.
+Copyright (c) 2010-2011 Colin MacKenzie IV. See LICENSE for details.

data/Rakefile

@@ -1,99 +1,19 @@
 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")
+require 'bundler/gem_tasks'
 
-            # ... 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 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", ">= 2.0.0.beta.14"
-    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
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+def run(*args)
+  raise "tests failed" unless system *args
 end
 
-desc "Run all specs in spec directory"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-  t.rcov = false
+task :default do
+  run "rspec", "spec"
+  ENV['RAILS'] = '1'
+  run "rspec", "spec"
 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 :default => [:check_dependencies, :spec]
-
-#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|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = GenSpec::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "genspec #{version}"

data/genspec.gemspec

@@ -1,78 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
+require File.expand_path("lib/genspec/version", File.dirname(__FILE__))
+
 Gem::Specification.new do |s|
-  s.name = %q{genspec}
-  s.version = "0.2.0.prerails3.2"
+  s.name = 'genspec'
+  s.version = GenSpec::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-07-08}
-  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.date = '2010-07-08'
+  s.description = %q{Simple, expressive Thor and/or Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.}
+  s.email = 'sinisterchipmunk@gmail.com'
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "genspec.gemspec",
-     "lib/gen_spec.rb",
-     "lib/genspec.rb",
-     "lib/genspec/generator_example_group.rb",
-     "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.prerails3.1.gem",
-     "pkg/genspec-0.2.0.prerails3.2.gem",
-     "spec/environment_spec.rb",
-     "spec/generators/migration_spec.rb",
-     "spec/generators/test_rails3_spec.rb",
-     "spec/rcov.opts",
-     "spec/rspec.opts",
-     "spec/spec_helper.rb",
-     "spec/support/generators/my_migration/my_migration_generator.rb",
-     "spec/support/generators/test_rails3/USAGE",
-     "spec/support/generators/test_rails3/templates/file",
-     "spec/support/generators/test_rails3/test_rails3_generator.rb"
+    "README.rdoc"
   ]
+  s.files = `git ls-files`.split(/\n/)
   s.homepage = %q{http://www.thoughtsincomputation.com}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   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/migration_spec.rb",
-     "spec/generators/test_rails3_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/support/generators/my_migration/my_migration_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
+  s.summary = %q{Simple, expressive Thor and/or Rails 3 generator testing for RSpec. For the Rails 2.3 version, use genspec 0.1.x.}
+  s.test_files = Dir["spec/**/*"]
 
-    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>, [">= 2.0.0.beta.14"])
-      s.add_dependency(%q<sc-core-ext>, [">= 1.2.1"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.14"])
-    s.add_dependency(%q<sc-core-ext>, [">= 1.2.1"])
-  end
+  s.add_dependency 'thor', '~> 0.14.6'
+  s.add_dependency 'rspec', "~> 2.6.0"
+  s.add_dependency 'sc-core-ext', "~> 1.2.1"
+  s.add_dependency 'i18n', '~> 0.5.0'
+  
+  s.add_development_dependency 'bundler', '= 1.0.15'
 end