bitmasker 0.1.0 → 0.2.0

data/README.md

@@ -16,6 +16,10 @@ Synopsis
   end
 ```
 
+[![Code Climate](https://codeclimate.com/github/amiel/bitmasker.png)](https://codeclimate.com/github/amiel/bitmasker)
+[![Build Status](https://travis-ci.org/amiel/bitmasker.png)](https://travis-ci.org/amiel/bitmasker)
+
+
 Examples
 --------
 
@@ -34,7 +38,8 @@ Examples
   end
 ```
 
-this will define the following methods:
+This will define the following methods:
+
 * `User#notifications` -- returns a BitmaskAttributes object representing all values
 * `User#send_weekly_newsletter?` -- predicate
 * `User#send_weekly_newsletter` -- works just like the predicate, makes it easy to use actionview form helpers
@@ -43,8 +48,28 @@ this will define the following methods:
 * `User#send_monthly_newsletter`
 * `User#send_monthly_newsletter=(value)`
 
-the call to `config.accessible` calls `attr_accessible :send_weekly_newsletter, :send_monthly_newsletter` in your model
+the call to `config.accessible` calls `attr_accessible :send_weekly_newsletter, :send_monthly_newsletter` in your model.
+
+### Scopes
+
+Bitmasker also sets up a few useful scopes:
 
+* `User#with_notifications`
+* `User#without_notifications`
+* `User#with_any_notifications`
+
+#### Scopes Examples
+
+```ruby
+# Users that want weekly newsletter
+User.with_notifications(:send_weekly_newsletter)
+
+# Users that want monthly AND weekly newsletters
+User.with_notifications(:send_monthly_newsletter, :send_weekly_newsletter)
+
+# Users that want monthly OR weekly newsletters
+User.with_any_notifications(:send_monthly_newsletter, :send_weekly_newsletter)
+```
 
 
 View Example
@@ -79,5 +104,37 @@ if you are using attr_accessible in your model and you want to mass-assign your
 * `name`    name of the field name in the database where all this info is stored, should be an integer
 
 
+Updating from `has_bitmask_attributes`
+--------------------------------------
+
+If you used the `method_format` feature from `has_bitmask_attributes`, you will need to change
+your configuration as `method_format` has been removed.
+
+### Before
+
+```ruby
+  # in app/models/user.rb
+  class User < ActiveRecord::Base
+    has_bitmask_attributes :notifications do |config|
+      config.attribute :weekly_newsletter,    0b0001
+      config.attribute :monthly_newsletter,   0b0010, true
+      config.method_format 'send_%s'
+    end
+  end
+```
+
+### After
+
+```ruby
+  # in app/models/user.rb
+  class User < ActiveRecord::Base
+    has_bitmask_attributes :notifications do |config|
+      config.attribute :send_weekly_newsletter,    0b0001
+      config.attribute :send_monthly_newsletter,   0b0010, true
+    end
+  end
+```
+
+
 Copyright (c) 2012 Amiel Martin, released under the MIT license
 

data/lib/bitmasker/bitmask_scope.rb

@@ -0,0 +1,61 @@
+module Bitmasker
+  class BitmaskScope
+    include ActiveModel::AttributeMethods
+    attribute_method_prefix 'with_'
+    attribute_method_prefix 'with_any_'
+    attribute_method_prefix 'without_'
+
+    class_attribute :model_class
+    class_attribute :field_name
+    class_attribute :mask_name
+    class_attribute :bitmask_attributes
+
+    def self.make(model_class, field_name, mask_name, bitmask_attributes)
+      klass = Class.new(self) do
+        define_attribute_methods [mask_name]
+
+        def self.to_s
+          "#{superclass}(#{model_class}##{field_name})"
+        end
+      end
+
+      klass.model_class = model_class
+      klass.field_name = field_name
+      klass.mask_name = mask_name
+      klass.bitmask_attributes = bitmask_attributes.stringify_keys
+
+      klass
+    end
+
+    def bitmask
+      Bitmask.new(bitmask_attributes, 0)
+    end
+
+    # REVIEW: This (the unused _ attribute) tells me I have the design wrong
+    def with_attribute(_, *attributes)
+      # TODO: Test lots of databases
+      bitmask_query attributes, "#{field_name} & :mask = :mask"
+    end
+
+    def with_any_attribute(_, *attributes)
+      # TODO: Test lots of databases
+      bitmask_query attributes, "#{field_name} & :mask <> 0"
+    end
+
+    def without_attribute(_, *attributes)
+      # TODO: Test lots of databases
+      bitmask_query attributes, "#{field_name} & :mask = 0 OR #{field_name} IS NULL"
+    end
+
+    private
+
+    def bitmask_query(attributes, query)
+      mask = bitmask
+      mask.set_array(Array.wrap(attributes).flatten.map(&:to_s))
+
+      # TODO: Test lots of databases
+      model_class.where(query, mask: mask.to_i)
+    end
+
+  end
+end

data/lib/bitmasker/generator.rb

@@ -8,6 +8,8 @@ module Bitmasker
       @mask_name = mask_name
       @field_name = mask_name.to_s + '_mask'
 
+      @scope_name = mask_name.to_s + '_scope'
+
       @use_attr_accessible = false
     end
 
@@ -33,14 +35,22 @@ module Bitmasker
 
     def generate
       klass = BitmaskAttributes.make(@model, @field_name, @bitmask_attributes, @bitmask_defaults)
+      scope_klass = BitmaskScope.make(@model, @field_name, @mask_name, @bitmask_attributes)
 
       @model.send :define_method, @mask_name do
         klass.new(self)
       end
 
+      @model.singleton_class.send :define_method, @scope_name do
+        scope_klass.new
+      end
+
+      @model.singleton_class.delegate "with_#{@mask_name}",
+        "without_#{@mask_name}", "with_any_#{@mask_name}",
+        to: @scope_name
+
       @bitmask_attributes.each do |attribute, mask|
-        @model.delegate attribute, "#{attribute}?", "#{attribute}=",
-          "#{attribute}_was",
+        @model.delegate attribute, "#{attribute}?", "#{attribute}=", "#{attribute}_was",
           to: @mask_name
 
         @model.attr_accessible attribute if @use_attr_accessible

data/lib/bitmasker/version.rb

@@ -1,3 +1,3 @@
 module Bitmasker
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/bitmasker.rb

@@ -1,6 +1,7 @@
 require 'bitmask'
 require 'bitmasker/model'
 require 'bitmasker/bitmask_attributes'
+require 'bitmasker/bitmask_scope'
 require 'bitmasker/generator'
 
 require 'bitmasker/rails' if defined? ::Rails

data/test/bitmasker/bitmask_attributes_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class Bitmasker::BitmaskAttributesTest < MiniTest::Unit::TestCase
+class Bitmasker::BitmaskAttributesTest < MiniTest::Test
 
   MockModel = Class.new do
     def self.value_to_boolean(value)

data/test/bitmasker/bitmask_scope_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class Bitmasker::BitmaskScopeTest < MiniTest::Test
+
+  MockModel = Class.new
+
+  def model_instance
+    @model_instance ||= MockModel.new
+  end
+
+  def setup
+    @klass = Bitmasker::BitmaskScope.make(
+      MockModel, 'email_mask', 'emails',
+      send_weekly_email:        0b0001,
+      send_monthly_newsletter:  0b0010,
+      send_daily_spam:          0b0100,
+    )
+  end
+
+  def subject
+    @subject ||= @klass.new
+  end
+
+  def test_klass_to_s
+    assert_equal "Bitmasker::BitmaskScope(Bitmasker::BitmaskScopeTest::MockModel#email_mask)", @klass.to_s
+  end
+
+
+  def test_with_attribute
+    MockModel.expects(:where).with("email_mask & :mask = :mask", mask: 1)
+    subject.with_emails(:send_weekly_email)
+  end
+
+  def test_with_attributes_array
+    MockModel.expects(:where).with("email_mask & :mask = :mask", mask: 6)
+    subject.with_emails([:send_monthly_newsletter, :send_daily_spam])
+  end
+
+  def test_with_attributes
+    MockModel.expects(:where).with("email_mask & :mask = :mask", mask: 6)
+    subject.with_emails(:send_monthly_newsletter, :send_daily_spam)
+  end
+
+  def test_without_attribute
+    MockModel.expects(:where).with("email_mask & :mask = 0 OR email_mask IS NULL", mask: 2)
+    subject.without_emails(:send_monthly_newsletter)
+  end
+
+  def test_with_any_attribute
+    MockModel.expects(:where).with("email_mask & :mask <> 0", mask: 3)
+    subject.with_any_emails([:send_weekly_email, :send_monthly_newsletter])
+  end
+end

data/test/integration_test.rb

@@ -41,7 +41,7 @@ class MockModel
 end
 
 
-class BitmaskAttributesTest < MiniTest::Unit::TestCase
+class BitmaskAttributesTest < MiniTest::Test
 
   def test_does_stuff_attribute
     mock = MockModel.new

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require 'turn/autorun'
+# require 'turn/autorun'
 
 require 'mocha/setup'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitmasker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitmask
@@ -100,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/bitmasker/bitmask_attributes.rb
+- lib/bitmasker/bitmask_scope.rb
 - lib/bitmasker/generator.rb
 - lib/bitmasker/model.rb
 - lib/bitmasker/rails.rb
@@ -109,6 +110,7 @@ files:
 - Rakefile
 - README.md
 - test/bitmasker/bitmask_attributes_test.rb
+- test/bitmasker/bitmask_scope_test.rb
 - test/integration_test.rb
 - test/test_helper.rb
 homepage: https://github.com/amiel/bitmasker
@@ -123,20 +125,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2321849182877328955
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2321849182877328955
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Bitmasker allows you to store many boolean values as one integer field in
   the database.
 test_files:
 - test/bitmasker/bitmask_attributes_test.rb
+- test/bitmasker/bitmask_scope_test.rb
 - test/integration_test.rb
 - test/test_helper.rb