flop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1be972aa3ae27087ea067523e5c91ae74cbfd123
+  data.tar.gz: fe5db96c968e40888f2443c53e5f3a8d18b55390
+SHA512:
+  metadata.gz: b9853f11882c1edbe0e32dd802210fb411d1ff0bdc1198d43ffe51dcba250cf0e7a82878e4fbe4d79147628971e681d641fa8b3bb4a41f050f35946386102d1c
+  data.tar.gz: 7f439d941911c295240329035ce5704c91e31855dd017b5bc2bac67b8e6277b70ae526e54cf802537613b810c84d985221e4a2eeb31b8818c07bbd6f3f508342

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guillaume DOTT
+
+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,89 @@
+# Flop
+
+Flop is a feature flipper gem for ruby.
+
+Toggle features on and off easily and store feature states in memory or in redis
+with the different repositories.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flop'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flop
+
+## Repositories
+
+First, you need to configure where to store everything by setting a repository.
+
+Available repositories are :
+- `Flop::Repository::Memory`
+- `Flop::Repository::Redis`
+
+To set the repository, create a new object and affect it to `Flop.repo`.
+```ruby
+Flop.repo = Flop::Repository::Memory.new
+
+require 'redis'
+
+Flop.repo = Flop::Repository::Redis.new(Redis.new)
+```
+
+### Redis
+
+The `Redis` repository requires a `Redis` connection as its first parameter.
+The default namespace can be passed as a second parameter.
+
+The default namespace can be a string, an array or a proc.
+
+```ruby
+Flop::Repository::Redis.new(Redis.new, "flop:namespace")
+Flop::Repository::Redis.new(Redis.new, [:flop, :namespace])
+Flop::Repository::Redis.new(Redis.new, -> { ENV['NAMESPACE'] })
+```
+
+## Features
+
+To access a feature, you can call the Flop[] method or create a new `Flop::Feature` object.
+```ruby
+Flop[:example_feature] # is the same as
+Flop::Feature.new(:example_feature)
+```
+
+Available methods on `Flop::Feature` are :
+- `feature.active?` returns true if the feature is active
+- `feature.inactive?` returns true if the feature is inactive
+- `feature.set(boolean)` sets the state of the feature to the passed value
+- `feature.activate` activates the feature
+- `feature.deactivate` deactivates the feature
+- `feature.toggle` toggles the state of the feature
+- `feature.with { }` executes the block if the feature is active
+- `feature.without { }` executes the block if the feature is inactive
+
+## Examples
+
+```ruby
+Flop.repo = Flop::Repository::Memory.new
+
+Flop[:feature].active? # => false
+Flop[:feature].toggle # => true
+
+Flop[:feature].with do
+  # code
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gdott9/flop/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,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = Dir['test/**/*_test.rb']
+end

data/flop.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flop"
+  spec.version       = Flop::VERSION
+  spec.authors       = ["Guillaume DOTT"]
+  spec.email         = ["guillaume+github@dott.fr"]
+  spec.summary       = %q{A simple ruby feature flipper}
+  spec.description   = %q{Activate and deactivate features easily}
+  spec.homepage      = 'https://github.com/gdott9/flop'
+  spec.license       = 'MIT'
+
+  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{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0'
+  spec.add_development_dependency 'fakeredis', '~> 0.5'
+end

data/lib/flop.rb

@@ -0,0 +1,19 @@
+require 'flop/version'
+
+require 'flop/feature'
+require 'flop/repository/memory'
+require 'flop/repository/redis'
+
+module Flop
+  class << self
+    attr_writer :repo
+
+    def repo
+      @repo ||= Flop::Repository::Memory.new
+    end
+
+    def [](feature)
+      Flop::Feature.new(feature)
+    end
+  end
+end

data/lib/flop/feature.rb

@@ -0,0 +1,43 @@
+module Flop
+  class Feature
+    attr_accessor :name, :repo
+
+    def initialize(name, repo = Flop.repo)
+      self.name = name.to_sym
+      self.repo = repo
+    end
+
+    def active?
+      repo.get(name)
+    end
+
+    def inactive?
+      !active?
+    end
+
+    def set(value)
+      repo.set(name, value)
+      value
+    end
+
+    def activate
+      set true
+    end
+
+    def deactivate
+      set false
+    end
+
+    def toggle
+      set !active?
+    end
+
+    def with(&block)
+      yield block if active?
+    end
+
+    def without(&block)
+      yield block if inactive?
+    end
+  end
+end

data/lib/flop/repository/memory.rb

@@ -0,0 +1,17 @@
+module Flop
+  module Repository
+    class Memory
+      def initialize
+        @features = Hash.new(false)
+      end
+
+      def get(name)
+        @features[name]
+      end
+
+      def set(name, value)
+        @features[name] = value
+      end
+    end
+  end
+end

data/lib/flop/repository/redis.rb

@@ -0,0 +1,28 @@
+module Flop
+  module Repository
+    class Redis
+      def initialize(redis, namespace = '')
+        @redis = redis
+        @namespace = namespace
+      end
+
+      def get(name)
+        @redis.get(key(name)).to_i == 1
+      end
+
+      def set(name, value)
+        @redis.set(key(name), value ? 1 : 0)
+      end
+
+      private
+
+      def key(name)
+        [namespace, name].flatten.join(':')
+      end
+
+      def namespace
+        @namespace.is_a?(Proc) ? @namespace.call : @namespace
+      end
+    end
+  end
+end

data/lib/flop/version.rb

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

data/test/flop/feature_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class Flop::FeatureTest < Minitest::Test
+  def setup
+    @feature = Flop::Feature.new(:test)
+  end
+
+  def test_it_is_inactive_by_default
+    assert Flop::Feature.new(:inactive_feature).inactive?
+  end
+
+  def test_that_name_is_symbol
+    assert_equal :string, Flop::Feature.new('string').name
+  end
+
+  def test_set_specified_value
+    @feature.set true
+    assert @feature.active?
+
+    @feature.set false
+    assert @feature.inactive?
+  end
+
+  def test_toggle
+    @feature.deactivate
+
+    @feature.toggle
+    assert @feature.active?
+  end
+
+  def test_activate
+    @feature.activate
+    assert @feature.active?
+  end
+
+  def test_deactivate
+    @feature.deactivate
+    assert @feature.inactive?
+  end
+
+  def test_with_executes_block
+    @feature.deactivate
+    assert_nil @feature.with { true }
+
+    @feature.activate
+    assert @feature.with { true }
+  end
+
+  def test_without_executes_block
+    @feature.deactivate
+    assert @feature.without { true }
+
+    @feature.activate
+    assert_nil @feature.without { true }
+  end
+end

data/test/flop/repository/generic_repo_example.rb

@@ -0,0 +1,13 @@
+module Flop::Repository::GenericRepoExample
+  def test_default_value_is_false
+    refute @repo.get(:unknown_key), 'default value is not false'
+  end
+
+  def test_get_value
+    @repo.set(:test, true)
+    @repo.set(:test2, false)
+
+    assert_equal true, @repo.get(:test)
+    assert_equal false, @repo.get(:test2)
+  end
+end

data/test/flop/repository/memory_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+require 'flop/repository/generic_repo_example'
+
+class Flop::Repository::MemoryTest < Minitest::Test
+  def setup
+    @repo = Flop::Repository::Memory.new
+  end
+
+  include Flop::Repository::GenericRepoExample
+end

data/test/flop/repository/redis_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+require 'flop/repository/generic_repo_example'
+require 'fakeredis'
+
+class Flop::Repository::RedisTest < Minitest::Test
+  def setup
+    @repo = Flop::Repository::Redis.new(Redis.new)
+  end
+
+  include Flop::Repository::GenericRepoExample
+end

data/test/flop_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FlopTest < Minitest::Test
+  def test_that_return_feature
+    assert_instance_of Flop::Feature, Flop[:test]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+require 'flop'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: flop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume DOTT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Activate and deactivate features easily
+email:
+- guillaume+github@dott.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flop.gemspec
+- lib/flop.rb
+- lib/flop/feature.rb
+- lib/flop/repository/memory.rb
+- lib/flop/repository/redis.rb
+- lib/flop/version.rb
+- test/flop/feature_test.rb
+- test/flop/repository/generic_repo_example.rb
+- test/flop/repository/memory_test.rb
+- test/flop/repository/redis_test.rb
+- test/flop_test.rb
+- test/test_helper.rb
+homepage: https://github.com/gdott9/flop
+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: A simple ruby feature flipper
+test_files:
+- test/flop/feature_test.rb
+- test/flop/repository/generic_repo_example.rb
+- test/flop/repository/memory_test.rb
+- test/flop/repository/redis_test.rb
+- test/flop_test.rb
+- test/test_helper.rb