rails_settlement 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a6695df770d40dfaff82ecab8bc78d0c8094be1c1bb5396a3065627394d3b2a
-  data.tar.gz: 816e133bd3c262c8ca33f77b1d2629e11f3980a14a903111b93d22fb1c7d8f66
+  metadata.gz: fea25e5290b99af4236253654e98e65428fbb8845cd3952ed57bddbfbd877aa5
+  data.tar.gz: bf7b83e4dcd6cde28b6fbca6bf96db247ec07d75e4ea76ffa8caec1f775dc7e3
 SHA512:
-  metadata.gz: 0524dceb140d2e07286d2cac1adfde6d4c24a1b4f10b9103cd0509b0475551e263e14e2deb51c530961f8c5092ff06469723373eb1f391aaaaa862a26bbe311c
-  data.tar.gz: 2ffc3f8ddacc5ce63232670febdb4223f968760ce9da686c20553fd6cfc9b75150b7d2c9cbfffafe2cf865f4745b6a238a61c17ea70343d09085943bbca776a4
+  metadata.gz: 61f3e0eb9b9909119252dfda0cced54624da78f22c531bf6ae7b03cdd30e3be30485182fda294c83d01475b0df03e56ebd4ded6fdbd1875605e053a677b4dddf
+  data.tar.gz: c19ca70fec032ce9b3ffb0868bbc92d4f4322a0138e1e5240d11a5581820b26824ae0ec2a13ef284c301c18b3b7abcb1d1c249e1224c9f0f366007a0d19ebbcc

data/.rubocop.yml

@@ -13,7 +13,10 @@ Layout/LineLength:
   Max: 150
 
 Metrics/AbcSize:
-  Max: 22
+  Max: 23
+
+Metrics/MethodLength:
+  Max: 15
 
 Style/Documentation:
   Enabled: false

data/README.md

@@ -25,6 +25,16 @@ class UsersController < ApplicationController
   # 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
 
+  # You can also set a namespace for the model with the `namespace` option. It can be a string or a symbol.
+  # Suppose you have a model 'Admin::User', you can define:
+  # set_user namespace: :admin, ...
+  # If you have a model that's nested more than once, like 'Admin::Account::User', you can define as:
+  # set_user namespace: 'admin/account', ...
+
+  # If you want to search an object's relationship, you can use the `associated_to` option.
+  # set_articles! associated_to: :user, ... # => Article.where(user => user)
+  # set_articles! associated_to: :user, scope_to: :published # => Article.published.where(user => user).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
@@ -47,6 +57,4 @@ end
 
 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.3.0"
+  VERSION = "1.4.0"
 end

data/lib/rails_settlement.rb

@@ -14,12 +14,15 @@ module RailsSettlement
     def method_missing(method, **options)
       super unless (matches = method.to_s.match(SETTABLE_REGEX))
 
-      variable, raisable = _handle_match_data(matches)
-      klass = _klass(variable, **options.extract!(:namespace))
-      param_options = _param_options(klass: klass, options: options)
-      scoped_klass = _handle_scopes(klass: klass, scopes: param_options[:scope_to])
+      variable, raisable = _rs_handle_match_data(matches)
+      klass = _rs_klass(variable, **options.extract!(:namespace))
+      param_options = _rs_param_options(klass: klass, options: options)
+      scoped_klass = _rs_handle_scopes(klass: klass, scopes: param_options[:scope_to])
+      associated_to = _rs_handle_associated_to(options: options)
 
       before_action(**options) do
+        scoped_klass = _rs_associated_scope(scoped_relation: scoped_klass, associated_to: associated_to)
+
         instance_variable_set("@#{variable}", scoped_klass.find_by(param_options[:model_key] => params[param_options[:params_key]]))
         raise ActiveRecord::RecordNotFound if raisable && instance_variable_get("@#{variable}").nil?
       end
@@ -33,21 +36,21 @@ module RailsSettlement
 
     private
 
-    def _handle_match_data(match_data)
+    def _rs_handle_match_data(match_data)
       [match_data[:object], match_data[:raisable].present?]
     end
 
-    def _klass(variable, namespace: nil)
+    def _rs_klass(variable, namespace: nil)
       variable = variable.classify
       variable = "#{namespace.to_s.classify}::#{variable}" if namespace.present?
       variable.constantize
     end
 
-    def _param_options(klass:, options:)
+    def _rs_param_options(klass:, options:)
       (klass.try(:settable_params) || {}).merge(options.extract!(:model_key, :params_key, :scope_to))
     end
 
-    def _handle_scopes(klass:, scopes:)
+    def _rs_handle_scopes(klass:, scopes:)
       return klass if scopes.blank?
 
       scopes = [scopes] unless scopes.is_a?(Array)
@@ -55,6 +58,18 @@ module RailsSettlement
 
       klass
     end
+
+    def _rs_handle_associated_to(options:)
+      return nil unless options.key?(:associated_to)
+
+      options.delete(:associated_to)
+    end
+  end
+
+  def _rs_associated_scope(scoped_relation:, associated_to: nil)
+    return scoped_relation if associated_to.blank?
+
+    scoped_relation.where(associated_to => public_send(associated_to))
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_settlement
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tejas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord