waddup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124b07086882a87d52aeac3f2774ef9189eb9c6c
-  data.tar.gz: a760abd321c924beca39c80bb54dbd190277b7ac
+  metadata.gz: 41d84aaf796c2b8557e948350c43c4e451833217
+  data.tar.gz: 3acf2d4a01290ffbbec9382bdc42294226df4738
 SHA512:
-  metadata.gz: c56e90b616d1d99204b4e9a09f138d925522fa8fed652b4d4a9aa6c0b2f2825ef35b57251c8cd152a7d8fe2a1d08bb344643b70e22cebaa66c30d788b176f838
-  data.tar.gz: 2dbe261c3af49768d231a8e30c258c44743067f8efecf54b9f4ec3f52fd560d3260bb03d12572ceae4138ca4883f333eb69341d23e9fd9930bd1facd9c9a9108
+  metadata.gz: e4555eb4f6aa5572113ad4e24064140b59af2d9442e6a48dcb9e9d555105d8fd6ca5304c936f447e461f12f6517b01060911dd38cf0b038f623cbc20a005f2c8
+  data.tar.gz: 109ba65acf536fe8324fb4af8bd498b732a0d098212e7391ac3bd45aaa3c80981d243d9810154a4850568121dcb701501ada8fc69d08996e99fdf4f94ca6a6dd

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v0.2.0 - November 29, 2013
+- Proper CLI implementation supporting `--version` and `--help`.
+- Visual and JSON output support using `--format`.
+
 ### v0.1.0 - November 29, 2013
 - Drop support for 1.8.7 and 1.9.2.
 - From/to arguments are treated as past by default.

data/README.md

@@ -81,3 +81,12 @@ To specify an end date, use one of `to`, `until`, `uptil`, `upto` or `through`:
     waddup through yesterday
 
 Defaults to right now if an end date is ommitted.
+
+
+### Formats
+
+At present, Waddup supports two formats: visual (see screenshot) and JSON.
+
+Use the `--format` flag to indicate the desired output format:
+
+    waddup since yesterday --format json

data/bin/sup

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
 
-require 'waddup'
 require 'waddup/cli'
-
-Waddup::CLI.new.run! ARGV

data/bin/waddup

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
 
-require 'waddup'
 require 'waddup/cli'
-
-Waddup::CLI.new.run! ARGV

data/lib/waddup.rb

@@ -8,4 +8,4 @@ require 'waddup/source'
 require 'waddup/sources/apple_calendar'
 require 'waddup/sources/apple_mail'
 require 'waddup/sources/git'
-require 'waddup/version'
+require 'waddup/metadata'

data/lib/waddup/cli.rb

@@ -1,10 +1,15 @@
 require 'chronic'
 
+require 'waddup'
+
 module Waddup
 
   class CLI
+    require 'commander/import'
 
-    attr_accessor :sources, :from, :to
+    program :name, Waddup::NAME
+    program :version, Waddup::VERSION
+    program :description, Waddup::SUMMARY
 
     KEYWORDS = {
       sources: %w[with],
@@ -14,61 +19,83 @@ module Waddup
 
     KEYWORD_BOUNDARY = "(?:\\s#{KEYWORDS.values.flatten.join('|\\s')}|\\Z)"
 
-    def parse!
-      parse_keyword :sources do |match|
-        sources = match[1]
-        @sources = Waddup::Source.usable.select do |source|
-          sources.include? source::ALIAS
+    class << self
+
+      attr_accessor :sources, :from, :to
+
+      def parse!(arguments)
+        @arguments = arguments.join ' '
+
+        parse_keyword :sources do |match|
+          sources = match[1]
+          @sources = Waddup::Source.usable.select do |source|
+            sources.include? source::ALIAS
+          end
+        end
+
+        parse_keyword :from do |match|
+          @from = Chronic.parse match[1], context: :past
         end
-      end
 
-      parse_keyword :from do |match|
-        @from = Chronic.parse match[1], context: :past
+        parse_keyword :to do |match|
+          @to = Chronic.parse match[1], context: :past
+        end
       end
 
-      parse_keyword :to do |match|
-        @to = Chronic.parse match[1], context: :past
+      def parse_keyword(keyword, &block)
+        @arguments.match /(?:#{KEYWORDS[keyword].join('|')})\s(.+?)#{KEYWORD_BOUNDARY}/i, &block
       end
-    end
 
-    def parse_keyword(keyword, &block)
-      @arguments.match /(?:#{KEYWORDS[keyword].join('|')})\s(.+?)#{KEYWORD_BOUNDARY}/i, &block
     end
 
-    # Parses given arguments, aggregates events and renders timesheet
-    def run!(arguments)
-      @arguments = arguments.join ' '
-
-      parse!
+    default_command :timesheet
 
-      # Sanity checking
-      @sources ||= Waddup::Source.usable
-      @from    ||= Time.now
-      @to      ||= Time.now
-
-      # Aggregate events from all sources
-      events = sources.map do |source|
-        source.new.events from, to
-      end
+    command :timesheet do |c|
+      c.syntax = 'waddup with git and mail since last monday 9:00 until yesterday morning'
+      c.description = 'Aggregates events and generates timesheet between from and to range'
+      c.option '--format visual | json', String, 'Provides timesheet in specified format'
+      c.action do |args, options|
+        parse! args
 
-      # Sort events
-      events.flatten!
-      events.sort_by! &:at
+        # Sanity checking
+        @sources ||= Waddup::Source.usable
+        @from    ||= Time.now
+        @to      ||= Time.now
 
-      # Group daily
-      days = events.group_by { |event| event.at.to_date }
+        # Aggregate events from all sources
+        events = sources.map do |source|
+          source.new.events from, to
+        end
 
-      # Generate timesheet
-      days.each_pair do |day, events|
-        puts
-        puts day.strftime('%A, %-d %B %Y')
-        puts
-        events.each do |event|
-          puts "  #{event.at.strftime('%H:%M')}  #{event.source.class::ICON}  #{event.label}"
+        # Sort events
+        events.flatten!
+        events.sort_by! &:at
+
+        # Group daily
+        days = events.group_by { |event| event.at.to_date }
+
+        # Generate timesheet in requested format
+        case options.format
+        when 'json'
+          require 'json'
+          puts JSON.generate days
+        when 'visual'
+          days.each_pair do |day, events|
+            puts
+            puts day.strftime('%A, %-d %B %Y')
+            puts
+
+            events.each do |event|
+              puts "  #{event.at.strftime('%H:%M')}  #{event.source.class::ICON}  #{event.label}"
+            end
+          end
+
+          puts
+        else
+          raise 'Format needs to be either visual or json'
         end
-      end
 
-      puts
+      end
     end
 
   end

data/lib/waddup/event.rb

@@ -9,6 +9,15 @@ module Waddup
       yield self if block_given?
     end
 
+    def to_json(state)
+      {
+        :label  => label,
+        :at     => at,
+        :until  => @until,
+        :source => source.class::ALIAS
+      }.to_json
+    end
+
   end
 
 end

data/lib/waddup/metadata.rb

@@ -0,0 +1,7 @@
+module Waddup
+
+  NAME    = 'Waddup'
+  VERSION = '0.2.0'
+  SUMMARY = 'Waddup retraces your activities from arbitrary sources such as version control, issue tracking software and mail clients'
+
+end

data/waddup.gemspec

@@ -2,7 +2,7 @@
 
 $:.push File.expand_path('../lib', __FILE__)
 
-require 'waddup/version'
+require 'waddup/metadata'
 
 Gem::Specification.new do |s|
   s.name        = 'waddup'
@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Tim Kurvers']
   s.email       = ['tim@moonsphere.net']
   s.homepage    = 'https://github.com/timkurvers/waddup'
-  s.summary     = 'Waddup retraces your activities from arbitrary sources such as version control, issue tracking software and mail clients'
-  s.description = 'Waddup retraces your activities from arbitrary sources - such as version control, issue tracking software and mail clients - and displays them in a neat chronological overview'
+  s.summary     = Waddup::SUMMARY
+  s.description = "#{Waddup::SUMMARY} - and displays them in a neat chronological overview"
 
   s.rubyforge_project = 'waddup'
 
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'chronic', '~> 0.10.2'
+  s.add_dependency 'chronic',   '~> 0.10.2'
+  s.add_dependency 'commander', '~> 4.1.5'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waddup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Kurvers
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Waddup retraces your activities from arbitrary sources - such as version
+description: Waddup retraces your activities from arbitrary sources such as version
   control, issue tracking software and mail clients - and displays them in a neat
   chronological overview
 email:
@@ -151,6 +165,7 @@ files:
 - lib/waddup/extensions/applescript.rb
 - lib/waddup/extensions/file_system.rb
 - lib/waddup/extensions/system.rb
+- lib/waddup/metadata.rb
 - lib/waddup/registry.rb
 - lib/waddup/source.rb
 - lib/waddup/sources/apple_calendar.rb
@@ -158,7 +173,6 @@ files:
 - lib/waddup/sources/apple_mail.rb
 - lib/waddup/sources/apple_mail/sent_mail.applescript
 - lib/waddup/sources/git.rb
-- lib/waddup/version.rb
 - spec/fixtures/sources/apple_calendar.results
 - spec/fixtures/sources/apple_mail.results
 - spec/fixtures/sources/git.log

data/lib/waddup/version.rb

@@ -1,5 +0,0 @@
-module Waddup
-
-  VERSION = '0.1.0'
-
-end