nxt_support 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f312406bd8279693e902e38435d9ecec8e0e3d15c1e522d91c4a5cd75e4f4ced
-  data.tar.gz: 0bb1c82b792322ecab97f89093295b17c4f9c5e2223a71584aca23b4b672a95a
+  metadata.gz: 5be999049e08c616e9259357e3babdc21c8a56202e29463ffb35877d7b59156b
+  data.tar.gz: a24d5abbc81b8a05104096251e7a1c5ef95fd4ef22378be9ad225e310848a417
 SHA512:
-  metadata.gz: 92bf3e5ec6c83fe1f713973d4528b1a85b7c83573f86121b3fbe03e8586820c63e56369911d84031a62af5ca2db72bc50baaac2a45a29e270936d9154671f58b
-  data.tar.gz: 0b883a1c2bbb8e0b7a6040569204676f4d5beec2b41514d791a1545863cd7c41d4394f8a1619b61956058cb6fa5d2038db6403857fb5cbe71f6a040dac6d77a4
+  metadata.gz: 62f3c629491c73b7b9fe0ac85639d01671cd3845fa6250a5c5b980ca5ea2a3353bc17337f2a7dbf72904113761cf70d6b43864635a526eed6bb0f7eb859e997d
+  data.tar.gz: 27ea42c5fa932be54cbc2b2e0cc1d5e1edd34176fe50e8fb8581507ce9429fba032dbba2aeda8806044f7471918eb8cc33744939a881ab4a6d409e7b2130ecb8

data/.circleci/config.yml

@@ -10,9 +10,9 @@ workflows:
       - build:
           matrix:
             parameters:
-              ruby-version: ["3.0.2", "3.1.3", "3.2.1"]
+              ruby-version: ["3.0.2", "3.1.3", "3.2.1", "3.2.2"]
 orbs:
-  ruby: circleci/ruby@2.0.0
+  ruby: circleci/ruby@2.0.1
 
 jobs:
   build:
@@ -28,7 +28,9 @@ jobs:
 
     steps:
       - checkout
-      - ruby/install-deps
+      - ruby/install-deps:
+          key: gems-v2
+          include-branch-in-cache-key: false
       - run:
           name: run tests
           command: |

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.5.0 2023-03-22
+- Add `rake_cli_options`
+
 # v0.4.3 2023-03-22
 - `Sentry-Error-Id`: Don't assume status code is an Integer
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_support (0.4.3)
+    nxt_support (0.5.0)
       activerecord
       activesupport
       nxt_init
@@ -10,47 +10,49 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    activemodel (7.0.7.2)
+      activesupport (= 7.0.7.2)
+    activerecord (7.0.7.2)
+      activemodel (= 7.0.7.2)
+      activesupport (= 7.0.7.2)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
-    diff-lcs (1.4.4)
-    i18n (1.12.0)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.18.0)
+    mini_portile2 (2.8.4)
+    minitest (5.19.0)
     nxt_init (0.1.5)
       activesupport
     nxt_registry (0.3.10)
       activesupport
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (13.0.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    sqlite3 (1.4.2)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 

data/README.md

@@ -2,7 +2,10 @@
 
 # NxtSupport
 
-This is a collection of mixins, helpers and classes that cover several aspects of a ruby on rails application, such as models, controllers and job processing. At [Getsafe](https://hellogetsafe.com), we run multiple Ruby on Rails apps as part of our insurance infrastructure and we found that we wrote quite some shared helpers that are duplicated among applications and serve a generic purpose that we could share in this gem. Look at it as our version of ActiveSupport (which is amazing! ❤️), droping in the pieces we sometimes miss in the beautiful puzzle of Rails.
+This is a collection of mixins, helpers and classes that cover several aspects of a ruby on rails application, such as models, controllers and job processing. 
+At [Getsafe](https://hellogetsafe.com), we run multiple Ruby on Rails apps as part of our insurance infrastructure and we found that we wrote quite some 
+shared helpers that are duplicated among applications and serve a generic purpose that we could share in this gem. 
+Look at it as our version of ActiveSupport (which is amazing! ❤️), dropping in the pieces we sometimes miss in the beautiful puzzle of Rails.
 
 ## Installation
 
@@ -28,7 +31,7 @@ Here's an overview all the supporting features.
 A Rack middleware that adds a `Sentry-Error-ID` header to 5xx responses. 
 The header is only added if an error was reported during the request. 
 The error ID is gotten from [`sentry.error_event_id` in the Rack env](https://github.com/getsentry/sentry-ruby/pull/1849)).
-You can then visit `https://sentry.io/organizations/<org-slug>>?query=<error-event-id>`
+You can then visit `https://<org-slug>.sentry.io/issues/?query=<error-event-id>`
 to go directly to the error (it may not show up immediately).
 
 Note that this middleware must be inserted before Sentry's own middleware. 
@@ -250,7 +253,7 @@ TestClass.translate_hash(firstname: 'John', firstname: :first_name)
 => { 'first_name' => 'John' }
 ```
 The `value` also could be a `Hash` where key represents the new key in result hash and value must be a lambda or Proc
-that would be used to process value from origin hash. If the tuple hash contains more than 1 key-value paris or value in key value pair
+that would be used to process value from origin hash. If the tuple hash contains more than 1 key-value pairs or value in key value pair
 is not a callable block `InvalidTranslationArgument` error would be raised.
 
 ```ruby
@@ -357,6 +360,64 @@ NxtSupport::BirthDate.new(date: '1990-08-08').to_age # => 30
 NxtSupport::BirthDate.new(date: '1990-08-08').to_age_in_months # => 361
 ```
 
+### NxtSupport::Console.rake_cli_options
+A simple utility that uses Ruby's [OptionParser](https://docs.ruby-lang.org/en/2.1.0/OptionParser.html)
+to make it easier to pass CLI options to Rake tasks.
+
+#### Task definition
+Call `NxtSupport::Console.rake_cli_options` with a block. Use the `option` method to define options.
+It takes one required argument (the flag syntax), and optionally the data type and a default value.
+
+Options which are not booleans **must** end with an `=`.
+
+```rb
+task my_task: :environment do
+  opts = NxtSupport::Console.rake_cli_options do
+    option '--simulate', default: false
+    option '--contract_numbers=', Array, default: []
+    option '--limit=', Integer
+    option '--effective_at='
+  end
+
+  do_stuff_with opts
+end
+```
+
+#### Command line
+
+A `--` must be passed after the Rake task name and any Rake-specific options, 
+before our custom task options. (With `heroku run`, you'll also need a second `--`).
+
+```sh
+rake my_task -- --simulate --contract_numbers=123,456 --effective_at=2022-01-02 --limit=20
+# {:contract_numbers=>["123", "456"], :simulate=>true, :effective_at=>"2022-01-02", :limit=>20}
+```
+
+On Heroku (note the second `--`):
+
+```sh
+heroku run rake my_task -- -- --simulate --contract_numbers=123,456 --effective_at=2022-01-02 --limit=20
+```
+
+If any options are not passed, they'll be replaced with their defaults. 
+If no default was specified, they will _not_ be present in the returned hash.
+
+```sh
+rake my_task -- --effective_at=2022-10-13
+# {:simulate=>false, :effective_at=>"2022-10-13", :contract_numbers=>[]}
+```
+
+If you specify an option which was not defined, the command will exit with an error:
+
+```sh
+rake my_task -- --effective_at=2022-10-13 --testing
+# invalid option: --testing
+```
+
+#### Limitations
+- Short arguments aren't supported (`-l` as a shortcut for `--limit`).
+- On the command line, options with values must be passed with an `=` at the end. `--effective_at 2022-10-13` will not work.
+
 ### NxtSupport/Services
 Enjoy your service objects.
 
@@ -436,7 +497,7 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/nxt_insurance/nxt_support.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nxt-insurance/nxt_support.
 
 ## Publishing
 ### GitHub Tags and Releases

data/lib/nxt_support/console.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module NxtSupport
+  module Console
+    # Better CLI arguments for Rake tasks, using Ruby's OptionParser
+    # See https://docs.ruby-lang.org/en/2.1.0/OptionParser.html
+    #
+    # Example usage in a task:
+    #
+    #   task :my_task do
+    #     opts = NxtSupport::Console.rake_cli_options do
+    #       option '--simulate'
+    #       option '--contract_numbers=', Array, default: []
+    #       option '--limit=', Integer, default: 10
+    #       option '--effective_at='
+    #     end
+    #
+    #     p opts
+    #   end
+    #
+    # On the CLI:
+    #   rake my_task -- --simulate --contract_numbers=123,456 --effective_at=2022-01-02 --limit=20
+    #
+    # Results:
+    #   {:contract_numbers=>["123", "456"], :simulate=>true, :effective_at=>"2022-01-02", :limit=>20}
+    #
+    # Note that the extra "--" must be passed after the task name and all Rake-specific flags.
+    #
+    # Also, only arguments which are supplied on the CLI or had defaults defined will be present in the returned hash
+    #   rake my_task -- --effective_at=2022-10-13
+    #   => {:limit=>10, :effective_at=>"2022-10-13", :contract_numbers=>[]}
+    def rake_cli_options(argv = ARGV.dup, &option_definition_block)
+      require 'optparse'
+
+      argv.shift while argv.include?('--') # Remove task name and --
+      options = {}
+
+      OptionParser.new do |parser|
+        parser.define_singleton_method(:option) do |switch, type = nil, default: nil|
+          if default
+            switch_name = switch.sub('--', '').sub('=', '')
+            options[:"#{switch_name}"] = default
+          end
+          type ? def_option(switch, type) : def_option(switch)
+        end
+        parser.instance_eval(&option_definition_block)
+      end.parse!(argv, into: options)
+
+      options
+    end
+
+    module_function :rake_cli_options
+  end
+end

data/lib/nxt_support/version.rb

@@ -1,3 +1,3 @@
 module NxtSupport
-  VERSION = "0.4.3".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/nxt_support.rb

@@ -8,6 +8,7 @@ require "nxt_support/serializers"
 require "nxt_support/util"
 require "nxt_support/services"
 require "nxt_support/refinements"
+require "nxt_support/console"
 
 require 'nxt_support/middleware/sentry_error_id'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_support
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Nils Sommer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -165,6 +165,7 @@ files:
 - bin/rspec
 - bin/setup
 - lib/nxt_support.rb
+- lib/nxt_support/console.rb
 - lib/nxt_support/middleware/sentry_error_id.rb
 - lib/nxt_support/models.rb
 - lib/nxt_support/models/assignable_values.rb
@@ -214,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Support through reusable Mixins and Helpers for Ruby on Rails Applications