onboardable 1.3.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64ca22b6b557818ddbd19779baf17ebf1c9890d79caf6790525774098e10951
-  data.tar.gz: 1580320037e0ffb67697b22a29a3c3c477752c2fde5ecbc71ba8425b87ecb046
+  metadata.gz: e9f0c447b6d3593da8e840bc4964a61fb7078df687a13e0d87bf846d51c17838
+  data.tar.gz: 5b0861f3ff6b98ed383d2497e4bca47bee0893ab98124e3bfd680c3b1e119dac
 SHA512:
-  metadata.gz: c048601b0ca78f84d44602df3863f132d71489a81df86aec4f4b4e220aa4f2ffa58e8348b8f4007c1280dee098a50f7a48f5cd5b7f6508f1e0d03ca457c816bc
-  data.tar.gz: 97efd280235a2965383df3a52fe7378b1e32024a37f413cac3140a17c18823b90e6318cce0e0af5da44541884a803da56cb7d43919e4715f07ae71da8586def3
+  metadata.gz: 15c8e34a8d136da36ec0a8d968f6140123c5d05cece765e60ed1f95267416bf10373e4ea79159b84095e78485a691f3906a4897c15cb4b85ce377e3337c87b51
+  data.tar.gz: dfdb3df40595dd49dc2860494bb9da050c8124f8e936f17ddd8c52a00626ac7576270d1cb4f793591f0d79277513079975d370a64c44504f5eda8151ed931944

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [1.5.0] - 2025-08-01
+
+- Drop support for Ruby 3.1.
+- Update development dependencies to their latest versions.
+
+## [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.

data/Gemfile.lock

@@ -1,71 +1,76 @@
 PATH
   remote: .
   specs:
-    onboardable (1.3.3)
+    onboardable (1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    diff-lcs (1.5.1)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
     docile (1.4.1)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.26.2)
-    parser (3.3.4.2)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
+    prism (1.4.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.5)
-      strscan
-    rspec (3.13.0)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.4)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.65.1)
+    rspec-support (3.13.4)
+    rubocop (1.79.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 (>= 2.4, < 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.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.0)
-      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.4)
-      rubocop (~> 1.61)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.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.6.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
+  x86_64-darwin-24
   x86_64-linux
 
 DEPENDENCIES
@@ -74,9 +79,9 @@ DEPENDENCIES
   rspec (~> 3.13)
   rubocop (~> 1.65, >= 1.65.1)
   rubocop-performance (~> 1.21, >= 1.21.1)
-  rubocop-rake (~> 0.6.0)
+  rubocop-rake (~> 0.7.1)
   rubocop-rspec (~> 3.0, >= 3.0.4)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.5.17
+   2.7.1

data/README.md

@@ -65,7 +65,7 @@ could be included in the documentation. This guide covers initialization,
 navigation, step verification, and completion of the onboarding process.
 
 After defining and accessing the onboarding steps as described
-earlier, managed the onboarding process through various controls
+earlier, manage the onboarding process through various controls
 that allow step navigation and state verification:
 
 1. **Initialize Onboarding Process**
@@ -73,34 +73,34 @@ 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**
+2. **Check the order of steps**
 
    Determine the order of steps in the onboarding process to ensure
    that the sequence is correct and that the steps are defined as expected.
 
    ```ruby
-   onboarding.steps # Returns the list of steps
+   onboarding.steps
    ```
 
-1. **Navigating Through Steps**
+3. **Navigating Through Steps**
 
    Navigate through the onboarding steps using the navigation methods provided.
    These methods help in moving forward and backward through the onboarding process.
@@ -111,8 +111,8 @@ that allow step navigation and state verification:
       what's next or advance to it, updating the current step status.
 
       ```ruby
-      onboarding.next_step  # Preview the next step
-      onboarding.next_step! # Advance to the next step
+      onboarding.next_step
+      onboarding.next_step!
       ```
 
    - **Previous Step**
@@ -121,71 +121,71 @@ that allow step navigation and state verification:
      making changes or updates to revert to the previous step.
 
      ```ruby
-     onboarding.prev_step  # Preview the previous step
-     onboarding.prev_step! # Move back to the previous step
+     onboarding.prev_step
+     onboarding.prev_step!
      ```
 
-1. **Check Step Position**
+4. **Check Step Position**
 
    Determine whether the current step is the first or the last in the sequence
    to manage UI elements like 'Next' or 'Back' buttons appropriately.
 
    ```ruby
-   step = onboarding.steps.sample # Random step from the list
+   step = onboarding.steps.sample
 
-   onboarding.first_step?(step)   # Is the first step?
-   onboarding.last_step?(step)    # Is the last step?
-   onboarding.current_step?(step) # Is the current step?
-   onboarding.second_step?(step)  # Is the second step?
-   onboarding.prev_step?(step)    # Is the previous step?
+   onboarding.first_step?(step)
+   onboarding.last_step?(step)
+   onboarding.current_step?(step)
+   onboarding.second_step?(step)
+   onboarding.prev_step?(step)
    ```
 
-1. **Monitor Progress**
+5. **Monitor Progress**
 
    - 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
+     ```
 
    - 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**
+6. **Access Current Step Details**
 
    Retrieve details about the current step, which can include the name,
    custom data, and status, to display appropriate information or help
-   the user completes tasks associated with the step.
+   the user understand their current position in the onboarding process.
 
    ```ruby
-   onboarding.current_step        # Current step details
-   onboarding.current_step.name   # Step name
-   onboarding.current_step.data   # Step custom data
-   onboarding.current_step.status # Step status
+   onboarding.current_step
+   onboarding.current_step.name
+   onboarding.current_step.data
+   onboarding.current_step.status
    ```
 
-1. **Complete the Onboarding Process**
+7. **Complete the Onboarding Process**
 
    Once the user reaches the last step and completes it, finalize the
    onboarding process, which might involve setting a user attribute to
@@ -200,12 +200,12 @@ that allow step navigation and state verification:
    # Exception Handling Approach
    begin
      onboarding.next_step!
-   rescue LastStepError
+   rescue Onboardable::LastStepError
      # Implement finalization processes like updating user attributes
    end
    ```
 
-1. **Exit the Onboarding Process Early**
+8. **Exit the Onboarding Process Early**
 
    Handle cases where a user decides to discontinue the onboarding
    by attempting to navigate back from the initial step.
@@ -219,7 +219,7 @@ that allow step navigation and state verification:
    # Exception Handling Approach
    begin
      onboarding.prev_step!
-   rescue FirstStepError
+   rescue Onboardable::FirstStepError
      # Implement cleanup or final actions for an orderly exit
    end
    ```
@@ -230,13 +230,13 @@ user-friendly onboarding process using the Onboardable gem.
 ## 🛠 Development
 
 1. After checking out the repo, run `bin/setup` to install dependencies.
-1. Then, run `rake spec` to run the tests.
-1. Also run `bin/console` for an interactive prompt that will allow you to experiment.
-1. To install this gem onto your local machine, run `bundle exec rake install`.
-1. To release a new version, update the version number in `version.rb`.
-1. After, run `bundle exec rake release`, which will create a git tag for the version.
-1. Push git commits and the created tag.
-1. Then push the `.gem` file to [rubygems.org](https://rubygems.org).
+2. Then, run `rake spec` to run the tests.
+3. Also run `bin/console` for an interactive prompt that will allow you to experiment.
+4. To install this gem onto your local machine, run `bundle exec rake install`.
+5. To release a new version, update the version number in `version.rb`.
+6. After, run `bundle exec rake release`, which will create a git tag for the version.
+7. Push git commits and the created tag.
+8. Then push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## 🤝 Contributing
 
@@ -250,5 +250,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 📜 Code of Conduct
 
-Everyone interacting in the Onboardable project's codebases, issue trackers,
+Everyone interacting with the Onboardable project's codebases, issue trackers,
 chat rooms and mailing lists are expected to follow the [code of conduct](https://github.com/dmrAnderson/onboardable/blob/main/CODE_OF_CONDUCT.md).

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/base.rb

@@ -14,11 +14,11 @@ module Onboardable
       # @return [Step] The current step in the list.
       attr_reader :current_step
 
-      # Initializes a new instance of List with steps and a current step.
+      # Initializes a new instance of the List with steps and a current step.
       #
       # @param steps [Array<Step>] An array of steps comprising the onboarding process.
       # @param current_step [Step] The step currently active in the process.
-      # @param options [Hash] An options hash for the list.
+      # @param options [Hash] Optional parameters for configuring the list.
       def initialize(steps, current_step, options = {})
         self.steps = steps
         self.current_step = current_step
@@ -39,7 +39,7 @@ module Onboardable
       # @return [Hash] The options hash for the list.
       attr_reader :options
 
-      # Sets and validates the steps array, ensuring it is an Array of Step objects.
+      # Sets and validates an array of steps.
       #
       # @param steps [Array<Step>] The steps to be assigned to the list.
       # @return [Array<Step>] The assigned steps.
@@ -58,7 +58,7 @@ module Onboardable
         end
       end
 
-      # Sets and validates the options hash, ensuring it is a Hash object.
+      # Sets and validates options for the list.
       #
       # @param options [Hash] The options to be assigned to the list.
       # @return [Hash] The assigned options.

data/lib/onboardable/list/builder.rb

@@ -59,9 +59,9 @@ module Onboardable
       # @return [Hash] The options hash for the builder.
       attr_reader :options
 
-      # Sets the options hash for the builder.
+      # Sets options hash for the builder.
       #
-      # @param options [Hash] The options hash to be set.
+      # @param options [Hash] Options to be set for the builder.
       def options=(options)
         @options = Hash(options).except(STEP_KEY)
       end
@@ -91,7 +91,7 @@ module Onboardable
       #
       # @param name [String] The name of the step to be converted to a Step object.
       # @return [Step] The corresponding Step object.
-      # @raise [StepError] Raises if the specified step name is not present in the steps hash.
+      # @raise [StepError] Raises if the specified step name is not present in steps hash.
       def convert_to_step!(name)
         steps[name] || raise(StepError.new(name, steps.keys))
       end

data/lib/onboardable/step.rb

@@ -16,8 +16,8 @@ module Onboardable
     class << self
       # Attempts to convert a class to a Step object using a specified conversion method.
       #
-      # @param klass [Class] The class to convert to a Step
-      # @return [Step, nil] The converted Step object, or nil if the class does not respond to the conversion method
+      # @param klass [Class] The class to convert to a Step.
+      # @return [Step, nil] The converted Step object, or nil if the class does not respond to the conversion method.
       def try_convert(klass)
         return unless klass.respond_to?(CONVERSION_METHOD)
 
@@ -30,26 +30,26 @@ module Onboardable
 
       # Raises an error for a failed conversion attempt.
       #
-      # @param klass [Class] The class that failed to convert
-      # @raise [StepConversionError] Raises an error for a failed conversion attempt
+      # @param klass [Class] The class that failed to convert.
+      # @raise [StepConversionError] Raises an error for a failed conversion attempt.
       def conversion_error!(klass, step)
         raise StepConversionError.new(klass, step)
       end
     end
 
-    # @return [String] The name of the step
+    # @return [String] The name of the step.
     attr_reader :name
 
-    # @return [Hash] Custom data associated with the step
+    # @return [Hash] Custom data associated with the step.
     attr_reader :data
 
-    # @return [Symbol] The current status of the step
+    # @return [Symbol] The current status of the step.
     attr_reader :status
 
     # Initializes a new Step with a name, optional custom data, and a default status.
     #
-    # @param name [String] The name of the step
-    # @param data [Hash] The custom data associated with the step, defaults to an empty hash
+    # @param name [String] The name of the step.
+    # @param data [Hash] The custom data associated with the step.
     def initialize(name, data = {})
       self.name = name
       self.data = data
@@ -79,23 +79,23 @@ module Onboardable
 
     # Compares this step to another to determine if they are equivalent, based on the step name.
     #
-    # @param other [Step] The step to compare with
-    # @return [Boolean] True if both steps have the same name, false otherwise
+    # @param other [Step] The step to compare with.
+    # @return [Boolean] True if both steps have the same name, false otherwise.
     def ==(other)
       to_str == other.to_str
     end
 
     # Provides a string representation of the step, using its name.
     #
-    # @return [String] The name of the step
+    # @return [String] The name of the step.
     def to_str
       name
     end
 
     # Updates the status of the step based on a specified comparison result.
     #
-    # @param comparison_result [Integer] The result of a comparison with the current step (-1, 0, or 1)
-    # @return [Symbol] The new status of the step
+    # @param comparison_result [Integer] The result of a comparison operation.
+    # @return [Symbol] The new status of the step.
     def update_status!(comparison_result)
       self.status = case comparison_result
                     when -1 then COMPLETED_STATUS
@@ -108,14 +108,14 @@ module Onboardable
 
     # Sets the name of the step, ensuring it is a valid String.
     #
-    # @param name [String] The raw name of the step
+    # @param name [String] The raw name of the step.
     def name=(name)
       @name = String.new(name).freeze
     end
 
     # Sets the status of the step.
     #
-    # @param status [Symbol] The new status of the step
+    # @param status [Symbol] The new status of the step.
     def status=(status)
       STATUSES.include?(status) || raise(StepStatusError.new(status, STATUSES))
 
@@ -124,15 +124,15 @@ module Onboardable
 
     # Sets the custom data for the step, ensuring it is a valid Hash.
     #
-    # @param data [Hash] The raw custom data
+    # @param data [Hash] The raw custom data.
     def data=(data)
       @data = Hash(data).freeze
     end
 
     # Raises an error for an invalid comparison result.
     #
-    # @param comparison_result [Integer] The invalid comparison result
-    # @raise [ComparisonResultError] Raises an error for an invalid comparison result
+    # @param comparison_result [Integer] The invalid comparison result.
+    # @raise [ComparisonResultError] Raises an error for an invalid comparison result.
     def comparison_result_error!(comparison_result)
       raise ComparisonResultError.new(comparison_result, (-1..1).to_a)
     end

data/lib/onboardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onboardable
-  VERSION = '1.3.3'
+  VERSION = '1.5.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.2.0'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.13'
   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-rake', '~> 0.7.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 3.0', '>= 3.0.4'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Artem Skrynnyk
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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
@@ -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.2.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.9
 specification_version: 4
 summary: Streamlines onboarding process integration
 test_files: []