bitwise_attribute 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 728afc2714df27029947e0f98b2c542ad8835bf44e052f720c588d22f2bcb821
-  data.tar.gz: 5e8fe818d69624b1888f954416a15f9cf938039067a5f67fea12eef73bf76e31
+  metadata.gz: '09a20c421bbc1d6c4c7803c43be1b937f53725c9f9cea4be27c05c0c00b4d23a'
+  data.tar.gz: 15af80b8780cfa9e081c45186049ee7bbd9a96266f140fcf2294e14adadf8dcc
 SHA512:
-  metadata.gz: 257fb003a2eb0421a5ca03b5b6cd32a2b4317c7172cb26a204e2516bc9b7aeb07989a99867bb5f33bbb6ccc6667f7bd88d5e1c116b18f6d782eee9dd469c5ece
-  data.tar.gz: 58b7153d9e3b51898d387252a1a91ed6f1514c778eff46f1941ed78cb4ff88b9d933131e493b4dbb184aaa27720d430335df741ba9a5ea103a66305b15d73a8e
+  metadata.gz: 8bbf57d1f5e5a69a2ab6952ca9d8cf5376e28846e8ab2b7d0c858d9838bf7d6563e6ceb283b8641b0095e2dc05150a17aa60bdafaad8c872c775bf967d4b9c61
+  data.tar.gz: 90a8b4ca18833063b57d64279ef2e2c8bef0c2a7975788c128dbf31fca0a4b3535a6820955a6e0e42412e4afb3f98a7db8e18549d8f5cfc93f16c5b66406fb24

data/.rspec

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

data/.rubocop.yml

@@ -2,20 +2,19 @@ Metrics/AbcSize:
   Max: 30
 
 Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/bitwise_attribute.rb'
-    - 'lib/bitwise_attribute/values_list.rb'
+  Enabled: false
 
 Metrics/LineLength:
   Max: 100
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 50
 
 Metrics/BlockLength:
   Max: 150
 
 Metrics/ModuleLength:
   Max: 200
+
+Metrics/AbcSize:
+  Max: 70

data/.travis.yml

@@ -3,3 +3,6 @@ language: ruby
 rvm:
   - 2.5.0
 before_install: gem install bundler -v 1.16.1
+script:
+  - bundle exec rspec --fail-fast
+  - bundle exec rubocop

data/Gemfile.lock

@@ -1,17 +1,23 @@
 PATH
   remote: .
   specs:
-    bitwise_attribute (0.2.2)
-      activesupport (~> 5.1.5)
+    bitwise_attribute (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
     activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    arel (8.0.0)
     ast (2.4.0)
     byebug (10.0.1)
     coderay (1.1.2)
@@ -61,6 +67,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -70,6 +77,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 3)
   bitwise_attribute!
   bundler (~> 1.16)
   pry-byebug
@@ -77,6 +85,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 0.54.0)
   simplecov (~> 0.15.1)
+  sqlite3
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -2,6 +2,9 @@
 [![Build Status](https://travis-ci.org/rikas/bitwise_attribute.svg?branch=master)](https://travis-ci.org/rikas/bitwise_attribute)
 
 # BitwiseAttribute
+Manipulation of bitmask attributes in your classes (typically ActiveRecord models). You can have multiple values mapped to the same column — for example when you need a User with multiple roles.
+
+It adds a lot of helper methods so you don't have to deal with the underlying mask.
 
 ## Installation
 
@@ -24,6 +27,10 @@ Or install it yourself as:
 Include `BitwiseAttribute` and then define your attribute with `attr_bitwise`. By default it will
 use the singularized name with `_mask`.
 
+Check the example below to see how to use the helpers and methods created automatically in your classes.
+
+## Examples
+
 For the `roles` attribute you need to have `role_mask` column in your model, so add the migration:
 
 ```ruby
@@ -37,19 +44,93 @@ end
 ```ruby
 class User < ActiveRecord::Base
   include BitwiseAttribute
-
+  
+  # This line will do all the magic!
+  #
+  # By default we assume that your column will be called `role_mask`.
+  # You can send the `column_name` option if your column has another name.
+  #
   attr_bitwise :roles, values: %i[user moderator admin]
 end
 ```
 
-You can then use
+### Instance manipulation
+
+You can then access the `roles` field without having to know the underlying value of `role_mask`.
+
+```ruby
+user = User.new(roles: [:user, :admin])
+
+user.roles
+#=> [:user, :admin]
+
+user.role_mask
+#=> 5
+
+user.roles << :moderator
+user.roles
+#=> [:user, :admin, :moderator]
+```
+
+You can see if a particular record has a given value:
+
+```ruby
+user.admin?
+#=> true
+```
+
+### Class methods
+
+You can get all available values and correspondent mask value:
+
+```ruby
+User.roles
+#=> { :user => 1, :moderator => 2, :admin => 4 }
+```
+
+So if you need all the keys just use:
+
+```ruby
+User.roles.keys
+#=> [:user, :moderator, :admin]
+```
+
+### ActiveRecord named scopes
+
+BitwiseAttribte will add some methods for easier queries on the database:
+
+```ruby
+User.with_roles
+#=> Users that have at least one role
+
+User.with_roles(:admin)
+#=> Users that have the :admin role
+
+User.with_roles(:admin, :moderator)
+#=> Users that have the admin role AND the moderator role
+
+User.with_any_roles(:admin, :moderator)
+#=> Users that have the admin role OR the moderator role
+
+User.with_exact_roles(:moderator)
+#=> Users that have ONLY the moderator role
+
+User.with_exact_roles(:moderator, :admin)
+#=> Users that have ONLY the moderator AND admin roles
+
+User.without_roles(:admin)
+#=> Users without the admin role
+
+User.without_roles(:admin, :moderator)
+#=> Users without the admin role AND without the moderator role
+```
+
+These are the same as using `with_roles`:
 
 ```ruby
-user = User.first
-user.roles #=> []
-user.roles = [:user, :admin] #=> [:user, :admin]
-user.save
-user.role_mask #=> 5
+User.admin
+User.user
+User.admin.moderator
 ```
 
 ## Development

data/bin/console

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'bitwise_attribute'
 

data/bitwise_attribute.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   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 'activerecord', '>= 3'
   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'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/bitwise_attribute/active_record_methods.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module BitwiseAttribute
+  module ActiveRecordMethods
+    def define_named_scopes(name, column_name, mapping)
+      define_singleton_method("with_#{name}") do |*keys|
+        keys = keys.flatten.uniq
+
+        return [] unless keys&.any?
+
+        records = where("#{column_name} & #{mapping[keys.first]} = #{mapping[keys.first]}")
+
+        keys[1..-1].each do |key|
+          records = records.where("#{column_name} & #{mapping[key]} = #{mapping[key]}")
+        end
+
+        records
+      end
+
+      define_singleton_method("with_any_#{name}") do |*keys|
+        keys = keys.flatten.uniq
+
+        return where.not(column_name => nil) unless keys&.any?
+
+        records = where("#{column_name} & #{mapping[keys.first]} = #{mapping[keys.first]}")
+
+        keys[1..-1].each do |key|
+          records = records.or(where("#{column_name} & #{mapping[key]} = #{mapping[key]}"))
+        end
+
+        records
+      end
+
+      define_singleton_method("with_exact_#{name}") do |*keys|
+        keys = keys.flatten.uniq
+
+        return [] unless keys&.any?
+
+        records = send("with_#{name}", keys)
+
+        (mapping.keys - keys).each do |key|
+          records = records.where("#{column_name} & #{mapping[key]} != #{mapping[key]}")
+        end
+
+        records
+      end
+
+      define_singleton_method("without_#{name}") do |*keys|
+        keys = keys.flatten.uniq
+
+        return where(column_name => nil).or(where(column_name => 0)) unless keys&.any?
+
+        records = where("#{column_name} & #{mapping[keys.first]} != #{mapping[keys.first]}")
+
+        keys[1..-1].each do |key|
+          records = records.where("#{column_name} & #{mapping[key]} != #{mapping[key]}")
+        end
+
+        records
+      end
+
+      # Defines a class method for each key of the mapping, returning records that have *at least*
+      # the corresponding value.
+      mapping.keys.each do |key|
+        define_singleton_method(key) do
+          send("with_#{name}", key)
+        end
+      end
+    end
+  end
+end

data/lib/bitwise_attribute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BitwiseAttribute
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/bitwise_attribute.rb

@@ -3,52 +3,39 @@
 require 'active_support'
 require 'active_support/concern'
 require 'active_support/core_ext'
+
 require 'bitwise_attribute/version'
 require 'bitwise_attribute/values_list'
+require 'bitwise_attribute/active_record_methods'
 
 module BitwiseAttribute
-  extend ActiveSupport::Concern
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    include BitwiseAttribute::ActiveRecordMethods
 
-  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)
-
       mapping = build_mapping(values)
 
-      @mapping ||= {}
-      @mapping[name] = mapping
-
       define_class_methods(name, column_name, mapping)
-      define_instante_methods(name, column_name, mapping)
+      define_instance_methods(name, column_name, mapping)
     end
 
+    private
+
     def define_class_methods(name, column_name, mapping)
-      # Class methods
       define_singleton_method(name) do
         mapping
       end
 
-      define_singleton_method("with_#{name}") do |*keys|
-        where(column_name => bitwise_union(keys, name))
-      end
-
-      define_singleton_method("with_all_#{name}") do |*keys|
-        where(column_name => bitwise_intersection(keys, name))
-      end
-
-      # Defines a class method for each key of the mapping, returning records that have *at least*
-      # the corresponding value.
-      mapping.keys.each do |key|
-        define_singleton_method(key) do
-          send("with_#{key}")
-        end
-      end
+      define_named_scopes(name, column_name, mapping) if defined?(ActiveRecord)
     end
 
-    def define_instante_methods(name, column_name, mapping)
+    def define_instance_methods(name, column_name, mapping)
       define_method(name) do
         roles = value_getter(column_name, mapping)
 
@@ -72,65 +59,9 @@ module BitwiseAttribute
     # Each sym get a power of 2 value
     def build_mapping(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
-      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
+        values.each_with_index { |key, index| hash[key] = (0b1 << index) }
       end
     end
-
-    def mapping_for_name(name)
-      @mapping[name.to_sym]
-    end
-
-    def values_for_column(name)
-      mapping_for_name(name).values
-    end
-
-    def map_to_values(name, keys)
-      mapping = mapping_for_name(name)
-
-      keys.map { |key| mapping[key.to_sym] }.compact
-    end
-
-    def bitwise_union(keys, name)
-      mask = []
-
-      mapped = map_to_values(name, keys)
-
-      mapped.each do |mv|
-        values_for_column(name).each do |value|
-          mask << (mv | value)
-        end
-      end
-
-      mask.uniq
-    end
-
-    def bitwise_intersection(keys, name)
-      mask = []
-
-      mapped = map_to_values(name, keys)
-      mapped = mapped.reduce(&:|)
-
-      values_for_column(name).each do |value|
-        mask << (value | mapped)
-      end
-
-      mask.uniq
-    end
   end
 
   private
@@ -150,16 +81,12 @@ module BitwiseAttribute
     values.each do |value|
       raise(ArgumentError, "Unknown value #{value}!") unless mapping[value]
 
-      add_value(mask_column, mapping[value])
+      send("#{mask_column}=", send(mask_column) | mapping[value])
     end
   end
 
-  # Return if value presents in mask (raw value)
+  # Return if value is present 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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bitwise_attribute
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
-  type: :runtime
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.15.1
+- !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'
 description: Bitwise attribute for ruby class and Rails model.
 email:
 - oterosantos@gmail.com
@@ -129,6 +143,7 @@ files:
 - bin/setup
 - bitwise_attribute.gemspec
 - lib/bitwise_attribute.rb
+- lib/bitwise_attribute/active_record_methods.rb
 - lib/bitwise_attribute/values_list.rb
 - lib/bitwise_attribute/version.rb
 homepage: https://github.com/rikas/bitwise_attribute