onboardable 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8937c95a5e3ca637b90d8ef871d57e1bf7f23e44c52549f66e38cfbd13120602
-  data.tar.gz: '08c904a659fbc0dcead1c41babfcd733b3b5f0c46fd7b1a1279c1479ee9730c1'
+  metadata.gz: 9b6bddf9e6bd140af8b288a658222c3742ce07f6b9f2585716ba28e9c24a1097
+  data.tar.gz: '09a2c6fe377f80a33e1fbff274c9e05cfa6c907ae3661def938b961bf1afe181'
 SHA512:
-  metadata.gz: e30650b2b899483742c4d98b09250a38428ae3e5d476c435178575bc44d767c0d397cbadb55a78300ca43b258bd72ca8c917e0175283ce49210c2d85d6aefc6c
-  data.tar.gz: 7625b9d924d5c477028721e87324437c337e91cfc3ef77da97545b55980f948fd7d380d48cffbd7b4577f2fac4e71f05621fc53cbb5409b5389786e402741657
+  metadata.gz: '0379a520c2bb0699772c500866924497fb6ab89ffacbb93d3e7b34b0fac3f614ae899d8ab5bff49a9189d6c46f3d37fe1c7e557c95c9929d2205c03530edc63c'
+  data.tar.gz: ce3d1feaca082deedc5dbf4d20fb56663ec403d3614e35e35c1ebb21b237864bde9599da46e8ff0e16a7d03164253fea878c9f736afc0631bba982a706b25200

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [1.4.0] - 2025-04-01
+
+- Add support for Ruby 3.4.
+- Drop support for Ruby 3.0.
+
+## [1.3.3] - 2024-08-16
+
+- Updated rbs files to improve type-checking.
+- Added github-actions package ecosystem to the development workflow.
+
 ## [1.3.2] - 2024-07-10
 
 - Added adjustments to rbs files to improve type-checking.

data/Gemfile.lock

@@ -1,68 +1,73 @@
 PATH
   remote: .
   specs:
-    onboardable (1.3.2)
+    onboardable (1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    diff-lcs (1.5.1)
-    docile (1.4.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    ast (2.4.3)
+    diff-lcs (1.6.1)
+    docile (1.4.1)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.1)
-      strscan
+    regexp_parser (2.10.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rspec-support (3.13.2)
+    rubocop (1.75.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.43.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.21.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (3.0.2)
-      rubocop (~> 1.61)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.43.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   x86_64-darwin-23
@@ -72,11 +77,11 @@ DEPENDENCIES
   onboardable!
   rake (~> 13.2, >= 13.2.1)
   rspec (~> 3.13)
-  rubocop (~> 1.64, >= 1.64.1)
+  rubocop (~> 1.65, >= 1.65.1)
   rubocop-performance (~> 1.21, >= 1.21.1)
-  rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 3.0, >= 3.0.2)
+  rubocop-rake (~> 0.7.1)
+  rubocop-rspec (~> 3.0, >= 3.0.4)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.5.15
+   2.6.6

data/README.md

@@ -73,23 +73,23 @@ that allow step navigation and state verification:
    - Instantiate the onboarding process when a `User` object is created.
      This sets up the initial step based on the defined onboarding flow.
 
-   ```ruby
-   onboarding = User.new.onboarding
-   ```
+     ```ruby
+     onboarding = User.new.onboarding
+     ```
 
    - For a more detailed setup, use the `Onboardable::List::Builder` to
      create a custom onboarding flow with specific steps and details.
 
-    ```ruby
-   builder = Onboardable::List::Builder.new
+     ```ruby
+     builder = Onboardable::List::Builder.new
 
-   builder.create_step 'welcome', message: 'Welcome to your new account!'
-   builder.create_step 'account_setup', task: 'Create credentials'
-   builder.create_step 'confirmation'
-   builder.create_step_from ExternalStepProvider
+     builder.create_step 'welcome', message: 'Welcome to your new account!'
+     builder.create_step 'account_setup', task: 'Create credentials'
+     builder.create_step 'confirmation'
+     builder.create_step_from ExternalStepProvider
 
-   onboarding = builder.build
-    ```
+     onboarding = builder.build
+     ```
 
 1. **Check the order of steps**
 
@@ -145,32 +145,32 @@ that allow step navigation and state verification:
    - Calculate the progress or completion percentage of the onboarding process
      to provide users with an indication of how far they have progressed.
 
-   ```ruby
-   onboarding.progress # Returns the completion percentage
-   ```
+     ```ruby
+     onboarding.progress # Returns the completion percentage
+     ```
 
    - To customize the progress calculation formula, define a lambda function
      that takes the current step index and the total number of steps as arguments.
 
-    ```ruby
-    CALCULATION = ->(step_index, steps_size) { step_index + steps_size }
-    onboarding.progress(CALCULATION)
-    ```
+     ```ruby
+     CALCULATION = ->(step_index, steps_size) { step_index + steps_size }
+     onboarding.progress(CALCULATION)
+     ```
 
    - Alternatively, set the custom progress calculation formula during the
      onboarding definition to automatically calculate the progress.
 
-    ```ruby
-    class User
-      include Onboardable
+     ```ruby
+     class User
+       include Onboardable
 
-      CALCULATION = ->(step_index, steps_size) { step_index + steps_size }
+       CALCULATION = ->(step_index, steps_size) { step_index + steps_size }
 
-      has_onboarding progress_calculation: CALCULATION do
-        # ...
-      end
-    end
-    ```
+       has_onboarding progress_calculation: CALCULATION do
+         # ...
+       end
+     end
+     ```
 
 1. **Access Current Step Details**
 

data/lib/onboardable/errors.rb

@@ -22,7 +22,7 @@ module Onboardable
     # @param klass [Class] The class that failed to convert.
     # @param step [unknown] The object that was attempted to be converted to a Step.
     def initialize(klass, step)
-      super("can't convert #{klass} to Step (#{klass}#to_onboarding_step gives #{step.class}).")
+      super("Can't convert #{klass} to Step (#{klass}#to_onboarding_step gives #{step.class}).")
     end
   end
 

data/lib/onboardable/list/navigation.rb

@@ -94,14 +94,14 @@ module Onboardable
       #
       # @raise [FirstStepError] The error indicating the current step is the first step.
       def first_step_error!
-        raise FirstStepError.new(current_step, steps.map(&:to_str))
+        raise FirstStepError.new(current_step.name, steps.map(&:to_str))
       end
 
       # Raises a LastStepError indicating the current step is the last step in the onboarding process.
       #
       # @raise [LastStepError] The error indicating the current step is the last step.
       def last_step_error!
-        raise LastStepError.new(current_step, steps.map(&:to_str))
+        raise LastStepError.new(current_step.name, steps.map(&:to_str))
       end
     end
   end

data/lib/onboardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onboardable
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

data/lib/onboardable.rb

@@ -29,9 +29,9 @@ module Onboardable
     # @param options [Hash] Optional configuration options for the ListBuilder.
     # @yield [List::Builder] Executes block in the context of List::Builder.
     # @return [Step] The current step in the building process.
-    def onboarding=(options = {}, &block)
+    def onboarding=(options = {}, &)
       self.list_builder = List::Builder.new(options)
-      list_builder.instance_eval(&block)
+      list_builder.instance_eval(&)
     end
     alias has_onboarding onboarding=
 

data/onboardable.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Provides tools for easy setup of custom onboarding to boost engagement.'
   spec.homepage = 'https://github.com/dmrAnderson/onboardable'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
@@ -41,10 +41,10 @@ Gem::Specification.new do |spec|
   # guide at: https://bundler.io/guides/creating_gem.html
   spec.add_development_dependency 'rake', '~> 13.2', '>= 13.2.1'
   spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.64', '>= 1.64.1'
+  spec.add_development_dependency 'rubocop', '~> 1.65', '~> 1.65', '>= 1.65.1'
   spec.add_development_dependency 'rubocop-performance', '~> 1.21', '>= 1.21.1'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 3.0', '>= 3.0.2'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.0', '>= 3.0.4'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/sig/onboardable/errors.rbs

@@ -23,11 +23,11 @@ module Onboardable
   end
 
   class LastStepError < Error
-    def initialize: (Symbol step, Array[Symbol] expected_steps) -> untyped
+    def initialize: (String step, Array[String] expected_steps) -> untyped
   end
 
   class FirstStepError < Error
-    def initialize: (Symbol step, Array[Symbol] expected_steps) -> untyped
+    def initialize: (String step, Array[String] expected_steps) -> untyped
   end
 
   class StepStatusError < Error

data/sig/onboardable/list/navigation.rbs

@@ -30,4 +30,4 @@ module Onboardable
       def last_step_error!: () -> untyped
     end
   end
-end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Artem Skrynnyk
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,20 +49,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.64'
+        version: '1.65'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.64.1
+        version: 1.65.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.64'
+        version: '1.65'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.64.1
+        version: 1.65.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -90,14 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +106,7 @@ dependencies:
         version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -117,7 +116,7 @@ dependencies:
         version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +170,6 @@ metadata:
   bug_tracker_uri: https://github.com/dmrAnderson/onboardable/issues
   documentation_uri: https://rubydoc.info/gems/onboardable
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -179,15 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Streamlines onboarding process integration
 test_files: []