enabler 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1eef7bfc44bf4a0a6b8947b12403c6c95f8602
-  data.tar.gz: 39d8303fae1633acfc1c86e08aa0ceb33a4a535e
+  metadata.gz: 81a5568c263c249d5c68726e559979f77c71d85c
+  data.tar.gz: 8e2c9dec31542bc566abdde1dbf2bd4c2e6b455c
 SHA512:
-  metadata.gz: 3b6775a9b505857dcc130b11390abbe1544f30db80bca63e535d134e2f6996f709c8ebf30a30d965cdd1eb862b3a1dc2811e85d8b12c26ca13c8bbf59521f8fb
-  data.tar.gz: 14ee7a7d4798390f03b45ec10955b0fc25067eed57823748379c1b406ccfaf5e6af0def27a64f9dec19388dd88971a6d0516a48165ced5d65cf825ed4ee01c77
+  metadata.gz: b879b9fa5f9480de357d9bd6f1972a66ad7c428874358d118e5fa593ec41e83f7250290c9a56833f3be10fc340aeaf94bbdd5ebcadfbedfd4b15f87be53f24f6
+  data.tar.gz: bdc32849784e5138dc7e7b59d09318775b41a92c03de83e07a22096b8644c47278470b51cf8a0afd4a60eba25aac37aea5190fb43d6f3d9fd8390d95ce752993

data/.gitignore

@@ -1,22 +1,34 @@
 *.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
+/.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/
+/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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    enabler (0.0.1)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    mock_redis (0.10.0)
+    rake (10.1.1)
+    redis (3.0.7)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  enabler!
+  mock_redis
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Luke Roberts
+
+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

@@ -1,6 +1,6 @@
 # Enabler
 
-TODO: Write a gem description
+Feature enabler
 
 ## Installation
 

data/enabler.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mock_redis"
 end

data/lib/enabler/errors/rule_already_defined_error.rb

@@ -0,0 +1,5 @@
+module Enabler
+	module Errors
+		class RuleAlreadyDefinedError < StandardError;end
+	end
+end

data/lib/enabler/rule.rb

@@ -0,0 +1,15 @@
+module Enabler
+	class Rule
+
+		attr_reader :feature, :definition
+
+		def initialize(feature, definition)
+			@feature, @definition = feature, definition
+		end
+
+		def enabled?(model)
+			definition.call(model)
+		end
+
+	end
+end

data/lib/enabler/storage/redis.rb

@@ -0,0 +1,40 @@
+module Enabler
+	module Storage
+		class Redis
+
+			attr_reader(:redis)
+
+			def initialize(redis)
+				@redis = redis
+			end
+
+			def add!(feature, model)
+				redis.sadd key(feature, model), model.id
+			end
+
+			def remove!(feature, model)
+				redis.srem key(feature, model), model.id
+			end
+
+			def enabled?(feature, model)
+				redis.sismember key(feature, model), model.id 
+			end
+
+			private
+
+			def key(feature, model)
+				"enabler::#{underscore model.class.to_s}::#{underscore feature.to_s}"
+			end
+
+			#taking from active support
+			def underscore(string)
+				string.gsub(/::/, '/').
+					gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+					gsub(/([a-z\d])([A-Z])/,'\1_\2').
+					tr("-", "_").
+					downcase
+			end
+
+		end
+	end
+end

data/lib/enabler/version.rb

@@ -1,3 +1,3 @@
 module Enabler
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/enabler.rb

@@ -1,5 +1,54 @@
 require "enabler/version"
+require "enabler/storage/redis"
+require "enabler/errors/rule_already_defined_error"
+require "enabler/rule"
 
 module Enabler
-  # Your code goes here...
+
+	def self.store=(val)
+		@@store = val
+	end
+
+	def self.store
+		@@store
+	end
+
+	def self.enabled?(feature, object)
+		enabled_via_rule?(feature, object) || 
+			enabled_via_storage?(feature, object)
+	end
+
+	def self.enabled_via_storage?(feature, object)
+		store.enabled?(feature, object)
+	end
+
+	def self.enabled_via_rule?(feature, object)
+		sym = feature.to_sym
+		r = self.rule(sym)
+		return false unless r
+		r.enabled?(model)
+	end
+
+	def self.enable!(feature, object)
+		store.add!(feature, object)
+	end
+
+	def self.disable!(feature, object)
+		store.remove!(feature, object)
+	end
+
+	def self.rules
+		@@rules ||= [] 
+	end
+
+	def self.rule(feature)
+		self.rules.select { |item| item.feature == feature.to_sym }.first
+	end
+
+	def self.define_rule!(feature, &block)
+		sym = feature.to_sym
+		raise Errors::RuleAlreadyDefinedError if self.rule(sym)
+		self.rules << Rule.new(sym, block)
+	end
+
 end

data/spec/enabler/rule_spec.rb

@@ -0,0 +1,17 @@
+require 'enabler'
+
+describe Enabler::Rule do
+	let(:model) { double('Model', id:1) }
+	let(:pass_rule_def) { Proc.new { |model| model.id == 1 } }
+	let(:fail_rule_def) { Proc.new { |model| model.id != 1} }
+
+	context "with a passing rule" do
+		subject { Enabler::Rule.new(:jump, pass_rule_def) }
+		specify { subject.enabled?(model).should be_true }
+	end
+
+	context "with a failing rule" do
+		subject { Enabler::Rule.new(:jump, fail_rule_def) }
+		specify { subject.enabled?(model).should be_false }
+	end
+end

data/spec/enabler/storage/redis_spec.rb

@@ -0,0 +1,40 @@
+require 'mock_redis'
+require 'enabler'
+
+describe Enabler::Storage::Redis do
+	let(:redis) { MockRedis.new }
+	let(:model) { double('Model', id:1, class:'Model') }
+	subject { Enabler::Storage::Redis.new(redis) }
+
+	describe "#add!" do
+		it "adds the id to the correct set in redis" do
+			expect{ 
+				subject.add!(:dance, model) 
+			}.to change{
+				redis.sismember('enabler::model::dance', 1) 
+			}.from(false).to(true)
+		end
+	end
+
+	describe "#remove!" do
+		before { subject.add!(:dance, model)	}
+		it "removes the id from the correct set in redis" do
+			expect{ 
+				subject.remove!(:dance, model) 
+			}.to change{
+				redis.sismember('enabler::model::dance', 1) 
+			}.from(true).to(false)
+		end
+	end
+
+
+	describe "#enabled?" do
+		context "when id is in set" do
+			before { subject.add!(:dance, model) }
+			specify { subject.enabled?(:dance, model).should be_true }
+		end
+		context "when id is not in set" do
+			specify { subject.enabled?(:dance, model).should be_false }
+		end
+	end
+end

data/spec/enabler_spec.rb

@@ -0,0 +1,55 @@
+require 'enabler'
+
+describe Enabler do
+	let(:store) { double('Store', add!:true, remove!:true) }
+	let(:model) { double('Model', id:1, class:'Model') }
+	before { Enabler.store = store }
+
+	describe ".enabled?" do
+
+		context "when store has feature enabled" do
+			before { store.stub(:enabled?) { true } }
+			specify { Enabler.enabled?(:dance, model).should be_true }
+		end
+
+		context "when store has feature disabled" do
+			before { store.stub(:enabled?) { false } }
+			specify { Enabler.enabled?(:dance, model).should be_false }
+		end
+
+	end
+
+	describe ".enable!" do
+		it "calls set on the store" do
+			store.should_receive(:add!).with(:dance, model)
+			Enabler.enable! :dance, model
+		end
+	end
+
+	describe ".disable!" do
+		it "calls set on the store" do
+			store.should_receive(:remove!).with(:dance, model)
+			Enabler.disable! :dance, model
+		end
+	end
+
+	describe ".rules" do
+		context "with no rules set" do
+			specify { Enabler.rules.should be == [] }
+		end
+
+		context "with rules set" do
+			let(:rule_def) { Proc.new{ true} }
+			before do
+				Enabler.define_rule! :boogie, &rule_def
+			end
+			after do
+				Enabler.class_variable_set(:@@rules, [])
+			end
+      
+			specify { Enabler.rules.length.should be == 1 }
+			specify { Enabler.rule(:boogie).feature.should == :boogie }
+			specify { Enabler.rule(:boogie).definition.should == rule_def }
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enabler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Luke Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2014-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !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: mock_redis
+  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: Enable features
 email:
 - email@luke-roberts.co.uk
@@ -61,12 +89,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - enabler.gemspec
 - lib/enabler.rb
+- lib/enabler/errors/rule_already_defined_error.rb
+- lib/enabler/rule.rb
+- lib/enabler/storage/redis.rb
 - lib/enabler/version.rb
+- spec/enabler/rule_spec.rb
+- spec/enabler/storage/redis_spec.rb
+- spec/enabler_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -91,4 +127,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Enable features
-test_files: []
+test_files:
+- spec/enabler/rule_spec.rb
+- spec/enabler/storage/redis_spec.rb
+- spec/enabler_spec.rb