detroit-email 0.2.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f404c9d5cf5dd50a6e295c89006206c62952f25
+  data.tar.gz: 35feafb655d78f595bcb60a9b0fc5e4f4e5e0543
+SHA512:
+  metadata.gz: c1683f3ccd6dc92ecf44594f5709e582728b0123dc54d7da7d6f0707b75fe8fcf63ad14600f86409c75e999544c78c79c111f58076eaea66450a68e272c40c5f
+  data.tar.gz: f503c4ec5648a21fc5e5e84329382eceb7e5041f90d2619ee840a277b6b7f1c48f3fe0c464eb9900dc1480e7136e71bb4df1e1f3c5e4ff04d7391ec34621596e

data/{README.rdoc → README.md}

@@ -1,16 +1,20 @@
-= Detroit Email Tool
+# Detroit Email Tool
 
-{Website}[http://rubyworks.github.com/detroit-email] /
-{Report Issue}[http://github.com/rubyworks/detroit-email/issues] /
-{Repository}[http://github.com/rubyworks/deroit-email]
+[Website](http://rubyworks.github.com/detroit-email) /
+[Report Issue](http://github.com/rubyworks/detroit-email/issues) /
+[Development](http://github.com/rubyworks/deroit-email)
 
+[![Build Status](https://secure.travis-ci.org/rubyworks/detroit-email.png)](http://travis-ci.org/rubyworks/detroit-email) 
+[![Gem Version](https://badge.fury.io/rb/detroit-email.png)](http://badge.fury.io/rb/detroit-email)    
+[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
 
-== Description
+
+## About
 
 The Email tool is used to send out project announcements to a set of
 email addresses.
 
-By default it generates a <i>release announcement</i> based on a projects
+By default it generates a *release announcement* based on a projects
 metadata. Release announcements can be customized via _parts_, including
 a project's README file.
 
@@ -30,15 +34,21 @@ not be set independently for every project.
     @secure    ENV['EMAIL_SECURE']
 
 
-== Installation
+## Installation
+
+### Using RubyGems
 
   $ gem install detroit-email
 
 
-== Copyrights
+## Legal
+
+Detroit Email
 
 Copyright (c) 2011 Rubyworks
 
+(GPL-3.0 License)
+
 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
@@ -49,6 +59,4 @@ 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/>.
-
+See COPYING.md file for full details.

data/lib/detroit-email.rb

@@ -1,17 +1,13 @@
-module Detroit
-
-  require 'detroit/tool'
+require 'detroit-standard'
 
-  # New Email instance.
-  def Email(options={})
-    Email.new(options)
-  end
+module Detroit
 
+  ##
   # The Email tool is used to send out project announcements to a set of
   # email addresses.
   #
-  # By default it generates a <i>release announcement</i> based on a projects
-  # metadata. Release announcements can be customized via _parts_, including
+  # By default it generates a *release announcement* based on a projects
+  # metadata. Release announcements can be customized via *parts*, including
   # a project's README file.
   #
   # Fully custom messages can also be sent by setting the message field,
@@ -29,8 +25,47 @@ module Detroit
   #   @login     ENV['EMAIL_LOGIN']
   #   @secure    ENV['EMAIL_SECURE']
   #
+  # This tool ties into the `prepare` and `promote` stations of the
+  # standard toolchain.
+  #
   class Email < Tool
 
+    # Designed to interface with Statndard assembly. Attaches `#approve`
+    # method to `prepare` and `#announce` method to `promote` assembly
+    # stations.
+    #
+    # @!parse
+    #   include Standard
+    #
+    assembly Standard
+
+    # Needs email utility provided by detroit.
+    include EmailUtils
+
+    # Location of manpage for this tool.
+    MANPAGE = File.dirname(__FILE__) + '/../man/detroit-email.5'
+
+    # Load any special requirements and set attribute defaults.
+    #
+    # @return [void]
+    def prerequisite
+      require 'facets/boolean'  # TODO: should this universal?
+
+      @mailto   = ['rubytalk@ruby-lang.org']
+      @subject  = "[ANN] %s v%s released" % [metadata.title, metadata.version]
+      @file     = nil #'doc/ANN{,OUNCE}{,.txt,.rdoc}' TODO: default announcment file?
+      @parts    = [:message, :description, :resources, :notes, :changes]
+
+      #mailopts = Ratch::Emailer.environment_options.rekey(&:to_s)  # FIXME
+      #@port    = mailopts['port']
+      #@server  = mailopts['server']
+      #@account = mailopts['account']  #|| metadata.email
+      #@domain  = mailopts['domain']   #|| metadata.domain
+      #@login   = mailopts['login']
+      #@secure  = mailopts['secure']
+      #@from    = mailopts['from']     #|| metadata.email
+    end
+
     # Message file to send.
     attr_accessor :file
 
@@ -75,42 +110,21 @@ module Detroit
       @secure = s.to_b
     end
 
-
-    #  A S S E M B L Y
-
-    #
-    def assemble?(station, options={})
-      destination = options[:destination]
-      case station
-      when :prepare then (destination == :promote)
-      when :promote then true
-      else false    
-      end
-    end
-
-    # Attach #approve to prepare and #announce to promote assembly stations.
-    def assemble(station, options={})
-      destination = options[:destination]
-      case station
-      when :prepare
-        approve if destination == :promote
-      when :promote
-        announce
-      end
-    end
-
-
-    #  S E R V I C E  M E T H O D S
-
-    #
+    # Ask developer if the mail should be sent.
     def approve
       apply_environment
       @approved = mail_confirm?
+      # TODO: better way to terminate?
       exit -1 unless @approved
     end
 
+    # Alias for #approve.
+    def prepare; approve; end
+
     # Send announcement message.
     def announce
+      apply_environment unless @approved
+
       mailopts = self.mailopts
 
       if mailto.empty?
@@ -132,8 +146,10 @@ module Detroit
       end
     end
 
-    #
-    alias_method :promote, :announce
+    # Alias for #announce.
+    def promote
+      announce
+    end
 
     # Message to send. Defaults to a generated release announcement.
     def message
@@ -201,29 +217,6 @@ module Detroit
       @secure   ||= ENV['EMAIL_SECURE']
     end
 
-    private
-
-    def initialize_defaults
-      @mailto   = ['rubytalk@ruby-lang.org']
-      @subject  = "[ANN] %s v%s released" % [metadata.title, metadata.version]
-      @file     = nil #'doc/ANN{,OUNCE}{,.txt,.rdoc}' TODO: default announcment file?
-      @parts    = [:message, :description, :resources, :notes, :changes]
-
-      #mailopts = Ratch::Emailer.environment_options.rekey(&:to_s)  # FIXME
-      #@port    = mailopts['port']
-      #@server  = mailopts['server']
-      #@account = mailopts['account']  #|| metadata.email
-      #@domain  = mailopts['domain']   #|| metadata.domain
-      #@login   = mailopts['login']
-      #@secure  = mailopts['secure']
-      #@from    = mailopts['from']     #|| metadata.email
-    end
-
-    #
-    def initialize_requires
-      require 'facets/boolean'  # TODO: should this universal?
-    end
-
     #
     #def announce_options(options)
     #  options  = options.rekey
@@ -240,10 +233,18 @@ module Detroit
     #  result
     #end
 
-  public
+    #
+    def assemble?(station, options={})
+      return true if station == :prepare && approve?(options)
+      return true if station == :promote
+      return false
+    end
+
+  private
 
-    def self.man_page
-      File.dirname(__FILE__)+'/../man/detroit-email.5'
+    #
+    def approve?(state)
+      state[:destination] == :promote
     end
 
   end
@@ -264,4 +265,3 @@ end
 #
 # 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/man/detroit-email.5

@@ -1,15 +1,16 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "DETROIT\-EMAIL" "5" "October 2011" "" ""
+.TH "DETROIT\-EMAIL" "5" "January 2014" "" ""
 .
 .SH "NAME"
 \fBdetroit\-email\fR \- send out customizable email announcement
 .
 .SH "DESCRIPTION"
-The Email plug\-in for Detroit can send out release announcements, or other messages during the standard \fBpromote\fR stop\.
+The Email plug\-in for Detroit can send out release announcements, or other messages during the standard \fBpromote\fR stage\.
 .
 .SH "OPTIONS"
+The following options can be used in the Detroit toolchain file for defining an Email tool instance\.
 .
 .IP "\(bu" 4
 \fBfile\fR \- If the body of the message is in a file use this option to set the path to that file relative to the project\'s root directory\.
@@ -82,14 +83,14 @@ Most of the options default to environment variables (unless \fBnoenv\fR is used
 Note that if EMAIL_PASSWORD is not set in the environment, then the user will be prompted for it on the command line when it is required\.
 .
 .SH "EXAMPLES"
-Usually the use case is send out a release announcement, and in that case the default configuration suffices\. So, the typical example is as simple as:
+Usually the usecase is for sending out a release announcement, and in that case the default configuration suffices\. So, the typical example is simply:
 .
 .IP "" 4
 .
 .nf
 
 announce:
-  service: email
+  tool: email
   mailto:
     \- ruby\-talk@ruby\-lang\.org
 .
@@ -109,10 +110,10 @@ Development Site \fIhttp://github\.com/detroit/detroit\-email\fR
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Copyright (c) 2010 Rubyworks
 .
 .P
 Detroit EMail is distributable in accordance with the GPLv3 license\.
 .
 .SH "SEE ALSO"
-dnote(1)
+detroit(1)

data/man/detroit-email.5.html

@@ -61,7 +61,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-email(5)</li>
@@ -76,11 +76,14 @@
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
-<p>The Email plug-in for Detroit can send out release announcements, or other
-messages during the standard <code>promote</code> stop.</p>
+<p>The Email plug-in for Detroit can send out release announcements,
+or other messages during the standard <code>promote</code> stage.</p>
 
 <h2 id="OPTIONS">OPTIONS</h2>
 
+<p>The following options can be used in the Detroit toolchain file
+for defining an Email tool instance.</p>
+
 <ul>
 <li><p><code>file</code> - If the body of the message is in a file use this option
 to set the path to that file relative to the project's root
@@ -124,11 +127,11 @@ will be prompted for it on the command line when it is required.</p>
 
 <h2 id="EXAMPLES">EXAMPLES</h2>
 
-<p>Usually the use case is send out a release announcement, and in that case the
-default configuration suffices. So, the typical example is as simple as:</p>
+<p>Usually the usecase is for sending out a release announcement, and in that
+case the default configuration suffices. So, the typical example is simply:</p>
 
 <pre><code>announce:
-  service: email
+  tool: email
   mailto:
     - ruby-talk@ruby-lang.org
 </code></pre>
@@ -145,18 +148,18 @@ default configuration suffices. So, the typical example is as simple as:</p>
 
 <h2 id="COPYRIGHT">COPYRIGHT</h2>
 
-<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
+<p>Copyright (c) 2010 Rubyworks</p>
 
 <p>Detroit EMail 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></p>
+<p><span class="man-ref">detroit<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='tc'>January 2014</li>
     <li class='tr'>detroit-email(5)</li>
   </ol>
 

data/man/detroit-email.5.ronn

@@ -3,12 +3,15 @@ detroit-email(5) - send out customizable email announcement
 
 ## DESCRIPTION
 
-The Email plug-in for Detroit can send out release announcements, or other
-messages during the standard `promote` stop.
+The Email plug-in for Detroit can send out release announcements,
+or other messages during the standard `promote` stage.
 
 
 ## OPTIONS
 
+The following options can be used in the Detroit toolchain file
+for defining an Email tool instance.
+
   * `file` - If the body of the message is in a file use this option
     to set the path to that file relative to the project's root 
     directory.
@@ -59,11 +62,11 @@ will be prompted for it on the command line when it is required.
 
 ## EXAMPLES
 
-Usually the use case is send out a release announcement, and in that case the
-default configuration suffices. So, the typical example is as simple as:
+Usually the usecase is for sending out a release announcement, and in that
+case the default configuration suffices. So, the typical example is simply:
 
     announce:
-      service: email
+      tool: email
       mailto:
         - ruby-talk@ruby-lang.org
 
@@ -79,7 +82,7 @@ For more information:
 
 ## COPYRIGHT
 
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Copyright (c) 2010 Rubyworks
 
 Detroit EMail is distributable in accordance with the GPLv3 license.
 

metadata

@@ -1,27 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: detroit-email
 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: &8890620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *8890620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Email plugin for Detroit build system. This plugin is designed to send
   out a well formated release announcement during the promote phase. Though, it can
   be configured to send out any message desired.
@@ -31,40 +33,37 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-- COPYING.rdoc
+- README.md
 files:
-- .ruby
 - lib/detroit-email.rb
 - man/detroit-email.5
 - man/detroit-email.5.html
 - man/detroit-email.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: Email plugin for Detroit
 test_files: []
+has_rdoc: 

data/.ruby

@@ -1,36 +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+
-dependencies: []
-alternatives: []
-conflicts: []
-repositories: []
-resources:
-  home: http://detroit.github.com/
-  code: http://github.com/detroit/detroit-email
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2011-10-16'
-summary: Email plugin for Detroit
-title: Detroit Email
-version: 0.2.0
-name: detroit-email
-suite: detroit
-description: Email plugin for Detroit build system. This plugin is designed to send
-  out a well formated release announcement during the promote phase. Though, it can
-  be configured to send out any message desired.
-organization: rubyworks
-date: '2012-04-01'

data/COPYING.rdoc

@@ -1,21 +0,0 @@
-= COPYRIGHT NOTICES
-
-== Detroit Email
-
-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.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-(http://detroit.github.com)
-