chronolog 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2121db8e20b57a6cd648cf542b0d83daabf643122a535fc4eaf4d3a3c5f14fc9
-  data.tar.gz: 0e266057d3ef6ac6efe377b30669d15819d6c6dee267753de280c319d8e2a920
+  metadata.gz: b1cfd1f135d109930f56b6242aa87bdf6d04a6e082a68638a134fc8596c43833
+  data.tar.gz: fb105b43a137eec656b65cd7520108b51bfde22fcbff77b7e9a6aecd75548f49
 SHA512:
-  metadata.gz: 5d6688dc5c6f56dc2afb7abb6d83fa248c350688e9e3a512db73ae46c7572cdfa1bdd2ad82d67c7d2efcc29ee66fa41b560352ee3db7add105faab5bc572a2af
-  data.tar.gz: 8607f17597c5e907575e08d134451f77c092f3a8e5f580c1bfeb40c9d6f60bb776c990b3722f2799d0d894b49d2e8fca1c945e7bfc5515df083c05b73b9ea9ea
+  metadata.gz: 87942460f5e3be3ec80321a9a31f51dd5de719cfc8535f5fef33ae980c28f8dcd2fe07a24165d4f84cd63185acdb53d6620457596978472ab41669b80a6ff05e
+  data.tar.gz: 27a2d89476f0a8749bd2f13deed3b4ab254600adaa6ee189df6618571b747af3f3717bb0f6b99bcf8032e4085817745def9403ca9962c8afdf05caa38587e7dc

data/README.md

@@ -3,9 +3,10 @@ Chronolog
 
 [![Gem](https://img.shields.io/gem/v/chronolog.svg)](https://rubygems.org/gems/chronolog)
 
+Chronolog is a CLI for logging time in plain text files.
 
-Install
--------
+Installation
+------------
 
 Get it from RubyGems:
 
@@ -19,6 +20,61 @@ Or build it from GitHub:
     $ gem install chronolog-*.gem
 
 
+Usage
+-----
+
+Run Chronolog in interactive mode:
+
+    $ chronolog work.log
+    > started last monday at 09:30
+    Started session at 2018-09-24 09:30:00 +0200
+    > stopped last monday at 18:00
+    Stopped session at 2018-09-24 18:00:00 +0200
+    > started yesterday at 10:00
+    Started session at 2018-09-29 10:00:00 +0200
+    > stopped yesterday at 19:30
+    Stopped session at 2018-09-29 19:30:00 +0200
+    > print last monday
+    Time logged for 2018-09-24
+    Year:          18.00 hours
+    Month:         18.00 hours
+    Day:            8.50 hours
+    > print yesterday
+    Time logged for 2018-09-27
+    Year:          18.00 hours
+    Month:         18.00 hours
+    Day:            9.50 hours
+    > quit
+
+Or run chronolog one command at a time:
+
+    $ chronolog work.log started 30 minutes ago
+    Started session at 2018-09-28 10:00:00 +0200
+
+    $ chronolog work.log print
+    Time logged for 2018-09-28
+    Year:          18.30 hours
+    Month:         18.30 hours
+    Day:            0.30 hours
+    Session:        0.30 hours
+
+    $ chronolog work.log stop
+    Stopped session at 2018-09-28 10:30:00 +0200
+
+Everything is saved in plain text so you can also edit the file directly:
+
+    $ date +'started at %s # plain text <3' >> work.log
+
+    $ cat work.log
+    started at 1537774200
+    stopped at 1537804800
+    started at 1538035200
+    stopped at 1538069400
+    started at 1538121600
+    stopped at 1538123400
+    started at 1538123410 # plain text <3
+
+
 License
 -------
 

data/bin/chronolog

@@ -2,6 +2,6 @@
 
 require "chronolog"
 
-path = ARGV.pop
+path = ARGV.shift
 cmd = ARGV.join(" ")
 Chronolog::CLI.new(path).run(cmd)

data/lib/chronolog/cli.rb

@@ -3,7 +3,7 @@ require "readline"
 module Chronolog
   class CLI
     CLI_CMDS = %w[quit help].freeze
-    LIB_CMDS = %w[print start stop].freeze
+    LIB_CMDS = %w[print start started stop stopped].freeze
     CMDS = (CLI_CMDS + LIB_CMDS).sort.freeze
 
     def initialize(path)
@@ -29,21 +29,41 @@ module Chronolog
     protected
 
     def exec(cmd)
-      args = cmd.split
       exit if cmd =~ /^q/
-      return @chronolog.send(args.shift, *args) if LIB_CMDS.include?(args[0])
-      usage
+      args = cmd.split
+      name = args.shift
+      return usage unless LIB_CMDS.include?(name)
+      @chronolog.send(name, **parse(args))
     rescue StandardError => e
-      puts "Error: #{e.message}"
+      print_error(e.message)
+    end
+
+    def parse(args)
+      key = :time
+      args.each_with_object({}) do |arg, opts|
+        case arg
+        when "at", "on", "for"
+          key = :time
+        when "in"
+          key = :unit
+        else
+          opts[key] = "#{opts[key]} #{arg}".lstrip if key
+        end
+      end
     end
 
     def usage
       unless @interactive
-        puts "Usage: chronolog [command] <file.log>"
+        puts "Usage: chronolog <file.log> [command]"
         puts
       end
       commands = (@interactive ? CMDS : LIB_CMDS).join("', '")
       puts "Available commands: '#{commands}'"
     end
+
+    def print_error(text)
+      error = Rainbow("Error:").red
+      puts "#{error} #{text}"
+    end
   end
 end

data/lib/chronolog/engine.rb

@@ -1,4 +1,6 @@
 require "csv"
+require "chronic"
+require "rainbow"
 
 module Chronolog
   class Engine
@@ -9,32 +11,45 @@ module Chronolog
       read_csv
     end
 
-    def start
+    def start(time: "now")
       raise "Received 'start' after 'start'" unless @started_at.nil?
-      @started_at = Time.now
+      @started_at = Chronic.parse(time)
       @csv << ["started", "at", @started_at.to_i]
+      print_header(format("Started session at %s", @started_at))
     end
 
-    def stop
+    def stop(time: "now")
       raise "Received 'stop' before 'start'" if @started_at.nil?
-      @stopped_at = Time.now
+      @stopped_at = Chronic.parse(time)
       @csv << ["stopped", "at", @stopped_at.to_i]
       update_variables
       @started_at = nil
+      print_header(format("Stopped session at %s", @stopped_at))
     end
 
-    def print(unit = "hours")
-      started_at = @started_at || Time.now
-      stopped_at = Time.now
+    def print(unit: "hours", time: "now")
+      stopped_at = Chronic.parse(time)
+      started_at = @started_at || stopped_at
       current = stopped_at - started_at
+      print_header(format("Time logged for %s", stopped_at.strftime("%F")))
       %w[year month day session].each do |period|
+        next if period == "session" && time != "now"
         duration = (current + previous(period, started_at)) / unit_length(unit)
-        puts format("This %- 10s % 7.2f %s", "#{period}:", duration, unit)
+        left = Rainbow(format("%- 10s", "#{period.capitalize}:"))
+        right = Rainbow(format("% 9.2f %s", duration, unit)).cyan
+        puts "#{left} #{right}"
       end
     end
 
+    alias started start
+    alias stopped stop
+
     protected
 
+    def print_header(text)
+      puts Rainbow(text).yellow
+    end
+
     def setup_variables
       @years = Hash.new(0)
       @months = Hash.new(0)

data/lib/chronolog/version.rb

@@ -1,3 +1,3 @@
 module Chronolog
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronolog
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vincent Ollivier
@@ -9,7 +9,47 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-09-30 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: 
 email: v@vinc.cc
 executables:
@@ -47,5 +87,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Log elapsed time
+summary: Chronolog is a CLI for logging time in plain text files
 test_files: []