working_times 0.3.2 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42c1a4ebd7f1f1f281f19acb32a48e1380b98bd3aa3cc2bb1bcd5d56debd527
-  data.tar.gz: a11317affbb17526880eabedd2d03f696e65e6d9c93d7574c5c623ec40843c6a
+  metadata.gz: 7141b461d0bf7215ca3656d259de497ec7062a3639a0945a1fa8dea9deea27ce
+  data.tar.gz: ce7ffcd9a86aa7395d15ccab63a44408ddbf5e00aa1ce489bdb0266c2d2170d9
 SHA512:
-  metadata.gz: 9fa455a36013da66a73c91bfbabd64a1c3f3fa5b7aef9a7dc52dd782e133ebad74d17a19ed28e86dc6e6f3e4d701f2c87652029ac4ba9c41812d88a683a50813
-  data.tar.gz: cc4944b5c7c4a957bf5be1567f393902bc848032e08c3dc281f78c0c28333ec87c2d278fa6874e57258ceba687e87a31413fc71279aea2e726a44d1809b38e5e
+  metadata.gz: 94cfce8f51ded451931e65fbab2983b0a51a769522c7e762625e739e44484e5f0224ffba32bc9c357f26fc0c28b1d5e5dc641cb452695766198e3f83d239689e
+  data.tar.gz: 50d4bab6fa14e2c69eeec085e373694384cd94a72f0647b8212581820b0e019447ffd2603de052de3b13b865a57299731ebb08558dbe46ac1d374fe251a0ae69

data/lib/working_times.rb

@@ -2,4 +2,5 @@ require 'working_times/constants'
 require 'working_times/config'
 require 'working_times/state'
 require 'working_times/record'
+require 'working_times/invoice'
 require 'working_times/cli'

data/lib/working_times/cli.rb

@@ -1,59 +1,100 @@
-# frozen_string_literal: true
-
 require 'thor'
+require 'fileutils'
 
 module WorkingTimes
   class CLI < Thor
     include State
 
-    option :work_on, aliases: ['-w'], desc: 'Specify what group of work on'
-    desc 'start [COMMENT] <option>', 'Start working with comment.'
-    def start(comment = nil)
-      initialize_data_dir
+    desc 'init WORKON [TERM] [COMPANY]', 'initialize data directory for your working'
+    def init(workon, term = 'default', company = '')
+      if Dir.exist?(workon)
+        puts "WORKON '#{workon}' is already created. Or name conflicted.'"
+        return
+      end
+
+      FileUtils.mkdir_p(File.join(workon, 'terms'))
+      FileUtils.mkdir_p(File.join(workon, 'invoices'))
+      initialize_wtconf(workon, term, company)
+    end
+
+    desc 'start [COMMENT] ', 'Start working with comment.'
+    def start(comment = '')
       if working?
         puts "You are already on working at #{current_work}."
         puts "To finish this, execute 'wt finish'."
         return
       end
 
-      Record.new(timestamp: Time.now, comment: comment, work_on: options[:work_on]).start
-      start_work(options[:work_on])
+      initialize_term_log
+
+      Record.new(timestamp: DateTime.now, comment: comment).start
+      start_work
     end
 
-    desc 'st [COMMENT] <option>', 'Short hand for *start*'
+    desc 'st [COMMENT]', 'Short hand for *start*'
     alias st start
 
     desc 'finish [COMMENT]', 'Finish working on current group.'
-    def finish(comment = nil)
+    def finish(comment = '')
       unless working?
         puts 'You are not starting work. Execute "wt start" to start working.'
         return
       end
 
-      Record.new(timestamp: Time.now, comment: comment).finish
+      Record.new(timestamp: DateTime.now, comment: comment).finish
       finish_work
     end
 
     desc 'fi [COMMENT]', 'Short hand for *finish*'
     alias fi finish
 
-    desc 'rest DURATION', 'Record resting time. e.g. \'wt rest 1h30m\''
-    def rest(duration = nil)
-      if duration.nil?
-        puts <<~MSG
-          Please specify duration of resting.
-          e.g. wt rest 1h30m
-          e.g. wt rest '1 hour 30 minutes'
-        MSG
-        return
-      end
-
+    desc 'rest DURATION', 'Record resting time. e.g. \'wt rest 1h30m\'\'wt rest 1 hour 30 minutes\''
+    def rest(duration)
       unless working?
         puts 'You are not starting work. Execute "wt start" to start working.'
         return
       end
 
-      Record.new(timestamp: Time.now, duration: duration).rest
+      Record.new(timestamp: DateTime.now, duration: duration).rest
+    end
+
+    option :build, type: :boolean, aliases: ['-b']
+    desc 'invoice', 'Create invoice for current term by TeX template. It will build pdf if option is set'
+    def invoice
+      Invoice.new.tap do |invoice|
+        invoice.generate
+        invoice.build if options[:build]
+      end
+      puts "Invoice created to #{path_invoice_current_term}."
+    end
+
+    desc 'version', 'Show version of working_times'
+    def version
+      puts 'version: ' + VERSION
+    end
+
+    private
+
+    def initialize_wtconf(workon, term, company)
+      # on initializing, we shouldn't use path helper e.g. Config#data_dir
+      data_dir = File.expand_path(workon)
+      File.write(File.join(data_dir, 'wtconf.json'), <<~WTCONF)
+        {
+          "term": "#{term}",
+          "invoice": {
+            "company": "#{company}",
+            "template": "",
+            "salaryPerHour": 0,
+            "taxRate": 0.0
+          }
+        }
+      WTCONF
+    end
+
+    def initialize_term_log
+      return if File.exist?(path_current_term)
+
+      File.write(path_current_term, SCHEMA.join(',') + "\n")
     end
   end
 end

data/lib/working_times/config.rb

@@ -1,45 +1,55 @@
-# frozen_string_literal: true
+require 'json'
 
 module WorkingTimes
   module Config
     private
 
-    # return where data directory is
     def data_dir
-      File.expand_path(wtconf['DATADIR'])
+      File.expand_path('.')
     end
 
-    # return default working project/task/etc...
-    def default_work
-      wtconf['DEFAULTWORK']
+    def path_wtconf
+      File.join(data_dir, 'wtconf.json')
+    end
+
+    def term_dir
+      File.join(data_dir, 'terms')
+    end
+
+    def path_working_flag
+      File.join(data_dir, '.working')
+    end
+
+    def current_term
+      wtconf['term']
+    end
+
+    def path_current_term
+      File.join(term_dir, current_term)
+    end
+
+    def current_company
+      wtconf['company']
+    end
+
+    def invoice_dir
+      File.join(data_dir, 'invoices')
+    end
+
+    def invoice_info
+      wtconf['invoice']
+    end
+
+    def dir_invoice_current_term
+      File.join(invoice_dir, current_term)
+    end
+
+    def path_invoice_current_term
+      File.join(dir_invoice_current_term, "#{current_term}.tex")
     end
 
-    # parse ~/.wtconf
     def wtconf
-      conf = default_conf
-      begin
-        File
-          .readlines(File.expand_path('~/.wtconf'))
-          .map(&:chomp)
-          .each do |row|
-            k, v = row.split('=')
-            conf[k] = v
-          end
-      rescue Errno::ENOENT
-        puts '~/.wtconf not found, generated.'
-        generate_wtconf
-      end
-      conf
-    end
-
-    # default configurations of .wtconf
-    def default_conf
-      { 'DATADIR' => File.expand_path('~/.wt'), 'DEFAULTWORK' => 'default' }
-    end
-
-    # generate configuration file to ~/.wtconf when does not exist
-    def generate_wtconf
-      File.open(File.expand_path('~/.wtconf'), 'w') { |f| f.puts(default_conf.map { |k, v| "#{k}=#{v}" }) }
+      JSON.parse(File.read(path_wtconf))
     end
   end
 end

data/lib/working_times/constants.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module WorkingTimes
-  VERSION = '0.3.2'
+  VERSION = '0.7.2'.freeze
 
   START_MSG = [
     'Have a nice work!',
@@ -12,4 +10,11 @@ module WorkingTimes
     'Great job!',
     'Time to beer!'
   ].freeze
+
+  SCHEMA = [
+    'started_at',  # DateTime#rfc3339
+    'finished_at', # DateTime#rfc3339
+    'rest_sec',    # Integer (inidicates second)
+    'comment'      # String
+  ].freeze
 end

data/lib/working_times/invoice.rb

@@ -0,0 +1,135 @@
+module WorkingTimes
+  # Class about creating invoice
+  # This class is designed to build data_dir/invoices/current_term/invoice.tex
+  # from data_dir/invoices/template.tex
+  class Invoice
+    include Config
+    attr_reader :path_template, :salary_per_hour, :tax_rate, :company
+
+    WDAYS = %w[日 月 火 水 木 金 土].freeze
+    Date::DATE_FORMATS[:jp_date] = '%m月%d日'
+    Time::DATE_FORMATS[:only_hm] = '%H:%M'
+
+    # path_template : String
+    # salary_per_hour : Integer
+    # tax_rate : Float
+    # company : String
+    def initialize
+      h_invoice_info = invoice_info
+
+      @path_template   = h_invoice_info['template']
+      @salary_per_hour = h_invoice_info['salaryPerHour']
+      @tax_rate        = h_invoice_info['taxRate']
+      @company         = h_invoice_info['company']
+    end
+
+    def generate
+      create_dir_invoice_current_term
+      makeup_worktable
+      generate_invoice_from_template
+    end
+
+    def build
+      puts 'Currently, it is not available to build pdf with latexmk.'
+      puts 'Wait for new version!'
+    end
+
+    private
+
+    def create_dir_invoice_current_term
+      FileUtils.mkdir_p(dir_invoice_current_term)
+    end
+
+    def makeup_worktable
+      @worktable = [
+        '\hline',
+        '日付 & 曜日 & 内容 & 出勤 & 退勤 & 休憩 & 労働時間 \\\\ \hline\hline'
+      ]
+      @allworktime_on_sec = 0.0
+      working_times = CSV.open(path_current_term, headers: true)
+      row = working_times.first
+      date_itr = beginning_of_month(row['started_at'])
+      date_itr.upto(date_itr.end_of_month) do |date|
+        if row.nil?
+          @worktable << format_worktable_row(date)
+        elsif same_day?(row['started_at'], date.rfc3339)
+          worktime = calculate_worktime(row['started_at'], row['finished_at'], row['rest_sec'])
+          @allworktime_on_sec += worktime
+          @worktable <<
+            format_worktable_row(date, row['comment'], row['started_at'], row['finished_at'], row['rest_sec'], worktime)
+          row = working_times.readline
+        else
+          @worktable << format_worktable_row(date)
+        end
+      end
+    end
+
+    def generate_invoice_from_template
+      template = File.readlines(path_template)
+      File.open(path_invoice_current_term, 'w') do |f|
+        template.each do |t|
+          t.gsub!(/##COMPANY##/, company)
+          t.gsub!(/##WORKTIME##/, parse_second_to_hh_str(@allworktime_on_sec))
+          t.gsub!(/##ACTUALWORKTIME##/, parse_second_to_hm_str(@allworktime_on_sec))
+          t.gsub!(/##SALARYPERHOUR##/, salary_per_hour.to_s)
+          t.gsub!(/##SALARY##/, salary.to_s)
+          t.gsub!(/##TAXRATE##/, "#{(tax_rate * 100).to_i}\\%")
+          t.gsub!(/##TAX##/, tax.to_s)
+          t.gsub!(/##SALARYWITHTAX##/, (salary + tax).to_s)
+          # on gsub, '\' means 'replace sub string'.
+          # so we should use block if work as expected
+          t.gsub!(/##WORKTABLE##/) { @worktable.join("\n") }
+
+          f.write(t)
+        end
+      end
+    end
+
+    def beginning_of_month(rfc3339)
+      Date.parse(rfc3339).beginning_of_month
+    end
+
+    def same_day?(one_rfc3339, another_rfc3339)
+      Date.parse(one_rfc3339) == Date.parse(another_rfc3339)
+    end
+
+    def calculate_worktime(st_rfc3339, fi_rfc3339, rest_sec)
+      Time.parse(fi_rfc3339) - Time.parse(st_rfc3339) - rest_sec.to_i
+    end
+
+    # date : Date
+    # comment : String
+    # started_at, finished_at : String (RFC3339)
+    # rest, worktime : Integer
+    def format_worktable_row(date, comment = nil, started_at = nil, finished_at = nil, rest = nil, worktime = nil)
+      "#{date.to_s(:jp_date)} & " \
+      "#{WDAYS[date.wday]} & " \
+      "#{comment || '-'} & " \
+      "#{started_at.nil? ? '-' : Time.parse(started_at).to_s(:only_hm)} & " \
+      "#{finished_at.nil? ? '-' : Time.parse(finished_at).to_s(:only_hm)} & " \
+      "#{rest.nil? ? '-' : parse_second_to_hm_str(rest.to_i)} & " \
+      "#{worktime.nil? ? '-' : parse_second_to_hm_str(worktime)} \\\\ \\hline"
+    end
+
+    # second : Float
+    def parse_second_to_hm_str(second)
+      second = second.to_i
+      h = second / 3600
+      m = (second - 3600 * h) / 60
+      "#{h}:#{m.to_s.rjust(2, '0')}"
+    end
+
+    def parse_second_to_hh_str(second)
+      (second / 3600).to_i.to_s
+    end
+
+    # calculate with 'hour' only
+    def salary
+      @salary ||= @allworktime_on_sec.to_i / 3600 * salary_per_hour
+    end
+
+    def tax
+      @tax ||= (salary * tax_rate).to_i
+    end
+  end
+end

data/lib/working_times/record.rb

@@ -1,57 +1,62 @@
-# frozen_string_literal: true
-
 require 'active_support/time'
+require 'csv'
 
 module WorkingTimes
   class Record
     include State
 
-    attr_reader :timestamp, :comment, :duration, :work_on
+    OPTIONS = { headers: true, return_headers: true, write_headers: true }.freeze
+
+    attr_reader :timestamp, :comment, :duration
 
-    def initialize(timestamp:, comment: nil, duration: nil, work_on: nil)
+    def initialize(timestamp:, comment: nil, duration: nil)
       @timestamp = timestamp
       @comment   = comment
       @duration  = duration
-      @work_on   = work_on.nil? ? default_work : work_on
     end
 
     def start
-      File.open("#{data_dir}/#{work_on}", 'a+') do |f|
-        f.puts "#{timestamp.rfc3339},,#{comment},start"
+      CSV.open(path_current_term, 'a+', OPTIONS) do |csv|
+        csv.puts([timestamp.rfc3339, '', 0, comment])
       end
     end
 
     def finish
-      File.open("#{data_dir}/#{current_work}", 'a+') do |f|
-        f.puts ",#{timestamp.rfc3339},#{comment},finish"
+      updated_csv = ''
+      CSV.filter(File.open(path_current_term), updated_csv, OPTIONS) do |row|
+        next if row.header_row?
+        next unless row['finished_at'].empty?
+
+        row['finished_at'] = timestamp.rfc3339
+        row['comment'] = comment
       end
+      File.write(path_current_term, updated_csv)
     end
 
     def rest
-      parse_rest_finished_at
-      File.open("#{data_dir}/#{current_work}", 'a+') do |f|
-        f.puts "#{timestamp.rfc3339},#{@finished_at.rfc3339},#{comment},rest"
-      end
+      parse_rest_sec
 
-      show_rest_msg
+      updated_csv = ''
+      CSV.filter(File.open(path_current_term), updated_csv, OPTIONS) do |row|
+        next if row.header_row?
+        next unless row['finished_at'].empty?
+
+        row['rest_sec'] = @rest_sec
+      end
+      File.write(path_current_term, updated_csv)
     end
 
     private
 
-    def parse_rest_finished_at
-      @finished_at = timestamp
+    def parse_rest_sec
+      @rest_sec = 0
       if /(?<hour>\d+)\s*h/ =~ duration
-        @finished_at += hour.to_i.hour
+        @rest_sec += hour.to_i * 3600
       end
 
       if /(?<minute>\d+)\s*m/ =~ duration
-        @finished_at += minute.to_i.minute
+        @rest_sec += minute.to_i * 60
       end
     end
-
-    def show_rest_msg
-      Time::DATE_FORMATS[:rest_finished_at] = '%H:%M:%S'
-      puts "You can rest until #{@finished_at.to_s(:rest_finished_at)}."
-    end
   end
 end

data/lib/working_times/state.rb

@@ -1,46 +1,37 @@
-# frozen_string_literal: true
-
 module WorkingTimes
   module State
     private
 
     include Config
 
-    # generate data directory when does not exist
-    # it is usually called by 'start' command
-    def initialize_data_dir
-      return if exist_data_dir?
-
-      puts 'data directory .wt not found, generated.'
-      Dir.mkdir(data_dir)
-    end
-
-    def exist_data_dir?
-      File.exist?(data_dir)
-    end
-
     def working?
-      File.exist?("#{data_dir}/.working")
+      File.exist?(path_working_flag)
     end
 
     # return what kind of working on
     def current_work
-      File.readlines("#{data_dir}/.working").last.chomp
+      File.readlines(path_working_flag).last.chomp
     end
 
-    # create ~/.wt/.working include what you working on
-    # and show 'started' message
-    def start_work(work_on)
-      work_on = work_on.nil? ? default_work : work_on
-      File.open("#{data_dir}/.working", 'w+') { |f| f.puts work_on }
+    def start_work
+      File.write(path_working_flag, current_term)
       puts START_MSG.sample
     end
 
-    # delete 'working' flag
-    # and show 'finished' message
     def finish_work
-      File.delete("#{data_dir}/.working")
+      puts "You were working about #{worked_time}."
+      File.delete(path_working_flag)
       puts FINISH_MSG.sample
     end
+
+    def worked_time
+      last_record = CSV.read(path_current_term).last
+      started_at  = Time.parse(last_record[0])
+      finished_at = Time.parse(last_record[1])
+      duration    = (finished_at - started_at).to_i
+      hour = duration / 3600
+      min  = (duration - 3600 * hour) / 60
+      "#{hour.to_s.rjust(2, '0')} hour #{min.to_s.rjust(2, '0')} min"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: working_times
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.7.2
 platform: ruby
 authors:
 - Aoshi Fujioka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rubocop
+  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'
 description: Store your working/worked time simply. This gem gives simple CLI tool.
 email:
 - blue20will@gmail.com
@@ -107,6 +135,7 @@ files:
 - lib/working_times/cli.rb
 - lib/working_times/config.rb
 - lib/working_times/constants.rb
+- lib/working_times/invoice.rb
 - lib/working_times/record.rb
 - lib/working_times/state.rb
 homepage: https://github.com/arsley/working_times