detroit-github 0.2.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2cfc8fd4027b3889192296e34fe61eb88d48cf2
+  data.tar.gz: d1945a9ad213b2fa71707c91f1eecc434fafa63e
+SHA512:
+  metadata.gz: 40f47f07b88c01cdc192d374830e693d08cf24415bf42ef510daff79c39b97a52491707d5cde8291ff1daede33253cf45a5256cc7320c7589da92d4dcb5287d4
+  data.tar.gz: d66a85a390e5ab08de05e5ba500153ddfa6f3c24d905c79e0dc85eea7ccecbd9ddd360b21989c1b8cb987e79b20124ba2562957d74132240c2b1e468809226ef

data/README.md

@@ -0,0 +1,55 @@
+# Detroit GitHub Tool
+
+[Website](http://rubyworks.github.com/detroit-github) /
+[Report Issue](http://github.com/rubyworks/detroit-github/issues) /
+[Development](http://github.com/rubyworks/detroit-github)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/detroit-github.png)](http://travis-ci.org/rubyworks/detroit-github) 
+[![Gem Version](https://badge.fury.io/rb/detroit-github.png)](http://badge.fury.io/rb/detroit-github)    
+[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
+
+
+## About
+
+The GitHub tool provides services tied to your project's github repository.
+Currently it only supports gh-pages publishing from a project's website directory.
+
+When you first run the github tool, it will look for a `web` project directory
+(or the directory as specified by the `folder` setting). If it does not exist
+it will create it by checking out the reposistory and making `gh-pages` the
+sole branch.
+
+Be sure to add `web` (or your configured site directory) in `.gitignore`.
+
+
+## Install
+
+### With RubyGems
+
+Per the usual gem install process:
+
+    $ gem install detroit-github
+
+Or using Bundler add it to the Gemfile.
+
+    gem "detroit-github"
+
+If using Indexer, make sure `detroit-github` is in your `requirements`.
+
+
+## Legal
+
+Detroit GitHub ·; 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-github.rb

@@ -1,34 +1,53 @@
-require 'detroit/tool'
+require 'detroit-standard'
 
 module Detroit
 
-  # Convenience method for creating a GitHub tool instance.
-  def GitHub(options={})
-    GitHub.new(options)
-  end
+  # FIXME: Sitemap feature is out-of-order!
 
+  ##
   # GitHub tool provides services for working with your
   # project's github repository.
   #
   # Currently it only supports gh-pages publishing.
   #
-  # IMPORTNAT: This tool is useless unless your project is hosted on GitHub!
+  # The following stations of the standard toolchain are targeted:
+  #
+  # * prepare
+  # * publish
+  # * clean
+  #
+  # @note This tool is useless unless your project is hosted on GitHub!
   class GitHub < Tool
 
+    # Works with the Standard assembly.
+    #
+    # @!parse
+    #   include Standard
+    #
+    assembly Standard
+
+    # Location of manpage for tool.
+    MANPAGE = File.dirname(__FILE__)+'/../man/detroit-github.5'
+
     #
     PAGES_BRANCH = "gh-pages"
 
     # The project directory to store the gh-pages git repo.
     DEFAULT_FOLDER = "web"
 
-    #
+    # Default remote name.
     DEFAULT_REMOTE = "origin"
 
     # Default commit message.
     DEFAULT_MESSAGE = "Update pages via Detroit."
 
-
-    #  A T T R I B U T E S
+    #
+    def prerequisite
+      @branch  = PAGES_BRANCH
+      @folder  = DEFAULT_FOLDER
+      @remote  = DEFAULT_REMOTE
+      @message = DEFAULT_MESSAGE
+    end
 
     # The remote to use (defaults to 'origin').
     attr_accessor :remote
@@ -76,29 +95,6 @@ module Detroit
     # The repository branch (ALWAYS "gh-pages").
     attr_reader :branch
 
-    #  A S S E M B L Y
-
-    # Do not need to `prepare` if gh_pages directory is already created.
-    def assemble?(station, options={})
-      case station
-      when :prepare
-        child ? false : true
-      when :publish, :clean
-        true
-      end
-    end
-
-    # Attach to `prepare`, `publish` and `clean`.
-    def assemble(station, options={})
-      case station
-      when :prepare then prepare
-      when :publish then publish
-      when :clean   then clean
-      end
-    end
-
-    #  S E R V I C E   M E T H O D S 
-
     #
     def prepare
       return if child
@@ -119,11 +115,16 @@ module Detroit
       update_gitignore
     end
 
-    #
+    # We do not need to prepare if gh_pages directory is already created.
+    def prepare?
+      !child
+    end
+
     # Publish sitemap files to branch (gh-pages).
     #
-    # @todo Should we all `git add --all` ?
+    # @todo Should we `git add --all` ?
     #
+    # @return [void]
     def publish
       if !File.directory?(pgdir)
         report "No pages folder found (#{folder})."
@@ -139,11 +140,31 @@ module Detroit
       end
     end
 
-    #
+    # Remove temporary directory.
     def clean
       rm_r File.join(Dir.tmpdir, 'detroit', 'github')
     end
 
+    # @method :station_publish(opts = {})
+    station :prepare
+
+    # @method :station_publish(opts = {})
+    station :publish
+
+    # @method :station_clean(opts = {})
+    station :clean
+
+    # This tool ties into the `prepare`, `publish` and `clean` stations of the
+    # standard assembly.
+    #
+    # @return [Boolean]
+    def assemble?(station, options={})
+      return true if station == :prepare
+      return true if station == :publish
+      return true if station == :purge
+      return false
+    end
+
   private
 
     # NOTE: Considered using `sh %[git clone --local . #{pgdir}]` but
@@ -193,15 +214,7 @@ module Detroit
       end
     end
 
-    # TODO: Does the POM Project provide the site folder?
-
-    #
-    def initialize_defaults
-      @branch   ||= PAGES_BRANCH
-      @folder   ||= DEFAULT_FOLDER
-      @remote   ||= DEFAULT_REMOTE
-      @message  ||= DEFAULT_MESSAGE
-    end
+    # TODO: Does the Project provide the site folder?
 
     # TODO: Switch to `scm` gem if it is better than grit.
 
@@ -318,12 +331,6 @@ module Detroit
     end
 =end
 
-  public
-
-    def self.man_page
-      File.dirname(__FILE__)+'/../man/detroit-github.5'
-    end
-
   end
 
 end

data/man/detroit-github.5.ronn

@@ -3,14 +3,13 @@ detroit-github(5) - github services for detroit
 
 ## DESCRIPTION
 
-The GitHub tool provides services tied to your project's
-github repository. Presently it only supports gh-pages
-publishing.
+The Github plugin provides services tied to a project's Github
+repository. Presently it supports gh-pages publishing.
 
 ## 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 Github tool instance.
 
   * `remote` - The remote to use (defaults to 'origin').
 
@@ -42,12 +41,12 @@ to a directory called `doc` we could use:
         site: .
         doc: doc
 
-However, this isn't usually necessary, since a soft link could be used
+However, this isn't usually necessary, since a symlink could be used
 instead.
 
     $ ln -s doc site/doc
 
-You can check soft-links into with git and they will be transferred as
+You can check symlinks into git and they will be transferred as
 if the real file when copied to the gh-pages file. So a more complex
 `sitemap` is really only needed when more specific selections or
 complex globs are needed.
@@ -64,9 +63,9 @@ For more information:
 
 ## COPYRIGHT
 
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Copyright (c) 2010 Rubyworks
 
-Detroit GitHub is distributable in accordance with the GPLv3 license.
+Detroit GitHub is distributable in accordance with the GPL v3 license.
 
 
 ## SEE ALSO

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: detroit-github
 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-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &16794180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *16794180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &16786740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16786740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: GitHub plugin for Detroit build system.
 email:
 - transfire@gmail.com
@@ -40,40 +45,37 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-- COPYING.rdoc
+- README.md
 files:
-- .ruby
 - lib/detroit-github.rb
 - man/detroit-github.5
 - man/detroit-github.5.html
 - man/detroit-github.5.ronn
+- README.md
 - LICENSE.txt
-- README.rdoc
-- COPYING.rdoc
 homepage: http://detroit.github.com/
 licenses:
-- GPL3
+- 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: GitHub plugin for Detroit
 test_files: []
+has_rdoc: 

data/.ruby

@@ -1,35 +0,0 @@
----
-source:
-- meta
-authors:
-- name: T. Sawyer
-  email: transfire@gmail.com
-copyrights:
-- holder: Thomas Sawyer
-  year: '2011'
-  license: GPL3
-requirements:
-- name: detroit
-  version: 0.3.0+
-- name: grit
-dependencies: []
-alternatives: []
-conflicts: []
-repositories: []
-resources:
-  home: http://detroit.github.com/
-  code: http://github.com/detroit/detroit-github
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2011-10-16'
-summary: GitHub plugin for Detroit
-title: Detroit GitHub
-version: 0.2.0
-name: detroit-github
-suite: detroit
-description: GitHub plugin for Detroit build system.
-organization: rubyworks
-date: '2012-04-01'

data/COPYING.rdoc

@@ -1,24 +0,0 @@
-= COPYRIGHT NOTICES
-
-== Detroit GitHub
-
-Copyright:: (c) 2011 Thomas Sawyer, Rubyworks
-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,32 +0,0 @@
-= Detroit GitHub Tool
-
-{Website}[http://rubyworks.github.com/detroit-github] /
-{Report Issue}[http://github.com/rubyworks/detroit-github/issues] /
-{Repository}[http://github.com/rubyworks/detroit-github]
-
-
-== Description
-
-The GitHub tool provides services tied to your project's
-github repository.
-
-Currently it only supports gh-pages publishing from a
-project's website directory.
-
-
-== Installation
-
-Per the usual gem install process:
-
-  $ gem install detroit-github
-
-
-== Copyrights
-
-Copyright (c) 2011 Thomas Sawyer
-
-Detroit GitHub is distributable in accordance with the GPL, GNU General Public
-License, version 3 or higher.
-
-See COPYING.rdoc and LICENSE.txt file for details.
-