punched 1.0.4 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31fb8d911d693ff343d9becd044d9c3378b64ba8214e6175aec5e6e042ce621
-  data.tar.gz: aba03f814669c72f40e8cb2a56317aac1313ae3033f627fcc3ae9f83cc33ad03
+  metadata.gz: b9e6c733da15335832d27af80790665daed6c11c5baad9fbca2e221c094a15ca
+  data.tar.gz: 9d0817147f2df8b7c275ca233c45640b4fe9b2919bad621d4b3fe7cacd9847ba
 SHA512:
-  metadata.gz: 9bd2d23729a8fbde5073d9aaa907d8585ea10c063ffeb3176e942cf6ce2fae7fdd078b038e7a520f03a39f4037c385278fe2c1a8b7e28b058bf9586ded70094c
-  data.tar.gz: d4111205855e18c030236011ba93e02b6780771595df1c755d61095f5d6fcec0425cf22d56ca0da723c6e7bd5dabd2120ff4cc2035e80dcb62579fea8d3d15a7
+  metadata.gz: 7a3e6d274a7e53e9672178aaf1ff4beb283cba46f8b48b28f101f7e433af24195f016a5200f4a3b9222d51cf4daed4c10c5e1270a931730ed184f67b8fc54051
+  data.tar.gz: e4ad79f601795b9fa1f0afda921cec744ad853f2fc54c82122abea80faeffcf37f1d3c4c5b0b2b388c442efa933c059fc9ffbb7d51b21579090619526e290a9b

data/.gitignore

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

data/.travis.yml

@@ -1,10 +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

@@ -3,6 +3,8 @@
 
 [![Build Status](https://img.shields.io/travis/pstaender/punched.svg?branch=v1.0.0&style=flat-square)](https://travis-ci.org/pstaender/punched)
 
+[![asciicast](https://asciinema.org/a/222572.svg)](https://asciinema.org/a/222572)
+
 ### Requirements
 
   * ruby 2.1+
@@ -15,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
-
-```sh
-  $ punched stop "Punch*"
-```
+To be more explicit, you can also use `start` and `stop` instead of `toggle`.
 
-#### 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
@@ -66,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
@@ -105,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
@@ -124,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

@@ -1,24 +1,39 @@
 #!/usr/bin/env ruby
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+begin
+  require File.expand_path(File.dirname(THIS_FILE) + '/../lib/punchcard.rb')
+rescue LoadError
+  require 'punchcard'
+end
 
-require 'punchcard'
 require 'csv'
 require 'markdown-tables'
 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| item.to_s.end_with?('=') || item.to_s == 'project' }.concat([:all]).sort
+  PunchCard.new(nil).public_methods(false).reject do |item|
+    item.to_s.end_with?('=') || item.to_s == 'project'
+  end.concat(global_available_actions).sort
+end
+
+def global_available_actions
+  %i[all totalsum]
 end
 
-def action_available? action
+def action_available?(action)
   available_actions.include? action.to_sym
 end
 
-def exit_with_error! msg
+def exit_with_error!(msg)
   STDERR.puts msg
   exit 1
 end
@@ -27,58 +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"]
-  data = Dir[PunchCard::SETTINGS_DIR+'/*'].map { |file|
-    data = CSV.parse(`ruby #{__FILE__} csv '#{File.basename(file)}'`).first
-    last_activity = !data[2].empty? ? DateTime.parse(data[2]).to_time.to_i : 0
-    data.push(last_activity)
-    data
-  }.sort { |a, b|
-    a.last <=> b.last
-  }.reverse.map { |row|
+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? ? 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
 
-if ARGV.first == 'all'
-  all ARGV[1] || 'plain'
-  exit
-elsif ARGV.first && ['-h', '--help', 'help'].include?(ARGV.first)
-  puts usage
-  exit
+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
 
-selected_action = ARGV[0]
-project_name    = ARGV[1]
-
-if selected_action
+def call_punchcard(selected_action:, project_name:, arguments:)
   if action_available?(selected_action)
-    exit_with_error!("2nd argument has to be the project name, e.g.:\n#{usage}") if !project_name && selected_action != 'list'
+    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.size > 0
-        puts 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
-        puts 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}"
@@ -87,3 +102,88 @@ if selected_action
     exit_with_error! "Unrecognized action '#{selected_action || ''}'\n#{usage}"
   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)
+  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
+
+if ['-h', '--help', 'help'].include?(ARGV.first)
+  puts(usage)
+  exit
+end
+
+selected_action = ARGV[0]
+project_name    = ARGV[1]
+
+if selected_action
+  begin
+    raise UnknownActionError.new(selected_action) unless action_available?(selected_action)
+    if selected_action == 'all'
+      all(ARGV[1] || 'plain')
+    elsif selected_action == 'totalsum'
+      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
+      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
+    exit_with_error! "Unknown action '#{e.message}'\n#{usage}"
+  end
+end

data/lib/punchcard.rb

@@ -1,4 +1,6 @@
-# (c) 2017-2018 by philipp staender
+# frozen_string_literal: true
+
+# (c) 2017-2019 by Philipp Staender
 
 require 'date'
 require 'time'
@@ -7,33 +9,32 @@ class PunchCardError < StandardError
 end
 
 class PunchCard
-
   SETTINGS_DIR        = ENV['PUNCHCARD_DIR'] || File.expand_path('~/.punchcard')
-  HOURLY_RATE_PATTERN = /^\s*(\d+)([^\d]+)*\s*/i
-  TIME_POINT_PATTERN  = /^((\d+|.+?\s[\+\-]\d{4}?\s*)(\-)*(\d+|\s.+\d?)*)$/
-  META_KEY_PATTERN    = /^([a-zA-Z0-9]+)\:\s*(.*)$/
-  VERSION             = '1.0.4'
+  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.3.2'
 
-  attr_accessor :project
+  attr_accessor :title
 
-  def initialize project_name
+  def initialize(project_name)
     @wilcard_for_filename = ''
     @meta_data            = {}
     find_or_make_settings_dir
-    if project_name
-      self.project = project_name
-      find_or_make_file
-      read_project_data
-    end
+    return unless project_name
+
+    self.project = project_name
+    find_or_make_file
+    read_project_data
   end
 
   def start
     output = []
     if start_time && !end_time
-      output << "'#{project}' already started (#{humanized_total} total)"
-      output << "#{duration(start_time, timestamp)}"
+      output << "'#{title_or_project}' already started (#{humanized_total} total)"
+      output << duration(start_time, timestamp).to_s
     else
-      output << "'#{project}' started (#{humanized_total} total)"
+      output << "'#{title_or_project}' started (#{humanized_total} total)"
       self.start_time = timestamp
     end
     output.join("\n")
@@ -42,12 +43,12 @@ class PunchCard
   def stop
     output = []
     if end_time
-      output << "'#{@project}' already stopped (#{humanized_total} total)"
+      output << "'#{title_or_project}' already stopped (#{humanized_total} total)"
     elsif start_time
-      output << "'#{@project}' stopped (#{humanized_total} total)"
+      output << "'#{title_or_project}' stopped (#{humanized_total} total)"
       self.end_time = timestamp
     else
-      output << "Nothing to stop"
+      output << 'Nothing to stop'
     end
     output.join("\n")
   end
@@ -60,11 +61,23 @@ class PunchCard
     end
   end
 
+  def title_or_project
+    title || project
+  end
+
+  def title_and_project
+    if title != project
+      "#{title} [#{project}]"
+    else
+      project
+    end
+  end
+
   def status
     project_exists_or_stop!
     find_or_make_file
     output = []
-    output << (project+" (#{running_status})\n")
+    output << (title_or_project + " (#{running_status})\n")
     output << humanized_total
     output.join("\n")
   end
@@ -73,51 +86,66 @@ class PunchCard
     project_exists_or_stop!
     find_or_make_file
     output = []
-    output << project+" (#{running_status})\n\n"
-    project_data.map do |line|
+    data = project_data
+    data[0] = "#{data[0]} (#{running_status})"
+    data.map do |line|
       points = line_to_time_points(line)
-      if points
-        starttime = points[0]
-        endtime   = points[1] || timestamp
-        output << duration(starttime, endtime) + "\t" + self.class.format_time(Time.at(starttime)) + " - " + self.class.format_time(Time.at(endtime))
+      unless points
+        output << line + "\n"
+        next
       end
+
+      starttime = points[0]
+      endtime   = points[1] || timestamp
+      output << duration(starttime, endtime) + "\t" + self.class.format_time(Time.at(starttime)) + ' - ' + self.class.format_time(Time.at(endtime))
     end
     output << "========\n#{humanized_total}\t(total)"
     output.join("\n")
   end
 
-  def csv
+  def csv(start_at: nil, end_at: nil)
     project_exists_or_stop!
     find_or_make_file
     durations = []
     last_activity = nil
     project_data.map do |line|
       points = line_to_time_points(line)
-      if points
-        starttime = points[0]
-        endtime   = points[1] || timestamp
-        last_activity = points[1] || points[0]
-        durations.push duration(starttime, endtime)
-      end
+      next unless points
+
+      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 end_time - start_time
     end
-    '"'+[
-        @project,
-        running_status,
-        last_activity ? self.class.format_time(Time.at(last_activity).to_datetime) : '',
-        humanized_total,
-        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]}" : '',
+    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) : '',
+      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('","') + '"'
   end
 
   def remove
-    if File.exists?(project_file)
+    if File.exist?(project_file)
       File.delete(project_file)
       "Deleted #{project_file}"
     end
   end
 
-  def rename new_project_name
+  def rename(new_project_name)
     old_filename = project_filename
     data         = project_data
     data[0]      = new_project_name
@@ -126,11 +154,11 @@ class PunchCard
     File.rename(old_filename, project_filename) && "#{old_filename} -> #{project_filename}"
   end
 
-  def project= project_name
+  def project=(project_name)
     @project = project_name
     if @project.end_with?('*')
-      @wilcard_for_filename = "*"
-      @project              = @project.chomp("*")
+      @wilcard_for_filename = '*'
+      @project              = @project.chomp('*')
     end
     @project.strip
   end
@@ -139,46 +167,72 @@ class PunchCard
     @project.strip
   end
 
-  def set key, value
-    raise PunchCardError.new("Key '#{key}' can only be alphanumeric") unless key.match(/^[a-zA-Z0-9]+$/)
+  def set(key, value)
+    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)
-      if points
-        starttime = points[0]
-        endtime   = points[1] || timestamp
-        total     += endtime - starttime
-      end
+      next unless points
+
+      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
 
-  def self.format_time datetime
+  def self.format_time(datetime)
     datetime.strftime('%F %T')
   end
 
-  private
+  def self.humanize_duration(duration)
+    return nil unless duration
 
-  def hourly_rate
-    hourly_rate_found = @meta_data[:hourlyRate] && @meta_data[:hourlyRate].match(HOURLY_RATE_PATTERN)
-    if hourly_rate_found
-      {
-          hourlyRate: hourly_rate_found[1].to_f,
-          currency:   hourly_rate_found[2] ? hourly_rate_found[2].strip : '',
-      }
+    hours   = duration / (60 * 60)
+    minutes = (duration / 60) % 60
+    seconds = duration % 60
+    "#{decimal_digits(hours)}:#{decimal_digits(minutes)}:#{decimal_digits(seconds)}"
+  end
+
+  def self.decimal_digits(digit)
+    if digit.to_i < 10
+      "0#{digit}"
     else
-      nil
+      digit.to_s
     end
   end
 
+  private
+
+  def hourly_rate
+    hourly_rate_found = @meta_data[:hourlyRate]&.match(HOURLY_RATE_PATTERN)
+    return unless hourly_rate_found
+
+    {
+      hourlyRate: hourly_rate_found[1].to_f,
+      currency: hourly_rate_found[2] ? hourly_rate_found[2].strip : ''
+    }
+  end
+
   def project_exists_or_stop!
-    raise PunchCardError.new("'#{@project}' does not exists") unless project_exist?
+    raise PunchCardError, "'#{@project}' does not exists" unless project_exist?
   end
 
   def active?
@@ -190,29 +244,14 @@ class PunchCard
   end
 
   def humanized_total
-    humanize_duration total
+    self.class.humanize_duration total
   end
 
-  def duration starttime, endtime
-    if starttime
-      humanize_duration endtime - starttime
+  def duration(start_time, end_time)
+    if start_time
+      self.class.humanize_duration end_time - start_time
     else
-      humanize_duration 0
-    end
-  end
-
-  def humanize_duration duration
-    hours   = duration / (60 * 60)
-    minutes = (duration / 60) % 60
-    seconds = duration % 60
-    "#{decimal_digits(hours)}:#{decimal_digits(minutes)}:#{decimal_digits(seconds)}"
-  end
-
-  def decimal_digits digit
-    if digit.to_i < 10
-      "0#{digit}"
-    else
-      digit.to_s
+      self.class.humanize_duration 0
     end
   end
 
@@ -220,11 +259,11 @@ class PunchCard
     time_points ? time_points[0] : nil
   end
 
-  def start_time= time
+  def start_time=(time)
     append_new_line timestamp_to_time(time)
   end
 
-  def end_time= time
+  def end_time=(time)
     replace_last_line "#{timestamp_to_time(start_time)} - #{timestamp_to_time(time)}"
   end
 
@@ -236,24 +275,24 @@ class PunchCard
     line_to_time_points last_entry
   end
 
-  def line_to_time_points line
+  def line_to_time_points(line)
     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
     end
-
   end
 
   def string_to_timestamp(str)
     return str if str.nil?
+
     str.strip!
-    # This is some legacy... previous versions stored timestamp,
+    # here some legacy… previous versions stored timestamp,
     # but now punched stores date-time strings for better readability.
-    # So we have to convert timestamp and date-time format into timestamp here
+    # So we have to convert timestamp and date-time format into timestamp
     str =~ /^\d+$/ ? str.to_i : (str =~ /^\d{4}\-\d/ ? Time.parse(str).to_i : nil)
   end
 
@@ -271,10 +310,9 @@ class PunchCard
 
   def read_project_data
     title      = nil
-    meta_data  = []
     timestamps = []
     i          = 0
-    File.open(project_file, "r").each_line do |line|
+    File.open(project_file, 'r').each_line do |line|
       line.strip!
       if i.zero?
         title = line
@@ -285,15 +323,16 @@ class PunchCard
       end
       i += 1
     end
-    @project = title if title
+    @project = File.basename(project_file)
+    self.title = title
     timestamps
   end
 
   def project_data
-    File.open(project_file).each_line.map { |line| line.strip }
+    File.open(project_file).each_line.map(&:strip)
   end
 
-  def write_string_to_project_file! string
+  def write_string_to_project_file!(string)
     File.open(project_file, 'w') { |f| f.write(string) }
   end
 
@@ -303,11 +342,11 @@ class PunchCard
     write_string_to_project_file! [@project, meta_data_lines.join("\n"), timestamps].reject(&:empty?).join("\n")
   end
 
-  def append_new_line line
-    open(project_file, 'a') { |f| f.puts("\n"+line.to_s.strip) }
+  def append_new_line(line)
+    open(project_file, 'a') { |f| f.puts("\n" + line.to_s.strip) }
   end
 
-  def replace_last_line line
+  def replace_last_line(line)
     data     = project_data
     data[-1] = line
     write_string_to_project_file! data.join("\n")
@@ -322,20 +361,23 @@ class PunchCard
   end
 
   def project_exist?
-    File.exists?(project_file)
+    File.exist?(project_file)
   end
 
   def find_or_make_file
-    write_string_to_project_file!(@project+"\n") unless project_exist?
-    @project = project_data.first
+    write_string_to_project_file!(@project + "\n") unless project_exist?
+    self.title ||= project_data.first
   end
 
   def find_or_make_settings_dir
-    Dir.mkdir(SETTINGS_DIR) unless File.exists?(SETTINGS_DIR)
+    Dir.mkdir(SETTINGS_DIR) unless File.exist?(SETTINGS_DIR)
   end
 
-  def sanitize_filename name
-    name.downcase.gsub(/(\\|\/)/, '').gsub(/[^0-9a-z.\-]/, '_')
+  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

@@ -1,22 +1,19 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "punchcard"
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'punchcard'
 
 Gem::Specification.new do |s|
   s.name                  = 'punched'
   s.version               = PunchCard::VERSION
-  s.authors               = ["Philipp Staender"]
-  s.email                 = ["philipp.staender@gmail.com"]
+  s.authors               = ['Philipp Staender']
+  s.email                 = ['pstaender@mailbox.org']
   s.homepage              = 'https://github.com/pstaender/punchcard'
   s.summary               = 'Punchcard Timetracker'
   s.description           = 'Minimal time tracking tool for cli'
   s.license               = 'GPL-3.0'
   s.executables           = ['punched']
-  s.default_executable    = 'punched'
-  s.rubyforge_project     = 'punched'
-  s.require_paths         = ["lib"]
-  s.required_ruby_version = '>= 2.1'
+  s.require_paths         = ['lib']
+  s.required_ruby_version = '>= 2.6'
   s.files                 = `git ls-files`.split("\n")
-  
+
   s.add_dependency 'markdown-tables', '~> 1.0.2'
 end

data/spec/punchcard_spec.rb

@@ -1,6 +1,7 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
-require "punchcard"
+require 'punchcard'
 require 'securerandom'
 
 def example_settings_dir
@@ -8,13 +9,16 @@ def example_settings_dir
 end
 
 def setup_example_settings_dir
-  Dir.glob(example_settings_dir+'/*').each { |file| File.delete(file) }
+  Dir.glob(example_settings_dir + '/*').each { |file| File.delete(file) }
   PunchCard.send(:remove_const, :SETTINGS_DIR)
   PunchCard.const_set(:SETTINGS_DIR, example_settings_dir)
 end
 
-describe PunchCard do
+def punched_bin
+  "PUNCHCARD_DIR=#{example_settings_dir} #{Dir.pwd}/bin/punched"
+end
 
+describe PunchCard do
   before do
     setup_example_settings_dir
   end
@@ -25,8 +29,8 @@ describe PunchCard do
     PunchCard.new("My random Project #{SecureRandom.hex}")
   end
 
-  def my_project_file filename = 'my_project'
-    File.open("#{example_settings_dir}/#{filename}", "r").read
+  def my_project_file(filename = 'my_project')
+    File.open("#{example_settings_dir}/#{filename}", 'r').read
   end
 
   def start_and_stop
@@ -63,7 +67,7 @@ describe PunchCard do
   it 'should calculate tracked total time' do
     project      = two_seconds_tracking
     tracked_time = project.details.lines.last.match(/^\d{2}\:\d{2}\:(\d{2}).*total/)[1].to_i
-    expect(tracked_time).to  be_between 1, 3
+    expect(tracked_time).to be_between 1, 3
     project      = two_seconds_tracking
     tracked_time = project.details.lines.last.match(/^\d{2}\:\d{2}\:(\d{2}).*total/)[1].to_i
     expect(tracked_time).to be_between 3, 5
@@ -80,29 +84,36 @@ describe PunchCard do
     expect(my_project_file.lines[-2]).to match(/^\d+/)
   end
 
-  it '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")
+  it 'should convert names to underscore with special characters' 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
+
+  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 €"
-    expect(my_project_file.lines[1].strip).to eq("hourlyRate: 1000 €")
+    project.set 'hourlyRate', '1000 €'
+    expect(my_project_file.lines[1].strip).to eq('hourlyRate: 1000 €')
   end
 
   it 'should calculate earnings' do
     project = start_and_stop
-    project.set 'hourlyRate', "1000EURO"
+    project.set 'hourlyRate', '1000EURO'
     project.toggle
     sleep 2
     project.toggle
     project.toggle
     sleep 2
     project.toggle
-    expect(project.csv).to match /^"My Project","stopped","[0-9\-\s\:]+?","[0-9\:]+?","1000.0 EURO","1\.\d+ EURO"$/
+    expect(project.csv).to match /^"My Project \[my_project\]","stopped","[0-9\-\s\:]+?","[0-9\:]+?","1000.0 EURO","1\.\d+ EURO"$/
   end
 
   it 'should track different projects simultanously' do
@@ -115,16 +126,16 @@ describe PunchCard do
     project_a.stop
     sleep 2
     project_b.stop
-    expect(project_b.total.to_i - project_a.total.to_i).to be_between(2,4)
+    expect(project_b.total.to_i - project_a.total.to_i).to be_between(2, 4)
   end
 
   it 'should load latest project by wildcard' do
     project_a = random_project
-    project   = PunchCard.new "My random*"
+    project   = PunchCard.new 'My random*'
     expect(project.project).to eq(project_a.project)
     sleep 1
     project_b = random_project
-    project   = PunchCard.new "My random*"
+    project   = PunchCard.new 'My random*'
     expect(project.project).to eq(project_b.project)
     expect(project.project).not_to eq(project_a.project)
   end
@@ -133,23 +144,28 @@ describe PunchCard do
     project = example_project
     content = my_project_file
     project.rename 'Renamed Project'
-    expect(File.open("#{example_settings_dir}/renamed_project", "r").read.strip).to eq(content.strip.sub(/My Project/, 'Renamed Project'))
-    expect(File.exists?("#{example_settings_dir}/my_project")).to be_falsey
+    expect(File.open("#{example_settings_dir}/renamed_project", 'r').read.strip).to eq(content.strip.sub(/My Project/, 'Renamed Project'))
+    expect(File.exist?("#{example_settings_dir}/my_project")).to be_falsey
     expect(project.project).to eq('Renamed Project')
     project.start
     sleep 0.1
     project.stop
-    content = File.open("#{example_settings_dir}/renamed_project", "r").read.strip
+    content = File.open("#{example_settings_dir}/renamed_project", 'r').read.strip
     project.rename 'Other Project'
-    expect(File.open("#{example_settings_dir}/other_project", "r").read.strip).to eq(content.strip.sub(/Renamed Project/, 'Other Project'))
-    expect(File.exists?("#{example_settings_dir}/renamed_project")).to be_falsey
+    expect(File.open("#{example_settings_dir}/other_project", 'r').read.strip).to eq(content.strip.sub(/Renamed Project/, 'Other Project'))
+    expect(File.exist?("#{example_settings_dir}/renamed_project")).to be_falsey
   end
 
   it 'should remove' do
     project = example_project
-    expect(File.exists?("#{example_settings_dir}/my_project")).to be_truthy
+    expect(File.exist?("#{example_settings_dir}/my_project")).to be_truthy
     project.remove
-    expect(File.exists?("#{example_settings_dir}/my_project")).to be_falsey
+    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.0.4
+  version: 1.3.2
 platform: ruby
 authors:
 - Philipp Staender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-20 00:00:00.000000000 Z
+date: 2020-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markdown-tables
@@ -26,7 +26,7 @@ dependencies:
         version: 1.0.2
 description: Minimal time tracking tool for cli
 email:
-- philipp.staender@gmail.com
+- pstaender@mailbox.org
 executables:
 - punched
 extensions: []
@@ -53,15 +53,14 @@ 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: []
-rubyforge_project: punched
-rubygems_version: 2.7.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Punchcard Timetracker