bones 2.1.1 → 2.2.0

data/History.txt

@@ -1,3 +1,15 @@
+== 2.2.0 / 2009-01-01
+
+* 4 minor enhancements
+  - projects can be instantiated from git or svn repositories
+  - added a task to generate a project gemspec for use on github [Sandro Turriate]
+  - Mr Bones erb translation is now applied to files with a
+    '.bns' extension instead of an '.erb' extension
+  - refactored the main bones application
+* 1 bugfix
+  - Mr Bones tasks are only added to the gemspec when a package
+    is being built
+
 == 2.1.1 / 2008-12-15
 
 * 1 minor enhancement

data/Manifest.txt

@@ -3,19 +3,27 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/bones
-data/History.txt.erb
+bones.gemspec
+data/History.txt.bns
 data/Manifest.txt
-data/README.txt.erb
-data/Rakefile.erb
-data/bin/NAME.erb
-data/lib/NAME.rb.erb
-data/spec/NAME_spec.rb.erb
-data/spec/spec_helper.rb.erb
+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/main.rb
 lib/bones/smtp_tls.rb
 lib/bones/tasks/ann.rake
 lib/bones/tasks/bones.rake
@@ -30,10 +38,13 @@ 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/app/file_manager_spec.rb
+spec/bones/app_spec.rb
 spec/bones_spec.rb
-spec/data/data/README.txt
-spec/data/data/Rakefile
+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/README.rdoc

@@ -60,6 +60,7 @@ Mr Bones provides the following rake tasks:
   gem:reinstall     # Reinstall the gem
   gem:release       # Package and upload to RubyForge
   gem:repackage     # Force a rebuild of the package files
+  gem:spec          # Write the gemspec
   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
@@ -86,7 +87,7 @@ directory. Add your own tasks there when you need more functionality.
 
 To create a new "Get Fuzzy" project:
 
-  bones get_fuzzy
+  bones create get_fuzzy
 
 If you ever get confused about what Mr Bones can do:
 
@@ -182,7 +183,7 @@ copied to the ".mrbones" directory in your home directory. From there, the
 skeleton can be modified however you like (add new files and tasks, add new
 directories, etc).
 
-  bones --freeze
+  bones freeze
 
 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
@@ -191,11 +192,11 @@ project or your own ".rake" task files.
 You can have multiple skeletons with different names. Your projects can be
 instantiated from any of these skeletons. Just supply a name when freezing:
 
-  bones --freeze foo
+  bones freeze foo
 
 You can instantiate a project from the "foo" skeleton:
 
-  bones --skeleton foo get_fuzzy
+  bones create --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.
@@ -207,21 +208,44 @@ Unfreezing a skeleton will remove your customized project skeleton from the
 instead. A copy of your custom skeleton is stored in an archive directory of
 the ".mrbones" directory before it is removed.
 
-  bones --unfreeze
+  bones unfreeze
 
 You can unfreeze named skeletons, too:
 
-  bones --unfreeze foo
+  bones unfreeze foo
+
+==== Repository Skeletons
+
+You can instantiate a new project from a git or svn repository. For example,
+if you would like to use the "bort" rails template from github, you can type
+in the following:
+
+  bones create --repository git://github.com/fudgestudios/bort.git foo
+
+Typing in the full path to the repository each time is tedious. You can
+create an alias by freezing the repository and giving it an easy to remember
+name.
+
+  bones freeze --repository git://github.com/fudgestudios/bort.git bort
+
+This does not checkout a copy of the repository; it give us an easy to use
+alias when we want to create a new proejct based on the repository. The
+following command will use our new alias to instantiate a new project called
+"foo":
+
+  bones create --skeleton bort foo
+
+If the repository contains '.bns' files they will be filtered through the
+ERb templating system. All the custom modifications described in the next
+section apply to repository based skeletons as well.
 
 ==== Custom Modifications
 
 Mr Bones will perform a limited set of substitutions on the files in the
 skeleton when it generates a new project. ERB is used to insert the project
 name and the derived class name into template files. The file must end in an
-".erb" suffix for ERB substitutions to take place. The ".erb" suffix is
-stripped from the file during project generation. Therefore, your ERB files
-should have two suffixes -- the ".erb" suffix that will be stripped, and the
-suffix you want the resulting project file to have.
+".bns" suffix for ERB substitutions to take place. The ".bns" suffix is
+stripped from the file during project generation.
 
 Only two values can be substituted into files using ERB -- the project name and
 the derived class name.

data/Rakefile

@@ -9,7 +9,7 @@ PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
 PROJ.version = Bones::VERSION
-PROJ.release_name = 'Proximal Phalanges'
+PROJ.release_name = 'Distal Phalanges'
 PROJ.ruby_opts = %w[-W0]
 PROJ.readme_file = 'README.rdoc'
 
@@ -35,7 +35,7 @@ PROJ.ann.paragraphs = %w[install synopsis features requirements]
 PROJ.ann.text = <<-ANN
 == FUN FACT
 
-A typical adult human skeleton commonly consists of 206, 208 or more bones depending on the method used in counting.
+"Tom Sawyer" was the first novel written on a typewriter.
 
 == POST SCRIPT
 

data/bin/bones

@@ -2,6 +2,6 @@
 
 require File.expand_path(
     File.join(File.dirname(__FILE__), '..', 'lib', 'bones'))
-Bones::Main.run ARGV
+Bones::App.run ARGV
 
 # EOF

data/bones.gemspec

@@ -0,0 +1,40 @@
+# -*- 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/data/{Rakefile.erb → Rakefile.bns}

@@ -6,7 +6,11 @@ begin
   require 'bones'
   Bones.setup
 rescue LoadError
-  load 'tasks/setup.rb'
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
 end
 
 ensure_in_path 'lib'

data/data/lib/NAME.rb.bns

@@ -0,0 +1,49 @@
+
+module <%= classname %>
+
+  # :stopdoc:
+  VERSION = '1.0.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.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
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  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'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module <%= classname %>
+
+<%= classname %>.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/bones.rb

@@ -2,7 +2,7 @@
 module Bones
 
   # :stopdoc:
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
@@ -32,6 +32,8 @@ module Bones
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
 
+  # call-seq:
+  #    Bones.setup
   #
   #
   def self.setup

data/lib/bones/app.rb

@@ -0,0 +1,92 @@
+
+require 'fileutils'
+require 'optparse'
+require 'erb'
+
+module Bones
+class App
+
+  # Create a new instance of App, and run the +bones+ application given
+  # the command line _args_.
+  #
+  def self.run( args )
+    self.new.run args
+  end
+
+  # Create a new main instance using _io_ for standard output and _err_ for
+  # error messages.
+  #
+  def initialize( out = STDOUT, err = STDERR )
+    @out = out
+    @err = err
+  end
+
+  # Parse the desired user command and run that command object.
+  #
+  def run( args )
+    cmd_str = args.shift
+    cmd = case cmd_str
+      when 'create';    CreateCommand.new(@out, @err)
+      when 'update';    UpdateCommand.new(@out, @err)
+      when 'freeze';    FreezeCommand.new(@out, @err)
+      when 'unfreeze';  UnfreezeCommand.new(@out, @err)
+      when 'info';      InfoCommand.new(@out, @err)
+      when nil, '-h', '--help'
+        help
+      when '-v', '--version'
+        @out.puts "Mr Bones #{::Bones::VERSION}"
+        nil
+      else
+        raise "Unknown command #{cmd_str.inspect}"
+      end
+
+    cmd.run args if cmd
+
+  rescue StandardError => err
+    @err.puts "ERROR:  While executing bones ... (#{err.class})"
+    @err.puts "    #{err.to_s}"
+    exit 1
+  end
+
+  # Show the toplevel Mr Bones help message.
+  #
+  def help
+    @out.puts <<-MSG
+
+  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.
+
+  Usage:
+    bones -h/--help
+    bones -v/--version
+    bones command [options] [arguments]
+
+  Examples:
+    bones create new_project
+    bones freeze -r git://github.com/fudgestudios/bort.git bort
+    bones create -s bort new_rails_project
+
+  Commands:
+    bones create          create a new project from a skeleton
+    bones update          copy Mr Bones tasks to a project
+    bones freeze          create a new skeleton in ~/.mrbones/
+    bones unfreeze        remove a skeleton from ~/.mrbones/
+    bones info            show information about available skeletons
+
+  Further Help:
+    Each command has a '--help' option that will provide detailed
+    information for that command.
+
+    http://codeforpeople.rubyforge.org/bones/
+
+    MSG
+    nil
+  end
+
+end  # class App
+end  # module Bones
+
+Bones.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/bones/app/command.rb

@@ -0,0 +1,130 @@
+
+module Bones
+class App
+
+class Command
+
+  attr_reader :options
+
+  def initialize( out = STDOUT, err = STDERR )
+    @out = out
+    @err = err
+    @options = {
+      :skeleton_dir => File.join(mrbones_dir, 'data'),
+      :with_tasks => false,
+      :verbose => false,
+      :name => nil,
+      :output_dir => nil
+    }
+    @options[:skeleton_dir] = ::Bones.path('data') unless test(?d, skeleton_dir)
+  end
+
+  def run( args )
+    raise NotImplementedError
+  end
+
+  # The output directory where files will be written.
+  #
+  def output_dir
+    options[:output_dir]
+  end
+
+  # The directory where the project skeleton is located.
+  #
+  def skeleton_dir
+    options[:skeleton_dir]
+  end
+
+  # The project name from the command line.
+  #
+  def name
+    options[:name]
+  end
+
+  # A git or svn repository URL from the command line.
+  #
+  def repository
+    return options[:repository] if options.has_key? :repository
+    return IO.read(skeleton_dir).strip if skeleton_dir and test(?f, skeleton_dir)
+    nil
+  end
+
+  # Returns +true+ if we are going to copy the Mr Bones tasks into the
+  # destination directory. Normally this will return +false+.
+  #
+  def with_tasks?
+    options[:with_tasks]
+  end
+
+  #
+  #
+  def copy_tasks( to )
+    fm = FileManager.new(
+      :source => ::Bones.path(%w[lib bones tasks]),
+      :destination => to,
+      :stdout => @out,
+      :stderr => @err,
+      :verbose => verbose?
+    )
+    fm.archive_destination
+    fm.copy
+  end
+
+  # Returns +true+ if the user has requested verbose messages.
+  #
+  def verbose?
+    options[:verbose]
+  end
+
+  # Returns the .bones resource directory in the user's home directory.
+  #
+  def mrbones_dir
+    return @mrbones_dir if defined? @mrbones_dir
+
+    path = (::Bones::WIN32 ? ENV['HOMEPATH'].tr("\\", "/") : ENV['HOME'])
+    path = File.join(path, '.mrbones')
+    @mrbones_dir = File.expand_path(path)
+  end
+
+  #
+  #
+  def standard_options
+    {
+      :verbose => ['-v', '--verbose', 'enable verbose output',
+          lambda {
+            options[:verbose] = true
+          }],
+      :directory => ['-d', '--directory DIRECTORY', String,
+          'project directory to create', '(defaults to project_name)',
+          lambda { |value|
+            options[:output_dir] = value
+          }],
+      :skeleton => ['-s', '--skeleton NAME', String,
+          'project skeleton to use',
+          lambda { |value|
+            path = File.join(mrbones_dir, value)
+            if test(?e, path)
+              options[:skeleton_dir] = path 
+            elsif test(?e, value)
+              options[:skeleton_dir] = value
+            else
+              raise ArgumentError, "Unknown skeleton '#{value}'"
+            end
+          }],
+      :with_tasks => ['--with-tasks', 'copy rake tasks to the project folder',
+          lambda {
+            options[:with_tasks] = true
+          }],
+      :repository => ['-r', '--repository URL', String,
+          'svn or git repository path', 
+          lambda { |value|
+            options[:repository] = value
+          }]
+    }
+  end
+
+end  # class Command
+end  # class App
+end  # module Bones
+
+# EOF