kobot 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f35251b3ce8549b6b268a9741ecc88398f4fca4e1fbe27c343e2a1c35d456ca0
-  data.tar.gz: 1af276cc34607f075650b5be4df65c9666449c761b410fb5cc63629fe0392ff7
+  metadata.gz: '08261437cd35a8b09dfad79740f2f6ec52e87fea47713aba5e00133aa570ac08'
+  data.tar.gz: a7941208f88d46d40fb8d5366851f5b466bb85e975b3d5ff95e7753bf9f8032c
 SHA512:
-  metadata.gz: a1a76b64eb1aa1019a12b4f1d4a2d34c84d79cf020b0ebc7cee7c1bd4902b180aec70790ee236883100bfd2501bbee9846f61b5b40dd8fb3996159e58b94b0df
-  data.tar.gz: a81c35396d3dde1a74ab9aad3c3535e92699268f49a133f9f43514b192bae808a84f1974c9f9c537690ce3561c942251c044591fc363b54c619b44586ede7670
+  metadata.gz: f14ebacda3eaec90ae6f6e9f995821d3116599e2fdff2e19afcd546c43404f6453055d256828f4f549e07d5f3e08ac0ba4cbc1c6ee0e4b3739a02277b0285258
+  data.tar.gz: d42d8f45187cc512eb08b13d5c891cd7b0bf567a76bf55b49ffc089c240946f0345208b7586fecbd2a32c8e3f3855f22086913bed5c79152e3248e5db0692d75

data/CHANGELOG.md

@@ -28,3 +28,8 @@
 
 ### v1.2.5
 - Added I18n support for both English and Japanese KOT UI
+
+### v1.3.0
+- Added config option (-a, --auto-skip-without) to enable automatic skipping based on schedule
+- Replaced deprecated options with capabilities option in Selenium driver initialization
+- Refactored scattered attr_accessors and reduced instance variables count reported by Rubocop

data/README.md

@@ -62,6 +62,9 @@ Usage: kobot [options]
     -s, --skip [D1,D2,D3]            Specify dates to skip clock in/out with date format YYYY-MM-DD and
                                      multiple values separated by comma, such as: 2020-05-01,2020-12-31;
                                      weekends and public holidays in Japan will be skipped by default
+    -a [SCHEDULE],                   Enable automatic skipping by reading schedule from the Time Card page;
+        --auto-skip-without          skip today if the provided text is not contained in the schedule column
+                                     on the Time Card page; by default 裁量労働 is used
     -t, --to [TO]                    Email address to send notification to; by default it is sent to
                                      the same self email account used in SMTP config as the sender
     -n, --notify                     Enable email notification

data/lib/kobot/config.rb

@@ -8,24 +8,21 @@ module Kobot
       attr_accessor :clock,
                     :loglevel,
                     :skip,
+                    :auto_skip_without,
                     :dryrun,
-                    :force
-
-      attr_accessor :kot_url,
+                    :force,
+                    :kot_url,
                     :kot_timezone_offset,
-                    :kot_date_format
-
-      attr_accessor :gmail_notify_enabled,
+                    :kot_date_format,
+                    :gmail_notify_enabled,
                     :gmail_notify_subject,
                     :gmail_notify_to,
                     :gmail_smtp_address,
-                    :gmail_smtp_port
-
-      attr_accessor :browser_headless,
+                    :gmail_smtp_port,
+                    :browser_headless,
                     :browser_geolocation,
-                    :browser_wait_timeout
-
-      attr_accessor :credentials_file
+                    :browser_wait_timeout,
+                    :credentials_file
 
       def configure
         yield self

data/lib/kobot/engine.rb

@@ -81,7 +81,10 @@ module Kobot
       }
       options = Selenium::WebDriver::Chrome::Options.new(prefs: prefs)
       options.headless! if Config.browser_headless
-      @browser = Selenium::WebDriver.for(:chrome, options: options)
+      caps = [
+        options
+      ]
+      @browser = Selenium::WebDriver.for(:chrome, capabilities: caps)
       @wait = Selenium::WebDriver::Wait.new(timeout: Config.browser_wait_timeout)
       Kobot.logger.info('Launch browser successful')
     end
@@ -151,22 +154,24 @@ module Kobot
         next unless date_cell.text.include? @today
 
         Kobot.logger.info('Reading today record')
-        @kot_today = date_cell.text
-        @kot_today_css_class = date_cell.attribute('class')
-        @kot_today_type = tr.find_element(css: 'td.work_day_type').text
-        @kot_today_clock_in = tr.find_element(
+        @kot_data = {}
+        @kot_data[:today] = date_cell.text
+        @kot_data[:today_css_class] = date_cell.attribute('class')
+        @kot_data[:today_type] = tr.find_element(css: 'td.work_day_type').text
+        @kot_data[:today_schedule] = tr.find_element(css: 'td.schedule').text
+        @kot_data[:today_clock_in] = tr.find_element(
           css: 'td.start_end_timerecord[data-ht-sort-index="START_TIMERECORD"]'
         ).text
-        @kot_today_clock_out = tr.find_element(
+        @kot_data[:today_clock_out] = tr.find_element(
           css: 'td.start_end_timerecord[data-ht-sort-index="END_TIMERECORD"]'
         ).text
         Kobot.logger.debug do
           {
-            kot_toay: @kot_today,
-            kot_today_css_class: @kot_today_css_class,
-            kot_today_type: @kot_today_type,
-            kot_today_clock_in: @kot_today_clock_in,
-            kot_today_clock_out: @kot_today_clock_out
+            kot_toay: @kot_data[:today],
+            kot_today_css_class: @kot_data[:today_css_class],
+            kot_today_type: @kot_data[:today_type],
+            kot_today_clock_in: @kot_data[:today_clock_in],
+            kot_today_clock_out: @kot_data[:today_clock_out]
           }
         end
         break
@@ -174,60 +179,69 @@ module Kobot
     end
 
     def validate_today_record!
-      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_today.strip.empty?
+      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_data[:today].strip.empty?
 
       if kot_weekend?
-        raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" unless Config.force
+        raise KotRecordError, "Today=#{@today} is marked as weekend: #{@kot_data[:today]}" unless Config.force
+
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is marked as weekend: #{@kot_data[:today]}"
+        )
+      end
+
+      if kot_public_holiday?
+        raise KotRecordError, "Today=#{@today} is marked as public holiday: #{@kot_data[:today]}" unless Config.force
 
         Kobot.logger.info(
-          "[Force] should have exited: today=#{@today} is marked as weekend on kot: #{@kot_today}"
+          "[Force] should have exited: today=#{@today} is marked as public holiday: #{@kot_data[:today]}"
         )
       end
 
-      return unless kot_public_holiday?
-      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" unless Config.force
+      if kot_non_work_schedule?
+        raise KotRecordError, "Today=#{@today} is non-work schedule: #{@kot_data[:today_schedule]}" unless Config.force
 
-      Kobot.logger.info(
-        "[Force] should have exited: today=#{@today} is marked as public holiday on kot: #{@kot_today}"
-      )
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is non-work schedule: #{@kot_data[:today_schedule]}"
+        )
+      end
     end
 
     def clock_in!
       Kobot.logger.warn("Clock in during the afternoon: #{@now}") if @now.hour > 12
-      if @kot_today_clock_in.strip.empty?
+      if @kot_data[:today_clock_in].strip.empty?
         click_clock_in_button
         return if Config.dryrun
 
         read_today_record
-        raise KotClockInError, 'Clock in operation seems to have failed' if @kot_today_clock_in.strip.empty?
+        raise KotClockInError, 'Clock in operation seems to have failed' if @kot_data[:today_clock_in].strip.empty?
 
-        Kobot.logger.info("Clock in successful: #{@kot_today_clock_in}")
+        Kobot.logger.info("Clock in successful: #{@kot_data[:today_clock_in]}")
         Mailer.send(clock_notify_message(clock: :in))
       else
-        Kobot.logger.warn("Clock in done already: #{@kot_today_clock_in}")
+        Kobot.logger.warn("Clock in done already: #{@kot_data[:today_clock_in]}")
       end
     end
 
     def clock_out!
       Kobot.logger.warn("Clock out during the morning: #{@now}") if @now.hour <= 12
       unless Config.dryrun
-        if @kot_today_clock_in.strip.empty?
+        if @kot_data[:today_clock_in].strip.empty?
           raise KotClockOutError,
-                "!!!No clock in record for today=#{@kot_today}!!!"
+                "!!!No clock in record for today=#{@kot_data[:today]}!!!"
         end
       end
 
-      if @kot_today_clock_out.strip.empty?
+      if @kot_data[:today_clock_out].strip.empty?
         click_clock_out_button
         return if Config.dryrun
 
         read_today_record
-        raise KotClockOutError, 'Clock out operation seems to have failed' if @kot_today_clock_out.strip.empty?
+        raise KotClockOutError, 'Clock out operation seems to have failed' if @kot_data[:today_clock_out].strip.empty?
 
-        Kobot.logger.info("Clock out successful: #{@kot_today_clock_out}")
+        Kobot.logger.info("Clock out successful: #{@kot_data[:today_clock_out]}")
         Mailer.send(clock_notify_message(clock: :out))
       else
-        Kobot.logger.warn("Clock out done already: #{@kot_today_clock_out}")
+        Kobot.logger.warn("Clock out done already: #{@kot_data[:today_clock_out]}")
       end
     end
 
@@ -270,18 +284,22 @@ module Kobot
       [
         @selector.kot_date_saturday,
         @selector.kot_date_sunday
-      ].any? { |weekend| @kot_today&.include? weekend }
+      ].any? { |weekend| @kot_data[:today]&.include? weekend }
+    end
+
+    def kot_non_work_schedule?
+      !@kot_data[:today_schedule]&.include?(Config.auto_skip_without)
     end
 
     def kot_public_holiday?
-      return true if @kot_today_type&.include? @selector.kot_workday_time_off_text
+      return true if @kot_data[:today_type]&.include? @selector.kot_workday_time_off_text
 
       kot_today_highlighted = %w[sunday saturday].any? do |css|
-        @kot_today_css_class&.include? css
+        @kot_data[:today_css_class]&.include? css
       end
       if kot_today_highlighted
         Kobot.logger.warn(
-          "Today=#{@kot_today} is highlighted (holiday) but not marked as #{@selector.kot_workday_time_off_text}"
+          "Today=#{@kot_data[:today]} is highlighted (holiday) but not marked as #{@selector.kot_workday_time_off_text}"
         )
       end
       kot_today_highlighted
@@ -293,8 +311,8 @@ module Kobot
         "<b>Date:</b> #{@today}",
         "<b>Status:</b> <span style='color:#{color}'>#{status}</span>"
       ]
-      message << "<b>Clock_in:</b> #{@kot_today_clock_in}" if clock
-      message << "<b>Clock_out:</b> #{@kot_today_clock_out}" if clock == :out
+      message << "<b>Clock_in:</b> #{@kot_data[:today_clock_in]}" if clock
+      message << "<b>Clock_out:</b> #{@kot_data[:today_clock_out]}" if clock == :out
       message.join('<br>')
     end
   end

data/lib/kobot/option.rb

@@ -27,6 +27,13 @@ module Kobot
             options[:skip] = skip
           end
 
+          opt.on('-a', '--auto-skip-without [SCHEDULE]',
+                 'Enable automatic skipping by reading schedule from the Time Card page;',
+                 'skip today if the provided text is not contained in the schedule column',
+                 'on the Time Card page; by default 裁量労働 is used') do |schedule|
+            options[:auto_skip_without] = schedule
+          end
+
           opt.on('-t', '--to [TO]',
                  'Email address to send notification to; by default it is sent to',
                  'the same self email account used in SMTP config as the sender') do |to|

data/lib/kobot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kobot
-  VERSION = '1.2.5'
+  VERSION = '1.3.0'
 end

data/lib/kobot.rb

@@ -34,6 +34,7 @@ module Kobot
         config.dryrun                = options[:dryrun]
         config.force                 = options[:force]
         config.skip                  = options[:skip] || []
+        config.auto_skip_without     = options[:auto_skip_without] || '裁量労働'
 
         config.kot_url               = 'https://s2.kingtime.jp/independent/recorder/personal/'
         config.kot_timezone_offset   = '+09:00'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webdrivers