toe 0.4.0

data/History

@@ -0,0 +1,3 @@
+== 0.4.0 / 2010-05-02
+
+Release with updates to work with Tap > 1.0.

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2010, Simon Chiang
+
+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.

data/README

@@ -0,0 +1,19 @@
+= Toe
+
+Project management tasks
+
+== Description
+
+Toe provides boilerplate management tasks for ruby projects, for example test
+and gem packaging tasks. Use like any {Tap}[http://tap.rubyforge.org] tasks.
+
+== Installation
+
+Available as a gem from Gemcutter[http://gemcutter.org/gems/toe].
+
+  % gem install toe
+
+== Info
+
+Copyright (c) 2009-2010, Simon Chiang
+License:: {MIT-Style}[link:files/MIT-LICENSE.html]

data/lib/toe.rb

@@ -0,0 +1,2 @@
+require 'toe/manifest'
+require 'toe/test'

data/lib/toe/gem.rb

@@ -0,0 +1,21 @@
+require 'toe/gem_task'
+require 'fileutils'
+
+module Toe
+  # ::task package a gem
+  class Gem < GemTask
+    
+    config :output_dir, 'pkg', :short => :o  # Output directory
+    
+    def process(path=default_path)
+      unless File.directory?(output_dir)
+        FileUtils.mkdir_p(output_dir)
+      end
+    
+      path = ::Gem::Builder.new(gemspec(path)).build
+      FileUtils.mv(path, File.join(output_dir, File.basename(path)))
+    
+      path
+    end
+  end
+end

data/lib/toe/gem_task.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'tap/task'
+
+module Toe
+  class GemTask < Tap::Task
+    def default_path
+      File.expand_path("#{File.basename(Dir.pwd)}.gemspec")
+    end
+    
+    def gemspec(path)
+      unless File.exists?(path)
+        raise "no such gemspec: #{path}"
+      end
+    
+      eval(File.read(path), TOPLEVEL_BINDING, path)
+    end
+  end
+end

data/lib/toe/manifest.rb

@@ -0,0 +1,36 @@
+require 'toe/gem_task'
+
+module Toe
+  # ::task prints files for a manifest
+  class Manifest < GemTask
+    
+    config :omit, %w{^rdoc ^pkg ^test}, &c.list(&c.regexp)
+    
+    def process(path=default_path)
+      
+      # collect files from the gemspec, labeling 
+      # with true or false corresponding to the
+      # file existing or not
+      files = gemspec(path).files.inject({}) do |files, file|
+        files[File.expand_path(file)] = [File.exists?(file), file]
+        files
+      end
+
+      # gather non-rdoc/pkg files for the project
+      # and add to the files list if they are not
+      # included already (marking by the absence
+      # of a label)
+      Dir.glob("**/*").each do |file|
+        next if File.directory?(file) || omit.any? {|pattern| file =~ pattern }
+
+        path = File.expand_path(file)
+        files[path] = ["", file] unless files.has_key?(path)
+      end
+
+      # sort and output the results
+      files.values.sort_by {|exists, file| file }.each do |entry| 
+        puts "%-5s %s" % entry
+      end
+    end
+  end
+end

data/lib/toe/rdoc.rb

@@ -0,0 +1,46 @@
+require 'toe/gem_task'
+require 'rdoc/rdoc'
+require 'cdoc'
+
+module Toe
+  # :startdoc::task generate rdoc
+  class Rdoc < GemTask
+    
+    config :output_dir, 'rdoc', :short => :o, &c.string_or_nil   # Output directory
+    config :force, false, &c.flag                                # Force rebuild
+    config :cdoc, true, &c.switch                                # Use cdoc template
+    
+    def options
+      opts = []
+      
+      if output_dir
+        opts << '--op'
+        opts << output_dir
+      end
+      
+      if cdoc
+        opts.concat %w{
+          --fmt cdoc 
+          --template cdoc/cdoc_html_template
+        }
+      end
+      
+      if force
+        opts << '--force-update'
+      end
+      
+      opts
+    end
+    
+    def process(path=default_path)
+      spec = gemspec(path)
+
+      files = spec.files.select {|file|
+        file =~ /lib.*\.rb$/
+      } + spec.extra_rdoc_files
+      
+      args = options + spec.rdoc_options + files.uniq
+      RDoc::RDoc.new.document(args)
+    end
+  end
+end

data/lib/toe/setup/gh_pages.rb

@@ -0,0 +1,55 @@
+require 'tap/task'
+
+module Toe
+  module Setup
+    # :startdoc::task setup github pages
+    #
+    # GitHub Pages are about the easiest way to put up documentation possible.
+    # This task sets up github pages a-la the instructions that appear when
+    # you visit your project homepage before pages is set up:
+    #
+    #   yourname.github.com/project
+    #
+    # Caution: make your working directory clean before you do this (either
+    # stash or commit), otherwise this will LOSE any changes you've made to
+    # your project since the last commit. 
+    #
+    #   % tap setup/gh_pages
+    #
+    # Subsequent to this task, your working directory will be empty and you
+    # will be on the gh-pages branch.  Add content and push to github:
+    #
+    #   echo "My GitHub Page" > index.html
+    #   git add .
+    #   git commit -a -m "First pages commit"
+    #   git push origin gh-pages
+    #
+    # The documentation should be updated in about a minute.
+    class GhPages < Tap::Task
+      include Tap::Utils
+      
+      config :clean, false, &c.flag      # Remove all files
+      
+      def process
+        unless File.exists?(".git")
+          raise "cannot setup pages, not a git repository"
+        end
+        
+        sh "git symbolic-ref HEAD refs/heads/gh-pages"
+        
+        if File.exists?(".git/index")
+          sh "rm .git/index"
+        end
+        
+        if clean
+          sh "git clean -fdx"
+        end
+      end
+      
+      def sh(*cmd)
+        log :sh, cmd.join(' ')
+        super
+      end
+    end 
+  end
+end

data/lib/toe/test.rb

@@ -0,0 +1,84 @@
+require 'tap/task'
+
+module Toe
+  # :startdoc::task a testing task
+  #
+  # The Tap version of Rake::TestTask, shamelessly adapted from the original.
+  # The default test command is:
+  #
+  #   % ruby -w -Ilib -e 'ARGV.each{|f| load f}' TEST_FILES...
+  # 
+  # Where the test files are all files matching 'test/**/*_test.rb'.  The options
+  # can be used to specify other options, lib paths, globs, filters, and even
+  # multiple interpreters.
+  #
+  class Test < Tap::Task
+    include Tap::Utils
+    
+    # The command to launch a ruby interpreter.  Multiple
+    # commands many be specified for multiple interpreters.
+    config :cmds, ["ruby"], :long => :cmd, &c.list                  # Commands to launch a ruby interpreter
+
+    # Array of options to pass to each cmd.
+    config :opts, ["w"], :long => :opt, &c.list                     # Options to the ruby interpreter
+
+    # List of directories to added to $LOAD_PATH before 
+    # running the tests.
+    config :libs, ['lib'], :long => :lib, :short => :I, &c.list     # Specify the test libraries
+
+    # Note that the default pattern reflects modern
+    # test naming conventions.
+    config :globs, ["test/**/*_test.rb"], :long => :glob, &c.list   # Globs to auto-discover test files
+
+    # Filters test files, useful for only testing
+    # a subset of all tests.  Test files are always
+    # filtered, even when manually specified.
+    config :filter, ".", &c.regexp                                  # A regexp filter of test files
+
+    # Iterates over test files to launch them one by one.
+    config :iterate, false, &c.switch                               # Iteratively runs test files
+
+    # Code to load the test files, by default a simple one-liner:
+    #
+    #   -e 'ARGV.each{|f| load f}'
+    #
+    def load_code
+      "-e 'ARGV.each{|f| load f}'"
+    end
+
+    def process(*args)
+    
+      # construct the command options
+      options = [load_code]
+      opts.each {|opt|  options << (opt[0] == ?- ? opt : "-#{opt}") }
+      libs.each {|path| options << "-I\"#{File.expand_path(path)}\"" }
+      options = options.join(" ")
+  
+      # select test files
+      files = globs.collect do |glob|
+        Dir.glob(glob).select do |path|
+          File.file?(path) && path =~ filter
+        end
+      end.flatten!
+  
+      if files.empty?
+        log :warn, "no files found for: #{globs.inspect}", Logger::WARN
+      end
+  
+      files.collect! {|path| "\"#{path}\""}
+      files = [files.join(' ')] unless iterate
+  
+      # launch each test
+      files.each do |path|
+        cmds.each do |cmd|
+          sh(cmd, options, path)
+        end
+      end
+    end
+    
+    def sh(*cmd)
+      log :sh, cmd.join(' ')
+      super
+    end
+  end
+end

data/lib/toe/version.rb

@@ -0,0 +1,7 @@
+module Toe
+  MAJOR = 0
+  MINOR = 4
+  TINY = 0
+
+  VERSION="#{MAJOR}.#{MINOR}.#{TINY}"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: toe
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Simon Chiang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tap-gen
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: simon.a.chiang@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History
+- README
+- MIT-LICENSE
+files: 
+- lib/toe.rb
+- lib/toe/gem.rb
+- lib/toe/gem_task.rb
+- lib/toe/manifest.rb
+- lib/toe/rdoc.rb
+- lib/toe/setup/gh_pages.rb
+- lib/toe/test.rb
+- lib/toe/version.rb
+- tap.yml
+- History
+- README
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://tap.rubyforge.org/toe/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+- -S
+- -N
+- --title
+- Toe
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tap
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A tap development suite
+test_files: []
+