bones 2.1.1 → 2.2.0

data/lib/bones/app/update_command.rb

@@ -0,0 +1,47 @@
+
+module Bones
+class App
+
+class UpdateCommand < Command
+
+  def run( args )
+    parse args
+
+    raise "'#{output_dir}' does not exist" unless test(?e, output_dir)
+    copy_tasks(File.join(output_dir, 'tasks'))
+
+    msg = "Updated tasks in directory '#{output_dir}'"
+    @out.puts msg
+  end
+
+  def parse( args )
+    std_opts = standard_options
+
+    opts = OptionParser.new
+    opts.banner = 'Usage: bones update <directory>'
+
+    opts.separator ''
+    opts.separator '  Copy the Mr Bones rake tasks into the project directory'
+
+    opts.separator ''
+    opts.separator '  Common Options:'
+    opts.on_tail( '-h', '--help', 'show this message' ) {
+      @out.puts opts
+      exit
+    }
+
+    # parse the command line arguments
+    opts.parse! args
+    options[:output_dir] = args.empty? ? nil : args.join('_')
+
+    if output_dir.nil?
+      @out.puts opts
+      exit 1
+    end
+  end
+
+end  # class CreateCommand
+end  # class App
+end  # module Bones
+
+# EOF

data/lib/bones/tasks/gem.rake

@@ -37,8 +37,6 @@ class GemPackageTask < Rake::PackageTask
     local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
     if !test(?e, local_setup)
       Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
-      gem_spec.files = (gem_spec.files +
-          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
     end
   end
 
@@ -63,6 +61,10 @@ class GemPackageTask < Rake::PackageTask
 
     file package_dir_path => bones_files do
       mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
       bones_files.each do |fn|
         base_fn = File.join('tasks', File.basename(fn))
         f = File.join(package_dir_path, base_fn)
@@ -157,6 +159,13 @@ namespace :gem do
     puts PROJ.gem._spec.to_ruby
   end
 
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
   desc 'Install the gem'
   task :install => [:clobber, 'gem:package'] do
     sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"

data/spec/bones/app/file_manager_spec.rb

@@ -0,0 +1,150 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# --------------------------------------------------------------------------
+describe Bones::App::FileManager do
+
+  before :each do
+    @fm = Bones::App::FileManager.new
+  end
+
+  after :each do
+    FileUtils.rm_rf(@fm.destination) if @fm.destination
+    FileUtils.rm_rf(@fm.archive) if @fm.archive
+  end
+
+  it "should have a configurable source" do
+    @fm.source.should be_nil
+
+    @fm.source = '/home/user/.mrbones/data'
+    @fm.source.should == '/home/user/.mrbones/data'
+  end
+
+  it "should have a configurable destination" do
+    @fm.destination.should be_nil
+
+    @fm.destination = 'my_new_app'
+    @fm.destination.should == 'my_new_app'
+  end
+
+  it "should set the archive directory when the destination is set" do
+    @fm.archive.should be_nil
+
+    @fm.destination = 'my_new_app'
+    @fm.archive.should == 'my_new_app.archive'
+  end
+
+  it "should return a list of files to copy" do
+    @fm.source = Bones.path 'data'
+
+    ary = @fm._files_to_copy
+    ary.length.should == 9
+
+    ary.should == %w[
+      History.txt.bns
+      Manifest.txt
+      README.txt.bns
+      Rakefile.bns
+      bin/NAME.bns
+      lib/NAME.rb.bns
+      spec/NAME_spec.rb.bns
+      spec/spec_helper.rb.bns
+      test/test_NAME.rb
+    ]
+  end
+
+  it "should archive the destination directory if it exists" do
+    @fm.destination = Bones.path(%w[spec data bar])
+    test(?e, @fm.destination).should == false
+    test(?e, @fm.archive).should == false
+
+    FileUtils.mkdir @fm.destination
+    @fm.archive_destination
+    test(?e, @fm.destination).should == false
+    test(?e, @fm.archive).should == true
+  end
+
+  it "should rename files and folders containing 'NAME'" do
+    @fm.source = Bones.path(%w[spec data data])
+    @fm.destination = Bones.path(%w[spec data bar])
+    @fm.copy
+
+    @fm._rename(File.join(@fm.destination, 'NAME'), 'tirion')
+
+    dir = File.join(@fm.destination, 'tirion')
+    test(?d, dir).should == true
+    test(?f, File.join(dir, 'tirion.rb.bns')).should == true
+  end
+
+  it "should raise an error when renaming an existing file or folder" do
+    @fm.source = Bones.path(%w[spec data data])
+    @fm.destination = Bones.path(%w[spec data bar])
+    @fm.copy
+
+    lambda {@fm._rename(File.join(@fm.destination, 'NAME'), 'lib')}.
+      should raise_error(RuntimeError)
+  end
+
+  it "should perform ERb templating on '.bns' files" do
+    @fm.source = Bones.path(%w[spec data data])
+    @fm.destination = Bones.path(%w[spec data bar])
+    @fm.copy
+    @fm.finalize('foo_bar')
+
+    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, %w[foo_bar foo_bar.rb.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, %w[foo_bar foo_bar.rb])).should == true
+
+    txt = File.read(File.join(@fm.destination, %w[foo_bar foo_bar.rb]))
+    txt.should == <<-TXT
+module FooBar
+  def self.foo_bar
+    p 'just a test'
+  end
+end
+    TXT
+  end
+
+  # ------------------------------------------------------------------------
+  describe 'when configured with a repository as a source' do
+
+    it "should recognize a git repository" do
+      @fm.source = 'git://github.com/TwP/bones.git'
+      @fm.repository.should == :git
+
+      @fm.source = 'git://github.com/TwP/bones.git/'
+      @fm.repository.should == :git
+    end
+
+    it "should recognize an svn repository" do
+      @fm.source = 'file:///home/user/svn/ruby/trunk/apc'
+      @fm.repository.should == :svn
+
+      @fm.source = 'http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8'
+      @fm.repository.should == :svn
+
+      @fm.source = 'https://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8'
+      @fm.repository.should == :svn
+
+      @fm.source = 'svn://10.10.10.10/project/trunk'
+      @fm.repository.should == :svn
+
+      @fm.source = 'svn+ssh://10.10.10.10/project/trunk'
+      @fm.repository.should == :svn
+    end
+
+    it "should return nil if the source is not a repository" do
+      @fm.source = '/some/directory/on/your/hard/drive'
+      @fm.repository.should == nil
+    end
+  end
+
+end
+
+# EOF

data/spec/bones/app_spec.rb

@@ -0,0 +1,97 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. spec_helper]))
+
+class Runner
+  attr_accessor :name
+  def run(*a, &b) nil; end
+end
+
+describe Bones::App do
+
+  before :all do
+    @out = StringIO.new
+    @err = StringIO.new
+  end
+
+  before :each do
+    @runner = Runner.new
+    @app = Bones::App.new(@out, @err)
+
+    Bones::App::CreateCommand.stub!(:new).
+        and_return {@runner.name = :create; @runner}
+    Bones::App::UpdateCommand.stub!(:new).
+        and_return {@runner.name = :update; @runner}
+    Bones::App::FreezeCommand.stub!(:new).
+        and_return {@runner.name = :freeze; @runner}
+    Bones::App::UnfreezeCommand.stub!(:new).
+        and_return {@runner.name = :unfreeze; @runner}
+    Bones::App::InfoCommand.stub!(:new).
+        and_return {@runner.name = :info; @runner}
+  end
+
+  after :each do
+    @out.clear
+    @err.clear
+  end
+
+  it 'should provide a create command' do
+    @app.run %w[create]
+    @runner.name.should == :create
+  end
+
+  it 'should provide an update command' do
+    @app.run %w[update]
+    @runner.name.should == :update
+  end
+
+  it 'should provide a freeze command' do
+    @app.run %w[freeze]
+    @runner.name.should == :freeze
+  end
+
+  it 'should provide an unfreeze command' do
+    @app.run %w[unfreeze]
+    @runner.name.should == :unfreeze
+  end
+
+  it 'should provide an info command' do
+    @app.run %w[info]
+    @runner.name.should == :info
+  end
+
+  it 'should provide a help command' do
+    @app.run %w[--help]
+    @out.readline
+    @out.readline.should match(%r/^  Mr Bones is a handy tool that builds/)
+    @out.clear
+
+    @app.run %w[-h]
+    @out.readline
+    @out.readline.should match(%r/^  Mr Bones is a handy tool that builds/)
+  end
+
+  it 'should default to the help message if no command is given' do
+    @app.run []
+    @out.readline
+    @out.readline.should match(%r/^  Mr Bones is a handy tool that builds/)
+  end
+
+  it 'should report an error for unrecognized commands' do
+    lambda {@app.run %w[foo]}.should raise_error(SystemExit)
+    @err.readline.should == 'ERROR:  While executing bones ... (RuntimeError)'
+    @err.readline.should == '    Unknown command "foo"'
+  end
+
+  it 'should report a version number' do
+    @app.run %w[--version]
+    @out.readline.should == "Mr Bones #{Bones::VERSION}"
+    @out.clear
+
+    @app.run %w[-v]
+    @out.readline.should == "Mr Bones #{Bones::VERSION}"
+  end
+
+end  # describe Bones::App
+
+# EOF

data/spec/data/data/NAME/NAME.rb.bns

@@ -0,0 +1,5 @@
+module <%= classname %>
+  def self.<%= name %>
+    p 'just a test'
+  end
+end

data/spec/data/data/README.txt.bns

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

@@ -0,0 +1,30 @@
+# 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.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require '<%= name %>'
+
+task :default => 'spec:run'
+
+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'
+
+# EOF

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@
 unless defined? BONES_SPEC_HELPER
 BONES_SPEC_HELPER = true
 
+require 'stringio'
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib bones]))
 
@@ -17,6 +18,27 @@ Spec::Runner.configure do |config|
   # config.mock_with :rr
 end
 
+class StringIO
+  alias :_readline :readline
+  def readline
+    @_pos ||= 0
+    seek @_pos
+    begin
+      _line = _readline
+      @_pos = tell
+      _line.rstrip
+    rescue EOFError
+      nil
+    end
+  end
+
+  def clear
+    truncate 0
+    seek 0
+    @_pos = 0
+  end
+end
+
 end  # unless defined?
 
 # EOF