clinvoice 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3fa79e8325739695366e91bc1e8cc4197771dc6bc7f46fe08216499f773e30
-  data.tar.gz: eb93495c6eea902a30455910a081b4a314da80c9343bf6f6ba5e67fbe4674cd0
+  metadata.gz: bd6602cc55be67b18e1507625e40cbfc5bebf18c8dabae2ffa6fb32177c61c92
+  data.tar.gz: ad155884e1f2cabc5df4e2ab57ae89866acf39276138576f8f98816ba9ed47ed
 SHA512:
-  metadata.gz: c012ccc054481d4912985dcee20507aac4d8996ff1317c71ff51ac20710c6f1b69b06fd24ce8ff57c4ceb9f7ab3fbf524826abf91bc4d3e89b68145f28fbb4be
-  data.tar.gz: bca8754d29c24a6237be190184e7ed7f8139a0b8bbf6589de3bb5851404b26b908caeec8b1f2e44a7c5619b919e1ef3389d1d31ca43491ba04170365f86019ec
+  metadata.gz: 9687ba2f286e4517c02626a63dbe06e77cbff5909ab3a4ef8dfe8fa091593edfaccf910ade7efb2b321964993b82f81e8fd8907cf27b2b8dea8478bfce5c854a
+  data.tar.gz: 16fd56e515bb4e6299026679b5b7c116b22503191850fceb680e8eb15469e13dfca485cf37d35fec7cb1be995af6edc6644e725aad4ddacdd575ab39b49705f6

data/README.md

@@ -5,7 +5,7 @@ Generates invoices using command line based on yaml files
 ```shell
 clinvoice init <datafile> # starts a new template with id 1 and empty entries.
 clinvoice new <filename> # generates a pdf invoice based on a data file `yml`.
-clinvoice next <datafile> # generates the next data file `yml`.
+clinvoice next <datafile> # generates the next data file `yml`, based on the last one.
 ```
 
 ## Installation
@@ -58,6 +58,14 @@ data:
   notes: "footer notes optional"
 ```
 
+`issue_date` and `due_date` are optional; add them to the data file to have them printed on the invoice:
+
+```yaml
+data:
+  issue_date: "2021-08-11"
+  due_date: "2021-09-11"
+```
+
 2 - Edit the data file:
 
     $ vim doge-client-1.yml
@@ -66,13 +74,20 @@ data:
 
     $ clinvoice new doge-client-1
 
-This will create a `doge-client-1.pdf` file based on the data file `doge-client-1.yml`.
+This will create a `doge-client-1.pdf` file based on the data file `doge-client-1.yml`. You can also pass the filename with the `.yml` extension, e.g. `clinvoice new doge-client-1.yml`.
 
 4 - Generate a next datafile
 
     $ clinvoice next doge-client
 
-This will create a `doge-client-2.yml` data file, based on the last data file id + 1.
+This will create a `doge-client-2.yml` data file, based on the last data file:
+
+- `id` is incremented.
+- `issue_date` and `due_date` are advanced by one month (rolling over the year when needed), keeping the `MM/dd/YYYY` format.
+- Any `Mon YYYY` occurrence in item descriptions (e.g. `Aug 2026`) is advanced by one month too (e.g. `Sep 2026`).
+- Everything else (items, notes, contractor, client, currency, etc.) is copied as is.
+
+If the `$EDITOR` environment variable is set, the new data file is opened in it automatically.
 
 ## Development
 
@@ -82,7 +97,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clinvoice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewaguiar/clinvoice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -90,4 +105,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Clinvoice project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clinvoice/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Clinvoice project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrewaguiar/clinvoice/blob/master/CODE_OF_CONDUCT.md).

data/lib/clinvoice/generate_next_template.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'date'
+
+module Clinvoice
+  module GenerateNextTemplate
+    DATE_FORMAT = '%m/%d/%Y'
+    MONTH_YEAR_REGEX = /\b(#{Date::ABBR_MONTHNAMES.compact.join('|')}) (\d{4})\b/.freeze
+
+    def self.call(file)
+      last_data_file = find_last_data_file(file)
+
+      unless last_data_file
+        puts "No existing data file found for '#{file}'."
+        exit 1
+      end
+
+      yaml = YAML.load_file(last_data_file)
+      invoice_data = yaml['data']
+
+      invoice_data['id'] += 1
+      invoice_data['issue_date'] = increment_date(invoice_data['issue_date']) if invoice_data['issue_date']
+      invoice_data['due_date'] = increment_date(invoice_data['due_date']) if invoice_data['due_date']
+
+      invoice_data['items'].each do |item|
+        item['description'] = increment_month_year(item['description']) if item['description']
+      end
+
+      next_file = "#{file}-#{invoice_data['id']}.yml"
+      File.write(next_file, YAML.dump(yaml))
+
+      open_in_editor(next_file)
+
+      next_file
+    end
+
+    def self.find_last_data_file(file)
+      Dir["#{file}-*.yml"].max_by { |f| f[/-(\d+)\.yml\z/, 1].to_i }
+    end
+
+    def self.increment_date(value)
+      (Date.strptime(value, DATE_FORMAT) >> 1).strftime(DATE_FORMAT)
+    end
+
+    def self.increment_month_year(text)
+      text.gsub(MONTH_YEAR_REGEX) do
+        month_number = Date::ABBR_MONTHNAMES.index(Regexp.last_match(1))
+        year = Regexp.last_match(2).to_i
+        next_month = Date.new(year, month_number, 1) >> 1
+
+        "#{Date::ABBR_MONTHNAMES[next_month.month]} #{next_month.year}"
+      end
+    end
+
+    def self.open_in_editor(file)
+      editor = ENV['EDITOR']
+      return if editor.nil? || editor.empty?
+
+      system(editor, file)
+    end
+  end
+end

data/lib/clinvoice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clinvoice
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/lib/clinvoice.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'clinvoice/initialize_template'
+require 'clinvoice/generate_next_template'
 require 'clinvoice/generate_pdf'
 require 'clinvoice/version'
 
@@ -16,6 +17,8 @@ module Clinvoice
       Clinvoice::InitializeTemplate.call(file)
     when 'new'
       Clinvoice::GeneratePDF.call(file)
+    when 'next'
+      Clinvoice::GenerateNextTemplate.call(file)
     else
       show_usage_and_exit!
     end
@@ -27,6 +30,7 @@ module Clinvoice
 
         clinvoice init <datafile> # starts a new template with id 1 and empty entries.
         clinvoice new <filename> # generates a pdf invoice based on a data file `yml`.
+        clinvoice next <datafile> # generates the next data file `yml`, based on the last one.
 
       Args:
 
@@ -51,6 +55,15 @@ module Clinvoice
 
           This will create a `doge-client-1.pdf` file based on the data file `doge-client-1.yml`.
 
+        4 - Generate a next datafile
+
+          `$ clinvoice next doge-client`
+
+          This will create a `doge-client-2.yml` data file, based on the last data file: id is incremented,
+          `issue_date` and `due_date` are advanced by one month, and any "Mon YYYY" occurrences in item
+          descriptions (example: "Aug 2026") are advanced by one month too. Everything else is copied as is.
+          The new file is opened in $EDITOR, if set.
+
     USAGE
 
     exit

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: clinvoice
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Andrew S Aguiar
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +90,7 @@ files:
 - generate-gem
 - lib/clinvoice.rb
 - lib/clinvoice/data.rb
+- lib/clinvoice/generate_next_template.rb
 - lib/clinvoice/generate_pdf.rb
 - lib/clinvoice/helper.rb
 - lib/clinvoice/initialize_template.rb
@@ -105,7 +105,6 @@ homepage: https://github.com/andrewaguiar/clinvoice
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 4.0.7
 specification_version: 4
 summary: Generates invoices using command line
 test_files: []