payment_day 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f831e07338ecf125bda97e4c77b9f0968c4cb4c60625addfecb5bedbfd906c4c
-  data.tar.gz: 41200c85a4bce203446ab8a66936eeb0fa39609acbad4cb703d3432a646a526d
+  metadata.gz: 6e8eac69e44a25f3069daac105862597e6f763fbe4594828b5b5b1d6a500f5b5
+  data.tar.gz: ca33ec1cb95f81285f18fdaf6d77dccc4d75ebc11b4fb62689d1c0f38e974393
 SHA512:
-  metadata.gz: f72f3c88895c8a5e38a5811af9ba180172833412c739e000f68d8586e338bc9a8e25232dccebe2723edeeb432694da3ed291e29834892342923d8a0d3541cba3
-  data.tar.gz: d0fbf52275d7298466fbbc11343ddecec8f95c637769f623a746a704d50aea634e623a1a760d92d65887fe554ba012ee6db5026915e8fb2c8426e40d574fd9da
+  metadata.gz: 07f40ba0b61cebf07ca5f8a2430f059bf52b9af6182a4bb4f6c38f7d9045771645e01074faf1cbcc8072f9c12acae43398322b148b78662fe44ecab85056e412
+  data.tar.gz: d4dd9e1c99c42e93197aeef849eb229c70fecb1ef3be93d09905af25667b648589af3ccf44c78b769e76bc733a1662ad69ef208d193b48c66bf107ac87a1aec1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.12] - 2022-12-31
+
+- Refactoring
+- pay_day executable supports more options
+
+## [0.1.11] - 2022-12-28
+
+- Refactoring
+
 ## [0.1.0] - 2022-12-27
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pay_day (0.1.0)
+    payment_day (0.1.2)
       rainbow (~> 3.1)
       terminal-table (~> 3.0)
       thor (~> 1.2)
@@ -22,7 +22,7 @@ PLATFORMS
 
 DEPENDENCIES
   minitest (~> 5.0)
-  pay_day!
+  payment_day!
   rake (~> 13.0)
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,6 @@
-# PayDay
+# PaymentDay
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pay_day`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Provides a class PaymentDay::View. This class generates the pay days for the given year(s).
 
 ## Installation
 
@@ -16,17 +14,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+# Get the pay days
+PaymentDay::View(2023).pay_days # return Array of Hash(es) with the pay_days
+PaymentDay::View("2023").pay_days # accept String as input
+PaymentDay::View(2023, 2024).pay_days # accept multiple years
+PaymentDay::View([2023]).pay_days # accept Array's as input
+PaymentDay::View("2023-2024").pay_days # accept String ranges
+PaymentDay::View(2023..2024).pay_days # accept Range as input
+PaymentDay::View(2023..2024, 2025, '2026').pay_days # accept a mix of all of them
+
+# Last parameter defines the options if set
+# shows 2023 twice in the list of pay_days, default is false
+PaymentDay::View(2023..2024, 2023, duplicates: true).pay_days
+
+table = PaymentDay::View(2023).list # returns a Terminal::Table instance
+puts table # which can be printed like this
+```
+
+### payment_day executable supports the following options:
+
+Option | Negated | Shortcut | Default
+--- | ---: | ---: | ---:
+--ascii | --no-ascii | -a | false
+--columns | | -c | 10
+--dayname | --no-dayname | -e | true
+--duplicates | --no-duplicates | -d | false
+--footer | --no-footer | -f | true
+--header | --no-header | -h | true
+--separator | --no-separator | -s | true
+
+```bash
+payment_day view 2023 2024 2025-2027
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pay_day.
+Bug reports and pull requests are welcome on GitHub at https://github.com/the-pulli/payment_day.
 
 ## License
 

data/lib/payment_day/cli.rb

@@ -6,11 +6,27 @@ require "thor"
 module PaymentDay
   # CLI class for PayDay
   class CLI < Thor
-    desc "list", "Lists all pay days for the given year(s)"
-    method_option :ascii, aliases: "-a", type: :boolean, default: false
-    method_option :separator, aliases: "-s", type: :boolean, default: true
-    def list(*years)
-      puts PaymentDay::View.new(years, options).list
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "view YEARS", "Lists all pay days for the given year(s)"
+    method_option :ascii, aliases: "-a", type: :boolean, default: false, desc: "Do you want to have a ASCII table printed?"
+    method_option :columns, aliases: "-c", type: :numeric, default: 10, desc: "How many years (columns) do you wanna display in one table?"
+    method_option :dayname, aliases: "-e", type: :boolean, default: true, desc: "Do you want see the day name?"
+    method_option :duplicates, aliases: "-d", type: :boolean, default: false, desc: "Do you want see duplicates?"
+    method_option :footer, aliases: "-f", type: :boolean, default: true, desc: "Do you want see the table footer?"
+    method_option :header, aliases: "-h", type: :boolean, default: true, desc: "Do you wanna see the table title?"
+    method_option :separator, aliases: "-s", type: :boolean, default: true, desc: "Do you want to have a separator for the rows printed?"
+    def view(*years)
+      years = PaymentDay::View.new(years, options).years
+      years = years.each_slice(options[:columns])
+      years.each_with_index do |yearsChunk, page|
+        year_options = options.dup
+        year_options[:page] = page.next
+        year_options[:pages] = years.to_a.length
+        puts PaymentDay::View.new(yearsChunk, year_options).list()
+      end
     end
   end
 end

data/lib/payment_day/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaymentDay
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/payment_day.rb

@@ -8,24 +8,39 @@ require_relative "payment_day/version"
 module PaymentDay
   # View class
   class View
-    MONTHS = %w[January February March April May June July August September October November December].freeze
+    DEFAULT_OPTIONS = {
+      ascii: false,
+      dayname: false,
+      duplicates: false,
+      footer: true,
+      page: nil,
+      pages: nil,
+      separator: true
+    }.freeze
 
-    attr_reader :pay_days
+    attr_reader :pay_days, :years
 
     def initialize(*years)
       options = years.last.is_a?(Hash) ? years.slice!(-1) : {}
-      @years = Array(prepare_years(years))
+      @months = []
+      @options = DEFAULT_OPTIONS.merge options.transform_keys(&:to_sym)
+      @years = prepare_years(years)
       @pay_days = find_pay_days
-      @options = { separator: true, ascii: false }.merge options.transform_keys(&:to_sym)
     end
 
     def list
       Terminal::Table.new do |t|
         t.title = Rainbow("Pay days").bright
-        t.headings = [Rainbow("Month").bright] + @years.map { |y| Rainbow(y).bright }
+        t.headings = [Rainbow("Month").bright] + @years.map { |y| { value: Rainbow(y).bright, alignment: :center } }
         t.style = { all_separators: @options[:separator], border: border }
-        t.rows = MONTHS.map { |m| Rainbow(m).cyan }.zip(*format_pay_days)
+        t.rows = @months.map { |m| Rainbow(m).cyan }.zip(*format_pay_days)
         @years.each_index { |v| t.align_column v.next, :center }
+        page = @options[:page]
+        pages = @options[:pages]
+        if @options[:footer] && pages > 1
+          t.add_row [{ colspan: @years.length.next, value: "Page #{page}/#{pages}",
+                       alignment: :center }]
+        end
       end
     end
 
@@ -34,7 +49,7 @@ module PaymentDay
     private
 
     def prepare_years(years)
-      years.flatten.map do |year|
+      result = years.flatten.map do |year|
         case year
         when Range
           year.to_a
@@ -49,19 +64,38 @@ module PaymentDay
           year
         end
       end.flatten
+
+      result = result.uniq unless @options[:duplicates]
+      Array(result)
     end
 
     def find_pay_days
-      @years.map do |year|
+      unless @options[:duplicates]
+        year_hsh = {}
+        @years.each.with_index do |year, index|
+          year_hsh[year] = (1..12).to_a.map do |month|
+            last_day = Date.parse("#{year}-#{month}-01").next_month.prev_day
+            @months.push(last_day.strftime("%B")) if index.zero?
+            prev(last_day)
+          end
+        end
+        return year_hsh
+      end
+
+      @years.map.with_index do |year, index|
         (1..12).to_a.map do |month|
           last_day = Date.parse("#{year}-#{month}-01").next_month.prev_day
+          @months.push(last_day.strftime("%B")) if index.zero?
           prev(last_day)
         end
       end
     end
 
     def format_pay_days
-      @pay_days.map { |year| year.map { |d| Rainbow(d.strftime("%d")).green } }
+      format = @options[:dayname] ? "%a, %d" : "%d"
+      return @pay_days.map { |_, year| year.map { |d| Rainbow(d.strftime(format)).green } } unless @options[:duplicates]
+
+      @pay_days.map { |year| year.map { |d| Rainbow(d.strftime(format)).green } }
     end
 
     def prev(day)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payment_day
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - PuLLi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow