gemma 0.0.2 → 1.0.0

data/template/base/Rakefile.rb.erb

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

data/template/base/gem_name.gemspec.erb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+ 
+require '<%= gem_name %>/version'
+ 
+Gem::Specification.new do |s|
+  s.name              = '<%= gem_name %>'
+  s.version           = <%= module_name %>::VERSION
+  s.platform          = Gem::Platform::RUBY
+  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.rubyforge_project = '<%= gem_name %>'
+
+  #s.add_runtime_dependency '...'
+  s.add_development_dependency 'gemma', '>= <%= Gemma::VERSION %>', '<%=
+    gemma_version_requirement %>'
+
+  s.files       = Dir.glob('{lib,bin}/**/*.rb') + %w(README.rdoc)
+  s.test_files  = Dir.glob('test/test_*.rb')
+  s.executables = Dir.glob('bin/*').map{|f| File.basename(f)}
+
+  s.rdoc_options = [
+    "--main",    "README.rdoc",
+    "--title",   "#{s.full_name} Documentation"]
+  s.extra_rdoc_files << "README.rdoc"
+end
+

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

@@ -0,0 +1,5 @@
+require '<%= gem_name %>/version'
+
+module <%= module_name %>
+  # TODO write code 
+end

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

@@ -0,0 +1,3 @@
+module <%= module_name %>
+  VERSION = '0.0.1'
+end

data/template/executable/bin/gem_name.erb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require '<%= gem_name %>'
+
+abort "TODO write program code"
+

data/template/test_unit/test/test_gem_name.rb.erb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "<%= gem_name %>"
+
+class Test<%= module_name %> < Test::Unit::TestCase
+  def test_<%= gem_name %>
+    assert_equal 3, 1 + 1, "TODO write tests"
+  end
+end
+

data/test/test_gemma.rb

@@ -4,12 +4,13 @@ require "gemma"
 require "set"
 
 class TestGemma < Test::Unit::TestCase
+  # Can load empty spec.
   def test_empty_spec
     s = Gem::Specification.new
     Gemma::RakeTasks.new(s)
   end
 
-  def test_rdoc
+  def test_rdoc_tasks
     s = Gem::Specification.new
     s.files = %w(lib/a.rb lib/b.rb)
     s.test_files = %w(test/test_a.rb test/test_a.rb)
@@ -17,8 +18,7 @@ class TestGemma < Test::Unit::TestCase
     s.extra_rdoc_files = ['README.md', 'FAQ']
 
     Gemma::RakeTasks.new(s) do |g|
-      assert_equal %w(lib/a.rb lib/b.rb README.md FAQ).to_set,
-        g.rdoc.files.to_set
+      assert_equal %w(lib FAQ README.md).to_set, g.rdoc.files.to_set
       assert_equal [], g.rdoc.options
       assert_equal 'README.md', g.rdoc.main
       assert_equal nil, g.rdoc.title
@@ -29,7 +29,18 @@ class TestGemma < Test::Unit::TestCase
     end
   end
 
-  def test_yard
+  def test_run_tasks
+    s = Gem::Specification.new
+    s.files = %w(lib/a.rb)
+    s.executables = %w(a b)
+    s.test_files = %w(test/test_a.rb)
+
+    Gemma::RakeTasks.new(s) do |g|
+      assert_equal %w(a b).to_set, g.run.program_names.to_set
+    end
+  end
+
+  def test_yard_tasks
     s = Gem::Specification.new
     s.files = %w(lib/a.rb)
     s.test_files = %w(test/test_a.rb)
@@ -40,7 +51,7 @@ class TestGemma < Test::Unit::TestCase
     # A file should not be passed as an extra file if it's the --main file.
     # Test files should not be documented.
     Gemma::RakeTasks.new(s) do |g|
-      assert_equal %w(lib/a.rb), g.yard.files
+      assert_equal %w(lib), g.yard.files
       assert_equal [], g.yard.extra_files
       assert_equal 'README.rdoc', g.yard.main
       assert_equal [], g.yard.options
@@ -49,7 +60,7 @@ class TestGemma < Test::Unit::TestCase
       assert_equal nil, g.yard.title
 
       g.yard.with_yardoc_task do |yd|
-        assert_equal %w(lib/a.rb), yd.files
+        assert_equal %w(lib), yd.files
         assert_equal 4, yd.options.size
         assert_equal 'README.rdoc',
           Gemma::Options.extract(%w(--main), yd.options).argument
@@ -61,7 +72,7 @@ class TestGemma < Test::Unit::TestCase
     # Add some extra files (that aren't the --main file).
     s.extra_rdoc_files << 'FAQ'
     Gemma::RakeTasks.new(s) do |g|
-      assert_equal %w(lib/a.rb), g.yard.files
+      assert_equal %w(lib), g.yard.files
       assert_equal %w(FAQ), g.yard.extra_files
       assert_equal 'README.rdoc', g.yard.main
       assert_equal [], g.yard.options
@@ -70,14 +81,14 @@ class TestGemma < Test::Unit::TestCase
     # Make sure extra options are ignored.
     s.rdoc_options = ['--main', 'README.rdoc', '--diagram']
     Gemma::RakeTasks.new(s) do |g|
-      assert_equal %w(lib/a.rb), g.yard.files
+      assert_equal %w(lib), g.yard.files
       assert_equal %w(FAQ), g.yard.extra_files
       assert_equal 'README.rdoc', g.yard.main
       assert_equal [], g.yard.options
     end
     s.rdoc_options = ['--diagram', '--main', 'README.rdoc']
     Gemma::RakeTasks.new(s) do |g|
-      assert_equal %w(lib/a.rb), g.yard.files
+      assert_equal %w(lib), g.yard.files
       assert_equal %w(FAQ), g.yard.extra_files
       assert_equal 'README.rdoc', g.yard.main
       assert_equal [], g.yard.options
@@ -92,7 +103,7 @@ class TestGemma < Test::Unit::TestCase
       assert_equal [], g.yard.options
 
       g.yard.with_yardoc_task do |yd|
-        assert_equal %w(lib/a.rb - FAQ), yd.files
+        assert_equal %w(lib - FAQ), yd.files
         assert_equal 6, yd.options.size
         assert_equal 'README.rdoc',
           Gemma::Options.extract(%w(--main), yd.options).argument
@@ -104,7 +115,7 @@ class TestGemma < Test::Unit::TestCase
     end
   end
 
-  def test_test_unit
+  def test_test_unit_tasks
     s = Gem::Specification.new
     s.files = %w(lib/a.rb lib/b.rb)
     s.test_files = %w(test/test_a.rb test/test_b.rb)
@@ -119,7 +130,7 @@ class TestGemma < Test::Unit::TestCase
     end
   end
 
-  def test_rcov
+  def test_rcov_tasks
     s = Gem::Specification.new
     s.files = %w(lib/a.rb lib/b.rb)
     s.test_files = %w(test/test_a.rb test/test_b.rb)
@@ -133,5 +144,46 @@ class TestGemma < Test::Unit::TestCase
       end
     end
   end
+
+  def test_conventions_good_gem_name
+    assert  Gemma::Conventions.good_gem_name?("my_gem_name")
+    assert  Gemma::Conventions.good_gem_name?("my-gem-name")
+    assert  Gemma::Conventions.good_gem_name?("foo")
+    assert  Gemma::Conventions.good_gem_name?("foo1")
+    assert  Gemma::Conventions.good_gem_name?("foo_4_bar")
+    assert !Gemma::Conventions.good_gem_name?("Foo")
+    assert !Gemma::Conventions.good_gem_name?("FooBar")
+    assert !Gemma::Conventions.good_gem_name?("Foo_Bar")
+    assert !Gemma::Conventions.good_gem_name?("Foo-Bar")
+  end
+
+  def test_conventions_gem_name_to_module_name
+    assert_equal 'MyGem',
+      Gemma::Conventions.gem_name_to_module_name("my_gem")
+    assert_equal 'MyGem3',
+      Gemma::Conventions.gem_name_to_module_name("my_gem3")
+    assert_equal 'A4B',
+      Gemma::Conventions.gem_name_to_module_name("a_4_b")
+    assert_equal 'A4b',
+      Gemma::Conventions.gem_name_to_module_name("a4b")
+  end
+
+  #
+  # Exercise usage message for bin/gemma.
+  #
+  def test_print_usage
+    gemma_file = File.join(File.dirname(__FILE__), '..', 'bin', 'gemma')
+    io = StringIO.new
+    Gemma::Utility.print_usage_from_file_comment gemma_file, '#', io
+    assert io.string =~ /gemma/
+  end
+
+  def test_plugin_abstract
+    s = Gem::Specification.new
+    plugin = Gemma::RakeTasks::Plugin.new(s)
+    assert_raise(NotImplementedError) {
+      plugin.create_rake_tasks # abstract method
+    }
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gemma
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - John Lees-Miller
@@ -15,35 +15,72 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 +01:00
+date: 2010-12-06 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id001
 description: |
-  If you are using .gemspecs as intended
-  (http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/), gemma generates
-  common rake tasks with default settings extracted from your .gemspec file.
+  Gemma is a gem development helper like hoe and jeweler, but it keeps the
+  gemspec in a gemspec file, where it belongs, instead of in your Rakefile.
+  This helps your gem to play nicely with commands like gem and bundle, and it
+  allows gemma to provide rake tasks with sensible defaults for many common gem
+  development tasks.
 
 email: 
 - jdleesmiller@gmail.com
-executables: []
-
+executables: 
+- gemma
 extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- bin/gemma
 files: 
-- lib/gemma/rake_tasks/gem_tasks.rb
+- lib/gemma.rb
+- lib/gemma/options.rb
+- lib/gemma/gem_from_template.rb
+- lib/gemma/conventions.rb
+- lib/gemma/rake_tasks/test_unit_tasks.rb
+- lib/gemma/rake_tasks/rdoc_tasks.rb
 - lib/gemma/rake_tasks/rcov_tasks.rb
+- lib/gemma/rake_tasks/run_tasks.rb
 - lib/gemma/rake_tasks/yard_tasks.rb
-- lib/gemma/rake_tasks/rdoc_tasks.rb
-- lib/gemma/rake_tasks/test_unit_tasks.rb
 - lib/gemma/rake_tasks/plugin.rb
-- lib/gemma/options.rb
-- lib/gemma/rake_tasks.rb
 - lib/gemma/version.rb
-- lib/gemma.rb
+- lib/gemma/rake_tasks.rb
+- lib/gemma/utility.rb
+- template/base/.gitignore
+- template/base/Rakefile.rb.erb
+- template/base/README.rdoc.erb
+- template/base/gem_name.gemspec.erb
+- template/base/lib/gem_name.rb.erb
+- template/base/lib/gem_name/version.rb.erb
+- template/executable/bin/gem_name.erb
+- template/test_unit/test/test_gem_name.rb.erb
 - README.rdoc
+- bin/gemma
 - test/test_options.rb
 - test/test_gemma.rb
 has_rdoc: true
@@ -54,6 +91,8 @@ post_install_message:
 rdoc_options: 
 - --main
 - README.rdoc
+- --title
+- gemma-1.0.0 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -80,7 +119,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Generate helpful rake tasks from your gemspec.
+summary: Gemspec-centric gem development helper.
 test_files: 
 - test/test_options.rb
 - test/test_gemma.rb

data/lib/gemma/rake_tasks/gem_tasks.rb

@@ -1,74 +0,0 @@
-module Gemma
-  class RakeTasks
-    #
-    # Create tasks to build and release (push) gems.
-    #
-    # TODO not done yet
-    #
-    class GemTasks < Plugin
-      #
-      # @param [Gem::Specification] gemspec
-      # @param [String, nil] gemspec_file_name
-      #
-      def initialize gemspec, gemspec_file_name
-        super(gemspec)
-
-        @gemspec_file_name = gemspec_file_name
-
-        # Defaults.
-        @output = 'pkg'
-      end
-
-      #
-      # Name of the gemspec file to be built; if this is nil, no gem tasks are
-      # generated. 
-      #
-      # @return [String, nil] 
-      #
-      attr_accessor :gemspec_file_name
-
-      #
-      # Name of directory in which gem files are placed; defaults to pkg.
-      #
-      # @return [String]
-      #
-      attr_accessor :output
-
-      #
-      # Full path to gem file.
-      #
-      # @return [String]
-      #
-      def gem_file
-        File.join(output, gemspec.file_name)
-      end
-
-      #
-      # Internal method; see {Plugin#create_rake_tasks}.
-      #
-      # @return [nil]
-      #
-      # @private
-      #
-      def create_rake_tasks
-        if gemspec_file_name
-          directory output
-
-          desc "gem build"
-          task :build => output do
-            sh "gem build #{gemspec_file_name}"
-            mv gemspec.file_name, gem_file
-          end
-          CLOBBER.include(gem_file)
-           
-          desc "gem release"
-          task :release => :build do
-            sh "gem push #{gem_file}"
-          end
-        end
-
-        nil
-      end
-    end
-  end
-end