onboardable 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aeeceb88e43c0cefe319f2fa5e301618b0d4b3a57d34edc507298e752cd52ec
-  data.tar.gz: d29c89bf6488afe8d46f8f948bdc892b40172953ccf8bb3f5cf1d8191b7ad48a
+  metadata.gz: ef1662a800c2b2c562af504026f4a84bd7a93c895236784e20e53659d7fdcaa3
+  data.tar.gz: 90df600da2944d056ca6d64891a311e4507f1227c2827b44485735451ccc329d
 SHA512:
-  metadata.gz: 053a72f2dab37f639b258e74f4f984d688af673dd43c3771b583f7ba46da4e3f9c28d64fb4972642669d266711b1b811c662e16718f2d32929a8b4612dc605bb
-  data.tar.gz: abd9ce8f2775ade5edd1a3b2450f0c873a7e9a5156135c43ed4a80bd5a46a156d94a44dac14b0ade16d32f220b4e14511a15a19ca36af8d71d90425fb4c59179
+  metadata.gz: 32e156cde48492f62a29a41b1c382c1be86bd5922b47ddcd32a5ca606127204002f8805da9c1adc087ea005c90a26a20de9081939617d9f623f9b5075fecd113
+  data.tar.gz: 3f8a70a79552741d71c0de140204220e66d70b5a43e5e7ce3c54c15b06900e55e15f5c840812c3463f3c10909bb693788e0aeaeb8039617a026b2fe2cef2bcc0

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+- 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
 
 - Introduced `step_from` method for adding steps from external sources.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onboardable (1.1.0)
+    onboardable (1.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -41,27 +41,20 @@ project as per the installation guide provided earlier.
      include Onboardable
 
      has_onboarding do
-       # Welcome step with a greeting message.
+       # Use the `step` method to steps with a name and optional data
        step 'welcome', message: 'Welcome to your new account!'
-
-       # Account setup step for credentials.
        step 'account_setup', task: 'Create credentials'
+       step 'confirmation'
 
-       # Profile completion step to add photo and bio.
-       step 'profile_completion', task: 'Add a photo and bio'
-
-       # Confirmation step to verify details before completion.
-       step 'confirmation', prompt: 'Confirm your details'
-
-       # Use `step_from` to add steps from external sources for reusability.
+       # 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 a method to return an onboarding step
-     def self.to_onboardable_step
+     # 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

data/lib/onboardable/list/builder.rb

@@ -40,7 +40,7 @@ module Onboardable
 
       # Constructs a new List object from the steps added to the builder.
       #
-      # @param current_step_name [String] The name of the step to mark as current in the built list.
+      # @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)

data/lib/onboardable/version.rb

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

data/lib/onboardable.rb

@@ -12,7 +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 [Class] the class including the Onboardable module
+  # @param klass [Module] the class including the Onboardable module
+  # @return [untyped]
   def self.included(klass)
     klass.extend ClassMethods
     klass.include InstanceMethods
@@ -30,20 +31,29 @@ module Onboardable
     # 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
     def list_builder=(&block)
       list_builder.instance_eval(&block)
     end
     alias has_onboarding list_builder=
+
+    # 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
+    def onboarding(current_step_name = nil)
+      list_builder.build!(current_step_name)
+    end
   end
 
   # Instance methods for onboarding navigation, added to classes including Onboardable.
   module InstanceMethods
-    # Builds a List from the ListBuilder at the class level, optionally specifying the current step.
+    # 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
     def onboarding(current_step_name = nil)
-      self.class.list_builder.build!(current_step_name)
+      self.class.onboarding(current_step_name)
     end
   end
 end

data/sig/onboardable.rbs

@@ -7,9 +7,11 @@ module Onboardable
 
     def list_builder=: () { () -> List::Builder } -> Step
     alias has_onboarding list_builder=
+
+    def onboarding: (String?) -> List::Base
   end
 
   module InstanceMethods
-    def onboarding: (String?) -> List
+    def onboarding: (String?) -> List::Base
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Artem Skrynnyk
@@ -164,7 +164,7 @@ metadata:
   homepage_uri: https://github.com/dmrAnderson/onboardable
   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
+  documentation_uri: https://rubydoc.info/gems/onboardable
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []