custom_rails_settings_cached 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c90d324da6f1105a3787d6fe5e425cde77e7ef22b76f93f72029cb6b6f5775f
-  data.tar.gz: 4926f1c2a6850691bb3770f6463905f0c687cf333b0db39d008a11b54b06a86d
+  metadata.gz: 29d27addc040a72886822abd305924de2c6be632e6a0bf9ec2b5b74c72877fa0
+  data.tar.gz: bfccea2e5065766bb4d81f416ef541bb0c967fd733334b619388c3f25881171a
 SHA512:
-  metadata.gz: b33a6abb15314f0d997e36e6daff2cdf9c26586afc3cd2275cef5ac84e2df70e0d199d32473c3b42f2f951a2b7e7a7730c76b8c86f519224655679ed5574f74d
-  data.tar.gz: 6c331873e2b23396493ce97de3abe4532559a6e3b3901cbf71de5751ba5a7a67319ec7e10d93cc5def42e7c9b96eac6135189e7677c25af8d24abd82a2b0ed4e
+  metadata.gz: 423381285f2ebb21f98f1740821ab058a2f062b44132fc5426493607bef6bd496401b166eb0d554f29e67ee441c757908a2b6aead1a33d384ed54d88143a93f9
+  data.tar.gz: ff535dee29861d258bd2ed365647958d7e9f2d77c4ae6ef8de7f6fa2f6fffc83e3e4926389461d40a3faa6bad70451b829474ea1975a2cdd66d0b226b90c6138

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    custom_rails_settings_cached (0.1.0)
+    custom_rails_settings_cached (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,12 +1,13 @@
 # CustomRailsSettingsCached
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/custom_rails_settings_cached`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+My Custom with Rails Settings Cached. Easy to setup and use.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You need install [Rails Settings Cached](https://github.com/huacnlee/rails-settings-cached) to use this gem.
+
+
+Then, ddd this line to your application's Gemfile:
 
 ```ruby
 gem 'custom_rails_settings_cached'
@@ -22,7 +23,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Must define `CUSTOM_RAILS_SETTINGS_KEYS` before `include CustomRailsSettingsCached`
+
+*CUSTOM_RAILS_SETTINGS_KEYS* can be Array or Hash.
+
+```ruby
+  CUSTOM_RAILS_SETTINGS_KEYS = {
+    google_analytics: [:enabled, :tracking_code],
+    facebook_pixel_ads: [:enabled, :tracking_code]
+  }
+  
+  # Or
+  
+  CUSTOM_RAILS_SETTINGS_KEYS = [:google_analytics, :facebook_pixel_ads]
+  
+  # Or
+  
+  CUSTOM_RAILS_SETTINGS_KEYS = {
+    google_analytics: :tracking_code,
+    facebook_pixel_ads: [:enabled, :tracking_code]
+  }
+```
+Then, include `CustomRailsSettingsCached` in your model.
+Exam:
+```ruby
+  include CustomRailsSettingsCached
+ ```
+
+Or, can use with your custom concern.
+
+```ruby
+require 'custom_rails_settings_cached'
+
+module MyCustomRailsSetting
+  def self.included klass
+    klass.include CustomRailsSettingsCached
+
+    # custom more here
+    # klass.class_eval do
+    #   has_many :players
+    #   validates :number_of_player, presence: true
+    # end
+  end
+end
+
+```
+Then use `include MyCustomRailsSetting` at model.
+
+Exams:
+
+**Get Value**
+
+```ruby
+    object = YourModel.first
+    object.google_analytics_tracking_code
+```
+
+**Set Value**
+
+```ruby
+    object = YourModel.first
+    object.update google_analytics_tracking_code: '123456ABCDEF'
+```
+
 
 ## Development
 

data/lib/custom_rails_settings_cached.rb

@@ -52,24 +52,34 @@ module CustomRailsSettingsCached
     end
 
     if defined?(self::CUSTOM_RAILS_SETTINGS_KEYS)
-      if self::CUSTOM_RAILS_SETTINGS_KEYS.is_a?(Array)
+      build_custom_settings_methods self::CUSTOM_RAILS_SETTINGS_KEYS
+    end
+  end
+
+  module ClassMethods
+    def build_custom_settings_methods(custom_settings)
+      if custom_settings.is_a?(Array)
         # Exam:
         # CUSTOM_RAILS_SETTINGS_KEYS = [:google_analytics, :facebook_pixel_ads]
-        self::CUSTOM_RAILS_SETTINGS_KEYS.each do |setting_key|
-          self.define_method "#{setting_key}" do
-            self.get_settings setting_key
-          end
-          self.define_method "#{setting_key}=" do |setting_value|
-            self.init_setting(setting_key, setting_value)
+        custom_settings.each do |setting_key|
+          if setting_key.is_a?(Symbol)
+            self.define_method "#{setting_key}" do
+              self.get_settings setting_key
+            end
+            self.define_method "#{setting_key}=" do |setting_value|
+              self.init_setting(setting_key, setting_value)
+            end
+          else
+            self.build_custom_settings_methods setting_key
           end
         end
-      elsif self::CUSTOM_RAILS_SETTINGS_KEYS.is_a?(Hash)
+      elsif custom_settings.is_a?(Hash)
         # Exam:
         # CUSTOM_RAILS_SETTINGS_KEYS = {
         #   google_analytics: [:enabled, :tracking_code],
         #   facebook_pixel_ads: [:enabled, :tracking_code]
         # }
-        self::CUSTOM_RAILS_SETTINGS_KEYS.each do |k, v|
+        custom_settings.each do |k, v|
           if v.is_a?(Array)
             v.each do |setting_key|
               # Use: Partner.first.google_analytics_enabled
@@ -82,7 +92,7 @@ module CustomRailsSettingsCached
                 self.init_setting(store_setting_key, setting_value)
               end
             end
-          else
+          elsif v.is_a?(Symbol)
             # Use: Partner.first.google_analytics
             self.define_method "#{v}" do
               self.get_settings v

data/lib/custom_rails_settings_cached/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomRailsSettingsCached
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_rails_settings_cached
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Derek Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-21 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies: []
 description: My custom with Rails Settings Cached
 email: