togls 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29cf1b0568aea63a9f302b01727e2b03e2f6b022
+  data.tar.gz: 7b109336122ffd30f15621b8b769d3ad0556bd34
+SHA512:
+  metadata.gz: 76ed9cf6f4d3b726902a8332fb16b57a1f4355cd3004cf0eca1f73228a9e4c304a89c967ebf157ebe5b3cc5003809223ed5dfd2577eb78dbc9197d4567bd7f05
+  data.tar.gz: 466bb270590c5a5000340ce3585da8f51195ae9016f79b1200d09dcc2f2f620a3809ac4168b1f1b9b51f1dff6ca6f5911b15e4a3e4fd5303d0e35742db4357c9

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

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/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/ChangeLog.md

@@ -0,0 +1,14 @@
+# ChangeLog
+
+The following are lists of the notable changes included with each release.
+This is intended to help keep people informed about notable changes between
+versions, as well as provide a rough history.
+
+#### Next Release
+
+#### v0.1.0
+
+* Add concept of Groups as a provided rule
+* Add concept of Rules and Custom Rules, allowing users to have more dynamic
+  feature toggles
+* Add basic feature toggles able to be switched on/off

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in togl.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian Miller
+
+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,96 @@
+[![Build Status](https://travis-ci.org/codebreakdown/togls.svg?branch=master)](https://travis-ci.org/codebreakdown/togls)
+[![Code Climate](https://img.shields.io/codeclimate/github/codebreakdown/togls.svg)](https://codeclimate.com/github/codebreakdown/togls)
+[![Code
+Coverage](https://img.shields.io/codeclimate/coverage/github/codebreakdown/togls.svg)](https://codeclimate.com/github/codebreakdown/togls)
+[![Dependency Status](https://gemnasium.com/codebreakdown/togls.svg)](https://gemnasium.com/codebreakdown/togls)
+
+# Togls
+
+A lightweight feature toggle library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'togls'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install togls
+
+## Usage
+
+### Setup
+
+The default behaviour for any feature that has not been defined that is accessed is to default to false.
+
+```ruby
+Togls.features do
+  # Set this feature to always be on
+  feature(:pop_up_login_form).on 
+  # Set this feature to always be off
+  feature(:send_follup_email).off
+  # Create a group rule
+  rule = Togls::Rules::Group.new(["user@email.com"])
+  feature(:new_contact_form).on(rule)
+end
+```
+
+### Evaluate
+
+```ruby
+if Togls.feature(:new_contact_form).on?("user@email.com")
+  # Do my awesome feature
+end
+```
+
+### Custom Rules
+
+A simple rule can be defined by created a rule object and passing a block
+
+```ruby
+# Only allow users with email addresses at gmail.com
+gmail_rule = Togls::Rule.new { |target| target =~ /gmail.com$/ }
+
+Togls.features do
+  feature(:only_gmail_users).on(gmail_rule)
+end
+```
+
+To implement a more complex rule a new rule object can be defined under Togls::Rules that implements the run method and returns a boolean. When a feature is defined, the rule will be added to the feature object and the run method called with whatever target is passed.
+
+```ruby
+module Togls
+  module Rules
+    class Group < Rule
+      def initialize(list)
+        @list = list
+      end
+
+      def run(target)
+        @list.include?(target)
+      end
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/codebreakdown/togls/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,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 "togls"
+
+# 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/lib/togls/feature.rb

@@ -0,0 +1,25 @@
+module Togls
+  class Feature
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+      off
+    end
+
+    def on(rule = nil)
+      if rule.nil?
+        rule = Rule.new { true }
+      end
+      @rule = rule 
+    end
+
+    def off
+      @rule = Rule.new { false }
+    end
+
+    def on?(target = nil)
+      @rule.run(target)
+    end
+  end
+end

data/lib/togls/feature_registry.rb

@@ -0,0 +1,25 @@
+module Togls
+  class FeatureRegistry
+    def initialize
+      @registry = {}
+      @default_feature = Feature.new(:default).tap {|f| f.on(Rule.new { false }) }
+    end
+
+    def self.create(&features)
+      registry = self.new
+      registry.instance_eval(&features) 
+      registry
+    end
+
+    def feature(tag)
+      @registry[tag.to_sym] = Feature.new(tag.to_sym)
+    end
+
+    def get(key)
+      @registry.fetch(key) do |key|
+        Togls.logger.warn("Feature identified by #{key} has not been defined")
+        @default_feature
+      end
+    end
+  end
+end

data/lib/togls/rule.rb

@@ -0,0 +1,11 @@
+module Togls
+  class Rule
+    def initialize(&rule)
+      @definition = rule  
+    end
+
+    def run(target = nil)
+      @definition.call(target)
+    end
+  end
+end

data/lib/togls/rules/group.rb

@@ -0,0 +1,13 @@
+module Togls
+  module Rules
+    class Group < Rule
+      def initialize(list)
+        @list = list
+      end
+
+      def run(target)
+        @list.include?(target)
+      end
+    end
+  end
+end

data/lib/togls/rules.rb

@@ -0,0 +1,6 @@
+require 'togls/rules/group'
+
+module Togls
+  module Rules
+  end
+end

data/lib/togls/version.rb

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

data/lib/togls.rb

@@ -0,0 +1,20 @@
+require "togls/version"
+require "togls/feature_registry"
+require "togls/feature"
+require "togls/rule"
+require "togls/rules"
+require "logger"
+
+module Togls
+  def self.features(&features)
+    @feature_registry = FeatureRegistry.create(&features)
+  end
+  
+  def self.feature(key)
+    @feature_registry.get(key)
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/togls.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'togls/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "togls"
+  spec.version       = Togls::VERSION
+  spec.authors       = ["Brian Miller", "Andrew DePonte"]
+  spec.email         = ["brimil01@gmail.com", "cyphactor@gmail.com"]
+
+  spec.summary       = %q{An ultra light weight yet ridiculously powerful ruby feature toggle gem.}
+  spec.description   = %q{An ultra light weight yet ridiculously powerful ruby feature toggle gem that supports the concept of release toggles and business toggles.}
+  spec.homepage      = "http://github.com/codebreakdown/togls"
+  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_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: togls
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Miller
+- Andrew DePonte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: An ultra light weight yet ridiculously powerful ruby feature toggle gem
+  that supports the concept of release toggles and business toggles.
+email:
+- brimil01@gmail.com
+- cyphactor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/togls.rb
+- lib/togls/feature.rb
+- lib/togls/feature_registry.rb
+- lib/togls/rule.rb
+- lib/togls/rules.rb
+- lib/togls/rules/group.rb
+- lib/togls/version.rb
+- togls.gemspec
+homepage: http://github.com/codebreakdown/togls
+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.4.5
+signing_key: 
+specification_version: 4
+summary: An ultra light weight yet ridiculously powerful ruby feature toggle gem.
+test_files: []