bitwise_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02de993668b47710ed8674dd89e0f31df73b5fe10a0f54791cfede73927f6801
+  data.tar.gz: bcc2a3e1916287a32029746e9878a3951adb6ca08a28e76d2eefb2cb713b1080
+SHA512:
+  metadata.gz: 35a58ec03084936782bf04ac7e634783d427861ce7a82fb7088ede9f162e8fd7b7d2acb387387454271e194e821709d6e1c6047a630556c2b6eb31fb44d5ee51
+  data.tar.gz: 5b9a4e19f46ec7082baa56f0a6c48e9b10fd8b82d31bca08f3672463d53b760fc71a4f68d18e37dfd4abab29f397cd37444f8b3b5cce76eff6064228d03bf3ad

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics/AbcSize:
+  Max: 20
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/bitwise_attribute.rb'
+    - 'lib/bitwise_attribute/values_list.rb'
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 45

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bitwise_attribute.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    bitwise_attribute (0.1.0)
+      activesupport (~> 5.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (10.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitwise_attribute!
+  bundler (~> 1.16)
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.54.0)
+  simplecov (~> 0.15.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ricardo Otero
+
+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,72 @@
+[![Dependency Status](https://gemnasium.com/rikas/bitwise_attribute.svg)](https://gemnasium.com/rikas/bitwise_attribute)
+[![Build Status](https://travis-ci.org/rikas/bitwise_attribute.svg?branch=master)](https://travis-ci.org/rikas/bitwise_attribute)
+
+# BitwiseAttribute
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitwise_attribute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitwise_attribute
+
+## Usage
+
+Include `BitwiseAttribute` and then define your attribute with `attr_bitwise`. By default it will
+use the singularized name with `_mask`.
+
+For the `roles` attribute you need to have `role_mask` column in your model, so add the migration:
+
+```ruby
+class AddRoleMaskToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :role_mask, :integer, default: 0
+  end
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  include BitwiseAttribute
+
+  attr_bitwise :roles, values: %i[user moderator admin]
+end
+```
+
+You can then use
+
+```ruby
+user = User.first
+user.roles #=> []
+user.roles = [:user, :admin] #=> [:user, :admin]
+user.save
+user.role_mask #=> 5
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rikas/bitwise_attribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bitwise_attribute'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitwise_attribute.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bitwise_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bitwise_attribute'
+  spec.version       = BitwiseAttribute::VERSION
+  spec.authors       = ['Ricardo Otero']
+  spec.email         = ['oterosantos@gmail.com']
+
+  spec.summary       = 'Bitwise attribute for ruby class and Rails model.'
+  spec.description   = 'Bitwise attribute for ruby class and Rails model.'
+  spec.homepage      = 'https://github.com/rikas/bitwise_attribute'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency 'activesupport', '~> 5.1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15.1'
+end

data/lib/bitwise_attribute.rb

@@ -0,0 +1,101 @@
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext'
+require 'bitwise_attribute/version'
+require 'bitwise_attribute/values_list'
+
+module BitwiseAttribute
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def attr_bitwise(name, column_name: nil, values:)
+      column_name ||= "#{name.to_s.singularize}_mask"
+
+      # Check if the values is an array or hash with valid values. Raise ArgumentError otherwise.
+      validate_values!(values)
+
+      # Sets the constant <name.upcase>_MAPPING
+      mapping = build_mapping(name, values)
+
+      @mapping ||= {}
+      @mapping[name] = mapping
+
+      define_singleton_method(name) do
+        @mapping[name]
+      end
+
+      define_method(name) do
+        roles = value_getter(column_name, mapping)
+
+        # This special array will call self.<name>= after changed
+        ValuesList.new(name, self, roles)
+      end
+
+      define_method("#{name}=") do |new_values|
+        value_setter(column_name, Array(new_values), mapping)
+      end
+
+      # Adds a boolean method for each key (ex: admin?)
+      mapping.keys.each do |key|
+        define_method("#{key}?") do
+          value?(column_name, mapping[key])
+        end
+      end
+    end
+
+    # Builds 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(name, values)
+      {}.tap do |hash|
+        if values.is_a?(Hash)
+          hash.merge!(values.sort_by { |_, value| value }.to_h)
+        else
+          values.each_with_index { |key, index| hash[key] = 2**index }
+        end
+
+        hash[:empty] = 0 # the default one
+      end
+    end
+
+    # Validates the numeric values for each key. If it's not a power of 2 then raise ArgumentError.
+    def validate_values!(values)
+      return true if values.is_a?(Array)
+
+      values.reject { |_, value| (Math.log2(value) % 1.0).zero? }.tap do |invalid_options|
+        if invalid_options.any?
+          raise(ArgumentError, "Values should be a power of 2 (#{invalid_options})")
+        end
+      end
+    end
+  end
+
+  private
+
+  # Return current value to symbols array
+  #   Ex: 16 => [:slots, :credits]
+  def value_getter(mask_column, mapping)
+    mapping.values.reject { |value| (send(mask_column) & value).zero? }.map do |value|
+      mapping.invert[value]
+    end
+  end
+
+  # Set current values from values array
+  def value_setter(mask_column, values, mapping)
+    send("#{mask_column}=", 0)
+
+    values.each do |value|
+      raise(ArgumentError, "Unknown value #{value}!") unless mapping[value]
+
+      add_value(mask_column, mapping[value])
+    end
+  end
+
+  # Return if value presents in mask (raw value)
+  def value?(mask_column, val)
+    send(mask_column) & val != 0
+  end
+
+  def add_value(mask_column, val)
+    send("#{mask_column}=", send(mask_column) | val)
+  end
+end

data/lib/bitwise_attribute/values_list.rb

@@ -0,0 +1,16 @@
+module BitwiseAttribute
+  class ValuesList < Array
+    def initialize(field, record, values)
+      @field = field
+      @record = record
+
+      concat(values)
+    end
+
+    def <<(value)
+      concat(Array(value))
+
+      @record.send("#{@field}=", self)
+    end
+  end
+end

data/lib/bitwise_attribute/version.rb

@@ -0,0 +1,3 @@
+module BitwiseAttribute
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: bitwise_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricardo Otero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: Bitwise attribute for ruby class and Rails model.
+email:
+- oterosantos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitwise_attribute.gemspec
+- lib/bitwise_attribute.rb
+- lib/bitwise_attribute/values_list.rb
+- lib/bitwise_attribute/version.rb
+homepage: https://github.com/rikas/bitwise_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.7.3
+signing_key: 
+specification_version: 4
+summary: Bitwise attribute for ruby class and Rails model.
+test_files: []