togl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a490d4260342d1ab7ddcce025f11fdad6464d7
+  data.tar.gz: d6ca68b24b89b364b0ff534af5207ced033b145e
+SHA512:
+  metadata.gz: a926954cd466dabb04212907cabf84a2411b74047fcdcca1a1d30d56a69364ddd3bf7822c3e262b8a39499972aca09c56d1fe3da5f7c2a95a006acc96794166d
+  data.tar.gz: bb9014d73d3bded301bb02825fbd4a6b271016de9882e12a0724cb8fcbf1110d919de1e745ba88333ec0f0f4b224a6f1d04b1db4cf5f2baa5a220058aacc806a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+-rspec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Arne Brasseur
+
+MIT License
+
+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,30 @@
+# Togl
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'togl'
+```
+
+And then execute:
+
+    $ gem install -g
+
+
+Or install it directly:
+
+    $ gem install togl
+
+## Usage
+
+
+## Contributing
+
+1. Fork it ( https://github.com/plexus/togl/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

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems/package_task'
+
+spec = Gem::Specification.load(File.expand_path('../togl.gemspec', __FILE__))
+gem = Gem::PackageTask.new(spec)
+gem.define
+
+desc "Push gem to rubygems.org"
+task :push => :gem do
+  sh "git tag v#{Togl::VERSION}"
+  sh "git push --tags"
+  sh "gem push pkg/togl-#{Togl::VERSION}.gem"
+end
+
+require 'mutant'
+task :default => :mutant
+
+desc "run mutant"
+task :mutant do
+  pattern = ENV.fetch('PATTERN', 'Togl*')
+  opts    = ENV.fetch('MUTANT_OPTS', '').split(' ')
+  result  = Mutant::CLI.run(%w[-Ilib -rtogl --use rspec --score 100] + opts + [pattern])
+  fail unless result == Mutant::CLI::EXIT_SUCCESS
+end
+
+require 'rspec/core/rake_task'
+
+desc "run rspec"
+RSpec::Core::RakeTask.new(:rspec) do |t, task_args|
+  t.rspec_opts = "-Ispec"
+  t.pattern = "spec"
+end

data/lib/togl.rb

@@ -0,0 +1,30 @@
+require "attribs"
+require "togl/version"
+require "rack/utils"
+
+module Togl
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure(&block)
+    Config::Builder.new(config, &block)
+    config
+  end
+
+  def on?(feature)
+    config.on?(feature)
+  end
+
+  def off?(feature)
+    config.on?(feature)
+  end
+end
+
+require "togl/feature"
+require "togl/util"
+require "togl/adapter"
+require "togl/adapter/rack_session"
+require "togl/config"
+require "togl/config/builder"
+require "togl/rack/middleware"

data/lib/togl/adapter.rb

@@ -0,0 +1,11 @@
+module Togl
+  class Adapter
+    def self.all
+      @all ||= {}
+    end
+
+    def self.register(name, callable)
+      Adapter.all[name] = callable
+    end
+  end
+end

data/lib/togl/adapter/rack_session.rb

@@ -0,0 +1,11 @@
+module Togl
+  class Adapter
+    class RackSession < self
+      register :rack_session, self
+
+      def self.call(name)
+        Thread.current[:togl_session_features][name.to_s]
+      end
+    end
+  end
+end

data/lib/togl/config.rb

@@ -0,0 +1,51 @@
+module Togl
+  class Config
+    include Attribs.new(:features, :adapters, :default_adapters)
+    attr_writer :default_adapters
+
+    def initialize(args = {}, &block)
+      super({features: [], adapters: Adapter.all, default_adapters: []}.merge(args))
+      Builder.new(self, &block) if block_given?
+    end
+
+    def add_feature(name, opts = {})
+      name = name.to_sym
+      opts = {
+        name: name,
+        config: self,
+        adapters: default_adapters
+      }.merge(opts)
+      features.push(Feature.new(opts))
+      self
+    end
+
+    def add_adapter(name, callable)
+      name = name.to_sym
+      adapters.merge!(name => callable)
+      self
+    end
+
+    def fetch(name)
+      name = name.to_sym
+      features.detect do |feature|
+        feature.name.equal?(name)
+      end
+    end
+
+    def fetch_adapter(name)
+      adapters.fetch(name.to_sym)
+    end
+
+    def on?(name)
+      fetch(name).on?
+    end
+
+    def off?(name)
+      !on?(name)
+    end
+
+    def rack_middleware
+      Rack::Middleware
+    end
+  end
+end

data/lib/togl/config/builder.rb

@@ -0,0 +1,22 @@
+module Togl
+  class Config
+    class Builder
+      def initialize(config, &block)
+        @config = config
+        instance_eval(&block)
+      end
+
+      def feature(name, opts = {})
+        @config.add_feature(name, opts)
+      end
+
+      def adapter(name, callable)
+        @config.add_adapter(name, callable)
+      end
+
+      def adapters(*adapters)
+        @config.default_adapters = adapters
+      end
+    end
+  end
+end

data/lib/togl/feature.rb

@@ -0,0 +1,24 @@
+module Togl
+  class Feature
+    include Attribs.new(:name, :config, default: :off, adapters: [])
+
+    def on?
+      on = adapters.reduce(nil) do |memo, adapter|
+        if [true, false].include?(memo)
+          memo
+        else
+          adapter_on?(adapter)
+        end
+      end
+      if on.nil?
+        default.equal?(:on)
+      else
+        on
+      end
+    end
+
+    def adapter_on?(adapter)
+      config.fetch_adapter(adapter).call(name)
+    end
+  end
+end

data/lib/togl/rack/middleware.rb

@@ -0,0 +1,35 @@
+module Togl
+  module Rack
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Thread.current[:togl_session_features] = detect_feature_params(env)
+        @app.call(env)
+        Thread.current[:togl_session_features] = nil
+      end
+
+      def detect_feature_params(env)
+        params = ::Rack::Utils.parse_query(env["QUERY_STRING"])
+        session = env["rack.session"]
+        session_features = session["features"] || {}
+        { ["enable_feature", "enable_features"]   => true,
+          ["disable_feature", "disable_features"] => false,
+          ["reset_feature", "reset_features"]     => nil }.each do |keys, flag|
+          keys.each do |key|
+            feature_names(params, key).each do |feature|
+              session_features[feature] = flag
+            end
+          end
+        end
+        session_features
+      end
+
+      def feature_names(params, key)
+        params.fetch(key, "").split(",").map(&:strip)
+      end
+    end
+  end
+end

data/lib/togl/util.rb

@@ -0,0 +1,10 @@
+module Togl
+  module Util
+    module_function
+
+    def camelize(str)
+      str.gsub(/\/(.?)/)     { "::#{ $1.upcase }" }
+        .gsub!(/(?:^|_)(.)/) { $1.upcase          }
+    end
+  end
+end

data/lib/togl/version.rb

@@ -0,0 +1,3 @@
+module Togl
+  VERSION = "0.0.1"
+end

data/spec/integration_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe "high level usage examples" do
+  let(:togl) do
+    Togl::Config.new do
+      adapters :rack_session
+
+      feature :hero
+      feature :frontend
+    end
+  end
+
+  specify do
+    called = false
+
+    app = ->(env) do
+      called = true
+
+      expect(togl.on? :hero).to be true
+      expect(togl.on? :frontend).to be false
+    end
+
+    app = togl.rack_middleware.new(app)
+    env = {
+      "rack.session" => {},
+      "QUERY_STRING" => "enable_feature=hero"
+    }
+    app.call(env)
+
+    expect(called).to be true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bogus/rspec'
+require 'timeout'
+require 'togl'
+
+RSpec.configure do |rspec|
+  rspec.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
+  rspec.disable_monkey_patching!
+  rspec.raise_errors_for_deprecations!
+  # rspec.around(:each) do |example|
+  #   Timeout.timeout(1, &example)
+  # end
+end
+
+Bogus.configure do |bogus|
+  bogus.search_modules << Togl
+end

data/spec/togl/config/builder_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe Togl::Config::Builder do
+  let(:config) { Togl::Config.new }
+  let!(:builder) {
+    Togl::Config::Builder.new(config) do
+      feature :foo, default: :on
+      feature :bar
+      adapters :rack_session
+    end
+  }
+
+  describe "#initialize" do
+    it "takes a Togl config and a configuration block" do
+      expect(config.fetch(:foo)).to eql Togl::Feature.new(name: :foo, default: :on, config: config)
+    end
+  end
+
+  describe "#feature" do
+    it "works with only a name" do
+      expect(config.fetch(:bar)).to eql Togl::Feature.new(name: :bar, config: config)
+
+    end
+  end
+end

data/spec/togl/config_spec.rb

@@ -0,0 +1,93 @@
+RSpec.describe Togl::Config do
+  let(:config) do
+    described_class.new
+      .add_feature("foo")
+      .add_adapter("foo", ->(n){ :result })
+      .add_adapter("bar", ->(n){ :rasilt })
+  end
+
+  describe "#initialize" do
+    it "should take a block for building the config" do
+      config = described_class.new do
+        feature :foo
+      end
+
+      expect(config.features.map(&:name)).to eql [:foo]
+    end
+
+    it "should take arguments to override the defaults" do
+      config = described_class.new(default_adapters: [:rack, :session])
+      expect(config.default_adapters).to eql [:rack, :session]
+    end
+
+    it "should have defaults for its attributes" do
+      config = described_class.new
+      expect(config.features).to eql []
+      expect(config.adapters).to eql Togl::Adapter.all
+      expect(config.default_adapters).to eql []
+    end
+  end
+
+  describe "#add_feature" do
+    it "should append a feature to the list" do
+      expect(config.features).to eql [Togl::Feature.new(name: :foo, config: config)]
+    end
+
+    it "takes options" do
+      config.add_feature(:wammie, adapters: [:redis, :rack])
+      expect(config.fetch(:wammie))
+        .to eql Togl::Feature.new(name: :wammie, config: config, adapters: [:redis, :rack])
+    end
+
+    it "should use default adapters if none given" do
+      config.default_adapters.push(:rack)
+      config.add_feature(:lisa)
+      expect(config.fetch(:lisa)).to eql Togl::Feature.new(name: :lisa, config: config, adapters: [:rack])
+    end
+  end
+
+  describe '#fetch' do
+    let(:config) do
+      described_class.new
+        .add_feature(:foo)
+        .add_feature("bar")
+        .add_feature(:baz)
+    end
+
+    it "should find a feature object by name" do
+      expect(config.fetch("bar")).to eql Togl::Feature.new(name: :bar, config: config)
+    end
+  end
+
+  describe "#on?" do
+    fake(:feature, name: :disrupt)
+    it "should delegate to the feature" do
+      config = self.config.append_to(:features, feature)
+
+      config.on?("disrupt")
+      expect(feature).to have_received.on?
+    end
+  end
+
+  describe "#add_adapter" do
+
+    it "should store the adapter" do
+      expect(config.adapters[:foo].call(:bar)).to equal :result
+    end
+  end
+
+  describe "#fetch_adapter" do
+    it "should return the adapter by name" do
+      expect(config.fetch_adapter("bar").call(1)).to equal :rasilt
+    end
+  end
+
+  describe "rack_middleware" do
+    it "should return a rack middleware builder" do
+      Togl::Config::Builder.new(config) do
+        adapters :rack_session
+      end
+      expect(config.rack_middleware.new(->(env){})).to be_a Togl::Rack::Middleware
+    end
+  end
+end

data/spec/togl/feature_spec.rb

@@ -0,0 +1,63 @@
+RSpec.describe Togl::Feature do
+  subject(:feature) do
+    described_class.new(
+      name: name,
+      config: config,
+      default: default,
+      adapters: adapters
+    )
+  end
+
+  let(:name) { :eric }
+  let(:config) { Togl::Config.new }
+  let(:default) { :off }
+  let(:adapters) { [] }
+
+  describe "#on?" do
+    it "should be disabled by default" do
+      expect(feature.on?).to be false
+    end
+
+    context "when on by default" do
+      let(:adapters) { [:s1, :s2] }
+      let(:default) { :on }
+
+      it "should be on if all strategues return nil" do
+        config
+          .add_adapter(:s1, ->(name){ nil })
+          .add_adapter(:s2, ->(name){ nil })
+        expect(feature.on?).to be true
+      end
+    end
+
+    context "with adapters" do
+      let(:adapters) { [:s1, :s2] }
+
+      it "should be on if the adapter returns true - skipping nils" do
+        config
+          .add_adapter(:s1, ->(name){ nil })
+          .add_adapter(:s2, ->(name){ name == :eric })
+        expect(feature.on?).to be true
+      end
+
+      it "should be off if the adapter returns false - skipping nils" do
+        config
+          .add_adapter(:s1, ->(name){ nil })
+          .add_adapter(:s2, ->(name){ name != :eric })
+        expect(feature.on?).to be false
+      end
+
+      it "should be on if the adapter returns true" do
+        config
+          .add_adapter(:s1, ->(name){ name == :eric })
+        expect(feature.on?).to be true
+      end
+
+      it "should be off if the adapter returns false" do
+        config
+          .add_adapter(:s1, ->(name){ name != :eric })
+        expect(feature.on?).to be false
+      end
+    end
+  end
+end

data/spec/togl_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Togl do
+  describe ".config" do
+    it "should return a Togl::Config" do
+      expect(Togl.config).to be_a Togl::Config
+    end
+
+    it "should memoize" do
+      expect(Togl.config).to equal Togl.config
+    end
+  end
+end

data/togl.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+require File.expand_path("../lib/togl/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "togl"
+  spec.version       = Togl::VERSION
+  spec.authors       = ["Arne Brasseur"]
+  spec.email         = ["arne@arnebrasseur.net"]
+  spec.summary       = %q{Perfect Features Toggles}
+  spec.description   = %q{Multi-strategy feature flags.}
+  spec.homepage      = "https://github.com/plexus/togl"
+  spec.license       = "MIT"
+
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.extra_rdoc_files = %w[README.md]
+
+  spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency "attribs", "~> 1.0"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "mutant-rspec"
+  spec.add_development_dependency "bogus"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: togl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arne Brasseur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: attribs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  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: bogus
+  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: Multi-strategy feature flags.
+email:
+- arne@arnebrasseur.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/togl.rb
+- lib/togl/adapter.rb
+- lib/togl/adapter/rack_session.rb
+- lib/togl/config.rb
+- lib/togl/config/builder.rb
+- lib/togl/feature.rb
+- lib/togl/rack/middleware.rb
+- lib/togl/util.rb
+- lib/togl/version.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/togl/config/builder_spec.rb
+- spec/togl/config_spec.rb
+- spec/togl/feature_spec.rb
+- spec/togl_spec.rb
+- togl.gemspec
+homepage: https://github.com/plexus/togl
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Perfect Features Toggles
+test_files:
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/togl/config/builder_spec.rb
+- spec/togl/config_spec.rb
+- spec/togl/feature_spec.rb
+- spec/togl_spec.rb