methadone 1.0.0.rc5 → 1.0.0.rc6

data/tutorial/8_conclusion.md

@@ -1,11 +0,0 @@
-# Conclusion
-
-Wow, what a whirlwind tour we've had!  Hopefully, you've gained some confidence in writing command-line apps, and know the
-features Methadone provides to make it a snap.
-
-This is just the tip of the iceberg; [my book][clibook] covers the topic of command-line application development in Ruby in much
-more detail.
-
-There's also more to Methadone than we've been able to cover here; the Rubydoc is extensive and up-to-date, so spend a few
-minutes bouncing around to see what else there is.  And, feel free to [log issues][issues] or submit pull requests on the
-[Github page][methadone-github].

data/tutorial/code/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@methadone-tutorial --create

data/tutorial/code/fullstop/.gitignore

@@ -1,5 +0,0 @@
-.DS_Store
-results.html
-pkg
-html
-.*sw?

data/tutorial/code/fullstop/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in fullstop.gemspec
-gemspec

data/tutorial/code/fullstop/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 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/tutorial/code/fullstop/README.rdoc

@@ -1,23 +0,0 @@
-= fullstop - DESCRIBE YOUR GEM
-
-Author::  YOUR NAME (YOUR EMAIL)
-Copyright:: Copyright (c) 2012 YOUR NAME
-
-
-License:: apache, see LICENSE.txt
-
-
-
-DESCRIBE YOUR GEM HERE
-
-== Links
-
-* {Source on Github}[LINK TO GITHUB]
-* RDoc[LINK TO RDOC.INFO]
-
-== Install
-
-== Examples
-
-== Contributing
-

data/tutorial/code/fullstop/Rakefile

@@ -1,31 +0,0 @@
-require 'bundler'
-require 'rake/clean'
-require 'rake/testtask'
-require 'cucumber'
-require 'cucumber/rake/task'
-gem 'rdoc' # we need the installed RDoc gem, not the system one
-require 'rdoc/task'
-
-include Rake::DSL
-
-Bundler::GemHelper.install_tasks
-
-Rake::TestTask.new do |t|
-  t.pattern = 'test/tc_*.rb'
-end
-
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
-  t.fork = false
-end
-
-Rake::RDocTask.new do |rd|
-  
-  rd.main = "README.rdoc"
-  
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-end
-
-task :default => [:test,:features]

data/tutorial/code/fullstop/bin/fullstop

@@ -1,43 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require 'methadone'
-require 'fullstop'
-require 'fileutils'
-
-class App
-  include Methadone::Main
-  include Methadone::CLILogging
-  include Methadone::SH
-  include Fullstop
-
-  main do |repo_url|
-    Dir.chdir options['checkout-dir'] do
-      repo = Repo.clone_from(repo_url,options[:force])
-      repo.files do |file|
-        link_file(repo,file,options[:force])
-      end
-    end
-    info "Dotfiles symlinked"
-  end
-
-  def self.link_file(repo,file,overwrite)
-    source_file = File.join(repo.repo_dir,file)
-    FileUtils.rm(file) if File.exists?(file) && overwrite
-    FileUtils.ln_s source_file,'.'
-  end
-
-  version Fullstop::VERSION
-
-  description 'Manages dotfiles from a git repo'
-
-  options['checkout-dir'] = ENV['HOME']
-  on("--force","Overwrite files if they exist")
-  on("-d DIR","--checkout-dir","Where to clone the repo")
-
-  arg :repo_url
-
-  use_log_level_option
-
-  go!
-end

data/tutorial/code/fullstop/features/fullstop.feature

@@ -1,40 +0,0 @@
-Feature: Checkout dotfiles
-  In order to get my dotfiles onto a new computer
-  I want a one-command way to keep them up to date
-  So I don't have to do it myself
-
-  Scenario: Basic UI
-    When I get help for "fullstop"
-    Then the exit status should be 0
-    And the banner should be present
-    And there should be a one line summary of what the app does
-    And the banner should include the version
-    And the banner should document that this app takes options
-    And the banner should document that this app's arguments are:
-      |repo_url|which is required|
-    And the following options should be documented:
-      | --force        |
-      | --checkout-dir |
-      | -d             |
-
-  Scenario: Happy Path
-    Given a git repo with some dotfiles at "/tmp/dotfiles.git"
-    When I successfully run `fullstop file:///tmp/dotfiles.git`
-    Then the dotfiles should be checked out in the directory "~/dotfiles"
-    And the files in "~/dotfiles" should be symlinked in my home directory
-
-  Scenario: Fail if directory is cloned
-    Given a git repo with some dotfiles at "/tmp/dotfiles.git"
-    And I have my dotfiles cloned and symlinked to "~/dotfiles"
-    And there's a new file in the git repo
-    When I run `fullstop file:///tmp/dotfiles.git`
-    Then the exit status should not be 0
-    And the stderr should contain "checkout dir already exists, use --force to overwrite"
-
-  Scenario: Force overwrite
-    Given a git repo with some dotfiles at "/tmp/dotfiles.git"
-    And I have my dotfiles cloned and symlinked to "~/dotfiles"
-    And there's a new file in the git repo
-    When I successfully run `fullstop --force file:///tmp/dotfiles.git`
-    Then the dotfiles in "~/dotfiles" should be re-cloned
-    And the files in "~/dotfiles" should be symlinked in my home directory

data/tutorial/code/fullstop/features/step_definitions/fullstop_steps.rb

@@ -1,64 +0,0 @@
-include FileUtils
-
-FILES = %w(.vimrc .bashrc .exrc)
-NEW_FILE = '.inputrc'
-
-Given /^a git repo with some dotfiles at "([^"]*)"$/ do |repo_dir|
-  @repo_dir = repo_dir
-  base_dir = File.dirname(repo_dir)
-  dir = File.basename(repo_dir)
-  puts base_dir
-  puts dir
-  Dir.chdir base_dir do
-    rm_rf dir
-    mkdir dir
-  end
-  Dir.chdir repo_dir do
-    FILES.each { |_| touch _ }
-    sh "git init ."
-    sh "git add #{FILES.join(' ')}"
-    sh "git commit -a -m 'initial commit'"
-  end
-end
-
-Then /^the dotfiles should be checked out in the directory "([^"]*)"$/ do |dotfiles_dir|
-  @files = @files_override || FILES
-  # Expand ~ to ENV["HOME"]
-  base_dir = File.dirname(dotfiles_dir)
-  base_dir = ENV['HOME'] if base_dir == "~"
-  dotfiles_dir = File.join(base_dir,File.basename(dotfiles_dir))
-
-  File.exist?(dotfiles_dir).should == true
-  Dir.chdir dotfiles_dir do
-    @files.each do |file|
-      File.exist?(file).should == true
-    end
-  end
-end
-
-Then /^the files in "([^"]*)" should be symlinked in my home directory$/ do |dotfiles_dir|
-  @files = @files_override || FILES
-  Dir.chdir(ENV['HOME']) do
-    @files.each do |file|
-      File.lstat(file).should be_symlink
-    end
-  end
-end
-
-Given /^I have my dotfiles cloned and symlinked to "([^"]*)"$/ do |dir|
-  step %{I successfully run `fullstop file://#{@repo_dir}`}
-end
-
-Given /^there's a new file in the git repo$/ do
-  Dir.chdir @repo_dir do
-    touch NEW_FILE
-    sh "git add #{NEW_FILE}"
-    sh "git commit -m 'added'"
-  end
-end
-
-Then /^the dotfiles in "([^"]*)" should be re\-cloned$/ do |dir|
-  @files_override = FILES + [NEW_FILE]
-  step %{the dotfiles should be checked out in the directory "#{dir}"}
-end
-

data/tutorial/code/fullstop/features/support/env.rb

@@ -1,22 +0,0 @@
-require 'aruba/cucumber'
-require 'methadone/cucumber'
-
-ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
-LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
-
-Before do
-  # Using "announce" causes massive warnings on 1.9.2
-  @puts = true
-  @original_rubylib = ENV['RUBYLIB']
-  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
-  @original_home = ENV['HOME']
-  ENV['HOME'] = "/tmp/fakehome"
-  FileUtils.rm_rf "/tmp/fakehome"
-  FileUtils.mkdir "/tmp/fakehome"
-  @files_override = nil
-end
-
-After do
-  ENV['RUBYLIB'] = @original_rubylib
-  ENV['HOME'] = @original_home
-end