usaidwat 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81fff9eeb3cb27fb171c0e765857245b69a7cfa6
-  data.tar.gz: 0e8665fd1c0b68b607fd0354624ea089e0e9015d
+  metadata.gz: f691290d3941259d0b2cfdfaa0ac6f256df6bfba
+  data.tar.gz: 4e943e27e1d55d4c3fb08b10c1d8298b24303312
 SHA512:
-  metadata.gz: e00710b0a337b430c7fa576dc4ca58e847e402b060d316df87561fb555133c41b0d7a7247208d1ff6d3773330c5aee481aeb69f3ab833e3ecaf97151f3aefedb
-  data.tar.gz: 80415d6345702d01eb5d4bc5df197e09ed4b308bf1ed657e25cf4fc4300eba3653ecb5c3dfa5e36667c9f6888504af28e1a0341a4e893810a1c345f384c2df87
+  metadata.gz: 568babcb320e2cbddbd18ee4bfb1a3f8a6f33e3a014abe65992d1bfebad0fe5fb9d4199e2df85d8054da83ee36fc80c49087d7d0825ea72cc0a5fc3c2730ef35
+  data.tar.gz: b8532c9d3210713253e8f9a7fd9cf9f5b01bd37babbac633c16454b40bdef0290cdfec2840620acae013958d380e8a46efd512e107801dccc0e67d06a4429783

data/Rakefile

@@ -31,6 +31,13 @@ task :release => [:tag, :build] do
   system "gem", "push", GEM
 end
 
+desc "Run the test suite"
+task :test do
+  ok = system "bundle", "exec", "rspec"
+  fail if !ok
+  system "bundle", "exec", "cucumber", "-f", "progress"
+end
+
 desc "Clean built products"
 task :clean do
   rm Dir.glob("*.gem"), :verbose => true

data/bin/usaidwat

@@ -5,7 +5,9 @@ require 'usaidwat'
 require 'usaidwat/ext/mercenary'
 
 Mercenary.program(:usaidwat) do |p|
-  p.version USaidWat::VERSION
+  version = USaidWat::VERSION
+  version += " (#{USaidWat::commit_hash})" if USaidWat::VERSION.end_with?('.dev')
+  p.version version
   p.description 'Answers the age-old question, "Where does a Redditor comment the most?"'
   p.syntax 'usaidwat <command> [options] <args>'
 

data/features/timeline.feature

@@ -0,0 +1,46 @@
+Feature: Show timeline of comments
+
+  As a Redditor
+  I want to visualize when another Redditor comments most often
+  In order to see what time they like to comment
+
+  Scenario: Show timeline data for user
+    Given the Reddit service returns comments for the user "mipadi"
+    When I run `usaidwat timeline mipadi`
+    Then it should pass with:
+      """
+        0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
+      S                 *           *                 *                        
+      M                          *  *  *     *  *  *  *     *     *            
+      T                       *  *  *  *  *  *  *  *     *                     
+      W                          *  *  *  *  *     *                           
+      T                          *  *  *     *  *  *                 *  *      
+      F                          *  *  *                 *        *  *  *      
+      S                                      *  *                              
+      """
+
+  Scenario: Show timeline data for a user with no comments
+    Given the Reddit service returns comments for the user "blank"
+    When I run `usaidwat timeline blank`
+    Then it should pass with:
+      """
+      blank has no comments.
+      """
+
+  Scenario: Show timeline data without specifying a user
+    Given the Reddit service returns comments for the user "mipadi"
+    When I run `usaidwat timeline testuser`
+    Then the exit status should not be 0
+    And stderr should contain exactly:
+      """
+      No such user: testuser
+      """
+
+  Scenario: Show timeline without specifying a user
+    Given the Reddit service returns comments for the user "mipadi"
+    When I run `usaidwat timeline`
+    Then the exit status should not be 0
+    And stderr should contain exactly:
+      """
+      You must specify a username
+      """

data/lib/usaidwat.rb

@@ -9,6 +9,7 @@ require "usaidwat/algo"
 require "usaidwat/client"
 require "usaidwat/command"
 require "usaidwat/formatter"
+require "usaidwat/thing"
 require "usaidwat/version"
 
 require_all "usaidwat/commands"

data/lib/usaidwat/client.rb

@@ -1,11 +1,13 @@
-require 'snooby'
 require 'usaidwat/service'
-require 'usaidwat/ext/snooby'
 require 'usaidwat/ext/time'
 
 module USaidWat
   module Client
-    class ReachabilityError < RuntimeError; end
+    class ReachabilityError < RuntimeError
+      def initialize(msg = nil)
+        super(msg || 'Reddit unreachable')
+      end
+    end
 
     class NoSuchUserError < StandardError; end
 
@@ -20,20 +22,20 @@ module USaidWat
         user.comments(100)
       rescue NoMethodError
         raise NoSuchUserError, username
-      rescue TypeError, Net::HTTP::Persistent::Error
-        raise ReachabilityError, "Reddit unreachable"
+      rescue RuntimeError
+        raise ReachabilityError
       end
 
       def link_karma
-        about('link_karma')
+        about.link_karma
       end
 
       def comment_karma
-        about('comment_karma')
+        about.comment_karma
       end
 
       def created_at
-        Time.at(about('created_utc'))
+        about.created_utc
       end
 
       def age
@@ -48,8 +50,8 @@ module USaidWat
         user.posts
       rescue NoMethodError
         raise NoSuchUserError, username
-      rescue TypeError, Net::HTTP::Persistent::Error
-        raise ReachabilityError, "Reddit unreachable"
+      rescue RuntimeError
+        raise ReachabilityError
       end
 
       private
@@ -58,18 +60,16 @@ module USaidWat
         @service.user(username)
       end
 
-      def about(key)
-        user.about[key]
+      def about
+        user.about
       rescue NoMethodError
         raise NoSuchUserError, username
-      rescue TypeError, Net::HTTP::Persistent::Error
-        raise ReachabilityError, "Reddit unreachable"
       end
     end
 
     class Redditor < BaseRedditor
       def initialize(username)
-        @service = Snooby::Client.new("usaidwat v#{USaidWat::VERSION}")
+        @service = USaidWat::Service::RedditService.new
         super
       end
     end

data/lib/usaidwat/commands/timeline.rb

@@ -0,0 +1,42 @@
+module USaidWat
+  module Application
+    class Timeline < Command
+      def initialize(prog)
+        prog.command(:timeline) do |c|
+          c.action do |args, options|
+            process(options, args)
+          end
+        end
+        super
+      end
+
+      def process(options, args)
+        raise ArgumentError.new('You must specify a username') if args.empty?
+        username = args.shift
+
+        redditor = client.new(username)
+        comments = redditor.comments
+
+        quit "#{username} has no comments." if comments.empty?
+
+        buckets = comments_by_days_and_hours(comments)
+        times = Array.new(7) { Array.new(24, 0) }
+        buckets.each do |v|
+          d, h = v
+          times[d][h] += 1
+        end
+
+        formatter = USaidWat::CLI::TimelineFormatter.new
+        puts formatter.format(times)
+      rescue USaidWat::Client::NoSuchUserError
+        quit "No such user: #{username}", :no_such_user
+      end
+
+      private
+
+      def comments_by_days_and_hours(comments)
+        comments.map { |c| [c.created_utc.wday, c.created_utc.hour] }
+      end
+    end
+  end
+end

data/lib/usaidwat/formatter.rb

@@ -1,187 +1,7 @@
-require 'date'
-require 'downterm'
-require 'rainbow/ext/string'
-require 'redcarpet'
-require 'set'
-require 'stringio'
-require 'ttycaca'
-require 'usaidwat/ext/string'
-require 'usaidwat/ext/time'
+require 'usaidwat/formatter/base'
+require 'usaidwat/formatter/comment'
+require 'usaidwat/formatter/count'
+require 'usaidwat/formatter/post'
+require 'usaidwat/formatter/timeline'
 
 Rainbow.enabled = true unless ENV['USAIDWAT_ENV'] == 'cucumber'
-
-module USaidWat
-  module CLI
-    class BaseFormatter
-      def initialize(options = {})
-        @options = options
-        @count = 0
-      end
-
-      def pattern
-        @options[:pattern]
-      end
-
-      def pattern?
-        !!@options[:pattern]
-      end
-
-      def raw?
-        !!@options[:raw]
-      end
-
-      def relative_dates?
-        @options[:date_format].nil? || @options[:date_format].to_sym != :absolute
-      end
-
-      protected
-
-      def tty
-        @tty ||= Ttycaca::Terminal.new
-      end
-    end
-
-    class PostFormatter < BaseFormatter
-      def format(post)
-        cols = tty.width
-        out = StringIO.new
-        out.write("\n\n\n") unless @count == 0
-        out.write("#{post.subreddit}\n".color(:green))
-        out.write("#{post_link(post)}\n".color(:yellow))
-        out.write("#{post.title.strip.unescape_html.truncate(cols)}\n".color(:magenta))
-        out.write("#{post_date(post)}".color(:blue))
-        out.write("\n#{post.url}") unless post.url.end_with?(post.permalink)
-        @count += 1
-        out.rewind
-        out.read
-      end
-
-      private
-
-      def post_link(post)
-        "https://www.reddit.com#{post.permalink.split('/')[0..-2].join('/')}"
-      end
-
-      def post_date(post)
-        Time.at(post.created_utc).ago
-      end
-    end
-
-    class CompactPostFormatter < BaseFormatter
-      def format(post)
-        cols = tty.width
-        out = StringIO.new
-        subreddit = post.subreddit
-        cols -= subreddit.length + 1
-        title = post.title.strip.unescape_html.truncate(cols)
-        out.write(subreddit.color(:green))
-        out.write(" #{title}\n")
-        out.rewind
-        out.read
-      end
-    end
-
-    class CommentFormatter < BaseFormatter
-      def format(comment)
-        cols = tty.width
-        out = StringIO.new
-        out.write("\n\n") unless @count == 0
-        out.write("#{comment.subreddit}\n".color(:green))
-        out.write("#{comment_link(comment)}\n".color(:yellow))
-        out.write("#{comment.link_title.strip.unescape_html.truncate(cols)}\n".color(:magenta))
-        out.write("#{comment_date(comment)}".color(:blue))
-        out.write(" \u2022 ".color(:cyan))
-        out.write(sprintf("%+d\n", comment_karma(comment)).color(:blue))
-        out.write("\n")
-        out.write("#{comment_body(comment)}\n")
-        @count += 1
-        out.rewind
-        out.read
-      end
-      
-      private
-        def markdown
-          @markdown ||= Redcarpet::Markdown.new(Downterm::Render::Terminal, :autolink => true,
-                                                                            :strikethrough => true,
-                                                                            :superscript => true)
-        end
-
-        def comment_body(comment)
-          body = comment.body.strip.unescape_html
-          body = markdown.render(body) unless raw?
-          if pattern?
-            body.highlight(pattern)
-          else
-            body
-          end
-        end
-
-        def comment_link(comment)
-          link = comment.link_id.split("_")[-1]
-          "http://www.reddit.com/r/#{comment.subreddit}/comments/#{link}/z/#{comment.id}"
-        end
-
-        def comment_date(comment)
-          d = DateTime.strptime(comment.created_utc.to_s, "%s").to_time.localtime
-          if relative_dates?
-            d.ago
-          else
-            d_part = d.strftime("%a, %-d %b %Y")
-            t_part = d.strftime("%l:%M %p").strip
-            "#{d_part}, #{t_part}"
-          end
-        end
-
-        def comment_karma(comment)
-          comment.ups - comment.downs
-        end
-    end
-
-    class CompactCommentFormatter < BaseFormatter
-      def format(comment)
-        cols = tty.width
-        out = StringIO.new
-        subreddit = comment.subreddit
-        cols -= subreddit.length + 1
-        title = comment.link_title.strip.unescape_html.truncate(cols)
-        key = "#{subreddit} #{title}"
-        if !seen?(key)
-          out.write("#{subreddit}".color(:green))
-          out.write(" #{title}\n")
-        end
-        mark_seen(key)
-        out.rewind
-        out.read
-      end
-
-      private
-
-      def comments
-        @comments ||= Set.new
-      end
-
-      def mark_seen(comment)
-        comments << comment
-      end
-
-      def seen?(comment)
-        comments.include?(comment)
-      end
-    end
-
-    class TallyFormatter < BaseFormatter
-      def format(partition_data)
-        out = StringIO.new
-        longest_subreddit = partition_data.longest
-        subreddits = partition_data.counts
-        subreddits.each do |subreddit_count|
-          subreddit, tally = subreddit_count
-          line = sprintf("%-*s  %3d\n", longest_subreddit, subreddit, tally)
-          out.write(line)
-        end
-        out.rewind
-        out.read
-      end
-    end
-  end
-end

data/lib/usaidwat/formatter/base.rb

@@ -0,0 +1,39 @@
+require 'downterm'
+require 'rainbow/ext/string'
+require 'redcarpet'
+require 'ttycaca'
+
+module USaidWat
+  module CLI
+    module TTYFormatter
+      def tty
+        @tty ||= Ttycaca::Terminal.new
+      end
+    end
+
+    class BaseFormatter
+      include TTYFormatter
+
+      def initialize(options = {})
+        @options = options
+        @count = 0
+      end
+
+      def pattern
+        @options[:pattern]
+      end
+
+      def pattern?
+        !!@options[:pattern]
+      end
+
+      def raw?
+        !!@options[:raw]
+      end
+
+      def relative_dates?
+        @options[:date_format].nil? || @options[:date_format].to_sym != :absolute
+      end
+    end
+  end
+end