juwelier 2.1.0

data/features/step_definitions/generator_steps.rb

@@ -0,0 +1,387 @@
+Given /^I do not want cucumber stories$/ do
+  @use_cucumber = false
+end
+
+Given /^I want cucumber stories$/ do
+  @use_cucumber = true
+end
+
+Given /^I do not want reek$/ do
+  @use_reek = false
+end
+
+Given /^I want reek$/ do
+  @use_reek = true
+end
+
+Given /^I do not want bundler$/ do
+  @use_bundler = false
+end
+
+
+Given /^I want bundler$/ do
+  @use_bundler = true
+end
+
+Given /^I do not want roodi$/ do
+  @use_roodi = false
+end
+
+Given /^I want roodi$/ do
+  @use_roodi = true
+end
+
+And /^I do not want rubyforge setup$/ do
+  @use_rubyforge = false
+end
+
+And /^I want rubyforge setup$/ do
+  @use_rubyforge = true
+end
+
+Given /^I want to use yard instead of rdoc$/ do
+  @documentation_framework = "yard"
+end
+
+Given /^I want to use rdoc instead of yard$/ do
+  @documentation_framework = "rdoc"
+end
+
+
+Given /^I intend to test with (\w+)$/ do |testing_framework|
+  @testing_framework = testing_framework.to_sym
+end
+
+Given /^I have configured git sanely$/ do
+  @user_email = 'bar@example.com'
+  @user_name = 'foo'
+  @github_user = 'flajann2'
+
+  require 'git'
+  Git.stubs(:global_config).
+        returns({
+          'user.name' => @user_name,
+          'user.email' => @user_email,
+          'github.user' => @github_user})
+end
+
+Given /^I set JUWELIER_OPTS env variable to "(.*)"$/ do |val|
+  ENV['JUWELIER_OPTS'] = val
+end
+
+When /^I generate a (.*)project named '((?:\w|-|_)+)' that is '([^']*)'$/ do |testing_framework, name, summary|
+  step "I generate a #{testing_framework}project named '#{name}' that is '#{summary}' and described as ''"
+end
+
+When /^I generate a (.*)project named '((?:\w|-|_)+)' that is '([^']*)' and described as '([^']*)'$/ do |testing_framework, name, summary, description|
+  @name = name
+  @summary = summary
+  @description = description
+
+  testing_framework = testing_framework.squeeze.strip
+  unless testing_framework.blank?
+    @testing_framework = testing_framework.to_sym
+  end
+
+
+  arguments = [ '--summary', @summary,
+               '--description', @description,
+                @use_cucumber ? '--cucumber' : nil,
+                @testing_framework ? "--#{@testing_framework}" : nil,
+                @use_rubyforge ? '--rubyforge' : nil,
+                @use_roodi ? '--roodi' : nil,
+                @use_reek ? '--reek' : nil,
+                case @use_bundler
+                when true then '--bundler'
+                when false then '--no-bundler'
+                else nil
+                end,
+                @documentation_framework ? "--#{@documentation_framework}" : nil,
+                "#{@working_dir}/#{@name}"].compact
+
+
+  @stdout = OutputCatcher.catch_out do
+    Juwelier::Generator::Application.run! *arguments
+  end
+
+  @repo = Git.open(File.join(@working_dir, @name))
+end
+
+Then /^a directory named '(.*)' is created$/ do |directory|
+  directory = File.join(@working_dir, directory)
+
+  assert File.exists?(directory), "#{directory} did not exist"
+  assert File.directory?(directory), "#{directory} is not a directory"
+end
+
+Then "cucumber directories are created" do
+  step "a directory named 'the-perfect-gem/features' is created"
+  step "a directory named 'the-perfect-gem/features/support' is created"
+  step "a directory named 'the-perfect-gem/features/step_definitions' is created"
+end
+
+
+Then /^a file named '(.*)' is created$/ do |file|
+  file = File.join(@working_dir, file)
+
+  assert File.exists?(file), "#{file} expected to exist, but did not"
+  assert File.file?(file), "#{file} expected to be a file, but is not"
+end
+
+Then /^a file named '(.*)' is not created$/ do |file|
+  file = File.join(@working_dir, file)
+
+  assert ! File.exists?(file), "#{file} expected to not exist, but did"
+end
+
+Then /^a sane '.gitignore' is created$/ do
+  step "a file named 'the-perfect-gem/.gitignore' is created"
+  step "'coverage' is ignored by git"
+  step "'coverage.data' is ignored by git"
+  step "'*.swp' is ignored by git"
+  step "'.DS_Store' is ignored by git"
+  step "'rdoc' is ignored by git"
+  step "'pkg' is ignored by git"
+end
+
+Then /^'(.*)' is ignored by git$/ do |git_ignore|
+  @gitignore_content ||= File.read(File.join(@working_dir, @name, '.gitignore'))
+
+  assert_match git_ignore, @gitignore_content
+end
+
+Then /^Rakefile has '(.*)' for the (.*) (.*)$/ do |value, task_class, field|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  block_variable, task_block = yank_task_info(@rakefile_content, task_class)
+  #raise "Found in #{task_class}: #{block_variable.inspect}: #{task_block.inspect}"
+
+  assert_match /#{block_variable}\.#{field} = (%Q\{|"|')#{Regexp.escape(value)}(\}|"|')/, task_block
+end
+
+Then /^Rakefile adds '(.*)' as a development dependency to Juwelier::Tasks$/ do |dependency|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  block_variable, task_block = yank_task_info(@rakefile_content, "Juwelier::Tasks")
+
+  assert_match /#{block_variable}\.add_development_dependency "#{dependency}"/, task_block
+end
+
+Then /^Rakefile does not add '(.*)' as a development dependency to Juwelier::Tasks$/ do |dependency|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  block_variable, task_block = yank_task_info(@rakefile_content, "Juwelier::Tasks")
+
+  assert_no_match /#{block_variable}\.add_development_dependency "#{dependency}"/, task_block
+end
+
+Then /^Rakefile has '(.*)' in the Rcov::RcovTask libs$/ do |libs|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  block_variable, task_block = yank_task_info(@rakefile_content, 'Rcov::RcovTask')
+
+  assert_match "#{block_variable}.libs << '#{libs}'", @rakefile_content
+end
+
+Then /^Rakefile has '(.*)' in the Rcov::RcovTask rcov_opts$/ do |rcov_opts|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  block_variable, task_block = yank_task_info(@rakefile_content, 'Rcov::RcovTask')
+
+  assert_match "#{block_variable}.rcov_opts << '#{rcov_opts}'", @rakefile_content
+end
+
+
+Then /^'(.*)' contains '(.*)'$/ do |file, expected_string|
+  contents = File.read(File.join(@working_dir, @name, file))
+  assert_match expected_string, contents
+end
+
+Then /^'(.*)' mentions copyright belonging to me in (\d{4})$/ do |file, year|
+  contents = File.read(File.join(@working_dir, @name, file))
+  assert_match "Copyright (c) #{year} #{@user_name}", contents
+end
+
+Then /^'(.*)' mentions copyright belonging to me in the current year$/ do |file|
+  current_year = Time.now.year
+  step "'#{file}' mentions copyright belonging to me in #{current_year}"
+end
+
+
+Then /^LICENSE\.txt credits '(.*)'$/ do |copyright_holder|
+  step "a file named 'the-perfect-gem/LICENSE.txt' is created"
+  @license_content ||= File.read(File.join(@working_dir, @name, 'LICENSE.txt'))
+  assert_match copyright_holder, @license_content
+end
+
+Given /^it is the year (\d+)$/ do |year|
+  time = Time.local(year.to_i, 9, 1, 10, 5, 0)
+  Timecop.travel(time)
+end
+
+
+Then /^LICENSE\.txt has a copyright in the year (\d+)$/ do |year|
+  step "a file named 'the-perfect-gem/LICENSE.txt' is created"
+  @license_content ||= File.read(File.join(@working_dir, @name, 'LICENSE.txt'))
+  assert_match year, @license_content
+end
+
+
+Then /^'(.*)' should define '(.*)' as a subclass of '(.*)'$/ do |file, class_name, superclass_name|
+  @test_content = File.read((File.join(@working_dir, @name, file)))
+
+  assert_match "class #{class_name} < #{superclass_name}", @test_content
+end
+
+Then /^'(.*)' should describe '(.*)'$/ do |file, describe_name|
+  @spec_content ||= File.read((File.join(@working_dir, @name, file)))
+
+  assert_match %Q{describe "#{describe_name}" do}, @spec_content
+end
+
+Then /^'(.*)' should contextualize '(.*)'$/ do |file, describe_name|
+  @spec_content ||= File.read((File.join(@working_dir, @name, file)))
+
+  assert_match %Q{context "#{describe_name}" do}, @spec_content
+end
+
+Then /^'(.*)' should have tests for '(.*)'$/ do |file, describe_name|
+  @tests_content ||= File.read((File.join(@working_dir, @name, file)))
+
+  assert_match %Q{Shindo.tests("#{describe_name}") do}, @tests_content
+end
+
+Then /^'(.*)' requires '(.*)'$/ do |file, lib|
+  content = File.read(File.join(@working_dir, @name, file))
+
+  assert_match /require ['"]#{Regexp.escape(lib)}['"]/, content
+end
+
+Then /^'(.*)' does not require '(.*)'$/ do |file, lib|
+  content = File.read(File.join(@working_dir, @name, file))
+
+  assert_no_match /require ['"]#{Regexp.escape(lib)}['"]/, content
+end
+
+Then /^Rakefile does not require '(.*)'$/ do |file|
+  step "'Rakefile' does not require '#{file}'"
+end
+
+Then /^Rakefile requires '(.*)'$/ do |file|
+  step "'Rakefile' requires '#{file}'"
+end
+
+Then /^Rakefile does not instantiate a (.*)$/ do |task_name|
+  content = File.read(File.join(@working_dir, @name, 'Rakefile'))
+  assert_no_match /#{task_name}/, content
+end
+
+Then /^Rakefile instantiates a (.*)$/ do |task_name|
+  content = File.read(File.join(@working_dir, @name, 'Rakefile'))
+  assert_match /#{task_name}/, content
+end
+
+
+Then /^'(.+?)' should autorun tests$/ do |test_helper|
+  content = File.read(File.join(@working_dir, @name, test_helper))
+
+  assert_match "MiniTest::Unit.autorun", content
+end
+
+Then /^cucumber world extends "(.*)"$/ do |module_to_extend|
+  content = File.read(File.join(@working_dir, @name, 'features', 'support', 'env.rb'))
+  assert_match "World(#{module_to_extend})", content
+end
+
+
+Then /^'features\/support\/env\.rb' sets up features to use test\/unit assertions$/ do
+
+end
+
+Then /^'features\/support\/env\.rb' sets up features to use minitest assertions$/ do
+  content = File.read(File.join(@working_dir, @name, 'features', 'support', 'env.rb'))
+
+  assert_match "world.extend(Mini::Test::Assertions)", content
+end
+
+Then /^git repository has '(.*)' remote$/ do |remote|
+  remote = @repo.remotes.first
+
+  assert_equal 'origin', remote.name
+end
+
+Then /^git repository '(.*)' remote should be '(.*)'/ do |remote, remote_url|
+  remote = @repo.remotes.first
+
+  assert_equal 'git@github.com:flajann2/the-perfect-gem.git', remote.url
+end
+
+Then /^a commit with the message '(.*)' is made$/ do |message|
+  assert_match message, @repo.log.first.message
+end
+
+Then /^'(.*)' was checked in$/ do |file|
+  status = @repo.status[file]
+
+  assert_not_nil status, "wasn't able to get status for #{file}"
+  assert ! status.untracked, "#{file} was untracked"
+  assert_nil status.type, "#{file} had a type. it should have been nil"
+end
+
+Then /^no files are (\w+)$/ do |type|
+  assert_equal 0, @repo.status.send(type).size
+end
+
+Then /^Rakefile has "(.*)" as the default task$/ do |task|
+  @rakefile_content ||= File.read(File.join(@working_dir, @name, 'Rakefile'))
+  assert_match "task :default => :#{task}", @rakefile_content
+end
+
+
+After do
+  ENV['JUWELIER_OPTS'] = nil
+end
+
+Then /^'Gemfile' has a (\w+) dependency on '(.*)'$/ do |group, name|
+  @gemfile_content ||= File.read(File.join(@working_dir, @name, 'Gemfile'))
+
+  group_block = yank_group_info(@gemfile_content, group)
+
+  assert_match name, group_block
+end
+
+Then /^'Gemfile' does not have a (\w+) dependency on '(.*)'$/ do |group, name|
+  @gemfile_content ||= File.read(File.join(@working_dir, @name, 'Gemfile'))
+
+  group_block = yank_group_info(@gemfile_content, group)
+
+  assert_no_match Regexp.new(Regexp.escape(name)), group_block
+end
+
+Then /^'Gemfile' has a development dependency on the current version of juwelier$/ do
+  @gemfile_content ||= File.read(File.join(@working_dir, @name, 'Gemfile'))
+  group_block = yank_group_info(@gemfile_content, 'development')
+  
+  assert_match %Q{gem "juwelier", "~> #{Juwelier::Version::STRING}"}, group_block
+end
+
+
+Then /^'(.*)' sets up bundler using the default and development groups$/ do |file|
+  content = File.read(File.join(@working_dir, @name, file))
+
+  assert_match "Bundler.setup(:default, :development)", content
+end
+
+Then /^'(.*)' does not setup bundler$/ do |file|
+  content = File.read(File.join(@working_dir, @name, file))
+
+  assert_no_match /Bundler\.setup/, content
+end
+
+Then /^'Gemfile' uses the (.*) source$/ do |source|
+  content = File.read(File.join(@working_dir, @name, 'Gemfile'))
+
+  assert_match %Q{source "http://rubygems.org"}, content
+end
+
+
+Then /^Rakefile has a magic comment for UTF\-(\d+)$/ do |arg1|
+  content = File.read(File.join(@working_dir, @name, 'Rakefile'))
+  assert_match "# encoding: utf-8", content
+end
+

data/features/step_definitions/task_steps.rb

@@ -0,0 +1,6 @@
+Then /^I can gem install "([^"]+)"$/ do |gem_path|
+  @stdout = `cd #{@working_dir}; gem install --install-dir #{@working_dir}/gem-install-dir --no-ri --no-rdoc #{gem_path} 2>&1`
+  assert_no_match /ERROR/, @stdout
+  assert $?.exited?
+end
+

data/features/support/env.rb

@@ -0,0 +1,41 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :xzibit, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'juwelier'
+require 'mocha'
+require 'output_catcher'
+require 'timecop'
+require 'ruby-debug'
+require 'active_support'
+
+require 'test/unit/assertions'
+World(Test::Unit::Assertions)
+
+require 'construct'
+World(Construct::Helpers)
+
+def yank_task_info(content, task)
+  if content =~ /#{Regexp.escape(task)}.new(\(.*\))? do \|(.*?)\|(.*?)^end$/m
+    [$2, $3]
+  end
+end
+
+def yank_group_info(content, group)
+  if content =~ /group :#{group} do(.*?)end/m
+    $1
+  end
+end
+
+def fixture_dir
+  File.expand_path File.join(File.dirname(__FILE__), '..', '..', 'test', 'fixtures')
+end
+
+After do
+  Timecop.return
+end

data/features/tasks/build_gem.feature

@@ -0,0 +1,9 @@
+Feature: building gems
+
+  Scenario: default
+    Given a working directory
+    And I use the existing project "existing-project-with-version-yaml" as a template
+    And "VERSION.yml" contains hash "{ :major => 1, :minor => 5, :patch => 3}"
+    And "existing-project-with-version/pkg/existing-project-with-version-1.5.3.gem" does not exist
+    When I run "rake build" in "existing-project-with-version-yaml"
+    Then I can gem install "existing-project-with-version-yaml/pkg/existing-project-with-version-1.5.3.gem"

data/features/tasks/version.feature

@@ -0,0 +1,31 @@
+Feature: version rake task
+
+  #Scenario: a newly created project without a version
+  #  Given a working directory
+  #  And I use the juwelier command to generate the "the-perfect-gem" project in the working directory
+  #  And "the-perfect-gem/VERSION" does not exist
+  #  When I run "rake version" in "the-perfect-gem"
+  #  Then the process should not exit cleanly
+
+  Scenario: an existing project with version yaml
+    Given a working directory
+    And I use the existing project "existing-project-with-version-yaml" as a template
+    And "VERSION.yml" contains hash "{ :major => 1, :minor => 5, :patch => 3}"
+    When I run "rake version" in "existing-project-with-version-yaml"
+    Then the process should exit cleanly
+    And the current version, 1.5.3, is displayed
+
+  Scenario: an existing project with version plaintext
+    Given a working directory
+    And I use the existing project "existing-project-with-version-plaintext" as a template
+    And "VERSION" contains "1.5.3"
+    When I run "rake version" in "existing-project-with-version-plaintext"
+    Then the process should exit cleanly
+    And the current version, 1.5.3, is displayed
+
+  Scenario: an existing project with version constant
+    Given a working directory
+    And I use the existing project "existing-project-with-version-constant" as a template
+    When I run "rake version" in "existing-project-with-version-constant"
+    Then the process should exit cleanly
+    And the current version, 1.0.0, is displayed