rails_settlement 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59429b5aef8ee3fb19702c66a17ddba2240017bfa215ef0799483ee076f2b64c
-  data.tar.gz: 3d153d543d3010e5c067eb9d79bf8c3feb188c6b1c82ec7ca41dee1e6ebba0e1
+  metadata.gz: 5f6997e50cad74b6bfb65514e1efc59a454db83eca5d903fed3cee4ae35326aa
+  data.tar.gz: 0f372b19be2e0f3614c9c55b01394d38b6aebb915bf9905857b6cc5c746266a5
 SHA512:
-  metadata.gz: 812f2ab5b2974f245af355d5cfdb68b71b1069437c0e5a2e70911f01a44c890acec96bd25aa1d9b031e756090aba9a1961eba113a6b7d17db3aac742fb62d43f
-  data.tar.gz: f8bb4d5f49e407dda8ee652651a03d3bbcb78fcd1f0173d17196635638c55203bacde0ee84f4dcf392c06faa188b525a27469a8be24c850b9344ddc0148ba31a
+  metadata.gz: 8bf231039431dbf2c302aab711be354ef8373cbf9570cf053d32100e3f3660b2399a9067f8be965c2dd553b303f4333a5fe06fe2ebe031ed12e54523bce86b78
+  data.tar.gz: 881deb50b91a6628596d9767a55ad4e57a15cf6055a8452d1a2275f0bd051b84eba7aa8bf429629e306fdd4b79073112a939abb73460f350c8b1a55262b0df1c

data/README.md

@@ -9,31 +9,44 @@ Add to your Gemfile:
 gem 'rails_settlement'
 ```
 
-## How to User
+## How to Use
 
-Let's suppose you want to fetch a `User` before performing a controller action:
+Suppose you need to fetch a User before executing a controller action:
 
 ```ruby
 class UsersController < ApplicationController
-  set_user only: %i[show] # Internally, it's just a before_action callback, so you can pass options to the callback directly.
-  set_user! only: %i[edit] # Using this method with a bang (!) would trigger an ActiveRecord::RecordNotFound Exception.
+  set_user only: %i[show] # It's essentially a before_action callback, allowing you to pass options directly.
 
-  ...
+  # Using the bang (!) with this method triggers an ActiveRecord::RecordNotFound Exception.
+  set_user! only: %i[edit]
+
+  # You can also define a scope with the `scope_to` option. It can be either a string/symbol or an Array of string/symbols.
+  # This fetches the user after chaining all the scopes together.
+  # set_user scope_to: :is_active, only: %i[show] #=> User.is_active.find_by
+  # set_user! scope_to: %i[is_active is_admin] #=> User.is_active.is_admin.find_by
+
+  def show
+    do_something with: user # You also have an attribute reader with the same name available if the object is found. If not, it defaults to nil (unless a bang method is used, in which case an error is raised!)
+  end
 end
 ```
 
 ```ruby
 class User < ApplicationRecord
-  # This method would be used internally by set_user to fetch correct param (using params_key), and to send a key to #find_by (using model_key)
-  # This can be also overridden on the fly by passing any of these two keys (or both!) in the controller directly
+  scope :is_active, -> { where(is_active: true) }
+
+  # This method is used internally by `set_user` to fetch the correct param (using `params_key`) and to send a key to `find_by` (using `model_key`).
+  # You can override this on the fly by passing any of these two keys (or both!) in the controller directly.
   # Ex: set_user params_key: :user_username, only: %i[index], ...
+  # You can also pass a `scope_to` option in the hash below.
   def self.settable_params
     { params_key: :username, model_key: :username }
   end
 end
 ```
 
-This way you can use any model instead of a `User`. Just follow the naming convention `set_[model_name_in_snake_case]!`.
-P.S: This should not work with STI or any Namespaced models. If you have a way to make them work, please raise a pull request!
+This approach allows you to use any model instead of a `User`. Just follow the naming convention set_[model_name_in_snake_case]!.
+
+Note: This implementation does not support STI or any Namespaced models. If you have a solution to make them work, please submit a pull request!
 
 That's about it!

data/lib/rails_settlement/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSettlement
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/rails_settlement.rb

@@ -12,16 +12,14 @@ module RailsSettlement
 
   class_methods do
     def method_missing(method, **options)
-      super unless (match_data = method.to_s.match(SETTABLE_REGEX))
+      super unless (matches = method.to_s.match(SETTABLE_REGEX))
 
-      variable = match_data[:object]
-      raisable = match_data[:raisable].present?
-
-      klass = variable.classify.constantize
-
-      param_options = (klass.try(:settable_params) || {}).merge(options.extract!(:model_key, :params_key))
+      variable, raisable = _handle_match_data(matches)
+      klass = _klass(variable)
+      param_options = _param_options(klass: klass, options: options)
 
       before_action(**options) do
+        klass = _handle_scopes(klass, param_options[:scope_to])
         instance_variable_set("@#{variable}", klass.find_by(param_options[:model_key] => params[param_options[:params_key]]))
         raise ActiveRecord::RecordNotFound if raisable && instance_variable_get("@#{variable}").nil?
       end
@@ -32,9 +30,32 @@ module RailsSettlement
     def respond_to_missing?(method, include_private = false)
       super || method.to_s.match?(SETTABLE_REGEX)
     end
+
+    private
+
+    def _handle_match_data(match_data)
+      [match_data[:object], match_data[:raisable].present?]
+    end
+
+    def _klass(variable)
+      variable.classify.constantize
+    end
+
+    def _param_options(klass:, options:)
+      (klass.try(:settable_params) || {}).merge(options.extract!(:model_key, :params_key, :scope_to))
+    end
+  end
+
+  def _handle_scopes(klass, scopes)
+    return klass if scopes.blank?
+
+    scopes = [scopes] unless scopes.is_a?(Array)
+    scopes.each { |scope| klass = klass.public_send(scope) }
+
+    klass
   end
 end
 
-ActiveSupport.on_load(:action_controller_base) do
+ActiveSupport.on_load(:action_controller) do
   include RailsSettlement
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_settlement
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tejas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord