TwP-bones 2.3.0

data/lib/bones.rb

@@ -0,0 +1,62 @@
+
+module Bones
+
+  # :stopdoc:
+  VERSION = '2.3.0'
+  PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  WIN32 = %r/win32/ =~ RUBY_PLATFORM
+  DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+  # :startdoc:
+
+  # Returns the path for Mr Bones. 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
+
+  # call-seq:
+  #    Bones.require_all_libs_relative_to( filename, directory = nil )
+  #
+  # 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
+
+  # call-seq:
+  #    Bones.setup
+  #
+  #
+  def self.setup
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+
+    if test(?e, local_setup)
+      load local_setup
+      return
+    end
+
+    bones_setup = ::Bones.path %w[lib bones tasks setup.rb]
+    load bones_setup
+
+    rakefiles = Dir.glob(File.join(Dir.pwd, %w[tasks *.rake])).sort
+    import(*rakefiles)
+  end
+
+  # TODO: fix file lists for Test::Unit and RSpec
+  #       these guys are just grabbing whatever is there and not pulling
+  #       the filenames from the manifest
+
+end  # module Bones
+
+Bones.require_all_libs_relative_to(__FILE__)
+
+# EOF

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[
+      .bnsignore
+      History.txt.bns
+      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/bones_spec.rb

@@ -0,0 +1,18 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe Bones do
+
+  before :all do
+    @root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+
+  it "finds things releative to 'root'" do
+    Bones.path(%w[lib bones debug]).
+        should == File.join(@root_dir, %w[lib bones debug])
+  end 
+    
+end  # describe Bones
+
+# 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/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/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# Equivalent to a header guard in C/C++
+# Used to prevent the spec helper from being loaded more than once
+unless defined? BONES_SPEC_HELPER
+BONES_SPEC_HELPER = true
+
+require 'stringio'
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib bones]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # 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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: TwP-bones
+version: !ruby/object:Gem::Version 
+  version: 2.3.0
+platform: ruby
+authors: 
+- Tim Pease
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-13 00:00:00 -08:00
+default_executable: bones
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.3
+    version: 
+description: 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).
+email: tim.pease@gmail.com
+executables: 
+- bones
+extensions: []
+
+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/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/foo/README.txt
+files: 
+- History.txt
+- README.rdoc
+- Rakefile
+- bin/bones
+- data/.bnsignore
+- data/History.txt.bns
+- 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/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
+has_rdoc: true
+homepage: http://codeforpeople.rubyforge.org/bones
+post_install_message: |
+  --------------------------
+   Keep rattlin' dem bones!
+  --------------------------
+
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: codeforpeople
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Mr Bones is a handy tool that builds a skeleton for your new Ruby projects
+test_files: []
+