jrun-rstack 0.5.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Jeremy Burks
+
+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/README.textile

@@ -0,0 +1,57 @@
+h2. Why?
+
+"newgem":http://newgem.rubyforge.org/ and "hoe":http://seattlerb.rubyforge.org/hoe/ work great for open source projects. RStack is intended to be used behind the firewall. There are a couple of other differences. One being it uses "RSpec":http://rspec.info/ rather than test/unit. The second difference is RStack automatically works with "CruiseControl.rb":http://cruisecontrolrb.thoughtworks.com/. It does that by adding a @cruise_config.rb@ configuration and by including a @cruise@ task.
+
+h2. Usage
+
+<pre><code>
+rstack ninjas
+</code></pre>
+
+h2. Generated Files and Directories
+
+<pre><code>
+jrun ~/tmp $ rstack ninjas
+creating ninjas/lib/ninjas
+creating ninjas/spec/shared
+creating ninjas/spec
+creating ninjas/bin
+creating ninjas/lib
+creating ninjas/lib
+moving Rakefile to ninjas/Rakefile
+moving README.txt to ninjas/README.txt
+moving cruise_config.rb to ninjas/cruise_config.rb
+moving main.rb to ninjas/lib/ninjas.rb
+moving version.rb to ninjas/lib/ninjas/version.rb
+moving spec_helper.rb to ninjas/spec/spec_helper.rb
+</pre></code>
+
+h2. Generated Rakefile
+
+<pre><code>
+require 'rubygems'
+require 'rstack'
+require File.join(File.dirname(__FILE__), 'lib', 'ninjas', 'version')
+
+RStack::Configuration.new 'ninjas' do |config|
+  config.summary = '[ENTER A SUMMARY]'
+  config.author = 'jrun'
+  config.email = '[ENTER YOUR EMAIL]'
+  config.url = '[ENTER A PROJECT URL]'
+  config.version = Ninjas::Version::STRING
+end
+</pre></code>
+
+h2. Available Tasks
+<pre><code>
+jrun ~/tmp/ninjas $ rake -T
+(in /Users/jrun/tmp/ninjas)
+rake clobber_package             # Remove package products
+rake clobber_spec:with_coverage  # Remove rcov products for spec:with_coverage
+rake gem                         # Build the gem file ninjas-0.1.0.gem
+rake package                     # Build all the packages
+rake repackage                   # Force a rebuild of the package files
+rake spec                        # Run specs
+rake spec:with_coverage          # Run specs through RCov and generate HTML...
+</code></pre>
+

data/Rakefile

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rstack'
+
+RStack::Configuration.new 'rstack' do |config|
+  config.summary            = "Provides a gem library generator and helpful rake tasks"
+  config.author             = 'jeremy burks'
+  config.email              = "jeremy.burks@gmail.com"
+  config.url                = "http://github.com/jrun/rstack/wikis"
+  config.has_rdoc           = true
+  config.version            = RStack::Version::STRING
+  config.executables        = ["rstack"]
+  config.package_filelist.add  *['templates/**/*', 'vendor/**/*']
+end

data/bin/rstack

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'rstack'
+require 'optparse'
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Generate a standardized gem which uses rspec.
+
+Usage: rstack [ENTER NAME OF GEM]
+
+Options:
+BANNER
+  opts.on("-h", "--help", "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+end
+parser.parse!(["-h"]) unless ARGV[0]
+
+RStack::Generator.new(ARGV[0]).run

data/lib/rstack/configuration.rb

@@ -0,0 +1,67 @@
+module RStack
+  class Configuration        
+    attr_accessor :gem_name, :summary, :author, :email, :url, :version,
+                  :platform, :spec_filelist, :package_filelist, :require_path,
+                  :has_rdoc, :rdoc_files, :outpath, :executables, :dependencies
+    
+    attr_reader :outpath
+    
+    def initialize(gem_name)
+      @gem_name         = gem_name
+      @summary          = '[ENTER A SUMMARY]'
+      @author           = '[ENTER A AUTHOR]'
+      @email            = '[ENTER YOUR EMAIL]'
+      @url              = '[ENTER A PROJECT URL]'
+      @require_path     = 'lib'
+      @version          = "0.1.0"
+      @platform         = ::Gem::Platform::RUBY
+      @package_filelist = FileList['[a-zA-Z]*', 'bin/**/*', 'lib/**/*', 'spec/**/*']
+      @spec_filelist    = FileList['spec/**/*_spec.rb']
+      @rdoc_files       = ['README.txt', 'CHANGELOG.txt', "LICENSE.txt", 'lib/**/*.rb']  
+      @has_rdoc         = false
+      @executables      = []
+      @dependencies     = {}
+
+      @outpath = ENV["CC_BUILD_ARTIFACTS"] || default_outpath
+      
+      unless File.exist?(@outpath)
+        FileUtils.mkdir(@outpath) 
+      end
+
+      yield self if block_given?
+
+      define_tasks
+    end
+    
+    def files
+      @files ||= filelist_to_cleaned_a @package_filelist
+    end
+    
+    def spec_files
+      @spec_files ||= filelist_to_cleaned_a @spec_filelist
+    end
+    
+    def define_tasks
+      RSpec.define_tasks  self
+      Gem.define_tasks    self
+      RDoc.define_tasks   self if @has_rdoc
+            
+      task :default => :spec
+      task :repackage => "spec:with_coverage"
+      task :cruise  do
+        ::Rake::Task[:repackage].invoke
+        ::Rake::Task[:rdoc].invoke if @has_rdoc
+      end
+    end
+    
+    def filelist_to_cleaned_a(filelist)
+      filelist.to_a.delete_if {|file| file.include?('.svn') || file.include?('rdoc') } 
+    end
+    private :filelist_to_cleaned_a
+    
+    def default_outpath
+      FileUtils.getwd / 'out'
+    end
+    private :default_outpath
+  end
+end

data/lib/rstack/generator.rb

@@ -0,0 +1,58 @@
+module RStack
+  class Generator
+    
+    attr_reader :project_name, :pathized_project_name, :path, :main, :main_path, 
+                :module_name, :templates_path
+    
+    def initialize(project_name)
+      @project_name           = project_name.downcase
+      @pathized_project_name  = @project_name.to_const_path
+      @module_name            = @pathized_project_name.camel_case
+      @path                   = Pathname.new(@project_name)
+      
+      parts = @pathized_project_name.split("/")
+      @main = parts.last + ".rb"
+      @main_path = Pathname.new((parts - [parts.last]).join("/"))
+      @templates_path = Pathname.new(RStack.root) / 'templates'     
+    end
+    
+    def paths
+      {
+        :bin      => path / "bin",
+        :lib      => path / 'lib',
+        :main     => path / "lib" / @main_path,
+        :project  => path / "lib" / @pathized_project_name,
+        :spec     => path / "spec"
+      }
+    end
+        
+    def run
+      create_directories
+      move_template "Rakefile",         path / "Rakefile"
+      move_template "README.txt",       path / "README.txt"
+      move_template "cruise_config.rb", path / "cruise_config.rb"      
+      move_template "main.rb",          paths[:main] / @main
+      move_template "version.rb",       paths[:project] / "version.rb"
+      move_template "spec_helper.rb",   paths[:spec] / "spec_helper.rb"
+    end
+  
+    def create_directories
+      paths.values.each do |path|
+        puts "creating #{path}"
+        path.mkpath
+      end
+    end
+
+    def move_template(template_name, destination_path)
+      puts "moving #{template_name} to #{destination_path}"
+      contents = File.read(templates_path + template_name)
+      File.open(destination_path, 'w') do |f| 
+        f << eval('"' + contents + '"')
+      end
+    end
+    
+    def author
+      ENV['USERNAME'] || ENV['USER'] || '[ENTER YOUR USERNAME]'
+    end
+  end
+end

data/lib/rstack/tasks/doc.rb

@@ -0,0 +1,15 @@
+module RStack
+  class RDoc
+    def self.define_tasks(configuration)
+      require 'rake/rdoctask'
+      ::Rake::RDocTask.new do |rdoc|
+        rdoc.rdoc_files.add configuration.rdoc_files
+        rdoc.rdoc_dir = configuration.outpath + '/doc'
+        rdoc.title    = "#{configuration.gem_name} -- #{configuration.version}"
+        rdoc.main     = 'README.txt'
+        rdoc.template = RStack.vendor / 'allison-2.0.2' / 'lib' / 'allison.rb'
+        rdoc.options  << '--line-numbers' << '--inline-source'
+      end      
+    end
+  end
+end

data/lib/rstack/tasks/gem.rb

@@ -0,0 +1,52 @@
+module RStack
+  class Gem
+    def self.define_tasks(configuration)
+      spec = ::Gem::Specification.new do |s|
+        s.name      = configuration.gem_name
+        s.version   = configuration.version
+        s.platform  = configuration.platform
+        s.summary   = configuration.summary
+        s.author    = configuration.author
+        s.email     = configuration.email
+        s.homepage  = configuration.url
+
+        unless configuration.gem_name == 'rstack'
+          s.add_dependency "rstack", ">= #{RStack::Version::STRING}"
+        end
+        
+        s.add_dependency 'rake',          '>= 0.8.1'
+        s.add_dependency 'rcov',          '>= 0.8.0'
+        s.add_dependency 'diff-lcs',      '>= 1.1.2'        
+        s.add_dependency 'rspec',         '>= 1.1.3'
+        s.add_dependency 'extlib'
+
+        configuration.dependencies.each do |dependency, version|
+          s.add_dependency dependency, version
+        end
+              
+        s.files             = configuration.files
+        s.executables       = configuration.executables
+        s.require_path      = configuration.require_path
+        s.has_rdoc          = configuration.has_rdoc
+        #s.extra_rdoc_files  = ["README.txt"]
+      end
+      ::Rake::GemPackageTask.new(spec) { |p| p.gem_spec = spec }
+            
+      namespace :gem do
+        desc "Repackage gem, uninstall and install again (does not use sudo)."
+        task :refresh => :repackage do
+          system "gem uninstall #{configuration.gem_name} -v #{configuration.version}"
+          system "gem install pkg/#{configuration.gem_name}-#{configuration.version}.gem"
+        end
+        
+        desc "Create a gemspec file"
+        task :spec do
+          File.open("#{configuration.gem_name}.gemspec", "w") do |file|
+            file.puts spec.to_ruby
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/rstack/tasks/rspec.rb

@@ -0,0 +1,24 @@
+module RStack
+  class RSpec
+    def self.define_tasks(configuration)
+      ::Spec::Rake::SpecTask.new do |t|        
+        t.spec_opts = if File.exist?('spec/spec.opts')
+          ['-O', 'spec/spec.opts' ]
+        else
+          ['--format', 'specdoc', '--diff', '--color']
+        end
+        t.spec_files = configuration.spec_files
+      end
+      
+      desc "Run specs through RCov and generate HTML reports"
+      ::Spec::Rake::SpecTask.new('spec:with_coverage') do |t|
+        t.rcov_dir      = configuration.outpath / 'coverage'
+        t.spec_files    = configuration.spec_files
+        t.spec_opts     = ["--format", "html:#{configuration.outpath}/spec_report.html", "--diff"]
+        t.fail_on_error = false
+        t.rcov          = true
+        t.rcov_opts << '--no-rcovrt' # required or rcov will fail
+      end      
+    end
+  end
+end

data/lib/rstack/version.rb

@@ -0,0 +1,9 @@
+module RStack #:nodoc:
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/rstack.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'extlib'
+
+module RStack
+  def self.root
+    Pathname.new(File.dirname(__FILE__)).parent.expand_path
+  end
+  
+  def self.vendor
+    root / 'vendor'
+  end
+end
+
+Pathname.glob((RStack.vendor / '**').to_s).each do |dir| 
+  $:.unshift File.directory?(lib = "#{dir}/lib") ? lib : dir
+end
+
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+require 'rstack/version'
+require 'rstack/configuration'
+require 'rstack/generator'
+
+Pathname.glob((RStack.root / 'lib/rstack/tasks/*.rb').to_s).each {|f| require f }

data/spec/configuration_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe RStack::Configuration do
+  before(:each) do
+    @config = RStack::Configuration.new('rstack')
+  end
+  
+  it "should have a #gem_name equal to the name give to initialize" do
+    @config.gem_name.should == 'rstack'
+  end
+  
+  it "should default the version to 0.1.0" do
+    @config.version.should == '0.1.0'
+  end
+  
+  it "should default the require path to 'lib'" do
+    @config.require_path.should == 'lib'
+  end
+  
+  it "should default the platform to ruby" do
+    @config.platform.should == Gem::Platform::RUBY
+  end
+
+  it "should define a 'spec' task" do
+    Rake::Task.should be_task_defined("spec")
+  end
+  
+  it "should define a 'spec:full' task" do
+    Rake::Task.should be_task_defined("spec:with_coverage")
+  end
+  
+  it "should not define a 'rdoc' task by default" do
+    Rake::Task.should_not be_task_defined("rdoc")
+  end
+  
+  it "should define a repackage task" do
+    Rake::Task.should be_task_defined("repackage")
+  end
+  
+  it "should define an rdoc task if 'has_rdoc' is true" do
+    RStack::Configuration.new('rstack') {|config| config.has_rdoc = true }
+    Rake::Task.should be_task_defined("rdoc")    
+  end
+  
+  it "should define a 'cruise' task" do
+    Rake::Task.should be_task_defined("cruise")
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe RStack::Generator do
+  before(:each) do
+    @generator = RStack::Generator.new("Foo")
+  end
+  
+  it "should assign the given project name downcased to the project name attribute" do
+    @generator.project_name.should == "foo"
+  end
+  
+  it "should assign the given project name classified to the module name attribute" do
+    generator = RStack::Generator.new("classified_project")
+    generator.module_name.should == "ClassifiedProject"
+  end
+
+  it "should have a path equal to the project name" do
+    @generator.path.should == Pathname.new(@generator.project_name)
+  end
+  
+  it "should have a pathized project name" do
+    @generator.pathized_project_name.should == "foo"
+  end
+    
+  it "should assign the last element to be the name of main .rb file" do
+    @generator.main.should == "foo.rb"
+  end
+  
+  it "should have a lib path should include the elements of the dasherized project name" do
+    @generator.paths[:lib].to_s.should == RStack.root.to_s / "foo/lib"
+  end
+  
+  it "should have a main path that includes all the pathized elements but the last" do
+    @generator.paths[:main].to_s.should == RStack.root.to_s / "foo/lib"
+  end
+
+  it "should have a project path that includes the pathized elements" do
+    @generator.paths[:project].to_s.should == RStack.root.to_s / "foo/lib/foo"
+  end    
+end
+
+describe RStack::Generator, "#move_template" do
+  before(:each) do
+    File.stub!(:read).and_return("foo")
+    File.stub!(:open)
+    @generator = RStack::Generator.new("foo")
+  end
+  
+  it "should read the given template file from template path" do
+    File.should_receive(:read).with(@generator.templates_path + 'template_file')
+    @generator.move_template("template_file", "destination_file")
+  end
+  
+  it "should write the given destination file to the gem path" do
+    File.should_receive(:open).with("destination_path", 'w')
+    @generator.move_template("template_file", "destination_path")    
+  end
+end
+
+describe RStack::Generator, "#templates_path" do
+  before(:each) do
+    @generator = RStack::Generator.new("foo")
+  end
+  
+  it "should be an instance of Pathname" do
+    @generator.templates_path.should be_instance_of(Pathname)
+  end
+  
+  it "should start with RSTACK_ROOT" do
+    @generator.templates_path.to_s.starts_with?(RStack.root).should be_true
+  end
+  
+  it "should exist" do
+    File.exist?(@generator.templates_path).should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rstack'
+
+# extension modules for use in specs
+Dir.glob(File.dirname(__FILE__) + '/shared/*.rb').each {|f| require f }
+
+module SpecHelper
+  def null_mock(name, options = {})
+    mock name, options.merge(:null_object => true)
+  end
+  
+  alias :null_stub :null_mock
+end
+
+Spec::Runner.configure do |config|
+  config.include(SpecHelper)
+  
+  # config.before(:each) do
+  # end
+end

data/spec/tasks/doc_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe RStack::RDoc, 'defining a task' do
+  before(:each) do
+    @config = stub_everything :configuration
+    @config.stub!(:to_str).and_return('')
+    @task = RStack::RDoc.define_tasks @config
+  end
+  
+  it "should define a valid template path" do
+    @task.template.should exist
+  end
+end

data/templates/README.txt

@@ -0,0 +1 @@
+== README

data/templates/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rstack'
+require File.join(File.dirname(__FILE__), 'lib', '#{pathized_project_name}', 'version')
+
+RStack::Configuration.new '#{project_name}' do |config|
+  config.summary  = '[ENTER A SUMMARY]'
+  config.author   = '#{author}'
+  config.email    = '[ENTER YOUR EMAIL]'
+  config.url      = '[ENTER A PROJECT URL]'
+  config.version  = #{module_name}::Version::STRING
+end

data/templates/cruise_config.rb

@@ -0,0 +1,10 @@
+Project.configure do |project|  
+  # Send email notifications about broken and fixed builds to email1@your.site, email2@your.site (default: send to nobody)
+  project.email_notifier.emails = []
+
+  # Build the project by invoking rake task 'custom'
+  # project.rake_task = 'repackage:full'
+
+  # Ping Subversion for new revisions every 5 minutes (default: 30 seconds)
+  # project.scheduler.polling_interval = 5.minutes
+end

data/templates/main.rb

@@ -0,0 +1 @@
+$:.unshift File.exapnd_path(File.dirname(__FILE__))

data/templates/spec_helper.rb

@@ -0,0 +1,14 @@
+require '#{main.chomp('.rb')}'
+
+module SpecHelper
+  def null_mock(name, options = {})
+    mock name, options.merge(:null_object => true)
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(SpecHelper)
+  
+  # config.before(:each) do
+  # end
+end

data/templates/version.rb

@@ -0,0 +1,8 @@
+#{mods = ''; module_name.split('::').each_with_index {|mod, i| mods << 'module ' << mod << ' #:nodoc' << $/ << ('  ' * i)}; mods}module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+#{ends = ''; module_name.split('::').each {|mod| ends << 'end' << $/ }; ends;}

data/vendor/allison-2.0.2/CHANGELOG

@@ -0,0 +1,16 @@
+
+v2.0.2. Let's not talk about that.
+
+v2.0.1. Remove PROJECT constant which isn't even used, gosh (Adam).
+
+v2.0. Visual redesign. Gem version. 'allison' command line tool.
+
+v1.5. RDoc.
+
+v1.4. Again.
+
+v1.3. Hack to make gem versioning work.
+
+v1.2. Caching in order to remove Markaby dependency.
+
+v1. First release.