feature_setting 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18ca75fc887ba02f7803b8702d72c8adc720cf80
-  data.tar.gz: 1c4a9ac3f0697cca4f6784bcd34ab9395f39f94e
+  metadata.gz: d7b74eb144e8d91a12cbb631bd244fd1a72e297c
+  data.tar.gz: aa980b19d5de36d71fac54e50194d012bd692785
 SHA512:
-  metadata.gz: 5387df7acbec72b6d024fd3b542674276829f751df3f38218c59689ef9a76554b2c97ee7e206432be88aed1ed1324a478caf9c3b2b60a5e0162475d84801d633
-  data.tar.gz: 7becbfd04f2cb502cdd0d1400a09b06e608594d482320b7c50bd5daf0e0aff224d784d8c2426f43147c2e76c2656bb0d502ffd5b0b007a839c2090d170418f2f
+  metadata.gz: 3e68c43b11367ea876f0e58b257fc91a9e6fe283200ff1ee4bfd4a0a834ea80b5ebaf39fd4e7aa6cc76bc57d99d0fa09d177b2df47c6856b049d3496f2d3bf22
+  data.tar.gz: 84e9fe706f6f6eb614814cfe1ec5daf5b4e3f37ec458b8b8c281315e2268e6ec159f7940b4d014bca7f1087b67d602998c2844ae0930ebebebc4a45a7ffa2758

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 # Changelog
 
+## v1.2.0
+
+- change parent class names to `FeatureSetting::Feature` and `FeatureSetting::Setting` (the old `FsFeature` and `FsSetting` can still be used as well)
+
 ## v1.1.0
 
-- dynamically generate setter methods for FsSetting keys simplify updating values:
+- dynamically generate setter methods for FsSetting keys to simplify updating values:
 
 ```ruby
 MySetting.setting_key = 123

data/README.md

@@ -7,9 +7,9 @@ This gem introduces the concept of "features" and "settings" to your Rails app.
 - a feature is a key that can either be enabled or disabled
 - a setting is a key that has a value (of type String, Fixnum, Float, or Array)
 
-In practice, features can be used to switch certain functionality in your code on or off. This can be used to roll out functionality without the need to deploy. Settings are very flexible in that they can hold any value. The possibilities are endless.
+In practice, features can be used to switch certain functionality in your code on or off. This can be used to roll out functionality without the need to deploy. Settings are very flexible in that they can hold any value. The possibilities are endless. They should not be used to store application secrets, such as tokens, passwords, and keys. Those type of settings should rather be stored in environment variables using tools like [https://github.com/bkeepers/dotenv](dotenv).
 
-Both, features and settings are configured with default values that persist in the database and then can be updated if required.
+Both, features and settings are configured in your code with default values. They can then be updated at any time in the Rails console and persist in the database.
 
 ```ruby
 # using features:
@@ -52,10 +52,10 @@ The next step is to define your Feature and/or Setting classes.
 
 ### Features
 
-To create a new Feature class, inherit a class from `FeatureSetting::FsFeature`. Then define your features in th `FEATURES` hash and call `init_features!`.
+To create a new Feature class, inherit a class from `FeatureSetting::Feature` (if using a gem version prior to `1.2.0` use `FeatureSetting::FsFeature`). Then define your features in a hash called `FEATURES` and call `init_features!`.
 
 ```ruby
-class Features < FeatureSetting::FsFeature
+class Features < FeatureSetting::Feature
   FEATURES = {
     newfeature: true
   }
@@ -81,15 +81,15 @@ Features.enable_newfeature!
 Features.disable_newfeature!
 ```
 
-Default values for features are defined in your class and  current values are persisted in the database.
+Default values for features are defined in your class and current values are persisted in the database.
 
 
 ### Settings
 
-To create a new Setting class, inherit a class from `FeatureSetting::FsSetting`. Then define your settings in the `SETTINGS` hash and call `init_settings!`. The following example shows some possible definitions.
+To create a new Setting class, inherit a class from `FeatureSetting::Setting` (if using a gem version prior to `1.2.0` use `FeatureSetting::FsSetting`). Then define your settings in a hash called `SETTINGS` and call `init_settings!`. The following example shows the setup and some possible definitions.
 
 ```ruby
-class Settings < FeatureSetting::FsSetting
+class Settings < FeatureSetting::Setting
   SETTINGS = {
     setting_one: 12300,
     setting_two: 'some string',

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

@@ -74,4 +74,7 @@ module FeatureSetting
       end
     end
   end
+
+  # alias this class to Feature
+  Feature = FsFeature
 end

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

@@ -26,18 +26,26 @@ module FeatureSetting
       def init_settings!
         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)
-          define_singleton_method(key.to_s) do
-            record = self.where(key: key, klass: klass).first
-            convert_to_type(record.value, record.value_type)
-          end
-          define_singleton_method("#{key}=") do |value|
-            record = self.where(key: key, klass: klass).first
-            set!(key, value)
-          end
+          define_getter_method(key)
+          define_setter_method(key)
         end
         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)
+        end
+      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
       end
@@ -99,4 +107,7 @@ module FeatureSetting
       end
     end
   end
+
+  # alias this class to Setting
+  Setting = FsSetting
 end

data/lib/feature_setting/version.rb

@@ -1,3 +1,3 @@
 module FeatureSetting
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_setting
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Indro De
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport