onboardable 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1662a800c2b2c562af504026f4a84bd7a93c895236784e20e53659d7fdcaa3
-  data.tar.gz: 90df600da2944d056ca6d64891a311e4507f1227c2827b44485735451ccc329d
+  metadata.gz: 85ade5264e7e019c70f76d1ad5ccf9713257e596baaae4495eeaaa575146af2e
+  data.tar.gz: 17fb50df5dc091e8f8c1326c2b28dea7657e5f97efcc94d4ba3ab34ea41e242b
 SHA512:
-  metadata.gz: 32e156cde48492f62a29a41b1c382c1be86bd5922b47ddcd32a5ca606127204002f8805da9c1adc087ea005c90a26a20de9081939617d9f623f9b5075fecd113
-  data.tar.gz: 3f8a70a79552741d71c0de140204220e66d70b5a43e5e7ce3c54c15b06900e55e15f5c840812c3463f3c10909bb693788e0aeaeb8039617a026b2fe2cef2bcc0
+  metadata.gz: ea96934ba19039ad48f297314d1021aa9be880cbd324da0d7575ecd351bb61563193099180cf43e2da051053ba2f2cce8df06bc260206e2796ee30b6f383e040
+  data.tar.gz: 35db141793dec0c56ddbd667ac8e1d1bacb33dfcb032a83ace5bcc712ab4f3010504f66b838ac7f0feddd422b87eb494f5b9c2064d15c221babedb17ac941088

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [Unreleased]
 
+## [1.2.1] - 2024-06-01
+
+- Added trusted publisher
+
+## [1.2.0] - 2024-05-25
+
+- Added `#second_step?` method to check if the target step is the second step.
+- Added `#prev_step?` method to check if the target step is the previous step.
+- Added `#current_step?` method to check if the target step is the current step.
+
+## [1.1.1] - 2024-05-21
+
 - Added `onboarding` class method to define the onboarding steps.
 - Added [documentation link](https://rubydoc.info/gems/onboardable) to gemspec.
 

data/CODE_OF_CONDUCT.md

@@ -2,18 +2,25 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to participate in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for
+our community includes:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
 * Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
@@ -24,61 +31,90 @@ Examples of unacceptable behavior include:
 * Public or private harassment
 * Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+* Other conduct that could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in response
+to any behavior that they deem inappropriate, threatening, offensive, or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces and also applies when an
+individual is officially representing the community in public spaces. Examples of
+representing our community includes using an official e-mail address, posting via
+an official social media account, or acting as an appointed representative at an
+online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at skrynnyk.artem@coaxsoft.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
+to the community leaders responsible for enforcement at skrynnyk.artem@coaxsoft.com.
+All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and
+security of the reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior
+deemed unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders,
+providing clarity around the nature of the violation and an explanation
+of why the behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior.
+No interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, for a specified period of time.
+This includes avoiding interactions in community spaces as well as external
+channels like social media. Violating these terms may lead to a temporary or
+permanent ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards,
+including sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time.
+No public or private interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, is
+allowed during this period. Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards,
+including sustained inappropriate behavior, harassment of an individual, or
+aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired
+by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onboardable (1.1.1)
+    onboardable (1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.24.0)
-    parser (3.3.1.0)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
     racc (1.8.0)
@@ -34,7 +34,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -81,11 +81,11 @@ DEPENDENCIES
   onboardable!
   rake (~> 13.2, >= 13.2.1)
   rspec (~> 3.13)
-  rubocop (~> 1.63, >= 1.63.5)
+  rubocop (~> 1.64, >= 1.64.1)
   rubocop-performance (~> 1.21)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.29, >= 2.29.2)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.5.10
+   2.5.11

data/README.md

@@ -18,7 +18,7 @@ Install the gem and add to the application's Gemfile by executing:
 bundle add onboardable
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If the bundler is not being used to manage dependencies, install the gem by executing:
 
 ```shell
 gem install onboardable
@@ -29,36 +29,31 @@ gem install onboardable
 First, ensure that the Onboardable gem is installed and properly set up in your
 project as per the installation guide provided earlier.
 
-### Basic Configuration
-
-   To incorporate an onboarding process into your Ruby User class, start by
-   including the Onboardable module to add onboarding functionality. Then,
-   define the onboarding steps with the has_onboarding method, detailing each
-   step with helpful tooltips and descriptions. Here's how you can set it up:
-
-   ```ruby
-   class User
-     include Onboardable
-
-     has_onboarding do
-       # Use the `step` method to steps with a name and optional data
-       step 'welcome', message: 'Welcome to your new account!'
-       step 'account_setup', task: 'Create credentials'
-       step 'confirmation'
-
-       # Use the `step_from` method to define steps from external providers
-       step_from ExternalStepProvider
-     end
-   end
-
-   # External class for providing a reusable onboarding step
-   class ExternalStepProvider
-     # Define class method to return an onboarding step
-     def self.to_onboarding_step
-       Onboardable::Step.new('external_step', info: 'This is an external step.')
-     end
-   end
-   ```
+### Defining Onboarding Steps
+
+To incorporate an onboarding process into your `User` class, start by
+including the `Onboardable` module to add onboarding functionality. Then,
+define the onboarding steps with the `has_onboarding` method, detailing each
+step with helpful tooltips and descriptions. Here's how you can set it up:
+
+```ruby
+class User
+  include Onboardable
+
+  has_onboarding do
+    step 'welcome', message: 'Welcome to your new account!'
+    step 'account_setup', task: 'Create credentials'
+    step 'confirmation'
+    step_from ExternalStepProvider
+  end
+end
+
+class ExternalStepProvider
+  def self.to_onboarding_step
+    Onboardable::Step.new 'external_step', info: 'This is an external step.'
+  end
+end
+```
 
 ### Using the Onboarding Steps
 
@@ -73,13 +68,36 @@ that allow step navigation and state verification:
 
 1. **Initialize Onboarding Process**
 
-   Instantiate the onboarding process when a user object is created.
-   This sets up the initial step based on the defined onboarding flow.
+   - 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
    ```
 
+   - 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
+
+   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
+    ```
+
+1. **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
+   ```
+
 1. **Navigating Through Steps**
 
    Navigate through the onboarding steps using the navigation methods provided.
@@ -111,8 +129,13 @@ that allow step navigation and state verification:
    to manage UI elements like 'Next' or 'Back' buttons appropriately.
 
    ```ruby
-   onboarding.first_step? # Is the first step?
-   onboarding.last_step?  # Is the last step?
+   step = onboarding.steps.sample # Random step from the list
+
+   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?
    ```
 
 1. **Monitor Progress**
@@ -128,7 +151,7 @@ that allow step navigation and state verification:
 
    Retrieve details about the current step, which can include the name,
    custom data, and status, to display appropriate information or help
-   the user complete tasks associated with the step.
+   the user completes tasks associated with the step.
 
    ```ruby
    onboarding.current_step        # Current step details

data/lib/onboardable/errors.rb

@@ -36,8 +36,8 @@ module Onboardable
   end
 
   # Error raised when an invalid step is encountered within the onboarding process.
-  class InvalidStepError < Error
-    # Initializes a new InvalidStepError with details about the issue.
+  class StepError < Error
+    # Initializes a new StepError with details about the issue.
     #
     # @param step [String] The invalid step that triggered the error.
     # @param expected_steps [Array<String>] The list of valid steps expected at this point.
@@ -78,4 +78,15 @@ module Onboardable
       super("Currently `#{step}` the first step. Available steps are: `#{expected_steps.join('`, `')}`.")
     end
   end
+
+  # Error raised when an invalid status is encountered for a step.
+  class StepStatusError < Error
+    # Initializes a new StepStatusError with details about the issue.
+    #
+    # @param status [Symbol] The invalid status that triggered the error.
+    # @param expected_statuses [Array<Symbol>] The list of valid statuses expected.
+    def initialize(status, expected_statuses)
+      super("Invalid status: `#{status}`. Must be one of: `#{expected_statuses.join('`, `')}`.")
+    end
+  end
 end

data/lib/onboardable/list/base.rb

@@ -6,10 +6,10 @@ module Onboardable
     class Base
       include Navigation
 
-      # @return [Array<Step>] the steps in the list
+      # @return [Array<Step>] The steps in the list.
       attr_reader :steps
 
-      # @return [Step] the current step in the list
+      # @return [Step] The current step in the list.
       attr_reader :current_step
 
       # Initializes a new instance of List with steps and a current step.
@@ -25,7 +25,7 @@ module Onboardable
       #
       # @return [Float] The completion percentage of the onboarding process.
       def progress
-        (step_index!(current_step).to_f / steps.size) * 100
+        (step_index(current_step).to_f / steps.size) * 100
       end
 
       private
@@ -33,6 +33,7 @@ module Onboardable
       # Sets and validates the steps array, ensuring it is an Array of Step objects.
       #
       # @param steps [Array<Step>] The steps to be assigned to the list.
+      # @return [Array<Step>] The assigned steps.
       def steps=(steps)
         @steps = Array(Array.try_convert(steps)).freeze
       end
@@ -40,19 +41,38 @@ module Onboardable
       # Updates the current step and recalibrates the status of all steps in the list.
       #
       # @param raw_current_step [Step] The new current step to set.
+      # @return [Step] The updated current step.
       def current_step=(raw_current_step)
-        current_step_index = step_index!(raw_current_step)
-        steps.each_with_index { |step, index| step.update_status!(index <=> current_step_index) }
-        @current_step = steps.fetch(current_step_index)
+        step_index(raw_current_step).then do |index|
+          update_each_step_status(index)
+          @current_step = steps.fetch(index)
+        end
       end
 
       # Determines the index of a given step in the list, ensuring the step exists.
       #
       # @param raw_step [Step] The step for which the index is requested.
       # @return [Integer] The index of the step within the list.
-      # @raise [InvalidStepError] Raises an error if the step does not exist in the list.
-      def step_index!(raw_step)
-        steps.index { |step| step == raw_step } || raise(InvalidStepError.new(raw_step.to_str, steps.map(&:to_str)))
+      def step_index(raw_step)
+        steps.index { |step| step == raw_step } || step_error!(raw_step)
+      end
+
+      # Updates the status of each step in the list based on the current step index.
+      #
+      # @param current_step_index [Integer] The index of the current step in the list.
+      # @return [Array<Step>] The updated steps array.
+      def update_each_step_status(current_step_index)
+        steps.each_with_index do |step, index|
+          step.update_status!(index <=> current_step_index)
+        end
+      end
+
+      # Raises a StepError indicating an invalid step was encountered.
+      #
+      # @param raw_step [Step] The step that triggered the error.
+      # @raise [StepError] Raises an error if the step does not exist in the list.
+      def step_error!(raw_step)
+        raise StepError.new(raw_step.to_str, steps.map(&:to_str))
       end
     end
   end

data/lib/onboardable/list/builder.rb

@@ -30,20 +30,17 @@ module Onboardable
       # Converts a class to a Step object and adds it to the builder.
       #
       # @param klass [Class] The class to be converted to a step.
-      # @raise [UndefinedMethodError] if the conversion method is not defined for the class.
-      def create_step_from!(klass)
-        Step.try_convert(klass).tap do |step|
-          add_step(step || raise(UndefinedMethodError.new(klass, Step::CONVERSION_METHOD)))
-        end
+      # @return [Step] The converted step.
+      def create_step_from(klass)
+        (Step.try_convert(klass) || undefined_method_error!(klass)).tap { |step| add_step(step) }
       end
-      alias step_from create_step_from!
+      alias step_from create_step_from
 
       # Constructs a new List object from the steps added to the builder.
       #
       # @param current_step_name [String, nil] The name of the step to mark as current in the built list. Can be nil.
       # @return [Base] A new List object initialized with the steps and the specified current step.
-      # @raise [EmptyStepsError] if no steps have been added to the builder.
-      def build!(current_step_name)
+      def build(current_step_name)
         Base.new(convert_to_steps!, convert_to_step!(current_step_name || current_step.name))
       end
 
@@ -52,13 +49,14 @@ module Onboardable
       # Adds a step to the builder.
       #
       # @param step [Step] The step to be added.
+      # @return [Step] The added step.
       def add_step(step)
         step.name.then do |name|
           warn_about_override(name) if steps.key?(name)
           steps[name] = step
         end
 
-        self.current_step ||= step
+        step.tap { self.current_step = step }
       end
 
       # Assigns a hash of steps to the builder.
@@ -73,18 +71,24 @@ module Onboardable
       # @return [Array<Step>] An array of steps.
       # @raise [EmptyStepsError] Raises if there are no steps to convert.
       def convert_to_steps!
-        raise EmptyStepsError if steps.empty?
-
-        steps.values
+        steps.any? ? steps.values : raise(EmptyStepsError)
       end
 
       # Retrieves a Step object from the builder's steps based on the step name.
       #
       # @param name [String] The name of the step to be converted to a Step object.
       # @return [Step] The corresponding Step object.
-      # @raise [InvalidStepError] 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 the steps hash.
       def convert_to_step!(name)
-        steps[name] || raise(InvalidStepError.new(name, steps.keys))
+        steps[name] || raise(StepError.new(name, steps.keys))
+      end
+
+      # Raises an UndefinedMethodError indicating that the conversion method is not defined for the class.
+      #
+      # @param klass [Class] The class that does not have the conversion method defined.
+      # @raise [UndefinedMethodError] Raises an error indicating the missing conversion method.
+      def undefined_method_error!(klass)
+        raise UndefinedMethodError.new(klass, Step::CONVERSION_METHOD)
       end
     end
   end

data/lib/onboardable/list/navigation.rb

@@ -8,30 +8,48 @@ module Onboardable
       #
       # @return [Step, nil] The next step in the list or nil if the current step is the last one.
       def next_step
-        current_index = step_index!(current_step)
+        current_index = step_index(current_step)
         steps[current_index.next]
       end
 
+      # Checks if the specified step is the next step in the onboarding process.
+      #
+      # @param step [Step] The step to check.
+      # @return [Boolean] True if the specified step is the next step, false otherwise.
+      def next_step?(step)
+        next_step == step
+      end
+
       # Moves the current step pointer to the next step in the onboarding process.
       #
-      # @raise [LastStepError] if the current step is the last step and there is no next step to move to.
+      # @return [Step] The next step in the list.
+      # @raise [LastStepError] If the current step is the last step and there is no next step to move to.
       def next_step!
-        self.current_step = next_step || raise(LastStepError.new(current_step, steps.map(&:to_str)))
+        self.current_step = next_step || last_step_error!
       end
 
       # Returns the previous step in the onboarding process.
       #
       # @return [Step, nil] The previous step in the list or nil if the current step is the first one.
       def prev_step
-        current_index = step_index!(current_step)
+        current_index = step_index(current_step)
         current_index.positive? ? steps[current_index.pred] : nil
       end
 
+      # Checks if the specified step is the previous step in the onboarding process.
+      #
+      # @param step [Step] The step to check.
+      # @return [Boolean] True if the specified step is the previous step, false otherwise.
+      def prev_step?(step)
+        prev_step == step
+      end
+
       # Moves the current step pointer to the previous step in the onboarding process.
       #
-      # @raise [FirstStepError] if the current step is the first step and there is no previous step to move to.
+      # @return [Step] The previous step in the list.
+      # @raise [FirstStepError] If the current step is the first step and there is no previous step to move to.
       def prev_step!
-        self.current_step = prev_step || raise(FirstStepError.new(current_step, steps.map(&:to_str)))
+        self.current_step = prev_step || first_step_error!
       end
 
       # Checks if the specified step is the first step in the onboarding process.
@@ -39,7 +57,7 @@ module Onboardable
       # @param step [Step] The step to check (defaults to the current step if not specified).
       # @return [Boolean] True if the specified step is the first step, false otherwise.
       def first_step?(step = current_step)
-        step == first_step
+        first_step == step
       end
 
       # Checks if the specified step is the last step in the onboarding process.
@@ -47,7 +65,7 @@ module Onboardable
       # @param step [Step] The step to check (defaults to the current step if not specified).
       # @return [Boolean] True if the specified step is the last step, false otherwise.
       def last_step?(step = current_step)
-        step == last_step
+        last_step == step
       end
 
       # Retrieves the first step in the onboarding process.
@@ -57,12 +75,36 @@ module Onboardable
         steps.fetch(0)
       end
 
+      # Checks if the specified step is the current step in the onboarding process.
+      #
+      # @param step [Step] The step to check.
+      # @return [Boolean] True if the specified step is the current step, false otherwise.
+      def current_step?(step)
+        current_step == step
+      end
+
       # Retrieves the last step in the onboarding process.
       #
       # @return [Step] The last step in the list.
       def last_step
         steps.fetch(-1)
       end
+
+      private
+
+      # Raises a FirstStepError indicating the current step is the first step in the onboarding process.
+      #
+      # @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))
+      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))
+      end
     end
   end
 end

data/lib/onboardable/step.rb

@@ -70,15 +70,14 @@ module Onboardable
     # 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
     # @raise [ComparisonResultError] if the comparison result is not -1, 0, or 1
     def update_status!(comparison_result)
       self.status = case comparison_result
                     when -1 then COMPLETED_STATUS
                     when 0 then CURRENT_STATUS
                     when 1 then PENDING_STATUS
-                    else
-                      raise ComparisonResultError.new(comparison_result, [-1, 0, 1])
-                    end
+                    else comparison_result_error!(comparison_result); end
     end
 
     private
@@ -90,6 +89,15 @@ module Onboardable
       @name = String.new(String.try_convert(raw_name)).freeze
     end
 
+    # Sets the status of the step.
+    #
+    # @param raw_status [Symbol] the new status of the step
+    def status=(raw_status)
+      STATUSES.include?(raw_status) || raise(StepStatusError.new(raw_status, STATUSES))
+
+      @status = raw_status
+    end
+
     # Sets the custom data for the step, ensuring it is a valid Hash.
     #
     # @param raw_data [Hash] the raw custom data
@@ -97,9 +105,12 @@ module Onboardable
       @data = Hash(Hash.try_convert(raw_data)).freeze
     end
 
-    # Sets the status of the step.
+    # Raises an error for an invalid comparison result.
     #
-    # @param status [Symbol] the new status of the step
-    attr_writer :status
+    # @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
   end
 end

data/lib/onboardable/utils/warnings.rb

@@ -9,7 +9,7 @@ module Onboardable
       # Issues a warning when a step with the same name already exists and will be overridden.
       #
       # @param name [String] The name of the step that will be overridden.
-      # @return [void]
+      # @return [void] Returns nothing.
       def warn_about_override(name)
         warn "Step `#{name}` already exists and will be overridden.", uplevel: 1
       end

data/lib/onboardable/version.rb

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

data/lib/onboardable.rb

@@ -12,8 +12,8 @@ require_relative 'onboardable/version'
 module Onboardable
   # Initializes the Onboardable module when included in a class, extending it with class and instance methods.
   #
-  # @param klass [Module] the class including the Onboardable module
-  # @return [untyped]
+  # @param klass [Module] The class including the Onboardable module
+  # @return [untyped] The class including the Onboardable module.
   def self.included(klass)
     klass.extend ClassMethods
     klass.include InstanceMethods
@@ -23,15 +23,15 @@ module Onboardable
   module ClassMethods
     # Retrieves or initializes a ListBuilder for onboarding steps at the class level.
     #
-    # @return [List::Builder] the ListBuilder associated with the class
+    # @return [List::Builder] The ListBuilder associated with the class.
     def list_builder
       @list_builder ||= List::Builder.new
     end
 
     # Configures onboarding steps via a ListBuilder with a provided block.
     #
-    # @yield [List::Builder] executes block in the context of List::Builder
-    # @return [Step] the current step in the building process
+    # @yield [List::Builder] Executes block in the context of List::Builder.
+    # @return [Step] The current step in the building process.
     def list_builder=(&block)
       list_builder.instance_eval(&block)
     end
@@ -39,10 +39,10 @@ module Onboardable
 
     # Builds the onboarding list and optionally sets the current step.
     #
-    # @param current_step_name [String, nil] the name of the current step, if specified
-    # @return [List::Base] the List built from the class's ListBuilder
+    # @param current_step_name [String, nil] The name of the current step, if specified.
+    # @return [List::Base] The List built from the class's ListBuilder.
     def onboarding(current_step_name = nil)
-      list_builder.build!(current_step_name)
+      list_builder.build(current_step_name)
     end
   end
 
@@ -50,8 +50,8 @@ module Onboardable
   module InstanceMethods
     # Builds the onboarding list and optionally sets the current step.
     #
-    # @param current_step_name [String, nil] the name of the current step, if specified
-    # @return [List::Base] the List built from the class's ListBuilder
+    # @param current_step_name [String, nil] The name of the current step, if specified.
+    # @return [List::Base] The List built from the class's ListBuilder.
     def onboarding(current_step_name = nil)
       self.class.onboarding(current_step_name)
     end

data/onboardable.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'lib/onboardable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'onboardable'
+  spec.version = Onboardable::VERSION
+  spec.authors = ['Artem Skrynnyk']
+  spec.email = ['skrynnyk.artem@coaxsoft.com']
+
+  spec.summary = 'Streamlines onboarding process integration'
+  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.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  spec.metadata['changelog_uri'] = 'https://github.com/dmrAnderson/onboardable/blob/main/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/dmrAnderson/onboardable/issues'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/onboardable'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|spec)/|\.(?:git|rspec|rubocop))})
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # 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-performance', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.29', '>= 2.29.2'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/onboardable/errors.rbs

@@ -14,7 +14,7 @@ module Onboardable
     def initialize: () -> void
   end
 
-  class InvalidStepError < Error
+  class StepError < Error
     def initialize: (String, Array[String]) -> void
   end
 
@@ -29,4 +29,8 @@ module Onboardable
   class FirstStepError < Error
     def initialize: (String, Array[String]) -> void
   end
+
+  class StepStatusError < Error
+    def initialize: (Symbol, Array[Symbol]) -> void
+  end
 end

data/sig/onboardable/list/base.rbs

@@ -13,7 +13,11 @@ module Onboardable
       attr_writer steps: Array[Step]
       attr_writer current_step: Step
 
-      def step_index!: (Step)-> Integer
+      def step_error!: (Step) -> void
+
+      def step_index: (Step)-> Integer
+
+      def update_each_step_status: (Integer) -> Array[Step]
     end
   end
 end

data/sig/onboardable/list/builder.rbs

@@ -9,10 +9,10 @@ module Onboardable
       def create_step: (String, Hash[Symbol, untyped]) -> Step
       alias step create_step
 
-      def create_step_from!: (Class) -> Step
-      alias step_from create_step_from!
+      def create_step_from: (Class) -> Step
+      alias step_from create_step_from
 
-      def build!: (String?) -> Base
+      def build: (String?) -> Base
 
       private
 
@@ -23,6 +23,8 @@ module Onboardable
       def convert_to_step!: (String) -> Step
 
       def convert_to_steps!: -> Array[Step]
+
+      def undefined_method_error!: (Class) -> void
     end
   end
 end

data/sig/onboardable/list/navigation.rbs

@@ -3,12 +3,24 @@ module Onboardable
     module Navigation
       def next_step: () -> Step?
       def next_step!: () -> Step
+      def next_step?: (Step) -> bool
+
       def prev_step: () -> Step?
+      def prev_step?: (Step) -> bool
       def prev_step!: () -> Step
-      def first_step?: (?Step) -> bool
+
       def first_step: -> Step
-      def last_step?: (?Step) -> bool
+      def first_step?: (?Step) -> bool
+
       def last_step: -> Step
+      def last_step?: (?Step) -> bool
+
+      def current_step?: (Step) -> bool
+
+      private
+
+      def first_step_error!: -> void
+      def last_step_error!: -> void
     end
   end
 end

data/sig/onboardable/step.rbs

@@ -28,5 +28,7 @@ module Onboardable
     attr_writer name: String
     attr_writer data: Hash[Symbol, untyped]
     attr_writer status: Symbol
+
+    def comparison_result_error!: (Integer) -> void
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Artem Skrynnyk
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,20 +50,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.63'
+        version: '1.64'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.63.5
+        version: 1.64.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.63'
+        version: '1.64'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.63.5
+        version: 1.64.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -133,8 +133,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -150,6 +148,7 @@ files:
 - lib/onboardable/step.rb
 - lib/onboardable/utils/warnings.rb
 - lib/onboardable/version.rb
+- onboardable.gemspec
 - sig/onboardable.rbs
 - sig/onboardable/errors.rbs
 - sig/onboardable/list/base.rbs
@@ -166,7 +165,7 @@ metadata:
   bug_tracker_uri: https://github.com/dmrAnderson/onboardable/issues
   documentation_uri: https://rubydoc.info/gems/onboardable
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Streamlines onboarding process integration
 test_files: []

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---require spec_helper
---order rand

data/.rubocop.yml

@@ -1,11 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-  - rubocop-rake
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0.0
-
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: gemspec