gemma 0.0.2 → 1.0.0

data/lib/gemma/options.rb

@@ -1,4 +1,7 @@
 module Gemma
+  #
+  # Helpers for processing command line arguments.
+  #
   module Options
     #
     # @attr [String, nil] argument

data/lib/gemma/rake_tasks.rb

@@ -53,7 +53,11 @@ module Gemma
       block.call(self) if block_given?
 
       @plugins.values.each do |plugin|
-        plugin.create_rake_tasks
+        begin
+          plugin.create_rake_tasks
+        rescue 
+          warn "plugin #{plugin.class} failed: #{$!}"
+        end
       end
     end
 
@@ -88,6 +92,11 @@ module Gemma
     #
     def rdoc; @plugins[:rdoc] end
 
+    #
+    # @return [RunTasks]
+    #
+    def run; @plugins[:run] end
+
     #
     # @return [TestUnitTasks]
     #
@@ -98,23 +107,14 @@ module Gemma
     #
     def yard; @plugins[:yard] end
 
-    #
-    # @return [GemTasks]
-    #
-    #def gem; @plugins[:gem] end
-
     protected
 
     def create_default_plugins
       @plugins[:rcov] = Gemma::RakeTasks::RcovTasks.new(gemspec)
       @plugins[:rdoc] = Gemma::RakeTasks::RDocTasks.new(gemspec)
+      @plugins[:run]  = Gemma::RakeTasks::RunTasks.new(gemspec)
       @plugins[:test] = Gemma::RakeTasks::TestUnitTasks.new(gemspec)
       @plugins[:yard] = Gemma::RakeTasks::YardTasks.new(gemspec)
-
-      # not that helpful yet
-      # @plugins[:gem]  = Gemma::RakeTasks::GemTasks.new(gemspec,
-      #   gemspec_file_name)
     end
-
   end
 end

data/lib/gemma/rake_tasks/rcov_tasks.rb

@@ -19,6 +19,7 @@ module Gemma
         # Defaults.
         @task_name = :rcov
         @output = 'rcov'
+        @files = gemspec.test_files.dup
         @with_rcov_task = nil
       end
 
@@ -35,6 +36,13 @@ module Gemma
       # @return [String] 
       #
       attr_accessor :output
+
+      #
+      # The files to test; defaults to the +test_files+ from the gemspec.
+      #
+      # @return [Array<String>]    
+      # 
+      attr_accessor :files
    
       #
       # Customize the rcov task.
@@ -59,19 +67,18 @@ module Gemma
       # @private
       #
       def create_rake_tasks 
-        begin
-          require 'rcov/rcovtask'
-          Rcov::RcovTask.new(self.task_name) do |rcov|
-            rcov.libs       = gemspec.require_paths
-            rcov.test_files = gemspec.test_files
-            rcov.warning    = true
-            rcov.rcov_opts << "-x ^/"
-            rcov.output_dir = self.output
-            @with_rcov_task.call(rcov) if @with_rcov_task
-          end
-        rescue LoadError
-          # Assume rcov is not installed.
+        require 'rcov/rcovtask'
+        Rcov::RcovTask.new(self.task_name) do |rcov|
+          rcov.libs       = gemspec.require_paths
+          rcov.test_files = self.files
+          rcov.warning    = true
+          rcov.rcov_opts << "-x ^/"
+          rcov.output_dir = self.output
+          @with_rcov_task.call(rcov) if @with_rcov_task
         end
+        nil
+      rescue LoadError
+        # Assume rcov is not installed.
       end
     end
   end

data/lib/gemma/rake_tasks/rdoc_tasks.rb

@@ -1,19 +1,19 @@
 module Gemma
   class RakeTasks
     #
-    # Create tasks for generating `rdoc` API documentation with settings from
+    # Create tasks for generating +rdoc+ API documentation with settings from
     # the gemspec.
     #
-    # The default settings are based on the `files`, `rdoc_options` and
-    # `extra_rdoc_files` data in the gemspec. By default, test cases (which
-    # might be included in `files`) are not documented.
+    # 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.
+    # rdoc will be used (see {#use_gem_if_available}).
     #
-    # This plugin is based on the `Rake::RDocTask` that comes bundled with rake.
-    # 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}. 
+    # 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
+    # can modify the +RDocTask+ object directly in a block passed to
+    # {#with_rdoc_task}. 
     #
     class RDocTasks < Plugin
       #
@@ -38,8 +38,7 @@ module Gemma
         @title, @options = Options.extract(%w(-t --title), @options).to_a
         @template, @options = Options.extract(%w(-T --template), @options).to_a
 
-        # Don't include the test files by default.
-        @files = gemspec.files - gemspec.test_files
+        @files = gemspec.require_paths + gemspec.extra_rdoc_files
       end
 
       #
@@ -93,8 +92,8 @@ module Gemma
       attr_accessor :use_gem_if_available
 
       #
-      # Files to be processed by rdoc; extracted from gemspec; test files are
-      # not included by default.
+      # Files and directories to be processed by rdoc; extracted from gemspec;
+      # by default, these are the gem's +require_paths+ and +extra_rdoc_files+.
       #
       # @return [Array<String>] 
       #

data/lib/gemma/rake_tasks/run_tasks.rb

@@ -0,0 +1,73 @@
+module Gemma
+  class RakeTasks
+    #
+    # 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.
+    #
+    # 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:
+    #
+    #   rake my_prog['foo --bar=baz --bat=hi']
+    #
+    class RunTasks < Plugin
+      #
+      # @param [Gem::Specification] gemspec
+      #
+      def initialize gemspec
+        super(gemspec)
+
+        # Defaults.
+        @task_prefix = ''
+        @program_names = gemspec.executables.dup
+        @ruby_args = ['-w', "-I#{gemspec.require_paths.join(':')}", '-rubygems']
+      end
+
+      #
+      # The task names are formed by prepending this string onto each program
+      # name; defaults to the empty string.
+      #
+      # @return [String]    
+      # 
+      attr_accessor :task_prefix
+
+      #
+      # Names of the executable (file in the bin directory) to run; by default,
+      # contains the +executables+ from the gemspec.
+      #
+      # @return [Array<String>] may be empty
+      # 
+      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}.
+      #
+      # @return [nil]
+      #
+      # @private
+      #
+      def create_rake_tasks
+        for program_name in program_names
+          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))
+          end
+        end
+        nil
+      end
+    end
+  end
+end
+

data/lib/gemma/rake_tasks/test_unit_tasks.rb

@@ -17,16 +17,24 @@ module Gemma
 
         # Defaults.
         @task_name = :test
+        @files = gemspec.test_files.dup
         @with_test_task = nil
       end
 
       #
-      # Name of rake task used to generate these docs; defaults to test.
+      # Name of rake task used to run the test; defaults to test.
       #
       # @return [Symbol]    
       # 
       attr_accessor :task_name
 
+      #
+      # The files to test; defaults to the +test_files+ from the gemspec.
+      #
+      # @return [Array<String>]    
+      # 
+      attr_accessor :files
+
       #
       # Customize the test task.
       #
@@ -50,14 +58,18 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        require 'rake/testtask'
-        Rake::TestTask.new(self.task_name) do |tt|
-          tt.libs        = gemspec.require_paths
-          tt.test_files  = gemspec.test_files
-          tt.warning     = true
-          @with_test_task.call(tt) if @with_test_task
+        unless self.files.empty?
+          require 'rake/testtask'
+          Rake::TestTask.new(self.task_name) do |tt|
+            tt.libs        = gemspec.require_paths
+            tt.test_files  = self.files
+            tt.warning     = true
+            @with_test_task.call(tt) if @with_test_task
+          end
         end
         nil
+      rescue LoadError
+        # Assume the test task is not installed.
       end
     end
   end

data/lib/gemma/rake_tasks/yard_tasks.rb

@@ -4,24 +4,25 @@ module Gemma
     # Create tasks to generate documentation with yard (yardoc) if it is
     # available.
     #
-    # The files to document are extracted from the gemspec's `files` and
-    # `extra_rdoc_files` members.
+    # The gemspec's +require_paths+ and +extra_rdoc_files+ are documented by
+    # default.
     #
     # Unfortunately, yardoc's command line options are largely incompatible with
-    # those for rdoc, but the `--main` and `--title` options from `rdoc_options`
-    # are also passed through to yardoc by default. The short forms `-m` and
-    # `-t` of these arguments are also passed on as `--main` and `--title` to
-    # yardoc (note that `-m` and `-t` mean different things to yardoc than to
-    # rdoc!). Note that any files (that is, non-options) in `rdoc_options` are
-    # also ignored.
+    # those for rdoc, but the <tt>--main</tt> and <tt>--title</tt> options from
+    # +rdoc_options+ are passed through to yardoc by default. The short forms
+    # <tt>-m</tt> and <tt>-t</tt> of these arguments are also passed on as
+    # <tt>--main</tt> and <tt>--title</tt> to yardoc (note that <tt>-m</tt> and
+    # <tt>-t</tt> mean different things to yardoc than to rdoc!).  Note that any
+    # files (that is, non-options) in +rdoc_options+ are also ignored.
     #
     # If you want to further customize your yardoc output, you can add options
-    # in the {Gemma::RakeTasks.with_gemspec_file} configuration block.
+    # in the {Gemma::RakeTasks.with_gemspec_file} configuration block or use a
+    # <tt>.yardopts</tt> file.
     #
-    # This plugin is based on the `YARD::Rake::YardocTask` that comes bundled
-    # with yard.  If you need an option that isn't exposed by the plugin, you
-    # can modify the `YardocTask` object directly in a block passed to
-    # {#with_yardoc_task}. 
+    # This plugin is based on the <tt>YARD::Rake::YardocTask</tt> that comes
+    # bundled with yard.  If you need an option that isn't exposed by the
+    # plugin, you can modify the +YardocTask+ object directly in a block passed
+    # to {#with_yardoc_task}. 
     #
     class YardTasks < Plugin
       #
@@ -43,9 +44,8 @@ module Gemma
 
         @options = []
 
-        # Don't document the test files.
-        # Yard splits up the ruby files from the 'extra' files.
-        @files = gemspec.files - gemspec.test_files - gemspec.extra_rdoc_files
+        # Yard splits up the files from the 'extra' files.
+        @files = gemspec.require_paths.dup
         @extra_files = gemspec.extra_rdoc_files.dup
         @extra_files.delete(main) if main
       end
@@ -82,7 +82,7 @@ module Gemma
 
       #
       # Ruby files to be processed by yard; these are extracted from the
-      # gemspec; test files are not included by default.
+      # gemspec; by default these are the +require_paths+.
       #
       # @return [Array<String>] 
       #
@@ -128,21 +128,19 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        begin
-          require 'yard'
-          YARD::Rake::YardocTask.new do |yd|
-            yd.name    = self.task_name
-            yd.options = complete_options
-            yd.files   = self.files
-            yd.files.push('-', *self.extra_files) unless self.extra_files.empty?
-            @with_yardoc_task.call(yd) if @with_yardoc_task
-          end
-          CLOBBER.include(self.output)
-          CLOBBER.include('.yardoc')
-        rescue LoadError
-          # Assume yard is not installed.
+        require 'yard'
+        YARD::Rake::YardocTask.new do |yd|
+          yd.name    = self.task_name
+          yd.options = complete_options
+          yd.files   = self.files
+          yd.files.push('-', *self.extra_files) unless self.extra_files.empty?
+          @with_yardoc_task.call(yd) if @with_yardoc_task
         end
+        CLOBBER.include(self.output)
+        CLOBBER.include('.yardoc')
         nil
+      rescue LoadError
+        # Assume yard is not installed.
       end
 
       private 

data/lib/gemma/utility.rb

@@ -0,0 +1,41 @@
+module Gemma
+  module Utility
+    # 
+    # If the usage information for a script is documented in a comment block at
+    # the top of the file, this method prints it out. If there is a shebang
+    # (#!) on the first line, it is not printed.
+    #
+    def self.print_usage_from_file_comment file, comment_char='#', io=$stdout
+      lines = File.readlines(file)
+      lines.shift if lines.first =~ /^#!/ # ignore shebang
+      for line in lines
+        line.strip!
+        break unless line =~ /^#{comment_char}(.*)/
+        io.puts $1
+      end
+    end
+
+    #
+    # A very simple recursive grep.
+    #
+    # @param [Regexp] tag
+    #
+    # @param [String] path
+    #
+    # @param [IO] io
+    #
+    # @return [nil]
+    #
+    def self.rgrep tag, path, io=$stdout
+      Dir.chdir path do
+        (Dir["**/*"] + Dir["**/.*"]).select {|f| File.file? f}.sort.each do |f|
+          File.readlines(f).each_with_index do |line, i|
+            io.puts "#{f}:#{i}: #{line}" if line =~ tag
+          end
+        end
+      end
+      nil
+    end
+  end
+end
+

data/lib/gemma/version.rb

@@ -1,3 +1,3 @@
 module Gemma
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

data/template/base/.gitignore

@@ -0,0 +1,6 @@
+.*.swp
+pkg/*
+*.gem
+.bundle
+/rcov
+/rdoc

data/template/base/README.rdoc.erb

@@ -0,0 +1,49 @@
+= <%= gem_name %>
+
+* TODO url
+
+== SYNOPSIS
+
+TODO description
+
+=== Usage
+
+  TODO (code sample of usage)
+
+== REQUIREMENTS
+
+* TODO (list of requirements)
+
+== INSTALLATION
+
+  sudo gem install <%= gem_name %>
+
+== DEVELOPMENT
+
+TODO developer advice
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) <%= Time.new.strftime("%Y") %> TODO
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+