bitfield_attribute 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1da85dce3a7dee9f30ae1f56db09a16e2cf58098
+  data.tar.gz: 3b30bfaf3943ffe7dff701bdcb931cce8173b8ed
+SHA512:
+  metadata.gz: 6649c773b5257f37c07856865fb1b2e6c970247624839ed418b6091afef7e8ffd9d23984e9e006392add8f3b085796f1985ddb28e06f1fe16fcb912041aa1e81
+  data.tar.gz: 561f47334f78e9e7b9c04050bf4dea2da9cbae9333c3575f2312e32e6429654ac4b99eefae7689a37a93211d35a0880a9f79b25922e0457cf71633cf4a7b8f7f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Viktor Sokolov
+
+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,111 @@
+# BitfieldAttribute
+
+Bitfield value object for ActiveModel. No hidden definitions. No callbacks. Magicless.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitfield_attribute'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitfield_attribute
+
+## Usage
+
+Add integer column to your model:
+
+```ruby
+class AddNotificationSettingsToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :notification_settings, :integer, default: 0
+  end
+end
+```
+
+Define bitfield class:
+
+```ruby
+class User::NotificationSettings
+  include BitfieldAttribute::Base
+
+  define_bits :weekly_digest, :announces, :events
+end
+```
+
+Define accessor in the model:
+
+```ruby
+class User < ActiveRecord::Base
+  def notification_settings
+    @notification_settings ||= User::NotificationSettings.new(self, :notification_settings)
+  end
+
+  def notification_settings=(value)
+    notification_settings.attributes = value
+  end
+end
+```
+
+Use it:
+
+```ruby
+user = User.new(notification_settings: {weekly_digest: true})
+user.notification_settings.announces = true
+
+user.notification_settings.weekly_digest?   # => true
+user.notification_settings.to_a             # => [:weekly_digest, :announces]
+user.notification_settings.attributes       # => { weekly_digest: true, announces: true, events: false }
+user[:notification_settings]                # => 3
+```
+
+## ActiveModel I18n & forms
+
+Modify your bitfield class:
+
+```ruby
+class User::NotificationSettings
+  include BitfieldAttribute::Base
+  extend  ActiveModel::Naming
+  extend  ActiveModel::Translation
+
+  define_bits :weekly_digest, :announces, :events
+end
+```
+
+Add this to your locale file:
+
+```ruby
+en:
+  activemodel:
+    "user/notification_settings":
+      weekly_digest: 'Weekly top sellers digest'
+      announces: 'Announces'
+      events: 'Invitations'
+```
+
+Use forms:
+
+```slim
+= form_for @user do |form|
+  = form.fields_for :notification_settings, form.object.notification_settings do |f|
+    = f.check_box :weekly_digest
+    = f.label :weekly_digest
+
+  ...
+
+  = form.submit 'Save'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gzigzigzeo/bitfield_attribute/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bitfield_attribute.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitfield_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitfield_attribute"
+  spec.version       = BitfieldAttribute::VERSION
+  spec.authors       = ["Viktor Sokolov"]
+  spec.email         = ["gzigzigzeo@evilmartians.com"]
+  spec.summary       = %q{Bitfield value object for ActiveModel}
+  spec.description   = %q{Bitfield value object for ActiveModel. No hidden definitions. No callbacks. Magicless.}
+  spec.homepage      = "https://github.com/gzigzigzeo/bitfield_attribute"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activerecord"
+end

data/lib/bitfield_attribute.rb

@@ -0,0 +1,5 @@
+require "bitfield_attribute/version"
+require "bitfield_attribute/base"
+
+module BitfieldAttribute
+end

data/lib/bitfield_attribute/base.rb

@@ -0,0 +1,123 @@
+require 'active_model'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/object/inclusion'
+require 'active_support/concern'
+require 'active_record/connection_adapters/column'
+
+module BitfieldAttribute
+  module Base
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def define_bits(*keys)
+        if @keys.present?
+          raise ArgumentError, 'Define all your bits with a single #define_bits statement'
+        end
+
+        @keys = keys.map(&:to_sym)
+
+        if @keys.uniq.size != @keys.size
+          raise ArgumentError, "Bit names are not uniq"
+        end
+
+        if @keys.size > INTEGER_SIZE
+          raise ArgumentError, "Too many bit names for #{INTEGER_SIZE}-bit integer"
+        end
+
+        define_bit_methods
+      end
+
+      def keys
+        @keys
+      end
+
+      private
+      def define_bit_methods
+        keys.each do |key|
+          define_setter(key)
+          define_getter(key)
+        end
+      end
+
+      def define_setter(key)
+        define_method :"#{key}=" do |value|
+          @values[key] = value
+          write_bits
+        end
+      end
+
+      def define_getter(key)
+        define_method :"#{key}?" do
+          @values[key] || false
+        end
+
+        alias_method key, :"#{key}?"
+      end
+    end
+
+    def initialize(instance, attribute)
+      @instance = instance
+      @attribute = attribute
+
+      keys = self.class.keys
+
+      @values = keys.zip([false] * keys.size)
+      @values = Hash[@values]
+
+      read_bits
+    end
+
+    def to_a
+      @values.map { |key, value| key if value }.compact
+    end
+
+    def value
+      @instance[@attribute].to_i
+    end
+
+    def attributes
+      @values.freeze
+    end
+
+    def attributes=(hash)
+      @values.each { |key, _| @values[key] = false }
+      update(hash)
+    end
+
+    def update(hash)
+      hash.symbolize_keys.each do |key, value|
+        if @values.keys.include?(key)
+          @values[key] = true_value?(value)
+        end
+      end
+
+      write_bits
+    end
+
+    private
+    def read_bits
+      bit_value = @instance[@attribute].to_i
+
+      @values.keys.each.with_index do |name, index|
+        bit = 2 ** index
+        @values[name] = true if bit_value & bit == bit
+      end
+    end
+
+    def write_bits
+      0.tap do |bits|
+        @values.keys.each.with_index do |name, index|
+          bits = bits | (2 ** index) if @values[name]
+        end
+
+        @instance[@attribute] = bits
+      end
+    end
+
+    def true_value?(value)
+      value.in?(ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES)
+    end
+
+    INTEGER_SIZE = 32
+  end
+end

data/lib/bitfield_attribute/version.rb

@@ -0,0 +1,3 @@
+module BitfieldAttribute
+  VERSION = "0.0.1"
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe TestBitfield do
+  let(:storage) { { bitfield: 0 } }
+  subject { described_class.new(storage, :bitfield) }
+
+  context '#initialize' do
+    let(:storage) { { bitfield: 6 } }
+
+    it 'raises if too many values given' do
+      expect {
+        class WrongBitfield1
+          include BitfieldAttribute::Base
+
+          define_bits *(:A..:z).to_a
+        end
+      }.to raise_error(ArgumentError, 'Too many bit names for 32-bit integer')
+    end
+
+    it 'raises if non-uniq values given' do
+      expect {
+        class WrongBitfield2
+          include BitfieldAttribute::Base
+
+          define_bits :a, :a, :a
+        end
+      }.to raise_error(ArgumentError, 'Bit names are not uniq')
+    end
+
+    it 'raises if bits are defining with multiple statements' do
+      expect {
+        class WrongBitfield3
+          include BitfieldAttribute::Base
+
+          define_bits :a, :b, :c
+          define_bits :d, :e, :f
+        end
+      }.to raise_error(ArgumentError, 'Define all your bits with a single #define_bits statement')
+    end
+
+    it 'gets initial bits from value' do
+      expect(subject.first).to eq(false)
+      expect(subject.first?).to eq(false)
+
+      expect(subject.second).to eq(true)
+      expect(subject.second?).to eq(true)
+
+      expect(subject.last).to eq(true)
+      expect(subject.last?).to eq(true)
+
+      expect(subject.to_a).to eq([:second, :last])
+    end
+  end
+
+  context 'setters' do
+    it 'sets value on storage' do
+      expect(storage[:bitfield]).to eq(0)
+
+      subject.first = true
+      subject.last = true
+
+      expect(subject.value).to eq(5)
+      expect(storage[:bitfield]).to eq(5)
+    end
+
+    it 'sets values from hash' do
+      subject.attributes = { 'first' => '1', 'second' => '0', 'last' => '1' }
+
+      expect(subject.value).to eq(5)
+
+      subject.attributes = { first: 1 }
+
+      expect(subject.value).to eq(1)
+
+      expect(subject.attributes).to eq({ first: true, second: false, last: false })
+    end
+  end
+
+  context '#update' do
+    it 'updates attributes with provided hash' do
+      subject.attributes = { 'first' => '1', 'second' => '0', 'last' => '1' }
+
+      subject.update( first: 0, second: 1 )
+
+      expect(subject.value).to eq 6
+    end
+  end
+
+  context 'internalization' do
+    before do
+      I18n.enforce_available_locales = false
+      I18n.backend.store_translations(I18n.default_locale,
+        activemodel: {
+          attributes: {
+            test_bitfield: {
+              first: 'First field'
+            },
+            'bit_field/user/notification_settings' => {
+              second: 'Second field'
+            }
+          }
+        }
+      )
+    end
+
+    context 'non-namespaced model' do
+      it 'returns correct field name' do
+        expect(described_class.human_attribute_name(:first)).to eq('First field')
+      end
+    end
+
+    context 'namespaced model' do
+      subject { BitField::User::NotificationSettings.new(storage, :bitfield) }
+
+      it 'returns correct field name' do
+        expect(subject.class.human_attribute_name(:second)).to eq('Second field')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'bitfield_attribute'
+require 'support/test_bitfield'
+
+RSpec.configure do |config|
+  config.order = :random
+  config.filter_run(:focus)
+  config.run_all_when_everything_filtered = true
+end
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/support/test_bitfield.rb

@@ -0,0 +1,20 @@
+class TestBitfield
+  include BitfieldAttribute::Base
+  extend ActiveModel::Naming
+  extend ActiveModel::Translation
+
+  define_bits :first, :second, :last
+end
+
+module BitField
+  class User
+    class NotificationSettings
+      extend ActiveModel::Naming
+      extend ActiveModel::Translation
+
+      include BitfieldAttribute::Base
+
+      define_bits :second
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: bitfield_attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Viktor Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: simplecov
+  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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bitfield value object for ActiveModel. No hidden definitions. No callbacks.
+  Magicless.
+email:
+- gzigzigzeo@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitfield_attribute.gemspec
+- lib/bitfield_attribute.rb
+- lib/bitfield_attribute/base.rb
+- lib/bitfield_attribute/version.rb
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_bitfield.rb
+homepage: https://github.com/gzigzigzeo/bitfield_attribute
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bitfield value object for ActiveModel
+test_files:
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_bitfield.rb