bitmasker 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Amiel Martin
+
+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
+NON-INFRINGEMENT. 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,83 @@
+Bitmasker
+=========
+
+Bitmasker allows you to store many boolean values as one integer field in the database.
+
+Synopsis
+--------
+
+
+```ruby
+  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
+```
+
+Examples
+--------
+
+```ruby
+  # in migration
+  t.integer :notifications_mask
+
+  # 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
+      config.accessible
+      # config.field_name :notifications_mask # <- default functionality
+    end
+  end
+```
+
+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
+* `User#send_weekly_newsletter=(value)` -- just give it a boolean value (also takes "0" and "1" or "t" and "f" just like activerecord does for boolean fields)
+* `User#send_monthly_newsletter?`
+* `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
+
+
+
+View Example
+------------
+
+```erb
+  # in your view
+  <% form_for @user do |f| %>
+    Monthly Newsletter: <%= f.check_box :send_monthly_newsletter? %>
+    or
+    Monthly Newsletter
+    Yes: <%= f.radio_button :send_monthly_newsletter, 'true' %>
+    No: <%= f.radio_button :send_monthly_newsletter, 'false' %>
+  <% end %>
+```
+
+
+Config Options
+--------------
+
+`config.attribute(name, mask, default = false)`
+
+Sets up a binary attribute. Defines three functions: name, name?, and name=(true|false)
+* `name`    a symbol, Bitmasker will define
+* `mask`    example: 0b0000001, must be a power of 2
+* `default`   set to true if you want the attribute to default to true
+
+`config.accessible`
+if you are using attr_accessible in your model and you want to mass-assign your bitmask attributes, you will want to call this
+
+`config.field_name(name)`
+* `name`    name of the field name in the database where all this info is stored, should be an integer
+
+
+Copyright (c) 2012 Amiel Martin, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  # t.warning = true
+end

data/lib/bitmasker/bitmask_attributes.rb

@@ -0,0 +1,73 @@
+module Bitmasker
+  class BitmaskAttributes
+    include ActiveModel::AttributeMethods
+    attribute_method_suffix '?'
+    attribute_method_suffix '='
+    attribute_method_suffix '_was'
+
+    class_attribute :bitmask_attributes
+    class_attribute :defaults
+    class_attribute :model_class
+    class_attribute :field_name
+
+
+    def self.make(model_class, field_name, bitmask_attributes, defaults = {})
+      klass = Class.new(self) do
+        define_attribute_methods bitmask_attributes.keys
+      end
+
+      klass.model_class = model_class
+      klass.bitmask_attributes = bitmask_attributes.stringify_keys
+      klass.defaults = defaults.stringify_keys
+      klass.field_name = field_name
+
+      def klass.to_s
+        "#{superclass}(#{model_class}##{field_name})"
+      end
+
+      klass
+    end
+
+    def self.value_to_boolean(value)
+      model_class.value_to_boolean(value)
+    end
+
+    attr_reader :model, :bitmask
+    def initialize(model)
+      @model = model
+      @bitmask = Bitmask.new(bitmask_attributes, read || defaults)
+    end
+
+    def attribute(attribute)
+      bitmask.get attribute
+    end
+    alias_method :attribute?, :attribute
+
+    def attribute=(attribute, value)
+      bitmask.set attribute, self.class.value_to_boolean(value)
+      write
+    end
+
+    def attribute_was(attribute)
+      Bitmask.new(bitmask_attributes, was).get attribute
+    end
+
+    def to_a
+      bitmask.to_a
+    end
+
+    # Methods for the model
+
+    def read
+      model[field_name]
+    end
+
+    def write
+      model[field_name] = bitmask.to_i
+    end
+
+    def was
+      model.attribute_was field_name
+    end
+  end
+end

data/lib/bitmasker/generator.rb

@@ -0,0 +1,51 @@
+module Bitmasker
+  class Generator
+    def initialize(mask_name, model)
+      @bitmask_attributes = {}
+      @bitmask_defaults = {}
+
+      @model = model
+      @mask_name = mask_name
+      @field_name = mask_name.to_s + '_mask'
+
+      @use_attr_accessible = false
+    end
+
+
+    attr_writer :method_format
+    # makes the config dsl more consistent, allowing `config.method_format '%s'`
+    # instead of `config.method_format = '%s'`
+    alias_method :method_format, :method_format=
+
+
+    attr_writer :field_name
+    # makes the config dsl more consistent
+    alias_method :field_name, :field_name=
+
+    def attribute(name, mask, default = false)
+      @bitmask_attributes[name] = mask
+      @bitmask_defaults[name] = default
+    end
+
+    def accessible
+      @use_attr_accessible = true
+    end
+
+    def generate
+      klass = BitmaskAttributes.make(@model, @field_name, @bitmask_attributes, @bitmask_defaults)
+
+      @model.send :define_method, @mask_name do
+        klass.new(self)
+      end
+
+      @bitmask_attributes.each do |attribute, mask|
+        @model.delegate attribute, "#{attribute}?", "#{attribute}=",
+          "#{attribute}_was",
+          to: @mask_name
+
+        @model.attr_accessible attribute if @use_attr_accessible
+      end
+    end
+
+  end
+end

data/lib/bitmasker/model.rb

@@ -0,0 +1,18 @@
+module Bitmasker
+  module Model
+    def has_bitmask_attributes(name)
+      raise ArgumentError, "You must pass has_bitmask_attributes a block and define attributes." unless block_given?
+      config = Generator.new(name, self)
+      yield config
+      config.generate
+    end
+
+    def value_to_boolean(value)
+      if defined? ::ActiveRecord::ConnectionAdapters::Column
+        ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
+      else
+        ['1', 1, 't', 'true', true].include? value
+      end
+    end
+  end
+end

data/lib/bitmasker/rails.rb

@@ -0,0 +1,7 @@
+module Bitmasker
+  class Railtie < ::Rails::Railtie
+    initializer 'bitmasker.activerecord_extensions' do |app|
+      ActiveRecord::Base.send :extend, Bitmasker::Model
+    end
+  end
+end

data/lib/bitmasker/version.rb

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

data/lib/bitmasker.rb

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

data/test/bitmasker/bitmask_attributes_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class Bitmasker::BitmaskAttributesTest < MiniTest::Unit::TestCase
+
+  MockModel = Class.new do
+    def self.value_to_boolean(value)
+      !!value
+    end
+
+    def [](attribute)
+      0
+    end
+  end
+
+  def model_instance
+    @model_instance ||= MockModel.new
+  end
+
+  def setup
+    @klass = Bitmasker::BitmaskAttributes.make(
+      MockModel, 'email_mask',
+      send_weekly_email: 0b0001,
+      send_monthly_newsletter: 0b0010,
+    )
+  end
+
+  def subject
+    @subject ||= @klass.new(model_instance)
+  end
+
+  def test_klass_to_s
+    assert_equal "Bitmasker::BitmaskAttributes(Bitmasker::BitmaskAttributesTest::MockModel#email_mask)", @klass.to_s
+  end
+
+  def test_set_attribute
+    model_instance.expects(:[]=).with('email_mask', 1)
+    subject.send_weekly_email = true
+    assert_equal true, subject.send_weekly_email
+  end
+
+  def test_read_attribute
+    model_instance.expects(:[]).with('email_mask').returns(0)
+    assert_equal false, subject.send_weekly_email
+  end
+
+  def test_read_attribute_with_true_value
+    model_instance.expects(:[]).with('email_mask').returns(2)
+    assert_equal true, subject.send_monthly_newsletter
+  end
+
+  def test_predicate
+    model_instance.expects(:[]).with('email_mask').returns(2)
+    assert_equal true, subject.send_monthly_newsletter?
+  end
+
+  def test_was
+    model_instance.expects(:attribute_was).twice.with('email_mask').returns(1)
+    assert_equal false, subject.send_monthly_newsletter_was
+    assert_equal true, subject.send_weekly_email_was
+  end
+
+  def test_to_a
+    model_instance.expects(:[]).with('email_mask').returns(2)
+    assert_equal ['send_monthly_newsletter'], subject.to_a
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,111 @@
+require 'test_helper'
+
+class MockModel
+
+  attr_accessor :dummy_mask
+  attr_accessor :another_dummy_mask
+  extend Bitmasker::Model
+
+  def []=(sym, value)
+    send "#{ sym }=", value
+  end
+
+  def [](sym)
+    send sym
+  end
+
+  def self.accessible_attrs
+    @@accessible_attrs
+  end
+
+  def accessible_attrs
+    @@accessible_attrs
+  end
+
+  def self.attr_accessible(*args)
+    @@accessible_attrs ||= []
+    @@accessible_attrs += args
+  end
+
+
+  has_bitmask_attributes :dummy do |config|
+    config.attribute :does_stuff, 0b0001
+    config.attribute :with_default, 0b0010, true
+  end
+
+  has_bitmask_attributes :another_dummy do |config|
+    config.attribute :an_accessible_attribute, 0b001
+    config.accessible
+  end
+
+end
+
+
+class BitmaskAttributesTest < MiniTest::Unit::TestCase
+
+  def test_does_stuff_attribute
+    mock = MockModel.new
+    assert mock.dummy
+    assert !mock.does_stuff?
+    mock.does_stuff = true
+    assert mock.does_stuff?
+  end
+
+  def test_default
+    mock = MockModel.new
+    assert mock.with_default?, "should have a default: mock.dummy_mask is #{ mock.dummy_mask.inspect } mock.dummy is #{ mock.dummy.inspect }"
+    mock.with_default = false
+    assert !mock.with_default?, 'setting method after default failed'
+  end
+
+  def test_predicate_without_?
+    mock = MockModel.new
+    mock.does_stuff = true
+    assert mock.does_stuff
+  end
+
+  def test_accessible
+    mock = MockModel.new
+    assert_equal [:an_accessible_attribute], mock.accessible_attrs
+  end
+
+
+#  def test_array_assignment
+#    mock = MockModel.new
+#    mock.dummy = ['does_stuff']
+#    assert mock.does_stuff
+#    assert !mock.with_default
+#    mock.dummy = ['does_stuff', 'with_default'] # should accept strings
+#    assert mock.does_stuff
+#    assert mock.with_default
+#  end
+
+#  def test_empty_array_assignment
+#    mock = MockModel.new
+#    mock.dummy = []
+#    assert !mock.does_stuff
+#    assert !mock.with_default
+#  end
+
+#  def test_array_assignment_with_empty_strings
+#    mock = MockModel.new
+#    mock.dummy = ['', 'does_stuff']
+#    assert mock.does_stuff
+#    assert !mock.with_default
+#  end
+
+  # not throwing exception because you can't run migrations when it does
+  # def test_raises_without_field
+  #   assert_raise ArgumentError do
+  #     eval '
+  #     class MockModel
+  #       extend ::BitmaskAttributes
+  #
+  #       has_bitmask_attributes :without_field do |config|
+  #         config.attribute :none, 0b001
+  #       end
+  #     end
+  #     '
+  #   end
+  # end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'turn/autorun'
+
+require 'mocha/setup'
+
+require 'active_support/all'
+require 'active_record'
+
+require 'bitmasker'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: bitmasker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Amiel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitmask
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n    Bitmasker allows you to store many boolean values as one integer
+  field in the database.\n  "
+email:
+- amiel@carnesmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bitmasker/bitmask_attributes.rb
+- lib/bitmasker/generator.rb
+- lib/bitmasker/model.rb
+- lib/bitmasker/rails.rb
+- lib/bitmasker/version.rb
+- lib/bitmasker.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/bitmasker/bitmask_attributes_test.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/amiel/bitmasker
+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.23
+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/integration_test.rb
+- test/test_helper.rb