onboardable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f8dab433ffdae729d520f952885f1023821f8174bfcf761d7e8b81ed4970e2f
+  data.tar.gz: a2abc67ae9936358c9742bd5e3c39a98f4a97e134d12ca7ece4773a235296763
+SHA512:
+  metadata.gz: 8f1ec81d701796ba14700f104ba424d73d27dc6dca04b172dad575d3b9b4fb925997caf6491f95400aedb7d7b8d0d8e00ed5b4c24206c88ff72808e22462f625
+  data.tar.gz: 7518e5c2d5713bc2ce3db3c5f50d136c92c328b9eeccc045e9c59c60dbfab4b0d240cbc107e1ddbc0779ca6e36aa64108e7b0eaff17afb975d2f5877fbc03dcd

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0.0
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## [Unreleased]
+
+## [0.1.0] - 2024-03-2
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## 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 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:
+
+* 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
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* 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
+  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 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.
+
+## 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.
+
+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:
+
+### 1. Correction
+
+**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.
+
+### 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.
+
+### 3. Temporary Ban
+
+**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.
+
+### 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.
+
+**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.
+
+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.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in onboardable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    onboardable (0.1.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.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    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-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.4)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    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_json_formatter (0.1.4)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-23
+  x86_64-linux
+
+DEPENDENCIES
+  onboardable!
+  rake (~> 13.2, >= 13.2.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.63, >= 1.63.4)
+  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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Artem Skrynnyk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,187 @@
+# 🚀 Onboardable
+
+![Build](https://img.shields.io/github/actions/workflow/status/dmrAnderson/onboardable/ci.yml)
+![Code Coverage](https://img.shields.io/coverallsCoverage/github/dmrAnderson/onboardable)
+
+The Onboardable gem is a Ruby module designed to simplify and streamline the
+process of managing and navigating through a series of steps or stages within
+an application, typically used for user onboarding workflows. By including
+the Onboardable module in a class, developers can easily define a sequence
+of onboarding steps, handle transitions between these steps, and maintain
+the state of the current step in the sequence.
+
+## 🔌 Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add onboardable
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install onboardable
+```
+
+## ⚙️ Usage
+
+First, ensure that the Onboardable gem is installed and properly set up in your
+project as per the installation guide provided earlier.
+
+### Basic Configuration
+
+1. **Include Onboardable in Your Class**
+
+   Decide which Ruby class should have the onboarding process.
+   For example, if you want to add an onboarding process to a `User`
+   class, you would modify the class as follows:
+
+   ```ruby
+   class User
+     include Onboardable
+   end
+   ```
+
+1. **Define Onboarding Steps**
+
+   You can define the steps involved in the onboarding process using
+   the `has_onboarding` method provided by the gem. Here's an example of
+   how to define a simple onboarding process with custom steps,
+   potentially including specific data for each step:
+
+   ```ruby
+   class User
+     has_onboarding do
+       step 'Create Account', tooltip: 'Minimum 8 characters.'
+       step('Verify Email', Class.new { def self.to_hash = { required: true } })
+       step 'Complete Profile' # This step does not include specific action data
+       step 'Introduction Tour', description: 'Get to know your new workspace!'
+     end
+   end
+   ```
+
+### Using the Onboarding Steps
+
+To enhance the guidance for users on how to navigate and manage the
+onboarding flow using the Onboardable gem, here's a concise guide that
+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
+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.
+
+   ```ruby
+   User.new.onboarding
+   # Initializes the onboarding process for a new user instance
+   ```
+
+1. **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
+   - **Next Step**
+
+      Access the next step without changing the current step to preview
+      what's next or advance to it, updating the current step status.
+
+      ```ruby
+      onboarding.next_step
+      # Returns the next step without changing the current step
+
+      onboarding.next_step!
+      # Advances to the next step, updating the current step
+      ```
+
+   - **Previous Step**
+
+     Similarly, access the previous step to move back without
+     making changes or updates to revert to the previous step.
+
+     ```ruby
+     onboarding.prev_step
+     # Returns the previous step without changing the current step
+
+     onboarding.prev_step!
+     # Reverts to the previous step, updating the current step
+     ```
+
+1. **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
+   onboarding.first_step?
+   # Returns true if the current step is the first
+
+   onboarding.last_step?
+   # Returns true if the current step is the last
+   ```
+
+1. **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 complete tasks associated with the step.
+
+   ```ruby
+   onboarding.current_step
+   # Returns the current step in the onboarding process
+
+   onboarding.current_step.name
+   # Returns the name of the current step
+
+   onboarding.current_step.data
+   # Returns the custom data associated with the step or an empty hash if not specified
+
+   onboarding.current_step.status
+   # Provides the current status or progress of the step
+   ```
+
+1. **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
+   indicate completion or triggering other application logic.
+
+   ```ruby
+   if onboarding.last_step?
+     # Trigger finalization processes like database updates or notifications
+   end
+   ```
+
+By following these steps, developers can effectively manage and facilitate a
+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).
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/dmrAnderson/onboardable>.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [code of conduct](https://github.com/dmrAnderson/onboardable/blob/main/CODE_OF_CONDUCT.md).
+
+## 📃 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 📜 Code of Conduct
+
+Everyone interacting in 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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/onboardable/errors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Onboardable
+  class Error < StandardError; end
+
+  class EmptyListError < Error
+    def initialize
+      super('Cannot be performed because the list is empty.')
+    end
+  end
+
+  class InvalidStepError < Error
+    def initialize(step, expected_steps)
+      super("Invalid step: `#{step}`. Must be one of: `#{expected_steps.join('`, `')}`.")
+    end
+  end
+
+  class InvalidComparisonResultError < Error
+    def initialize(comparison, expected_comparisons)
+      super("Invalid comparison result: `#{comparison}`. Must be one of: #{expected_comparisons.join('`, `')}.")
+    end
+  end
+
+  class LastStepError < Error
+    def initialize(step, expected_steps)
+      super("Currently `#{step}` the last step. Available steps are: `#{expected_steps.join('`, `')}`.")
+    end
+  end
+
+  class FirstStepError < Error
+    def initialize(step, expected_steps)
+      super("Currently `#{step}` the first step. Available steps are: `#{expected_steps.join('`, `')}`.")
+    end
+  end
+end

data/lib/onboardable/list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Onboardable
+  class List
+    include Utils::Navigation
+
+    attr_reader :steps, :current_step
+
+    def initialize(steps, current_step)
+      self.steps = steps
+      self.current_step = current_step
+    end
+
+    private
+
+    def steps=(raw_steps)
+      Array(Array.try_convert(raw_steps)).then do |converted_steps|
+        raise EmptyListError if converted_steps.empty?
+
+        @steps = converted_steps.freeze
+      end
+    end
+
+    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)
+    end
+
+    def step_index!(raw_step)
+      steps.index { |step| step == raw_step } || raise(InvalidStepError.new(raw_step, steps.map(&:to_str)))
+    end
+  end
+end

data/lib/onboardable/list_builder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Onboardable
+  class ListBuilder
+    attr_reader :steps
+    attr_accessor :current_step
+
+    def initialize
+      self.steps = {}
+    end
+
+    def add_step(name, data = {})
+      Step.new(name, data).tap do |step|
+        steps[name] = step
+        self.current_step ||= step
+      end
+    end
+    alias step add_step
+
+    def build!(current_step_name)
+      List.new(steps.values, convert_to_step!(current_step_name))
+    end
+
+    private
+
+    def steps=(raw_steps)
+      @steps = Hash(Hash.try_convert(raw_steps))
+    end
+
+    def convert_to_step!(name)
+      return current_step unless name
+
+      steps[name] || raise(InvalidStepError.new(name, steps.keys))
+    end
+  end
+end

data/lib/onboardable/step.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Onboardable
+  class Step
+    PENDING_STATUS = :pending
+    CURRENT_STATUS = :current
+    COMPLETED_STATUS = :completed
+    DEFAULT_STATUS = PENDING_STATUS
+    STATUSES = [PENDING_STATUS, CURRENT_STATUS, COMPLETED_STATUS].freeze
+
+    attr_reader :name, :data, :status
+
+    def initialize(name, data = {})
+      self.name = name
+      self.data = data
+
+      self.status = DEFAULT_STATUS
+    end
+
+    STATUSES.each do |status_method|
+      define_method :"#{status_method}?" do
+        status == status_method
+      end
+    end
+
+    def ==(other)
+      to_str == other.to_str
+    end
+
+    def to_str
+      name
+    end
+
+    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 InvalidComparisonResultError.new(comparison_result, [-1, 0, 1])
+                    end
+    end
+
+    private
+
+    def name=(raw_name)
+      @name = String.new(String.try_convert(raw_name)).freeze
+    end
+
+    def data=(raw_data)
+      @data = Hash(Hash.try_convert(raw_data)).freeze
+    end
+
+    attr_writer :status
+  end
+end

data/lib/onboardable/utils/navigation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Onboardable
+  module Utils
+    module Navigation
+      def next_step
+        current_index = step_index!(current_step)
+
+        steps[current_index.next]
+      end
+
+      def next_step!
+        self.current_step = next_step || raise(LastStepError.new(current_step, steps))
+      end
+
+      def prev_step
+        current_index = step_index!(current_step)
+
+        current_index.positive? ? steps[current_index.pred] : nil
+      end
+
+      def prev_step!
+        self.current_step = prev_step || raise(FirstStepError.new(current_step, steps))
+      end
+
+      def first_step?
+        current_step == steps.fetch(0)
+      end
+
+      def last_step?
+        current_step == steps.fetch(-1)
+      end
+    end
+  end
+end

data/lib/onboardable/version.rb

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

data/lib/onboardable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'onboardable/utils/navigation'
+require_relative 'onboardable/errors'
+require_relative 'onboardable/list'
+require_relative 'onboardable/list_builder'
+require_relative 'onboardable/step'
+require_relative 'onboardable/version'
+
+module Onboardable
+  def self.included(klass)
+    klass.extend ClassMethods
+    klass.include InstanceMethods
+  end
+
+  module ClassMethods
+    def list_builder
+      @list_builder ||= ListBuilder.new
+    end
+
+    def list_builder=(&block)
+      list_builder.instance_eval(&block)
+    end
+    alias has_onboarding list_builder=
+  end
+
+  module InstanceMethods
+    def onboarding(current_step_name = nil)
+      self.class.list_builder.build!(current_step_name)
+    end
+  end
+end

data/sig/onboardable/list.rbs

@@ -0,0 +1,15 @@
+module Onboardable
+  class List
+    attr_reader steps: Array[Step]
+    attr_reader current_step: Step
+
+    def initialize: (Array[Step], Step) -> instance
+
+    private
+
+    attr_writer steps: Array[Step]
+    attr_writer current_step: Step
+
+    def step_index!: (Step)-> Integer
+  end
+end

data/sig/onboardable/list_builder.rbs

@@ -0,0 +1,19 @@
+module Onboardable
+  class ListBuilder
+    attr_reader steps: Hash[String, Step]
+    attr_accessor current_step: Step
+
+    def initialize: () -> Hash[String, Step]
+
+    def add_step: (String, Hash[Symbol, untyped]) -> Step
+    alias step add_step
+
+    def build!: (String?) -> List
+
+    private
+
+    attr_writer steps: Hash[String, Step]
+
+    def convert_to_step!: (String?) -> Step
+  end
+end

data/sig/onboardable/step.rbs

@@ -0,0 +1,29 @@
+module Onboardable
+  class Step
+    PENDING_STATUS: Symbol
+    CURRENT_STATUS: Symbol
+    COMPLETED_STATUS: Symbol
+    DEFAULT_STATUS: Symbol
+    STATUSES: Array[Symbol]
+
+    attr_reader name: String
+    attr_reader data: Hash[Symbol, untyped]
+    attr_reader status: Symbol
+
+    def initialize: (String, Hash[Symbol, untyped]) -> instance
+
+    def pending?: () -> bool
+    def current?: () -> bool
+    def completed?: () -> bool
+    def ==: (Step) -> bool
+    def to_str: () -> String
+
+    def update_status!: (Integer) -> Symbol
+
+    private
+
+    attr_writer name: String
+    attr_writer data: Hash[Symbol, untyped]
+    attr_writer status: Symbol
+  end
+end

data/sig/onboardable/utils/navigation.rbs

@@ -0,0 +1,12 @@
+module Onboardable
+  module Utils
+    module Navigation
+      def next_step: () -> Step?
+      def next_step!: () -> Step
+      def prev_step: () -> Step?
+      def prev_step!: () -> Step
+      def first_step?: () -> bool
+      def last_step?: () -> bool
+    end
+  end
+end

data/sig/onboardable.rbs

@@ -0,0 +1,15 @@
+module Onboardable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  module ClassMethods
+    attr_reader list_builder: ListBuilder
+
+    def list_builder=: () { () -> ListBuilder } -> Step
+    alias has_onboarding list_builder=
+  end
+
+  module InstanceMethods
+    def  onboarding: (String?) -> List
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: onboardable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Skrynnyk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.63.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.63.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.29.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.29.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: Provides tools for easy setup of custom onboarding to boost engagement.
+email:
+- skrynnyk.artem@coaxsoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onboardable.rb
+- lib/onboardable/errors.rb
+- lib/onboardable/list.rb
+- lib/onboardable/list_builder.rb
+- lib/onboardable/step.rb
+- lib/onboardable/utils/navigation.rb
+- lib/onboardable/version.rb
+- sig/onboardable.rbs
+- sig/onboardable/list.rbs
+- sig/onboardable/list_builder.rbs
+- sig/onboardable/step.rbs
+- sig/onboardable/utils/navigation.rbs
+homepage: https://github.com/dmrAnderson/onboardable
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/dmrAnderson/onboardable/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/dmrAnderson/onboardable/issues
+  documentation_uri: https://github.com/dmrAnderson/onboardable/blob/main/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Streamlines onboarding process integration
+test_files: []