burke 0.1.0 → 0.2.0

data/README.rdoc

@@ -0,0 +1,66 @@
+= Burke
+
+== Synopsis
+
+Burke provides a bunch of helpers to make creating Rake files a little more
+pleasant. There are many subjective elements to this project, particularly
+when it comes to sensible defaults, but popular Ruby conventions are adhered to
+where possible. The project is named after Don Burke, host of an Australian
+gardening and home improvement show named Burke's Backyard
+(http://www.burkesbackyard.com.au).
+
+== Features
+
+* DRY definition of Gem packages for multiple platforms
+* Recovery from missing libraries like Yard and RSpec
+
+== Example
+
+Here is a sample Rakefile using Burke.
+
+  require 'rubygems'
+  require 'burke'
+  require 'fileutils'
+  
+  # Enable all tasks possible
+  Burke.enable_all
+  
+  # Give Burke some data about the project
+  Burke.setup do |s|
+    s.name = 'foo'
+    s.version = '1.2.3'
+    s.summary = 'an example Ruby library with extra foo'
+    s.files = FileList['lib/**/*.rb']
+    
+    s.docs do |d|
+      d.readme = 'README'
+      d.markup = 'rdoc'
+    end
+    
+    s.gems do |g|
+      g.platform 'ruby'
+      
+      g.platform 'x86-linux' do |p|
+        p.before do |s|
+          FileUtils.copy 'native/libfoo-x86-linux.so', 'lib/libfoo.so'
+          s.add_dependency 'ffi'
+          s.files += ['lib/libfoo.so']
+        end
+        
+        p.after do
+          FileUtils.remove 'lib/libfoo.so'
+        end
+      end
+    end
+  end
+
+== Default attributes
+
+* +version+ inferred from contents of 'VERSION' file
+* +files+ all files in 'lib' and 'spec' plus detected 'README', 'VERSION',
+  'LICENSE', 'COPYING' and/or 'Rakefile'
+* +docs.readme+ inferred from files matching 'README[\..*]?', case ignored
+* +docs.markup+ inferred from extension of detected README file
+* +rspec.spec_files+ 'spec/**/*_spec.rb'
+* +rspec.color+ true
+

data/Rakefile

@@ -0,0 +1,26 @@
+$LOAD_PATH << File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
+require 'burke'
+
+Burke.enable_all
+
+Burke.setup do |s|
+  s.name = 'burke'
+  s.summary = 'Helper for creating nice and clean Rake files'
+  s.author = 'Aiden Nibali'
+  s.email = 'dismal.denizen@gmail.com'
+  s.homepage = "http://github.com/dismaldenizen/burke"
+  
+  s.dependencies do |d|
+    d.rake '~> 0.8.7'
+  end
+  
+  s.has_rdoc = true
+  
+  s.clean = %w[.yardoc]
+  s.clobber = %w[pkg doc html]
+  
+  s.gems do |g|
+    g.platform 'ruby'
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/burke.rb

@@ -2,150 +2,320 @@ require 'rubygems'
 require 'rubygems/installer'
 require 'rake'
 require 'rake/tasklib'
-
-desc "Build gems for all targets"
-task :gems
+require 'mash'
 
 module Burke
-  VERSION = '0.1.0'
+  VERSION = File.read(File.join(File.dirname(File.dirname(__FILE__)), 'VERSION'))
+  @tasks = []
   
   class << self
-    def base_spec
-      @base_spec ||= Gem::Specification.new
-      yield @base_spec if block_given?
-      @base_spec
+    def enable_all opts={}
+      @tasks = %w[clean yard rdoc rspec rspec_rcov gems install].map {|t| t.to_sym}
+      disable opts[:except] if opts[:except]
     end
     
-    def package_task *args, &block
-      Rake::GemPackageTask.new *args, &block
+    def enable *args
+      @tasks.concat([*args].map {|t| t.to_sym})
+      @tasks.uniq!
     end
     
-    def install_task *args, &block
-      Rake::GemInstallTask.new *args, &block
+    def disable *args
+      dis = [*args].map {|t| t.to_sym}
+      @tasks.reject! {|t| dis.include? t}
     end
     
-    def yard_task *args, &block
+    def setup
+      @settings = Mash[
+        :dependencies => Mash[],
+        :docs => Mash[],
+        :rspec => Mash[:rcov => Mash[]],
+        :gems => GemSettings.new,
+        :clean => [],
+        :clobber => [],
+      ]
+      
+      @settings.files = Dir.glob('{lib,spec}/**/*')
+      %w[Rakefile COPYING LICENSE].each do |file|
+        @settings.files << file if File.exists?(file)
+      end
+      
+      project_files = Dir['*'].reject! {|f| File.directory? f or !File.readable? f}
+      
+      version_file = 'VERSION'
+      if File.readable?(version_file)
+        @settings.version = File.read(version_file).strip
+        @settings.files << version_file
+      end
+      
+      license_file = nil
+      project_files.each do |f|
+        if %w[license licence copying].include? f.downcase.split('.').first
+          license_file = f
+        end
+      end
+      
+      if license_file
+        @settings.docs.license = license_file
+        @settings.files << license_file
+      end
+      
+      readme_file = nil
+      project_files.each do |f|
+        if f.downcase =~ /readme[\..*]?/
+          readme_file = f if readme_file.nil? or f.length < readme_file.length
+        end
+      end
+      
+      if readme_file
+        @settings.docs.readme = File.basename readme_file
+        @settings.files << readme_file
+        @settings.docs.markup = case File.extname(readme_file).downcase
+        when '.rdoc'
+          'rdoc'
+        when '.md'
+          'markdown'
+        when '.textile'
+          'textile'
+        end
+      end
+      
+      @settings.rspec.spec_files = Dir['spec/**/*_spec.rb']
+      @settings.rspec.color = true
+      
+      yield @settings
+      
+      begin
+        require 'rake/clean'
+        CLOBBER.include(*@settings.clobber) if @settings.clobber
+      rescue LoadError
+      end if @tasks.include? :clean
+      
+      unless @settings.docs.files
+        d = @settings.docs
+        fl = FileList.new
+        fl.include "lib/**/*.rb"
+        fl.include d.readme if d.readme
+        fl.include d.license if d.license
+        d.files = fl.to_a
+      end
+      
       begin
         require 'yard'
-        YARD::Rake::YardocTask.new *args, &block
+        opts = []
+        d = @settings.docs
+        opts << "--title" << "#{@settings.name} #{@settings.version}"
+        opts << "--readme" << d.readme if d.readme
+        opts << "--markup" << d.markup if d.markup
+        extra_files = [d.license].compact
+        opts << "--files" << extra_files.join(',') unless extra_files.empty?
+        YARD::Rake::YardocTask.new 'yard' do |t|
+          t.options = opts
+        end
+      rescue LoadError
+      end if @tasks.include? :yard
+      
+      begin
+        require 'rake/rdoctask'
+        d = @settings.docs
+        Rake::RDocTask.new 'rdoc' do |r|
+          r.rdoc_files.include d.files
+          r.title = "#{@settings.name} #{@settings.version}"
+          r.main = d.readme if d.readme
+        end
       rescue LoadError
-        puts "Couldn't load Yard: generation of Yard docs is disabled"
+      end if @tasks.include? :rdoc
+      
+      if @settings.has_rdoc
+        d = @settings.docs
+        (@settings.extra_rdoc_files ||= []).concat d.files
+        opts = []
+        opts << "--title" << "#{@settings.name} #{@settings.version}"
+        opts << "--main" << d.readme if d.readme
+        @settings.rdoc_options ||= opts
       end
-    end
-    
-    def spec_task *args, &block
+      
       begin
         require 'spec/rake/spectask'
-        Spec::Rake::SpecTask.new *args, &block
+        r = @settings.rspec
+        opts = []
+        opts << "--colour" if r.color
+        opts << "--format" << r.format if r.format
+        Spec::Rake::SpecTask.new 'spec' do |t|
+          t.spec_files = r.spec_files
+          t.spec_opts = opts
+        end unless r.empty?
+        
+        begin
+          require 'spec/rake/verify_rcov'
+          
+          desc "Run specs with RCov"
+          Spec::Rake::SpecTask.new('spec:rcov') do |t|
+            t.spec_files = r.spec_files
+            t.spec_opts = opts
+            t.rcov = true
+            t.rcov_opts = ['--exclude', 'spec']
+          end
+
+          RCov::VerifyTask.new('spec:rcov:verify' => 'spec:rcov') do |t|
+            t.threshold = r.rcov.threshold
+            t.index_html = 'coverage/index.html'
+          end if r.rcov.threshold
+        rescue LoadError
+        end if @tasks.include? :rspec_rcov
       rescue LoadError
-        puts "Couldn't load RSpec: running of RSpec examples is disabled"
+      end if @tasks.include? :rspec
+      
+      begin
+        settings.gems.individuals.each do |conf|
+          GemTaskManager.add_task conf
+        end
+        
+        if name
+          desc "Build gem for this platform"
+          task(:gem => GemTaskManager.task_for_this_platform.task_name)
+        end
+      rescue LoadError
+      end if @tasks.include? :gems
+      
+      if @tasks.include? :install
+        GemTaskManager.install_task unless GemTaskManager::TASKS.empty?
       end
+      
+      @settings
     end
     
-    def rcov_verify_task *args, &block
-      begin
-        require 'spec/rake/verify_rcov'
-        RCov::VerifyTask.new *args, &block
-      rescue LoadError
-        puts "Couldn't load RSpec and RCov: verification of code coverage with RCov is disabled"
+    def base_gemspec
+      if @base_gemspec.nil?
+        @base_gemspec = Gem::Specification.new
+        
+        attrs = Gem::Specification.attribute_names
+        attrs -= [:dependencies]
+        attrs += [:author]
+        
+        attrs.each do |attr|
+          value = @settings.send(attr)
+          @base_gemspec.send("#{attr}=", value) if value
+        end
+        
+        @settings.dependencies.each do |gem, version|
+          @base_gemspec.add_dependency gem.to_s, version
+        end
       end
+      
+      @base_gemspec
+    end
+    
+    def settings
+      @settings
     end
   end
   
-  module Rake
-    class GemPackageTask < ::Rake::TaskLib
-      attr_reader :spec, :name
-      
-      TASKS = {}
+  class GemTaskManager
+    TASKS = {}
+    
+    def self.add_task conf
+      spec = conf.gemspec
+      name = "gem:#{spec.platform}"
+      pkg_dir = Burke.settings.gems.package_dir
       
-      @@package_dir = 'pkg'
+      if TASKS.empty?
+        desc "Build gems for all targets"
+      end
+      task :gems => name
       
-      def initialize plaf=Gem::Platform::RUBY
-        @spec = Burke.base_spec.dup
-        @spec.platform = Gem::Platform.new plaf
-        @name = "gem:#{@spec.platform}"
-        yield self if block_given?
-        define
+      unless ::Rake.application.last_comment
+        desc "Build gem for target '#{spec.platform}'"
       end
       
-      def self.package_dir= path
-        @@package_dir = path
+      task(name) do
+        conf.before.call spec unless conf.before.nil?
+        builder = Gem::Builder.new(spec)
+        builder.build
+        verbose true do
+          mkdir pkg_dir unless File.exists? pkg_dir
+          mv conf.gem_file, File.join(pkg_dir, conf.gem_file)
+        end
+        conf.after.call spec unless conf.after.nil?
       end
       
-      def self.package_dir
-        @@package_dir
+      TASKS[spec.platform.to_s] = conf
+    end
+    
+    def self.has_task? platform
+      TASKS.has_key? platform
+    end
+    
+    def self.task_for_this_platform
+      platform = Gem::Platform.new(RUBY_PLATFORM).to_s
+      name = nil
+      
+      if GemTaskManager.has_task? platform
+        name = platform
+      elsif GemTaskManager.has_task? 'ruby'
+        name = "ruby"
       end
       
-      def before &block
-        @before = block
+      TASKS[name]
+    end
+    
+    def self.install_task
+      t = task_for_this_platform
+      
+      desc "Install gem for this platform"
+      task 'install' => [t.task_name] do
+        Gem::Installer.new(File.join(t.package_dir, t.gem_file)).install
       end
+    end
+  end
+  
+  class GemSettings
+    attr_accessor :package_dir, :individuals
+    
+    def initialize
+      @package_dir = 'pkg'
+    end
+    
+    def platform plaf
+      conf = IndividualGemSettings.new plaf
+      @individuals ||= []
+      @individuals << conf
+      yield conf if block_given?
+      conf
+    end
+    
+    class IndividualGemSettings
+      attr_reader :platform
       
-      def extend_spec &block
-        @extend_spec = block
+      def initialize plaf
+        @platform = Gem::Platform.new plaf
       end
       
-      def after &block
-        @after = block
+      def gemspec
+        spec = Burke.base_gemspec.dup
+        spec.platform = @platform
+        spec
       end
       
       def gem_file
-        "#{spec.full_name}.gem"
+        "#{gemspec.full_name}.gem"
       end
       
-      private
-      def define
-        task :gems => name
-        
-        unless ::Rake.application.last_comment
-          desc "Build gem for target '#{@spec.platform}'"
-        end
-        task(name) { run_task }
-        TASKS[name] = self
-        
-        if @spec.platform == Gem::Platform::RUBY
-          desc "Build gem for target '#{@spec.platform}'"
-          task(:gem) { run_task }
-        end
-        
-        self
+      def task_name
+        "gem:#{platform}"
       end
       
-      def run_task
-        @before.call unless @before.nil?
-        @extend_spec.call spec unless @extend_spec.nil?
-        builder = Gem::Builder.new(@spec)
-        builder.build
-        verbose true do
-          mkdir @@package_dir unless File.exists? @@package_dir
-          mv gem_file, File.join(@@package_dir, gem_file)
-        end
-        @after.call unless @after.nil?
+      def package_dir
+        Burke.settings.gems.package_dir
       end
-    end
-    
-    class GemInstallTask < ::Rake::TaskLib
-      attr_reader :name
       
-      def initialize
-        @name = "install"
-        define
+      def before &block
+        @before = block if block_given?
+        @before
       end
       
-      private
-      def define
-        platform = Gem::Platform.new(RUBY_PLATFORM).to_s
-        t = nil
-        dep = nil
-        unless t = GemPackageTask::TASKS["gem:#{platform}"]
-          t = GemPackageTask::TASKS["gem:ruby"]
-        end
-        
-        desc "Build and install gem for this platform"
-        task name => [t.name] do
-          Gem::Installer.new(File.join(GemPackageTask.package_dir, t.gem_file)).install
-        end
-        
-        self
+      def after &block
+        @after = block if block_given?
+        @after
       end
     end
   end

data/lib/mash.rb

@@ -0,0 +1,25 @@
+class Mash < Hash
+  def method_missing name, *args, &block
+    if name.to_s =~ /(.*)=/
+      self.[]=($1, *args, &block)
+    else
+      if args.empty?
+        self.[](name, &block)
+      else
+        self.[]=(name, *args, &block)
+      end
+    end
+  end
+  
+  def []=(k, *v)
+    v = *v if v.one?
+    super k.to_s.downcase.to_sym, v
+  end
+  
+  def [](k)
+    v = super(k.to_s.downcase.to_sym)
+    yield v if block_given?
+    v
+  end
+end
+

data/spec/mash_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper')
+
+describe Mash do
+  context "when representing {:num => 42}" do
+    subject { Mash[:num => 42] }
+    its(:num) { should eql 42 }
+    its(:size) { should eql 1 }
+    its(:to_hash) { should eql :num => 42 }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib burke])
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aiden Nibali
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-22 00:00:00 +10:00
+date: 2010-08-24 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,23 +31,34 @@ dependencies:
         version: 0.8.7
   type: :runtime
   version_requirements: *id001
-description: Helper for creating nice and clean Rake files
+description: 
 email: dismal.denizen@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- lib/burke.rb
+- lib/mash.rb
+- README.rdoc
 files: 
 - lib/burke.rb
+- lib/mash.rb
+- spec/spec_helper.rb
+- spec/mash_spec.rb
+- Rakefile
+- VERSION
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/dismaldenizen/burke
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- burke 0.2.0
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement