feature_flagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74316fc70e25aa5098d8e500a59b1a983dabff2d
+  data.tar.gz: 98f838a09eb04c89b5f5f36b4b3a84859de36b14
+SHA512:
+  metadata.gz: f9b56d90d8bda18e090fb81b84387aef0c9bc053e09c758b2cbe3ebc38103b2a7208049c5bb822dfe036750ffde5ed4736341956234b8bb0bc4f083f342622e2
+  data.tar.gz: a00d2a9aac2e8ab2082f7ec6950a73f0d1653a9497ea0ee7b69adf15e8f0ee8311d82c0dd0e2fbcefc1437cf4618de0325432fb4e6f7a23db49b6567e8d4ae87

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,62 @@
+# FeatureFlagger
+
+Partial release your features.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'feature_flagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feature_flagger
+
+## Usage
+
+### Rails
+
+1. Create a `rollout.yml` in _config_ path and declare a rollout:
+```yml
+account: # model name
+  email_marketing: # namespace (optional)
+    new_email_flow: # feature key
+      description:
+        @dispatch team uses this rollout to introduce a new email flow for certains users. Read more at [link]
+```
+
+2. Adds rollout funcionality to your model:
+```ruby
+class Account < ActiveRecord::Base
+  include FeatureFlagger::Model
+  # ....
+end
+```
+
+
+3. Check;
+```ruby
+class DashboardController < ApplicationController
+  def index
+    if current_user.account.rollout?([:email_marketing, :new_email_flow])
+      # render something
+    else
+      # render something else
+    end
+  end
+end
+```
+
+P.S: If you try to check a inexistent rollout key will raise an error.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ResultadosDigitais/feature_flagger.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rollout"
+
+# 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_flagger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feature_flagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feature_flagger"
+  spec.version       = FeatureFlagger::VERSION
+  spec.authors       = ["Nando Sousa"]
+  spec.email         = ["nandosousafr@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "http://github.com/ResultadosDigitais/feature_flagger"
+
+  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 'redis-namespace'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/feature_flagger.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+require 'redis-namespace'
+
+require 'feature_flagger/version'
+require 'feature_flagger/control'
+require 'feature_flagger/model'
+require 'feature_flagger/feature'
+
+module FeatureFlagger
+  DEFAULT_CONFIG = { redis_namespace: 'rollout-control' }
+
+  class << self
+    def configure(&block)
+      set_config
+      yield self if block_given?
+    end
+
+    # TODO: rename to just _config_.
+    def config
+      @@config
+    end
+
+    def redis
+      redis_conn = @@config[:redis]
+      namespace  = @@config[:redis_namespace]
+      @@redis ||= Redis::Namespace.new(namespace, redis: redis_conn)
+    end
+
+    def redis=(conn)
+      set_config
+      @@config[:redis] = conn
+    end
+
+    def redis_namespace=(namespace)
+      set_config
+      @@config[:redis_namespace] = namespace
+    end
+
+    private
+
+    def set_config
+      @@config ||= DEFAULT_CONFIG
+
+      # TODO: Provide a Rake to generate initial YAML file
+      # for new projects.
+
+      if defined?(Rails)
+        @@config[:yaml_filepath] ||= "#{Rails.root}/config/rollout.yml"
+      end
+
+      if file_path = @@config[:yaml_filepath]
+        @@config[:info] ||= YAML.load_file(file_path)
+      end
+    end
+  end
+end

data/lib/feature_flagger/control.rb

@@ -0,0 +1,33 @@
+module FeatureFlagger
+  module Control
+    extend self
+
+    def rollout?(feature_key, resource_id, resource_name = nil)
+      feature_key = rsolv_key(feature_key, resource_name)
+      FeatureFlagger.redis.sismember(feature_key, resource_id)
+    end
+
+    def release!(feature_key, resource_id, resource_name = nil)
+      feature_key = rsolv_key(feature_key, resource_name)
+      FeatureFlagger.redis.sadd(feature_key, resource_id)
+    end
+
+    def unrelease!(feature_key, resource_id, resource_name = nil)
+      feature_key = rsolv_key(feature_key, resource_name)
+      FeatureFlagger.redis.srem(feature_key, resource_id)
+    end
+
+    def resource_ids(feature_key, resource_name = nil)
+      feature_key = rsolv_key(feature_key, resource_name)
+      FeatureFlagger.redis.smembers(feature_key)
+    end
+
+    private
+
+    def rsolv_key(feature_key, resource_name = nil)
+      feature_key_arr = Array(feature_key)
+      feature_key_arr.insert(0, resource_name) unless resource_name.nil?
+      feature_key_arr.join(':')
+    end
+  end
+end

data/lib/feature_flagger/feature.rb

@@ -0,0 +1,36 @@
+module FeatureFlagger
+  class Feature
+
+    def initialize(key, resource_name = nil)
+      @key = resource_name.nil? ? key : key.clone.insert(0, resource_name)
+      @key = Array(@key).collect(&:to_s)
+      @doc = FeatureFlagger.config[:info]
+    end
+
+    def fetch!
+      @data ||= find_value(@doc, *@key)
+      raise FeatureFlagger::KeyNotFoundError.new(@key) if @data.nil?
+      @data
+    end
+
+    def description
+      fetch!
+      @data['description']
+    end
+
+    private
+
+    def find_value(hash, key, *tail)
+      value = hash[key]
+
+      if value.nil? || tail.empty?
+        value
+      else
+        find_value(value, *tail)
+      end
+    end
+
+  end
+end
+
+class FeatureFlagger::KeyNotFoundError < StandardError ; end

data/lib/feature_flagger/model.rb

@@ -0,0 +1,38 @@
+module FeatureFlagger
+  # Model provides convinient methods for Rails Models
+  # class Account
+  #   include FeatureFlagger::Model
+  # end
+  #
+  # Example:
+  # Account.first.rollout?([:email_marketing, :new_awesome_feature])
+  # #=> true
+  module Model
+    def rollout?(feature_key)
+      Feature.new(feature_key, rollout_resource_name).fetch!
+      Control.rollout?(feature_key, id, rollout_resource_name)
+    end
+
+    def release!(feature_key)
+      Feature.new(feature_key, rollout_resource_name).fetch!
+      Control.release!(feature_key, id, rollout_resource_name)
+    end
+
+    def unrelease!(feature_key)
+      Feature.new(feature_key, rollout_resource_name).fetch!
+      Control.unrelease!(feature_key, id, rollout_resource_name)
+    end
+
+    private
+
+    def rollout_resource_name
+      klass_name = self.class.name
+      klass_name.gsub!(/::/, '_')
+      klass_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      klass_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      klass_name.tr!("-", "_")
+      klass_name.downcase!
+      klass_name
+    end
+  end
+end

data/lib/feature_flagger/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: feature_flagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Sousa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Write a longer description or delete this line.
+email:
+- nandosousafr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feature_flagger.gemspec
+- lib/feature_flagger.rb
+- lib/feature_flagger/control.rb
+- lib/feature_flagger/feature.rb
+- lib/feature_flagger/model.rb
+- lib/feature_flagger/version.rb
+homepage: http://github.com/ResultadosDigitais/feature_flagger
+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.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files: []
+has_rdoc: