feature_setting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d91a5d153742d206b572e6cb52b4d948d8e2dd
+  data.tar.gz: f9a5fc4954f5288b53d4894ac5c7026520083663
+SHA512:
+  metadata.gz: b3abbd0d8eafe2556fa25c91a69b76a0cfbed7031696ee5915a0ad723181f76ca9f3d68724a11876f618173b2fc0fa1b824cb9ee1cfe226e19e22dc72379f7d2
+  data.tar.gz: 28e2c3c8163cb41240b8f9cfde63a94c311a0e60f5b4209057c7af8c85cbe4cc431eac6cdfeb10f710204446e687d0caa05a434d679b3eff4bc010f09ea27ac8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in feature_setting.gemspec
+gemspec

data/README.md

@@ -0,0 +1,168 @@
+**Note: This gem is still under construction!**
+
+# 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)
+
+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.
+
+- 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.
+
+Both, features and settings are configured with default values that persist in the database and then can be updated if required.
+
+```ruby
+# using features:
+if Feature.caching_enabled?
+  # do this
+else
+  # do that
+end
+
+# using settings:
+if Setting.error_threshold > 500
+    # do this
+end
+
+if Setting.allowed_users.include?(current_user)
+  # to that
+end
+
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem 'feature_setting'
+```
+
+Now run the `feature_setting` installation:
+
+    $ rails generate feature_setting:install
+
+This generates a migration file. To run this migration:
+
+    $ rake db:migrate
+
+The next step is to define your Feature and/or Setting classes.
+
+
+## Usage
+
+### 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!`.
+
+```ruby
+class Features < FeatureSetting::FsFeature
+  FEATURES = {
+    newfeature: true
+  }
+
+  init_features!
+end
+```
+
+For each key you have defined, a class method `keyname_enabled?` is generated. You can now do the following:
+
+```ruby
+Features.newfeature_enabled? # => true
+Features.disable!(:newfeature)
+Features.newfeature_enabled? # => false
+Features.enable!(:newfeature)
+Features.newfeature_enabled? # => true
+```
+
+Or you can use these shortcuts:
+
+```ruby
+Features.enable_newfeature!
+Features.disable_newfeature!
+```
+
+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.
+
+```ruby
+class Settings < FeatureSetting::FsSetting
+  SETTINGS = {
+    setting_one: 12300,
+    setting_two: 'some string',
+    setting_three: %w(one two three),
+    setting_four: ENV['SETTING_FOUR']
+  }
+
+  init_settings!
+end
+```
+
+You can now do the following:
+
+```ruby
+Settings.newsetting # => 12300
+Settings.set!(newsetting: 1000)
+Settings.newsetting # => 1000
+
+# other ways to set setting values
+Settings.set!(:newsetting, 1000)
+Settings.set!('newsetting', 1000)
+```
+
+Default values for settings are defined in your class and  current values are persisted in the database.
+
+
+### Advanced Features
+
+Settings and features can be reset to their default values as configured in your class definition:
+
+```ruby
+Features.reset_features!
+Settings.reset_settings!
+```
+
+Display all defined keys:
+
+```ruby
+Features.defined_features
+Settings.defined_settings
+```
+
+You can create as many Setting or Feature classes as you desire. Here are some examples:
+
+```ruby
+SearchSettings.levenshtein_distance
+TestFeatures.experimental_search_enabled?
+```
+
+## Contributing
+
+1. Fork it (https://github.com/indrode/feature_setting/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Notes:
+
+- Contributions without tests won't be accepted.
+- Please don't update the gem version.
+
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/feature_setting.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.authors       = ['Indro De']
+  spec.email         = ['indro.de@gmail.com']
+
+  spec.summary       = 'A lightweight feature/setting DSL for Rails applications.'
+  spec.description   = %q{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'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 4.0'
+  spec.add_runtime_dependency 'activerecord', '~> 4.0'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3', '~> 0'
+  spec.add_development_dependency 'byebug', '~> 0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
+end

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

@@ -0,0 +1,77 @@
+require 'active_record'
+
+module FeatureSetting
+  class FsFeature < ActiveRecord::Base
+    FEATURES = {
+      test: false
+    }
+
+    def features
+      self.class::FEATURES
+    end
+
+    def klass
+      self.class
+    end
+
+    class << self
+      def features
+        self.new.features
+      end
+
+      def klass
+        self.new.klass
+      end
+
+      def init_features!
+        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
+        end
+        remove_old_features!
+      end
+
+      def remove_old_features!
+        self.where(key: all_stored_features - defined_features).destroy_all
+      end
+
+      def reset_features!
+        self.where(klass: klass).destroy_all
+        init_features!
+      end
+
+      def enable!(key)
+        if features.has_key?(key.to_sym)
+          record = self.where(key: key, klass: klass).first
+          record.update_attributes(enabled: true)
+        end
+      end
+
+      def disable!(key)
+        if features.has_key?(key.to_sym)
+          record = self.where(key: key, klass: klass).first
+          record.update_attributes(enabled: false)
+        end
+      end
+
+      def defined_features
+        features.keys.map(&:to_s)
+      end
+
+      private
+
+      def all_stored_features
+        self.all.pluck(:key)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+require 'active_record'
+
+module FeatureSetting
+  class FsSetting < ActiveRecord::Base
+    SETTINGS = {
+      test: 'value',
+    }
+
+    def settings
+      self.class::SETTINGS
+    end
+
+    def klass
+      self.class
+    end
+
+    class << self
+      def settings
+        self.new.settings
+      end
+
+      def klass
+        self.new.klass
+      end
+
+      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
+        end
+        remove_old_settings!
+      end
+
+      def remove_old_settings!
+        self.where(klass: klass, key: all_stored_settings - defined_settings).destroy_all
+      end
+
+      def reset_settings!
+        self.where(klass: klass).destroy_all
+        init_settings!
+      end
+
+      def set!(key = nil, value = nil, **hash)
+        key = existing_key(key, hash)
+        raise 'ERROR: FsSetting key is missing or does not exist.' unless key
+
+        record = self.where(key: key, klass: klass).first
+        new_value = hash.values.first || value
+        record.update_attributes(
+          value: convert_to_string(new_value, new_value.class.to_s),
+          value_type: new_value.class.to_s
+        )
+      end
+
+      def existing_key(key = nil, hash = {})
+        begin
+          settings.has_key?(hash.keys.first) || settings.has_key?(key.to_sym)
+          hash.keys.first || key.to_sym
+        rescue
+          nil
+        end
+      end
+
+      def defined_settings
+        settings.keys.map(&:to_s)
+      end
+
+      private
+
+      def all_stored_settings
+        self.all.pluck(:key)
+      end
+
+      def convert_to_type(value, type)
+        case type
+        when 'String'
+          value.to_s
+        when 'Fixnum'
+          value.to_i
+        when 'Float'
+          value.to_f
+        when 'Array'
+          value.split('|||')
+        end
+      end
+
+      def convert_to_string(value, type)
+        case type
+        when 'Array'
+          value.join('|||')
+        else
+          value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/feature_setting/version.rb

@@ -0,0 +1,3 @@
+module FeatureSetting
+  VERSION = "1.0.0"
+end

data/lib/feature_setting.rb

@@ -0,0 +1,7 @@
+require 'active_support/all'
+require 'feature_setting/version'
+require 'feature_setting/orm/active_record/fs_setting'
+require 'feature_setting/orm/active_record/fs_feature'
+
+module FeatureSetting
+end

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

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+
+module FeatureSetting
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      desc 'Generates database tables for feature_settings'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_migrations
+        migration_name = 'create_fs_tables.rb'
+        migration_template "migrations/#{migration_name}", "db/migrate/#{migration_name}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+class CreateFsTables < ActiveRecord::Migration
+  def self.up
+    create_table :fs_features do |t|
+      t.string :key
+      t.boolean :enabled, default: false
+      t.string :klass
+      t.timestamps null: false
+    end
+
+    create_table :fs_settings do |t|
+      t.string :key
+      t.string :value
+      t.string :value_type
+      t.string :klass
+      t.timestamps null: false
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: feature_setting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Indro De
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !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: codeclimate-test-reporter
+  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: 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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feature_setting.gemspec
+- lib/feature_setting.rb
+- lib/feature_setting/orm/active_record/fs_feature.rb
+- lib/feature_setting/orm/active_record/fs_setting.rb
+- lib/feature_setting/version.rb
+- lib/generators/feature_setting/install/install_generator.rb
+- lib/generators/feature_setting/install/templates/migrations/create_fs_tables.rb
+homepage: https://github.com/indrode/feature_setting
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A lightweight feature/setting DSL for Rails applications.
+test_files: []