punched 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1904b731e6d56b8dc58e49fd74f61d274da5a56342cb97b81a8a9c165f67dcc3
-  data.tar.gz: d923efb27d5f2f6dea68ae9591a1a2d8ad602ba773a1155eb18642b61bbca434
+  metadata.gz: e95894483cb39658bf8b2df9eddece40e114f5afc4c62e8705c5de00345ee3cd
+  data.tar.gz: 32431041a7583350ff2f4dd4e1f90c104cae6f100838caf708560a4f9fac5e8a
 SHA512:
-  metadata.gz: a98ac0bc3bb08062c85a97098bd5b5f9db1f5adb6f6dac97f02a4838dcde3f99feb91a90da7f45c4b2cf447a36e4cc70c832b1db3c2f0db40ae2d7c8f73a6df6
-  data.tar.gz: 7f097ad0f236ff27c7eb3dccde336aca01724a04f5613ff4a7eb3dcd9ca3d18438d4ec41cd391a769348ea482fc128971c1ed696ddb2d1d9b3d026c9624a1f02
+  metadata.gz: 6d56bd82d7e3e745a0d6c712e3f68af52e65a8df0e0430e68bea264138d36d60a0cef92fcf039ba183307e85e3aab59793525d030c1441fa2709982b742373f7
+  data.tar.gz: c99e60f4b12a4848feec37f5454ce1c6b343e5d083821276aa7cb12f050406533b560c02250788736c956e401f05f604afc2ab0c63272a542016623c17f5f0fb

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 punchcard_test_data/
+/*.gem

data/.travis.yml

@@ -1,11 +1,7 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
   - 2.6
+  - 2.7
   - ruby-head
 script: bundle exec rspec
 matrix:

data/README.md

@@ -17,49 +17,45 @@
 
 ### Usage
 
-#### Start Project
+#### Start and stop a Project
 
 ```sh
-  $ punched start "Punchcard (programming)"
+  $ punched toggle punchcard_programming
+  'punchcard_programming' started (00:00:00 total)
 ```
 
-#### Wildcard
-
-Save keystrokes by using wildcard. The first last active project, which matches the pattern (case insensitive) will be selected:
+To stop:
 
 ```sh
-  $ punched start "Punch*"
+  $ punched toggle punchcard_programming
+  'punchcard_programming' stopped (00:01:25 total)
 ```
 
-#### Stop Project
+To be more explicit, you can also use `start` and `stop` instead of `toggle`.
 
-```sh
-  $ punched stop "Punch*"
-```
-
-#### Toggle
+#### Wildcard
 
-Toggle between start and stop:
+Save keystrokes by using wildcard. The first last active project, which matches the (case insensitive) pattern will be selected:
 
 ```sh
-  $ punched toggle "Punch*"
+  $ punched toggle 'punched*'
 ```
 
 #### Status
 
 ```sh
-  $ punched status "Punch*"
+  $ punched status punched_programming
 
-    Punchcard (programming)
+    punched_programming
     01:10:09
 ```
 
 #### List details
 
 ```sh
-  $ punched details "Punch*"
+  $ punched details punched_programming
 
-    Punchcard (programming) (stopped)
+    punched_programming (stopped)
 
     00:00:08	2017-05-07 08:16:06 - 2017-05-07 08:16:14
     00:04:35	2017-05-07 08:22:02 - 2017-05-07 08:26:37
@@ -68,26 +64,44 @@ Toggle between start and stop:
     01:10:04	(total)
 ```
 
+#### Filtering
+
+You can filter your spend time with `startAt` and `endAt`:
+
+```sh
+  $ punched totalsum myproject --startAt=15.05.2020
+  $ punched totalsum myproject --startAt=15.05.2020 --endAt=30.05.2020
+  $ punched all plain --startAt=15.05.2020 --endAt=30.05.2020
+```
+
 #### Set Hourly Rate
 
 ```sh
-  $ punched set "Punch*" hourlyRate 250€
+  $ punched set punched_programming hourlyRate 250€
+  {"hourlyRate":"250€"}
 ```
 
-#### Total time in seconds
+#### Sum spended time on project(s)
+
+`total` returns the total spend time in seconds:
 
 ```sh
-  $ punched total "Punch*"
+  $ punched total punched_programming
+  13505
 ```
 
-#### Rename and delete Project
+`totalsum` calculates human readable spended time on project(s) (wildcard is used by default):
 
 ```sh
-  $ punched rename "Old Title" "New Title"
+  $ punched totalsum punched_programming
+  02:05:06
 ```
 
+Use `startAt` and/or `endAt` to set a time range:
+
 ```sh
-  $ punched remove "Punchcard (programming)"
+  $ punched totalsum punched_programming --startAt=2020-05-01 --endAt=2020-05-03
+  01:02:36
 ```
 
 #### Help
@@ -107,14 +121,14 @@ List all available actions:
     |========================================|=========|=====================|================|=============|==========|
     | project                                | status  |   last active on    | total duration | hourly rate | earnings |
     |========================================|=========|=====================|================|=============|==========|
-    | Website                                | stopped | 2017-05-07 15:50:00 |    00:04:40    | 95.0 €      | 380.00 € |
+    | website                                | stopped | 2017-05-07 15:50:00 |    00:04:40    | 95.0 €      | 380.00 € |
     |----------------------------------------|---------|---------------------|----------------|-------------|----------|
-    | Punchcard (programming)                | stopped | 2017-07-11 12:47:42 |    01:10:04    |             |          |
+    | punchcard_programming                  | stopped | 2017-07-11 12:47:42 |    01:10:04    |             |          |
     |========================================|=========|=====================|================|=============|==========|
 
 ```
 
-To use `md` or `csv` as output format:
+To use `plain`, `md` or `csv` as output format:
 
 ```sh
   $ punched all csv
@@ -126,6 +140,8 @@ To use `md` or `csv` as output format:
 
 You can use `all` with any other action as well, e.g. `punched all stop` to stop all running projects.
 
+Here you can also filter your spend time with `startAt` and `endAt`, respectively.
+
 ### Store projects files in a custom folder and sync them between computers
 
 By default, PunchCard will store the data in `~/.punchcard/`. Define your custom destination with:

data/bin/punched

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
-
 begin
-  require File.expand_path(File.dirname(THIS_FILE) + '/../lib/punchcard')
+  require File.expand_path(File.dirname(THIS_FILE) + '/../lib/punchcard.rb')
 rescue LoadError
   require 'punchcard'
 end
@@ -15,19 +14,19 @@ require 'date'
 require 'json'
 
 class UnknownActionError < StandardError; end
-
+class InvalidAllArgument < StandardError; end
 #
 # CLI Wrapper
 #
 
 def available_actions
-  PunchCard.new(nil).public_methods(false).reject { |item|
+  PunchCard.new(nil).public_methods(false).reject do |item|
     item.to_s.end_with?('=') || item.to_s == 'project'
-  }.concat(global_available_actions).sort
+  end.concat(global_available_actions).sort
 end
 
 def global_available_actions
-  [:all, :totalsum]
+  %i[all totalsum]
 end
 
 def action_available?(action)
@@ -43,48 +42,58 @@ def usage
   "Usage: #{File.basename(__FILE__)} #{available_actions.join('|')} 'Name of my project'"
 end
 
-def all(action)
-  available_formats = %w[csv plain md]
-  unless available_formats.include?(action)
-    raise "Format #{action} is not supported. Possible formats are: #{available_formats.join(',')}"
-  end
-
-  labels = ['project', 'status', 'last active on', 'total duration', 'hourly rate', 'earnings']
+def list_all_projects(format)
   data = call_punchcards_by_pattern('*', 'csv').map do |csv_string|
     csv_data = CSV.parse(csv_string)[0]
-    last_activity = !csv_data[2].empty? ? DateTime.parse(csv_data[2]).to_time.to_i : 0
+    last_activity = !csv_data[2].empty? ? Time.parse(csv_data[2]).to_i : 0
     csv_data.push(last_activity)
     csv_data
   end.sort_by(&:last).reverse.map do |row|
     row[0...-1]
   end
-
   return puts('No record(s) so far') if data.empty?
 
-  case action
+  puts convert_project_data(format, data)
+end
+
+def convert_project_data(format, data)
+  labels = ['project', 'status', 'last active on', 'total duration', 'hourly rate', 'earnings']
+  case format
   when 'md'
-    puts MarkdownTables.make_table(labels, data, is_rows: true, align: ['l'])
+    MarkdownTables.make_table(labels, data, is_rows: true, align: ['l'])
   when 'csv'
-    puts labels.to_csv
-    puts data.map(&:to_csv).join
+    "#{labels.to_csv}\n#{data.map(&:to_csv).join}"
   when 'plain'
     table = MarkdownTables.make_table(labels, data, is_rows: true, align: ['l'])
-    puts MarkdownTables.plain_text(table)
+    MarkdownTables.plain_text(table)
+  end
+end
+
+def all(action)
+  available_formats = %w[csv plain md]
+  if available_formats.include?(action)
+    list_all_projects(action)
+  elsif action_available?(action)
+    puts call_punchcards_by_pattern('*', action).to_a.join("\n")
+  else
+    suppurted_arguments = (available_formats + available_actions).reject {|n| n.to_s == 'all' }.uniq
+    raise InvalidAllArgument, "'#{action}' is not supported\nSupported formats and actions: #{suppurted_arguments.join(',')}"
   end
 end
 
-def call_punchcard(selected_action, project_name)
+def call_punchcard(selected_action:, project_name:, arguments:)
   if action_available?(selected_action)
     if !project_name && selected_action != 'list'
       exit_with_error!("2nd argument has to be the project name, e.g.:\n#{usage}")
     end
     punch_card = PunchCard.new project_name
     begin
-      arguments = ARGV.drop(2)
-      if !arguments.empty?
-        return punch_card.send(selected_action.to_s, *arguments)
+      if arguments.nil? || arguments.empty?
+        punch_card.public_send(selected_action.to_s)
+      elsif arguments.is_a?(Hash)
+        punch_card.public_send(selected_action.to_s, **arguments)
       else
-        return punch_card.send(selected_action.to_s)
+        punch_card.public_send(selected_action.to_s, *arguments)
       end
     rescue PunchCardError => e
       exit_with_error! "Error: #{e.message}"
@@ -94,10 +103,47 @@ def call_punchcard(selected_action, project_name)
   end
 end
 
+def cli_argument_by_name(name)
+  value = ARGV.filter { |arg| arg.start_with?("--#{name}=") }&.first
+  value = value.split('=')[1] unless value.nil?
+  if block_given? && !value.nil? && !value.empty?
+    yield value
+  else
+    value
+  end
+end
+
 def call_punchcards_by_pattern(pattern, action)
-  Dir["#{PunchCard::SETTINGS_DIR}/#{pattern}"].map do |file|
-    project_name = File.basename(file)
-    call_punchcard(action, project_name)
+  path_patterns = [
+    "#{PunchCard::SETTINGS_DIR}/#{pattern}*",
+    "#{PunchCard::SETTINGS_DIR}/*#{pattern}*"
+  ]
+  arguments = {}
+  if %w(csv plain md total).include?(action)
+    arguments = {
+      start_at: cli_argument_by_name('startAt') { |v| Date.parse(v) },
+      end_at: cli_argument_by_name('endAt') { |v| Date.parse(v) }
+    }
+  end
+  found = []
+  path_patterns.each do |path_pattern|
+    found = Dir[path_pattern].map do |file|
+      project_name = File.basename(file)
+      call_punchcard(
+        selected_action: action,
+        project_name: project_name,
+        arguments: arguments
+      )
+    end
+    break if found.any?
+  end
+  found
+end
+
+def validate_project_name_and_stop_if_invalid(project_name)
+  if project_name.strip.strip.start_with?('.')
+    STDERR.puts "Error: project name's are not allowed to start with '.'"
+    exit 1
   end
 end
 
@@ -114,18 +160,26 @@ if selected_action
     if selected_action == 'all'
       all(ARGV[1] || 'plain')
     elsif selected_action == 'totalsum'
-      pattern = ARGV[1] || '*'
+      pattern_argument = ARGV.slice(1)
+      pattern = !pattern_argument || pattern_argument.empty? || pattern_argument.start_with?('--') ? '*' : pattern_argument
       puts PunchCard.humanize_duration(
         call_punchcards_by_pattern(pattern, 'total').reduce(&:+)
       )
     else
-      result = call_punchcard(selected_action, project_name)
+      validate_project_name_and_stop_if_invalid(project_name)
+      result = call_punchcard(
+        selected_action: selected_action,
+        project_name: project_name,
+        arguments: ARGV.drop(2)
+      )
       if result.is_a?(Hash)
         puts result.to_json
       else
         puts result
       end
     end
+  rescue InvalidAllArgument => e
+    exit_with_error! e.message
   rescue PunchCardError => e
     exit_with_error! "Error: #{e.message}"
   rescue UnknownActionError => e

data/lib/punchcard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # (c) 2017-2019 by Philipp Staender
 
 require 'date'
@@ -11,7 +13,7 @@ class PunchCard
   HOURLY_RATE_PATTERN = /^\s*(\d+)([^\d]+)*\s*/i.freeze
   TIME_POINT_PATTERN  = /^((\d+|.+?\s[\+\-]\d{4}?\s*)(\-)*(\d+|\s.+\d?)*)$/.freeze
   META_KEY_PATTERN    = /^([a-zA-Z0-9]+)\:\s*(.*)$/.freeze
-  VERSION             = '1.2.0'.freeze
+  VERSION             = '1.3.1'
 
   attr_accessor :title
 
@@ -101,7 +103,7 @@ class PunchCard
     output.join("\n")
   end
 
-  def csv
+  def csv(start_at: nil, end_at: nil)
     project_exists_or_stop!
     find_or_make_file
     durations = []
@@ -110,16 +112,27 @@ class PunchCard
       points = line_to_time_points(line)
       next unless points
 
-      starttime = points[0]
-      endtime   = points[1] || timestamp
+      start_time = points[0]
+      end_time   = points[1] || timestamp
+
+      next if time_range_is_excluded_by_filter?(
+        start_at: start_at,
+        end_at: end_at,
+        start_time: start_time,
+        end_time: end_time
+      )
+
       last_activity = points[1] || points[0]
-      durations.push duration(starttime, endtime)
+      durations.push end_time - start_time
     end
+    total_duration = self.class.humanize_duration(
+      durations.reduce(&:+) || 0
+    )
     '"' + [
       title_and_project,
       running_status,
       last_activity ? self.class.format_time(Time.at(last_activity).to_datetime) : '',
-      humanized_total,
+      total_duration,
       hourly_rate ? hourly_rate[:hourlyRate].to_s + " #{hourly_rate[:currency]}" : '',
       hourly_rate ? (hourly_rate[:hourlyRate] * total / 3600.0).round(2).to_s + " #{hourly_rate[:currency]}" : ''
     ].join('","') + '"'
@@ -155,22 +168,32 @@ class PunchCard
   end
 
   def set(key, value)
-    raise PunchCardError, "Key '#{key}' can only be alphanumeric" unless key =~ /^[a-zA-Z0-9]+$/
+    unless key =~ /^[a-zA-Z0-9]+$/
+      raise PunchCardError, "Key '#{key}' can only be alphanumeric"
+    end
 
     @meta_data[key.to_sym] = value
     write_to_project_file!
     @meta_data
   end
 
-  def total
+  def total(start_at: nil, end_at: nil)
     total = 0
     project_data.map do |line|
       points = line_to_time_points(line)
       next unless points
 
-      starttime = points[0]
-      endtime   = points[1] || timestamp
-      total += endtime - starttime
+      start_time = points[0]
+      end_time   = points[1] || timestamp
+
+      next if time_range_is_excluded_by_filter?(
+        start_at: start_at,
+        end_at: end_at,
+        start_time: start_time,
+        end_time: end_time
+      )
+
+      total += end_time - start_time
     end
     total
   end
@@ -180,6 +203,8 @@ class PunchCard
   end
 
   def self.humanize_duration(duration)
+    return nil unless duration
+
     hours   = duration / (60 * 60)
     minutes = (duration / 60) % 60
     seconds = duration % 60
@@ -197,7 +222,7 @@ class PunchCard
   private
 
   def hourly_rate
-    hourly_rate_found = @meta_data[:hourlyRate] && @meta_data[:hourlyRate].match(HOURLY_RATE_PATTERN)
+    hourly_rate_found = @meta_data[:hourlyRate]&.match(HOURLY_RATE_PATTERN)
     return unless hourly_rate_found
 
     {
@@ -222,9 +247,9 @@ class PunchCard
     self.class.humanize_duration total
   end
 
-  def duration(starttime, endtime)
-    if starttime
-      self.class.humanize_duration endtime - starttime
+  def duration(start_time, end_time)
+    if start_time
+      self.class.humanize_duration end_time - start_time
     else
       self.class.humanize_duration 0
     end
@@ -254,7 +279,7 @@ class PunchCard
     matches = line.match(TIME_POINT_PATTERN)
 
     time_points = matches ? [string_to_timestamp(matches[2]), string_to_timestamp(matches[4])] : nil
-    if time_points && time_points.reject(&:nil?).empty?
+    if time_points&.reject(&:nil?)&.empty?
       nil
     else
       time_points
@@ -351,4 +376,8 @@ class PunchCard
   def sanitize_filename(name)
     name.downcase.gsub(%r{(\\|/)}, '').gsub(/[^0-9a-z.\-]/, '_')
   end
+
+  def time_range_is_excluded_by_filter?(start_time:, end_time:, start_at: nil, end_at: nil)
+    start_at && start_at.to_time.to_i >= start_time || end_at && end_at.to_time.to_i <= end_time
+  end
 end

data/punched.gemspec

@@ -11,9 +11,8 @@ Gem::Specification.new do |s|
   s.description           = 'Minimal time tracking tool for cli'
   s.license               = 'GPL-3.0'
   s.executables           = ['punched']
-  s.rubyforge_project     = 'punched'
   s.require_paths         = ['lib']
-  s.required_ruby_version = '>= 2.1'
+  s.required_ruby_version = '>= 2.6'
   s.files                 = `git ls-files`.split("\n")
 
   s.add_dependency 'markdown-tables', '~> 1.0.2'

data/spec/punchcard_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 require 'punchcard'
@@ -13,6 +14,10 @@ def setup_example_settings_dir
   PunchCard.const_set(:SETTINGS_DIR, example_settings_dir)
 end
 
+def punched_bin
+  "PUNCHCARD_DIR=#{example_settings_dir} #{Dir.pwd}/bin/punched"
+end
+
 describe PunchCard do
   before do
     setup_example_settings_dir
@@ -86,6 +91,13 @@ describe PunchCard do
     expect(project.project).to eq('playing_mot_rhead')
   end
 
+  xit 'should read and write utf8 names' do
+    PunchCard.new 'Playing Motörhead'
+    expect(my_project_file('playing_mot_rhead').strip).to eq('Playing Motörhead')
+    project = PunchCard.new 'Playing*'
+    expect(project.project).to eq('Playing Motörhead')
+  end
+
   it 'should set hourlyRate' do
     project = start_and_stop
     project.set 'hourlyRate', '1000 €'
@@ -150,4 +162,10 @@ describe PunchCard do
     project.remove
     expect(File.exist?("#{example_settings_dir}/my_project")).to be_falsey
   end
+
+  it 'should call punched all' do
+    two_seconds_tracking
+    result = `#{punched_bin} all`
+    expect(result).to match('My Project')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: punched
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Philipp Staender
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markdown-tables
@@ -45,7 +45,7 @@ homepage: https://github.com/pstaender/punchcard
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +53,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Punchcard Timetracker
 test_files: []