bones 3.5.1 → 3.5.2

data/History.txt

@@ -1,3 +1,8 @@
+== 3.5.2 / 2010-11-23
+
+1 minor change
+  - Markdown is the default README format [gioele]
+
 == 3.5.1 / 2010-10-27
 
 1 bugfix

data/README.rdoc

@@ -76,16 +76,18 @@ If you would like some extra functinoality the following plugins can be
 installed:
 
 * gem install bones-git
-* gem install bones-extras
+* gem install bones-yard
+* gem install bones-rspec
+* gem install bones-rcov
+
+A complete list of available plugins is available via the bones command:
+
+  bones plugins --all
 
 The 'bones-git' gem provides command line options for generating a git
 repository and pushing to github upon creation. Rake tasks for working with
 the git repository are also provided.
 
-The 'bones-extras' gem provides rake tasks for running Rspec tests, running
-Rcov on your source code, and pushing releases to RubyForge. You will need to
-have the corresponding gems installed for these tasks to be loaded.
-
 == ACKNOWLEDGEMENTS:
 
 Ryan Davis and Eric Hodel and their Hoe gem (from which much of the Mr Bones

data/{spec/data/default/README.txt.bns → default/README.md.bns}

@@ -1,32 +1,44 @@
 <%= name %>
-    by FIXME (your name)
-    FIXME (url)
-
-== DESCRIPTION:
+===========
 
 FIXME (describe your package)
 
-== FEATURES/PROBLEMS:
+Features
+--------
 
-* FIXME (list of features or problems)
+* FIXME (list of features and unsolved problems)
 
-== SYNOPSIS:
+Examples
+--------
 
-  FIXME (code sample of usage)
+    FIXME (code sample of usage)
 
-== REQUIREMENTS:
+Requirements
+------------
 
 * FIXME (list of requirements)
 
-== INSTALL:
+Install
+-------
 
 * FIXME (sudo gem install, anything else)
 
-== LICENSE:
+Author
+------
+
+Original author: FIXME (author's name)
+
+Contributors:
+
+* FIXME (contributor 1?)
+* FIXME (contributor 2?)
+
+License
+-------
 
-(The MIT License)
+(The MIT License) FIXME (different license?)
 
-Copyright (c) 2008 FIXME (different license?)
+Copyright (c) <%= Time.now.strftime('%Y') %> FIXME (author's name)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/bones/helpers.rb

@@ -1,5 +1,6 @@
 
 module Bones::Helpers
+  extend self
 
   DEV_NULL = File.exist?('/dev/null') ? '/dev/null' : 'NUL:'
   SUDO = if system("which sudo > #{DEV_NULL} 2>&1") then 'sudo'
@@ -28,34 +29,46 @@ module Bones::Helpers
     io.each {|x| x.close}
   end
 
-  # Reads a file at +path+ and spits out an array of the +paragraphs+
-  # specified.
+  # Reads the file located at the given +path+ and returns an array of the
+  # desired +paragraphs+. The paragraphs can be given as a single section
+  # +title+ or any number of paragraph numbers or ranges.
+  #
+  # For example:
   #
   #    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
-  #    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+  #    summary, *description = paragraphs_of('README.md', 3, 3..8)
+  #    features = paragraphs_of('README.md', 'features').join("\n\n")
+  #    examples = paragraphs_of('README.md', 'examples').join("\n\n")
   #
-  def paragraphs_of( path, *paragraphs )
-    title = String === paragraphs.first ? paragraphs.shift : nil
-    ary = File.read(path).delete("\r").split(/\n\n+/)
+  def paragraphs_of( path, *args )
+
+    title = String === args.first ? args.shift : nil
+    paragraphs = File.read(path).delete("\r").split(%r/\n\n+/)
+
+    if title.nil? then
+      result = paragraphs
 
-    result = if title
-      tmp, matching = [], false
-      rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
-      paragraphs << (0..-1) if paragraphs.empty?
+    else
+      title = Regexp.escape title
+      start_rgxp = [%r/\A=+\s*#{title}/i, %r/\A#{title}\n[=-]+\s*\Z/i]
+      end_rgxp   = [%r/\A=+/i, %r/\A.+\n[=-]+\s*\Z/i]
 
-      ary.each do |val|
-        if val =~ rgxp
+      result = []
+      matching = false
+      rgxp = start_rgxp
+
+      paragraphs.each do |p|
+        if rgxp.any? { |r| p =~ r }
           break if matching
           matching = true
-          rgxp = %r/^=+/i
+          rgxp = end_rgxp
         elsif matching
-          tmp << val
+          result << p
         end
       end
-      tmp
-    else ary end
+    end
 
-    result.values_at(*paragraphs)
+    args.empty? ? result : result.values_at(*args)
   end
 
   # Find a rake task using the task name and remove any description text. This

data/lib/bones/plugins/bones_plugin.rb

@@ -106,8 +106,8 @@ module Bones::Plugins::BonesPlugin
         but you are free to change it to whatever you choose.
       __
 
-      readme_file  'README.txt', :desc => <<-__
-        The name of your project's README file. The default is 'README.txt'
+      readme_file  'README.md', :desc => <<-__
+        The name of your project's README file. The default is 'README.md'
         but you are free to change it to whatever you choose. Since GitHub
         understand various markup languages, you can change the README
         file to support your markup language of choice.
@@ -145,7 +145,10 @@ module Bones::Plugins::BonesPlugin
     config.exclude << "^#{Regexp.escape(config.ignore_file)}$"
     config.changes     ||= paragraphs_of(config.history_file, 0..1).join("\n\n")
     config.description ||= paragraphs_of(config.readme_file, 'description').join("\n\n")
-    config.summary     ||= config.description.split('.').first
+    if config.description.empty?
+        config.description = paragraphs_of(config.readme_file, 1..1).first
+    end
+    config.summary ||= config.description[%r/^[^.]*\.?/]
 
     config.version ||= ENV['VERSION']
     if test(?f, 'version.txt') and !config.version

data/lib/bones/plugins/gem.rb

@@ -192,8 +192,15 @@ module Bones::Plugins::Gem
         puts config.gem._spec.to_ruby
       end
 
-      desc 'Write the gemspec '
+      desc 'Write the gemspec'
       task :spec => 'gem:prereqs' do
+        File.open("#{config.name}.gemspec", 'w') do |f|
+          f.write config.gem._spec.to_ruby
+        end
+      end
+
+      desc 'Write the gemspec in Rails YAML format'
+      task :rails_spec => 'gem:prereqs' do
         File.open('.specification', 'w') do |f|
           f.write config.gem._spec.to_yaml
         end

data/lib/bones/plugins/notes.rb

@@ -5,10 +5,23 @@ module Bones::Plugins::Notes
 
   def initialize_notes
     ::Bones.config {
+      desc 'Configuration for extracting annotations from project files.'
       notes {
-        exclude  []
-        extensions  %w(.txt .rb .erb .rdoc) << ''
-        tags  %w(FIXME OPTIMIZE TODO)
+        exclude [], :desc => <<-__
+          A list of regular expression patterns that will be used to exclude
+          certain files from the annotation search. Each pattern is given as a
+          string, and they are all combined using the regular expression or
+          "|" operator.
+        __
+
+        extensions %w[.txt .rb .erb .rdoc .md] << '', :desc => <<-__
+          Only files with these extensions will be searched for annotations.
+        __
+
+        tags %w[FIXME OPTIMIZE TODO], :desc => <<-__
+          The list of annotation tags that will be extracted from the files
+          being searched.
+        __
       }
     }
 

data/spec/bones/app/file_manager_spec.rb

@@ -45,7 +45,7 @@ describe Bones::App::FileManager do
       .rvmrc.bns
       History
       NAME/NAME.rb.bns
-      README.txt.bns
+      README.md.bns
       Rakefile.bns
       bin/NAME.bns
       lib/NAME.rb.bns
@@ -92,12 +92,12 @@ describe Bones::App::FileManager do
 
     dir = @fm.destination
     test(?e, File.join(dir, 'Rakefile.bns')).should == false
-    test(?e, File.join(dir, 'README.txt.bns')).should == false
+    test(?e, File.join(dir, 'README.md.bns')).should == false
     test(?e, File.join(dir, %w[foo_bar foo_bar.rb.bns])).should == false
     test(?e, File.join(dir, '.rvmrc.bns')).should == false
 
     test(?e, File.join(dir, 'Rakefile')).should == true
-    test(?e, File.join(dir, 'README.txt')).should == true
+    test(?e, File.join(dir, 'README.md')).should == true
     test(?e, File.join(dir, %w[foo_bar foo_bar.rb])).should == true
     test(?e, File.join(dir, '.rvmrc')).should == true
 

data/spec/bones/helpers_spec.rb

@@ -0,0 +1,52 @@
+
+require 'spec_helper'
+
+describe Bones::Helpers do
+
+  before :each do
+    Bones::Helpers::HAVE.clear
+  end
+
+  describe 'when extracting paragraphs' do
+    it 'recognizes RDoc headers by title' do
+      filename = Bones.path %w[spec data rdoc.txt]
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'install')
+      ary.length.should == 6
+      ary.first.should == '* gem install bones'
+      ary.last.should == %Q{The 'bones-git' gem provides command line options for generating a git\nrepository and pushing to github upon creation. Rake tasks for working with\nthe git repository are also provided.}
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'description')
+      ary.length.should == 1
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'license')
+      ary.length.should == 4
+    end
+
+    it 'recognizes Markdown headers by title' do
+      filename = Bones.path %w[spec data markdown.txt]
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'install')
+      ary.length.should == 5
+      ary.first.should == '* gem install bones'
+      ary.last.should == %Q{The 'bones-extras' gem provides rake tasks for running Rspec tests, running\nRcov on your source code, and pushing releases to RubyForge. You will need to\nhave the corresponding gems installed for these tasks to be loaded.}
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'mr bones')
+      ary.length.should == 1
+
+      ary = Bones::Helpers.paragraphs_of(filename, 'license')
+      ary.length.should == 4
+    end
+
+    it 'uses paragraph numbers' do
+      filename = Bones.path %w[spec data markdown.txt]
+
+      ary = Bones::Helpers.paragraphs_of(filename, 1, 3..5)
+      ary.length.should == 4
+      ary.first.should == %Q{Mr Bones is a handy tool that creates new Ruby projects from a code\nskeleton. The skeleton contains some starter code and a collection of rake\ntasks to ease the management and deployment of your source code. Several Mr\nBones plugins are available for creating git repositories, creating GitHub\nprojects, running various test suites and source code analysis tools.}
+      ary.last.should == %Q{When working with Rake, Mr Bones provides a set of tasks that help simplify\ncommon development tasks. These tasks include ...}
+    end
+  end
+
+end
+

data/{default/README.txt.bns → spec/data/default/README.md.bns}

@@ -1,32 +1,44 @@
 <%= name %>
-    by FIXME (your name)
-    FIXME (url)
-
-== DESCRIPTION:
+===========
 
 FIXME (describe your package)
 
-== FEATURES/PROBLEMS:
+Features
+--------
 
-* FIXME (list of features or problems)
+* FIXME (list of features and unsolved problems)
 
-== SYNOPSIS:
+Examples
+--------
 
-  FIXME (code sample of usage)
+    FIXME (code sample of usage)
 
-== REQUIREMENTS:
+Requirements
+------------
 
 * FIXME (list of requirements)
 
-== INSTALL:
+Install
+-------
 
 * FIXME (sudo gem install, anything else)
 
-== LICENSE:
+Author
+------
+
+Original author: FIXME (author's name)
+
+Contributors:
+
+* FIXME (contributor 1?)
+* FIXME (contributor 2?)
+
+License
+-------
 
-(The MIT License)
+(The MIT License) FIXME(different license?)
 
-Copyright (c) 2009 FIXME (different license?)
+Copyright (c) 2010 FIXME (author's name)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/spec/data/markdown.txt

@@ -0,0 +1,113 @@
+Mr Bones
+========
+
+Mr Bones is a handy tool that creates new Ruby projects from a code
+skeleton. The skeleton contains some starter code and a collection of rake
+tasks to ease the management and deployment of your source code. Several Mr
+Bones plugins are available for creating git repositories, creating GitHub
+projects, running various test suites and source code analysis tools.
+
+Features
+--------
+
+Mr Bones is configurable, helpful, and it simplifies project development.
+
+Mr Bones simplifies project creation by using a code template for generating
+a new working area for your code. This skeleton is customizable, and you can
+have multiple skeletons for various types of projects you work on - ruby
+libraries, web applications, or even writing projects.
+
+When working with Rake, Mr Bones provides a set of tasks that help simplify
+common development tasks. These tasks include ...
+
+* release announcements
+* gem packaging and management
+* releasing to gemcutter and rubyforge
+* documentation
+* annotation listing (TODO, FIXME, etc)
+* testing
+
+The provided rake tasks are configured using a "Bones" configuration block in
+the Rakefile. You can obtain a list of the available options and descriptive
+help for each option by running the various "bones" tasks (use "rake -T" to
+list the available tasks). Although there are many configuration options, the
+vast majority of them have sensible defaults; tailor to suit your needs in the
+Bones configuration block.
+
+Mr Bones can be extended via plugins. The plugins provide new rake tasks and
+configuration options for those tasks. Other developers can release plugins to
+automate the use of their libraries in a bones enabled system.
+
+Currently there are a "bones-git" plugin for interacting with github and git
+repositories and a "bones-extras" plugin for working with Rcov, RubyForge,
+and Rspec.
+
+There is far more information available in the Mr Bones manual.
+http://wiki.github.com/TwP/bones/manual
+
+Examples
+--------
+
+To create a new "Get Fuzzy" project:
+
+  bones create get_fuzzy
+
+If you ever get confused about what Mr Bones can do:
+
+  bones --help
+
+After your project is created, you can view all the available configuration
+options:
+
+  rake bones:options
+
+Detailed information about the options (or a subset of options) can also be
+displayed:
+
+  rake bones:help        #=> for all options
+  rake bones:help gem    #=> for the "gem" subset
+
+Install
+-------
+
+* gem install bones
+
+If you would like some extra functinoality the following plugins can be
+installed:
+
+* gem install bones-git
+* gem install bones-extras
+
+The 'bones-git' gem provides command line options for generating a git
+repository and pushing to github upon creation. Rake tasks for working with
+the git repository are also provided.
+
+The 'bones-extras' gem provides rake tasks for running Rspec tests, running
+Rcov on your source code, and pushing releases to RubyForge. You will need to
+have the corresponding gems installed for these tasks to be loaded.
+
+License
+-------
+
+MIT License
+Copyright (c) 2007 - 2010
+
+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/spec/data/rdoc.txt

@@ -0,0 +1,121 @@
+Mr Bones
+    by Tim Pease
+    http://gemcutter.org/gems/bones
+
+== DESCRIPTION:
+
+Mr Bones is a handy tool that creates new Ruby projects from a code
+skeleton. The skeleton contains some starter code and a collection of rake
+tasks to ease the management and deployment of your source code. Several Mr
+Bones plugins are available for creating git repositories, creating GitHub
+projects, running various test suites and source code analysis tools.
+
+== SYNOPSIS:
+
+To create a new "Get Fuzzy" project:
+
+  bones create get_fuzzy
+
+If you ever get confused about what Mr Bones can do:
+
+  bones --help
+
+After your project is created, you can view all the available configuration
+options:
+
+  rake bones:options
+
+Detailed information about the options (or a subset of options) can also be
+displayed:
+
+  rake bones:help        #=> for all options
+  rake bones:help gem    #=> for the "gem" subset
+
+== FEATURES:
+
+Mr Bones is configurable, helpful, and it simplifies project development.
+
+Mr Bones simplifies project creation by using a code template for generating
+a new working area for your code. This skeleton is customizable, and you can
+have multiple skeletons for various types of projects you work on - ruby
+libraries, web applications, or even writing projects.
+
+When working with Rake, Mr Bones provides a set of tasks that help simplify
+common development tasks. These tasks include ...
+
+* release announcements
+* gem packaging and management
+* releasing to gemcutter and rubyforge
+* documentation
+* annotation listing (TODO, FIXME, etc)
+* testing
+
+The provided rake tasks are configured using a "Bones" configuration block in
+the Rakefile. You can obtain a list of the available options and descriptive
+help for each option by running the various "bones" tasks (use "rake -T" to
+list the available tasks). Although there are many configuration options, the
+vast majority of them have sensible defaults; tailor to suit your needs in the
+Bones configuration block.
+
+Mr Bones can be extended via plugins. The plugins provide new rake tasks and
+configuration options for those tasks. Other developers can release plugins to
+automate the use of their libraries in a bones enabled system.
+
+Currently there are a "bones-git" plugin for interacting with github and git
+repositories and a "bones-extras" plugin for working with Rcov, RubyForge,
+and Rspec.
+
+There is far more information available in the Mr Bones manual.
+http://wiki.github.com/TwP/bones/manual
+
+== INSTALL:
+
+* gem install bones
+
+If you would like some extra functinoality the following plugins can be
+installed:
+
+* gem install bones-git
+* gem install bones-yard
+* gem install bones-rspec
+* gem install bones-rcov
+
+A complete list of available plugins is available via the bones command:
+
+  bones plugins --all
+
+The 'bones-git' gem provides command line options for generating a git
+repository and pushing to github upon creation. Rake tasks for working with
+the git repository are also provided.
+
+== ACKNOWLEDGEMENTS:
+
+Ryan Davis and Eric Hodel and their Hoe gem (from which much of the Mr Bones
+rake tasks have been stolen). The rails team and their source annotation
+extractor. Bruce Williams for help in coming up with the project name. Ara T.
+Howard for letting me squat in the codeforpeople rubyforge project.
+
+== LICENSE:
+
+MIT License
+Copyright (c) 2007 - 2010
+
+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/version.txt

@@ -1 +1 @@
-3.5.1
+3.5.2

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 3
   - 5
-  - 1
-  version: 3.5.1
+  - 2
+  version: 3.5.2
 platform: ruby
 authors: 
 - Tim Pease
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -06:00
+date: 2010-11-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,7 +130,8 @@ extra_rdoc_files:
 - README.rdoc
 - bin/bones
 - default/version.txt
-- spec/data/foo/README.txt
+- spec/data/markdown.txt
+- spec/data/rdoc.txt
 - version.txt
 files: 
 - .autotest
@@ -140,7 +141,7 @@ files:
 - bin/bones
 - default/.bnsignore
 - default/History.txt.bns
-- default/README.txt.bns
+- default/README.md.bns
 - default/Rakefile.bns
 - default/bin/NAME.bns
 - default/lib/NAME.rb.bns
@@ -170,17 +171,20 @@ files:
 - lib/bones/smtp_tls.rb
 - spec/bones/app/file_manager_spec.rb
 - spec/bones/app_spec.rb
+- spec/bones/helpers_spec.rb
 - spec/bones_spec.rb
 - spec/data/default/.bnsignore
 - spec/data/default/.rvmrc.bns
 - spec/data/default/History
 - spec/data/default/NAME/NAME.rb.bns
-- spec/data/default/README.txt.bns
+- spec/data/default/README.md.bns
 - spec/data/default/Rakefile.bns
 - spec/data/default/bin/NAME.bns
 - spec/data/default/lib/NAME.rb.bns
-- spec/data/foo/README.txt
+- spec/data/foo/README.md
 - spec/data/foo/Rakefile
+- spec/data/markdown.txt
+- spec/data/rdoc.txt
 - spec/spec_helper.rb
 - version.txt
 has_rdoc: true
@@ -221,6 +225,6 @@ rubyforge_project: bones
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Mr Bones is a handy tool that creates new Ruby projects from a code skeleton
+summary: Mr Bones is a handy tool that creates new Ruby projects from a code skeleton.
 test_files: []