juwelier 2.1.0

data/test/juwelier/test_gemspec_helper.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class TestGemspecHelper < Test::Unit::TestCase
+  def setup
+    Rake.application.instance_variable_set(:@rakefile, "Rakefile")
+  end
+
+  context "given a gemspec" do
+    setup do
+      @spec = build_spec
+      @helper = Juwelier::GemSpecHelper.new(@spec, File.dirname(__FILE__))
+    end
+
+    should 'have sane gemspec path' do
+      assert_equal "test/juwelier/#{@spec.name}.gemspec", @helper.path
+    end
+  end
+
+  context "#write" do
+    setup do
+      @spec = build_spec
+      @helper = Juwelier::GemSpecHelper.new(@spec, File.dirname(__FILE__))
+      FileUtils.rm_f(@helper.path)
+
+      @helper.write
+    end
+
+    teardown do
+      FileUtils.rm_f(@helper.path)
+    end
+
+    should "create gemspec file" do
+      assert File.exists?(@helper.path)
+    end
+
+    should "make valid spec" do
+      assert @helper.valid?
+    end
+
+    should "parse" do
+      @helper.parse
+    end
+  end
+end

data/test/juwelier/test_generator.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+class TestGenerator < Test::Unit::TestCase
+  def build_generator(testing_framework = :shoulda, options = {})
+    options = {
+      :project_name => 'the-perfect-gem',
+      :user_name => 'John Doe',
+      :user_email => 'john@example.com',
+      :github_username => 'johndoe',
+      :documentation_framework => :rdoc
+    }.merge(options)
+
+    options[:testing_framework] = testing_framework
+    Juwelier::Generator.new(options)
+  end
+
+  should "have the correct constant name" do
+    assert_equal "ThePerfectGem", build_generator.constant_name
+  end
+
+  should "have the correct file name prefix" do
+    assert_equal "the_perfect_gem", build_generator.file_name_prefix
+  end
+
+  should "have the correct require name" do
+    assert_equal "the-perfect-gem", build_generator.require_name
+  end
+
+  should "have the correct lib file name" do
+    assert_equal "the-perfect-gem.rb", build_generator.lib_filename
+  end
+  
+  should "have the correct git-remote" do
+    assert_equal 'user@host:/path/to/repo', build_generator(:shoulda, {:git_remote => "user@host:/path/to/repo"}).git_remote
+    assert_equal 'git@github.com:johndoe/the-perfect-gem.git', build_generator.git_remote 
+  end
+
+  should "extract project name from absolut path" do
+    assert_equal "my-project", build_generator(:shoulda, {:project_name => "/tmp/my-project"}).project_name
+  end
+
+  should "extract project name from relative path" do
+    assert_equal "my-project", build_generator(:shoulda, {:project_name => "../my-project"}).project_name
+  end
+
+  should "extract project name from direct path" do
+    assert_equal "my-project", build_generator(:shoulda, {:project_name => "my-project"}).project_name
+  end
+
+  def self.should_have_generator_attribute(attribute, value)
+    should "have #{value} for #{attribute}" do
+      assert_equal value, build_generator(@framework).send(attribute)
+    end
+  end
+
+  context "shoulda" do
+    setup { @framework = :shoulda }
+    should_have_generator_attribute :test_task, 'test'
+    should_have_generator_attribute :test_dir, 'test'
+    should_have_generator_attribute :default_task, 'test'
+    should_have_generator_attribute :feature_support_require, 'test/unit/assertions'
+    should_have_generator_attribute :feature_support_extend, 'Test::Unit::Assertions'
+    should_have_generator_attribute :test_pattern, 'test/**/test_*.rb'
+    should_have_generator_attribute :test_filename, 'test_the-perfect-gem.rb'
+    should_have_generator_attribute :test_helper_filename, 'helper.rb'
+  end
+
+  context "testunit" do
+    setup { @framework = :testunit }
+    should_have_generator_attribute :test_task, 'test'
+    should_have_generator_attribute :test_dir, 'test'
+    should_have_generator_attribute :default_task, 'test'
+    should_have_generator_attribute :feature_support_require, 'test/unit/assertions'
+    should_have_generator_attribute :feature_support_extend, 'Test::Unit::Assertions'
+    should_have_generator_attribute :test_pattern, 'test/**/test_*.rb'
+    should_have_generator_attribute :test_filename, 'test_the-perfect-gem.rb'
+    should_have_generator_attribute :test_helper_filename, 'helper.rb'
+  end
+
+  context "minitest" do
+    setup { @framework = :minitest }
+    should_have_generator_attribute :test_task, 'test'
+    should_have_generator_attribute :test_dir, 'test'
+    should_have_generator_attribute :default_task, 'test'
+    should_have_generator_attribute :feature_support_require, 'minitest/unit'
+    should_have_generator_attribute :feature_support_extend, 'MiniTest::Assertions'
+    should_have_generator_attribute :test_pattern, 'test/**/test_*.rb'
+    should_have_generator_attribute :test_filename, 'test_the-perfect-gem.rb'
+    should_have_generator_attribute :test_helper_filename, 'helper.rb'
+  end
+
+  context "bacon" do
+    setup { @framework = :bacon }
+    should_have_generator_attribute :test_task, 'spec'
+    should_have_generator_attribute :test_dir, 'spec'
+    should_have_generator_attribute :default_task, 'spec'
+    should_have_generator_attribute :feature_support_require, 'test/unit/assertions'
+    should_have_generator_attribute :feature_support_extend, 'Test::Unit::Assertions'
+    should_have_generator_attribute :test_pattern, 'spec/**/*_spec.rb'
+    should_have_generator_attribute :test_filename, 'the-perfect-gem_spec.rb'
+    should_have_generator_attribute :test_helper_filename, 'spec_helper.rb'
+  end
+
+  context "rspec" do
+    setup { @framework = :rspec }
+    should_have_generator_attribute :test_task, 'spec'
+    should_have_generator_attribute :test_dir, 'spec'
+    should_have_generator_attribute :default_task, 'spec'
+    should_have_generator_attribute :feature_support_require, 'rspec/expectations'
+    should_have_generator_attribute :feature_support_extend, nil
+    should_have_generator_attribute :test_pattern, 'spec/**/*_spec.rb'
+    should_have_generator_attribute :test_filename, 'the-perfect-gem_spec.rb'
+    should_have_generator_attribute :test_helper_filename, 'spec_helper.rb'
+  end
+
+  context "micronaut" do
+    setup { @framework = :micronaut }
+    should_have_generator_attribute :test_task, 'examples'
+    should_have_generator_attribute :test_dir, 'examples'
+    should_have_generator_attribute :default_task, 'examples'
+    should_have_generator_attribute :feature_support_require, 'micronaut/expectations'
+    should_have_generator_attribute :feature_support_extend, 'Micronaut::Matchers'
+    should_have_generator_attribute :test_pattern, 'examples/**/*_example.rb'
+    should_have_generator_attribute :test_filename, 'the-perfect-gem_example.rb'
+    should_have_generator_attribute :test_helper_filename, 'example_helper.rb'
+  end
+  
+  context "testspec" do
+    setup { @framework = :testspec }
+    should_have_generator_attribute :test_task, 'test'
+    should_have_generator_attribute :test_dir, 'test'
+    should_have_generator_attribute :default_task, 'test'
+    should_have_generator_attribute :feature_support_require, 'test/unit/assertions'
+    should_have_generator_attribute :feature_support_extend, 'Test::Unit::Assertions'
+    should_have_generator_attribute :test_pattern, 'test/**/*_test.rb'
+    should_have_generator_attribute :test_filename, 'the-perfect-gem_test.rb'
+    should_have_generator_attribute :test_helper_filename, 'test_helper.rb'
+  end
+  
+end

data/test/juwelier/test_generator_initialization.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+
+class TestGeneratorInitialization < Test::Unit::TestCase
+  def setup
+    set_default_git_config
+  end
+
+  context "given a nil github repo name" do
+    setup do
+      stub_git_config
+    end
+
+    should 'raise NoGithubRepoNameGiven' do
+      assert_raise Juwelier::NoGitHubRepoNameGiven do
+        Juwelier::Generator.new()
+      end
+    end
+  end
+
+  context "without git user's name set" do
+    setup do
+      stub_git_config 
+    end
+
+    should 'raise an NoGitUserName' do
+      assert_raise Juwelier::NoGitUserName do
+        Juwelier::Generator.new(:project_name => @project_name, :testing_framework => :shoulda, :documentation_framework => :rdoc)
+      end
+    end
+  end
+
+  context "without git user's email set" do
+    setup do
+      stub_git_config 
+    end
+
+    should 'raise NoGitUserEmail' do
+      assert_raise Juwelier::NoGitUserEmail do
+        Juwelier::Generator.new(:project_name => @project_name, :user_name => @git_name, :testing_framework => :shoulda, :documentation_framework => :rdoc)
+      end
+    end
+  end
+
+  context "without github username set" do
+    setup do
+      stub_git_config
+    end
+
+    should 'raise NotGitHubUser' do
+      assert_raise Juwelier::NoGitHubUser do
+        Juwelier::Generator.new(:project_name => @project_name, :user_name => @git_name, :user_email => @git_email, :testing_framework => :shoulda, :documentation_framework => :rdoc)
+      end
+    end
+  end
+  def build_generator(options = {})
+    defaults = { :project_name => @project_name,
+                 :user_name => @git_name,
+                 :user_email => @git_email,
+                 :github_username => @github_user,
+                 :testing_framework =>             :shoulda,
+                 :documentation_framework =>       :rdoc }
+
+    options = defaults.merge(options)
+    Juwelier::Generator.new(options) 
+  end
+
+  context "default configuration" do
+    setup do
+      stub_git_config
+      @generator = build_generator
+    end
+
+    should "use shoulda for testing" do
+      assert_equal :shoulda, @generator.testing_framework
+    end
+
+    should "use rdoc for documentation" do
+      assert_equal :rdoc, @generator.documentation_framework
+    end
+
+    should "set todo in summary" do
+      assert_match /todo/i, @generator.summary
+    end
+
+    should "set todo in description" do
+      assert_match /todo/i, @generator.description
+    end
+
+    should "set target directory to the project name" do
+      assert_equal @project_name, File.split(@generator.target_dir).last
+    end
+
+    should "set user's name from git config" do
+      assert_equal @git_name, @generator.user_name
+    end
+
+    should "set email from git config" do
+      assert_equal @git_email, @generator.user_email
+    end
+
+    should "set origin remote as github, based on username and project name" do
+      assert_equal "git@github.com:#{@github_user}/#{@project_name}.git", @generator.git_remote
+    end
+
+    should "set homepage as github based on username and project name" do
+      assert_equal "http://github.com/#{@github_user}/#{@project_name}", @generator.homepage
+    end
+
+    should "set github username from git config" do
+      assert_equal @github_user, @generator.github_username
+    end
+
+    should "set project name as the-perfect-gem" do
+      assert_equal @project_name, @generator.project_name
+    end
+  end
+
+  context "using yard" do
+    setup do
+      @generator = build_generator(:documentation_framework => :yard)
+    end
+
+    should "set the doc_task to yardoc" do
+      assert_equal "yardoc", @generator.doc_task
+    end
+
+  end
+
+  context "using rdoc" do
+    setup do
+      @generator = build_generator(:documentation_framework => :rdoc)
+    end
+
+    should "set the doc_task to rdoc" do
+      assert_equal "rdoc", @generator.doc_task
+    end
+  end
+
+  context "using a custom homepage" do
+    setup do
+      @generator = build_generator(:homepage => 'http://zomg.com')
+    end
+
+    should "set the homepage" do
+      assert_equal "http://zomg.com", @generator.homepage
+    end
+
+  end
+
+end

data/test/juwelier/test_generator_mixins.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class TestGeneratorMixins < Test::Unit::TestCase
+
+  [Juwelier::Generator::BaconMixin,
+   Juwelier::Generator::MicronautMixin,
+   Juwelier::Generator::MinitestMixin,
+   Juwelier::Generator::RspecMixin,
+   Juwelier::Generator::ShouldaMixin,
+   Juwelier::Generator::TestspecMixin,
+   Juwelier::Generator::TestunitMixin,
+  ].each do |mixin|
+    context "#{mixin}" do
+      %w(default_task feature_support_require feature_support_extend
+         test_dir test_task test_pattern test_filename
+         test_helper_filename).each do |method|
+          should "define #{method}" do
+            assert mixin.method_defined?(method)
+          end
+       end
+    end
+  end
+end

data/test/juwelier/test_specification.rb

@@ -0,0 +1,245 @@
+require 'test_helper'
+
+class TestSpecification < Test::Unit::TestCase
+  def setup
+    @project = create_construct
+  end
+
+  def teardown
+    @project.destroy!
+  end
+
+  def build_juwelier_gemspec(&block)
+    gemspec = if block
+                Gem::Specification.new(&block)
+              else
+                Gem::Specification.new()
+              end
+    gemspec.extend(Juwelier::Specification)
+    gemspec
+  end
+
+  should "be able to use to_ruby on a duped gemspec without error" do
+    gemspec = build_juwelier_gemspec
+    gemspec.files.include 'throwaway value'
+
+    gemspec.dup.to_ruby
+  end
+
+  context "basic defaults" do
+    setup do
+      @gemspec = build_juwelier_gemspec
+    end
+
+    should "make files a FileList" do
+      assert_equal FileList, @gemspec.files.class
+    end
+
+    should "make extra_rdoc_files a FileList" do
+      assert_equal FileList, @gemspec.extra_rdoc_files.class
+    end
+
+  end
+ 
+  context "there aren't any executables in the project directory" do
+    setup do
+      @project.directory 'bin' 
+    end
+
+    context "and there hasn't been any set on the gemspec" do
+      setup do
+        @gemspec = build_juwelier_gemspec
+        @gemspec.set_juwelier_defaults(@project)
+      end
+
+
+      should "have empty gemspec executables" do
+        assert_equal [], @gemspec.executables
+      end
+    end
+
+    context "and has been previously set executables" do
+      setup do
+        @gemspec  = build_juwelier_gemspec do |gemspec|
+          gemspec.executables = %w(non-existant)
+        end
+        @gemspec.set_juwelier_defaults(@project)
+      end
+
+      should "have only the original executables in the gemspec" do
+        assert_equal %w(non-existant), @gemspec.executables
+      end
+    end
+  end
+
+  context "there are multiple executables in the project directory" do
+    setup do
+      @project.directory('bin') do |bin|
+        bin.file 'burnination'
+        bin.file 'trogdor'
+      end
+      repo = Git.init(@project.to_s)
+      repo.config('user.name', 'who')
+      repo.config('user.email', 'who@where.com')
+      repo.add('bin/burnination')
+      repo.commit('Initial commit')
+    end
+
+    context "and there hasn't been any set on the gemspec" do
+      setup do
+        @gemspec  = build_juwelier_gemspec
+        @gemspec.set_juwelier_defaults(@project)
+      end
+
+      should "have the executables under version control in the gemspec" do
+        assert_equal %w(burnination), @gemspec.executables
+      end
+    end
+    context "and has been previously set executables" do
+      setup do
+        @gemspec  = build_juwelier_gemspec do |gemspec|
+          gemspec.executables = %w(burnination)
+        end
+        @gemspec.set_juwelier_defaults(@project)
+      end
+      should "have only the original executables in the gemspec" do
+        assert_equal %w(burnination), @gemspec.executables
+      end
+    end
+  end
+
+  context "there are mutiple extconf.rb and mkrf_conf.rb in the project directory" do
+    setup do
+      @project.directory('ext') do |ext|
+        ext.file 'extconf.rb'
+        ext.file 'mkrf_conf.rb'
+        ext.directory('trogdor_native') do |trogdor_native|
+          trogdor_native.file 'extconf.rb'
+          trogdor_native.file 'mkrf_conf.rb'
+        end
+      end
+    end
+
+    context "and there hasn't been any extensions set on the gemspec" do
+      setup do
+        @gemspec  = build_juwelier_gemspec
+        @gemspec.set_juwelier_defaults(@project)
+      end
+
+      should "have all the extconf.rb and mkrf_config.rb files in extensions" do
+        assert_equal %w(ext/mkrf_conf.rb ext/trogdor_native/mkrf_conf.rb ext/extconf.rb ext/trogdor_native/extconf.rb).sort, @gemspec.extensions.sort
+      end
+
+    end
+
+  end
+
+  context "there are some files and is setup for git" do
+    setup do
+      @project.file 'Rakefile'
+      @project.directory('lib') do |lib|
+        lib.file 'example.rb'
+      end
+
+      repo = Git.init(@project.to_s)
+      repo.config('user.name', 'who')
+      repo.config('user.email', 'who@where.com')
+      repo.add('.')
+      repo.commit('Initial commit')
+    end
+
+    context "and the files defaults are used" do
+      setup do
+        @gemspec  = build_juwelier_gemspec
+        @gemspec.set_juwelier_defaults(@project, @project)
+      end
+
+      should "populate files from git" do
+        assert_equal %w(Rakefile lib/example.rb), @gemspec.files.sort
+      end
+    end
+
+    context "and the files specified manually" do
+      setup do
+        @gemspec  = build_juwelier_gemspec do |gemspec|
+          gemspec.files = %w(Rakefile)
+        end
+        @gemspec.set_juwelier_defaults(@project, @project)
+      end
+
+      should "not be overridden by files from git" do
+        assert_equal %w(Rakefile), @gemspec.files
+      end
+    end
+
+  end
+
+  context "there are some files and is setup for git with ignored files" do
+    setup do
+      @project.file '.gitignore', 'ignored'
+      @project.file 'ignored'
+      @project.file 'Rakefile'
+      @project.directory('lib') do |lib|
+        lib.file 'example.rb'
+      end
+
+      repo = Git.init(@project.to_s)
+      repo.config('user.name', 'who')
+      repo.config('user.email', 'who@where.com')
+      repo.add('.')
+      repo.commit('Initial commit')
+
+
+      @gemspec  = build_juwelier_gemspec
+      @gemspec.set_juwelier_defaults(@project, @project)
+    end
+
+    should "populate files from git excluding ignored and .gitignore" do
+      assert_equal %w(Rakefile lib/example.rb), @gemspec.files.sort
+    end
+  end
+
+  context "there are some files and is setup for git and working in a sub directory" do
+    setup do
+      @subproject = File.join(@project, 'subproject')
+      @project.file 'Rakefile'
+      @project.file 'README'
+      @project.directory 'subproject' do |subproject|
+        subproject.file 'README'
+        subproject.directory('lib') do |lib|
+          lib.file 'subproject_example.rb'
+        end
+      end
+
+      repo = Git.init(@project.to_s)
+      repo.config('user.name', 'who')
+      repo.config('user.email', 'who@where.com')
+      repo.add('.')
+      repo.commit('Initial commit')
+
+      @gemspec  = build_juwelier_gemspec
+      @gemspec.set_juwelier_defaults(@subproject, @project)
+    end
+
+    should "populate files from git relative to sub directory" do
+      assert_equal %w(lib/subproject_example.rb README).sort, @gemspec.files.sort
+    end
+  end
+
+  context "there are some files and is not setup for git" do
+    setup do
+      @project.file 'Rakefile'
+      @project.directory('lib') do |lib|
+        lib.file 'example.rb'
+      end
+
+      @gemspec  = build_juwelier_gemspec
+      @gemspec.set_juwelier_defaults(@project, @project)
+    end
+
+    should "not populate files" do
+      assert_equal [], @gemspec.files.sort
+    end
+  end
+
+end