gemma 1.0.0 → 2.0.0

data/lib/gemma/rake_tasks/{test_unit_tasks.rb → minitest_tasks.rb}

@@ -1,14 +1,18 @@
 module Gemma
   class RakeTasks
     #
-    # Create tasks to run Test::Unit tests using the built-in (standard library)
-    # `test/unit`. By default, the `test_files` given in the gemspec are tested.
+    # Create tasks to run minitest tests. By default, the +require_paths+ from
+    # the gemspec and the gem's +test+ directory are placed on the load path,
+    # and the +test_files+ given in the gemspec are executed as tests.
+    #
+    # Minitest works on both 1.8 and 1.9, and it's mostly compatible with 
+    # <tt>Test::Unit</tt> tests.
     #
     # This plugin is based on the `Rake::TestTask` that comes bundled with rake.
     # If you need an option that isn't exposed by the plugin, you can modify the
     # `TestTask` object directly in a block passed to {#with_test_task}. 
     #
-    class TestUnitTasks < Plugin
+    class MinitestTasks < Plugin
       #
       # @param [Gem::Specification] gemspec
       #
@@ -61,16 +65,16 @@ module Gemma
         unless self.files.empty?
           require 'rake/testtask'
           Rake::TestTask.new(self.task_name) do |tt|
-            tt.libs        = gemspec.require_paths
+            tt.libs        = gemspec.require_paths.dup
+            tt.libs       << 'test'
             tt.test_files  = self.files
-            tt.warning     = true
+            tt.ruby_opts  << '-rubygems' << '-rbundler/setup'
             @with_test_task.call(tt) if @with_test_task
           end
         end
         nil
-      rescue LoadError
-        # Assume the test task is not installed.
       end
     end
   end
 end
+

data/lib/gemma/rake_tasks/plugin.rb

@@ -11,6 +11,8 @@ module Gemma
     # are generated.
     #
     class Plugin
+      include Rake::DSL
+
       def initialize gemspec
         @gemspec = gemspec
       end

data/lib/gemma/rake_tasks/rdoc_tasks.rb

@@ -1,3 +1,5 @@
+require 'rdoc/task'
+
 module Gemma
   class RakeTasks
     #
@@ -7,11 +9,8 @@ module Gemma
     # The default settings are based on the +require_paths+, +rdoc_options+ and
     # +extra_rdoc_files+ data in the gemspec. 
     #
-    # If an rdoc gem is installed, it will be used; otherwise, the built-in
-    # rdoc will be used (see {#use_gem_if_available}).
-    #
     # This plugin is based on the <tt>Rake::RDocTask</tt> that comes bundled
-    # with rake.  If you need an option that isn't exposed by the plugin, you
+    # with rdoc.  If you need an option that isn't exposed by the plugin, you
     # can modify the +RDocTask+ object directly in a block passed to
     # {#with_rdoc_task}. 
     #
@@ -23,7 +22,6 @@ module Gemma
         super(gemspec)
 
         # Defaults.
-        @use_gem_if_available = true
         @task_name = :rdoc
         @with_rdoc_task = nil
 
@@ -80,17 +78,6 @@ module Gemma
       #
       attr_accessor :template
 
-      #
-      # If an rdoc gem is installed, use it instead of the rdoc from the
-      # standard library (default true). 
-      #
-      # While rdoc is part of the ruby standard library, newer versions are
-      # available as gems.
-      # 
-      # @return [Boolean]
-      #
-      attr_accessor :use_gem_if_available
-
       #
       # Files and directories to be processed by rdoc; extracted from gemspec;
       # by default, these are the gem's +require_paths+ and +extra_rdoc_files+.
@@ -131,15 +118,6 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        if use_gem_if_available
-          begin
-            gem('rdoc')
-          rescue LoadError
-            # ignore -- just use the standard library one
-          end
-        end
-
-        require 'rake/rdoctask'
         Rake::RDocTask.new(self.task_name) do |rd|
           rd.rdoc_dir      = self.output
           rd.rdoc_files    = self.files
@@ -147,9 +125,9 @@ module Gemma
           rd.main          = self.main
           rd.template      = self.template
           rd.options       = self.options
-          rd.inline_source = false # doesn't seem to work on 1.8.7
           @with_rdoc_task.call(rd) if @with_rdoc_task
         end
+        CLOBBER.include(self.output)
 
         nil
       end

data/lib/gemma/rake_tasks/run_tasks.rb

@@ -3,13 +3,13 @@ module Gemma
     #
     # Run an executable script in the bin folder. 
     #
-    # There is one task per entry in the gemspec's +executables+ list.
-    # By default, warnings are enabled, the load path is set according to the
-    # +require_paths+ in the gemspec, and rubygems is included.
+    # There is one task per entry in the gemspec's +executables+ list. The
+    # executable is run with <tt>Kernel.exec</tt>. The result is equivalent to
+    # running <tt>bundler exec ...</tt>.
     #
     # To pass arguments to the script, you have to pass them as arguments to
     # the rake task. The syntax for quoting the arguments will depend on your
-    # shell, but on bash it might look like:
+    # shell, but on bash looks like:
     #
     #   rake my_prog['foo --bar=baz --bat=hi']
     #
@@ -23,7 +23,6 @@ module Gemma
         # Defaults.
         @task_prefix = ''
         @program_names = gemspec.executables.dup
-        @ruby_args = ['-w', "-I#{gemspec.require_paths.join(':')}", '-rubygems']
       end
 
       #
@@ -42,14 +41,6 @@ module Gemma
       # 
       attr_accessor :program_names
 
-      #
-      # Arguments to be passed to ruby; by default, warnings are enabled (-w)
-      # and the gemspec's +require_paths+ are on the load path (-I).
-      #
-      # @return [Array<String>]
-      #
-      attr_accessor :ruby_args
-
       #
       # Internal method; see {Plugin#create_rake_tasks}.
       #
@@ -58,11 +49,11 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        for program_name in program_names
+        program_names.each do |program_name|
           desc "run #{program_name}"
           task((task_prefix + program_name), :args) do |t, args|
-            args = (args[:args] || '').split(/\s/)
-            ruby(*(ruby_args + ["bin/#{program_name}"] + args))
+            program_args = Shellwords.shellsplit(args[:args] || '')
+            Kernel.exec(program_name, *program_args)
           end
         end
         nil

data/lib/gemma/rake_tasks/yard_tasks.rb

@@ -1,3 +1,5 @@
+require 'yard'
+
 module Gemma
   class RakeTasks
     #
@@ -128,7 +130,6 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        require 'yard'
         YARD::Rake::YardocTask.new do |yd|
           yd.name    = self.task_name
           yd.options = complete_options

data/lib/gemma/version.rb

@@ -1,3 +1,6 @@
 module Gemma
-  VERSION = '1.0.0'
+  VERSION_MAJOR = 2
+  VERSION_MINOR = 0
+  VERSION_PATCH = 0
+  VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
 end

data/template/base/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org" 
+gemspec
+

data/template/base/Rakefile.rb.erb

@@ -1,10 +1,7 @@
-begin
-  require 'rubygems'
-  require 'gemma'
+require 'rubygems'
+require 'bundler/setup'
+require 'gemma'
 
-  Gemma::RakeTasks.with_gemspec_file '<%= gem_name %>.gemspec'
-rescue LoadError
-  puts 'Install gemma (sudo gem install gemma) for more rake tasks.'
-end
+Gemma::RakeTasks.with_gemspec_file '<%= gem_name %>.gemspec'
 
 task :default => :test

data/template/base/gem_name.gemspec.erb

@@ -11,17 +11,16 @@ Gem::Specification.new do |s|
   s.authors           = ['TODO write your name']
   s.email             = ['TODO write your e-mail address']
   s.homepage          = 'TODO homepage'
-  s.summary           = %q{TODO write gem summary}
-  s.description       = %q{TODO write gem description}
+  s.summary           = %q{TODO write short gem summary}
+  s.description       = %q{TODO write longer gem description}
 
   s.rubyforge_project = '<%= gem_name %>'
 
-  #s.add_runtime_dependency '...'
-  s.add_development_dependency 'gemma', '>= <%= Gemma::VERSION %>', '<%=
-    gemma_version_requirement %>'
+  #s.add_runtime_dependency '...', '~> x.y.z'
+  s.add_development_dependency 'gemma', '~> <%= Gemma::VERSION %>'
 
   s.files       = Dir.glob('{lib,bin}/**/*.rb') + %w(README.rdoc)
-  s.test_files  = Dir.glob('test/test_*.rb')
+  s.test_files  = Dir.glob('test/<%= gem_name %>/*_test.rb')
   s.executables = Dir.glob('bin/*').map{|f| File.basename(f)}
 
   s.rdoc_options = [

data/template/base/lib/gem_name/version.rb.erb

@@ -1,3 +1,6 @@
 module <%= module_name %>
-  VERSION = '0.0.1'
+  VERSION_MAJOR = 0
+  VERSION_MINOR = 0
+  VERSION_PATCH = 1
+  VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
 end

data/template/executable/bin/gem_name.erb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env <%= RbConfig::CONFIG['ruby_install_name'] %>
 
 require '<%= gem_name %>'
 

data/template/{test_unit/test/test_gem_name.rb.erb → minitest/test/gem_name/gem_name_test.rb.erb}

@@ -1,5 +1,5 @@
-require "test/unit"
-require "<%= gem_name %>"
+require '<%= gem_name %>'
+require 'test/unit'
 
 class Test<%= module_name %> < Test::Unit::TestCase
   def test_<%= gem_name %>

data/test/gemma/gem_from_template_test.rb

@@ -0,0 +1,64 @@
+require 'gemma/test_helper'
+require 'tmpdir'
+
+class Gemma::GemFromTemplateTest < Test::Unit::TestCase
+  def setup
+    @tmp = Dir.mktmpdir('gemma')
+    @old_pwd = Dir.pwd
+    Dir.chdir(@tmp)
+  end
+
+  def teardown
+    Dir.chdir(@old_pwd)
+    FileUtils.remove_entry_secure @tmp
+  end
+
+  def test_create
+    #
+    # basic create-from-template tests
+    #
+    gt = Gemma::GemFromTemplate.new
+    gt.gem_name = "my_new_gem"
+    assert gt.good_gem_name?
+    
+    assert_equal "MyNewGem", gt.module_name
+    gt.module_name = "Foo" # override default
+    assert_equal "Foo", gt.module_name
+    gt.module_name = nil # revert back to default
+    assert_equal "MyNewGem", gt.module_name
+
+    assert_equal "my_new_gem", gt.dir_name
+    gt.dir_name = "bar" # override default
+    assert_equal "bar", gt.dir_name
+    gt.dir_name = nil # revert back to default
+    assert_equal "my_new_gem", gt.dir_name
+
+    template_paths = Gemma::GemFromTemplate::BUILTIN_TEMPLATES.map{|path|
+      File.join(Gemma::GemFromTemplate::TEMPLATE_ROOT,path)}
+    assert_equal 'base', File.basename(template_paths.first)
+
+    gt.dir_name = "my_new_gem_base"
+    gt.create_gem template_paths[0..0] # just base
+
+    gt.dir_name = "my_new_gem_full"
+    gt.create_gem template_paths # expand all templates
+  end
+
+  def test_todos
+    #
+    # we should be able to find the to-do markers in a newly created gem
+    #
+    gt = Gemma::GemFromTemplate.new
+    gt.gem_name = "test_gem"
+
+    template_paths = Gemma::GemFromTemplate::BUILTIN_TEMPLATES.map{|path|
+      File.join(Gemma::GemFromTemplate::TEMPLATE_ROOT,path)}
+    gt.create_gem template_paths
+
+    # look for some to-do markers
+    io = StringIO.new
+    Gemma::Utility.rgrep(/TODO/, gt.destination_path, io)
+    assert io.string =~ /README\.rdoc/
+  end
+end
+

data/test/gemma/gemma_new_test.rb

@@ -0,0 +1,121 @@
+require 'gemma/test_helper'
+require 'tmpdir'
+require 'open4'
+
+#
+# Run the 'gemma new' command and then run some basic commands to make sure that
+# things worked out.
+#
+class Gemma::GemmaNewTest < Test::Unit::TestCase
+  #
+  # Run a command in a bundler-free environment and capture both stdout and
+  # stderror output.
+  #
+  # We don't want to let our (gemma) bundler environment interfere with the
+  # bundler environment that we want to set up for the test gem, so we use
+  # bundler's +with_clean_env+ (which doesn't quite work yet in bundler 1.0, so
+  # we have to hack things a bit more than should be necessary)
+  #
+  # We also don't want to generate lots of confusing test output, so we capture
+  # stdout and stderr using Open4. (On 1.9.2, we can use <tt>Open3.popen2e</tt>,
+  # which is nicer, but Open3 on ruby 1.8.7 doesn't let us get exitstatus.)
+  #
+  def run_cmd *args
+    Bundler.with_clean_env {
+      # FIXME in bundler 1.1, this should not be necessary; see
+      # https://github.com/carlhuda/bundler/issues/1133
+      ENV.delete_if { |k,_| k[0,7] == 'BUNDLE_' }
+
+      # We also have to clear RUBYOPT, because Bundler::ORIGINAL_ENV in the test
+      # runner's process still contains some bundler stuff from rake's process.
+      # This suggests that we might have to stop using rake's built-in TestTask,
+      # and instead use one that runs the tests in a Bundler.with_clean_env
+      # block. However, it usually doesn't seem to make a difference, unless
+      # you're doing strange things like we are here.
+      ENV.delete('RUBYOPT')
+
+      output = nil
+      status = Open4.popen4(*args) {|pid,i,o,e|
+        i.close
+        output = o.read + e.read
+      }
+      [status, output]
+    }
+  end
+
+  def setup
+    # work in a temporary directory
+    @tmp = Dir.mktmpdir('gemma')
+    @old_pwd = Dir.pwd
+    Dir.chdir(@tmp)
+
+    # create a test gem; note that here we DO want the gemma bundler
+    # environment, because it puts our gemma executable on the bin path
+    output = `gemma new --name="test_gem"`
+    raise "gemma new failed:\n#{output}" unless $?.exitstatus
+
+    # we should get some TODOs from the template in the output
+    assert_match /TODO write your name/, output
+
+    Dir.chdir('test_gem')
+
+    # edit the test gem's Gemfile to point to this gemma
+    raise "no Gemfile in test gem" unless File.exists?('Gemfile')
+    File.open('Gemfile', 'a') do |f|
+      f.puts "gem 'gemma', :path => #{@old_pwd.dump}"
+    end
+
+    # run bundler on the test gem; it should find the same gems that we're using
+    # in the gemma bundle 
+    status, output = run_cmd('bundle', 'install', '--local')
+    raise "bundle failed:\n#{output}" unless status.exitstatus == 0
+
+    # it should say that it has loaded two things from source: gemma and the
+    # test_gem itself; if it doesn't it indicates that something strange
+    # happened with bundler's environment (or it may just break on future
+    # versions of bundler)
+    raise "did not load from source" unless output =~ /from source at/
+
+    # bundler should produce a lock file
+    raise "no Gemfile.lock in test gem" unless File.exists?('Gemfile.lock')
+  end
+
+  def teardown
+    Dir.chdir(@old_pwd)
+    FileUtils.remove_entry_secure @tmp
+  end
+
+  def test_rake
+    # list the rake tasks; this ensures that gemma loaded
+    status, output = run_cmd('rake -T')
+    assert_equal 0, status.exitstatus
+    assert_match /rake test/, output
+    assert_match /rake test_gem/, output
+    assert_match /rake rdoc/, output
+    assert_match /rake yard/, output
+
+    # run the tests; they should fail initially
+    status, output = run_cmd('rake')
+    assert_not_equal 0, status.exitstatus
+    assert_match /TODO write tests/, output
+
+    # run the executable; it should also fail
+    status, output = run_cmd('rake test_gem')
+    assert_not_equal 0, status.exitstatus
+    assert_match /TODO write program code/, output
+
+    # generate rdoc output
+    status, output = run_cmd('rake rdoc')
+    assert_equal 0, status.exitstatus
+
+    # generate yard output
+    status, output = run_cmd('rake yard')
+    assert_equal 0, status.exitstatus
+
+    # build the gem; this should fail, because we have invalid authors, etc.
+    status, output = run_cmd('rake build')
+    assert_match /TODO/, output # "... is not a valid author"
+    assert_equal 1, status.exitstatus
+  end
+end
+