onboardable 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f0c447b6d3593da8e840bc4964a61fb7078df687a13e0d87bf846d51c17838
-  data.tar.gz: 5b0861f3ff6b98ed383d2497e4bca47bee0893ab98124e3bfd680c3b1e119dac
+  metadata.gz: 8f24682a34d8f84cf2eba4bdf9e69734bfa4788c7937d1b8b90b05456985b27b
+  data.tar.gz: c18c2ec8f27809b239c7ca8059522923bc511b3aebafaf732cc611244549d463
 SHA512:
-  metadata.gz: 15c8e34a8d136da36ec0a8d968f6140123c5d05cece765e60ed1f95267416bf10373e4ea79159b84095e78485a691f3906a4897c15cb4b85ce377e3337c87b51
-  data.tar.gz: dfdb3df40595dd49dc2860494bb9da050c8124f8e936f17ddd8c52a00626ac7576270d1cb4f793591f0d79277513079975d370a64c44504f5eda8151ed931944
+  metadata.gz: e443300f42828683e075ec62377ff4d3d43663c8c4e8609f9f17baf89b06b71c84fdda673939fa4fd86f487f192b7c6d65028b389cd790f3c196f6d8ad62e0a8
+  data.tar.gz: b8f14acd58e53891ef6de0f0c0b65181a354904ff27fd77940072641c680980ba99539012b12add6ae4395f42087416ed9f174b04168c12df6a0483414fd4f22

data/CHANGELOG.md

@@ -1,70 +1,72 @@
 # CHANGELOG
 
-## [Unreleased]
+## 1.6.0
 
-## [1.5.0] - 2025-08-01
+- Add support for Ruby 4.0.
+
+## 1.5.0
 
 - Drop support for Ruby 3.1.
 - Update development dependencies to their latest versions.
 
-## [1.4.0] - 2025-04-01
+## 1.4.0
 
 - Add support for Ruby 3.4.
 - Drop support for Ruby 3.0.
 
-## [1.3.3] - 2024-08-16
+## 1.3.3
 
 - Updated rbs files to improve type-checking.
 - Added github-actions package ecosystem to the development workflow.
 
-## [1.3.2] - 2024-07-10
+## 1.3.2
 
 - Added adjustments to rbs files to improve type-checking.
 
-## [1.3.1] - 2024-06-10
+## 1.3.1
 
 - Fixed the issue with the custom formula calculation.
 
-## [1.3.0] - 2024-06-10
+## 1.3.0
 
-- Added option to calculate onboarding progress using a custom formula.
+- Added an option to calculate onboarding progress using a custom formula.
 
-## [1.2.2] - 2024-06-03
+## 1.2.2
 
 - Fixed the issue with the default `#current_step` method.
 
-## [1.2.1] - 2024-06-01
+## 1.2.1
 
 - Added trusted publisher
 
-## [1.2.0] - 2024-05-25
+## 1.2.0
 
 - 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
+## 1.1.1
 
 - Added `onboarding` class method to define the onboarding steps.
 - Added [documentation link](https://rubydoc.info/gems/onboardable) to gemspec.
 
-## [1.1.0] - 2024-05-21
+## 1.1.0
 
 - Introduced `step_from` method for adding steps from external sources.
 - Added warn_about_override method to alert on step overrides.
 - Added YARD documentation to the project for improved code documentation.
 
-## [1.0.1] - 2024-05-09
+## 1.0.1
 
 - Added `first_step` and `last_step` methods to easily access
   the boundaries of step lists.
 - Added `progress` method for calculating onboarding completion percentage.
 
-## [1.0.0] - 2024-05-08
+## 1.0.0
 
 - Enhanced `first_step?` and `last_step?` methods to accept an optional argument,
   improving flexibility by allowing checks against any specified step.
 
-## [0.1.0] - 2024-05-07
+## 0.1.0
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onboardable (1.5.0)
+    onboardable (1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -9,32 +9,32 @@ GEM
     ast (2.4.3)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    json (2.13.2)
+    json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
+    prism (1.7.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
-    regexp_parser (2.10.0)
-    rspec (3.13.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
-    rubocop (1.79.1)
+    rspec-support (3.13.6)
+    rubocop (1.82.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -42,22 +42,22 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.46.0, < 2.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.46.0)
+    rubocop-ast (1.48.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-performance (1.25.0)
+    rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
+    rubocop-rspec (3.8.0)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -65,12 +65,17 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+    yard-lint (1.3.0)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.4)
 
 PLATFORMS
-  x86_64-darwin-24
+  x86_64-darwin-25
   x86_64-linux
 
 DEPENDENCIES
@@ -82,6 +87,7 @@ DEPENDENCIES
   rubocop-rake (~> 0.7.1)
   rubocop-rspec (~> 3.0, >= 3.0.4)
   simplecov (~> 0.22.0)
+  yard-lint (~> 1.2, >= 1.2.3)
 
 BUNDLED WITH
-   2.7.1
+  4.0.3

data/README.md

@@ -251,4 +251,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## 📜 Code of Conduct
 
 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).
+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

@@ -20,7 +20,7 @@ module Onboardable
     # Initializes a new instance of StepConversionError.
     #
     # @param klass [Class] The class that failed to convert.
-    # @param step [unknown] The object that was attempted to be converted to a Step.
+    # @param step [Object] 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}).")
     end

data/lib/onboardable/list/base.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 module Onboardable
+  # The List module encapsulates functionality for managing a sequence of onboarding steps.
   module List
     # The List class manages a sequence of steps in an onboarding process, tracking progress and current state.
     class Base
       include Navigation
 
+      # Default calculation for onboarding progress as a percentage.
       PROGRESS_CALCULATION = ->(step_index, steps_size) { (step_index.to_f / steps_size) * 100 }
 
       # @return [Array<Step>] The steps in the list.
@@ -19,6 +21,8 @@ module Onboardable
       # @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] Optional parameters for configuring the list.
+      # @option options [Proc] :progress_calculation A custom calculation for progress percentage.
+      #   Receives step_index and steps_size as arguments and returns a Float.
       def initialize(steps, current_step, options = {})
         self.steps = steps
         self.current_step = current_step
@@ -61,6 +65,8 @@ module Onboardable
       # Sets and validates options for the list.
       #
       # @param options [Hash] The options to be assigned to the list.
+      # @option options [Proc] :progress_calculation A custom calculation for progress percentage.
+      #   Receives step_index and steps_size as arguments and returns a Float.
       # @return [Hash] The assigned options.
       def options=(options)
         @options = Hash(options).transform_keys(&:to_sym).freeze

data/lib/onboardable/list/builder.rb

@@ -6,6 +6,7 @@ module Onboardable
     class Builder
       include Utils::Warnings
 
+      # Key used to store steps in the options hash.
       STEP_KEY = :steps
 
       # Stores the steps added to the builder.
@@ -19,6 +20,10 @@ module Onboardable
       attr_accessor :current_step
 
       # Initializes a new instance of ListBuilder.
+      #
+      # @param options [Hash] Options to be set for the builder.
+      # @option options [Proc] :progress_calculation A custom calculation for progress percentage.
+      #   Receives step_index and steps_size as arguments and returns a Float.
       def initialize(options = {})
         self.options = options
       end
@@ -62,6 +67,8 @@ module Onboardable
       # Sets options hash for the builder.
       #
       # @param options [Hash] Options to be set for the builder.
+      # @option options [Proc] :progress_calculation A custom calculation for progress percentage.
+      #   Receives step_index and steps_size as arguments and returns a Float.
       def options=(options)
         @options = Hash(options).except(STEP_KEY)
       end

data/lib/onboardable/step.rb

@@ -3,14 +3,20 @@
 module Onboardable
   # Represents a single step within an onboarding process, including its status and associated data.
   class Step
+    # Method name used for converting a class to a Step object.
     CONVERSION_METHOD = :to_onboarding_step
 
+    # The step is pending and has not yet been started.
     PENDING_STATUS = :pending
+    # The step is currently in progress.
     CURRENT_STATUS = :current
+    # The step has been completed.
     COMPLETED_STATUS = :completed
 
+    # The default status for a new step.
     DEFAULT_STATUS = PENDING_STATUS
 
+    # All valid statuses for a step.
     STATUSES = [PENDING_STATUS, CURRENT_STATUS, COMPLETED_STATUS].freeze
 
     class << self
@@ -31,6 +37,7 @@ module Onboardable
       # Raises an error for a failed conversion attempt.
       #
       # @param klass [Class] The class that failed to convert.
+      # @param step [Object] The invalid object returned from the conversion method.
       # @raise [StepConversionError] Raises an error for a failed conversion attempt.
       def conversion_error!(klass, step)
         raise StepConversionError.new(klass, step)
@@ -101,7 +108,8 @@ module Onboardable
                     when -1 then COMPLETED_STATUS
                     when 0 then CURRENT_STATUS
                     when 1 then PENDING_STATUS
-                    else comparison_result_error!(comparison_result); end
+                    else comparison_result_error!(comparison_result)
+                    end
     end
 
     private

data/lib/onboardable/utils/warnings.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Onboardable
+  # The Utils module contains utility classes and modules for the Onboardable namespace.
   module Utils
     # The Warnings module provides utility methods for issuing warnings.
     module Warnings

data/lib/onboardable/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Onboardable
-  VERSION = '1.5.0'
+  # The version of the Onboardable gem.
+  VERSION = '1.6.0'
 end

data/lib/onboardable.rb

@@ -13,7 +13,7 @@ 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] The class including the Onboardable module.
+  # @return [void]
   def self.included(klass)
     klass.extend ClassMethods
     klass.include InstanceMethods
@@ -27,6 +27,8 @@ module Onboardable
     # Configures onboarding steps via a ListBuilder with a provided block.
     #
     # @param options [Hash] Optional configuration options for the ListBuilder.
+    # @option options [Proc] :progress_calculation A custom calculation for progress percentage.
+    #   Receives step_index and steps_size as arguments and returns a Float.
     # @yield [List::Builder] Executes block in the context of List::Builder.
     # @return [Step] The current step in the building process.
     def onboarding=(options = {}, &)

data/onboardable.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   # 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))})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|spec)/|\.(?:git|rspec|rubocop|yard))})
     end
   end
 
@@ -46,6 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0.7.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 3.0', '>= 3.0.4'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
+  spec.add_development_dependency 'yard-lint', '~> 1.2', '>= 1.2.3'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/sig/onboardable/errors.rbs

@@ -7,7 +7,7 @@ module Onboardable
   end
 
   class StepConversionError < Error
-    def initialize: (Class klass, untyped step) -> untyped
+    def initialize: (Class klass, Object step) -> untyped
   end
 
   class EmptyStepsError < Error

data/sig/onboardable.rbs

@@ -1,7 +1,7 @@
 module Onboardable
   VERSION: String
 
-  def self.included: (Class klass) -> untyped
+  def self.included: (Module klass) -> void
 
   module ClassMethods
     attr_accessor list_builder: List::Builder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Artem Skrynnyk
@@ -131,6 +131,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: yard-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 description: Provides tools for easy setup of custom onboarding to boost engagement.
 email:
 - skrynnyk.artem@coaxsoft.com
@@ -184,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Streamlines onboarding process integration
 test_files: []