methadone 0.3.0 → 0.3.1

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -102,10 +102,6 @@ don't accept options, <tt>[options]</tt> won't appear in the help.  The names of
 will appear in proper order and <tt>:optional</tt> ones will be in square brackets.  You don't have to 
 touch a thing.
 
-Why not just <tt>def main</tt> and call that method?  +go!+ also handles exceptions:
-
-* Any uncaught exception that isn't a subclass of <tt>Methadone::Error</tt> will cause the app to exit with a 70 (standard Linux "internal error" exit status) and print the exception's messages to standard error, no backtrace
-* An instance of <tt>Methadone::Error</tt>, if caught, will have similar behavior, but the +exit_code+ method will be called on the exception to determine the exit status.  You can trigger this exception via <tt>exit_now! exit_stats,message</tt>
 
 == Utility Classes
 

data/Rakefile

@@ -14,6 +14,7 @@ desc 'run tests'
 Rake::TestTask.new do |t|
   t.libs << "lib"
   t.libs << "test"
+  t.ruby_opts << "-rrubygems"
   t.test_files = FileList['test/test_*.rb']
 end
 
@@ -28,7 +29,7 @@ end
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
-  tag_opts = ''
+  tag_opts = ' --tags ~@pending'
   tag_opts = " --tags #{ENV['TAGS']}" if ENV['TAGS']
   t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
   t.fork = false

data/bin/methadone

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby -w
 
-$: << File.join(File.dirname(__FILE__),'..','lib')
-
 require 'fileutils'
 require 'optparse'
 require 'methadone'
@@ -13,6 +11,7 @@ include Methadone::CLI
 
 main do |app_name|
   check_and_prepare_basedir!(app_name,options[:force])
+  using_readme = options[:readme]
 
   gemname = File.basename(app_name)
   debug "Creating project for gem #{gemname}"
@@ -25,8 +24,12 @@ main do |app_name|
 
   template_dirs_in(:full).each  { |dir| mkdir_p dir }
 
-  ["Rakefile", "test/tc_something.rb", "features/support/env.rb"].each do |file|
-    copy_file file
+  ["Rakefile", ".gitignore", "test/tc_something.rb", "features/support/env.rb"].each do |file|
+    copy_file file, :binding => binding
+  end
+
+  if using_readme
+    copy_file "README.rdoc", :binding => binding 
   end
 
   copy_file "features/executable.feature", :as => "#{gemname}.feature", :binding => binding
@@ -41,9 +44,12 @@ main do |app_name|
   ], :before => /^end\s*$/
 end
 
+options[:readme] = true
+
 description "Kick the bash habit by bootstrapping your Ruby command-line apps"
 
 on("--force","Overwrite files if they exist")
+on("--[no-]readme","[Do not ]produce a README file")
 
 arg :app_name, :required
 

data/features/bootstrap.feature

@@ -20,12 +20,17 @@ Feature: Bootstrap a new command-line app
     And the following files should exist:
       |tmp/newgem/newgem.gemspec                            |
       |tmp/newgem/Rakefile                                  |
+      |tmp/newgem/.gitignore                                |
       |tmp/newgem/Gemfile                                   |
       |tmp/newgem/bin/newgem                                |
       |tmp/newgem/features/newgem.feature                   |
       |tmp/newgem/features/support/env.rb                   |
       |tmp/newgem/features/step_definitions/newgem_steps.rb |
       |tmp/newgem/test/tc_something.rb                      |
+    And the file "tmp/newgem/.gitignore" should match /results.html/
+    And the file "tmp/newgem/.gitignore" should match /html/
+    And the file "tmp/newgem/.gitignore" should match /pkg/
+    And the file "tmp/newgem/.gitignore" should match /.DS_Store/
     And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('aruba'/
     And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('rdoc'/
     And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('rake','~> 0.9.2'/
@@ -81,7 +86,6 @@ Feature: Bootstrap a new command-line app
     Then the exit status should not be 0
     And the stderr should match /'app_name' is required/
 
-    @debug
   Scenario: Help is properly documented
     When I get help for "methadone"
     Then the exit status should be 0

data/features/license.feature

@@ -0,0 +1,27 @@
+@pending
+Feature: Users should get the license included
+  As a user
+  I'd like to be able to include a license
+  So that I don't have to hunt it down for every new project
+
+  Scenario: Use a custom license
+    Given a custom license is available at http://localhost:1234/my_license.txt
+    When I run successfully `methadone -l my_license --license-location=http://localhost:1234 newgem`
+    Then newgem's license should identical to the file at http://localhost:1234/my_license.txt
+    And the README should reference the license my_license
+
+  Scenario Outline: Include one of a few stock licenses
+    When I run successfully `methadone -l <license> newgem`
+    Then newgem's license should be the <license> license
+    And the README should reference this license
+
+    Examples:
+      |<license>|
+      |apache|
+      |gpl|
+      |mit|
+
+  Scenario: No license specified
+    When I run successfully `methadone newgem`
+    Then the stderr should contain "Warning: your app has no license"
+    And the README should not reference a license

data/features/readme.feature

@@ -0,0 +1,26 @@
+Feature: a README should be generated
+  As a user
+  I want a template README
+  So I don't need to recall the formatting or other info to get started
+
+  Background:
+    Given the directory "tmp/newgem" does not exist
+
+  Scenario: I don't want a README
+    When I successfully run `methadone --no-readme tmp/newgem`
+    Then a README should not be generated
+    And the file "tmp/newgem/Rakefile" should not match /rd.main = "README.rdoc"/
+
+  Scenario Outline: Generate README
+    When I successfully run `methadone <flag> tmp/newgem`
+    Then a README should be generated in RDoc
+    And the README should contain the project name
+    And the README should contain my name
+    And the README should contain links to Github and RDoc.info
+    And the README should contain empty sections for common elements of a README
+    And the file "tmp/newgem/Rakefile" should match /rd.main = "README.rdoc"/
+
+    Examples:
+      |flag|
+      | |
+      |--readme|

data/features/step_definitions/bootstrap_steps.rb

@@ -13,3 +13,4 @@ end
 Then /^the stderr should match \/([^\/]*)\/$/ do |expected|
   assert_matching_output(expected, all_stderr)
 end
+

data/features/step_definitions/readme_steps.rb

@@ -0,0 +1,26 @@
+Then /^a README should not be generated$/ do
+  Then %(the file "tmp/newgem/README.rdoc" should not exist)
+end
+
+Then /^a README should be generated in RDoc$/ do
+  Then %(a file named "tmp/newgem/README.rdoc" should exist)
+end
+
+Then /^the README should contain the project name$/ do
+  Then %(the file "tmp/newgem/README.rdoc" should match /newgem/)
+end
+
+Then /^the README should contain my name$/ do
+  Then %(the file "tmp/newgem/README.rdoc" should match /Author::  YOUR NAME \\\(YOUR EMAIL\\\)/)
+end
+
+Then /^the README should contain links to Github and RDoc.info$/ do
+  Then %(the file "tmp/newgem/README.rdoc" should match /\\\* \\\{Source on Github\\\}\\\[LINK TO GITHUB\\\]/)
+  Then %(the file "tmp/newgem/README.rdoc" should match /RDoc\\\[LINK TO RDOC.INFO\\\]/)
+end
+
+Then /^the README should contain empty sections for common elements of a README$/ do
+  Then %(the file "tmp/newgem/README.rdoc" should match /^== Install/)
+  Then %(the file "tmp/newgem/README.rdoc" should match /^== Examples/)
+  Then %(the file "tmp/newgem/README.rdoc" should match /^== Contributing/)
+end

data/lib/methadone/main.rb

@@ -1,5 +1,12 @@
 require 'optparse'
 
+begin
+  basic_object = Module.const_get('BasicObject')
+  # We are 1.9.x
+rescue NameError
+  BasicObject = Object
+end
+
 module Methadone
   # Include this module to gain access to the "canonical command-line app structure"
   # DSL.  This is a *very* lightweight layer on top of what you might
@@ -11,7 +18,7 @@ module Methadone
   # as checking for required arguments to your app.  For example, if
   # we want our app to accept a negatable switch named "switch", a flag
   # named "flag", and two arguments "needed" (which is required) 
-  # and "maybe" which optional, we can do the following:
+  # and "maybe" which is optional, we can do the following:
   #
   #     #!/usr/bin/env ruby -w
   #       
@@ -118,7 +125,11 @@ module Methadone
     end
 
     # Returns an OptionParser that you can use
-    # to declare your command-line interface.  The object returned as
+    # to declare your command-line interface.  Generally, you
+    # won't use this and will use #on directly, but this allows
+    # you to have complete control of option parsing.
+    #
+    # The object returned has
     # an additional feature that implements typical use of OptionParser.
     #
     #     opts.on("--flag VALUE")
@@ -155,11 +166,11 @@ module Methadone
     #              This will be converted into a String and used to create
     #              the banner (unless you have overridden the banner)
     # +options+:: list (not Hash) of options:
-    #             <tt>:required</tt> - this arg is required (this is the default)
-    #             <tt>:optional</tt> - this arg is optional
-    #             <tt>:one</tt> - only one of this arg should be supplied (default)
-    #             <tt>:many</tt> - many of this arg may be supplied, but at least one is required
-    #             <tt>:any</tt> - any number, include zero, may be supplied
+    #             <tt>:required</tt>:: this arg is required (this is the default)
+    #             <tt>:optional</tt>:: this arg is optional
+    #             <tt>:one</tt>:: only one of this arg should be supplied (default)
+    #             <tt>:many</tt>::  many of this arg may be supplied, but at least one is required
+    #             <tt>:any</tt>:: any number, include zero, may be supplied
     def arg(arg_name,*options)
       opts.arg(arg_name,*options)
     end
@@ -271,6 +282,11 @@ module Methadone
       @option_parser.send(sym,*args,&block)
     end
 
+    # Since we extend Object on 1.8.x, to_s is defined and thus not proxied by method_missing
+    def to_s #::nodoc::
+      @option_parser.to_s
+    end
+
     private
 
     def set_banner