feature_cop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f90532fb87a21090eb99cc8122997d0ce462b08
+  data.tar.gz: 01ddaf927a04082461a1227fd34941f0b2b751cb
+SHA512:
+  metadata.gz: d4e7f3ec3d361dd151e489e865b84d1f0c31e23e139c0db122a8f41cbf05553f1020063bed47f3897f760a702bf54361a51d5c7e6cf1b53da6db7a1d52ae69a3
+  data.tar.gz: 3fcd97b89c919e3491ae224bfca305b27d2073b97f92b273b9fb75ef6e87b45d67a3b82247f91133ce8e201d907f46aae3bdc988a2309c24e30ff34e01d65d3b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at brettallred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 NUVI
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brett Allred
+
+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/README.md

@@ -0,0 +1,87 @@
+# FeatureCop
+
+Feature cop is a simple feature toggling system for Ruby. All features are configured in the ENV, following the guidelines of a [12-Factor App](http://12factor.net/config)
+
+## Installation
+
+Using Bundler
+
+```ruby
+gem 'feature_cop'
+
+```
+Or install it yourself as:
+
+    $ gem install feature_cop
+
+
+## Basic Usage - Ruby
+
+Add features definitions to your ENV
+
+```
+MY_COOL_FEATURE = enabled
+LOGIN_V2_FEATURE = disabled
+```
+
+NOTE:
+Adding key values pairs to your ENV can be done in a number of ways. The above way is using .env file in conjuction with the [dot-env gem](https://github.com/bkeepers/dotenv)
+
+
+Use FeatureCop.allows? in your ruby code
+
+```ruby
+
+if FeatureCop.allows?(:my_cool_feature)
+   # execute new feature code
+else
+   # execute old feature code
+end
+```
+
+
+## Basic Usage - Javascript
+
+To use features in client side javascript, use  the ```FeatureCop.to_json``` helper.  This creates a JSON representation of the features so they can be sent to the client.  
+
+Notice: Feature names are converted to camelcase.  Also, values are converted to boolean values.
+
+```
+FeatureCop.to_json
+#=>
+{
+
+  "myCoolFeature"     : true
+  "loginV1Feature"    : false
+   "menubarV3Feature" : true
+}
+
+```
+
+Because javascript patterns & frameworks vary wildly and change often, we have opted not to provide any furtuer javascript helpers.  The easiset way to use FeatureCop in your client side is to get features into window.env, then you can use simple if statements to control features.
+
+```javascript
+ if(window.env.features.myCoolFeature === true) {
+   // execute new feature code
+ }else
+ {
+   // execute new feature code
+ }
+```
+
+Boom! Now you have feature flags!
+
+For more advanced usage, [see our wiki](https://github.com/nuvi/feature_cop/wiki)!
+
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/feature_cop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "feature_cop"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/feature_cop.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feature_cop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feature_cop"
+  spec.version       = FeatureCop::VERSION
+  spec.authors       = ["Brett Allred"]
+  spec.email         = ["brettallred@gmail.com"]
+
+  spec.summary       = %q{A simple gem for handing feature flagging in ruby}
+  spec.description   = %q{A simple gem for handing feature flagging in ruby}
+  spec.homepage      = "http://www.github.com/nuvi/feature_cop"
+  spec.license       = "MIT"
+
+  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_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/feature_cop/blacklist.rb

@@ -0,0 +1,37 @@
+module FeatureCop
+  module Blacklist
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def blacklist_from_yaml(file = "feature_cop_blacklist.yml")
+        if ::File.exists?(file)
+          absolute_path = file       
+        else
+          absolute_path = ::File.expand_path(::File.join("config", file))
+          raise "#{file} not found!" unless ::File.exists?(absolute_path)
+        end
+
+        self.blacklist = ::YAML.load_file(absolute_path)[env]      
+      end
+
+      def all_except_blacklist(identifier)
+        return true if @blacklist.nil?
+        !@blacklist.include?(identifier)
+      end
+
+
+      def blacklist
+        @blacklist 
+      end
+
+      def blacklist=(blacklist)
+        @blacklist = blacklist
+      end
+
+    end
+  end
+end

data/lib/feature_cop/enumerable_extensions.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  def sum(identity = 0, &block)
+    if block_given?
+      map(&block).sum(identity)
+    else
+      inject { |sum, element| sum + element } || identity
+    end
+  end
+end

data/lib/feature_cop/version.rb

@@ -0,0 +1,3 @@
+module FeatureCop
+  VERSION = "0.1.0"
+end

data/lib/feature_cop/whitelist.rb

@@ -0,0 +1,35 @@
+module FeatureCop
+  module Whitelist
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def whitelist_from_yaml(file = "feature_cop_whitelist.yml")
+        if ::File.exists?(file)
+          absolute_path = file       
+        else
+          absolute_path = ::File.expand_path(::File.join("config", file))
+          raise "#{file} not found!" unless ::File.exists?(absolute_path)
+        end
+
+        self.whitelist = ::YAML.load_file(absolute_path)[env]      
+      end
+
+      def whitelist
+        @whitelist
+      end
+
+      def whitelist=(whitelist)
+        @whitelist = whitelist
+      end
+
+      def whitelist_only(identifier)
+        return false if @whitelist.nil?
+        @whitelist.include?(identifier)
+      end
+    end
+  end
+end

data/lib/feature_cop.rb

@@ -0,0 +1,71 @@
+require "rubygems"
+require "active_support/inflector"
+require "active_support/inflections"
+require "feature_cop/version"
+require "feature_cop/enumerable_extensions"
+require "feature_cop/whitelist"
+require "feature_cop/blacklist"
+require "json"
+require "yaml"
+
+
+
+module FeatureCop
+  include FeatureCop::Whitelist
+  include FeatureCop::Blacklist
+
+  def self.allows?(feature, identifier = nil, opts = {})
+    feature_status = ENV["#{feature.to_s.upcase}"]
+    return false if feature_status.nil? 
+    self.method(feature_status.downcase).call(identifier)
+  end
+
+  def self.enabled(identifier)
+    true
+  end
+
+  def self.disabled(identifier)
+    false
+  end
+
+  def self.env
+    @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["APP_ENV"] || ENV["APP_ENV"] || "development"
+  end
+
+  def self.features
+    @features ||= self.set_features
+  end
+
+  def self.reset_features
+    @features = self.set_features
+  end
+
+  def self.sample10(identifier)
+    identifier.bytes.sum % 10 == 0 
+  end
+
+  def self.sample25(identifier)
+    identifier.bytes.sum % 4 == 0 
+  end
+
+  def self.sample50(identifier)
+    identifier.bytes.sum % 2 == 0 
+  end
+
+  def self.set_features
+    features = {}
+    ENV.each_pair do |key, value|
+      features[key] = value if key.end_with?("_FEATURE")
+    end
+    return features
+  end
+  
+  def self.to_json(identifier = nil)
+    feature_set = {}
+    features.each_pair do |key, value|
+      feature_set[key.downcase.camelize(:lower)] = self.method(value.downcase).call(identifier)  
+    end
+    feature_set.to_json
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: feature_cop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brett Allred
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple gem for handing feature flagging in ruby
+email:
+- brettallred@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feature_cop.gemspec
+- lib/feature_cop.rb
+- lib/feature_cop/blacklist.rb
+- lib/feature_cop/enumerable_extensions.rb
+- lib/feature_cop/version.rb
+- lib/feature_cop/whitelist.rb
+homepage: http://www.github.com/nuvi/feature_cop
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple gem for handing feature flagging in ruby
+test_files: []