bones 2.2.0 → 2.3.0

data/History.txt

@@ -1,3 +1,8 @@
+== 2.3.0 / 2009-01-25
+
+* 1 minor enhancement
+  - removed the need for a Manifest.txt file
+
 == 2.2.0 / 2009-01-01
 
 * 4 minor enhancements

data/README.rdoc

@@ -10,33 +10,6 @@ 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.1.0 CHANGES:
-
-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.
-
-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).
-
-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.
-
-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:
-
-  begin
-    require 'bones'
-    Bones.setup
-  rescue LoadError
-    load 'tasks/setup.rb'   # this line should already be there
-  end
-
 == FEATURES:
 
 Mr Bones provides the following rake tasks:
@@ -64,9 +37,6 @@ Mr Bones provides the following rake tasks:
   gem:uninstall     # Uninstall the gem
   git:create_tag    # Create a new tag in the Git repository
   git:show_tags     # Show tags from the Git repository
-  manifest          # Alias to manifest:check
-  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
@@ -76,6 +46,8 @@ 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
@@ -368,3 +340,31 @@ names on the left and new names on the right).
   ann_email             => ann.email     
 
 And of course, each name should be prepended with PROJ in your Rakefile.
+
+== VERSION 2.1.0 CHANGES:
+
+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.
+
+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).
+
+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.
+
+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:
+
+  begin
+    require 'bones'
+    Bones.setup
+  rescue LoadError
+    load 'tasks/setup.rb'   # this line should already be there
+  end
+

data/Rakefile

@@ -9,9 +9,11 @@ PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
 PROJ.version = Bones::VERSION
-PROJ.release_name = 'Distal Phalanges'
+PROJ.release_name = 'Calcaneus'
 PROJ.ruby_opts = %w[-W0]
 PROJ.readme_file = 'README.rdoc'
+PROJ.ignore_file = '.gitignore'
+PROJ.exclude << 'bones.gemspec'
 
 PROJ.rubyforge.name = 'codeforpeople'
 
@@ -35,7 +37,7 @@ PROJ.ann.paragraphs = %w[install synopsis features requirements]
 PROJ.ann.text = <<-ANN
 == FUN FACT
 
-"Tom Sawyer" was the first novel written on a typewriter.
+Twenty-five percent of a human's bones are in its feet.
 
 == POST SCRIPT
 
@@ -46,7 +48,6 @@ TwP
 ANN
 
 task :default => 'spec:specdoc'
-task 'gem:package' => 'manifest:assert'
 task 'ann:prereqs' do
   PROJ.name = 'Mr Bones'
 end

data/data/.bnsignore

@@ -0,0 +1,12 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/lib/bones.rb

@@ -2,7 +2,7 @@
 module Bones
 
   # :stopdoc:
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'

data/lib/bones/annotation_extractor.rb

@@ -51,9 +51,8 @@ class AnnotationExtractor
     end
   end
 
-  # Iterate over all the files in the project manifest and extract
-  # annotations from the those files. Returns the results as a hash for
-  # display.
+  # Iterate over all the files in the project and extract annotations from
+  # the those files. Returns the results as a hash for display.
   #
   def find
     results = {}

data/lib/bones/app/create_command.rb

@@ -29,7 +29,6 @@ class CreateCommand < Command
       if test(?f, File.join(output_dir, 'Rakefile'))
         begin
           FileUtils.cd output_dir
-          system "rake manifest:create 2>&1 > #{::Bones::DEV_NULL}"
           @out.puts "Now you need to fix these files"
           system "rake notes"
         ensure

data/lib/bones/app/file_manager.rb

@@ -141,7 +141,7 @@ class FileManager
     rgxp = %r/\A#{source}\/?/
     exclude = %r/tmp$|bak$|~$|CVS|\.svn/
 
-    ary = Dir.glob(File.join(source, '**', '*')).map do |filename|
+    ary = Dir.glob(File.join(source, '**', '*.*'), File::FNM_DOTMATCH).map do |filename|
       next if exclude =~ filename
       next if test(?d, filename)
       filename.sub rgxp, ''

data/lib/bones/tasks/post_load.rake

@@ -2,8 +2,8 @@
 # This file does not define any rake tasks. It is used to load some project
 # settings if they are not defined by the user.
 
-PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
 PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
                  "^#{Regexp.escape(PROJ.rdoc.dir)}/",
                  "^#{Regexp.escape(PROJ.rcov.dir)}/"]
 
@@ -25,12 +25,7 @@ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
 
 PROJ.summary ||= PROJ.description.split('.').first
 
-PROJ.gem.files ||=
-  if test(?f, PROJ.manifest_file)
-    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
-    files.delete ''
-    files
-  else [] end
+PROJ.gem.files ||= manifest
 
 PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
 

data/lib/bones/tasks/setup.rb

@@ -4,6 +4,7 @@ require 'rake'
 require 'rake/clean'
 require 'fileutils'
 require 'ostruct'
+require 'find'
 
 class OpenStruct; undef :gem; end
 
@@ -27,8 +28,8 @@ PROJ = OpenStruct.new(
   :ruby_opts => %w(-w),
   :libs => [],
   :history_file => 'History.txt',
-  :manifest_file => 'Manifest.txt',
   :readme_file => 'README.txt',
+  :ignore_file => '.bnsignore',
 
   # Announce
   :ann => OpenStruct.new(
@@ -254,9 +255,25 @@ end
 # Scans the current working directory and creates a list of files that are
 # candidates to be in the manifest.
 #
-def manifest_files
+def manifest
   files = []
-  exclude = Regexp.new(PROJ.exclude.join('|'))
+  exclude = PROJ.exclude.dup
+  comment = %r/^\s*#/
+ 
+  # process the ignore file and add the items there to the exclude list
+  if test(?f, PROJ.ignore_file)
+    ary = File.readlines(PROJ.ignore_file).map do |line|
+      next if line =~ comment
+      line.chomp.strip
+    end
+    ary.compact!
+    ary.delete ''
+    exclude.concat ary
+  end
+
+  # generate a regular expression from the exclude list
+  exclude = Regexp.new(exclude.join('|'))
+
   Find.find '.' do |path|
     path.sub! %r/^(\.\/|\/)/o, ''
     next unless test ?f, path

data/spec/bones/app/file_manager_spec.rb

@@ -42,8 +42,8 @@ describe Bones::App::FileManager do
     ary.length.should == 9
 
     ary.should == %w[
+      .bnsignore
       History.txt.bns
-      Manifest.txt
       README.txt.bns
       Rakefile.bns
       bin/NAME.bns

data/tasks/post_load.rake

@@ -2,8 +2,8 @@
 # This file does not define any rake tasks. It is used to load some project
 # settings if they are not defined by the user.
 
-PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
 PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
                  "^#{Regexp.escape(PROJ.rdoc.dir)}/",
                  "^#{Regexp.escape(PROJ.rcov.dir)}/"]
 
@@ -25,12 +25,7 @@ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
 
 PROJ.summary ||= PROJ.description.split('.').first
 
-PROJ.gem.files ||=
-  if test(?f, PROJ.manifest_file)
-    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
-    files.delete ''
-    files
-  else [] end
+PROJ.gem.files ||= manifest
 
 PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
 

data/tasks/setup.rb

@@ -4,6 +4,7 @@ require 'rake'
 require 'rake/clean'
 require 'fileutils'
 require 'ostruct'
+require 'find'
 
 class OpenStruct; undef :gem; end
 
@@ -27,8 +28,8 @@ PROJ = OpenStruct.new(
   :ruby_opts => %w(-w),
   :libs => [],
   :history_file => 'History.txt',
-  :manifest_file => 'Manifest.txt',
   :readme_file => 'README.txt',
+  :ignore_file => '.bnsignore',
 
   # Announce
   :ann => OpenStruct.new(
@@ -254,9 +255,25 @@ end
 # Scans the current working directory and creates a list of files that are
 # candidates to be in the manifest.
 #
-def manifest_files
+def manifest
   files = []
-  exclude = Regexp.new(PROJ.exclude.join('|'))
+  exclude = PROJ.exclude.dup
+  comment = %r/^\s*#/
+ 
+  # process the ignore file and add the items there to the exclude list
+  if test(?f, PROJ.ignore_file)
+    ary = File.readlines(PROJ.ignore_file).map do |line|
+      next if line =~ comment
+      line.chomp.strip
+    end
+    ary.compact!
+    ary.delete ''
+    exclude.concat ary
+  end
+
+  # generate a regular expression from the exclude list
+  exclude = Regexp.new(exclude.join('|'))
+
   Find.find '.' do |path|
     path.sub! %r/^(\.\/|\/)/o, ''
     next unless test ?f, path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-01 00:00:00 -07:00
+date: 2009-01-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,7 +36,6 @@ extra_rdoc_files:
 - 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
@@ -47,13 +46,11 @@ extra_rdoc_files:
 - spec/data/foo/README.txt
 files: 
 - History.txt
-- Manifest.txt
 - README.rdoc
 - Rakefile
 - bin/bones
-- bones.gemspec
+- data/.bnsignore
 - data/History.txt.bns
-- data/Manifest.txt
 - data/README.txt.bns
 - data/Rakefile.bns
 - data/bin/NAME.bns
@@ -77,7 +74,6 @@ files:
 - 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
@@ -100,7 +96,6 @@ files:
 - tasks/bones.rake
 - tasks/gem.rake
 - tasks/git.rake
-- tasks/manifest.rake
 - tasks/notes.rake
 - tasks/post_load.rake
 - tasks/rdoc.rake

data/Manifest.txt

@@ -1,50 +0,0 @@
-History.txt
-Manifest.txt
-README.rdoc
-Rakefile
-bin/bones
-bones.gemspec
-data/History.txt.bns
-data/Manifest.txt
-data/README.txt.bns
-data/Rakefile.bns
-data/bin/NAME.bns
-data/lib/NAME.rb.bns
-data/spec/NAME_spec.rb.bns
-data/spec/spec_helper.rb.bns
-data/test/test_NAME.rb
-lib/bones.rb
-lib/bones/annotation_extractor.rb
-lib/bones/app.rb
-lib/bones/app/command.rb
-lib/bones/app/create_command.rb
-lib/bones/app/file_manager.rb
-lib/bones/app/freeze_command.rb
-lib/bones/app/info_command.rb
-lib/bones/app/unfreeze_command.rb
-lib/bones/app/update_command.rb
-lib/bones/debug.rb
-lib/bones/smtp_tls.rb
-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/app/file_manager_spec.rb
-spec/bones/app_spec.rb
-spec/bones_spec.rb
-spec/data/data/NAME/NAME.rb.bns
-spec/data/data/README.txt.bns
-spec/data/data/Rakefile.bns
-spec/data/data/lib/NAME.rb.bns
-spec/data/foo/README.txt
-spec/data/foo/Rakefile
-spec/spec_helper.rb

data/bones.gemspec

@@ -1,40 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{bones}
-  s.version = "2.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tim Pease"]
-  s.date = %q{2009-01-01}
-  s.default_executable = %q{bones}
-  s.description = %q{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).}
-  s.email = %q{tim.pease@gmail.com}
-  s.executables = ["bones"]
-  s.extra_rdoc_files = ["History.txt", "README.rdoc", "bin/bones", "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/spec.rake", "lib/bones/tasks/svn.rake", "lib/bones/tasks/test.rake", "spec/data/data/README.txt", "spec/data/foo/README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "bin/bones", "data/History.txt.bns", "data/Manifest.txt", "data/README.txt.bns", "data/Rakefile.bns", "data/bin/NAME.bns", "data/lib/NAME.rb.bns", "data/spec/NAME_spec.rb.bns", "data/spec/spec_helper.rb.bns", "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", "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"]
-  s.has_rdoc = true
-  s.homepage = %q{http://codeforpeople.rubyforge.org/bones}
-  s.post_install_message = %q{--------------------------
- Keep rattlin' dem bones!
---------------------------
-}
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{codeforpeople}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Mr Bones is a handy tool that builds a skeleton for your new Ruby projects}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rake>, [">= 0.8.3"])
-    else
-      s.add_dependency(%q<rake>, [">= 0.8.3"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0.8.3"])
-  end
-end

data/lib/bones/tasks/manifest.rake

@@ -1,48 +0,0 @@
-
-require 'find'
-
-namespace :manifest do
-
-  desc 'Verify the manifest'
-  task :check do
-    fn = PROJ.manifest_file + '.tmp'
-    files = manifest_files
-
-    File.open(fn, 'w') {|fp| fp.puts files}
-    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
-    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
-      lines.map! do |line|
-        case line
-        when %r/^(-{3}|\+{3})/; nil
-        when %r/^@/; ANSICode.blue line
-        when %r/^\+/; ANSICode.green line
-        when %r/^\-/; ANSICode.red line
-        else line end
-      end
-    end
-    puts lines.compact
-    rm fn rescue nil
-  end
-
-  desc 'Create a new manifest'
-  task :create do
-    files = manifest_files
-    unless test(?f, PROJ.manifest_file)
-      files << PROJ.manifest_file
-      files.sort!
-    end
-    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
-  end
-
-  task :assert do
-    files = manifest_files
-    manifest = File.read(PROJ.manifest_file).split($/)
-    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
-  end
-
-end  # namespace :manifest
-
-desc 'Alias to manifest:check'
-task :manifest => 'manifest:check'
-
-# EOF

data/tasks/manifest.rake

@@ -1,48 +0,0 @@
-
-require 'find'
-
-namespace :manifest do
-
-  desc 'Verify the manifest'
-  task :check do
-    fn = PROJ.manifest_file + '.tmp'
-    files = manifest_files
-
-    File.open(fn, 'w') {|fp| fp.puts files}
-    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
-    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
-      lines.map! do |line|
-        case line
-        when %r/^(-{3}|\+{3})/; nil
-        when %r/^@/; ANSICode.blue line
-        when %r/^\+/; ANSICode.green line
-        when %r/^\-/; ANSICode.red line
-        else line end
-      end
-    end
-    puts lines.compact
-    rm fn rescue nil
-  end
-
-  desc 'Create a new manifest'
-  task :create do
-    files = manifest_files
-    unless test(?f, PROJ.manifest_file)
-      files << PROJ.manifest_file
-      files.sort!
-    end
-    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
-  end
-
-  task :assert do
-    files = manifest_files
-    manifest = File.read(PROJ.manifest_file).split($/)
-    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
-  end
-
-end  # namespace :manifest
-
-desc 'Alias to manifest:check'
-task :manifest => 'manifest:check'
-
-# EOF