feature_setting 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06abd9e67e15be7d9f9c9ba43a6584fa422148ed0ca7c6cc45c56aeaa9676076
-  data.tar.gz: f85e976430756103cac6862b6a54c05672515a880d54c20be9da543233b8b774
+  metadata.gz: d88b8c501d738b622e547956bbbc2e44164e375d72fe949a02749a5dbba93207
+  data.tar.gz: 5ae3b3db98a22c65a7595b4b14015fae8b3b3de9f3c08d506186bb27a2c03657
 SHA512:
-  metadata.gz: 85b95a1a26932bcd1ce80eeecfc8055d07b8f38e88af309103f9cf175b7eab5daf32e911f29b64e4ab02bdb0095481e6fbfa550799e7895ed27e40093fe693b4
-  data.tar.gz: 7361fa1fdf00eba9a959e24709bca4bb0b15c2903f322c8d4d4da60cb2c2a321fe506e3d2ef80f7d6151f57f7adf44c9608bdf11b3cbc892bba1587ca47be8d9
+  metadata.gz: e97a3af42489cc34a2b4c716b6c36d241eb834156aa0936358cc57b0fb7d387fcfdea6f11d7b01f4e8c7551174d4b37a69800831f5927ae82f0c4f9d58809442
+  data.tar.gz: 6954b1cb38e3314b9cf0f63181c0e6e100ad0e7ed647fa969e6cd71b67b15326ad60092a9de4159035b5e22068b444559d4b2b21831cfff5a9e54e4cfb9996ea

data/.rubocop.yml

@@ -0,0 +1,100 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'feature_setting.gemspec'
+RSpec/MultipleExpectations:
+  Max: 3
+RSpec/ExampleLength:
+  Max: 10
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+Style/Documentation:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 105
+Metrics/MethodLength:
+  Max: 12
+  Exclude:
+    - 'lib/generators/**/**'
+RSpec/FilePath:
+  Enabled: false
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # (new in 2.4)
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # (new in 2.4)
+  Enabled: true

data/README.md

@@ -1,7 +1,7 @@
 # feature_setting
 
 [![Gem
-Version](https://badge.fury.io/rb/feature_setting.svg)](http://badge.fury.io/rb/feature_setting)
+Version](https://badge.fury.io/rb/feature_setting.svg)](https://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
@@ -30,8 +30,8 @@ if Setting.error_threshold > 500
     # do this
 end
 
-if Setting.allowed_users.include?(current_user)
-  # to that
+if Setting.allowed_users.include?(current_user.id)
+  # do that
 end
 ```
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "feature_setting"
+require 'bundler/setup'
+require 'feature_setting'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "feature_setting"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/feature_setting.gemspec

@@ -1,29 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'feature_setting/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'feature_setting'
-  spec.version       = FeatureSetting::VERSION
-  spec.licenses      = ['MIT']
-  spec.authors       = ['Indro De']
-  spec.email         = ['indro.de@gmail.com']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.name                  = 'feature_setting'
+  spec.version               = FeatureSetting::VERSION
+  spec.licenses              = ['MIT']
+  spec.authors               = ['Indro De']
+  spec.email                 = ['indro.de@gmail.com']
 
-  spec.summary       = 'A lightweight feature/setting DSL for Rails applications.'
-  spec.description   = '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.'
-  spec.homepage      = 'https://github.com/indrode/feature_setting'
+  spec.summary               = 'A lightweight feature/setting DSL for Rails applications.'
+  spec.description           = <<-DESCRIPTION
+    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.
+  DESCRIPTION
+  spec.homepage              = 'https://github.com/indrode/feature_setting'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = ['lib']
+  spec.files                 = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths         = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.0'
   spec.add_runtime_dependency 'activerecord', '>= 4.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.0'
   spec.add_runtime_dependency 'hashie', '>= 3.4.3'
   spec.add_development_dependency 'bundler', '>= 1.9'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop', '>= 1.17.0'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
 end

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

@@ -4,7 +4,7 @@ module FeatureSetting
   class FsFeature < ActiveRecord::Base
     FEATURES = {
       test: false
-    }
+    }.freeze
 
     def features
       self.class::FEATURES
@@ -15,25 +15,25 @@ module FeatureSetting
     end
 
     class << self
-      def method_missing(m, *args)
+      def method_missing(_method, *_args)
         false
       end
 
-      def respond_to_missing?(*args)
+      def respond_to_missing?(*_args)
         true
       end
 
       def features
-        self.new.features
+        new.features
       end
 
       def klass
-        self.new.klass.to_s
+        new.klass.to_s
       end
 
-      def init_features!(remove_old_features = false)
+      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)
+          create_feature(key, value)
           define_checker_method(key)
           define_enabler_method(key)
           define_disabler_method(key)
@@ -43,8 +43,8 @@ module FeatureSetting
 
       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
+          create_feature(key, value)
+          value = find_by(key: key, klass: klass).enabled
           define_checker_method(key) { value }
           define_enabler_method(key) { false }
           define_disabler_method(key) { false }
@@ -52,48 +52,53 @@ module FeatureSetting
       end
 
       def define_checker_method(key, &block)
-        block = Proc.new do
-          record = self.where(key: key, klass: klass).first
-          record ? record.enabled : false
-        end unless block_given?
+        unless block_given?
+          block = proc do
+            record = find_by key: key, klass: klass
+            record ? record.enabled : false
+          end
+        end
         define_singleton_method("#{key}_enabled?") { block.call }
       end
 
       def define_enabler_method(key, &block)
-        block = Proc.new do
-          enable!(key)
-        end unless block_given?
+        unless block_given?
+          block = proc do
+            enable!(key)
+          end
+        end
         define_singleton_method("enable_#{key}!") { block.call }
       end
 
       def define_disabler_method(key, &block)
-        block = Proc.new do
-          disable!(key)
-        end unless block_given?
+        unless block_given?
+          block = proc do
+            disable!(key)
+          end
+        end
         define_singleton_method("disable_#{key}!") { block.call }
       end
 
       def remove_old_features!
-        self.where(key: all_stored_features - defined_features).destroy_all
+        where(key: all_stored_features - defined_features).destroy_all
       end
 
       def reset_features!
-        self.where(klass: klass).destroy_all
-        init_features!
+        init_features! if where(klass: klass).delete_all
       end
 
       def enable!(key)
-        if features.key?(key.to_sym)
-          record = self.where(key: key, klass: klass).first
-          record.update(enabled: true)
-        end
+        return unless features.key?(key.to_sym)
+
+        record = find_by key: key, klass: klass
+        record.update(enabled: true)
       end
 
       def disable!(key)
-        if features.key?(key.to_sym)
-          record = self.where(key: key, klass: klass).first
-          record.update(enabled: false)
-        end
+        return unless features.key?(key.to_sym)
+
+        record = find_by key: key, klass: klass
+        record.update(enabled: false)
       end
 
       def defined_features
@@ -103,7 +108,18 @@ module FeatureSetting
       private
 
       def all_stored_features
-        self.all.pluck(:key)
+        all.pluck(:key)
+      end
+
+      def create_feature(key, value)
+        create_with(
+          key: key,
+          enabled: value,
+          klass: klass
+        ).find_or_create_by(
+          klass: klass,
+          key: key
+        )
       end
     end
   end

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

@@ -1,8 +1,21 @@
 require 'active_record'
 require 'json'
+require_relative './../../../helpers/convert_value'
 
 module FeatureSetting
   class FsSetting < ActiveRecord::Base
+    class SettingKeyNotFoundError < StandardError
+      def message
+        'Key is missing or does not exist.'
+      end
+    end
+
+    class SettingTypeMismatchError < StandardError
+      def message
+        'The value for a setting of type Hash must be a Hash.'
+      end
+    end
+
     SETTINGS = {
       test: 'value'
     }.freeze
@@ -24,9 +37,9 @@ module FeatureSetting
         new.klass.to_s
       end
 
-      def init_settings!(remove_old_settings = false)
+      def init_settings!(remove_old_settings: false)
         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)
+          create_setting(key, value)
           define_getter_method(key)
           define_setter_method(key)
         end
@@ -35,18 +48,20 @@ module FeatureSetting
 
       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)
+          create_setting(key, value)
+          record = find_by key: key, klass: klass
+          value = ConvertValue.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?
+        unless block_given?
+          block = proc do
+            record = find_by key: key, klass: klass
+            ConvertValue.convert_to_type(record.value, record.value_type)
+          end
+        end
 
         define_singleton_method(key.to_s) { block.call }
       end
@@ -58,22 +73,22 @@ module FeatureSetting
       end
 
       def remove_old_settings!
-        where(klass: klass, key: all_stored_keys - defined_keys).destroy_all
+        where(klass: klass, key: all_stored_keys - defined_keys).delete_all
       end
 
       def reset_settings!
-        where(klass: klass).destroy_all
-        init_settings!
+        init_settings! if where(klass: klass).delete_all
       end
 
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def set!(key = nil, value = nil)
-        raise 'ERROR: FsSetting key is missing or does not exist.' unless defined_keys.include?(key.to_s)
+        raise SettingNotExistsError 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)
+        record = find_by key: key.to_s, klass: klass
+        old_value = ConvertValue.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)
+          raise SettingTypeMismatchError unless value.is_a?(Hash)
 
           new_value = old_value.update(value)
           value_type = 'Hash'
@@ -83,16 +98,18 @@ module FeatureSetting
         end
 
         record.update(
-          value: convert_to_string(new_value, new_value.class.to_s),
+          value: ConvertValue.convert_to_string(new_value, new_value.class.to_s),
           value_type: value_type
         )
       end
-      alias_method :update!, :set!
+      alias update! set!
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def existing_key(key = nil, hash = {})
-        settings.key?(hash.keys.first) || settings.key?(key.to_sym)
+        return unless settings.key?(hash.keys.first) || settings.key?(key.to_sym)
+
         hash.keys.first || key.to_sym
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -103,7 +120,7 @@ module FeatureSetting
       def stored_settings
         hash = {}
         where(klass: klass).each do |record|
-          hash[record.key.to_sym] = convert_to_type(record.value, record.value_type)
+          hash[record.key.to_sym] = ConvertValue.convert_to_type(record.value, record.value_type)
         end
 
         hash
@@ -115,40 +132,16 @@ module FeatureSetting
         all.pluck(:key)
       end
 
-      def convert_to_type(value, type)
-        case type
-        when 'String'
-          value.to_s
-        when 'TrueClass'
-          true
-        when 'NilClass'
-          false
-        when 'FalseClass'
-          false
-        when 'Fixnum'
-          value.to_i
-        when 'Integer'
-          value.to_i
-        when 'Float'
-          value.to_f
-        when 'Symbol'
-          value.to_sym
-        when 'Array'
-          value.split('|||')
-        when 'Hash'
-          Hashie::Mash.new(JSON.parse(value))
-        end
-      end
-
-      def convert_to_string(value, type)
-        case type
-        when 'Hash', 'Hashie::Mash'
-          value.to_json
-        when 'Array'
-          value.join('|||')
-        else
-          value.to_s
-        end
+      def create_setting(key, value)
+        create_with(
+          key: key,
+          value: ConvertValue.convert_to_string(value, value.class.to_s),
+          value_type: value.class.to_s,
+          klass: klass
+        ).find_or_create_by(
+          klass: klass,
+          key: key
+        )
       end
     end
   end

data/lib/feature_setting/version.rb

@@ -1,3 +1,3 @@
 module FeatureSetting
-  VERSION = "1.6.3"
+  VERSION = '1.7.0'.freeze
 end

data/lib/generators/feature_setting/install/install_generator.rb

@@ -13,7 +13,7 @@ module FeatureSetting
       end
 
       desc 'Generates database tables for feature_settings'
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_migrations
         migration_name = 'create_fs_tables.rb'

data/lib/helpers/convert_value.rb

@@ -0,0 +1,37 @@
+module ConvertValue
+  class << self
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def convert_to_type(value, type)
+      case type
+      when 'String'
+        value.to_s
+      when 'TrueClass'
+        true
+      when 'NilClass', 'FalseClass'
+        false
+      when 'Fixnum', 'Integer'
+        value.to_i
+      when 'Float'
+        value.to_f
+      when 'Symbol'
+        value.to_sym
+      when 'Array'
+        value.split('|||')
+      when 'Hash'
+        Hashie::Mash.new(JSON.parse(value))
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+    def convert_to_string(value, type)
+      case type
+      when 'Hash', 'Hashie::Mash'
+        value.to_json
+      when 'Array'
+        value.join('|||')
+      else
+        value.to_s
+      end
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: feature_setting
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Indro De
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,9 +164,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 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.
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      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.
 email:
 - indro.de@gmail.com
 executables: []
@@ -147,6 +190,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -162,6 +206,7 @@ files:
 - lib/feature_setting/version.rb
 - lib/generators/feature_setting/install/install_generator.rb
 - lib/generators/feature_setting/install/templates/migrations/create_fs_tables.rb
+- lib/helpers/convert_value.rb
 homepage: https://github.com/indrode/feature_setting
 licenses:
 - MIT
@@ -174,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="