mongoid_feature_flags 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch("Gemfile")
+  watch("mongoid-feature-flags.gemspec")
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Winslett
+
+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,56 @@
+# Mongoid::FeatureFlags
+
+Out of the box simple usage of feature flags with Mongoid classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-feature-flags'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-feature-flags
+
+## Usage
+
+If you would like to add features on persons, `include Mongoid::FeatureFlags` 
+
+    class Person
+      include Mongoid::Document
+      
+      has_many :possessions
+      belongs_to :family
+
+      include Mongoid::FeatureFlags
+      inherits_features_from :family
+    end
+
+Then, you can do the following:
+
+    p = Person.first
+    p.add_feature(:play_guitar_like_slash)
+
+    p.feature?(:play_guitar_like_slash) { *works* }
+    p.feature?(:play_guitar_like_nikki_sixx) { *does not work* }
+
+## Security ##
+
+### Rails 3.2 ###
+You are responsible for using `strong_parameters` at the controller level.
+
+### < Rails 3.2 ###
+You are responsible for adding `attr_accessible` or `attr_protected` to
+your classes for security.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mongoid_feature_flags/errors.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module FeatureFlags
+    class InvalidFlagName < RuntimeError; end
+  end
+end

data/lib/mongoid_feature_flags/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module FeatureFlags
+    VERSION = ENV['CIRCLE_BUILD_NUM'] ? "0.1.#{ENV['CIRCLE_BUILD_NUM']}" : "0.0.1"
+  end
+end

data/lib/mongoid_feature_flags.rb

@@ -0,0 +1,66 @@
+require "mongoid_feature_flags/version"
+require "mongoid_feature_flags/errors"
+
+module Mongoid
+  module FeatureFlags
+    extend ActiveSupport::Concern
+
+    included do
+      begin
+        self.field :feature_flags, type: Hash
+      rescue
+        if $!.to_s == "undefined method `field' for WithoutMongoid:Class"
+          raise "Adding Mongoid::FeatureFlags requires Mongoid::Document to also be included on the class"         
+        end
+      end
+    end
+    
+    module ClassMethods
+      def inherits_features_from(*relative)
+        @feature_flag_parents ||= []
+        @feature_flag_parents += relative
+      end
+    end
+    
+    module InstanceMethods
+      def add_feature(*flags)
+        self.feature_flags ||= {}
+        flags.each do |flag|
+          self.feature_flags[flag] = true  
+        end
+        self.save
+      end
+      
+      def features
+        inherited_feature_flags.merge(self.feature_flags).inject([]) { |new_hash, key| TrueClass === key[1] ? (new_hash + [key[0]]) : new_hash }
+      end
+      
+      def feature?(*require_features, &block)
+        if (self.features & require_features).length > 0
+          block.present? ? block.yield : true  
+        end
+      end
+      
+      def not_feature?(*unrequired_features, &block)
+        if (self.features & unrequired_features).length == 0
+          block.present? ? block.yield : true
+        end
+      end
+      
+      def feature_flag_validate_flag(*flag)
+        raise(InvalidFlagName, "Flags must be a symbol") if !flag.any? { |f| f.is_a?(Symbol) }
+      end
+
+
+      def inherited_feature_flags
+        self.class.instance_variable_get("@feature_flag_parents").inject({}) do |flag_hash, relative|
+          if self.respond_to?(relative) && self.send(relative).present? && self.send(relative).respond_to?(:feature_flags)
+            flag_hash.merge(self.send(relative).send(:feature_flags))
+          else
+            flag_hash
+          end
+        end
+      end
+    end
+  end
+end

data/mongoid_feature_flags.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid_feature_flags/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Winslett"]
+  gem.email         = ["chris@mongohq.com"]
+  gem.description   = %q{Mongoid Feature Flags}
+  gem.summary       = %q{Hopefully a nice little plug and play for }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongoid_feature_flags"
+  gem.require_paths = ["lib"]
+  gem.version       = Mongoid::FeatureFlags::VERSION
+  
+  gem.add_dependency "activesupport", "~> 3.2.0"
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "guard-bundler"
+  gem.add_development_dependency "mongoid"
+  gem.add_development_dependency "rb-fsevent", "~> 0.9.1"
+end

data/spec/lib/feature_flag_spec.rb

@@ -0,0 +1,81 @@
+require_relative "../spec_helper"
+
+describe Mongoid::FeatureFlags do
+  
+  context "#direct" do
+    let :person do
+      p = Person.create!
+      p.add_feature(:can_see_cartoons)
+      p
+    end
+    
+    it "#permitted" do
+      triggered = nil
+      person.feature?(:can_see_cartoons) do
+        triggered = "yep"  
+      end
+
+      triggered.should eq("yep")
+    end
+
+    it "#unpermitted" do
+      triggered = nil
+      person.feature?(:can_see_cnn) do
+        triggered = "yep"
+      end
+
+      triggered.should eq(nil)
+    end
+
+    it "#not_feature? permitted" do
+      triggered = nil
+      person.not_feature?(:can_see_cartoons) do
+        triggered = "nope"
+      end
+
+      triggered.should eq(nil)
+    end
+
+    it "#featured? unpermitted" do
+      triggered = nil
+      person.not_feature?(:can_see_cnn) do
+        triggered = "nope"
+      end
+
+      triggered.should eq("nope")
+    end
+  end
+  
+  context "#inherited" do
+    let :family do
+      f = Family.create!
+      f.add_feature(:can_see_comedy_central)
+      f
+    end
+    
+    let :person do     
+      p = Person.create!(family: family)
+      p.add_feature(:can_see_cartoons)
+      p
+    end
+    
+    it "#permitted" do
+      triggered = nil
+      person.feature?(:can_see_comedy_central) do
+        triggered = "yep"
+      end
+      
+      triggered.should eq("yep")
+    end
+
+    it "#unpermitted" do
+      triggered = nil
+      person.feature?(:can_see_star_wars) do
+        triggered = "yep"
+      end
+
+      triggered.should eq(nil)
+    end
+  end
+  
+end

data/spec/models/family.rb

@@ -0,0 +1,8 @@
+class Family
+  include Mongoid::Document
+  
+  has_many :people, class_name: "Person"
+  
+  include Mongoid::FeatureFlags
+
+end

data/spec/models/person.rb

@@ -0,0 +1,10 @@
+class Person
+  include Mongoid::Document
+  
+  has_many :possessions
+  belongs_to :family
+
+  include Mongoid::FeatureFlags
+  inherits_features_from :family
+  
+end

data/spec/models/possession.rb

@@ -0,0 +1,8 @@
+class Possession
+  include Mongoid::Document
+  
+  belongs_to :person
+  
+  include Mongoid::FeatureFlags
+
+end

data/spec/models/without_mongoid.rb

@@ -0,0 +1,3 @@
+class WithoutMongoid
+  include Mongoid::FeatureFlags
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "mongoid"
+
+require_relative "../lib/mongoid_feature_flags"
+
+require_relative "./models/family"
+require_relative "./models/person"
+require_relative "./models/possession"
+
+Mongoid.database = Mongo::Connection.from_uri("mongodb://localhost:27017/test").db("test")

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_feature_flags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Winslett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70105158078900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105158078900
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70105158078460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105158078460
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70105158077940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105158077940
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &70105158077320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105158077320
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70105158076580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105158076580
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70105158076060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: *70105158076060
+description: Mongoid Feature Flags
+email:
+- chris@mongohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid_feature_flags.rb
+- lib/mongoid_feature_flags/errors.rb
+- lib/mongoid_feature_flags/version.rb
+- mongoid_feature_flags.gemspec
+- spec/lib/feature_flag_spec.rb
+- spec/models/family.rb
+- spec/models/person.rb
+- spec/models/possession.rb
+- spec/models/without_mongoid.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Hopefully a nice little plug and play for
+test_files:
+- spec/lib/feature_flag_spec.rb
+- spec/models/family.rb
+- spec/models/person.rb
+- spec/models/possession.rb
+- spec/models/without_mongoid.rb
+- spec/spec_helper.rb