feature_setting 1.5.2 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab8e41a32042cf67cc57b481b65f0b91b3b40120
-  data.tar.gz: 43fe930139c71bf372959fab6a9dff0e87f01ead
+SHA256:
+  metadata.gz: 53ffa8db4e5e12eab93ef6a84df1d16c297459643d84139b3f34bf15eed7f88a
+  data.tar.gz: 9f88e1e4672bc51d4d1a739e510ffbc448448422870a2b14873318fe49710c44
 SHA512:
-  metadata.gz: 6b8a06dc361a89c9f21e5b5903b8bf9975138c7e98c5301ccadba9c5d6048b53e2bf41cb53132212f9cf2f3856c9fc1e01031c3813bb15b7c6c6740b39a50c88
-  data.tar.gz: 507ebb28119c420308cdfdc562ca0805510335c2c6b148d63d78741f11f54238d320002af36b66c096d602bae95d6841e1a498882142c4691496876e0af84eaa
+  metadata.gz: fbe6488bc9eb17cfb6812ce5be36b7d58368436938be2e18ef5105695412a2d4786852befedec892f4b72137a227a4166957bad89a0bedc4de6d8836c3f24f4e
+  data.tar.gz: 2753e2457b391937abd777ff998a574cf765052d7de782e52eba986b3d5b33c9561186aaf46fc0fe5070223afc9d02684d41e5401873f16e72ecbda13f4783df

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/.travis.yml

@@ -1,3 +1,12 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=3cb479d83eec93856a43161ba46dbad5b8d2e4979a36754bfc07202277b7f1c6
 language: ruby
-rvm:
-  - 2.2.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,6 +1,12 @@
 # feature_setting
 
-[![Gem Version](https://badge.fury.io/rb/feature_setting.svg)](http://badge.fury.io/rb/feature_setting) [![Code Climate](https://codeclimate.com/github/indrode/feature_setting/badges/gpa.svg)](https://codeclimate.com/github/indrode/feature_setting) [![Test Coverage](https://codeclimate.com/github/indrode/feature_setting/badges/coverage.svg)](https://codeclimate.com/github/indrode/feature_setting/coverage) [![security](https://hakiri.io/github/indrode/feature_setting/master.svg)](https://hakiri.io/github/indrode/feature_setting/master)
+[![Gem
+Version](https://badge.fury.io/rb/feature_setting.svg)](http://badge.fury.io/rb/feature_setting)
+[![Code
+Climate](https://codeclimate.com/github/indrode/feature_setting/badges/gpa.svg)](https://codeclimate.com/github/indrode/feature_setting)
+[![Test
+Coverage](https://codeclimate.com/github/indrode/feature_setting/badges/coverage.svg)](https://codeclimate.com/github/indrode/feature_setting/coverage)
+[![security](https://hakiri.io/github/indrode/feature_setting/master.svg)](https://hakiri.io/github/indrode/feature_setting/master) [![Build Status](https://travis-ci.org/indrode/feature_setting.svg?branch=master)](https://travis-ci.org/indrode/feature_setting)
 
 This gem introduces the concept of "features" and "settings" to your Rails app. It provides an easy way to define such features and settings with default values right in your code and will persist them in the database.
 
@@ -63,6 +69,7 @@ class Features < FeatureSetting::Feature
   init_features!
 end
 ```
+**Note:** You can call `init_features!(true)` to remove any existing features that are not defined anymore
 
 For each key you have defined, a class method `keyname_enabled?` is generated. You can now do the following:
 
@@ -103,17 +110,23 @@ class Settings < FeatureSetting::Setting
 end
 ```
 
+**Note:** You can call `init_settings!(true)` to remove any existing settings that are not defined anymore
+
 You can now do the following:
 
 ```ruby
 Settings.setting_one # => 12300
 Settings.setting_one = 2000
 Settings.setting_one # => 2000
+```
+
+**NEW IN VERSION 1.6:** Hashes values can be updated individually and will not overwrite the entire hash:
+```ruby
+Settings.setting_five = { key1: 'another_value' }
+=> setting_five:  { key1: 'another_value', key2: 'value2' }
 
-# other ways to set setting values:
-Settings.set!(setting_one: 1000)
-Settings.set!(:setting_one, 1000)
-Settings.set!('setting_one', 1000)
+Settings.setting_five = { key3: 'value3' }
+=> setting_five:  { key1: 'another_value', key2: 'value2', key3: 'value3' }
 ```
 
 Default values for settings are defined in your class and current values are persisted in the database.
@@ -146,6 +159,14 @@ Features.defined_features
 Settings.defined_settings
 ```
 
+Cache settings or features:
+
+```ruby
+Features.cache_features!
+Settings.cache_settings!
+```
+Note that a simple call to `Features.init_features!` or `Settings.init_settings!` respectively will remove caching.
+
 You can create as many Setting or Feature classes as you desire. Here are some examples:
 
 ```ruby
@@ -171,7 +192,7 @@ Notes:
 
 The MIT License (MIT)
 
-Copyright (c) 2015, 2016 Indro De ([http://indrode.com](http://indrode.com))
+Copyright (c) 2015, 2016, 2017, 2018, 2019 Indro De ([http://indrode.com](http://indrode.com))
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/feature_setting.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'byebug', '>= 0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '>= 0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/feature_setting/orm/active_record/fs_feature.rb

@@ -31,21 +31,46 @@ module FeatureSetting
         self.new.klass.to_s
       end
 
-      def init_features!
+      def init_features!(remove_old_features = false)
         features.each do |key, value|
           self.create_with(key: key, enabled: value, klass: klass).find_or_create_by(klass: klass, key: key)
-          define_singleton_method("#{key}_enabled?") do
-            record = self.where(key: key, klass: klass).first
-            record.enabled
-          end
-          define_singleton_method("enable_#{key}!") do
-            enable!(key)
-          end
-          define_singleton_method("disable_#{key}!") do
-            disable!(key)
-          end
+          define_checker_method(key)
+          define_enabler_method(key)
+          define_disabler_method(key)
         end
-        remove_old_features!
+        remove_old_features! if remove_old_features
+      end
+
+      def cache_features!
+        features.each do |key, value|
+          self.create_with(key: key, enabled: value, klass: klass).find_or_create_by(klass: klass, key: key)
+          value = self.where(key: key, klass: klass).first.enabled
+          define_checker_method(key) { value }
+          define_enabler_method(key) { false }
+          define_disabler_method(key) { false }
+        end
+      end
+
+      def define_checker_method(key, &block)
+        block = Proc.new do
+          record = self.where(key: key, klass: klass).first
+          record.enabled
+        end unless block_given?
+        define_singleton_method("#{key}_enabled?") { block.call }
+      end
+
+      def define_enabler_method(key, &block)
+        block = Proc.new do
+          enable!(key)
+        end unless block_given?
+        define_singleton_method("enable_#{key}!") { block.call }
+      end
+
+      def define_disabler_method(key, &block)
+        block = Proc.new do
+          disable!(key)
+        end unless block_given?
+        define_singleton_method("disable_#{key}!") { block.call }
       end
 
       def remove_old_features!
@@ -60,14 +85,14 @@ module FeatureSetting
       def enable!(key)
         if features.key?(key.to_sym)
           record = self.where(key: key, klass: klass).first
-          record.update_attributes(enabled: true)
+          record.update(enabled: true)
         end
       end
 
       def disable!(key)
         if features.key?(key.to_sym)
           record = self.where(key: key, klass: klass).first
-          record.update_attributes(enabled: false)
+          record.update(enabled: false)
         end
       end
 

data/lib/feature_setting/orm/active_record/fs_setting.rb

@@ -4,8 +4,8 @@ require 'json'
 module FeatureSetting
   class FsSetting < ActiveRecord::Base
     SETTINGS = {
-      test: 'value',
-    }
+      test: 'value'
+    }.freeze
 
     def settings
       self.class::SETTINGS
@@ -17,56 +17,77 @@ module FeatureSetting
 
     class << self
       def settings
-        self.new.settings
+        new.settings
       end
 
       def klass
-        self.new.klass.to_s
+        new.klass.to_s
       end
 
-      def init_settings!
+      def init_settings!(remove_old_settings = false)
         settings.each do |key, value|
-          self.create_with(key: key, value: convert_to_string(value, value.class.to_s), value_type: value.class.to_s, klass: klass).find_or_create_by(klass: klass, key: key)
+          create_with(key: key, value: convert_to_string(value, value.class.to_s), value_type: value.class.to_s, klass: klass).find_or_create_by(klass: klass, key: key)
           define_getter_method(key)
           define_setter_method(key)
         end
-        remove_old_settings!
+        remove_old_settings! if remove_old_settings
       end
 
-      def define_getter_method(key)
-        define_singleton_method(key.to_s) do
-          record = self.where(key: key, klass: klass).first
-          convert_to_type(record.value, record.value_type)
+      def cache_settings!
+        settings.each do |key, value|
+          create_with(key: key, value: convert_to_string(value, value.class.to_s), value_type: value.class.to_s, klass: klass).find_or_create_by(klass: klass, key: key)
+          record = where(key: key, klass: klass).first
+          value = convert_to_type(record.value, record.value_type)
+          define_getter_method(key) { value }
         end
       end
 
+      def define_getter_method(key, &block)
+        block = Proc.new do
+          record = where(key: key, klass: klass).first
+          convert_to_type(record.value, record.value_type)
+        end unless block_given?
+
+        define_singleton_method(key.to_s) { block.call }
+      end
+
       def define_setter_method(key)
         define_singleton_method("#{key}=") do |value|
-          record = self.where(key: key, klass: klass).first
           set!(key, value)
         end
       end
 
       def remove_old_settings!
-        self.where(klass: klass, key: all_stored_settings - defined_settings).destroy_all
+        where(klass: klass, key: all_stored_keys - defined_keys).destroy_all
       end
 
       def reset_settings!
-        self.where(klass: klass).destroy_all
+        where(klass: klass).destroy_all
         init_settings!
       end
 
-      def set!(key = nil, value = nil, **hash)
-        key = existing_key(key, hash)
-        fail 'ERROR: FsSetting key is missing or does not exist.' unless key
+      def set!(key = nil, value = nil)
+        raise 'ERROR: FsSetting key is missing or does not exist.' unless defined_keys.include?(key.to_s)
+
+        record = where(key: key.to_s, klass: klass).first
+        old_value = convert_to_type(record.value, record.value_type)
+
+        if record.value_type == 'Hash'
+          raise 'ERROR: The value for a setting of type Hash must be a Hash.' unless value.is_a?(Hash)
 
-        record = self.where(key: key, klass: klass).first
-        new_value = hash.values.first || value
-        record.update_attributes(
+          new_value = old_value.update(value)
+          value_type = 'Hash'
+        else
+          new_value = value
+          value_type = value.class.to_s
+        end
+
+        record.update(
           value: convert_to_string(new_value, new_value.class.to_s),
-          value_type: new_value.class.to_s
+          value_type: value_type
         )
       end
+      alias_method :update!, :set!
 
       def existing_key(key = nil, hash = {})
         settings.key?(hash.keys.first) || settings.key?(key.to_sym)
@@ -75,14 +96,23 @@ module FeatureSetting
         nil
       end
 
-      def defined_settings
+      def defined_keys
         settings.keys.map(&:to_s)
       end
 
+      def stored_settings
+        hash = {}
+        where(klass: klass).each do |record|
+          hash[record.key.to_sym] = convert_to_type(record.value, record.value_type)
+        end
+
+        hash
+      end
+
       private
 
-      def all_stored_settings
-        self.all.pluck(:key)
+      def all_stored_keys
+        all.pluck(:key)
       end
 
       def convert_to_type(value, type)
@@ -97,6 +127,8 @@ module FeatureSetting
           false
         when 'Fixnum'
           value.to_i
+        when 'Integer'
+          value.to_i
         when 'Float'
           value.to_f
         when 'Symbol'
@@ -110,12 +142,10 @@ module FeatureSetting
 
       def convert_to_string(value, type)
         case type
-        when 'Hash'
+        when 'Hash', 'Hashie::Mash'
           value.to_json
         when 'Array'
           value.join('|||')
-        when 'Hash'
-          value.to_json
         else
           value.to_s
         end

data/lib/feature_setting/version.rb

@@ -1,3 +1,3 @@
 module FeatureSetting
-  VERSION = "1.5.2"
+  VERSION = "1.6.2"
 end

data/lib/generators/feature_setting/install/templates/migrations/create_fs_tables.rb

@@ -1,4 +1,4 @@
-class CreateFsTables < ActiveRecord::Migration
+class CreateFsTables < ActiveRecord::Migration[4.2]
   def self.up
     create_table :fs_features do |t|
       t.string :key
@@ -15,4 +15,9 @@ class CreateFsTables < ActiveRecord::Migration
       t.timestamps null: false
     end
   end
+
+  def self.down
+    drop_table :fs_features
+    drop_table :fs_settings
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_setting
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.2
 platform: ruby
 authors:
 - Indro De
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +166,7 @@ homepage: https://github.com/indrode/feature_setting
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,9 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A lightweight feature/setting DSL for Rails applications.
 test_files: []