onboardable 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a5fbb1b0cfbe18fc1ed5060581fa138f726e52d9eac213ccfc4ac58d9c9a41
-  data.tar.gz: 7d7bf373308e6ca7f82afceb7d658ac5e5e960099e68de343b65bb2fdf918279
+  metadata.gz: 8937c95a5e3ca637b90d8ef871d57e1bf7f23e44c52549f66e38cfbd13120602
+  data.tar.gz: '08c904a659fbc0dcead1c41babfcd733b3b5f0c46fd7b1a1279c1479ee9730c1'
 SHA512:
-  metadata.gz: 6aa13416b3f767daeab45c7e4c5fa48a5895eaf9929da9eab25848c5956c805f2a193aa7d78e9b7e2fc7721b9e53618b10705f5f73adadab549ed14d8253e4b5
-  data.tar.gz: 828fe6ada70d330175d6e71eaf6b4b7506e1f1fb9e829f4a2a82fbf66692cd3de14388667c5ebff8779420038d92ef5b519f0cae7d8c97b43cf2a490fed0111e
+  metadata.gz: e30650b2b899483742c4d98b09250a38428ae3e5d476c435178575bc44d767c0d397cbadb55a78300ca43b258bd72ca8c917e0175283ce49210c2d85d6aefc6c
+  data.tar.gz: 7625b9d924d5c477028721e87324437c337e91cfc3ef77da97545b55980f948fd7d380d48cffbd7b4577f2fac4e71f05621fc53cbb5409b5389786e402741657

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [1.3.2] - 2024-07-10
+
+- Added adjustments to rbs files to improve type-checking.
+
 ## [1.3.1] - 2024-06-10
 
 - Fixed the issue with the custom formula calculation.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onboardable (1.3.1)
+    onboardable (1.3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -12,14 +12,14 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.25.1)
-    parser (3.3.2.0)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
     racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.2.9)
+    rexml (3.3.1)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -27,7 +27,7 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
@@ -47,22 +47,13 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.0)
-      rubocop (~> 1.41)
-    rubocop-performance (1.21.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 (2.31.0)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.0)
-      rubocop (~> 1.40)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -82,10 +73,10 @@ DEPENDENCIES
   rake (~> 13.2, >= 13.2.1)
   rspec (~> 3.13)
   rubocop (~> 1.64, >= 1.64.1)
-  rubocop-performance (~> 1.21)
+  rubocop-performance (~> 1.21, >= 1.21.1)
   rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 2.31)
+  rubocop-rspec (~> 3.0, >= 3.0.2)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.5.11
+   2.5.15

data/lib/onboardable/errors.rb

@@ -9,7 +9,7 @@ module Onboardable
     # Initializes a new instance of UndefinedMethodError.
     #
     # @param klass [Class] The class that does not have the method defined.
-    # @param method [Symbol, String] The name of the method that is not defined.
+    # @param method [Symbol] The method that was called on the class.
     def initialize(klass, method)
       super("Method `#{method}` is not defined for `#{klass}`.")
     end
@@ -20,7 +20,7 @@ module Onboardable
     # Initializes a new instance of StepConversionError.
     #
     # @param klass [Class] The class that failed to convert.
-    # @param step [Object] The object returned by the failed conversion.
+    # @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}).")
     end

data/lib/onboardable/list/base.rb

@@ -49,10 +49,10 @@ 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.
+      # @param current_step [Step] The new current step to set.
       # @return [Step] The updated current step.
-      def current_step=(raw_current_step)
-        step_index(raw_current_step).then do |index|
+      def current_step=(current_step)
+        step_index(current_step).then do |index|
           update_each_step_status(index)
           @current_step = steps.fetch(index)
         end
@@ -68,10 +68,10 @@ module Onboardable
 
       # 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.
+      # @param step [Step] The step for which the index is requested.
       # @return [Integer] The index of the step within the list.
-      def step_index(raw_step)
-        steps.index { |step| step == raw_step } || step_error!(raw_step)
+      def step_index(step)
+        steps.index { |item| item == step } || step_error!(step)
       end
 
       # Updates the status of each step in the list based on the current step index.
@@ -86,10 +86,10 @@ module Onboardable
 
       # Raises a StepError indicating an invalid step was encountered.
       #
-      # @param raw_step [Step] The step that triggered the error.
+      # @param 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))
+      def step_error!(step)
+        raise StepError.new(step.to_str, steps.map(&:to_str))
       end
     end
   end

data/lib/onboardable/list/navigation.rb

@@ -23,7 +23,6 @@ module Onboardable
       # Moves the current step pointer to the next step in the onboarding process.
       #
       # @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 || last_step_error!
       end
@@ -47,7 +46,6 @@ module Onboardable
       # Moves the current step pointer to the previous step in the onboarding process.
       #
       # @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 || first_step_error!
       end

data/lib/onboardable/step.rb

@@ -56,14 +56,25 @@ module Onboardable
       self.status = DEFAULT_STATUS
     end
 
-    STATUSES.each do |status_method|
-      # @!method {status_method}?
-      # Checks if the step is in a specific status.
-      #
-      # @return [Boolean] True if the step is currently in the {status_method} status, false otherwise.
-      define_method :"#{status_method}?" do
-        status == status_method
-      end
+    # Checks if the step is in the pending status.
+    #
+    # @return [Boolean] True if the step is currently in the pending status, false otherwise.
+    def pending?
+      status == PENDING_STATUS
+    end
+
+    # Checks if the step is in the current status.
+    #
+    # @return [Boolean] True if the step is currently in the current status, false otherwise.
+    def current?
+      status == CURRENT_STATUS
+    end
+
+    # Checks if the step is in the completed status.
+    #
+    # @return [Boolean] True if the step is currently in the completed status, false otherwise.
+    def completed?
+      status == COMPLETED_STATUS
     end
 
     # Compares this step to another to determine if they are equivalent, based on the step name.
@@ -97,25 +108,25 @@ module Onboardable
 
     # Sets the name of the step, ensuring it is a valid String.
     #
-    # @param raw_name [String] The raw name of the step
-    def name=(raw_name)
-      @name = String.new(raw_name).freeze
+    # @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 raw_status [Symbol] The new status of the step
-    def status=(raw_status)
-      STATUSES.include?(raw_status) || raise(StepStatusError.new(raw_status, STATUSES))
+    # @param status [Symbol] The new status of the step
+    def status=(status)
+      STATUSES.include?(status) || raise(StepStatusError.new(status, STATUSES))
 
-      @status = raw_status
+      @status = status
     end
 
     # Sets the custom data for the step, ensuring it is a valid Hash.
     #
-    # @param raw_data [Hash] The raw custom data
-    def data=(raw_data)
-      @data = Hash(raw_data).freeze
+    # @param data [Hash] The raw custom data
+    def data=(data)
+      @data = Hash(data).freeze
     end
 
     # Raises an error for an invalid comparison result.

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] Returns nothing.
+      # @return [nil]
       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.3.1'
+  VERSION = '1.3.2'
 end

data/onboardable.gemspec

@@ -42,9 +42,9 @@ Gem::Specification.new do |spec|
   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-performance', '~> 1.21', '>= 1.21.1'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.31'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.0', '>= 3.0.2'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/sig/onboardable/errors.rbs

@@ -3,34 +3,34 @@ module Onboardable
   end
 
   class UndefinedMethodError < Error
-    def initialize: (Class, Symbol | String) -> void
+    def initialize: (Class klass, Symbol method) -> untyped
   end
 
   class StepConversionError < Error
-    def initialize: (Class, untyped) -> void
+    def initialize: (Class klass, untyped step) -> untyped
   end
 
   class EmptyStepsError < Error
-    def initialize: () -> void
+    def initialize: () -> untyped
   end
 
   class StepError < Error
-    def initialize: (String, Array[String]) -> void
+    def initialize: (String step, Array[String] expected_steps) -> untyped
   end
 
   class ComparisonResultError < Error
-    def initialize: (Integer, Array[Integer]) -> void
+    def initialize: (Integer comparison, Array[Integer] expected_comparisons) -> untyped
   end
 
   class LastStepError < Error
-    def initialize: (String, Array[String]) -> void
+    def initialize: (Symbol step, Array[Symbol] expected_steps) -> untyped
   end
 
   class FirstStepError < Error
-    def initialize: (String, Array[String]) -> void
+    def initialize: (Symbol step, Array[Symbol] expected_steps) -> untyped
   end
 
   class StepStatusError < Error
-    def initialize: (Symbol, Array[Symbol]) -> void
+    def initialize: (Symbol status, Array[Symbol] expected_statuses) -> untyped
   end
 end

data/sig/onboardable/list/base.rbs

@@ -1,27 +1,33 @@
 module Onboardable
   module List
     class Base
-      PROGRESS_CALCULATION: Proc
+      include Navigation
+
+      PROGRESS_CALCULATION: untyped
 
       attr_reader steps: Array[Step]
+
       attr_reader current_step: Step
 
-      def initialize: (Array[Step], Step) -> instance
+      def initialize: (Array[Step] steps, Step current_step, ?Hash[Symbol, untyped] options) -> untyped
 
-      def progress: (Proc?) -> Float
+      def progress: (?Proc? progress_calculation) -> Float
 
       private
 
+      attr_reader options: Hash[Symbol, untyped]
+
       attr_writer steps: Array[Step]
+
       attr_writer current_step: Step
 
-      attr_accessor options: Hash[Symbol, untyped]
+      attr_writer options: Hash[Symbol, untyped]
 
-      def step_error!: (Step) -> void
+      def step_index: (Step step) -> Integer
 
-      def step_index: (Step)-> Integer
+      def update_each_step_status: (Integer current_step_index) -> Array[Step]
 
-      def update_each_step_status: (Integer) -> Array[Step]
+      def step_error!: (Step step) -> untyped
     end
   end
 end

data/sig/onboardable/list/builder.rbs

@@ -1,32 +1,37 @@
 module Onboardable
   module List
     class Builder
+      include Utils::Warnings
+
       STEP_KEY: Symbol
 
-      attr_reader steps: Hash[String, Step]
+      def steps: () -> Hash[String, untyped]
+
       attr_accessor current_step: Step
 
-      def initialize: (Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+      def initialize: (?Hash[Symbol, untyped] options) -> untyped
+
+      def create_step: (String name, ?Hash[Symbol, untyped] data) -> Step
 
-      def create_step: (String, Hash[Symbol, untyped]) -> Step
       alias step create_step
 
-      def create_step_from: (Class) -> Step
+      def create_step_from: (Class klass) -> Step
+
       alias step_from create_step_from
 
-      def build: (String?) -> Base
+      def build: (?String? current_step_name) -> Base
 
       private
 
       attr_accessor options: Hash[Symbol, untyped]
 
-      def add_step: (Step) -> Step
+      def add_step: (Step step) -> Step
 
-      def convert_to_step!: (String) -> Step
+      def convert_to_steps!: () -> Array[Step]
 
-      def convert_to_steps!: -> Array[Step]
+      def convert_to_step!: (String name) -> Step
 
-      def undefined_method_error!: (Class) -> void
+      def undefined_method_error!: (Class klass) -> untyped
     end
   end
 end

data/sig/onboardable/list/navigation.rbs

@@ -1,26 +1,33 @@
 module Onboardable
   module List
     module Navigation
-      def next_step: () -> Step?
+      def next_step: () -> (Step | nil)
+
+      def next_step?: (Step step) -> bool
+
       def next_step!: () -> Step
-      def next_step?: (Step) -> bool
 
-      def prev_step: () -> Step?
-      def prev_step?: (Step) -> bool
+      def prev_step: () -> (Step | nil)
+
+      def prev_step?: (Step step) -> bool
+
       def prev_step!: () -> Step
 
-      def first_step: -> Step
-      def first_step?: (?Step) -> bool
+      def first_step?: (?Step step) -> bool
 
-      def last_step: -> Step
-      def last_step?: (?Step) -> bool
+      def last_step?: (?Step step) -> bool
 
-      def current_step?: (Step) -> bool
+      def first_step: () -> Step
+
+      def current_step?: (Step step) -> bool
+
+      def last_step: () -> Step
 
       private
 
-      def first_step_error!: -> void
-      def last_step_error!: -> void
+      def first_step_error!: () -> untyped
+
+      def last_step_error!: () -> untyped
     end
   end
-end
+end

data/sig/onboardable/step.rbs

@@ -1,36 +1,53 @@
 module Onboardable
   class Step
     CONVERSION_METHOD: Symbol
+
     PENDING_STATUS: Symbol
+
     CURRENT_STATUS: Symbol
+
     COMPLETED_STATUS: Symbol
+
     DEFAULT_STATUS: Symbol
-    STATUSES: Array[Symbol]
 
-    def self.try_convert: (Class) -> Step?
+    STATUSES: ::Array[Symbol]
 
-    def self.conversion_error!: (Class, untyped) -> void
+    def self.try_convert: (Class klass) -> (Step | nil)
+
+    private
+
+    def self.conversion_error!: (Class klass, Step step) -> void
+
+    public
 
     attr_reader name: String
+
     attr_reader data: Hash[Symbol, untyped]
+
     attr_reader status: Symbol
 
-    def initialize: (String, Hash[Symbol, untyped]) -> instance
+    def initialize: (String name, ?Hash[Symbol, untyped] data) -> untyped
 
     def pending?: () -> bool
+
     def current?: () -> bool
+
     def completed?: () -> bool
-    def ==: (Step) -> bool
+
+    def ==: (Step other) -> bool
+
     def to_str: () -> String
 
-    def update_status!: (Integer) -> Symbol
+    def update_status!: (Integer comparison_result) -> Symbol
 
     private
 
     attr_writer name: String
-    attr_writer data: Hash[Symbol, untyped]
+
     attr_writer status: Symbol
 
-    def comparison_result_error!: (Integer) -> void
+    attr_writer data: Hash[Symbol, untyped]
+
+    def comparison_result_error!: (Integer comparison_result) -> untyped
   end
 end

data/sig/onboardable/utils/warnings.rbs

@@ -3,7 +3,7 @@ module Onboardable
     module Warnings
       private
 
-      def warn_about_override: (Hash[String, Step]) -> void
+      def warn_about_override: (String name) -> nil
     end
   end
 end

data/sig/onboardable.rbs

@@ -1,17 +1,19 @@
 module Onboardable
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  def self.included: (Class klass) -> untyped
 
   module ClassMethods
     attr_accessor list_builder: List::Builder
 
-    def onboarding=: (Hash[Symbol, untyped]) { () -> List::Builder } -> Step
+    def onboarding=: (?Hash[Symbol, untyped] options) { () -> List::Builder } -> Step
+
     alias has_onboarding onboarding=
 
-    def onboarding: (String?) -> List::Base
+    def onboarding: (?String? current_step_name) -> List::Base
   end
 
   module InstanceMethods
-    def onboarding: (String?) -> List::Base
+    def onboarding: (?String? current_step_name) -> List::Base
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Artem Skrynnyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -78,6 +81,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +104,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.31'
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.31'
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Streamlines onboarding process integration