punched 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95894483cb39658bf8b2df9eddece40e114f5afc4c62e8705c5de00345ee3cd
-  data.tar.gz: 32431041a7583350ff2f4dd4e1f90c104cae6f100838caf708560a4f9fac5e8a
+  metadata.gz: 332d10b07688d8df737329d65083cdee12e2f2a7fd2cc7d84a503fe8948688a0
+  data.tar.gz: 36a9ee38a2ad8187ba685982d01b0ae7422c077ec7107a1756706c9a675d15f7
 SHA512:
-  metadata.gz: 6d56bd82d7e3e745a0d6c712e3f68af52e65a8df0e0430e68bea264138d36d60a0cef92fcf039ba183307e85e3aab59793525d030c1441fa2709982b742373f7
-  data.tar.gz: c99e60f4b12a4848feec37f5454ce1c6b343e5d083821276aa7cb12f050406533b560c02250788736c956e401f05f604afc2ab0c63272a542016623c17f5f0fb
+  metadata.gz: c79f2403337f89533eaa77695786d33c41c6003d47e49f0eee1a62b66305eb9ee74fcf579a8efc44f1dfea2439de159aeef7f58c3d66a77567adce2daa7883db
+  data.tar.gz: 9337844f5458db7fc43ee924e31f71567a5f97b12ac30d4fa34bd422b90d7e3ecb444264c87ec738b4f61a873d964ce43f8dabee527f547dcf2b085176ce1f60

data/.github/workflows/specs.yml

@@ -0,0 +1,23 @@
+name: Specs
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

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

data/README.md

@@ -1,7 +1,7 @@
 # Punchcard
 ## Minimal time tracking tool for cli
 
-[![Build Status](https://img.shields.io/travis/pstaender/punched.svg?branch=v1.0.0&style=flat-square)](https://travis-ci.org/pstaender/punched)
+![status](https://github.com/pstaender/punched/actions/workflows/specs.yml/badge.svg)
 
 [![asciicast](https://asciinema.org/a/222572.svg)](https://asciinema.org/a/222572)
 
@@ -150,6 +150,26 @@ By default, PunchCard will store the data in `~/.punchcard/`. Define your custom
   export PUNCHCARD_DIR=~/Nextcloud/punchcard
 ```
 
+### Bash auto complete
+
+It is possible to add an auto completion for punchcard to your bash (tested on zsh so far). Add the following to your `.zshrc` / `.bashrc`:
+
+```bash
+PUNCHCARD_EXEC_PATH=$(which punched)
+
+punchcard_projects () {
+  ls $PUNCHCARD_DIR
+  return 0
+}
+
+[ -f $PUNCHCARD_EXEC_PATH ] && complete -F punchcard_projects $PUNCHCARD_EXEC_PATH
+```
+
+Ensure that the `$PUNCHCARD_DIR` environment variable is also set (see `Store projects files in a custom folder and sync them between computers`).
+
+Now you get a list of your existing projects everytime hitting a tab-key while using `punched`.
+
+In `rvm` the return value of `which punched` will be empty; use rvm to get the absolute path and / or set the path manually.
 
 ### Tests
 

data/bin/punched

@@ -157,6 +157,7 @@ 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'
@@ -183,6 +184,6 @@ if selected_action
   rescue PunchCardError => e
     exit_with_error! "Error: #{e.message}"
   rescue UnknownActionError => e
-    exit_with_error! "Unrecognized action '#{selected_action || e.message}'\n#{usage}"
+    exit_with_error! "Unknown action '#{e.message}'\n#{usage}"
   end
 end

data/lib/punchcard.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (c) 2017-2019 by Philipp Staender
+# (c) 2017-2023 by Philipp Staender
 
 require 'date'
 require 'time'
@@ -13,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.3.1'
+  VERSION             = '1.3.3'
 
   attr_accessor :title
 
@@ -108,7 +108,7 @@ class PunchCard
     find_or_make_file
     durations = []
     last_activity = nil
-    project_data.map do |line|
+    project_data_without_comments.map do |line|
       points = line_to_time_points(line)
       next unless points
 
@@ -179,7 +179,7 @@ class PunchCard
 
   def total(start_at: nil, end_at: nil)
     total = 0
-    project_data.map do |line|
+    project_data_without_comments.map do |line|
       points = line_to_time_points(line)
       next unless points
 
@@ -297,7 +297,7 @@ class PunchCard
   end
 
   def last_entry
-    project_data.last
+    project_data_without_comments.last
   end
 
   def timestamp
@@ -309,12 +309,14 @@ class PunchCard
   end
 
   def read_project_data
-    title      = nil
+    title      = File.basename(project_file)
     timestamps = []
     i          = 0
     File.open(project_file, 'r').each_line do |line|
       line.strip!
-      if i.zero?
+      next if line.start_with?('#')
+
+      if i.zero? && !line.match(TIME_POINT_PATTERN)
         title = line
       elsif line.match(META_KEY_PATTERN)
         set line.match(META_KEY_PATTERN)[1], line.match(META_KEY_PATTERN)[2]
@@ -332,6 +334,10 @@ class PunchCard
     File.open(project_file).each_line.map(&:strip)
   end
 
+  def project_data_without_comments
+    project_data.filter { |l| !l.start_with?('#')}
+  end
+
   def write_string_to_project_file!(string)
     File.open(project_file, 'w') { |f| f.write(string) }
   end

data/spec/punchcard_spec.rb

@@ -84,18 +84,18 @@ describe PunchCard do
     expect(my_project_file.lines[-2]).to match(/^\d+/)
   end
 
-  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')
+  it 'ignores lines starting with #' do
+    start_and_stop
+    File.write("#{example_settings_dir}/my_project", my_project_file + "\n# A comment line")
+    start_and_stop
+    expect(my_project_file).to match("\n# A comment line")
   end
 
-  xit 'should read and write utf8 names' do
+  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')
+    expect(project.project).to eq('playing_mot_rhead')
   end
 
   it 'should set hourlyRate' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: punched
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Philipp Staender
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-30 00:00:00.000000000 Z
+date: 2023-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markdown-tables
@@ -32,8 +32,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/specs.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Punchcard Timetracker

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.6
-  - 2.7
-  - ruby-head
-script: bundle exec rspec
-matrix:
-  allow_failures:
-    - rvm: ruby-head