timetrack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c133eec77f7c3e384c12cc90080d5e243ac594
-  data.tar.gz: 63777024840ac286d9d950ea07ea0b32cba5fa6e
+  metadata.gz: 686619e77bc75eb5e02f6ffcd1658e1b998f69b4
+  data.tar.gz: 6ba068152488dbfdd4e6d4730f099486cb459817
 SHA512:
-  metadata.gz: a8645748bc558b0797f44f5cd605b0e14995cea6472f7d9b0d2740615e163e3c25c130ab15105f3a28436b1492ca78c1fb52a56da0af626153d026fe7ae5e8f9
-  data.tar.gz: 90e7108e71bc82b678f6ca2db4741e38318a398cf9f086fb1db80539ccee13ad6944080d5400df9934260bad745f3766daf2f5677833c7470615c53877436798
+  metadata.gz: 6468aaec89019f984564e41eaf989aea69173dd8995fad85f9374096a80bf9795fdb798ef827482bfaee71fd68e5e013f7ab35c89ab759b3414a5b3143ca7f51
+  data.tar.gz: afef472a142141568ec7d2a20c2ea5a1a08e66f4535b534cce1b67f7907ddc4e5d82288bee6ae2dd74076ed809dd22c80f460b0bf4fdfa5e6aa84a7886b22482

data/.rspec

@@ -1,2 +1,6 @@
---format documentation
 --color
+--format progress
+--profile
+--warnings
+--order random
+--require spec_helper

data/Gemfile

@@ -3,3 +3,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in timetrack.gemspec
 gemspec
+
+gem 'parslet', git: 'https://github.com/jreut/parslet', branch: 'master'

data/README.md

@@ -1,5 +1,7 @@
 # Timetrack
 
+[![CircleCI](https://circleci.com/gh/jreut/timetrack/tree/master.svg?style=svg)](https://circleci.com/gh/jreut/timetrack/tree/master)
+
 Track time spent on tasks in a [ledger][ledger]-like format.
 
 ## Installation

data/circle.yml

@@ -0,0 +1,7 @@
+---
+machine:
+  ruby:
+    version: '2.3.3'
+test:
+  override:
+    - bundle exec rake ci

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 8
-total_score: 44
+total_score: 97

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 19.2
+threshold: 18.0

data/config/rubocop.yml

@@ -1,4 +1,6 @@
 ---
+require: rubocop-rspec
+
 Metrics/BlockLength:
   Exclude:
     # Ignore RSpec DSL

data/exe/timetrack

@@ -2,3 +2,5 @@
 # frozen_string_literal: true
 
 require 'timetrack'
+
+Timetrack::CLI.start ARGV

data/lib/timetrack.rb

@@ -1,7 +1,20 @@
 # frozen_string_literal: true
-require 'timetrack/version'
+require 'anima'
+require 'parslet'
+require 'thor'
+
+require 'timetrack/cli'
+require 'timetrack/day'
+require 'timetrack/event'
+require 'timetrack/time_formatter'
 require 'timetrack/parser'
+require 'timetrack/reader'
+require 'timetrack/transform'
+require 'timetrack/version'
+require 'timetrack/writer'
 
-# Entrypoint for gem
+# :nodoc:
+#
+# @api private
 module Timetrack
 end

data/lib/timetrack/cli.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Timetrack
+  # Command-line interface to this gem
+  class CLI < Thor
+  end
+end

data/lib/timetrack/day.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Timetrack
+  # Collection of events for a single day
+  class Day
+    include Anima.new :date, :events
+
+    def to_s
+      "#{date_string}\n#{events.join("\n")}"
+    end
+
+    private
+
+    def date_string
+      format '%04d/%02d/%02d', date.year, date.month, date.day
+    end
+  end
+end

data/lib/timetrack/event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Timetrack
+  # Value object for an event that has its date information
+  class Event
+    include Anima.new :submitted, :task, :begin, :end, :comment
+
+    def to_s
+      "  #{submitted_block}#{task}  #{TimeFormatter.format self.begin}" \
+        "  #{TimeFormatter.format self.end}#{comment_block}"
+    end
+
+    private
+
+    def submitted_block
+      '* ' if submitted
+    end
+
+    def comment_block
+      "  ; #{comment}" unless comment.to_s.empty?
+    end
+  end
+end

data/lib/timetrack/parser.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'parslet'
-
 module Timetrack
   # Read an IO and parse it into an AST
   class Parser < Parslet::Parser
@@ -16,7 +14,7 @@ module Timetrack
     rule(:date) { year >> str('/') >> month >> str('/') >> day }
     rule(:hour) { match['\d'].repeat 2 }
     rule(:minute) { match['\d'].repeat 2 }
-    rule(:time) { hour >> str(':') >> minute }
+    rule(:time) { (hour >> str(':') >> minute).as(:time) }
     rule(:begin_time) { (gutter >> time.as(:begin)) }
     rule(:end_time) { (gutter >> time.as(:end)).maybe }
     rule(:times) { begin_time >> end_time }
@@ -29,9 +27,9 @@ module Timetrack
       gutter >> submission_block >> task >> times >> comment_block >> to_eol
     end
     rule(:events) { (event.as(:event) >> newline).repeat }
-    rule(:event_day) { date >> newline >> events }
+    rule(:event_day) { date.as(:date) >> newline >> events.as(:events) }
     rule(:days) do
-      (event_day.as(:day) >> newline.repeat).repeat
+      (event_day >> newline.repeat).repeat
     end
     rule(:document) { days >> newline.repeat >> eof }
     root :document

data/lib/timetrack/reader.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Timetrack
+  # Assemble a parser, a transform, and an IO-like object together to turn them
+  # into an AST.
+  class Reader
+    include Anima.new :input, :parser, :transform
+
+    def load
+      transform.apply parser.parse input.read
+    end
+  end
+end

data/lib/timetrack/time_formatter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Timetrack
+  # Format a Time as HH:MM
+  class TimeFormatter
+    def self.format(time)
+      Kernel.format '%02d:%02d', time.hour, time.min
+    end
+  end
+end

data/lib/timetrack/transform.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module Timetrack
+  # Transform a deeply-nested hash into a rich object graph
+  class Transform < Parslet::Transform
+    def self.parse_time(string)
+      hour, minute = string.split(':').map(&:to_i)
+      UnassociatedTime.new hour: hour, minute: minute
+    end
+
+    rule(time: simple(:time)) { |bind| parse_time bind[:time] }
+    rule(event: subtree(:event)) do
+      UnassociatedEvent.new(event).with submitted: !event[:submitted].empty?
+    end
+    rule(date: simple(:date)) { Date.parse date }
+    rule(date: simple(:date), events: sequence(:events)) do
+      events.map do |unassociated_event|
+        unassociated_event.to_event date
+      end
+    end
+
+    # Intermediate event representation before it's been associated with a date
+    class UnassociatedEvent
+      include Anima.new :submitted, :task, :begin, :end, :comment
+
+      def to_event(date)
+        Event.new(
+          with(
+            begin: self.begin.to_time(date),
+            end: self.end.to_time(date)
+          ).to_h
+        )
+      end
+    end
+
+    # Intermediate time representation before it's been associated with a date
+    class UnassociatedTime
+      include Anima.new :hour, :minute
+
+      # This method smells of :reek:FeatureEnvy
+      def to_time(date)
+        Time.new date.year, date.month, date.day, hour, minute
+      end
+    end
+  end
+end

data/lib/timetrack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Timetrack
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/timetrack/writer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Timetrack
+  # Stringify Events in a format suitable for writing to a file
+  class Writer
+    attr_reader :events
+
+    def initialize(events:)
+      @events = events
+    end
+
+    def dump
+      days.join("\n\n")
+    end
+
+    private
+
+    def days
+      events
+        .group_by { |event| event.begin.to_date }
+        .map { |date, events| Day.new date: date, events: events }
+    end
+  end
+end

data/timetrack.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # 'allowed_push_host' to allow pushing to a single host or delete this
   # section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -31,12 +31,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'anima', '~> 0.3.0'
   spec.add_dependency 'parslet', '~> 1.7.1'
+  spec.add_dependency 'thor', '~> 0.19.4'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'devtools', '~> 0.1.16'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 11.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-snapshot', '~> 0.1.1'
-  spec.add_development_dependency 'devtools', '~> 0.1.16'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.10.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: timetrack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jordan Ryan Reuter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-21 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: anima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,75 +67,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: devtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 0.1.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 0.1.16
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-snapshot
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: devtools
+  name: rspec-snapshot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
 description: 
 email:
 - me+timetrack@jreut.com
@@ -120,7 +162,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -128,6 +169,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - config/flay.yml
 - config/flog.yml
 - config/mutant.yml
@@ -136,8 +178,15 @@ files:
 - config/yardstick.yml
 - exe/timetrack
 - lib/timetrack.rb
+- lib/timetrack/cli.rb
+- lib/timetrack/day.rb
+- lib/timetrack/event.rb
 - lib/timetrack/parser.rb
+- lib/timetrack/reader.rb
+- lib/timetrack/time_formatter.rb
+- lib/timetrack/transform.rb
 - lib/timetrack/version.rb
+- lib/timetrack/writer.rb
 - timetrack.gemspec
 homepage: https://www.github.com/jreut/timetrack
 licenses:

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.13.7