usaidwat 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2042e843c42b44f059297bb23e7350e9b0575978
-  data.tar.gz: 2a716a7208ab8af75b394701bd3b691f405b6a97
+  metadata.gz: 879e08c770c49388f73103250f6d6b34dd996afe
+  data.tar.gz: 09bc9f9c9c48498de136ab08d61092760ee16d0b
 SHA512:
-  metadata.gz: 4ed1d0358a6a8156dd27ac8f5e4bda3c2836874d126c8c40c850e07aa466c13d43fa1a0941b80ceddced3a52c56f5ba012f8a60f536ee21c7df91472ef162a51
-  data.tar.gz: 6a49f252762dd2664fb15f33b9966212ce0155e74d92c4771f17e91e021d34c95577313544ec88ebcbed5cd45b74cc2919af3504c4b0658479203e2dc9da31ff
+  metadata.gz: 0cd18092af983b5368707fa4198fdb57c934f7e8fd1b56acabc17db2297dca2ec356a99fcf95975318d4f19a4913e3cee57e11b2bed44c16a1066b36cf91863f
+  data.tar.gz: 3b8b25c190b2b5919bf30c7f6972624ee093637c7b4b4aac7e63570f7a64ecf76df612eca1dccd8c843c0bfbaec55f26bebe6dc0a1bdee93bddc70d3ae2da9fb

data/README.textile

@@ -12,46 +12,39 @@ h2(#usage). Usage
 
 A @usaidwat@ binary is installed with the gem. @usaidwat@ will analyze a user's last 100 comments and provide statistics.
 
-To list a Redditor's comments, simply plug in a username:
+To list a Redditor's comments, use the @log@ subcommand:
 
-bc. $ usaidwat jedberg
+bc. $ usaidwat log mipadi
 
-To list a count of subreddits in which a user has posted, pass the @--tally@ flag:
+To list a count of subreddits in which a user has posted, use the @tally@
+subcommand:
 
-bc. $ usaidwat -t jedberg
+bc. $ usaidwat tally mipadi
 
 You will see output like the following:
 
-bc. blog                  26
-funny                 15
-unitedkingdom         12
-Random_Acts_Of_Pizza  11
-AskReddit             7
-entertainment         4
-politics              4
-TheoryOfReddit        3
-Frugal                3
-technology            2
-fffffffuuuuuuuuuuuu   2
-wikipedia             2
-pics                  1
-programming           1
-sex                   1
-space                 1
-movies                1
-geek                  1
-comics                1
-videos                1
-apple                 1
-
-Which indicates that jedberg has commented in @/r/funny@ 15 times (out of his last 100 comments).
+bc. apple              6
+AskReddit         61
+battlefield3       2
+books              2
+django             1
+Games              1
+nyc                1
+personalfinance    1
+photography        1
+programming       20
+redditcasual       1
+wikipedia          1
+worldnews          2
+
+Which indicates that mipadi has commented in @/r/AskReddit@ 61 times (out of his last 100 comments).
 
 To see the comments for a specific subreddit, tack on that subreddit:
 
-bc. $ usaidwat jedberg funny
+bc. $ usaidwat log mipadi AskReddit
 
 All the comments for the given subreddit will be printed.
 
 h2(#testing). Testing
 
-Test suites can be run with RSpec and Cucumber.
+Test suites can be run with RSpec and Cucumber.

data/Rakefile

@@ -1,7 +1,29 @@
-require "bundler/gem_tasks"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usaidwat/version'
+
+GEMSPEC = `git ls-files | grep gemspec`.chomp
+GEM     = "usaidwat-#{USaidWat::VERSION}.gem"
+
+desc "Build usaidwat.gem"
+task :build do
+  system "gem", "build", GEMSPEC
+end
+
+desc "Install usaidwat.gem"
+task :install => :build do
+  system "gem", "install", GEM
+end
+
+desc "Push gem to RubyGems"
+task :release => :build do
+  system "git", "tag", "-s", "-m", "usaidwat v#{USaidWat::VERSION}", "v#{USaidWat::VERSION}"
+  system "gem", "push", GEM
+end
 
 desc "Clean built products"
 task :clean do
-  rm_rf "pkg", :verbose => true
   rm Dir.glob("*.gem"), :verbose => true
 end
+
+task :default => :build

data/bin/usaidwat

@@ -2,4 +2,4 @@
 
 require 'usaidwat'
 
-USaidWat.application.run(ARGV)
+USaidWat::Application.start(ARGV)

data/features/browse.feature

@@ -7,7 +7,7 @@ Feature: Browse comments
   Scenario: List all comments
     Given the Reddit service returns comments for the user "mipadi"
     And time is frozen at Jun 24, 2015 11:05 AM
-    When I run `usaidwat mipadi`
+    When I run `usaidwat log mipadi`
     Then it should pass with:
       """
       wikipedia
@@ -36,7 +36,7 @@ Feature: Browse comments
 
   Scenario: List all comments for a user that does not exist
     Given the Reddit service does not have a user "testuser"
-    When I run `usaidwat testuser`
+    When I run `usaidwat log testuser`
     Then it should fail with:
       """
       No such user: testuser
@@ -44,7 +44,7 @@ Feature: Browse comments
 
   Scenario: List all comments when user has no comments
     Given the Reddit service returns comments for the user "blank"
-    When I run `usaidwat blank`
+    When I run `usaidwat log blank`
     Then it should pass with:
       """
       blank has no comments.
@@ -52,7 +52,7 @@ Feature: Browse comments
 
   Scenario: Tally comments
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -t mipadi`
+    When I run `usaidwat tally mipadi`
     Then it should pass with:
       """
       apple              6
@@ -72,7 +72,7 @@ Feature: Browse comments
 
   Scenario: Sort comments
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -T mipadi`
+    When I run `usaidwat tally -c mipadi`
     Then it should pass with:
       """
       AskReddit         61
@@ -92,7 +92,7 @@ Feature: Browse comments
 
   Scenario: Tally comments when user has no comments
     Given the Reddit service returns comments for the user "blank"
-    When I run `usaidwat -t blank`
+    When I run `usaidwat tally -c blank`
     Then it should pass with:
       """
       blank has no comments.
@@ -100,7 +100,7 @@ Feature: Browse comments
 
   Scenario: Sort comments when user has no comments
     Given the Reddit service returns comments for the user "blank"
-    When I run `usaidwat -T blank`
+    When I run `usaidwat tally -c blank`
     Then it should pass with:
       """
       blank has no comments.
@@ -109,7 +109,7 @@ Feature: Browse comments
   Scenario: List comments for a particular subreddit
     Given the Reddit service returns comments for the user "mipadi"
     And time is frozen at Jun 24, 2015 11:05 AM
-    When I run `usaidwat mipadi AskReddit`
+    When I run `usaidwat log mipadi AskReddit`
     Then it should pass with:
       """
       AskReddit
@@ -139,7 +139,7 @@ Feature: Browse comments
   Scenario: List comments for a particular subreddit specified with the wrong case
     Given the Reddit service returns comments for the user "mipadi"
     And time is frozen at Jun 24, 2015 11:05 AM
-    When I run `usaidwat mipadi askreddit`
+    When I run `usaidwat log mipadi askreddit`
     Then it should pass with:
       """
       AskReddit
@@ -168,7 +168,7 @@ Feature: Browse comments
 
   Scenario: List comments for a subreddit with no comments
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat mipadi nsfw`
+    When I run `usaidwat log mipadi nsfw`
     Then it should pass with:
       """
       No comments by mipadi for nsfw.
@@ -176,40 +176,44 @@ Feature: Browse comments
 
   Scenario: Tally comments with subreddit
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -t mipadi AskReddit`
+    When I run `usaidwat tally mipadi AskReddit`
     Then it should fail with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      ERROR: "usaidwat tally" was called with arguments ["mipadi", "AskReddit"]
+      Usage: "usaidwat tally USERNAME"
       """
 
   Scenario: Sort comments with subreddit
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -T mipadi AskReddit`
+    When I run `usaidwat tally -c mipadi AskReddit`
     Then it should fail with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      ERROR: "usaidwat tally" was called with arguments ["mipadi", "AskReddit"]
+      Usage: "usaidwat tally USERNAME"
       """
 
   Scenario: Pass no arguments
     Given the Reddit service returns comments for the user "mipadi"
     When I run `usaidwat`
-    Then it should fail with:
+    Then it should pass with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      Commands:
       """
 
   Scenario: Pass no arguments when tallying
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -t`
+    When I run `usaidwat tally`
     Then it should fail with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      ERROR: "usaidwat tally" was called with no arguments
+      Usage: "usaidwat tally USERNAME"
       """
 
   Scenario: Pass no arguments when sorting
     Given the Reddit service returns comments for the user "mipadi"
-    When I run `usaidwat -T`
+    When I run `usaidwat tally -c`
     Then it should fail with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      ERROR: "usaidwat tally" was called with no arguments
+      Usage: "usaidwat tally USERNAME"
       """

data/features/help.feature

@@ -8,7 +8,7 @@ Feature: Get help
     When I run `usaidwat --help`
     Then it should pass with:
       """
-      Usage: usaidwat [-t | -T] <user> [<subreddit>]
+      Commands:
       """
   
   Scenario: Get version

data/features/step_definitions/reddit_steps.rb

@@ -1,7 +1,7 @@
 Given /^the Reddit service returns comments for the user "(.*?)"$/ do |user|
-  set_env 'USAIDWAT_ENV', 'cucumber'
+  set_environment_variable 'USAIDWAT_ENV', 'cucumber'
 end
 
 Given /^the Reddit service does not have a user "(.*?)"$/ do |user|
-  set_env 'USAIDWAT_ENV', 'cucumber'
+  set_environment_variable 'USAIDWAT_ENV', 'cucumber'
 end

data/lib/usaidwat/application.rb

@@ -1,98 +1,83 @@
-module USaidWat
-  class << self
-    def application
-      client = ENV['USAIDWAT_ENV'] == 'cucumber' ? USaidWat::Client::TestRedditor : USaidWat::Client::Redditor
-      @application ||= USaidWat::Application.new(client)
-    end
-  end
+require 'sysexits'
+require 'thor'
+require 'usaidwat/pager'
 
-  class Application
-    def initialize(client)
-      @client = client
-      Signal.trap("PIPE", "EXIT")
-    end
+module USaidWat
+  class Application < Thor
+    include Pager
+    include Sysexits
 
-    def run(argv)
-      trap("INT") { puts; exit 0 }
-      opts, args = handle_arguments(argv)
-      username = args.first
-      @redditor = @client.new(username)
-      @algo = opts.algorithm
-      begin
-        return tally_comments if opts.tally
-        return list_comments_for_subreddit(args[1]) if args.length == 2
-        return list_all_comments
-      rescue USaidWat::Client::NoSuchUserError
-        quit "No such user: #{username}", 3
+    class << self
+      def client
+        ENV['USAIDWAT_ENV'] == 'cucumber' ? USaidWat::Client::TestRedditor : USaidWat::Client::Redditor
       end
-    end
-
-    def usage(code=0)
-      puts "Usage: usaidwat [-t | -T] <user> [<subreddit>]"
-      exit code
-    end
-
-    def version(code=0)
-      puts "usaidwat v#{USaidWat::VERSION}"
-      exit 0
-    end
-
-    def quit(message, code=0)
-      puts message
-      exit code
-    end
 
-    def list_all_comments
-      quit "#{@redditor.username} has no comments." if @redditor.comments.empty?
-      formatter = USaidWat::CLI::CommentFormatter.new
-      @redditor.comments.each { |c| print formatter.format(c) }
+      def exit_on_failure?
+        true
+      end
     end
 
-    def list_comments_for_subreddit(subreddit)
-      comments = @redditor.comments
-      comments = comments.group_by { |c| c.subreddit.downcase }
-      comments = comments[subreddit.downcase]
-      quit "No comments by #{@redditor.username} for #{subreddit}." if comments.nil?
-      formatter = USaidWat::CLI::CommentFormatter.new
-      comments.each { |c| print formatter.format(c) }
-    end
+    map '--version' => :version
+    map 't' => :tally
+    map 'l' => :log
 
-    def tally_comments
-      quit "#{@redditor.username} has no comments." if @redditor.comments.empty?
+    desc 'tally USERNAME', 'Count comments by subreddit'
+    option :count, :aliases => '-c', :type => :boolean, :desc => 'Sort output by number of comments'
+    def tally(username)
+      redditor = Application.client.new(username)
+      algo_cls = options[:count] ? USaidWat::Algorithms::CountAlgorithm : USaidWat::Algorithms::LexicographicalAlgorithm
+      quit "#{redditor.username} has no comments." if redditor.comments.empty?
       # Unfortunately Snooby cannot return comments for a specific
       # user in a specific subreddit, so for now we have to sort them
       # ourself.
       longest_subreddit = 0
       buckets = Hash.new { |hash, key| hash[key] = 0 }
-      @redditor.comments.each do |comment|
+      redditor.comments.each do |comment|
         subreddit = comment.subreddit
         longest_subreddit = subreddit.length if subreddit.length > longest_subreddit
         buckets[subreddit] += 1
       end
-      algo = @algo.new(buckets)
+      algo = algo_cls.new(buckets)
       subreddits = buckets.keys.sort { |a,b| algo.sort(a, b) }
       subreddits.each do |subreddit|
         tally = buckets[subreddit]
         printf "%-*s  %3d\n", longest_subreddit, subreddit, tally
       end
-      exit 0
     end
 
-    private
-      def handle_arguments(argv)
-        opts = OpenStruct.new
-        opts.tally = false
-        opts.algorithm = USaidWat::Algorithms::LexicographicalAlgorithm
-        usage(1) if argv.length == 0
-        usage if argv.first == "--help"
-        version if argv.first == "--version"
-        if %W{-t -T}.include?(argv.first)
-          opts.tally = true
-          opts.algorithm = USaidWat::Algorithms::CountAlgorithm if argv.first == "-T"
-          argv.shift
-          usage(1) unless argv.length == 1
-        end
-        [opts, argv]
+    desc 'log USERNAME [SUBREDDIT]', 'Show comments by a user'
+    def log(username, subreddit = nil)
+      redditor = Application.client.new(username)
+      if subreddit
+        comments = redditor.comments
+        comments = comments.group_by { |c| c.subreddit.downcase }
+        comments = comments[subreddit.downcase]
+        quit "No comments by #{redditor.username} for #{subreddit}." if comments.nil?
+        list_comments(comments)
+      else
+        quit "#{redditor.username} has no comments." if redditor.comments.empty?
+        list_comments(redditor.comments)
+      end
+    rescue USaidWat::Client::NoSuchUserError
+      quit "No such user: #{username}", :no_such_user
+    end
+
+    desc 'version', 'Show version info and exit'
+    def version
+      puts "usaidwat v#{USaidWat::VERSION}"
+    end
+
+    no_commands do
+      def list_comments(comments)
+        formatter = USaidWat::CLI::CommentFormatter.new
+        page
+        comments.each { |c| print formatter.format(c) }
       end
+
+      def quit(message, code=:ok)
+        puts message
+        exit code
+      end
+    end
   end
 end

data/lib/usaidwat/ext/string.rb

@@ -4,7 +4,7 @@ class String
   end
 
   def convert_entities
-    self.gsub(/&gt;/, '>').gsub(/&lt;/, '<')
+    self.gsub(/&gt;/, '>').gsub(/&lt;/, '<').gsub(/&amp;/, '&')
   end
 
   def pluralize(n, suffix = 's', singular_suffix = '')

data/lib/usaidwat/pager.rb

@@ -0,0 +1,28 @@
+module Pager
+  def page
+    return if RUBY_PLATFORM =~ /win32/
+    return unless STDOUT.tty?
+
+    read, write = IO.pipe
+
+    unless Kernel.fork # Child process
+      STDOUT.reopen(write)
+      STDERR.reopen(write) if STDERR.tty?
+      read.close
+      write.close
+      return
+    end
+
+    # Parent process, become pager
+    STDIN.reopen(read)
+    read.close
+    write.close
+
+    ENV['LESS'] = 'FSRX' unless ENV['LESS']
+
+    Kernel.select [STDIN] # Wait until we have input before we start the pager
+    pager = ENV['PAGER'] || 'less'
+    exec pager rescue exec "/bin/sh", "-c", pager
+  rescue StandardError
+  end
+end

data/lib/usaidwat/version.rb

@@ -1,3 +1,3 @@
 module USaidWat
-  VERSION = "0.1.7"
+  VERSION = "1.0.0"
 end

data/spec/usaidwat/string_spec.rb

@@ -18,12 +18,19 @@ module USaidWat
           expect(actual).to eq(expected)
         end
 
-        it "converts both &gt; and &lt; to <" do
+        it "converts both &gt; and &lt; to > and <" do
           s = "look -&gt; this string has both &lt;- awesome, huh?"
           expected = "look -> this string has both <- awesome, huh?"
           actual = s.convert_entities
           expect(actual).to eq(expected)
         end
+
+        it "converts &amp; to &" do
+          s = "i like cake &amp; ice cream"
+          expected = "i like cake & ice cream"
+          actual = s.convert_entities
+          expect(actual).to eq(expected)
+        end
       end
 
       describe "#truncate" do

data/usaidwat.gemspec

@@ -18,11 +18,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency('snooby', '~> 0.1.5')
+  gem.add_runtime_dependency('highline', '~> 1.7')
   gem.add_runtime_dependency('rainbow', '~> 2.0')
-  gem.add_runtime_dependency('highline', '~> 1.7', '>= 1.7.2')
+  gem.add_runtime_dependency('snooby', '~> 0.1.5')
+  gem.add_runtime_dependency('sysexits', '~> 1.2')
+  gem.add_runtime_dependency('thor', '~> 0.19.1')
 
-  gem.add_development_dependency('aruba', '~> 0.6.2')
+  gem.add_development_dependency('aruba', '~> 0.8.1')
   gem.add_development_dependency('cucumber', '~> 2.0')
   gem.add_development_dependency('rspec', '~> 3.2')
   gem.add_development_dependency('timecop', '~> 0.7.4')

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: usaidwat
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Dippery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: snooby
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -39,39 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: snooby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: sysexits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +180,7 @@ files:
 - lib/usaidwat/ext/string.rb
 - lib/usaidwat/ext/time.rb
 - lib/usaidwat/formatter.rb
+- lib/usaidwat/pager.rb
 - lib/usaidwat/service.rb
 - lib/usaidwat/version.rb
 - spec/spec_helper.rb