detroit-gem 0.2.0

data/README.rdoc

@@ -0,0 +1,27 @@
+= Detroit Gem Tool
+
+{Website}[http://rubyworks.github.com/detroit-gem] /
+{Report Issue}[http://github.com/rubyworks/detroit-gem/issues] /
+{Repository}[http://github.com/rubyworks/detroit-gem]
+
+
+== Description
+
+Create `.gem` package for your Ruby project.
+
+
+== Installation
+
+Per the usual gem install process:
+
+  $ gem install detroit-rubygems
+
+
+== Copyrights
+
+Copyright (c) 2011 Thomas Sawyer
+
+Detroit Gem is licensed via the terms of the GPL version 3 or greater.
+
+See COPYING.rdoc and LICENSE.txt files for details.
+

data/lib/detroit-gem.rb

@@ -0,0 +1,230 @@
+require 'detroit/tool'
+
+module Detroit
+
+  # Create new Gem tool with the specified +options+.
+  def Gem(options={})
+    Gem.new(options)
+  end
+
+  # The Gem tool is used to generate gemspec and gem packages.
+  class Gem < Tool
+
+    # The .gemspec filename (default looks-up `.gemspec` or `name.gemspec` file).
+    attr_accessor :gemspec
+
+    # True or false whether to write gemspec from project metadata (default is `false`).
+    attr_accessor :autospec
+
+    # Package directory (defaults to `pkg`).
+    # Location of packages. This defaults to Project#pkg.
+    attr_accessor :pkgdir
+
+    # Whether to install the gem.
+    attr_writer :install
+
+    # Whether to install the gem (default `false`).
+    def install?
+      @install
+    end
+
+    # What rvm gemset to install in if installing.
+    #attr_accessor :gemset
+
+    # Version to release. Defaults to current version.
+    attr :version
+
+    # Additional options to pass to gem command.
+    #attr :options
+
+
+    #  A S S E M B L Y
+
+    #
+    def assemble?(station, options={})
+      case station
+      when :install then install?
+      when :package then true
+      when :release then true
+      when :reset   then true
+      when :purge   then true
+      end
+    end
+
+    # Attach to `package`, `install` and `release`, `reset` and `purge`.
+    def assemble(station, options={})
+      case station
+      when :package then package
+      when :install then install
+      when :release then release
+      when :reset   then reset
+      when :purge   then purge
+      end
+    end
+
+
+    #  S E R V I C E  M E T H O D S
+
+    # Write gemspec if +autospec+ is +true+ and then build the gem.
+    def package
+      create_gemspec if autospec   # TODO: should autospec be a generate phase?
+      build
+    end
+
+    # Create a gem package.
+    def build
+      trace "gem build #{gemspec}"
+      spec    = load_gemspec
+      builder = ::Gem::Builder.new(spec)
+      package = builder.build
+      mkdir_p(pkgdir)
+      mv(package, pkgdir)
+    end
+
+    # Convert metadata to a gemspec and write to +file+.
+    #
+    # file - name of gemspec file (defaults to value of #gemspec).
+    #
+    # Returns [String] file name.
+    def spec(file=nil)
+      create_gemspec(file)
+    end
+
+    #
+    def install
+      return unless install?
+      package_files.each do |file|
+        sh "gem install --no-rdoc --no-ri #{file}"
+      end
+    end   
+
+    # TODO: Gem push programatically instead of shelling out.
+
+    # Push gem package to RubyGems.org (a la Gemcutter).
+    def push
+      if package_files.empty?
+        report "No .gem packages found for version {version} at #{pkgdir}."
+      else
+        package_files.each do |file|
+          sh "gem push #{file}"
+        end
+      end
+    end
+
+    #
+    alias_method :release, :push
+
+    # Mark package files as outdated.
+    def reset
+      package_files.each do |f|
+        utime(0 ,0, f) 
+        report "Reset #{f}"
+      end
+    end
+
+    # Remove package file(s).
+    #--
+    # TODO: This is a little loose. Can we be more specific about which
+    # gem file(s) to remove?
+    #++
+    def purge
+      package_files.each do |f|
+        rm(f)
+        report "Removed #{f}"
+      end
+    end
+
+  private
+
+    #
+    def initialize_defaults
+      @autospec  = false
+
+      @pkgdir  ||= project.pkg
+      @gemspec ||= lookup_gemspec
+
+      @version = project.metadata.version
+    end
+
+    #
+    def package_files
+      Pathname.new(pkgdir).glob("*-#{version}.gem")
+    end
+
+    # Create gemspec if +autospec+ is +true+.
+    def prepackage
+      create_gemspec if autospec
+    end
+
+    # Create a gemspec file from project metadata.
+    def create_gemspec(file=nil)
+      file = gemspec if !file
+      require 'pom/gemspec'
+      yaml = project.to_gemspec.to_yaml
+      File.open(file, 'w') do |f|
+        f << yaml
+      end
+      status File.basename(file) + " updated."
+      return file
+    end
+
+    # Lookup gemspec file. If not found returns default path.
+    #
+    # Returns String of file path.
+    def lookup_gemspec
+      dot_gemspec = (project.root + '.gemspec').to_s
+      if File.exist?(dot_gemspec)
+        dot_gemspec.to_s
+      else
+        project.metadata.name + '.gemspec'
+      end
+    end
+
+    # Load gemspec file.
+    #
+    # Returns a ::Gem::Specification.
+    def load_gemspec
+      file = gemspec
+      if yaml?(file)
+        ::Gem::Specification.from_yaml(File.new(file))
+      else
+        ::Gem::Specification.load(file)
+      end
+    end
+
+    # If the gemspec a YAML gemspec?
+    def yaml?(file)
+      line = open(file) { |f| line = f.gets }
+      line.index "!ruby/object:Gem::Specification"
+    end
+
+    # TODO: Should we be rescuing this?
+    def initialize_requires
+      begin
+        require 'rubygems'
+      rescue LoadError
+        $stderr.puts "Could not load `rubygems'."
+      end
+      # can't do this b/c options not set yet
+      #require 'pom/gemspec' if autospec
+    end
+
+    ## Require rubygems library
+    #def require_rubygems
+    #  begin
+    #    require 'rubygems/specification'
+    #    ::Gem::manage_gems
+    # rescue LoadError
+    #    raise LoadError, "RubyGems is not installed."
+    # end
+    #end
+
+  public
+
+    def self.man_page
+      File.dirname(__FILE__)+'/../man/detroit-gem.5'
+    end
+
+  end
+
+end

data/man/detroit-gem.5

@@ -0,0 +1,79 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "DETROIT\-GEM" "5" "October 2011" "" ""
+.
+.SH "NAME"
+\fBdetroit\-gem\fR \- build gem package with detroit
+.
+.SH "DESCRIPTION"
+The Gem plug\-in for Detroit utilizes the \fBgem\fR command line tool to build a \fB\.gem\fR package for a project during the standard \fBpackage\fR phase\.
+.
+.SH "OPTIONS"
+The following options can be used in the Detroit assembly file for defining a Gem service\.
+.
+.IP "\(bu" 4
+\fBgemspec\fR \- The \.gemspec file\. The default is the first \fB\.gemspec\fR file found\.
+.
+.IP "\(bu" 4
+\fBautospec\fR \- Setting this option to \fBtrue\fR will have the plug\-in create a gemspec using a project\'s metadata\. Default is \fBfalse\fR\.
+.
+.IP "\(bu" 4
+\fBpkgdir\fR \- Directory to save generated gem file\. The default is \fBpkg/\fR\.
+.
+.IP "\(bu" 4
+\fBinstall\fR \- Should the gem be installed after being generated? Default is \fBfalse\fR\.
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Becuase the default options are all that is likely to be need the common exmaple something like:
+.
+.IP "" 4
+.
+.nf
+
+gem:
+  active: true
+.
+.fi
+.
+.IP "" 0
+.
+.P
+A fuller example might look something like this\.
+.
+.IP "" 4
+.
+.nf
+
+ gem:
+   gemspec: myapp\-extra\.gemspec
+   install: true
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
+.
+.SH "RESOURCES"
+For more information:
+.
+.IP "\(bu" 4
+API Documentation \fIhttp://rubydoc\.info/gems/detroit\-rubygems\fR
+.
+.IP "\(bu" 4
+Development Site \fIhttp://github\.com/detroit/detroit\-rubygems\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Copyright (c) 2010 Thomas Sawyer, Rubyworks
+.
+.P
+Detroit RubyGems is distributable in accordance with the GPLv3 license\.
+.
+.SH "SEE ALSO"
+dnote(1), gem(1)

data/man/detroit-gem.5.html

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>detroit-gem(5) - build gem package with detroit</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#RESOURCES">RESOURCES</a>
+    <a href="#COPYRIGHT">COPYRIGHT</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+    </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>detroit-gem(5)</li>
+    <li class='tc'></li>
+    <li class='tr'>detroit-gem(5)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>detroit-gem</code> - <span class="man-whatis">build gem package with detroit</span>
+</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>The Gem plug-in for Detroit utilizes the <code>gem</code> command line tool
+to build a <code>.gem</code> package for a project during the standard <code>package</code>
+phase.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>The following options can be used in the Detroit assembly file
+for defining a Gem service.</p>
+
+<ul>
+<li><p><code>gemspec</code> - The .gemspec file. The default is the first <code>.gemspec</code>
+ file found.</p></li>
+<li><p><code>autospec</code> - Setting this option to <code>true</code> will have the plug-in
+ create a gemspec using a project's metadata. Default is <code>false</code>.</p></li>
+<li><p><code>pkgdir</code> - Directory to save generated gem file. The default is <code>pkg/</code>.</p></li>
+<li><p><code>install</code> - Should the gem be installed after being generated? Default
+ is <code>false</code>.</p></li>
+</ul>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Becuase the default options are all that is likely to be need the
+common exmaple something like:</p>
+
+<pre><code>gem:
+  active: true
+</code></pre>
+
+<p>A fuller example might look something like this.</p>
+
+<pre><code> gem:
+   gemspec: myapp-extra.gemspec
+   install: true
+</code></pre>
+
+<p>The above examples use the YAML-base assembly format. Assembly
+files can also be Ruby-based. See Detroit documentation for more
+details.</p>
+
+<h2 id="RESOURCES">RESOURCES</h2>
+
+<p>For more information:</p>
+
+<ul>
+<li><p><a href="http://rubydoc.info/gems/detroit-rubygems">API Documentation</a></p></li>
+<li><p><a href="http://github.com/detroit/detroit-rubygems">Development Site</a></p></li>
+</ul>
+
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
+
+<p>Detroit RubyGems is distributable in accordance with the GPLv3 license.</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><span class="man-ref">dnote<span class="s">(1)</span></span>, <span class="man-ref">gem<span class="s">(1)</span></span></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2011</li>
+    <li class='tr'>detroit-gem(5)</li>
+  </ol>
+
+  </div>
+</body>
+</html>