crate 0.1.1

data/lib/crate/ruby.rb

@@ -0,0 +1,98 @@
+require 'crate/dependency'
+require 'crate/gem_integration'
+
+module Crate
+  class Ruby < Dependency
+    #
+    # Create a Crate Ruby with the given name and version
+    #
+    def initialize( name = nil, version = nil )
+      @name = name
+      @version = version
+      @install_commands = []
+      @build_commands = []
+      yield self if block_given?
+      @upstream_source = URI.parse( @upstream_source )
+      define unless name.nil? or version.nil?
+      ::Crate.ruby = self
+    end
+
+
+    #
+    # Define all the tasks in the namespace of the +name+ of this task.
+    #
+    # The dependency chain is:
+    #
+    #   :install => :build => :integration => :extensions => :patch => :unpack => :verify => :download
+    #
+    #
+    def define
+      logger.debug "Defining tasks for #{name} #{version}"
+
+      namespace name do
+        define_download
+        define_verify
+        define_unpack
+        define_patch
+        define_extensions
+        define_integration
+
+        desc "Integrate ruby modules into final source" 
+        task :integration => "#{name}:patch"
+        file dotfile('build') => "#{name}:integration"
+
+
+        define_build
+
+        define_install
+
+        task :done    => "#{name}:install"
+        task :default => "#{name}:done"
+      end
+
+      desc "Build and Integrate #{name} #{version}"
+      task name => "#{name}:default"
+    end
+
+    def lib_dir
+      File.join( pkg_dir, "lib" )
+    end
+
+    def ext_dir
+      File.join( pkg_dir, "ext" )
+    end
+
+    def ext_setup_file
+      File.join( ext_dir, "Setup" )
+    end
+
+    # 
+    # Define the task that overwrites the ext/Setup file
+    #
+    def define_extensions
+      desc "Overwrite the ext/Setup file"
+      task :extensions => "#{name}:patch" do
+        logger.info "Rewriting ext/Setup file"
+        File.open( ext_setup_file, "w") do |f|
+          f.puts "option nodynamic"
+          f.puts
+          ::Crate.project.extensions.each do |e|
+            f.puts e
+          end
+        end
+      end
+    end
+
+    #
+    # Add in an integration task that depends on all the Integeration object's
+    # name:default task
+    #
+    def define_integration
+    end
+
+    def integrates( other )
+      task "#{name}:integration" => "#{other}:integration"
+      task "#{other}:integration" => "#{name}:extensions"
+    end
+  end
+end

data/lib/crate/utils.rb

@@ -0,0 +1,74 @@
+require 'archive/tar/minitar'
+require 'zlib'
+require 'open-uri'
+require 'fileutils'
+require 'progressbar'
+require 'rubygems/installer'
+
+module Crate
+  #
+  # Utiltiy methods useful for many items
+  module Utils
+    #
+    # Changes into a directory and unpacks the archive.
+    #
+    def unpack( archive, into = Dir.pwd )
+      Dir.chdir( into ) do 
+        if archive.match( /\.tar\.gz\Z/ ) or archive.match(/\.tgz\Z/) then
+          tgz = ::Zlib::GzipReader.new( File.open( local_source, 'rb') )
+          ::Archive::Tar::Minitar.unpack( tgz, into )
+        elsif archive.match( /\.gem\Z/ ) then
+          subdir = File.basename( archive, ".gem" )
+          Gem::Installer.new( archive ).unpack( subdir )
+        else
+          raise "Unable to extract files from #{File.basename( local_source)} -- unknown format"
+        end
+      end
+    end
+
+    #
+    # Verify the given file against a digest value.  If the digest value is nil
+    # then it is a no-op.
+    #
+    def verify( file, against = nil )
+      return ( against ? against.verify( file ) : true )
+    end
+
+    #
+    # download the given URI to a specified location, show progress with a
+    # progress bar.
+    #
+    def download( uri, to )
+      to_dir = File.dirname( to )
+      FileUtils.mkdir_p( to_dir ) unless File.directory?( to_dir )
+
+      pbar = nil 
+      File.open( to , "w" ) do |outf|
+        begin
+          uri.open( :content_length_proc => lambda { |t| pbar = ::ProgressBar.new( File.basename( local_source ), t ) if  t && 0 < t  },  
+                    :progress_proc       => lambda { |s| pbar.set s if pbar } ) do |inf|
+            outf.write inf.read
+          end 
+        rescue => e
+          puts
+          STDERR.puts "Error downloading #{uri.to_s} : #{e}"
+          exit 1
+        end
+      end
+    end
+
+    #
+    # Apply the given patch file in a particular directory
+    #
+    def apply_patch( patch_file, location )
+      Dir.chdir( location ) do
+        %x[ patch -p0 < #{patch_file} ]
+      end
+    end
+
+    #
+    # Wrap a command sending its output to the the Crate.project logger at the
+    # debug level
+    #
+  end
+end

data/lib/crate/version.rb

@@ -0,0 +1,26 @@
+#--
+# Copyright (c) 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details
+#++
+
+module Crate
+  module Version
+    MAJOR   = 0
+    MINOR   = 1
+    BUILD   = 1
+
+    def to_a 
+      [MAJOR, MINOR, BUILD]
+    end
+
+    def to_s
+      to_a.join(".")
+    end
+
+    module_function :to_a
+    module_function :to_s
+
+    STRING = Version.to_s
+  end
+  VERSION = Version.to_s
+end

data/spec/crate_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
+
+describe Crate do
+  before(:each) do
+    # some setup
+  end
+
+  after(:each) do
+    # some cleanup
+  end
+
+  it "should have some tests" do
+    violated("I just want to be tested... is that so wrong?")
+  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 'crate'

data/tasks/announce.rake

@@ -0,0 +1,38 @@
+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 info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Crate::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+      mail.puts info[:urls]
+    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,98 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "crate"
+  version       "0.1.0"
+  author        "Jeremy Hinegardner"
+  email         "jeremy@copiousfreetime.org"
+  homepage      "http://copiousfreetime.rubyforge.org/crate"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE", ]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    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 + lib + test + data + rdoc + tasks 
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    rubygem Configuration::Table.has_key?('rubygem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("rubygem") {
+  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"
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/crate"
+}
+
+

data/tasks/distribution.rake

@@ -0,0 +1,46 @@
+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(Crate::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/#{Crate::GEM_SPEC.full_name}.gem"
+    end
+
+    desc "Uninstall gem"
+    task :uninstall do 
+      sh "sudo gem uninstall -x #{Crate::GEM_SPEC.name}"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+      puts Crate::GEM_SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:uninstall, :repackage, :install]
+
+
+    desc "distribute copiously"
+    task :copious => [ :package ] do
+      Rake::SshFilePublisher.new('jeremy@copiousfreetime.org',
+                                 '/var/www/vhosts/www.copiousfreetime.org/htdocs/gems/gems',
+                                 'pkg' ,"#{Crate::GEM_SPEC.full_name}.gem").upload
+      sh "ssh jeremy@copiousfreetime.org rake -f /var/www/vhosts/www.copiousfreetime.org/htdocs/gems/Rakefile"
+    end
+  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        = [ Crate.lib_path, 
+                          Crate.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