bones 2.5.1 → 3.0.0

data/lib/bones/plugins/bones_plugin.rb

@@ -0,0 +1,193 @@
+
+module Bones::Plugins::BonesPlugin
+  include ::Bones::Helpers
+  extend self
+
+  module Syntax
+    def enable_sudo
+      use_sudo true
+    end
+  end
+
+  def initialize_bones_plugin
+    ::Bones.config {
+      # ==== Project Defaults
+      name  nil, :desc => <<-__
+        The project name that will be used for packaging and distributing
+        your Ruby code as a gem.
+      __
+
+      summary  nil, :desc => <<-__
+        A short summary of your project. This summary is required in the
+        gemspec, and it is used by the rubygem framework when searching
+        for gems. If a summary is not given, then the first sentence from
+        the project's README description is used as the summary.
+      __
+
+      description  nil, :desc => <<-__
+        A longer description of your project. The description is used in
+        the gemspec, but it is not required to build a gem. If a
+        description is not given then the first paragraph from the
+        project's README description is used as the description.
+      __
+
+      changes  nil, :desc => <<-__
+        The list of notable changes in your project since the last release.
+        The changes are automatically filled in by reading the list of
+        changes from the project's History file. Only the changes for the
+        most current release are included.
+      __
+
+      authors  nil, :desc => <<-__
+        This can be a single author (as a string) or an array of authors
+        if more than one person is working on the project.
+      __
+
+      email  nil, :desc => <<-__
+        An email address so others can contact you with questions, bug
+        reports, compliments, large quantities of cash, etc.
+      __
+
+      url  "\000", :desc => <<-__
+        The canonical URL for your project. This should be a location
+        where others can go to find out more information about the project
+        such as links to source code, bug trackers, wikis, generated
+        documentation, etc. A good recommendation would be to point
+        to your gem on gemcutter.org (soon to be rubygems.org).
+      __
+
+      version  ENV['VERSION'] || '0.0.0', :desc => <<-__
+        Version number to use when creating the gem. This can be set either
+        in the Rakefile or on the command line by setting the VERSION flag to
+        the desired value.
+        |
+        |  rake gem VERSION=0.4.2
+        |
+        The VERSION flag must be explicitly set on the command line when
+        releasing a gem. This is just a safety measure to prevent premature
+        gem release.
+      __
+
+      release_name  ENV['RELEASE'], :desc => <<-__
+        And optional release name to be associated with your gem. This is used
+        only when creating a release announcement.
+      __
+
+      exclude  %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/), :desc => <<-__
+        A list of regular expression patterns that will be used to exclude
+        certain files from the gem packaging process. Each pattern is given
+        as a string, and they are all combined using the regular expression
+        or "|" operator.
+      __
+
+      # ==== System Defaults
+      ruby_opts  %w(-w), :desc => <<-__
+        Default options to pass to the Ruby interpreter when executing tests
+        and specs. The default is to enable all warnings. Since this is an
+        array, the current options can be cleared and new options can be added
+        using the standard array operations
+        |
+        |  ruby_opts.clear
+        |  ruby_opts << '-Ilib' << '-rubygems'
+        |
+      __
+
+      libs  Array.new, :desc => <<-__
+        This is an array of directories to automatically include in the
+        LOAD_PATH of your project. These directories are use for tests and
+        specs, and the gem system sets the "require_paths" for the gem from
+        these directories. If no libs are given, then the "lib" and "ext"
+        directories are automatically added if they are present in your
+        project.
+      __
+
+      history_file  'History.txt', :desc => <<-__
+        The name of your project's History file. The default is 'History.txt'
+        but you are free to change it to whatever you choose.
+      __
+
+      readme_file  'README.txt', :desc => <<-__
+        The name of your project's README file. The default is 'README.txt'
+        but you are free to change it to whatever you choose. Since GitHub
+        understand various markup languages, you can change the README
+        file to support your markup language of choice.
+      __
+
+      ignore_file  '.bnsignore', :desc => <<-__
+        Mr Bones does not use a manifest to determine which fiels should be
+        included in your project. All files are included unless they appear
+        in the ignore file or in the "exclude" configruation option. The
+        ignore file defaults to '.bnsignore'; however, if you are using git
+        as your version control system you can just as easily set the ignore
+        file to your '.gitignore' file.
+      __
+
+      colorize  true, :desc => <<-__
+        When set to true, various output from Mr Bones will be colorized
+        using terminal ANSI codes. Set to false if your terminal does not
+        support colors.
+      __
+
+      use_sudo  false, :desc => <<-__
+        When set to true gem commands will be run using sudo. A convenience
+        method is provided to enable sudo for gem commands
+        |
+        |  enable_sudo
+        |
+        This is equivalent to 'use_sudo true', but it reads a little nicer.
+      __
+    }
+  end
+
+  def post_load
+    config = ::Bones.config
+
+    config.exclude << "^#{Regexp.escape(config.ignore_file)}$"
+    config.changes     ||= paragraphs_of(config.history_file, 0..1).join("\n\n")
+    config.description ||= paragraphs_of(config.readme_file, 'description').join("\n\n")
+    config.summary     ||= config.description.split('.').first
+
+    if config.libs.empty?
+      %w(lib ext).each { |dir| config.libs << dir if test ?d, dir }
+    end
+
+    ::Bones::Helpers::SUDO.replace('') unless config.use_sudo
+  end
+
+  def define_tasks
+    config = ::Bones.config
+
+    namespace :bones do
+      desc 'Show the current Mr Bones configuration'
+      task :debug do |t|
+        atr = if t.application.top_level_tasks.length == 2
+          t.application.top_level_tasks.pop
+        end
+
+        ::Bones.help.show(atr, :descriptions => false, :values => true)
+      end
+
+      desc 'Show descriptions for the various Mr Bones configuration options'
+      task :help do |t|
+        atr = if t.application.top_level_tasks.length == 2
+          t.application.top_level_tasks.pop
+        end
+
+        ::Bones.help.show(atr, :descriptions => true, :values => true)
+      end
+
+      desc 'Show the available Mr Bones configuration options'
+      task :options do |t|
+        atr = if t.application.top_level_tasks.length == 2
+          t.application.top_level_tasks.pop
+        end
+
+        ::Bones.help.show(atr, :descriptions => false, :values => false)
+      end
+
+    end  # namespace :bones
+  end
+
+end  # module Bones::Plugins::BonesPlugin
+
+# EOF

data/lib/bones/plugins/gem.rb

@@ -0,0 +1,274 @@
+
+module Bones::Plugins::Gem
+  include ::Bones::Helpers
+  extend self
+
+  module Syntax
+    # Adds the given gem _name_ to the current project's dependency list. An
+    # optional gem _version_ can be given. If omitted, the newest gem version
+    # will be used.
+    #
+    def depend_on( name, *args )
+      opts = Hash === args.last ? args.pop : {}
+      version = args.first || opts[:version]
+      development = opts.key?(:development) ? opts[:development] : opts.key?(:dev) ? opts[:dev] : false
+
+      spec = Gem.source_index.find_name(name).last
+      version = spec.version.to_s if version.nil? and !spec.nil?
+
+      dep = case version
+            when nil; [name]
+            when %r/^\d/; [name, ">= #{version}"]
+            else [name, version] end
+
+      development ?
+          ::Bones.config.gem.development_dependencies << dep :
+          ::Bones.config.gem.dependencies << dep
+    end
+  end
+
+  def initialize_gem
+    ::Bones.config {
+      desc 'Configuration settings for gem packaging.'
+      gem {
+        dependencies  Array.new, :desc => <<-__
+          Array of gem dependencies.
+
+          A convenience method is provided to add gem dependencies, and so you
+          should not muck about with this configuration setting manually.
+
+          |  depend_on 'rake'
+          |  depend_on 'rspec', '1.2.8'    # expands to '>= 1.2.8'
+          |  depend_on 'main', '~> 2.0'
+        __
+
+        development_dependencies  Array.new, :desc => <<-__
+          Array of development gem dependencies.
+
+          A convenience method is provided to add gem dependencies, and so you
+          should not muck about with this configuration setting manually.
+
+          |  depend_on 'bones', :deveopment => true
+          |  depend_on 'mocah', :version => '0.9.8', :development => true
+        __
+
+        executables  nil, :desc => <<-__
+          Array of executables provided by your project. All files in the 'bin'
+          folder will be included by default. However, if you are using a
+          non-standard location for your executables then you will need to
+          include them explicitly here as an Array.
+        __
+
+        extensions  FileList['ext/**/extconf.rb'], :desc => <<-__
+          Array of gem extensions. This is the list of 'extconf.rb' files
+          provided by your project. Rubygems uses this list of files to
+          compile extensions when installing your gem.
+        __
+
+        files  nil, :desc => <<-__
+          The list of files to include when packaging up your gem. This
+          defaults to all files in the current directory excluding those
+          matched by the 'exclude' option and the 'ignore_file'. You can
+          supply your Array of files if you desire.
+        __
+
+        need_tar  true, :desc => <<-__
+          When set to true a tar-gzip file will be produced along with your
+          gem. The default is true.
+        __
+
+        need_zip  false, :desc => <<-__
+          When set to true a zip file will be produced along with your gem.
+          The default is false.
+        __
+
+        extras  Hash.new, :desc => <<-__
+          A hash of extra Gem::Specification settings that are otherwise not
+          provided for by Mr Bones. You will need to refer to the rubygems
+          documentation for a complete list of specification settings.
+        __
+      }
+    }
+
+    have?(:gem) { true }
+  end
+
+  def post_load
+    config = ::Bones.config
+
+    config.gem.files ||= manifest
+    config.gem.executables ||= config.gem.files.find_all {|fn| fn =~ %r/^bin/}
+    config.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
+
+    have?(:gemcutter) {
+      Gem.searcher.instance_variable_get(:@gemspecs).
+      map {|gs| gs.name}.include? 'gemcutter'
+    }
+  end
+
+  def define_tasks
+    config = ::Bones.config
+
+    namespace :gem do
+      config.gem._spec = Gem::Specification.new do |s|
+        s.name = config.name
+        s.version = config.version
+        s.summary = config.summary
+        s.authors = Array(config.authors)
+        s.email = config.email
+        s.homepage = Array(config.url).first
+        s.rubyforge_project = config.rubyforge.name || config.name rescue config.name
+
+        s.description = config.description
+
+        config.gem.dependencies.each do |dep|
+          s.add_dependency(*dep)
+        end
+
+        config.gem.development_dependencies.each do |dep|
+          s.add_development_dependency(*dep)
+        end
+
+        s.files = config.gem.files
+        s.executables = config.gem.executables.map {|fn| File.basename(fn)}
+        s.extensions = config.gem.files.grep %r/extconf\.rb$/
+
+        s.bindir = 'bin'
+        dirs = Dir["{#{config.libs.join(',')}}"]
+        s.require_paths = dirs unless dirs.empty?
+
+        if config.rdoc
+          incl = Regexp.new(config.rdoc.include.join('|'))
+          excl = config.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+          excl = Regexp.new(excl.join('|'))
+          rdoc_files = config.gem.files.find_all do |fn|
+                         case fn
+                         when excl; false
+                         when incl; true
+                         else false end
+                       end
+          s.rdoc_options = config.rdoc.opts + ['--main', config.rdoc.main]
+          s.extra_rdoc_files = rdoc_files
+          s.has_rdoc = true
+        end
+
+        if config.test
+          if test ?f, config.test.file
+            s.test_file = config.test.file
+          else
+            s.test_files = config.test.files.to_a
+          end
+        end
+
+        # Do any extra stuff the user wants
+        config.gem.extras.each do |msg, val|
+          case val
+          when Proc
+            val.call(s.send(msg))
+          else
+            s.send "#{msg}=", val
+          end
+        end
+      end  # Gem::Specification.new
+
+      ::Bones::GemPackageTask.new(config.gem._spec) do |pkg|
+        pkg.need_tar = config.gem.need_tar
+        pkg.need_zip = config.gem.need_zip
+      end
+
+      if have? :gemcutter
+        desc 'Package and upload to Gemcutter'
+        task :release => [:clobber, 'gem'] do |t|
+          v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+          abort "Versions don't match #{v} vs #{config.version}" if v != config.version
+
+          Dir.glob("pkg/#{config.gem._spec.full_name}*.gem").each { |fn|
+            sh "#{GEM} push #{fn}"
+          }
+        end
+      end
+
+      desc 'Show information about the gem'
+      task :debug => 'gem:prereqs' do
+        puts config.gem._spec.to_ruby
+      end
+
+      desc 'Write the gemspec '
+      task :spec => 'gem:prereqs' do
+        File.open("#{config.name}.gemspec", 'w') do |f|
+          f.write config.gem._spec.to_ruby
+        end
+      end
+
+      desc 'Install the gem'
+      task :install => [:clobber, 'gem:package'] do
+        sh "#{SUDO} #{GEM} install --local pkg/#{config.gem._spec.full_name}"
+
+        # use this version of the command for rubygems > 1.0.0
+        #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{config.gem._spec.full_name}"
+      end
+
+      desc 'Uninstall the gem'
+      task :uninstall do
+        installed_list = Gem.source_index.find_name(config.name)
+        if installed_list and installed_list.collect { |s| s.version.to_s}.include?(config.version) then
+          sh "#{SUDO} #{GEM} uninstall --version '#{config.version}' --ignore-dependencies --executables #{config.name}"
+        end
+      end
+
+      desc 'Reinstall the gem'
+      task :reinstall => [:uninstall, :install]
+
+      desc 'Cleanup the gem'
+      task :cleanup do
+        sh "#{SUDO} #{GEM} cleanup #{config.gem._spec.name}"
+      end
+    end  # namespace :gem
+
+
+    desc 'Alias to gem:package'
+    task :gem => 'gem:package'
+
+    task :clobber => 'gem:clobber_package'
+    remove_desc_for_task 'gem:clobber_package'
+  end
+
+  # Scans the current working directory and creates a list of files that are
+  # candidates to be in the manifest.
+  #
+  def manifest
+    config = ::Bones.config
+    files = []
+    exclude = config.exclude.dup
+    comment = %r/^\s*#/
+
+    # process the ignore file and add the items there to the exclude list
+    if test(?f, config.ignore_file)
+      ary = []
+      File.readlines(config.ignore_file).each do |line|
+        next if line =~ comment
+        line.chomp!
+        line.strip!
+        next if line.nil? or line.empty?
+
+        glob = line =~ %r/\*\./ ? File.join('**', line) : line
+        Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
+      end
+      exclude.concat ary
+    end
+
+    # generate a regular expression from the exclude list
+    exclude = Regexp.new(exclude.join('|'))
+
+    Find.find '.' do |path|
+      path.sub! %r/^(\.\/|\/)/o, ''
+      next unless test ?f, path
+      next if path =~ exclude
+      files << path
+    end
+    files.sort!
+  end
+
+end  # Bones::Plugins::Gem
+
+# EOF