onboardable 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3bc4163adb39b0fa068e08e35df7faebafaa55142f5fa1bfd6ecd0e7a3e3164
-  data.tar.gz: 76bf9040c66add8e3d31d094e62d3cc76b743983aacdd514e5d44d888d99efc8
+  metadata.gz: 9cc331c83492d5c21563a91644b3f2441b38d561ebde4d0690ba68813fadeb60
+  data.tar.gz: 1e55f9c4913a17385c6e2ebe4c7d1dd58921a35b72d786171aa8a28efae09306
 SHA512:
-  metadata.gz: 5987dff9d11eb2935d4f6b70c52f2241c6a059833cb996c97afda95ee5d569a010207e65acfed18dee6a156f38b7b72511f04eaa387bd4a99a33749b23ae8c0c
-  data.tar.gz: 84ba97acc53c39e3e2d217acb2af584134c8171d65ca342d1f11990053334208fc455f934608fb3427532792e7591d2a325156f0479718cd4c35f5162dc918ff
+  metadata.gz: '0456826a6d0b6bea084f95191240ea28776be3b4d8106a2f8055b259d24524055248143e01050be87e6c512084e9ddf7c576c594327ae9b617eb1db5e7068973'
+  data.tar.gz: 2e35337681b26a2c09fa7ba1e7e8b5c505747a5c0144f3116214241c06aca3b04d76b72ce439d14ca717090caa01e95f7f219543784dcdbc07b354b66984686f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## [Unreleased]
+
+- 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
 
 - Enhanced `first_step?` and `last_step?` methods to accept an optional argument,

data/Gemfile.lock

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

data/README.md

@@ -78,14 +78,15 @@ that allow step navigation and state verification:
    This sets up the initial step based on the defined onboarding flow.
 
    ```ruby
-   User.new.onboarding
+   onboarding = 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
+   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
@@ -125,6 +126,16 @@ that allow step navigation and state verification:
    # Returns true if the current step is the last
    ```
 
+1. **Monitor Progress**
+
+   Calculate the progress or completion percentage of the onboarding process
+   to provide users with an indication of how far they have progressed.
+
+   ```ruby
+   onboarding.progress
+   # Returns the percentage of onboarding completion
+   ```
+
 1. **Access Current Step Details**
 
    Retrieve details about the current step, which can include the name,
@@ -152,8 +163,35 @@ that allow step navigation and state verification:
    indicate completion or triggering other application logic.
 
    ```ruby
+   # Direct Check Approach
    if onboarding.last_step?
-     # Trigger finalization processes like database updates or notifications
+     # Implement finalization processes like updating user attributes
+   end
+
+   # Exception Handling Approach
+   begin
+     onboarding.next_step!
+   rescue LastStepError
+     # Implement finalization processes like updating user attributes
+   end
+   ```
+
+1. **Exit the Onboarding Process Early**
+
+   Handle cases where a user decides to discontinue the onboarding
+   by attempting to navigate back from the initial step.
+
+   ```ruby
+   # Direct Check Approach
+   if onboarding.first_step?
+     # Implement cleanup or final actions for an orderly exit
+   end
+
+   # Exception Handling Approach
+   begin
+     onboarding.prev_step!
+   rescue FirstStepError
+     # Implement cleanup or final actions for an orderly exit
    end
    ```
 

data/lib/onboardable/list.rb

@@ -11,6 +11,10 @@ module Onboardable
       self.current_step = current_step
     end
 
+    def progress
+      (step_index!(current_step).to_f / steps.size) * 100
+    end
+
     private
 
     def steps=(raw_steps)

data/lib/onboardable/utils/navigation.rb

@@ -24,11 +24,19 @@ module Onboardable
       end
 
       def first_step?(step = current_step)
-        step == steps.fetch(0)
+        step == first_step
       end
 
       def last_step?(step = current_step)
-        step == steps.fetch(-1)
+        step == last_step
+      end
+
+      def first_step
+        steps.fetch(0)
+      end
+
+      def last_step
+        steps.fetch(-1)
       end
     end
   end

data/lib/onboardable/version.rb

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

data/sig/onboardable/list.rbs

@@ -5,6 +5,8 @@ module Onboardable
 
     def initialize: (Array[Step], Step) -> instance
 
+    def progress: -> Float
+
     private
 
     attr_writer steps: Array[Step]

data/sig/onboardable/utils/navigation.rbs

@@ -6,7 +6,9 @@ module Onboardable
       def prev_step: () -> Step?
       def prev_step!: () -> Step
       def first_step?: (?Step) -> bool
+      def first_step: -> Step
       def last_step?: (?Step) -> bool
+      def last_step: -> Step
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onboardable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Artem Skrynnyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,6 +158,7 @@ homepage: https://github.com/dmrAnderson/onboardable
 licenses:
 - MIT
 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