detroit-grancher 0.2.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd6b2f339136fb77c2b381c176af025c815c01ed
+  data.tar.gz: a63dd82ae752af30220e01575360324f6d7d91e5
+SHA512:
+  metadata.gz: 0b1e10c517d998f29276a7f723cb6b43a9fdeaad423e97d73a680d31c0a59f64cbb3dbfa7279d2d826644261372d2fc27807b5b6d25ece61263c2aa9da359b18
+  data.tar.gz: f01b11838be16bb5d58bc4ae6835d8d44d6f9418177dd30e07671def1b07de0cfd4cee24104b8c5ec94810db526b0dcb9110abaf1ebdcbc9db1f4764652fd580

data/README.md

@@ -0,0 +1,43 @@
+# Detroit Grancher Tool
+
+[Website](http://rubyworks.github.com/detroit-grancher) /
+[Report Issue](http://github.com/rubyworks/detroit-grancher/issues) /
+[Development](http://github.com/rubyworks/detroit-grancher)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/detroit-grancher.png)](http://travis-ci.org/rubyworks/detroit-grancher) 
+[![Gem Version](https://badge.fury.io/rb/detroit-grancher.png)](http://badge.fury.io/rb/detroit-grancher)    
+[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
+
+
+## About
+
+The Grancher tool copies designated files to a git branch.
+This is useful for dealing with situations like GitHub's
+gh-pages branch for hosting project websites.
+
+
+## Install
+
+### With RubyGems
+
+    $ gem install detroit-grancher
+
+
+## Legal
+
+Detroit Grancher
+
+Copyright (c) 2011 Rubyworks
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+See LICENSE.txt for details.
+

data/lib/detroit-grancher.rb

@@ -1,25 +1,50 @@
-require 'detroit/tool'
+require 'detroit-standard'
 
 module Detroit
 
-  # Convenicene method for creating a new Grancher tool instance.
-  def Grancher(options={})
-    Grancher.new(options)
-  end
-
-  # IMPORTANT! Grancher Tool is being deprecated in favor of the new GitHub
+  ##
+  # This tool copies designated files to a git branch. This is useful
+  # for dealing with situations like GitHub's gh-pages branch for hosting
+  # project websites (a poor design copied from the Git project itself).
+  #
+  # IMPORTANT! Grancher tool is being deprecated in favor of the new GitHub
   # tool. Grancher has issues with Ruby 1.9 (due to encoding problems
-  # in Gash library) and show no signs of being fixes.
+  # in Gash library) that show no signs of being fixed.
   #
-  # IMPORTANT! This toll only works with Ruby 1.8.x.
+  # The following stations of the standard toolchain are targeted:
   #
-  # This tool copies designated files to a git branch.
-  # This is useful for dealing with situations like GitHub's
-  # gh-pages branch for hosting project websites.[1]
+  # * :pre_publish
+  # * :publish
+  #
+  # @note This tool may only works with Ruby 1.8.x.
   #
-  # [1] A poor design copied from the Git project itself.
   class Grancher < Tool
 
+    # Works with the Standard assembly.
+    #
+    # Attach `transfer` method to `pre_publish` assembly station, and
+    # attach `publish` method to `publish` assembly station.
+    #
+    # @!parse
+    #   include Standard
+    #
+    assembly Standard
+
+    # Location of manpage for tool.
+    MANPAGE = File.dirname(__FILE__) + '/../man/detroit-grancher.5'
+
+    # Initialize defaults.
+    #
+    # @todo Does project provide the site directory?
+    #
+    # @return [void]
+    def prerequisite
+      @branch   ||= 'gh-pages'
+      @remote   ||= 'origin'
+      @sitemap  ||= default_sitemap
+      #@keep_all ||= trial?
+    end
+
     # The brach into which to save the files.
     attr_accessor :branch
 
@@ -55,28 +80,6 @@ module Detroit
       end
     end
 
-
-    #  A S S E M B L Y  S T A T I O N S
-
-    def assemble?(station, options={})
-      case station
-      when :pre_publish then true
-      when :publish     then true
-      end
-    end
-
-    # Attach pre-publish method to pre-publish assembly station.
-    # Attach publish method to publish assembly station.
-    def assemble(station)
-      case station
-      when :pre_publish then transfer
-      when :publish     then publish
-      end
-    end
-
-
-    #  S E R V I C E  M E T H O D S
-
     # Cached Grancter instance.
     def grancher
       @grancher ||= ::Grancher.new do |g|
@@ -110,9 +113,6 @@ module Detroit
       report "Tranferred site files to #{branch}."
     end
 
-    # Same as transfer.
-    alias_method :pre_publish, :transfer
-
     # Push files to remote.
     def publish
       require 'grancher'
@@ -120,20 +120,22 @@ module Detroit
       report "Pushed site files to #{remote}."
     end
 
-  private
-
-    # TODO: Does the POM Project provide the site directory?
-    def initialize_defaults
-      @branch   ||= 'gh-pages'
-      @remote   ||= 'origin'
-      @sitemap  ||= default_sitemap
-      #@keep_all ||= trial?
+    # This tool ties into the `pre_publish` and `publish` stations of the
+    # standard assembly.
+    #
+    # @return [Boolean,Symbol]
+    def assemble?(station, options={})
+      return :transfer if station == :pre_publish
+      return :publish  if station == :publish
+      return false
     end
 
+  private
+
     # Default sitemap includes the website directoy, if it exists.
     # Otherwise it looks for a `doc` or `docs` directory.
     #
-    # NOTE: We have loop over the contents of the site directory
+    # @note This has to loop over the contents of the website directory
     # in order to pick up symlinks b/c Grancher doesn't support them.
     def default_sitemap
       sm  = []
@@ -155,12 +157,6 @@ module Detroit
       sm
     end
 
-  public
-
-    def self.man_page
-      File.dirname(__FILE__)+'/../man/detroit-grancher.5'
-    end
-
   end
 
 end

data/man/detroit-grancher.5

@@ -1,19 +1,19 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "DETROIT\-GRANCHER" "5" "October 2011" "" ""
+.TH "DETROIT\-GRANCHER" "5" "January 2014" "" ""
 .
 .SH "NAME"
 \fBdetroit\-grancher\fR \- publish website via dedicated git branch
 .
 .SH "DESCRIPTION"
-The Grancher tool utilizes the Grancher library to publish a project\'s website via a dedicated git branch\. Typically this is the \fBgh\-pages\fR branch\.
+The Grancher tool utilizes the Grancher library to publish a project\'s website via a dedicated git branch\. Typically this is used for the \fBgh\-pages\fR branch\.
 .
 .P
-Note that his plug\-in has been generally superseded by the \fBgithub\fR plug\-in\.
+\fBNote that his plugin has been generally superseded by the \fBgithub\fR plugin\.\fR
 .
 .SH "OPTIONS"
-The following options can be used in Detroit assembly files for defining a github service\.
+The following options can be used in Detroit toolchain files for defining a Grancher tool instance\.
 .
 .IP "\(bu" 4
 \fBremote\fR \- The remote to use (defaults to \'origin\')\.
@@ -90,10 +90,10 @@ Development Site \fIhttp://github\.com/detroit/detroit\-grancher\fR
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Copyright (c) 2010 Rubyworks
 .
 .P
-Detroit Grancher is distributable in accordance with the GPLv3 license\.
+Detroit Grancher is distributable in accordance with the GPL v3 license\.
 .
 .SH "SEE ALSO"
 detroit(1), git(1), detroit\-github(5)

data/man/detroit-grancher.5.html

@@ -60,7 +60,7 @@
     <a href="#RESOURCES">RESOURCES</a>
     <a href="#COPYRIGHT">COPYRIGHT</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>detroit-grancher(5)</li>
@@ -77,15 +77,15 @@
 
 <p>The Grancher tool utilizes the Grancher library to publish a
 project's website via a dedicated git branch. Typically this
-is the <code>gh-pages</code> branch.</p>
+is used for the <code>gh-pages</code> branch.</p>
 
-<p>Note that his plug-in has been generally superseded by the
-<code>github</code> plug-in.</p>
+<p><strong>Note that his plugin has been generally superseded by the
+<code>github</code> plugin.</strong></p>
 
 <h2 id="OPTIONS">OPTIONS</h2>
 
-<p>The following options can be used in Detroit assembly files
-for defining a github service.</p>
+<p>The following options can be used in Detroit toolchain files
+for defining a Grancher tool instance.</p>
 
 <ul>
 <li><p><code>remote</code> - The remote to use (defaults to 'origin').</p></li>
@@ -144,9 +144,9 @@ complex globs are needed.</p>
 
 <h2 id="COPYRIGHT">COPYRIGHT</h2>
 
-<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
+<p>Copyright (c) 2010 Rubyworks</p>
 
-<p>Detroit Grancher is distributable in accordance with the GPLv3 license.</p>
+<p>Detroit Grancher is distributable in accordance with the GPL v3 license.</p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
@@ -155,7 +155,7 @@ complex globs are needed.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>October 2011</li>
+    <li class='tc'>January 2014</li>
     <li class='tr'>detroit-grancher(5)</li>
   </ol>
 

data/man/detroit-grancher.5.ronn

@@ -5,15 +5,15 @@ detroit-grancher(5) - publish website via dedicated git branch
 
 The Grancher tool utilizes the Grancher library to publish a
 project's website via a dedicated git branch. Typically this
-is the `gh-pages` branch.
+is used for the `gh-pages` branch.
 
-Note that his plug-in has been generally superseded by the
-`github` plug-in.
+**Note that his plugin has been generally superseded by the
+`github` plugin.**
 
 ## OPTIONS
 
-The following options can be used in Detroit assembly files
-for defining a github service.
+The following options can be used in Detroit toolchain files
+for defining a Grancher tool instance.
 
   * `remote` - The remote to use (defaults to 'origin').
 
@@ -70,9 +70,9 @@ For more information:
 
 ## COPYRIGHT
 
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Copyright (c) 2010 Rubyworks
 
-Detroit Grancher is distributable in accordance with the GPLv3 license.
+Detroit Grancher is distributable in accordance with the GPL v3 license.
 
 
 ## SEE ALSO

metadata

@@ -1,38 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: detroit-grancher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - T. Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &17478300 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *17478300
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: detroit-standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grancher
-  requirement: &17477700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17477700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Grancher plugin for Detroit build system uses the grancher gem to copy
   a project's website directory to github gh-pages branch and push it the github.com
   during the publish phase. While quite usable, this plugin has been superceded by
@@ -43,40 +62,37 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-- COPYING.rdoc
+- README.md
 files:
-- .ruby
 - lib/detroit-grancher.rb
 - man/detroit-grancher.5
 - man/detroit-grancher.5.html
 - man/detroit-grancher.5.ronn
+- README.md
 - LICENSE.txt
-- README.rdoc
-- COPYING.rdoc
 homepage: http://detroit.github.com/
 licenses:
-- GPL-3
+- GPL-3.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Grancher plugin for Detroit
 test_files: []
+has_rdoc: 

data/.ruby

@@ -1,38 +0,0 @@
----
-source:
-- meta
-authors:
-- name: T. Sawyer
-  email: transfire@gmail.com
-copyrights:
-- holder: Thomas Sawyer
-  year: '2011'
-  license: GPL-3
-requirements:
-- name: detroit
-  version: 0.3.0+
-- name: grancher
-dependencies: []
-alternatives: []
-conflicts: []
-repositories: []
-resources:
-  home: http://detroit.github.com/
-  code: http://github.com/detroit/detroit-grancher
-  mail: http://groups.google.com/rubyworks-mailinglist
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2011-10-16'
-summary: Grancher plugin for Detroit
-title: Detroit Grancher
-version: 0.2.0
-name: detroit-grancher
-suite: detroit
-description: Grancher plugin for Detroit build system uses the grancher gem to copy
-  a project's website directory to github gh-pages branch and push it the github.com
-  during the publish phase. While quite usable, this plugin has been superceded by
-  the github gem for most use cases.
-organization: rubyworks
-date: '2012-04-01'

data/COPYING.rdoc

@@ -1,23 +0,0 @@
-= COPYRIGHT NOTICES
-
-== Detroit Grancher
-
-Copyright:: (c) 2011 Thomas Sawyer
-License:: GPL-3
-Website:: http://detroit.github.com
-
-  Copyright (c) 2011 Thomas Sawyer
-
-  This program is free software: you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published by
-  the Free Software Foundation, either version 3 of the License, or
-  (at your option) any later version.
-
-  This program is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/README.rdoc

@@ -1,23 +0,0 @@
-= Detroit Grancher Tool
-
-
-== DESCRIPTION
-
-The Grancher tool copies designated files to a git branch.
-This is useful for dealing with situations like GitHub's
-gh-pages branch for hosting project websites.
-
-
-== INSTALL
-
-  $ gem install detroit-grancher
-
-
-== COPYRIGHT
-
-Copyright (c) 2011 Thomas Sawyer
-
-GPL v.3 license
-
-See COPYING.rdoc and GPL3.txt file for details.
-