activerecord-bit_field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 415e570a739aa2432d73524aabd9d6832fb98fb3
+  data.tar.gz: 6d6eb6d45f0b51044274c7d873db6c17f898bf30
+SHA512:
+  metadata.gz: a6dbf33d8feafeb8affe9a8a4681ecf7c333e4cebbf87e31e6bba5c8abbdbb2169b63c84125539704edaa9591320c2297603fd0fdaa7923bb2ef00ca72a83102
+  data.tar.gz: a2cd2c5213c5a8cc1c8b2b3c0d2cc4565ad38a491b245068e22f07806c2f08bf1d5a1d7e49e574f6cd68c2ffcef1c154e9750a980389b6327eda7ddb3a40124e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,108 @@
+# Activerecord::BitField
+
+[![Build Status](https://travis-ci.org/ainame/activerecord-bit_field.svg?branch=master)](https://travis-ci.org/ainame/activerecord-bit_field)
+
+Activerecord::BitField provide a feature of mapping bit fileds to RDB table in ActiveRecord.
+This is reinventing the wheel; see `See Also` section.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-bit_field'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-bit_field
+
+## Usage
+
+At first, `require 'active_record/bit_field'` when don't using autoload.
+Next, define the integer column to using management of fields.
+Finaly, declare the bit_field in arbitrary models.
+
+```ruby
+class AddFilePermissionsTable < ActiveRecord::Migration
+  def change
+    create_table(:file_permissions) do |t|
+      t.integer :file_id, null: false, default: 0 # you must specify `default: 0`
+      t.integer :permission, null: false
+    end
+  end
+end
+
+...
+
+class FilePermission < ActiveRecrod::Base
+  include ActiveRecord::BitField
+
+  # :read map to first bit, :write map to second, ....
+  #
+  # .. 0 0 0 0 | 0 0 0 0    <- permission column
+  #                | | |
+  #            +---+ | `-----+
+  #            |     |       |
+  #        execute write   read
+  #
+  bit_field permission: [:read, :write, :execute]
+end
+
+file_permission = FilePermission.new
+file_permission.read? # => false in default
+
+file_permission = FilePermission.create(file_id: 1, permission: 1) # `1` is the bit map value
+file_permission.read? # => true
+file_permission.write? # => false
+
+file_permission.enable_write
+file_permission.disable_read
+file_permission.enable_execute
+file_permission.save!
+
+file_permission.permissin # => { read: false, write: true, execute: true }
+```
+
+### Options
+
+ActiveRecord::BitField can easily realize default-true bit field.
+In normaly, specify `DEFAULT 0` to fields column, then turn bit off(0) represent false
+and turn bit on(1) represent true. If you want to use default-true bit field,
+you maybe specify `DEFAULT 1` in table schema. But, when you want to add other field
+in that column, how do it?
+
+ActiveRecord::BitField ready `invert` option. If you provide true value with :invert key,
+ActiveRecord::BitField invert dealing of bit state; turn bit off(0) represent true and turn bit on(1) represent false.
+
+```ruby
+class FilePermission < ActiveRecrod::Base
+  include ActiveRecord::BitField
+
+  bit_field permission: [:read, :write, :execute], invert: true
+end
+
+file_permisson = FilePermission.new
+file_permisson.read? #=> true in default
+```
+
+## See Also
+
+You can use other products in same needs.
+This plugin don't have the select query each fields feature.
+But, these have it.
+
+* [pboling/flag_shih_tzu](https://github.com/pboling/flag_shih_tzu)
+* [grosser/bitfields](https://github.com/grosser/bitfields)
+
+## Contributing
+
+1. Fork it ( https://github.com/ainame/activerecord-bit_field/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,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+task default: :spec

data/activerecord-bit_field.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/bit_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-bit_field"
+  spec.version       = ActiveRecord::BitField::VERSION
+  spec.authors       = ["ainame"]
+  spec.email         = ["s.namai.09@gmail.com"]
+  spec.summary       = %q{provide a feature of mapping bit fileds to RDB table in ActiveRecord.}
+  spec.description   = %q{Activerecord::BitField provide a feature of mapping bit fileds to RDB table in ActiveRecord.}
+  spec.homepage      = "https://github.com/ainame/activerecord-bit_field"
+  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_runtime_dependency "activesupport", '>= 3.0.0'
+  spec.add_runtime_dependency "activerecord", '>= 3.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+end

data/lib/active_record/bit_field.rb

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+require 'active_record/bit_field/version'
+require 'active_support/concern'
+
+module ActiveRecord
+  module BitField
+    extend ActiveSupport::Concern
+
+    def bit_field_turn_bit_on_method(column, field)
+      value = read_attribute(column)
+      write_attribute(column, value | self.class.bit_field_get_column_mapper(column)[field.to_s])
+      nil
+    end
+
+    def bit_field_turn_bit_off_method(column, field)
+      value = read_attribute(column)
+      if (value & self.class.bit_field_get_column_mapper(column)[field.to_s]) != 0
+        write_attribute(column, value ^ self.class.bit_field_get_column_mapper(column)[field.to_s])
+      end
+      nil
+    end
+
+    def bit_field_inquire_method(column, field)
+      (read_attribute(column) & self.class.bit_field_get_column_mapper(column)[field.to_s]) != 0
+    end
+
+    def bit_field_setter_method(column, field, bool)
+      if bool
+        bit_field_turn_bit_on_method(column, field)
+      else
+        bit_field_turn_bit_off_method(column, field)
+      end
+    end
+
+    module ClassMethods
+      # @param [Hash] args オプションを含めた引数のハッシュ、キーがカラム名値の配列がフィールド名になる
+      # @option args [Boolean] :invret truthyな値を渡すとビットへのマッピング時にビットが0の状態を有効に1を無効にする
+      def bit_field(args = {})
+        destructed_args = args.to_a
+        argument = destructed_args.shift
+        options = destructed_args.to_h
+        raise "can't find arguments" unless argument
+
+        column, fields = argument
+        bit_field_set_column_fields(column, fields.dup)
+
+        mapper = bit_field_create_mapper(fields)
+        bit_field_set_column_mapper(column, mapper)
+
+        bit_field_orverride_getter_method(column, options)
+        bit_field_define_setter_method(column, options)
+        bit_field_define_fields_method(column, fields, options)
+
+        fields.each do |field|
+          bit_field_define_inquire_method(column, field, options)
+          bit_field_define_enable_method(column, field, options)
+          bit_field_define_disable_method(column, field, options)
+        end
+      end
+
+      def bit_field_create_mapper(fields)
+        fields.map.with_index.inject({}) do |map, (field, bit_shift)|
+          map[field.to_s] = 1 << bit_shift
+          map
+        end
+      end
+
+      def bit_field_set_column_fields(column, fields)
+        instance_variable_set("@_#{column}_fields", fields)
+      end
+
+      def bit_field_get_column_fields(column)
+        instance_variable_get("@_#{column}_fields")
+      end
+
+      def bit_field_set_column_mapper(column, mapper)
+        instance_variable_set("@_#{column}_mapper", mapper)
+      end
+
+      def bit_field_get_column_mapper(column)
+        instance_variable_get("@_#{column}_mapper")
+      end
+
+      def bit_field_orverride_getter_method(column, options)
+        unless options[:invert]
+          define_method "#{column}" do
+            self.class.bit_field_get_column_fields(column).reduce({}) do |mapping, field|
+              mapping[field] = bit_field_inquire_method(column, field)
+              mapping
+            end
+          end
+        else
+          define_method "#{column}" do
+            self.class.bit_field_get_column_fields(column).reduce({}) do |mapping, field|
+              mapping[field] = !bit_field_inquire_method(column, field)
+              mapping
+            end
+          end
+        end
+      end
+
+      def bit_field_define_setter_method(column, options)
+        unless options[:invert]
+          define_method "set_#{column}_field" do |field, value|
+            bit_field_setter_method(column, field, value)
+          end
+        else
+          define_method "set_#{column}_field" do |field, value|
+            bit_field_setter_method(column, field, !value)
+          end
+        end
+      end
+
+      def bit_field_define_fields_method(column, fields, options)
+        define_singleton_method "#{column}_fields" do
+          bit_field_get_column_fields(column)
+        end
+      end
+
+      def bit_field_define_inquire_method(column, field, options)
+        unless options[:invert]
+          define_method "#{field}?" do
+            bit_field_inquire_method(column, field)
+          end
+        else
+          define_method "#{field}?" do
+            !bit_field_inquire_method(column, field)
+          end
+        end
+      end
+
+      def bit_field_define_enable_method(column, field, options)
+        unless options[:invert]
+          define_method "enable_#{column}_field" do |_field|
+            bit_field_turn_bit_on_method(column, _field)
+          end
+
+          define_method "enable_#{field}" do
+            bit_field_turn_bit_on_method(column, field)
+          end
+        else
+          define_method "enable_#{column}_field" do |_field|
+            bit_field_turn_bit_off_method(column, _field)
+          end
+
+          define_method "enable_#{field}" do
+            bit_field_turn_bit_off_method(column, field)
+          end
+        end
+      end
+
+      def bit_field_define_disable_method(column, field, options)
+        unless options[:invert]
+          define_method "disable_#{column}_field" do |_field|
+            bit_field_turn_bit_off_method(column, _field)
+          end
+
+          define_method "disable_#{field}" do
+            bit_field_turn_bit_off_method(column, field)
+          end
+        else
+          define_method "disable_#{column}_field" do |_field|
+            bit_field_turn_bit_on_method(column, _field)
+          end
+
+          define_method "disable_#{field}" do
+            bit_field_turn_bit_on_method(column, field)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/bit_field/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module BitField
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/active_record/bit_field_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe ActiveRecord::BitField do
+
+  describe '.<column>_fields' do
+    it 'should return field names' do
+      expect(Dummy.flags_fields).to eq([:aaa, :bbb, :ccc])
+    end
+  end
+
+  context 'using bit_field DSL by flags column' do
+    let(:dummy) { Dummy.new }
+    let(:dummy_invert) { DummyInvert.new }
+
+    describe '#flgas' do
+      it 'decide default value by cloumn default value' do
+        expect(dummy.flags).to eq({ aaa: false, bbb: false, ccc: false})
+        expect(dummy_invert.flags).to eq({ aaa: true, bbb: true, ccc: true})
+      end
+
+      context 'enable aaa flag' do
+        before do
+          dummy.enable_flags_field(:aaa)
+          dummy.save!
+          dummy_invert.enable_flags_field(:aaa)
+          dummy_invert.save!
+        end
+
+        it 'default value is all false' do
+          expect(dummy.flags).to eq({ aaa: true, bbb: false, ccc: false})
+          expect(dummy_invert.flags).to eq({ aaa: true, bbb: true, ccc: true})
+        end
+      end
+    end
+
+    describe '#enable_<column>_field' do
+      before do
+        dummy_invert.send(:write_attribute, :flags, 1)
+        dummy_invert.save!
+      end
+
+      it 'should change bit value' do
+        expect { dummy.enable_flags_field(:aaa) }.to change {
+          dummy.read_attribute(:flags)
+        }.from(0).to(1)
+
+        expect { dummy_invert.enable_flags_field(:aaa) }.to change {
+          dummy_invert.read_attribute(:flags)
+        }.from(1).to(0)
+      end
+    end
+
+    describe '#disable_<column>_field' do
+      before do
+        dummy.send(:write_attribute, :flags, 1)
+        dummy.save!
+      end
+
+      it 'should change bit value' do
+        expect { dummy.disable_flags_field(:aaa) }.to change {
+          dummy.read_attribute(:flags)
+        }.from(1).to(0)
+
+        expect { dummy_invert.disable_flags_field(:aaa) }.to change {
+          dummy_invert.read_attribute(:flags)
+        }.from(0).to(1)
+      end
+    end
+
+    describe 'shorthand syntax' do
+      it 'has each flags inquire methods' do
+        expect(dummy.aaa?).to be(false)
+        expect(dummy.bbb?).to be(false)
+        expect(dummy.ccc?).to be(false)
+        expect(dummy_invert.aaa?).to be(true)
+        expect(dummy_invert.bbb?).to be(true)
+        expect(dummy_invert.ccc?).to be(true)
+      end
+
+      it 'has each flags inquire methods' do
+        expect { dummy.enable_aaa }.to change { dummy.aaa? }.from(false).to(true)
+        expect { dummy_invert.disable_aaa }.to change { dummy_invert.aaa? }.from(true).to(false)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib')))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+
+require 'active_record'
+require 'active_record/bit_field'
+require 'support/dummy'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Dummy.delete_all
+    DummyInvert.delete_all
+  end
+end

data/spec/support/dummy.rb

@@ -0,0 +1,30 @@
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+class DummySchema < ActiveRecord::Migration
+  def change
+    create_table :dummies do |t|
+      t.integer :flags, default: 0, null: false
+    end
+
+    create_table :dummy_inverts do |t|
+      t.integer :flags, default: 0, null: false
+    end
+  end
+end
+
+ActiveRecord::Migration.suppress_messages do
+  DummySchema.migrate(:up)
+end
+
+class Dummy < ActiveRecord::Base
+  include ActiveRecord::BitField
+  bit_field flags: [:aaa, :bbb, :ccc]
+end
+
+class DummyInvert < ActiveRecord::Base
+  include ActiveRecord::BitField
+  bit_field flags: [:aaa, :bbb, :ccc], invert: true
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-bit_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ainame
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: pry
+  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'
+description: Activerecord::BitField provide a feature of mapping bit fileds to RDB
+  table in ActiveRecord.
+email:
+- s.namai.09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-bit_field.gemspec
+- lib/active_record/bit_field.rb
+- lib/active_record/bit_field/version.rb
+- spec/lib/active_record/bit_field_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy.rb
+homepage: https://github.com/ainame/activerecord-bit_field
+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: provide a feature of mapping bit fileds to RDB table in ActiveRecord.
+test_files:
+- spec/lib/active_record/bit_field_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy.rb