toggles 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43bb08698c0cc3f3d5ee291ab7185f210ddbb074
+  data.tar.gz: 84a995ec6b03ab71c55e86debbd67dcab16b343c
+SHA512:
+  metadata.gz: 77953be11f5972d440d4b7655d10f4b079d1a2d2a50ed173507bdaa5675f183e2b0c9f2c3f8211a9790bb117b0a262670bca17f030f92cd68ae51564b1724b98
+  data.tar.gz: a0002c98e7947a0a799abaab00507405c28029fa7ba097c88a1b68dc343f0f325136ec6adc853db8ad8aa1e306c2fc3c9c06db9d5b1a7caac9d5cc015a5ae25b

data/.gitignore

@@ -0,0 +1,45 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    toggles (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.4.1)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.1.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pry
+  pry-nav
+  pry-remote
+  rake
+  rspec
+  rspec-its
+  toggles!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/features/collection.yml

@@ -0,0 +1,8 @@
+user:
+  id:
+    or:
+      in:
+        range:
+          - 1
+          - 10
+      gt: 50

data/features/test.yml

@@ -0,0 +1,5 @@
+user:
+  id: 1
+  logged_in?: true
+widget:
+  id: 2

data/lib/toggles.rb

@@ -0,0 +1 @@
+require "toggles/feature"

data/lib/toggles/feature.rb

@@ -0,0 +1,50 @@
+require "find"
+
+require "toggles/feature/base"
+require "toggles/feature/subject"
+require "toggles/feature/permissions"
+require "toggles/feature/permissions/operation"
+
+module Feature
+  OPERATIONS = {and:   Permissions::Operation::And,
+                gt:    Permissions::Operation::GreaterThan,
+                in:    Permissions::Operation::In,
+                lt:    Permissions::Operation::LessThan,
+                or:    Permissions::Operation::Or,
+                range: Permissions::Operation::Range}
+end
+
+# Dynamically create modules and classes within the `Feature` module based on
+# the directory structure of `features`.
+#
+# For example if the `features` directory has the structure:
+#
+# features
+# ├── thing
+# |   ├── one.yml
+# |   └── two.yml
+# └── test.yml
+#
+# `Feature::Test`, `Feature::Thing::One`, `Feature::Thing::Two` would be
+# available by default.
+Find.find("features") do |path|
+  if path.match(/\.ya?ml\Z/)
+    *directories, filename = path.chomp(File.extname(path)).split("/")
+
+    previous = Feature
+    directories[1..-1].each do |directory|
+      module_name = directory.split("_").map(&:capitalize).join.to_sym
+      previous    = begin
+                      previous.const_get(module_name)
+                    rescue NameError
+                      previous.const_set(module_name, Module.new)
+                    end
+    end
+
+    cls = Class.new(Feature::Base) do |c|
+      c.const_set(:PERMISSIONS, Feature::Permissions.new(path))
+    end
+
+    previous.const_set(filename.split("_").map(&:capitalize).join.to_sym, cls)
+  end
+end

data/lib/toggles/feature/base.rb

@@ -0,0 +1,27 @@
+require "yaml"
+
+module Feature
+  class Base
+    attr_reader :subjects
+
+    def self.enabled_for?(subjects = {})
+      new(subjects).enabled?
+    end
+
+    def self.disabled_for?(subjects = {})
+      !enabled_for? subjects
+    end
+
+    def initialize(subjects)
+      @subjects = subjects
+    end
+
+    def permissions
+      @permissions ||= self.class::PERMISSIONS
+    end
+
+    def enabled?
+      permissions.valid_for? subjects
+    end
+  end
+end

data/lib/toggles/feature/permissions.rb

@@ -0,0 +1,37 @@
+require "toggles/feature/permissions/operation"
+
+module Feature
+  class Permissions
+    extend Forwardable
+
+    attr_reader :path
+
+    def_delegators :rules, :all?, :keys
+
+    def initialize(path)
+      @path = path
+    end
+
+    def rules
+      @rules ||= YAML.load(File.read(path))
+    end
+
+    def subjects
+      @subjects ||= keys.map(&:to_sym)
+    end
+
+    def valid_for?(entities)
+      unless subjects == entities.keys
+        raise Subject::Invalid, Subject.difference(subjects, entities.keys)
+      end
+
+      rules.all? do |name, rule|
+        rule.all? do |key, value|
+          OPERATIONS.fetch(key, Operation::Attribute).call(
+            entities[name.to_sym], key, value
+          )
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation.rb

@@ -0,0 +1,7 @@
+require "toggles/feature/permissions/operation/and"
+require "toggles/feature/permissions/operation/gt"
+require "toggles/feature/permissions/operation/in"
+require "toggles/feature/permissions/operation/lt"
+require "toggles/feature/permissions/operation/or"
+require "toggles/feature/permissions/operation/property"
+require "toggles/feature/permissions/operation/range"

data/lib/toggles/feature/permissions/operation/and.rb

@@ -0,0 +1,15 @@
+module Feature
+  class Permissions
+    module Operation
+      class And
+        def self.call(entity, attr_name, expected)
+          expected.all? do |operation, value|
+            OPERATIONS.fetch(operation.to_sym, Attribute).call(
+              entity, attr_name, value
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/gt.rb

@@ -0,0 +1,11 @@
+module Feature
+  class Permissions
+    module Operation
+      class GreaterThan
+        def self.call(entity, attr_name, expected)
+          entity.send(attr_name) > expected
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/in.rb

@@ -0,0 +1,17 @@
+module Feature
+  class Permissions
+    module Operation
+      class In
+        def self.call(entity, attr_name, expected)
+          if expected.kind_of? Hash
+            expected = expected.reduce([]) do |list, (operation, args)|
+              OPERATIONS[operation.to_sym].call(args)
+            end
+          end
+
+          expected.include? entity.send(attr_name.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/lt.rb

@@ -0,0 +1,11 @@
+module Feature
+  class Permissions
+    module Operation
+      class LessThan
+        def self.call(entity, attr_name, expected)
+          entity.send(attr_name) < expected
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/or.rb

@@ -0,0 +1,15 @@
+module Feature
+  class Permissions
+    module Operation
+      class Or
+        def self.call(entity, attr_name, expected)
+          expected.any? do |operation, value|
+            OPERATIONS.fetch(operation.to_sym, Attribute).call(
+              entity, attr_name, value
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/property.rb

@@ -0,0 +1,19 @@
+module Feature
+  class Permissions
+    module Operation
+      class Attribute
+        def self.call(entity, attr_name, expected)
+          if expected.kind_of? Hash
+            expected.all? do |operation, value|
+              OPERATIONS.fetch(operation.to_sym, Operation::Attribute).call(
+                entity, attr_name, value
+              )
+            end
+          else
+            entity.send(attr_name) == expected
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/permissions/operation/range.rb

@@ -0,0 +1,12 @@
+module Feature
+  class Permissions
+    module Operation
+      class Range
+        def self.call(args)
+          raise StandardError, "Invalid range operation" if args.size != 2
+          (args.first..args.last)
+        end
+      end
+    end
+  end
+end

data/lib/toggles/feature/subject.rb

@@ -0,0 +1,13 @@
+module Feature
+  module Subject
+    class Invalid < StandardError
+      def initialize(args)
+        super("Invalid subjects for permissions: #{args}")
+      end
+    end
+
+    def self.difference(subjects, others)
+      Set.new((subjects - others) + (others - subjects)).to_a
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec/its"
+
+require "toggles"
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/toggles/feature/base_spec.rb

@@ -0,0 +1,32 @@
+describe Feature::Base do
+  let(:user)   { double(id: 1, logged_in?: true) }
+  let(:widget) { double(id: 2) }
+
+  subject { Feature::Test.new(user: user, widget: widget) }
+
+  its(:enabled?)              { is_expected.to eq true }
+  its(:subjects)              { is_expected.to eq user: user, widget: widget }
+  its("permissions.subjects") { is_expected.to eq [:user, :widget] }
+
+  describe "#enabled_for?" do
+    specify do
+      expect(Feature::Test.enabled_for?(user: double(id: 1, logged_in?: true),
+                                        widget: double(id: 2))).to eq true
+      expect(Feature::Test.enabled_for?(user: double(id: 1, logged_in?: false),
+                                        widget: double(id: 2))).to eq false
+    end
+
+    specify "invalid permissions" do
+      expect { Feature::Test.enabled_for?(widget: double) }.
+        to raise_error Feature::Subject::Invalid, "Invalid subjects for permissions: [:user]"
+    end
+
+    specify "collection" do
+      expect(Feature::Collection.enabled_for?(user: double(id: 1))).to eq true
+      expect(Feature::Collection.enabled_for?(user: double(id: 5))).to eq true
+      expect(Feature::Collection.enabled_for?(user: double(id: 10))).to eq true
+      expect(Feature::Collection.enabled_for?(user: double(id: 49))).to eq false
+      expect(Feature::Collection.enabled_for?(user: double(id: 51))).to eq true
+    end
+  end
+end

data/spec/toggles/feature/permissions_spec.rb

@@ -0,0 +1,24 @@
+describe Feature::Permissions do
+  let(:path) { "features/test.yml" }
+
+  subject { Feature::Permissions.new(path) }
+
+  its(:path)     { is_expected.to eq path }
+  its(:rules)    { is_expected.to eq({"user"=>{"id"=>1, "logged_in?"=>true},
+                                      "widget"=>{"id"=>2}}) }
+  its(:subjects) { [:user, :widget] }
+
+  describe "#valid_for?" do
+    specify do
+      expect(subject.valid_for?(user: double(id: 1, logged_in?: true),
+                                widget: double(id: 2))).to eq true
+      expect(subject.valid_for?(user: double(id: 2, logged_in?: true),
+                                widget: double(id: 2))).to eq false
+    end
+
+    specify "invalid subjects" do
+      expect { subject.valid_for?(user: double) }.
+        to raise_error Feature::Subject::Invalid, "Invalid subjects for permissions: [:widget]"
+    end
+  end
+end

data/spec/toggles/feature/subject_spec.rb

@@ -0,0 +1,15 @@
+describe Feature::Subject do
+  describe Feature::Subject::Invalid do
+    subject { Feature::Subject::Invalid.new([:user]) }
+
+    its(:message) { is_expected.to eq "Invalid subjects for permissions: [:user]" }
+  end
+
+  describe "#difference" do
+    specify do
+      expect(Feature::Subject.difference([:foo, :bar], [:bar])).to eq [:foo]
+      expect(Feature::Subject.difference([:bar], [:foo, :bar])).to eq [:foo]
+      expect(Feature::Subject.difference([:bar], [:foo])).to eq [:bar, :foo]
+    end
+  end
+end

data/toggles.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = "toggles"
+  s.version = "0.0.2"
+  s.authors = ["Andrew Tribone"]
+  s.summary = "YAML backed feature toggles"
+  s.email = "tribone@easypost.com"
+  s.homepage = ""
+  s.license = ""
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files = s.files.grep(/^(spec)\//)
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+  s.add_development_dependency "pry-remote"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-its"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: toggles
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrew Tribone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: pry-nav
+  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: pry-remote
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 
+email: tribone@easypost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- features/collection.yml
+- features/test.yml
+- lib/toggles.rb
+- lib/toggles/feature.rb
+- lib/toggles/feature/base.rb
+- lib/toggles/feature/permissions.rb
+- lib/toggles/feature/permissions/operation.rb
+- lib/toggles/feature/permissions/operation/and.rb
+- lib/toggles/feature/permissions/operation/gt.rb
+- lib/toggles/feature/permissions/operation/in.rb
+- lib/toggles/feature/permissions/operation/lt.rb
+- lib/toggles/feature/permissions/operation/or.rb
+- lib/toggles/feature/permissions/operation/property.rb
+- lib/toggles/feature/permissions/operation/range.rb
+- lib/toggles/feature/subject.rb
+- spec/spec_helper.rb
+- spec/toggles/feature/base_spec.rb
+- spec/toggles/feature/permissions_spec.rb
+- spec/toggles/feature/subject_spec.rb
+- spec/toggles_spec.rb
+- toggles.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: YAML backed feature toggles
+test_files:
+- spec/spec_helper.rb
+- spec/toggles/feature/base_spec.rb
+- spec/toggles/feature/permissions_spec.rb
+- spec/toggles/feature/subject_spec.rb
+- spec/toggles_spec.rb