stickler 0.1.0

data/lib/stickler/version.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2008 Jeremy Hinegardner
+# All rights reserved.  Licensed under the same terms as Ruby.  No warranty is
+# provided.  See LICENSE and COPYING for details.
+#++
+#
+module Stickler
+
+  # Version access in every possibly way that people might want to get it.
+  #
+  module Version
+
+    MAJOR = 0
+    MINOR = 1
+    BUILD = 0
+
+    def self.to_ary
+      [ MAJOR, MINOR, BUILD ]
+    end
+
+    def self.to_s
+      self.to_ary.join(".")
+    end
+
+    def self.to_hash
+      { :major => MAJOR, :minor => MINOR, :build => BUILD }
+    end
+
+    # Version string constant
+    STRING = Version.to_s.freeze
+    
+  end
+
+  # Version string constant
+  VERSION = Version.to_s.freeze
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
+require 'stickler'
+
+describe Stickler::Configuration do
+  before( :each ) do
+    @config_file_name = "/tmp/stickler.#{Process.pid}.yml"
+    FileUtils.cp Stickler::Paths.data_path( "stickler.yml"), @config_file_name 
+    @config = Stickler::Configuration.new( @config_file_name )
+  end
+
+  after( :each ) do
+    FileUtils.rm_f @config_file_name
+  end
+
+  %w[ downstream_source sources ].each do |key|
+    it "has a value for #{key}" do
+      @config.send( key ).should_not == nil
+    end
+  end
+
+  it "has an array of sources" do
+    @config.sources.should be_instance_of( Array )
+  end
+
+  it "can assign an arbitrary key/value pair like a hash" do
+    @config[:foo]  = 'bar'
+    @config['foo'].should == 'bar'
+  end
+
+  it "lists its keys" do
+    @config.keys.size.should > 0
+  end
+
+  it "can have gems added to it and reloaded" do
+    d = ::Gem::Dependency.new( 'rake', ">= 0.8.0" )
+    @config.gem_dependencies << d
+    @config.write
+
+    @config = Stickler::Configuration.new( @config_file_name )
+    @config.gem_dependencies.size.should == 1
+
+    @config.gem_dependencies.should be_include d
+
+  end
+
+  it "can have multiple requirements for each gem" do
+    d1 = ::Gem::Dependency.new( 'rake', ">= 0.8.0" )
+    @config.gem_dependencies << d1
+    d2 = ::Gem::Dependency.new( 'rake', ">= 0.8.0" )
+    @config.gem_dependencies << d2
+    @config.write
+
+    @config = Stickler::Configuration.new( @config_file_name )
+    @config.gem_dependencies.size.should == 2
+    @config.gem_dependencies.should be_include( d1 )
+    @config.gem_dependencies.should be_include( d2 )
+  end
+
+
+  it "can write the configuration back out to a file" do
+    @config.sources << "http://gems.github.com"
+    @config.write
+    @config = Stickler::Configuration.new( @config_file_name )
+    @config.sources.size.should == 2
+    @config.sources.should be_include( "http://gems.github.com/" )
+  end
+
+end

data/spec/paths_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+describe Stickler::Paths do
+  before(:each) do
+    @root_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    @root_dir += "/" 
+  end 
+
+  it "root dir should be correct" do
+    Stickler::Paths.root_dir.should == @root_dir
+  end 
+
+  it "config_path should be correct" do
+    Stickler::Paths.config_path.should == File.join(@root_dir, "config/")
+  end 
+
+  it "data path should be correct" do
+    Stickler::Paths.data_path.should == File.join(@root_dir, "data/")
+  end 
+
+  it "lib path should be correct" do
+    Stickler::Paths.lib_path.should == File.join(@root_dir, "lib/")
+  end 
+
+end

data/spec/repository_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
+require 'stickler'
+
+describe Stickler::Repository do
+
+  before( :each ) do
+    @top_dir = File.join( "/tmp/stickler" )
+    @repo = Stickler::Repository.new( 'directory' => @top_dir )
+    Stickler::Console.silent { @repo.setup }
+  end
+
+  after( :each ) do
+    FileUtils.rm_rf( @top_dir )
+  end
+
+
+  describe "#setup" do
+    %w[ gems log specifications dist cache].each do |sub_dir|
+      it "creates #{sub_dir} directory" do
+        new_dir = File.join( @top_dir , sub_dir )
+        File.directory?( new_dir ).should == true
+      end
+    end
+
+    it "setup creates a default stickler.yml file" do
+      s_yml = File.join( @top_dir, 'stickler.yml' )
+      s = YAML.load_file( s_yml )
+      s['sources'].size.should == 1
+      s['sources'].first.should == "http://gems.rubyforge.org"
+    end
+  end
+
+  describe "validity checks" do
+    %w[ gems log specifications dist cache].each do |sub_dir|
+      it "raises error if #{sub_dir} is missing" do
+        FileUtils.rmdir( File.join( @top_dir, sub_dir ) )
+        lambda { Stickler::Console.silent { @repo.valid! } }.should raise_error( Stickler::Repository::Error ) 
+      end
+
+      it "return false if #{sub_dir} is missing" do
+        FileUtils.rmdir( File.join( @top_dir, sub_dir ) )
+        Stickler::Console.silent{ @repo.should_not be_valid }
+      end
+    end
+
+    it "can create a valid directory system" do
+      @repo.should be_valid
+    end
+  end
+
+  it "creates a configuration" do
+    @repo.configuration['sources'].size.should == 1
+    @repo.configuration['sources'].first.should == "http://gems.rubyforge.org/"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec'
+
+$: << File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) )
+require 'stickler'

data/spec/version_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
+require 'stickler/version'
+
+describe "Stickler::Version" do
+  it "should have a version string" do
+    Stickler::Version.to_s.should =~ /\d+\.\d+\.\d+/
+    Stickler::VERSION.should =~ /\d+\.\d+\.\d+/
+  end
+
+  describe "has the version accessible as a hash" do
+    [ :major, :minor, :build ].each do |part|
+      it "#{part}" do
+        Stickler::Version.to_hash[ part ].to_s.should =~ /\d+/
+      end
+    end
+  end
+end

data/tasks/announce.rake

@@ -0,0 +1,39 @@
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# announcement methods
+#-------------------------------------------------------------------------------
+
+proj_config = Configuration.for('project')
+namespace :announce do
+  desc "create email for ruby-talk"
+  task :email do
+    info = Utils.announcement
+
+    File.open("email.txt", "w") do |mail|
+      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
+      mail.puts "To: ruby-talk@ruby-lang.org"
+      mail.puts "Date: #{Time.now.rfc2822}"
+      mail.puts "Subject: [ANN] #{info[:subject]}"
+      mail.puts
+      mail.puts info[:title]
+      mail.puts
+      mail.puts "  gem install #{Stickler::GEM_SPEC.name}"
+      mail.puts
+      mail.puts info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Stickler::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+    end 
+    puts "Created the following as email.txt:"
+    puts "-" * 72
+    puts File.read("email.txt")
+    puts "-" * 72
+  end 
+
+  CLOBBER << "email.txt"
+end
+

data/tasks/config.rb

@@ -0,0 +1,107 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "stickler"
+  version       Stickler::Version.to_s
+  author        "Jeremy Hinegardner"
+  email         "jeremy at copiousfreetime dot org"
+  homepage      "http://copiousfreetime.rubyforge.org/stickler"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE", "COPYING"]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    ext       FileList["ext/*.{c,h,rb}"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib
+    all       bin + ext + lib + test + data + rdoc + tasks 
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    gem Configuration::Table.has_key?('gem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("gem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#   - change mode to 'testunit' to use unit testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format specdoc --color ]
+  ruby_opts %w[ ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[ ]
+  test_files  Configuration.for('packaging').files.test
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers --inline-source ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+Configuration.for('extension') {
+  configs   Configuration.for('packaging').files.ext.find_all { |x| 
+                %w[ mkrf_conf.rb extconf.rb ].include?( File.basename(x) ) 
+            }
+}
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/stickler"
+}
+
+

data/tasks/distribution.rake

@@ -0,0 +1,38 @@
+require 'tasks/config'
+
+#-------------------------------------------------------------------------------
+# Distribution and Packaging
+#-------------------------------------------------------------------------------
+if pkg_config = Configuration.for_if_exist?("packaging") then
+
+  require 'gemspec'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/sshpublisher'
+
+  namespace :dist do
+
+    Rake::GemPackageTask.new(Stickler::GEM_SPEC) do |pkg|
+      pkg.need_tar = pkg_config.formats.tgz
+      pkg.need_zip = pkg_config.formats.zip
+    end
+
+    desc "Install as a gem"
+    task :install => [:clobber, :package] do
+      sh "sudo gem install pkg/#{Stickler::GEM_SPEC.full_name}.gem"
+    end
+
+    desc "Uninstall gem"
+    task :uninstall do 
+      sh "sudo gem uninstall -x #{Stickler::GEM_SPEC.name}"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+      puts Stickler::GEM_SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:uninstall, :repackage, :install]
+
+ end
+end

data/tasks/documentation.rake

@@ -0,0 +1,31 @@
+require 'tasks/config'
+
+#-----------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------
+
+if rdoc_config = Configuration.for_if_exist?('rdoc') then
+
+  namespace :doc do
+
+    require 'rake/rdoctask'
+
+    # generating documentation locally
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir   = rdoc_config.output_dir
+      rdoc.options    = rdoc_config.options
+      rdoc.rdoc_files = rdoc_config.files
+      rdoc.title      = rdoc_config.title
+      rdoc.main       = rdoc_config.main_page
+    end 
+
+    if rubyforge_config = Configuration.for_if_exist?('rubyforge') then
+      desc "Deploy the RDoc documentation to #{rubyforge_config.rdoc_location}"
+      task :deploy => :rerdoc do
+        sh "rsync -zav --delete #{rdoc_config.output_dir}/ #{rubyforge_config.rdoc_location}"
+      end 
+    end 
+
+  end 
+end
+

data/tasks/rspec.rake

@@ -0,0 +1,29 @@
+
+require 'tasks/config'
+
+#--------------------------------------------------------------------------------
+# configuration for running rspec.  This shows up as the test:default task
+#--------------------------------------------------------------------------------
+if spec_config = Configuration.for_if_exist?("test") then
+  if spec_config.mode == "spec" then
+    namespace :test do
+
+      task :default => :spec
+
+      require 'spec/rake/spectask'
+      Spec::Rake::SpecTask.new do |r| 
+        r.ruby_opts   = spec_config.ruby_opts
+        r.libs        = [ Stickler::Paths.lib_path, 
+                          Stickler::Paths.root_dir ]
+        r.spec_files  = spec_config.files 
+        r.spec_opts   = spec_config.options
+
+        if rcov_config = Configuration.for_if_exist?('rcov') then
+          r.rcov      = true
+          r.rcov_dir  = rcov_config.output_dir
+          r.rcov_opts = rcov_config.rcov_opts
+        end
+      end
+    end
+  end
+end