bones 2.0.3 → 2.1.0

data/History.txt

@@ -1,3 +1,14 @@
+== 2.1.0 / 2008-10-15
+
+* 1 major enhancement
+  - tasks can be used from the bones gem without having to create a
+    "tasks" folder in each project you create
+* 2 minor enhancements
+  - revmoved SVN $Id$ turds
+  - Mr Bones is now included by default as a development dependency
+* 1 bug fix
+  - changed the namespacing for the facets ANSICode class
+
 == 2.0.3 / 2008-07-02
 
 * 1 bug fix

data/Manifest.txt

@@ -11,34 +11,29 @@ data/bin/NAME.erb
 data/lib/NAME.rb.erb
 data/spec/NAME_spec.rb.erb
 data/spec/spec_helper.rb.erb
-data/tasks/ann.rake
-data/tasks/bones.rake
-data/tasks/gem.rake
-data/tasks/git.rake
-data/tasks/manifest.rake
-data/tasks/notes.rake
-data/tasks/post_load.rake
-data/tasks/rdoc.rake
-data/tasks/rubyforge.rake
-data/tasks/setup.rb
-data/tasks/spec.rake
-data/tasks/svn.rake
-data/tasks/test.rake
 data/test/test_NAME.rb
 lib/bones.rb
 lib/bones/annotation_extractor.rb
 lib/bones/debug.rb
 lib/bones/main.rb
 lib/bones/smtp_tls.rb
-tasks/ann.rake
-tasks/bones.rake
-tasks/gem.rake
-tasks/git.rake
-tasks/manifest.rake
-tasks/notes.rake
-tasks/post_load.rake
-tasks/rdoc.rake
-tasks/rubyforge.rake
-tasks/setup.rb
-tasks/spec.rake
-tasks/test.rake
+lib/bones/tasks/ann.rake
+lib/bones/tasks/bones.rake
+lib/bones/tasks/gem.rake
+lib/bones/tasks/git.rake
+lib/bones/tasks/manifest.rake
+lib/bones/tasks/notes.rake
+lib/bones/tasks/post_load.rake
+lib/bones/tasks/rdoc.rake
+lib/bones/tasks/rubyforge.rake
+lib/bones/tasks/setup.rb
+lib/bones/tasks/spec.rake
+lib/bones/tasks/svn.rake
+lib/bones/tasks/test.rake
+spec/bones/main_spec.rb
+spec/bones_spec.rb
+spec/data/data/README.txt
+spec/data/data/Rakefile
+spec/data/foo/README.txt
+spec/data/foo/Rakefile
+spec/spec_helper.rb

data/README.txt

@@ -10,73 +10,32 @@ 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).
 
-== VERSION 2.0.0 CHANGES:
+== VERSION 2.1.0 CHANGES:
 
-Version 2.0.0 of Mr Bones introduces backwards incompatibilities. Here is
-what you need to update in order for your current projects to work with
-this latest release.
+With my Mr Bones projects, I found myself constantly updating the tasks as new
+versions of Mr Bones were released. This quickly became annoying. Why not use
+the tasks from the Mr Bones gem and only copy those tasks to my own projects
+when they are packaged and released? That is the goal of this release of Mr
+Bones.
 
-Perform an update the tasks in your project directory:
-
-  bones -u your/project/directory
-
-The following .rake files have been renamed in Mr Bones 2.0.0 (the old
-name is on the left and the new name is on the right). You will need to
-delete the old version and use only the new version.
+Version 2.1.0 of Mr Bones allows your projects to use the rake tasks found
+in the Mr Bones gem but still remain independent from Mr Bones when
+deployed. This is accomplished by copying the rake tasks into your project
+only when it is packaged into a gem (or zip file or tarball).
 
-  doc.rake          => rdoc.rake
-  annotations.rake  => notes.rake
+You still have the option of copy the tasks to your local project when it is
+created. Or you can add tasks to your project at a later time.
 
-The PROJ openstruct has been amended to contain a collection of nested
-openstructs. This will affect any settings you might have in the
-top-level Rakefile for your project. Here is the translation key (old
-names on the left and new names on the right).
+So, if you have an exsiting project and you want to use the Mr Bones tasks,
+simply delete your "tasks" folder and put the following at the top of your
+Rakefile:
 
-  rubyforge_name        => rubyforge.name
-
-  specs                 => spec.files
-  spec_opts             => spec.opts
-
-  tests                 => test.files
-  test_file             => test.file
-  test_opts             => test.opts
-
-  rcov_dir              => rcov.dir
-  rcov_opts             => rcov.opts
-  rcov_threshold        => rcov.threshold
-  rcov_threshold_exact  => rcov.threshold_exact
-
-  rdoc_opts             => rdoc.opts
-  rdoc_include          => rdoc.include
-  rdoc_exclude          => rdoc.exclude
-  rdoc_main             => rdoc.main
-  rdoc_dir              => rdoc.dir
-  rdoc_remote_dir       => rdoc.remote_dir
-
-  dependencies          => gem.dependencies
-  executables           => gem.executables
-  extensions            => gem.extensions
-  files                 => gem.files
-  need_tar              => gem.need_tar
-  need_zip              => gem.need_zip
-  post_install_message  => gem.extras['post_install_message']
-
-  annotation_exclude    => notes.exclude
-  annotation_extensions => notes.extensions
-  annotation_tags       => notes.tags      
-
-  svn                   => svn.path
-  svn_root              => svn.root
-  svn_trunk             => svn.trunk
-  svn_tags              => svn.tags
-  svn_branches          => svn.branches
-
-  ann_file              => ann.file
-  ann_text              => ann.text
-  ann_paragraphs        => ann.paragraphs
-  ann_email             => ann.email     
-
-And of course, each name should be prepended with PROJ in your Rakefile.
+  begin
+    require 'bones'
+    Bones.setup
+  rescue LoadError
+    load 'tasks/setup.rb'   # this line should already be there
+  end
 
 == FEATURES:
 
@@ -94,9 +53,11 @@ Mr Bones provides the following rake tasks:
   doc:rerdoc        # Force a rebuild of the RDOC files
   doc:ri            # Generate ri locally for testing
   gem               # Alias to gem:package
+  gem:cleanup       # Cleanup the gem
   gem:debug         # Show information about the gem
   gem:install       # Install the gem
-  gem:package       # Build the gem file bones-1.3.4.gem
+  gem:package       # Build all the packages
+  gem:reinstall     # Reinstall the gem
   gem:release       # Package and upload to RubyForge
   gem:repackage     # Force a rebuild of the package files
   gem:uninstall     # Uninstall the gem
@@ -114,8 +75,6 @@ Mr Bones provides the following rake tasks:
   spec:run          # Run all specs with basic output
   spec:specdoc      # Run all specs with text output
   spec:verify       # Verify that rcov coverage is at least 90.0%
-  svn:create_tag    # Create a new tag in the SVN repository
-  svn:show_tags     # Show tags from the SVN repository
   test              # Alias to test:run
   test:rcov         # Run rcov on the unit tests
   test:run          # Run tests for run
@@ -129,12 +88,7 @@ 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:
+If you ever get confused about what Mr Bones can do:
 
   bones --help
 
@@ -160,7 +114,12 @@ 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'
+  begin
+    require 'bones'
+    Bones.setup
+  rescue LoadError
+    load 'tasks/setup.rb'
+  end
 
   ensure_in_path 'lib'
   require 'bones'
@@ -210,7 +169,7 @@ 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'
+  depend_on 'rake', '0.8.2'
 
 === Freezing a Skeleton
 
@@ -226,28 +185,31 @@ Typical uses of this feature would be to fill in user specific data like the
 author, e-mail address, etc. You can also add more default code to the skeleton
 project or your own ".rake" task files.
 
-==== Updating a Frozen Skeleton
+You can have multiple skeletons with different names. Your projects can be
+instantiated from any of these skeletons. Just supply a name when freezing:
 
-Just like a regular project, a frozen skeleton can be updated if a newer
-version of Mr Bones comes out with better features. Updating a frozen skeleton
-will only modify the tasks. All other files in the skeleton remain untouched.
+  bones --freeze foo
 
-  bones --freeze
+You can instantiate a project from the "foo" skeleton:
 
-The freeze command is used to update the skeleton tasks to the latest Mr Bones
-tasks. A copy of the current tasks are made in an "archive" directory in the
-".mrbones" directory. To revert back to the archive version, you will need to
-manually rename "archive" to "data" in the ".mrbones" directory.
+  bones --skeleton foo get_fuzzy
+
+The default skeleton name is "data". If no skeleton name is provided, then this
+is the skeleton that will be used.
 
 ==== Unfreezing a Skeleton
 
 Unfreezing a skeleton will remove your customized project skeleton from the
 ".mrbones" directory. The default Mr Bones project skeleton will be used
-instead. A copy of your custom skeleton is made in the "archive" directory of
+instead. A copy of your custom skeleton is stored in an archive directory of
 the ".mrbones" directory before it is removed.
 
   bones --unfreeze
 
+You can unfreeze named skeletons, too:
+
+  bones --unfreeze foo
+
 ==== Custom Modifications
 
 Mr Bones will perform a limited set of substitutions on the files in the
@@ -310,3 +272,72 @@ 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.
+
+
+== VERSION 2.0.0 CHANGES:
+
+Version 2.0.0 of Mr Bones introduces backwards incompatibilities. Here is
+what you need to update in order for your current projects to work with
+this latest release.
+
+Perform an update the tasks in your project directory:
+
+  bones -u your/project/directory
+
+The following .rake files have been renamed in Mr Bones 2.0.0 (the old
+name is on the left and the new name is on the right). You will need to
+delete the old version and use only the new version.
+
+  doc.rake          => rdoc.rake
+  annotations.rake  => notes.rake
+
+The PROJ openstruct has been amended to contain a collection of nested
+openstructs. This will affect any settings you might have in the
+top-level Rakefile for your project. Here is the translation key (old
+names on the left and new names on the right).
+
+  rubyforge_name        => rubyforge.name
+
+  specs                 => spec.files
+  spec_opts             => spec.opts
+
+  tests                 => test.files
+  test_file             => test.file
+  test_opts             => test.opts
+
+  rcov_dir              => rcov.dir
+  rcov_opts             => rcov.opts
+  rcov_threshold        => rcov.threshold
+  rcov_threshold_exact  => rcov.threshold_exact
+
+  rdoc_opts             => rdoc.opts
+  rdoc_include          => rdoc.include
+  rdoc_exclude          => rdoc.exclude
+  rdoc_main             => rdoc.main
+  rdoc_dir              => rdoc.dir
+  rdoc_remote_dir       => rdoc.remote_dir
+
+  dependencies          => gem.dependencies
+  executables           => gem.executables
+  extensions            => gem.extensions
+  files                 => gem.files
+  need_tar              => gem.need_tar
+  need_zip              => gem.need_zip
+  post_install_message  => gem.extras['post_install_message']
+
+  annotation_exclude    => notes.exclude
+  annotation_extensions => notes.extensions
+  annotation_tags       => notes.tags      
+
+  svn                   => svn.path
+  svn_root              => svn.root
+  svn_trunk             => svn.trunk
+  svn_tags              => svn.tags
+  svn_branches          => svn.branches
+
+  ann_file              => ann.file
+  ann_text              => ann.text
+  ann_paragraphs        => ann.paragraphs
+  ann_email             => ann.email     
+
+And of course, each name should be prepended with PROJ in your Rakefile.

data/Rakefile

@@ -1,16 +1,16 @@
-# $Id$
 
 $:.unshift('lib')
 
-load 'tasks/setup.rb'
 require 'bones'
+Bones.setup
 
 PROJ.name = 'bones'
 PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
 PROJ.version = Bones::VERSION
-PROJ.release_name = 'Haughty Hen'
+PROJ.release_name = 'Palimpsest'
+PROJ.ruby_opts = %w[-W0]
 
 PROJ.rubyforge.name = 'codeforpeople'
 
@@ -34,8 +34,7 @@ PROJ.ann.paragraphs = %w[install synopsis features requirements]
 PROJ.ann.text = <<-ANN
 == FUN FACT
 
-XML is much like violence --
-if it's not solving your problem then you are not using enough of it.
+A hen will lay one egg every 24 to 48 hours.
 
 == POST SCRIPT
 
@@ -45,12 +44,14 @@ TwP
 #{PROJ.gem.extras[:post_install_message]}
 ANN
 
-task :default => 'spec:run'
+task :default => 'spec:specdoc'
 task 'gem:package' => 'manifest:assert'
 task 'ann:prereqs' do
   PROJ.name = 'Mr Bones'
 end
 
+PROJ.gem.development_dependencies.clear
+
 depend_on 'rake'
 
 # EOF

data/data/Rakefile.erb

@@ -2,7 +2,12 @@
 # configured in this Rakefile. The .rake files in the tasks directory
 # are where the options are used.
 
-load 'tasks/setup.rb'
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  load 'tasks/setup.rb'
+end
 
 ensure_in_path 'lib'
 require '<%= name %>'
@@ -13,6 +18,7 @@ PROJ.name = '<%= name %>'
 PROJ.authors = 'FIXME (who is writing this software)'
 PROJ.email = 'FIXME (your e-mail)'
 PROJ.url = 'FIXME (project homepage)'
+PROJ.version = <%= classname %>::VERSION
 PROJ.rubyforge.name = '<%= name %>'
 
 PROJ.spec.opts << '--color'

data/data/bin/NAME.erb

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

data/data/lib/NAME.rb.erb

@@ -1,8 +1,3 @@
-# $Id$
-
-# Equivalent to a header guard in C/C++
-# Used to prevent the class/module from being loaded more than once
-unless defined? <%= classname %>
 
 module <%= classname %>
 
@@ -23,7 +18,7 @@ module <%= classname %>
   # <tt>File.join</tt>.
   #
   def self.libpath( *args )
-    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
   end
 
   # Returns the lpath for the module. If any arguments are given,
@@ -31,7 +26,7 @@ module <%= classname %>
   # <tt>File.join</tt>.
   #
   def self.path( *args )
-    args.empty? ? PATH : ::File.join(PATH, *args)
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
   end
 
   # Utility method used to rquire all files ending in .rb that lie in the
@@ -42,15 +37,13 @@ module <%= classname %>
   def self.require_all_libs_relative_to( fname, dir = nil )
     dir ||= ::File.basename(fname, '.*')
     search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+        ::File.join(::File.dirname(fname), dir, '*', '*.rb'))
 
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
 
 end  # module <%= classname %>
 
-<%= classname %>.require_all_libs_relative_to __FILE__
-
-end  # unless defined?
+<%= classname %>.require_all_libs_relative_to(__FILE__)
 
 # EOF