black_and_white 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e779b2341b287d09338e106253de2fd2a804ab6
-  data.tar.gz: 793d5a54c18cea751353123b16f818a8ff5b8812
+  metadata.gz: 54360b95b384a8d993009e4b6e30906e0263ea67
+  data.tar.gz: ee52743e185f957e779f23205154c8b4ec1919c9
 SHA512:
-  metadata.gz: c2ea3c62d3fffb2c44c4fbd1c01faf952fbff9f73f9a5b2519afe708c2234e85c698cce0ca1753ac9f8524396da9637ba1f5ee679c9293c278d8c7af2afd7033
-  data.tar.gz: 3e1a37311ce38390a9a4815d94f607fbfae2f47ddfffde4e4be890b6d22c4da10677c7580b28a126c77acdfcfde393d220a7b9639eb330572131c80b2acb729e
+  metadata.gz: eeb439a94afe944d665a1ae89827e9506bae9466cc45a067f240c20ab892a4ce715b46834dc2c64b54917ebe6d631985a63363d35d8576198880df46044750a7
+  data.tar.gz: d4657badc6ea8d135dc9289b5697e4fd05da91be974c91a7ef0625027c5f9e75d1b89a46ec6f6d0e87b58e26f8c9c8d1b0a0c0389ae86a6728b6bb818f677b2d

data/.gitignore

@@ -6,4 +6,6 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/coverage
 /tmp/
+/.byebug_history

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
   - 2.3.0
-before_install: gem install bundler -v 1.11.2
+before_install:
+- gem install bundler -v 1.11.2
+services:
+- mongodb
+script:
+- BAW_ACTIVERECORD=1 bundle exec rake
+- BAW_MONGOID=1 bundle exec rake

data/README.md

@@ -10,7 +10,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'black_and_white', '~> 0.1.6'
+gem 'black_and_white', '~> 0.2.0'
 ```
 
 And then execute:
@@ -22,7 +22,8 @@ Or install it yourself as:
     $ gem install black_and_white
 
 ## Usage
-Black And White is meant to work with Rails for the moment. In order to
+Black And White is meant to work with Rails for the moment. It has
+support for ActiveRecord and Mongoid. In order to
 use it first run:
 ```ruby
 rails g black_and_white:config
@@ -39,22 +40,32 @@ end
 
 BlackAndWhite::Hooks.init
 ```
+The `Hooks` class requires all the necessary files for the detected
+orm. If you are using `ActiveRecord` you need to generate the
+corresponding migrations with:
 
-After this run:
 ```ruby
 rails g black_and_white:migrations
 ```
-this will create the necessary migrations in the `db/migrate` folder.
 Review them and then feel free to migrate. Keep in mind that they give
-you only some very basic columns. You can add as much as you want.
+you only some very basic columns. You can add as much as you want and
+extend the logic
 
-### For ActiveRecord objects:
+### For ActiveRecord
 Include the black_and_white module for activerecord interactions. The base class may have multiple a/b tests:
 ```ruby
 class User < ActiveRecord::Base
   include BlackAndWhite::ActiveRecord
 end
 ```
+### For Mongoid
+Include the black_and_white module for activerecord interactions. The base class may have multiple a/b tests:
+```ruby
+class User
+  include Mongoid::Document
+  include BlackAndWhite::Mongoid
+end
+```
 
 To create a new A/B test you can run:
 ```ruby
@@ -86,17 +97,18 @@ user.ab_participate!('My Inactive test', join_inactive: true)
 user.ab_participate!('My Inactive test', raise_on_missing: true)
 => AbTestError, "no A/B Test with name My Inactive test exists or it is not active"
 ```
+A note for `Mongoid`: If you have `Mongoid.raise_not_found_error` this
+will raise the generic mongoid error for not found documents.
 
 If you added additional db colums or you want to add or extend more logic you can
 use the `add` method which evaluates the given block in the scope of
 the main `BlackAndWhite` module. That way you don't have to worry about
-code location
+code location.
 ```ruby
-model User < ActiveRecord::Base
-  include BlackAndWhite::ActiveRecord
-  BlackAndWhite.add(self) do
-    def my_new_method; end
-  end
+BlackAndWhite.add(self) do
+  def my_new_method; end
+  private
+  attr_reader :my_property
 end
 ```
 

data/black_and_white.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
+  spec.required_ruby_version = '>= 2.2.2'
+
   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) }
@@ -30,8 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "activerecord", "~> 4.2"
-  spec.add_development_dependency "activesupport", "~> 4.2"
+  spec.add_development_dependency "activerecord", ">= 4.2"
+  spec.add_development_dependency "activesupport", ">= 4.2"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "mongoid", ">= 5.1.4"
   spec.add_development_dependency 'database_cleaner'
 end

data/lib/black_and_white.rb

@@ -1,14 +1,11 @@
 require "black_and_white/version"
 require "black_and_white/config"
-require "black_and_white/hooks"
-require "black_and_white/active_record"
-require "black_and_white/active_record/error"
-require "black_and_white/helpers/utils"
+require "black_and_white/broker"
 
 module BlackAndWhite
 
   def self.create(args = {})
-    ActiveRecord::Test.create(args)
+    Broker.invoke(:create, args)
   end
 
   def self.add(klass, &block)

data/lib/black_and_white/active_record/test.rb

@@ -1,10 +1,9 @@
-require 'active_record'
 require 'active_support/inflector'
-require 'black_and_white/helpers/database'
 
 module BlackAndWhite
   module ActiveRecord
     class Test < ::ActiveRecord::Base
+      include Helpers::Methods
       self.table_name = BlackAndWhite.config.bw_main_table.to_s.pluralize
 
       validates :name, uniqueness: true
@@ -12,15 +11,6 @@ module BlackAndWhite
       has_and_belongs_to_many BlackAndWhite.config.bw_class_table,
                               join_table: BlackAndWhite.config.bw_join_table
 
-      def activate!
-        self.active = true
-        save!
-      end
-
-      def deactivate!
-        self.active = false
-        save!
-      end
     end
   end
 end

data/lib/black_and_white/broker.rb

@@ -0,0 +1,20 @@
+module BlackAndWhite
+  class Broker
+
+    class << self
+      attr_accessor :orm
+
+      def invoke(method, *args)
+        if orm == :active_record
+          BlackAndWhite::ActiveRecord::Test.send(method, *args)
+        elsif orm == :mongoid
+          BlackAndWhite::Mongoid::Test.send(method, *args)
+        end
+      end
+
+      def register(type)
+        self.orm = type
+      end
+    end
+  end
+end

data/lib/black_and_white/error.rb

@@ -0,0 +1,3 @@
+module BlackAndWhite
+  AbTestError = Class.new(StandardError)
+end

data/lib/black_and_white/helpers/active_record/database.rb

@@ -0,0 +1,56 @@
+module BlackAndWhite
+  module Helpers
+    module ActiveRecord
+      module Database
+        def bw_tests_table_data
+          <<RUBY
+          t.string :name, unique: true, null: false
+          t.boolean :active, default: false
+          t.timestamps null: false
+RUBY
+        end
+
+        def bw_relations_table_data
+          <<RUBY
+        t.references :#{bw_tests_class_table_singularize}, index: true
+        t.references :#{bw_tests_table_name_singularize}, index: true
+RUBY
+        end
+
+        def bw_relations_table_name
+          BlackAndWhite.config.bw_join_table
+        end
+
+        def bw_tests_table_name
+          BlackAndWhite.config.bw_main_table
+        end
+
+        def bw_tests_table_name_singularize
+          BlackAndWhite.config.bw_main_table.to_s.singularize
+        end
+
+        def bw_tests_class
+          BlackAndWhite.config.bw_class
+        end
+
+        def bw_tests_class_table
+          BlackAndWhite.config.bw_class_table
+        end
+
+        def bw_tests_class_table_singularize
+          BlackAndWhite.config.bw_class_table.to_s.singularize
+        end
+
+        def bw_tests_table_name_pluralize
+          BlackAndWhite.config.bw_main_table.to_s.pluralize
+        end
+
+        def migration_version
+          if defined?(Rails) && Rails.version.start_with?('5')
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/black_and_white/helpers/active_record/utils.rb

@@ -0,0 +1,21 @@
+module BlackAndWhite
+  module Helpers
+    module ActiveRecord
+      module Utils
+        extend self
+
+        def active_record_4?
+          ::ActiveRecord::VERSION::MAJOR == 4
+        end
+
+        def active_record_5?
+          ::ActiveRecord::VERSION::MAJOR == 5
+        end
+
+        def active_record_3?
+          ::ActiveRecord::VERSION::MAJOR == 3
+        end
+      end
+    end
+  end
+end

data/lib/black_and_white/helpers/methods.rb

@@ -0,0 +1,16 @@
+module BlackAndWhite
+  module Helpers
+    module Methods
+      # Common methods, shared between activerecord and mongoid
+      def activate!
+        self.active = true
+        save!
+      end
+
+      def deactivate!
+        self.active = false
+        save!
+      end
+    end
+  end
+end

data/lib/black_and_white/hooks.rb

@@ -1,9 +1,19 @@
 module BlackAndWhite
   class Hooks
     def self.init
+      require 'black_and_white'
+      require 'black_and_white/error'
+      require 'black_and_white/helpers/methods'
       if defined?(::ActiveRecord)
-        require "black_and_white/active_record/test"
-        require "black_and_white/active_record"
+        BlackAndWhite::Broker.register(:active_record)
+        require 'black_and_white/active_record'
+        require 'black_and_white/active_record/test'
+        require 'black_and_white/helpers/active_record/utils'
+        require 'black_and_white/helpers/active_record/database'
+      elsif defined?(::Mongoid)
+        BlackAndWhite::Broker.register(:mongoid)
+        require 'black_and_white/mongoid'
+        require 'black_and_white/mongoid/test'
       end
     end
   end

data/lib/black_and_white/mongoid.rb

@@ -1 +1,48 @@
-# Implement me at some point, please
+module BlackAndWhite
+  module Mongoid
+    extend ActiveSupport::Concern
+
+    included do
+      has_and_belongs_to_many :ab_tests, class_name: 'BlackAndWhite::Mongoid::Test'
+
+      attr_reader :ab_test, :options
+
+      def ab_participate!(test_name, **options, &block)
+        @options = options
+        if (@ab_test = fetch_ab_test(test_name)).present?
+          conditions = true
+          conditions = yield(self) if block_given?
+          update_participant if conditions
+        else
+          missing_ab_test(test_name)
+        end
+      end
+
+      def ab_participates?(test_name)
+        ab_tests.detect { |ab_test| ab_test.name == test_name }.present?
+      end
+
+      private
+
+      def update_participant
+        ab_tests << ab_test
+      end
+
+      def missing_ab_test(test_name)
+        if options[:raise_on_missing]
+          raise AbTestError, "no A/B Test with name #{test_name} exists or it is not active"
+        end
+        false
+      end
+
+      def fetch_ab_test(name)
+        query = { name: name }
+        if options[:join_inactive] == false
+          query.merge!(active: true)
+        end
+
+        BlackAndWhite::Mongoid::Test.find_by(query)
+      end
+    end
+  end
+end

data/lib/black_and_white/mongoid/test.rb

@@ -0,0 +1,16 @@
+module BlackAndWhite
+  module Mongoid
+    class Test
+      include ::Mongoid::Document
+      include Helpers::Methods
+
+      has_and_belongs_to_many BlackAndWhite.config.bw_class_table
+
+      field :name, type: String
+      field :description, type: String
+      field :active, type: Boolean, default: false
+
+      validates :name, uniqueness: true
+    end
+  end
+end

data/lib/black_and_white/version.rb

@@ -1,3 +1,3 @@
 module BlackAndWhite
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: black_and_white
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Stefan Slaveykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,28 +56,28 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -130,13 +144,16 @@ files:
 - codecov.yml
 - lib/black_and_white.rb
 - lib/black_and_white/active_record.rb
-- lib/black_and_white/active_record/error.rb
 - lib/black_and_white/active_record/test.rb
+- lib/black_and_white/broker.rb
 - lib/black_and_white/config.rb
-- lib/black_and_white/helpers/database.rb
-- lib/black_and_white/helpers/utils.rb
+- lib/black_and_white/error.rb
+- lib/black_and_white/helpers/active_record/database.rb
+- lib/black_and_white/helpers/active_record/utils.rb
+- lib/black_and_white/helpers/methods.rb
 - lib/black_and_white/hooks.rb
 - lib/black_and_white/mongoid.rb
+- lib/black_and_white/mongoid/test.rb
 - lib/black_and_white/version.rb
 - lib/generators/black_and_white/config_generator.rb
 - lib/generators/black_and_white/migrations_generator.rb
@@ -155,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/black_and_white/active_record/error.rb

@@ -1,5 +0,0 @@
-module BlackAndWhite
-  module ActiveRecord
-    AbTestError = Class.new(StandardError)
-  end
-end

data/lib/black_and_white/helpers/database.rb

@@ -1,54 +0,0 @@
-module BlackAndWhite
-  module Helpers
-    module Database
-      def bw_tests_table_data
-        <<RUBY
-          t.string :name, unique: true, null: false
-          t.boolean :active, default: false
-          t.timestamps null: false
-RUBY
-      end
-
-      def bw_relations_table_data
-        <<RUBY
-        t.references :#{bw_tests_class_table_singularize}, index: true
-        t.references :#{bw_tests_table_name_singularize}, index: true
-RUBY
-      end
-
-      def bw_relations_table_name
-        BlackAndWhite.config.bw_join_table
-      end
-
-      def bw_tests_table_name
-        BlackAndWhite.config.bw_main_table
-      end
-
-      def bw_tests_table_name_singularize
-        BlackAndWhite.config.bw_main_table.to_s.singularize
-      end
-
-      def bw_tests_class
-        BlackAndWhite.config.bw_class
-      end
-
-      def bw_tests_class_table
-        BlackAndWhite.config.bw_class_table
-      end
-
-      def bw_tests_class_table_singularize
-        BlackAndWhite.config.bw_class_table.to_s.singularize
-      end
-
-      def bw_tests_table_name_pluralize
-        BlackAndWhite.config.bw_main_table.to_s.pluralize
-      end
-
-      def migration_version
-        if defined?(Rails) && Rails.version.start_with?('5')
-          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-        end
-      end
-    end
-  end
-end

data/lib/black_and_white/helpers/utils.rb

@@ -1,19 +0,0 @@
-module BlackAndWhite
-  module Helpers
-    module Utils
-      extend self
-
-      def active_record_4?
-        ::ActiveRecord::VERSION::MAJOR == 4
-      end
-
-      def active_record_5?
-        ::ActiveRecord::VERSION::MAJOR == 5
-      end
-
-      def active_record_3?
-        ::ActiveRecord::VERSION::MAJOR == 3
-      end
-    end
-  end
-end