toggles 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c0bf3043c4b85c32062fa22750cc20c88af4cd4
-  data.tar.gz: f8aeb5d080385e546815ccc57d8401e8abc1c9e4
+  metadata.gz: 3fc507d16102054690297319ce1e47e61c1ef408
+  data.tar.gz: 482eb06c1c41bd52afd536d0aad227e57ac7deab
 SHA512:
-  metadata.gz: 2b7f5e471ba5456ee1ecc659f902b2826fecd2de532c1a4aef9b49e4791985df6cbdf73260e9643cd340711c3ab8f63c6daefb2691bcbc761fade903d3eacf93
-  data.tar.gz: 08d1d0b300525bde3f0166b3fced8bc426b11f383eeb0ef4a6a60a1530e4e52f1e67522ea96472f2546a4f98d35ffece5642b3997569fb00777639626e9b14e0
+  metadata.gz: 97b6de15c5f8abff3dc5fac12dd1429163ebe7208a1b68c4666af82d130cb6aa2ca3a44c20a87e959ee6df3bf42964b046658a0355816d3b799aa1292bd340bd
+  data.tar.gz: 85553a0544a5c6cb9f8929fe9f9c66d540451d6df8e2996af56af9bb3a16ea28ff9495f39dcb250e6396c8cf74bc48a30d18979a7e41c9ea9dc532cefc607321

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2016-2016, Simpler Postage, Inc. <oss@easypost.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Toggles
+
+[![Gem Version](https://badge.fury.io/rb/toggles.svg)](https://badge.fury.io/rb/toggles)
+[![CircleCI](https://circleci.com/gh/EasyPost/toggles.svg?style=svg)](https://circleci.com/gh/EasyPost/toggles)
+
+YAML backed feature toggles
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem "toggles"
+```
+
+and run `bundle install` from your shell.
+
+To install the gem manually from your shell, run:
+
+```ruby
+gem install toggles
+```
+
+## Configuration
+
+Configure `toggles`:
+
+```ruby
+Toggles.configure do |config|
+  config.features_dir = "features"
+end
+```
+
+You can now express conditional logic within `features_dir`. The structure of the `features_dir` determines the structure of the classes within the `Feature` module. For example if the `features_dir` has the structure:
+
+```
+features
+├── thing
+|   ├── one.yml
+|   └── two.yml
+└── test.yml
+```
+
+The classes `Feature::Test`, `Feature::Thing::One` and `Feature::Thing::Two` will be available for use within
+your application.
+
+You can call the `Toggles.init` method to force re-parsing the configuration and re-initializing all Features
+structures at any time. The `Toggles.reinit_if_necessary` method is a convenience helper which will only
+re-initialize of the top-level features directory has changed. Note that, in general, this will only detect
+changes if you use a system where you swap out the entire features directory on changes and do not edit
+individual files within the directory.
+
+## Usage
+
+Create a file in `features_dir`:
+
+```yaml
+user:
+  id:
+    in:
+      - 12345
+      - 54321
+```
+
+Check if the feature is enabled or disabled:
+
+```ruby
+Feature::NewFeature::AvailableForPresentation.enabled_for?(user: OpenStruct.new(id: 12345)) # true
+Feature::NewFeature::AvailableForPresentation.enabled_for?(user: OpenStruct.new(id: 54321)) # true
+Feature::NewFeature::AvailableForPresentation.enabled_for?(user: OpenStruct.new(id: 7)) # false
+
+Feature::NewFeature::AvailableForPresentation.disabled_for?(user: OpenStruct.new(id: 12345)) # false
+Feature::NewFeature::AvailableForPresentation.disabled_for?(user: OpenStruct.new(id: 54321)) # false
+Feature::NewFeature::AvailableForPresentation.disabled_for?(user: OpenStruct.new(id: 7)) # true
+```
+
+## License
+
+This project is licensed under the ISC License, the contents of which can be found at [LICENSE.txt](LICENSE.txt).

data/lib/toggles.rb

@@ -1,10 +1,16 @@
+require "find"
+require "pathname"
+
 require "toggles/configuration"
 require "toggles/feature"
 
 module Toggles
   extend self
 
+  StatResult = Struct.new(:inode, :mtime)
+
   def configure
+    @stat_tuple ||= StatResult.new(0, 0)
     yield configuration
     init
   end
@@ -30,11 +36,25 @@ module Toggles
   def init
     return unless Dir.exists? configuration.features_dir
 
-    Find.find(configuration.features_dir) do |path|
+    new_tree = Module.new
+
+    top_level = File.realpath(configuration.features_dir)
+    top_level_p = Pathname.new(top_level)
+
+    Find.find(top_level) do |path|
+      previous = new_tree
+      abspath = path
+      path = Pathname.new(path).relative_path_from(top_level_p).to_s
       if path.match(/\.ya?ml\Z/)
-        _, *directories, filename = path.chomp(File.extname(path)).split("/")
+        base = path.chomp(File.extname(path)).split("/")
+        if base.size > 1
+          directories = base[0...-1]
+          filename = base[-1]
+        else
+          directories = []
+          filename = base[0]
+        end
 
-        previous = Feature
         directories.each do |directory|
           module_name = directory.split("_").map(&:capitalize).join.to_sym
           previous    = if previous.constants.include? module_name
@@ -45,11 +65,30 @@ module Toggles
         end
 
         cls = Class.new(Feature::Base) do |c|
-          c.const_set(:PERMISSIONS, Feature::Permissions.new(path))
+          c.const_set(:PERMISSIONS, Feature::Permissions.new(abspath))
         end
 
         previous.const_set(filename.split("_").map(&:capitalize).join.to_sym, cls)
       end
     end
+
+    stbuf = File.stat(top_level)
+    @stat_tuple = StatResult.new(stbuf.ino, stbuf.mtime)
+
+    Feature.set_tree(new_tree)
+  end
+
+  def reinit_if_changed
+    # Reload the configuration if the top-level directory has changed.
+    # Does not detect changes to files inside that directory unless your
+    # filesystem propagates mtimes.
+    return unless Dir.exists? configuration.features_dir
+    top_level = File.realpath(configuration.features_dir)
+    stbuf = File.stat(top_level)
+    stat_tuple = StatResult.new(stbuf.ino, stbuf.mtime)
+
+    if @stat_tuple != stat_tuple
+      init
+    end
   end
 end

data/lib/toggles/feature.rb

@@ -1,5 +1,3 @@
-require "find"
-
 require "toggles/feature/base"
 require "toggles/feature/operation"
 require "toggles/feature/permissions"
@@ -13,4 +11,14 @@ module Feature
                 not:   Operation::Not,
                 or:    Operation::Or,
                 range: Operation::Range}
+
+  @@tree = Module.new
+
+  def self.set_tree(tree)
+    @@tree = tree
+  end
+
+  def self.const_missing(sym)
+    @@tree.const_get(sym, inherit: false)
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,14 @@
 require "rspec/its"
+require 'rspec/temp_dir'
 
 require "toggles"
 
-Toggles.configure do |config|
-  config.features_dir = "features"
-end
-
 RSpec.configure do |config|
   config.order = "random"
+
+  config.before(:each) do
+    Toggles.configure do |c|
+      c.features_dir = "features"
+    end
+  end
 end

data/spec/toggles/feature/acceptance/collection_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::Collection do
+describe "Feature::Collection" do
   specify 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

data/spec/toggles/feature/acceptance/complex_and_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::ComplexAnd do
+describe "Feature::ComplexAnd" do
   specify do
     expect(Feature::ComplexAnd.enabled_for?(data: double(id: 1))).to eq true
     expect(Feature::ComplexAnd.enabled_for?(data: double(id: 2, timestamp: 0))).to eq true

data/spec/toggles/feature/acceptance/multiple_subjects_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::MultipleSubjects do
+describe "Feature::MultipleSubjects" do
   specify do
     expect(Feature::MultipleSubjects.enabled_for?(
       user: double(id: 1, logged_in?: true), widget: double(id: 2))).to eq true

data/spec/toggles/feature/acceptance/nested_attributes_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::NestedAttributes do
+describe "Feature::NestedAttributes" do
   specify do
     expect(Feature::NestedAttributes.enabled_for?(
         foo: double(bar: :two, baz: double(id: 51)))).to eq true

data/spec/toggles/feature/acceptance/or_attributes_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::OrAttributes do
+describe "Feature::OrAttributes" do
   specify do
     expect(Feature::OrAttributes.enabled_for?(
       user: double(foo: 20, bar: 10))).to eq true

data/spec/toggles/feature/acceptance/type_spec.rb

@@ -1,4 +1,4 @@
-describe Feature::Type do
+describe "Feature::Type" do
   specify do
     expect(Feature::Type.enabled_for?(user_id: 1)).to eq true
     expect(Feature::Type.enabled_for?(user_id: 25)).to eq false

data/spec/toggles/init_spec.rb

@@ -0,0 +1,84 @@
+describe Toggles do
+  describe "#init" do
+    include_context "uses temp dir"
+
+    it "correctly loads configuration" do
+      Dir.mkdir("#{temp_dir}/foo")
+      Dir.mkdir("#{temp_dir}/bar")
+
+      File.open("#{temp_dir}/foo/users.yml", "w") do |f|
+        f.write("{\"id\": {\"in\": [1, 2]}}")
+      end
+
+      File.open("#{temp_dir}/bar/users.yml", "w") do |f|
+        f.write("{\"id\": {\"in\": [3, 4]}}")
+      end
+
+      Toggles.configure do |c|
+        c.features_dir = temp_dir
+      end
+      
+      expect(Feature::Foo::Users.enabled_for?(id: 1)).to eq(true)
+      expect(Feature::Bar::Users.enabled_for?(id: 3)).to eq(true)
+    end
+
+    it "reloads configuration when #init is called" do
+      Dir.mkdir("#{temp_dir}/foo")
+
+      File.open("#{temp_dir}/foo/users.yml", "w") do |f|
+        f.write("{\"id\": {\"in\": [1, 2]}}")
+      end
+      File.open("#{temp_dir}/foo/children.yml", "w") do |f|
+        f.write("{\"id\": {\"in\": [1, 2]}}")
+      end
+
+
+      Toggles.configure do |c|
+        c.features_dir = temp_dir
+      end
+      
+      expect(Feature::Foo::Users.enabled_for?(id: 1)).to eq(true)
+      expect(Feature::Foo::Children.enabled_for?(id: 1)).to eq(true)
+
+      File.open("#{temp_dir}/foo/users.yml", "w") do |f|
+        f.write("{\"id\": {\"in\": [2]}}")
+      end
+
+      File.unlink("#{temp_dir}/foo/children.yml")
+
+      Toggles.init
+
+      expect(Feature::Foo::Users.enabled_for?(id: 1)).to eq(false)
+      expect { Feature::Foo::Children.enabled_for?(id: 1) }.to raise_error(NameError)
+    end
+  end
+
+  describe "#reinit_if_changed" do
+    include_context "uses temp dir"
+
+    it "reloads when the contents have changed" do
+      Dir.mkdir("#{temp_dir}/features")
+
+      Toggles.configure do |c|
+        c.features_dir = "#{temp_dir}/features"
+      end
+
+      Dir.delete("#{temp_dir}/features")
+      Dir.mkdir("#{temp_dir}/features")
+
+      expect(Toggles).to receive("init")
+      Toggles.reinit_if_changed
+    end
+
+    it "does not reload when the contents have not changed" do
+      Dir.mkdir("#{temp_dir}/features")
+
+      Toggles.configure do |c|
+        c.features_dir = "#{temp_dir}/features"
+      end
+
+      expect(Toggles).not_to receive("init")
+      Toggles.reinit_if_changed
+    end
+  end
+end

data/toggles.gemspec

@@ -1,13 +1,19 @@
 Gem::Specification.new do |s|
   s.name = "toggles"
-  s.version = "0.1.1"
-  s.authors = ["Andrew Tribone"]
+  s.version = "0.1.2"
+  s.authors = ["Andrew Tribone", "James Brown"]
   s.summary = "YAML backed feature toggles"
-  s.email = "tribone@easypost.com"
-  s.homepage = "https://github.com/att14/toggles"
-  s.license = ""
+  s.email = "oss@easypost.com"
+  s.homepage = "https://github.com/EasyPost/toggles"
+  s.license = "ISC"
   s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files = s.files.grep(/^(spec)\//)
+  s.description = <<-EOF
+    YAML-backed implementation of the feature flags pattern. Build a
+    hierarchy of features in YAML files in the filesystem, apply various
+    conditions using boolean logic and a selection of filters, and easily
+    check whether a given feature should be applied.
+  EOF
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "pry"
@@ -16,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rspec-its"
+  s.add_development_dependency "rspec-temp_dir"
 end

metadata

@@ -1,122 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: toggles
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Tribone
+- James Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2016-11-08 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
+- !ruby/object:Gem::Dependency
+  name: rspec-temp_dir
+  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: |2
+      YAML-backed implementation of the feature flags pattern. Build a
+      hierarchy of features in YAML files in the filesystem, apply various
+      conditions using boolean logic and a selection of filters, and easily
+      check whether a given feature should be applied.
+email: oss@easypost.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
 - Gemfile
+- LICENSE.txt
+- README.md
 - Rakefile
 - features/collection.yml
 - features/complex_and.yml
@@ -158,10 +179,11 @@ files:
 - spec/toggles/feature/operation/range_spec.rb
 - spec/toggles/feature/permissions_spec.rb
 - spec/toggles/feature/subject_spec.rb
+- spec/toggles/init_spec.rb
 - toggles.gemspec
-homepage: https://github.com/att14/toggles
+homepage: https://github.com/EasyPost/toggles
 licenses:
-- ''
+- ISC
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -169,17 +191,17 @@ 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
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: YAML backed feature toggles
@@ -203,3 +225,4 @@ test_files:
 - spec/toggles/feature/operation/range_spec.rb
 - spec/toggles/feature/permissions_spec.rb
 - spec/toggles/feature/subject_spec.rb
+- spec/toggles/init_spec.rb