bones 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2007-12-28
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/bones
+data/History.txt.erb
+data/Manifest.txt
+data/README.txt.erb
+data/Rakefile.erb
+data/bin/NAME.erb
+data/lib/NAME.rb.erb
+data/spec/NAME_spec.rb
+data/tasks/annotations.rake
+data/tasks/doc.rake
+data/tasks/gem.rake
+data/tasks/manifest.rake
+data/tasks/rubyforge.rake
+data/tasks/setup.rb
+data/tasks/spec.rake
+data/tasks/test.rake
+data/test/test_NAME.rb
+lib/bones.rb
+tasks/annotations.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/test.rake

data/README.txt

@@ -0,0 +1,157 @@
+Mr Bones
+    by Tim Pease
+    http://codeforpeople.rubyforge.org/bones
+
+== DESCRIPTION:
+  
+Mr Bones is a handy tool that builds a skeleton for your new Ruby projects.
+The skeleton contains some starter code and a collection of rake tasks to
+ease the management and deployment of your source code. Mr Bones is not
+viral -- all the code your project needs is included in the skeleton (no
+gem dependency required).
+
+== FEATURES/PROBLEMS:
+
+Mr Bones provides the following rake tasks:
+
+  clobber              # Remove all build products
+  doc                  # Alias to doc:rdoc
+  doc:rdoc             # Build the rdoc HTML Files
+  doc:release          # Publish RDoc to RubyForge
+  doc:rerdoc           # Force a rebuild of the RDOC files
+  doc:ri               # Generate ri locally for testing
+  gem                  # Alias to gem:package
+  gem:debug            # Show information about the gem
+  gem:gem              # Build the gem file
+  gem:install          # Install the gem
+  gem:package          # Build all the packages
+  gem:release          # Package and upload to RubyForge
+  gem:repackage        # Force a rebuild of the package files
+  gem:uninstall        # Uninstall the gem
+  manifest:check       # Verify the manifest
+  manifest:create      # Create a new manifest
+  notes                # Enumerate all annotations
+  notes:fixme          # Enumerate all FIXME annotations
+  notes:optimize       # Enumerate all OPTIMIZE annotations
+  notes:todo           # Enumerate all TODO annotations
+  spec:rcov            # Run all specs with RCov
+  spec:run             # Run all specs with basic output
+  spec:specdoc         # Run all specs with text output
+  test:rcov            # Run rcov on the unit tests
+  test:run             # Run tests for run
+
+The rake tasks in the Mr Bones framework can be found in the "tasks"
+directory. Add your own tasks there when you need more functionality.
+
+== SYNOPSIS:
+
+To create a new "Get Fuzzy" project:
+
+  bones get_fuzzy
+
+If a new release of Mr Bones comes out with better features the "Get Fuzzy"
+project will need to be updated:
+
+  bones --update get_fuzzy
+
+And if you ever get confused about what Mr Bones can do:
+
+  bones --help
+
+== REQUIREMENTS:
+
+Mr Bones does not have any "requirements", but if you do not have the
+following gems installed you will not get all that Mr Bones has to offer.
+
+* rubyforge - for easy gem publishing to rubyforge.org
+* rcov - for code coverage testing
+* rspec - if that's the way you roll
+* rails - for source annotation extractor (notes)
+
+== INSTALL:
+
+* sudo gem install bones
+
+== MANUAL:
+
+The +bones+ command line tool is used to create a skeleton for a Ruby
+project. In that skeleton is a "tasks" directory that contains the Mr Bones
+rake files. These files are quite generic, and their functionality is
+controlled by options configured in the top-level Rakefile. Take a look at
+the Rakefile for the Mr Bones gem itself:
+
+  load 'tasks/setup.rb'
+
+  ensure_in_path 'lib'
+  require 'bones'
+
+  task :default => 'spec:run'
+
+  PROJ.name = 'bones'
+  PROJ.summary = 'Mr Bones is a handy tool that builds a skeleton for your new Ruby projects'
+  PROJ.authors = 'Tim Pease'
+  PROJ.email = 'not.real@fake.com'
+  PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
+  PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
+  PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+  PROJ.rubyforge_name = 'codeforpeople'
+  PROJ.rdoc_remote_dir = 'bones'
+  PROJ.version = Bones::VERSION
+
+  PROJ.exclude << '^doc'
+  PROJ.rdoc_exclude << '^data'
+
+  PROJ.spec_opts << '--color'
+
+  # EOF
+
+The +PROJ+ constant is an open struct that contains all the configuration
+options for the project. The open struct is created in the "tasks/setup.rb"
+file, and that is also where all the configurable options are defined. Take
+a look in the "setup.rb" file to see what options are available, but always
+make your changes in the Rakefile itself.
+
+The Mr Bones rake system is based on a "Manifest.txt" file that contains a
+list of all the files that will be used in the project. If a file does not
+appear in the manifest, it will not be included in the gem. Use the
++manifest+ rake tasks to create and update the manifest as needed.
+
+You can exclude files from being seen by the manifest -- the files are
+invisible to the Mr Bones rake tasks. You would do this for any subversion
+directories, backup files, or anything else you don't want gumming up the
+works. The files to exclude are given as an array of regular expression
+patterns.
+
+  PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn)
+  PROJ.exclude << '^doc'
+
+If your project depends on other gems, use the +depend_on+ command in your
+Rakefile to declare the dependency. If you do not specify a version, the
+most current version number for the installed gem is used.
+
+  depend_on 'logging'
+  depend_on 'rake', '0.7.3'
+
+== LICENSE:
+
+MIT License
+Copyright (c) 2007 - 2008
+
+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, sub-license, 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/Rakefile

@@ -0,0 +1,26 @@
+# $Id$
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'bones'
+
+task :default => 'spec:run'
+
+PROJ.name = 'bones'
+PROJ.summary = 'Mr Bones is a handy tool that builds a skeleton for your new Ruby projects'
+PROJ.authors = 'Tim Pease'
+PROJ.email = 'tim.pease@gmail.com'
+PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
+PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
+PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+PROJ.rubyforge_name = 'codeforpeople'
+PROJ.rdoc_remote_dir = 'bones'
+PROJ.version = Bones::VERSION
+
+PROJ.exclude << '^doc'
+PROJ.rdoc_exclude << '^data'
+
+PROJ.spec_opts << '--color'
+
+# EOF

data/bin/bones

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'bones'))
+Bones::Main.run ARGV
+
+# EOF

data/data/History.txt.erb

@@ -0,0 +1,4 @@
+== 1.0.0 / <%= Time.now.strftime("%Y-%m-%d") %>
+
+* 1 major enhancement
+  * Birthday!

data/data/README.txt.erb

@@ -0,0 +1,48 @@
+<%= name %>
+    by FIX (your name)
+    FIX (url)
+
+== DESCRIPTION:
+  
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+  
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+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/data/Rakefile.erb

@@ -0,0 +1,23 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require '<%= name %>'
+
+task :default => 'spec:run'
+
+PROJ.name = '<%= name %>'
+PROJ.summary = 'FIX'
+PROJ.authors = 'FIX'
+PROJ.email = 'FIX'
+PROJ.url = 'FIX'
+PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
+PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+PROJ.rubyforge_name = '<%= name %>'
+
+PROJ.spec_opts << '--color'
+
+# EOF

data/data/bin/NAME.erb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', '<%= name %>'))
+
+# Put your code here
+
+# EOF

data/data/lib/NAME.rb.erb

@@ -0,0 +1,7 @@
+# $Id$
+
+class <%= classname %>
+  VERSION = '1.0.0'
+end
+
+# EOF

data/data/tasks/annotations.rake

@@ -0,0 +1,29 @@
+# $Id$
+
+if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+
+desc "Enumerate all annotations"
+task :notes do
+  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+end
+
+namespace :notes do
+  desc "Enumerate all OPTIMIZE annotations"
+  task :optimize do
+    SourceAnnotationExtractor.enumerate "OPTIMIZE"
+  end
+
+  desc "Enumerate all FIXME annotations"
+  task :fixme do
+    SourceAnnotationExtractor.enumerate "FIXME"
+  end
+
+  desc "Enumerate all TODO annotations"
+  task :todo do
+    SourceAnnotationExtractor.enumerate "TODO"
+  end
+end
+
+end  # if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+
+# EOF

data/data/tasks/doc.rake

@@ -0,0 +1,47 @@
+# $Id$
+
+require 'rake/rdoctask'
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rd.main = PROJ.rdoc_main
+    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
+    rd.rdoc_dir = PROJ.rdoc_dir
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
+    files = PROJ.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    title = "#{PROJ.name}-#{PROJ.version} Documentation"
+    title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
+
+    rd.options << "-t #{title}"
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  desc 'Remove ri products'
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+# EOF

data/data/tasks/gem.rake

@@ -0,0 +1,87 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge_name
+
+    s.description = PROJ.description
+
+    PROJ.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.files
+    s.executables = PROJ.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = PROJ.rdoc_exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc_opts + ['--main', PROJ.rdoc_main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test_file
+      s.test_file = PROJ.test_file
+    else
+      s.test_files = PROJ.tests.to_a
+    end
+
+    # Do any extra stuff the user wants
+#   spec_extras.each do |msg, val|
+#     case val
+#     when Proc
+#       val.call(s.send(msg))
+#     else
+#       s.send "#{msg}=", val
+#     end
+#   end
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts PROJ.spec.to_ruby
+  end
+
+  Rake::GemPackageTask.new(PROJ.spec) do |pkg|
+    pkg.need_tar = PROJ.need_tar
+    pkg.need_zip = PROJ.need_zip
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, :package] do
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+# EOF