@@ -23,6 +23,7 @@ Jeweler::Tasks.new do |gem| gem.add_development_dependency "rr" gem.add_development_dependency "mocha" gem.add_development_dependency "redgreen" + gem.add_development_dependency "devver-construct" gem.add_development_dependency "yard" gem.add_development_dependency "cucumber" Rakefile @@ -13,6 +13,9 @@ class Jeweler def self.filelist_attribute(name) code = %{ def #{name} + if @#{name} && @#{name}.class != FileList + @#{name} = FileList[@#{name}] + end @#{name} ||= FileList[] end def #{name}=(value) @@ -29,28 +32,40 @@ class Jeweler # Assigns the Jeweler defaults to the Gem::Specification def set_jeweler_defaults(base_dir, git_base_dir = nil) - Dir.chdir(base_dir) do + base_dir = File.expand_path(base_dir) + git_base_dir = if git_base_dir + File.expand_path(git_base_dir) + else + base_dir + end + can_git = git_base_dir && File.directory?(File.join(git_base_dir, '.git')) + + Dir.chdir(git_base_dir) do require 'git' - if blank?(files) && git_base_dir - git_subdir = File.expand_path(base_dir).sub(File.join(File.expand_path(git_base_dir), ""), "") - repo = Git.open(git_base_dir) - self.files = (repo.ls_files.keys - repo.lib.ignored_files).map {|fn| fn.sub(File.join(git_subdir, ""), "")} + repo = Git.open(git_base_dir) if can_git + + if blank?(files) && repo + base_dir_with_trailing_separator = File.join(base_dir, "") + + self.files = (repo.ls_files(base_dir).keys - repo.lib.ignored_files).map do |file| + #breakpoint + File.expand_path(file).sub(base_dir_with_trailing_separator, "") + end end - if blank?(test_files) && File.directory?(File.join(base_dir, '.git')) - repo = Git.open(base_dir) + if blank?(test_files) && repo self.test_files = FileList['{spec,test,examples}/**/*.rb'] - repo.lib.ignored_files end if blank?(executables) - self.executables = Dir["bin/*"].map { |f| File.basename(f) } + self.executables = Dir['bin/*'].map { |f| File.basename(f) } end self.has_rdoc = true rdoc_options << '--charset=UTF-8' if blank?(extra_rdoc_files) - self.extra_rdoc_files = FileList["README*", "ChangeLog*", "LICENSE*"] + self.extra_rdoc_files = FileList['README*', 'ChangeLog*', 'LICENSE*', 'TODO'] end end end lib/jeweler/specification.rb @@ -2,60 +2,222 @@ require 'test_helper' class TestSpecification < Test::Unit::TestCase def setup - remove_tmpdir! - path = File.join(FIXTURE_DIR, "existing-project-with-version-yaml") - Git.init(path) - FileUtils.cp_r path, tmp_dir - #breakpoint + @project = create_construct + end + def teardown + @project.destroy! + end - @spec = Gem::Specification.new - @spec.extend(Jeweler::Specification) - @spec.set_jeweler_defaults(tmp_dir) + def build_jeweler_gemspec(&block) + gemspec = if block + Gem::Specification.new(&block) + else + Gem::Specification.new() + end + gemspec.extend(Jeweler::Specification) + gemspec end - def teardown - remove_tmpdir! + context "basic defaults" do + setup do + @gemspec = build_jeweler_gemspec + end + + should "make files a FileList" do + assert_equal FileList, @gemspec.files.class + end + + should "make test_files a FileList" do + assert_equal FileList, @gemspec.test_files.class + end + + should "make extra_rdoc_files a FileList" do + assert_equal FileList, @gemspec.extra_rdoc_files.class + end + + should "enable rdoc" do + assert @gemspec.has_rdoc + end end + + context "there aren't any executables in the project directory" do + setup do + @project.directory 'bin' + end - context "Gem::Specification with Jeweler monkey-patches" do - context "when setting defaults" do - should_eventually "should populate `files'" do - # this implementation changed to use ruby-git - assert_equal %w{Rakefile VERSION.yml bin/foo_the_ultimate_bin lib/foo_the_ultimate_lib.rb }, @spec.files.sort + context "and there hasn't been any set on the gemspec" do + setup do + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@project) end - should "should populate `executables'" do - assert_equal %w{ foo_the_ultimate_bin }, @spec.executables + + should "have empty gemspec executables" do + assert_equal [], @gemspec.executables end + end - context "with values already set" do - setup do - @spec.files = %w{ hey_include_me_in_gemspec } - @spec.set_jeweler_defaults(fixture_dir) + context "and has been previously set executables" do + setup do + @gemspec = build_jeweler_gemspec do |gemspec| + gemspec.executables = %w(non-existant) end + @gemspec.set_jeweler_defaults(@project) + end - should "not re-populate `files'" do - assert_equal %w{ hey_include_me_in_gemspec }, @spec.files - 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 + end + + context "and there hasn't been any set on the gemspec" do + setup do + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@project) end - context "for rdoc" do - should "be enabled" do - assert @spec.has_rdoc + should "have the executables in the gemspec" do + assert_equal %w(burnination trogdor), @gemspec.executables + end + end + context "and has been previously set executables" do + setup do + @gemspec = build_jeweler_gemspec do |gemspec| + gemspec.executables = %w(burnination) end + @gemspec.set_jeweler_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 some files and is setup for git" do + setup do + @project.file 'Rakefile' + @project.directory('lib') do |lib| + lib.file 'example.rb' + end - should "be utf-8" do - assert @spec.rdoc_options.include?('--charset=UTF-8') + repo = Git.init(@project) + repo.add('.') + repo.commit('Initial commit') + + + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@project, @project) + end + + should "populate files from git" do + assert_equal %w(Rakefile lib/example.rb), @gemspec.files + 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) + repo.add('.') + repo.commit('Initial commit') + + + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@project, @project) + end + + should "populate files from git excluding ignored" do + assert_equal %w(.gitignore Rakefile lib/example.rb), @gemspec.files + 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.directory 'subproject' do |subproject| + subproject.directory('lib') do |lib| + lib.file 'subproject_example.rb' end end + + repo = Git.init(@project) + repo.add('.') + repo.commit('Initial commit') + + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@subproject, @project) + end + + should "populate files from git relative to sub directory" do + assert_equal %w(lib/subproject_example.rb).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 - should "allow the user to concat files to the existing `files' array" do - before = @spec.files.dup - @spec.files << 'extra' + @gemspec = build_jeweler_gemspec + @gemspec.set_jeweler_defaults(@project, @project) + end - assert_equal before + %w{ extra }, @spec.files + should "not populate files" do + assert_equal [], @gemspec.files.sort end end + + #context "Gem::Specification with Jeweler monkey-patches" do + # setup do + # remove_tmpdir! + # path = File.join(FIXTURE_DIR, "existing-project-with-version-yaml") + # Git.init(path) + # FileUtils.cp_r path, tmp_dir + + # @spec = Gem::Specification.new + # @spec.extend(Jeweler::Specification) + + # end + + # context "when setting defaults" do + # setup do + # @spec.set_jeweler_defaults(tmp_dir) + # end + + # should_eventually "should populate `files'" do + # assert_equal %w{Rakefile VERSION.yml bin/foo_the_ultimate_bin lib/foo_the_ultimate_lib.rb }, @spec.files.sort + # end + + # context "with values already set" do + # setup do + # @spec.files = %w{ hey_include_me_in_gemspec } + # @spec.set_jeweler_defaults(fixture_dir) + # end + + # should "not re-populate `files'" do + # assert_equal %w{ hey_include_me_in_gemspec }, @spec.files + # end + # end + # end + + #end end test/jeweler/test_specification.rb @@ -12,6 +12,8 @@ begin require 'shoulda' require 'rr' require 'redgreen' + require 'construct' + require 'git' rescue LoadError => e puts "*" * 80 puts "Some dependencies needed to run tests were missing. Run the following command to find them:" @@ -42,6 +44,7 @@ end class Test::Unit::TestCase include RR::Adapters::TestUnit unless include?(RR::Adapters::TestUnit) + include Construct::Helpers def tmp_dir TMP_DIR test/test_helper.rb 92dd67134b208440e70b7e9d058fe540a6ca7ed7 Joshua Nichols josh@technicalpickles.com http://github.com/technicalpickles/jeweler/commit/8872d6c8b102a9b1a2b4d0ca1c0f297d084b5093 8872d6c8b102a9b1a2b4d0ca1c0f297d084b5093 2009-11-01T17:35:11-08:00 2009-11-01T17:35:11-08:00 Cleaning up how the Jeweler::Specification tests are done, and started using construct for them. Also, code cleanup in Jeweler::Specification. c0afba9b0ecfd59a758a6e36ecfa7b9ecb8d0faf Joshua Nichols josh@technicalpickles.com