kobot 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00f2c1151ffcb202b20d4b3f9881c9570b1075ea3684f7ab3ea2cfc65baf4b33
-  data.tar.gz: a6f3da0260abbbfce192557ea580526698b828ed19ec7175dd64080fa437ba35
+  metadata.gz: c867dcb791e15db7a407fc9dc0898ad49e9dccba53514f98ad32b253f1fc8adc
+  data.tar.gz: 6887ebe669b7628a7972a89d2b508b498f5ce856fe80d98e85a52c3bcedfd377
 SHA512:
-  metadata.gz: 4fb7e982db990bdbf659009501f3eb028d02fdddf7e8d6ea48762495867196f5dfc748c6d14926d5239b57c4433dad3d2568c8d6ca9bf42d6de401b91391e7a3
-  data.tar.gz: '06482f411bfbf8f0083d0750e7d8ea4074f6740de3e9b1d6ba27c3e850356cd28c39d83d3a27f5d99bf7e21589cce65d64396793ffd018180ec621f926db7327'
+  metadata.gz: 8ed4028a1a25f75cfa21370c41b72a7fbe66916c442279f7985b3dc6f1be6e540395b81292931549b53496b7db026ec0ca33f9c743623176207d31bf1b740aa4
+  data.tar.gz: b53a002259ad6312ae6437d11320b9b12f8d62e3ac26a01ed4e3dc48399cfb9d2f572384aebc2c3930014bf77e83c6351c7e7cf051b5eab02a87db33e31f7f51

data/CHANGELOG.md

@@ -5,3 +5,7 @@
 - Deprecated lower-case environment variables for credentials configuration
 - Updated option help doc to indicate weekends and public holidays are skipped by default
 - Updated required_ruby_version to be >= 2.4.0 to align with the webdrivers dependency
+
+### v1.2.0
+- Added an option to allow forcibly running regardless of weekends or public holidays
+- Added an ENV flag to allow requiring lib in local workspace for development purpose

data/README.md

@@ -57,15 +57,17 @@ Get help doc:
 ```
 $ kobot -h
 Usage: kobot [options]
-    -c, --clock CLOCK                The clock action: in, out
-    -l, --loglevel [LEVEL]           Specify log level: debug, info, warn, error. Default is info
+    -c, --clock CLOCK                Required; the clock action option: in, out
+    -l, --loglevel [LEVEL]           Specify log level: debug, info, warn, error; default is info
     -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 are skipped by default.
-    -t, --to [TO]                    Email address to send notification to. By default it is sent to
+                                     multiple values separated by comma, such as: 2020-05-01,2020-12-31;
+                                     weekends and public holidays in Japan will be skipped by default
+    -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
     -d, --dryrun                     Run the process without actual clock in/out
+    -f, --force                      Run the process forcibly regardless of weekends or public holidays;
+                                     must be used together with --dryrun to prevent mistaken operations
     -x, --headless                   Start browser in headless mode
     -g, --geolocation                Allow browser to use geolocation
     -h, --help                       Show this help message

data/exe/kobot

@@ -1,6 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'kobot'
+begin
+  # For quickly tryout in local development
+  # without installing to system gems path
+  raise LoadError if ENV['KOBOT_DEV']
+
+  require 'kobot'
+rescue LoadError
+  $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+  require 'kobot'
+end
 
 Kobot.run

data/lib/kobot.rb

@@ -33,6 +33,7 @@ module Kobot
         config.clock                 = options[:clock].to_sym
         config.loglevel              = options[:loglevel]&.to_sym || :info
         config.dryrun                = options[:dryrun]
+        config.force                 = options[:force]
         config.skip                  = options[:skip] || []
 
         config.kot_url               = 'https://s2.kingtime.jp/independent/recorder/personal/'

data/lib/kobot/config.rb

@@ -9,7 +9,8 @@ module Kobot
       attr_accessor :clock,
                     :loglevel,
                     :skip,
-                    :dryrun
+                    :dryrun,
+                    :force
 
       attr_accessor :kot_url,
                     :kot_timezone_offset,

data/lib/kobot/engine.rb

@@ -26,11 +26,15 @@ module Kobot
     # to be popped up and should be handled by the outside caller.
     def start
       if weekend?
-        Kobot.logger.info("Today=#{@today} is weekend.")
-        return
+        if Config.force
+          Kobot.logger.info("[Force] should have exited: today=#{@today} is weekend")
+        else
+          Kobot.logger.info("Today=#{@today} is weekend")
+          return
+        end
       end
       if holiday?
-        Kobot.logger.info("Today=#{@today} is holiday.")
+        Kobot.logger.info("Today=#{@today} is holiday")
         return
       end
       unless %i[in out].include? Config.clock
@@ -147,9 +151,29 @@ module Kobot
     end
 
     def verify_today_record!
-      raise KotRecordError, "Today=#{@today} is not found on kot." if @kot_today.strip.empty?
-      raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" if kot_weekend?
-      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" if kot_public_holiday?
+      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_today.strip.empty?
+
+      if kot_weekend?
+        unless Config.force
+          raise KotRecordError,
+                "Today=#{@today} is marked as weekend on kot: #{@kot_today}"
+        end
+
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is marked as weekend on kot: #{@kot_today}"
+        )
+      end
+
+      if kot_public_holiday?
+        unless Config.force
+          raise KotRecordError,
+                "Today=#{@today} is marked as public holiday on kot: #{@kot_today}"
+        end
+
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is marked as public holiday on kot: #{@kot_today}"
+        )
+      end
     end
 
     def clock_in!

data/lib/kobot/option.rb

@@ -14,23 +14,23 @@ module Kobot
         opt_parser = OptionParser.new do |opt|
           opt.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-          opt.on('-c', '--clock CLOCK', 'The clock action: in, out') do |clock|
+          opt.on('-c', '--clock CLOCK', 'Required; the clock action option: in, out') do |clock|
             options[:clock] = clock
           end
 
-          opt.on('-l', '--loglevel [LEVEL]', 'Specify log level: debug, info, warn, error. Default is info') do |level|
+          opt.on('-l', '--loglevel [LEVEL]', 'Specify log level: debug, info, warn, error; default is info') do |level|
             options[:loglevel] = level
           end
 
           opt.on('-s', '--skip [D1,D2,D3]', Array,
                  '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 are skipped by default.') do |skip|
+                 'multiple values separated by comma, such as: 2020-05-01,2020-12-31;',
+                 'weekends and public holidays in Japan will be skipped by default') do |skip|
             options[:skip] = skip
           end
 
           opt.on('-t', '--to [TO]',
-                 'Email address to send notification to. By default it is sent 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|
             options[:to] = to
           end
@@ -43,6 +43,12 @@ module Kobot
             options[:dryrun] = dryrun
           end
 
+          opt.on('-f', '--force',
+                 'Run the process forcibly regardless of weekends or public holidays;',
+                 'must be used together with --dryrun to prevent mistaken operations') do |force|
+            options[:force] = force
+          end
+
           opt.on('-x', '--headless', 'Start browser in headless mode') do |headless|
             options[:headless] = headless
           end
@@ -63,7 +69,12 @@ module Kobot
         end
         opt_parser.parse! ARGV
         raise OptionParser::MissingArgument, 'The clock option is required' if options[:clock].nil?
-        raise OptionParser::InvalidArgument, 'The clock option must be either: in, out' unless %w[in out].include? options[:clock]
+        unless %w[in out].include? options[:clock]
+          raise OptionParser::InvalidArgument, 'The clock option must be either: in, out'
+        end
+        if options[:force] && !options[:dryrun]
+          raise OptionParser::InvalidArgument, 'Must specify --dryrun for forcibly running'
+        end
 
         options
       rescue OptionParser::MissingArgument, OptionParser::InvalidArgument => e

data/lib/kobot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andy Jiang