rst 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: "bundle exec rake"

data/README.md

@@ -1,8 +1,21 @@
 rst
 ---
 
+[![Build Status](https://secure.travis-ci.org/clnclarinet/rst.png?branch=master)](http://travis-ci.org/clnclarinet/rst)
+
 A command line client for [rstat.us](http://rstat.us). Heavily influenced by [t](https://github.com/sferik/t).
 
+Usage
+-----
+
+Install the gem:
+
+    gem install rst
+
+Run with no arguments to see the help:
+
+    rst
+
 Current Functionality
 ---------------------
 

data/bin/rst

@@ -1,51 +1,49 @@
 #!/usr/bin/env ruby
-
-require 'optparse'
-require 'methadone'
-require 'rst'
-
-class App
-  include Methadone::Main
-  include Methadone::CLILogging
-
-  main do |command|
-    case command
-    when "world"
-      puts "\n"
-      puts Rst::CLI.world.join("\n\n")
-    else
-      puts opts
+# 1.9 adds realpath to resolve symlinks; 1.8 doesn't
+# have this method, so we add it so we get resolved symlinks
+# and compatibility
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
     end
-    exit 0
   end
+end
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'gli'
+require 'rst'
 
-  # supplemental methods here
+include GLI
 
-  # Declare command-line interface here
+program_desc 'A command line interface for rstat.us'
 
-  arg :command, :optional
+version Rst::VERSION
 
-  description "A command line interface for rstat.us"
+desc 'Display the version and exit.'
+switch [:v, :version]
 
-  #
-  # Accept flags via:
-  # on("--flag VAL","Some flag")
-  # options[flag] will contain VAL
-  #
-  # Specify switches via:
-  # on("--[no-]switch","Some switch")
-  #
-  # Or, just call OptionParser methods on opts
-  #
-  # Require an argument
-  # arg :some_arg
-  #
-  # # Make an argument optional
-  # arg :optional_arg, :optional
+desc 'Get the latest statuses from the whole rstat.us world'
+command :world do |c|
+  c.action do |global_options, options, args|
+    puts Rst::CLI.world.join("\n\n")
+  end
+end
 
-  version Rst::VERSION
+pre do |global, command, options, args|
+  if global[:v]
+    puts "version #{Rst::VERSION}"
+    exit! 0
+  end
+  true
+end
 
-  use_log_level_option
+post do |global, command, options, args|
+end
 
-  go!
+on_error do |exception|
+  true
 end
+
+exit GLI.run(ARGV)

data/features/help.feature

@@ -10,7 +10,7 @@ Feature: Help text
     And the banner should document that this app takes options
     And the following options should be documented:
       |--version|
-      |--log-level|
+      |--help|
 
   Scenario: rst --help
     When I get help for "rst"
@@ -19,7 +19,8 @@ Feature: Help text
     And the banner should document that this app takes options
     And the following options should be documented:
       |--version|
+      |--help|
     And the output should contain:
       """
-      Usage: rst [options] [command]
+      usage: rst [global options] command
       """

data/features/step_definitions/methadone_steps.rb

@@ -0,0 +1,56 @@
+# Cucumber step definitions from
+# http://github.com/davetron5000/methadone/blob/master/lib/methadone/cucumber.rb
+
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} --help`)
+end
+
+Then /^the following options should be documented:$/ do |options|
+  options.raw.each do |option|
+    step %(the option "#{option[0]}" should be documented)
+  end
+end
+
+Then /^the option "([^"]*)" should be documented$/ do |option|
+  step %(the output should match /\\s*#{Regexp.escape(option)}[\\s\\W]+\\w\\w\\w+/)
+end
+
+Then /^the banner should be present$/ do
+  step %(the output should match /usage: #{@app_name}/)
+end
+
+Then /^the banner should document that this app takes options$/ do
+  step %(the output should match /\[options\]/)
+  step %(the output should contain "Options")
+end
+
+Then /^the banner should document that this app's arguments are:$/ do |table|
+  expected_arguments = table.raw.map { |row|
+    option = row[0]
+    option = "[#{option}]" if row[1] == 'optional' || row[1] == 'which is optional'
+    option
+  }.join(' ')
+  step %(the output should contain "#{expected_arguments}")
+end
+
+Then /^the banner should document that this app takes no options$/ do
+  step %(the output should not contain "[options]")
+  step %(the output should not contain "Options")
+end
+
+Then /^the banner should document that this app takes no arguments$/ do
+  step %(the output should match /Usage: #{@app_name}\\s*\(\\[options\\]\)?$/)
+end
+
+Then /^the banner should include the version$/ do
+  step %(the output should match /v\\d+\\.\\d+\\.\\d+/)
+end
+
+Then /^there should be a one line summary of what the app does$/ do
+  output_lines = all_output.split(/\n/)
+  output_lines.should have_at_least(3).items
+  # [0] is our banner, which we've checked for
+  output_lines[1].should match(/^\s*$/)
+  output_lines[2].should match(/^\w\w+\s+\w\w+/)
+end

data/features/step_definitions/rst_steps.rb

@@ -1,4 +1,4 @@
-# Put your step definitions here
+# Custom rst steps
 
 Then /^the output should contain (\d+) updates$/ do |num|
   num = num.to_i

data/features/support/env.rb

@@ -1,5 +1,4 @@
 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')

data/lib/rst/version.rb

@@ -1,3 +1,3 @@
 module Rst
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/rst.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rake','~> 0.9.2')
   gem.add_development_dependency('vcr', '~> 2.1.1')
 
-  gem.add_dependency('methadone', '~> 1.2.0')
+  gem.add_dependency('gli', '~> 1.6.0')
   gem.add_dependency('typhoeus', '~> 0.3.3')
   gem.add_dependency('nokogiri', '~> 1.5.2')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rst
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -108,13 +108,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.1
 - !ruby/object:Gem::Dependency
-  name: methadone
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -165,12 +165,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/rst
 - features/help.feature
+- features/step_definitions/methadone_steps.rb
 - features/step_definitions/rst_steps.rb
 - features/support/env.rb
 - features/world.feature
@@ -211,6 +213,7 @@ specification_version: 3
 summary: A command line client for rstat.us
 test_files:
 - features/help.feature
+- features/step_definitions/methadone_steps.rb
 - features/step_definitions/rst_steps.rb
 - features/support/env.rb
 - features/world.feature