toggl-worktime 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d7d312022057b262ea569daa0ff5a2d4fd81f515c6c0fbe32d4dbbac1d5f8bd
-  data.tar.gz: 2412b9d69c4a482400bde188a1a7523b215c63891f1d7159a7834b257cb673b8
+  metadata.gz: f726845f28a920e1348ee0fd4fc2b136a6394b8f4007ea8498095b6eddc39e5a
+  data.tar.gz: e820f632627f8b8b137008cb48b4a9678ec14682aef3256750ccb8367a4a7d65
 SHA512:
-  metadata.gz: a643c84a3603192a66519cc95cf40523ff98bb626702608f958b9494b2ec8fd6c5551554c18cfac95ac71099a6936553361263e5471cecd7e0c1c2c4616cd79b
-  data.tar.gz: 6f1c575654a741742f3e4efcf438fa0ac89bed10b68b685e2aed44b2e4fe5bbbb292b67ff17dc10fa828acb1c2e133133ac3803cb07812b9f8ccde7d7b444b3c
+  metadata.gz: 4352863b125a2315ded1ec35702f0a04976fd2a3957ad0fd16a487251a98869f653de2fa01931a81e77c8a05950fafc4e56fe2cde32745b3d673d0ae430f91ce
+  data.tar.gz: d890b93dc1664bf686c5a36cbc271b24a5f7b95fc66b02a4a9bfa40cfb35d301e01feb89eb46e4fd8d9462d91c4daf89a904a31e3ab8343ba21b3f6a8d290f8d

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Change Log
+
+## [v0.3.0](https://github.com/limitusus/toggl-worktime/tree/v0.3.0) (2018-08-01)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.2.0...v0.3.0)
+
+**Closed issues:**
+
+- ignore vacation tag [\#3](https://github.com/limitusus/toggl-worktime/issues/3)
+
+**Merged pull requests:**
+
+- Config YAML [\#5](https://github.com/limitusus/toggl-worktime/pull/5) ([limitusus](https://github.com/limitusus))
+- Specify year [\#4](https://github.com/limitusus/toggl-worktime/pull/4) ([limitusus](https://github.com/limitusus))
+
+## [v0.2.0](https://github.com/limitusus/toggl-worktime/tree/v0.2.0) (2018-04-02)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.8...v0.2.0)
+
+**Merged pull requests:**
+
+- Remove const [\#2](https://github.com/limitusus/toggl-worktime/pull/2) ([limitusus](https://github.com/limitusus))
+
+## [v0.1.8](https://github.com/limitusus/toggl-worktime/tree/v0.1.8) (2018-04-01)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.7...v0.1.8)
+
+**Merged pull requests:**
+
+- Export work\_time from driver [\#1](https://github.com/limitusus/toggl-worktime/pull/1) ([limitusus](https://github.com/limitusus))
+
+## [v0.1.7](https://github.com/limitusus/toggl-worktime/tree/v0.1.7) (2017-09-19)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.6...v0.1.7)
+
+## [v0.1.6](https://github.com/limitusus/toggl-worktime/tree/v0.1.6) (2017-09-19)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.5...v0.1.6)
+
+## [v0.1.5](https://github.com/limitusus/toggl-worktime/tree/v0.1.5) (2017-08-15)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.4...v0.1.5)
+
+## [v0.1.4](https://github.com/limitusus/toggl-worktime/tree/v0.1.4) (2017-07-07)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.3...v0.1.4)
+
+## [v0.1.3](https://github.com/limitusus/toggl-worktime/tree/v0.1.3) (2017-07-07)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.2...v0.1.3)
+
+## [v0.1.2](https://github.com/limitusus/toggl-worktime/tree/v0.1.2) (2017-07-05)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.1...v0.1.2)
+
+## [v0.1.1](https://github.com/limitusus/toggl-worktime/tree/v0.1.1) (2017-07-05)
+[Full Changelog](https://github.com/limitusus/toggl-worktime/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/limitusus/toggl-worktime/tree/v0.1.0) (2017-07-05)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -13,6 +13,17 @@ worktime
 2017-06-12 13:29:09 - 2017-06-12 19:23:23
 ```
 
+or you can specify year (default is "this" year)
+
+```console
+$ toggl-worktime 2017 6 12
+Tomoya Kabe
+worktime
+2017-06-12 09:54:34 - 2017-06-12 12:40:45
+2017-06-12 13:29:09 - 2017-06-12 19:23:23
+```
+
+
 Weekend
 
 ```console
@@ -50,6 +61,36 @@ abcdef0123456789
 
 You can get your API token from Toggl at your profile settings page.
 
+NOTE: as of togglv8 v1.2.1, `.toggl` file **MUST NOT** end with a newline (`\010` or LF).
+The recommended way to create the file is `echo -n 'YOUR_TOGGL_API_TOKEN' > ~/.toggl`.
+This issue [will be fixed in the next togglv8 release](https://github.com/kanet77/togglv8/pull/21).
+
+### Configuration
+
+Place configuration file in `~/.toggl_worktime`.
+Or you can specify your favorite path with `-c CONFIG` option.
+
+```
+# -*- yaml -*-
+
+# working time interval within <working_interval_min> minutes is ignored
+working_interval_min: 10
+# Split the day at <day_begin_hour> o'clock
+day_begin_hour: 6
+# Timezone
+timezone: Asia/Tokyo
+
+# Time entries which match the condition below will not be counted as working time
+# Multiple conditions can be specified as an array in top level,
+# multiple keys (only "tags" for now) can be specified as hash keys in a condition,
+# and multiple values can be specifeid as an array.
+# Array conditions will be treated as "OR"
+# Hash conditions will be treated as "AND"
+ignore_conditions:
+  - tags:
+      - vacation
+```
+
 ### Just run
 
 ```console

data/exe/toggl-worktime

@@ -3,22 +3,33 @@
 
 $LOAD_PATH << File.expand_path("#{File.dirname __FILE__}/../lib")
 
+require 'optparse'
 require 'rubygems'
 require 'toggl/worktime'
 
 Version = Toggl::Worktime::VERSION
-MAX_WORKING_INTERVAL = 10
-DAY_BEGIN_HOUR = 6
-DEFAULT_TIMEZONE = 'Asia/Tokyo'
-
-driver = Toggl::Worktime::Driver.new(max_working_interval: MAX_WORKING_INTERVAL)
-
-month = ARGV[0].to_i
-day = ARGV[1].to_i
-hour = DAY_BEGIN_HOUR
-timezone = DEFAULT_TIMEZONE
-
-driver.merge!(month, day, hour, timezone)
+config_file = "#{ENV['HOME']}/.toggl_worktime"
+debug = false
+
+opt = OptionParser.new
+opt.on('-c CONFIG', '--config CONFIG') { |v| config_file = v }
+opt.on('--debug') { |v| debug = v }
+opt.parse!(ARGV)
+
+config = Toggl::Worktime::Config.new(path: config_file)
+driver = Toggl::Worktime::Driver.new(config: config)
+p config if debug
+
+if ARGV.size == 3
+  year, month, day = *ARGV.map(&:to_i)
+elsif ARGV.size == 2
+  year = Time.now.year
+  month, day = *ARGV.map(&:to_i)
+else
+  raise ArgumentError, 'Usage: toggl-worktime [YEAR] MONTH DAY'
+end
+
+driver.merge!(year, month, day)
 user = driver.me
 
 puts user['fullname']

data/lib/toggl/worktime.rb

@@ -3,6 +3,7 @@
 require 'togglv8'
 require 'json'
 require 'toggl/worktime/version'
+require 'toggl/worktime/config'
 require 'toggl/worktime/merger'
 require 'toggl/worktime/time'
 require 'toggl/worktime/driver'

data/lib/toggl/worktime/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Toggl
+  module Worktime
+    # Config for Toggl::Worktime
+    class Config
+      attr_accessor :foo
+
+      ATTRS = %i[
+        working_interval_min
+        day_begin_hour
+        timezone
+        ignore_conditions
+      ].freeze
+
+      ATTR_DEFAULTS = {
+        working_interval_min: 10,
+        day_begin_hour: 6,
+        timezone: 'Asia/Tokyo',
+        ignore_conditions: []
+      }.freeze
+
+      ATTRS.each do |attr|
+        attr_accessor attr
+      end
+
+      def initialize(args)
+        c = self.class.load_config(args[:path])
+        attr_set(c)
+      end
+
+      class << self
+        def load_config(path)
+          YAML.safe_load(File.open(path).read).transform_keys(&:to_sym)
+        end
+      end
+
+      private
+
+      def attr_set(hash)
+        ATTRS.each do |k|
+          send((k.to_s + '=').to_sym, hash.key?(k) ? hash[k] : ATTR_DEFAULTS[k])
+        end
+      end
+    end
+  end
+end

data/lib/toggl/worktime/driver.rb

@@ -4,31 +4,52 @@ module Toggl
   module Worktime
     # Toggle API driver
     class Driver
+      ONE_DAY_SECONDS = 86_400
+
       attr_reader :toggl
       attr_reader :work_time
 
-      def initialize(max_working_interval: 10)
+      def initialize(config:)
         @toggl = TogglV8::API.new
-        @max_working_interval = max_working_interval
+        @config = config
         @merger = nil
         @work_time = nil
+        @zone_offset = Toggl::Worktime::Time.zone_offset(@config.timezone)
+      end
+
+      def time_entries(year, month, day)
+        beginning_day = ::Time.new(
+          year, month, day, @config.day_begin_hour, 0, 0, @zone_offset
+        )
+        ending_day = beginning_day + ONE_DAY_SECONDS
+        start_iso = beginning_day.strftime('%FT%T%:z')
+        end_iso = ending_day.strftime('%FT%T%:z')
+        toggl.get_time_entries(start_date: start_iso, end_date: end_iso)
       end
 
-      def time_entries(month, day, hour, timezone)
-        now = DateTime.now
-        offset = Toggl::Worktime::Time.zone_offset(timezone)
-        beginning_day = DateTime.new(now.year, month, day, hour, 0, 0, offset)
-        ending_day = beginning_day + 1
-        toggl.get_time_entries(start_date: beginning_day.iso8601, end_date: ending_day.iso8601)
+      # time_entries filter with @config.ignore_conditions
+      def filter_entries(entries)
+        pass_l = lambda { |entry|
+          @config.ignore_conditions.none? do |cond|
+            cond.keys.all? do |key|
+              case key
+              when 'tags'
+                entry['tags']&.any? { |t| cond[key].include?(t) }
+              end
+            end
+          end
+        }
+        entries.select { |e| pass_l.call(e) }
       end
 
       def me
         @toggl.me(true)
       end
 
-      def merge!(month, day, hour, timezone)
-        time_entries = time_entries(month, day, hour, timezone)
-        @merger = Toggl::Worktime::Merger.new(time_entries, timezone, @max_working_interval)
+      def merge!(year, month, day)
+        time_entries = time_entries(year, month, day)
+        time_entries = filter_entries(time_entries)
+        @merger = Toggl::Worktime::Merger.new(time_entries, @config)
         @work_time = @merger.merge
       end
 
@@ -40,17 +61,16 @@ module Toggl
         end
       end
 
-      def time_expr(t)
-        t ? t.strftime('%F %T') : 'nil'
+      def time_expr(time)
+        time ? time.getlocal(@zone_offset).strftime('%F %T') : 'nil'
       end
 
       def total_time
-        time = @merger.total_time
-        total_seconds = (time * 86400).to_i
+        total_seconds = @merger.total_time.to_i
         hours = total_seconds / (60 * 60)
         minutes = (total_seconds - (hours * 60 * 60)) / 60
         seconds = total_seconds % 60
-        format("%02d:%02d:%02d", hours, minutes, seconds)
+        format('%02d:%02d:%02d', hours, minutes, seconds)
       end
     end
   end

data/lib/toggl/worktime/merger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module Toggl
   module Worktime
     # Time-entries merger
@@ -8,10 +10,9 @@ module Toggl
 
       ONE_DAY_MINUTES = 24 * 60
 
-      def initialize(time_entries, timezone, max_working_interval)
+      def initialize(time_entries, config)
         @time_entries = time_entries
-        @timezone = timezone
-        @max_working_interval = max_working_interval
+        @config = config
         @current_start = nil
         @current_stop = nil
         @continuing = true
@@ -35,7 +36,7 @@ module Toggl
       end
 
       def time_entries_each
-        zone_offset = Toggl::Worktime::Time.zone_offset(@timezone)
+        zone_offset = Toggl::Worktime::Time.zone_offset(@config.timezone)
         @time_entries.each do |te|
           start = parse_date(te['start'], zone_offset)
           stop = parse_date(te['stop'], zone_offset)
@@ -43,7 +44,7 @@ module Toggl
           @current_start = start if @current_start.nil?
           @current_stop = stop if @current_stop.nil?
           if start.nil? || stop.nil?
-            warn "start or stop time is nil: total time may be incomplete"
+            warn 'start or stop time is nil: total time may be incomplete'
           else
             @total_time += stop - start
           end
@@ -53,13 +54,13 @@ module Toggl
 
       def parse_date(date, zone_offset)
         return nil if date.nil?
-        DateTime.parse(date).new_offset(zone_offset)
+        ::Time.parse(date).getlocal(zone_offset)
       end
 
       def continuing(start)
         return true if @current_stop.nil?
         interval = (start - @current_stop) * ONE_DAY_MINUTES
-        @continuing = interval < @max_working_interval
+        @continuing = interval < @config.working_interval_min
       end
     end
   end

data/lib/toggl/worktime/time.rb

@@ -4,11 +4,11 @@ module Toggl
   module Worktime
     # Timezone
     module Time
-      # rational
+      # Seconds
       def self.zone_offset(timezone)
         tz = ENV['TZ']
         ENV['TZ'] = timezone
-        offset = DateTime.now.offset
+        offset = ::Time.now.utc_offset
         ENV['TZ'] = tz
         offset
       end

data/lib/toggl/worktime/version.rb

@@ -2,6 +2,6 @@
 
 module Toggl
   module Worktime
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/toggl-worktime.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'toggl/worktime/version'
 
@@ -23,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'togglv8'
   spec.add_dependency 'awesome_print'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rb-readline'
-  spec.add_development_dependency 'rubocop'
+  spec.add_dependency 'togglv8'
   spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rb-readline'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: toggl-worktime
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomoya KABE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: togglv8
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: togglv8
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rb-readline
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,61 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Summarise Toggl Time Entries
 email:
 - limit.usus@gmail.com
@@ -134,6 +134,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -143,6 +144,7 @@ files:
 - bin/setup
 - exe/toggl-worktime
 - lib/toggl/worktime.rb
+- lib/toggl/worktime/config.rb
 - lib/toggl/worktime/driver.rb
 - lib/toggl/worktime/merger.rb
 - lib/toggl/worktime/time.rb