attr_bitwise 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c7bc7f15d2c51cdaa8e8fc01987c4b3e500d89a
+  data.tar.gz: fe4fbf205f6c998ea684a45f56e61a833623e1fc
+SHA512:
+  metadata.gz: 5aaa7af4fc47354187a8c654f296642d7a0699ebac3676d5ef6891895b730da09b674f8dba5f639d9b7e003605d85f5a87fb780da880f29e8531a562dc809866
+  data.tar.gz: b70fcaf5b88f2eaea060277a4860c1e018a714002ddcf7fb76f5d33fb4a5a99e5c30a08f42acad45ce4b2c44cb6c7ca50a613c61b7a1d07a9f207e2da5460f83

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    attr_bitwise (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.4)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attr_bitwise!
+  bundler (~> 1.6)
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Charly POLY
+
+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,49 @@
+# `attr_bitwise`
+Bitwise attribute for ruby class and Rails model
+
+```ruby
+# Helper to define a bits based value on a Rails model attribute
+#   this helper expose a set of methods to make bitwise operations
+#
+#
+# Usage :
+#   attr_bitwise :<name>, [column_name: <column_name>,] mapping: <values_sym>
+#
+# Example
+# class MyModel < ActiveRecord::Base
+#   include BitwiseUtils
+#
+#   attr_bitwise :payment_types, mapping: [:slots, :credits]
+# end
+#
+# Will define the following high-level methods :
+#   - Class#payment_types => [<Symbol>, ...]
+#   - Class#payment_type?(value_or_sym) => Boolean
+#   - Class#add_payment_type(value_or_sym) => Fixnum
+#   - Class#remove_payment_type(value_or_sym) => Fixnum
+#
+# Will define the following low-level methods :
+#   - Class.to_bitwise_values(object, name) => [<Fixnum>, ...]
+#   - Class#payment_types_union([Fixnum, ..]) => [Fixnum, ..]
+#   - Class.bitwise_union([Fixnum, ..], name) => [Fixnum, ..]
+#   - Class#payment_types_intersection([Fixnum, ..]) => [Fixnum, ..]
+#   - Class.bitwise_intersection([Fixnum, ..], name) => [Fixnum, ..]
+#   - Class#payment_types_mapping => Hash
+#
+```
+
+
+## Install
+
+
+### Inline
+
+- `gem install bitwise_attr`
+
+### Gemfile
+
+- `gem 'bitwise_attr'`
+
+
+----------------------------------------
+Maintainers :  @wittydeveloper and @FSevaistre 

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/attr_bitwise.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "attr_bitwise/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_bitwise"
+  spec.version       = AttrBitwise::VERSION
+  spec.authors       = ["Charly POLY"]
+  spec.email         = ["cpoly55@gmail.com"]
+  spec.summary       = %q{Bitwise attribute for ruby class and Rails model}
+  spec.description   = %q{Bitwise attribute for ruby class and Rails model}
+  spec.homepage      = ""
+  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"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/attr_bitwise/version.rb

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

data/lib/attr_bitwise.rb

@@ -0,0 +1,230 @@
+require "active_support"
+require "active_support/concern"
+require "active_support/core_ext"
+require "attr_bitwise/version"
+
+# Helper to define a bits based value on a Rails model attribute
+#   this helper expose a set of methods to make bitwise operations
+#
+#
+# Usage :
+#   attr_bitwise :<name>, [column_name: <column_name>,] mapping: <values_sym>
+#
+# Example
+# class MyModel < ActiveRecord::Base
+#   include BitwiseUtils
+#
+#   attr_bitwise :payment_types, mapping: [:slots, :credits]
+# end
+#
+# Will define the following high-level methods :
+#   - Class#payment_types => [<Symbol>, ...]
+#   - Class#payment_type?(value_or_sym) => Boolean
+#   - Class#add_payment_type(value_or_sym) => Fixnum
+#   - Class#remove_payment_type(value_or_sym) => Fixnum
+#
+# Will define the following low-level methods :
+#   - Class.to_bitwise_values(object, name) => [<Fixnum>, ...]
+#   - Class#payment_types_union([Fixnum, ..]) => [Fixnum, ..]
+#   - Class.bitwise_union([Fixnum, ..], name) => [Fixnum, ..]
+#   - Class#payment_types_intersection([Fixnum, ..]) => [Fixnum, ..]
+#   - Class.bitwise_intersection([Fixnum, ..], name) => [Fixnum, ..]
+#   - Class#payment_types_mapping => Hash
+#
+# More details in methods definition
+module AttrBitwise
+  extend ActiveSupport::Concern
+
+  # ClassMethods
+  module ClassMethods
+    ######################
+    # public class methods
+    ######################
+
+    # Usage :
+    #   attr_bitwise :payment_types, mapping: [:slots, :credits],
+    #     column_name: 'payment_types_value'
+    #
+    def attr_bitwise(name, column_name: nil, mapping:)
+      column_name = "#{name}_value" unless column_name.present?
+
+      # mask attribute_accessor (internals)
+      define_method('value') { send(column_name) }
+      define_method('value=') { |value| send("#{column_name}=", value) }
+
+      # build mapping
+      bitwise_mapping = build_mapping(mapping, name)
+
+      # mask to symbols helper
+      define_method("#{name}") { send(:value_getter, bitwise_mapping) }
+
+      define_method("#{name}=") do |values_or_symbols_array|
+        unless values_or_symbols_array.is_a?(Array)
+          values_or_symbols_array = [values_or_symbols_array]
+        end
+        send(:value_setter, values_or_symbols_array, bitwise_mapping)
+      end
+
+      # masks symbol presence
+      define_method("#{name.to_s.singularize}?") do |value_or_symbol|
+        send(:value?, force_to_bitwise_value(value_or_symbol, bitwise_mapping))
+      end
+
+      # add value to mask
+      define_method("add_#{name.to_s.singularize}") do |value_or_symbol|
+        send(:add_value, force_to_bitwise_value(value_or_symbol, bitwise_mapping))
+      end
+
+      # remove value from mask
+      define_method("remove_#{name.to_s.singularize}") do |value_or_symbol|
+        send(:remove_value, force_to_bitwise_value(value_or_symbol, bitwise_mapping))
+      end
+
+      # compute values union against mask
+      define_method("#{name}_union") do |*mixed_array|
+        self.class.bitwise_union(*mixed_array, name)
+      end
+
+      # compute values intersection against mask
+      define_method("#{name}_intersection") do |*mixed_array|
+        self.class.bitwise_intersection(*mixed_array, name)
+      end
+    end
+
+    # given a payment_values array, return a possible matches
+    #   for a union
+    #
+    # with PAYMENT_TYPES_MAPPING = { credits: 0b001, slots: 0b010, paypal: 0b100 }
+    # see http://www.calleerlandsson.com/2015/02/16/flags-bitmasks-and-unix-file-system-permissions-in-ruby/
+    #
+    # bitwise_union(:slots, :credits, 'payment_types') => [0b011, 0b111]
+    def bitwise_union(*mixed_array, name)
+      values_array = mixed_array.map { |v| to_bitwise_values(v, name) }
+      mapping = mapping_from_name(name)
+      mask = []
+
+      values_array.each do |pv|
+        mapping.values.each do |pvv|
+          mask << (pv | pvv)
+        end
+      end
+
+      mask.uniq
+    end
+
+    # given a values_arr ay array, return a possible matches
+    #   for a intersection
+    #
+    # with PAYMENT_TYPES_MAPPING = { credits: 0b001, slots: 0b010, paypal: 0b100 }
+    # see http://www.calleerlandsson.com/2015/02/16/flags-bitmasks-and-unix-file-system-permissions-in-ruby/
+    #
+    # bitwise_intersection(:slots, :credits, 'payment_types') => [0b101, 0b100, 0b011, 0b111]
+    def bitwise_intersection(*mixed_array, name)
+      values_array = mixed_array.map { |v| to_bitwise_values(v, name) }
+      mapping = mapping_from_name(name)
+      mask = []
+      val = values_array.reduce(&:|)
+
+      mapping.values.each do |pv|
+        mask << (pv | val)
+      end
+
+      mask.uniq
+    end
+
+    # given an Object, return proper Fixnum value, depending of mapping
+    def to_bitwise_values(object, name)
+      mapping = mapping_from_name(name)
+      if object.is_a?(Array)
+        object.map { |v| force_to_bitwise_value(v, mapping) }
+      elsif object.is_a?(Hash)
+        object.values.map { |v| force_to_bitwise_value(v, mapping) }
+      else
+        force_to_bitwise_value(object, mapping)
+      end
+    end
+
+    # Given a raw value (int) or a symbol, return proper raw value (int)
+    def force_to_bitwise_value(value_or_symbol, mapping)
+      if value_or_symbol.is_a?(Symbol)
+        mapping[value_or_symbol]
+      else
+        value_or_symbol.to_i
+      end
+    end
+
+    #######################
+    # Private class methods
+    #######################
+
+    private
+
+    # return mapping given a bitwise name
+    def mapping_from_name(name)
+      const_get("#{name}_mapping".upcase)
+    end
+
+    # build internal bitwise key-value mapping
+    #   it add a zero value, needed for bits operations
+    #
+    # each sym get a power of 2 value
+    def build_mapping(symbols, name)
+      mapping = {}.tap do |hash|
+        symbols.each_with_index do |key, i|
+          hash[key] = 2**i
+        end
+        hash[:empty] = 0
+      end
+      # put mapping in unique constant
+      const_mapping_name = "#{name}_mapping".upcase
+      const_set(const_mapping_name, mapping)
+    end
+  end
+
+  ##########################
+  # Private instance methods
+  ##########################
+
+  private
+
+  def force_to_bitwise_value(value_or_symbol, mapping)
+    self.class.force_to_bitwise_value(value_or_symbol, mapping)
+  end
+
+  # Given a raw value (int) return proper raw value (int)
+  def value_to_sym(value, mapping)
+    mapping.invert[value]
+  end
+
+  # Return current value to symbols array
+  #   Ex : 011 => :slots, :credits
+  def value_getter(mapping)
+    mapping.values.select { |pv| (value & pv) != 0 }.
+      map { |v| value_to_sym(v, mapping) }
+  end
+
+  # Set current values from values array
+  def value_setter(values_or_symbols_array, mapping)
+    self.value = 0
+    values_or_symbols_array.each { |val| add_value(force_to_bitwise_value(val, mapping)) }
+  end
+
+  # Return if value presents in mask (raw value)
+  def value?(val)
+    value & val != 0
+  end
+
+  # add `value_or_symbol` to mask
+  #   Ex, with values = `10`
+  #     add_value(1) => 11
+  def add_value(val)
+    self.value |= val
+  end
+
+  # remove `value_or_symbol` to mask
+  #   Ex, with values = `11`
+  #     remove_value(1) => 10
+  def remove_value(val)
+    self.value &= ~val
+  end
+end

data/spec/attr_bitwise_spec.rb

@@ -0,0 +1,163 @@
+require_relative '../lib/attr_bitwise.rb'
+
+describe AttrBitwise do
+
+  # test class in order to test concern
+  class TestClass
+
+    include AttrBitwise
+
+    attr_accessor :payment_types_value
+
+    attr_bitwise :payment_types, mapping: [:slots, :credits]
+
+    def initialize
+      @payment_types_value = 0
+    end
+
+  end
+
+  subject { TestClass.new }
+
+  context '.to_bitwise_values' do
+
+    context 'with Hash argument' do
+      it do
+        expect(
+          TestClass.to_bitwise_values(
+            {
+              a: :credits,
+              b: :slots
+            },
+            'payment_types'
+          )
+        ).to eq [2, 1]
+      end
+    end
+
+    context 'with Array argument' do
+      it do
+        expect(TestClass.to_bitwise_values(
+          [:credits, :slots],
+          'payment_types'
+        )).to eq [2, 1]
+      end
+    end
+
+    context 'with Fixnum argument' do
+      it do
+        expect(TestClass.to_bitwise_values(1, 'payment_types')).to eq 1
+      end
+    end
+
+  end
+
+  context 'with `payment_types` attribute_name' do
+
+    context '#payment_types=' do
+
+      before { subject.payment_types = [:slots, :credits] }
+
+      it 'should set proper value' do
+        expect(subject.payment_types_value).to eq 3
+        expect(subject.payment_types).to eq [:slots, :credits]
+      end
+
+    end
+
+    context 'with `payment_types_value` = 0' do
+      context '#payment_types' do
+
+        it do
+          expect(subject.payment_types).to eq []
+        end
+
+      end
+
+      context '#add_payment_type' do
+
+        it do
+          subject.add_payment_type(:slots)
+          expect(subject.payment_types).to eq [:slots]
+        end
+
+        context 'when called twice, each type remains unique' do
+          it do
+            subject.add_payment_type(:slots)
+            subject.add_payment_type(:slots)
+            expect(subject.payment_types).to eq [:slots]
+          end
+        end
+
+      end
+
+      context '#payment_type?(:slots)' do
+
+        it do
+          expect(subject.payment_type?(:slots)).to eq false
+        end
+
+      end
+    end
+
+    context 'with `payment_types_value` = 3' do
+
+      before { subject.payment_types_value = 3 }
+
+      context '#payment_types' do
+
+        it do
+          expect(subject.payment_types).to eq [:slots, :credits]
+        end
+
+      end
+
+      context '#payment_type?(:slots)' do
+
+        it do
+          expect(subject.payment_type?(:slots)).to eq true
+        end
+
+      end
+
+      context '#remove_payment_type' do
+
+        it do
+          subject.remove_payment_type(:slots)
+          expect(subject.payment_types).to eq [:credits]
+        end
+
+      end
+
+      context '#payment_types_union' do
+
+        it do
+          expect(subject.payment_types_union(1, 2)).to eq [1, 3, 2]
+        end
+
+      end
+
+      context '.bitwise_union' do
+
+        it do
+          expect(
+            TestClass.bitwise_union(1, 2, 'payment_types')
+          ).to eq [1, 3, 2]
+        end
+
+      end
+
+      context '#bitwise_intersection' do
+
+        it do
+          expect(
+            TestClass.bitwise_intersection(1, 2, 'payment_types')
+          ).to eq [3]
+        end
+
+      end
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: attr_bitwise
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charly POLY
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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'
+description: Bitwise attribute for ruby class and Rails model
+email:
+- cpoly55@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- attr_bitwise.gemspec
+- lib/attr_bitwise.rb
+- lib/attr_bitwise/version.rb
+- spec/attr_bitwise_spec.rb
+homepage: ''
+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: Bitwise attribute for ruby class and Rails model
+test_files:
+- spec/attr_bitwise_spec.rb