active_record_bitmask 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c280de0aa76c1faf1a0eedaa01e79e1cd573409e0fe213e0ec2ec2a386fd6905
-  data.tar.gz: a12217033318fbcc0de0fa377fb008d873efb4f715229df96d9f311f86be3d9b
+  metadata.gz: 92ef09e4ac0ca5c2da0db1869dc52776f5d990292e9c921bf02e364f1535925c
+  data.tar.gz: 5e48672686d4d15b10f547a2fccd0c017799dd259bf36f2d1184da9261bce2c8
 SHA512:
-  metadata.gz: 4e2b1d0f778ef4cfb1ebd4ee438b5ea3777b86dcea8f25bfd686a1ce06439d5a62778376f624dd4cd036f6aa2fc083226458b0632867a2e5d661c0bf68afb266
-  data.tar.gz: 39be7a07fca3f6ab7b4e3e3c806e4f63aba832451ddb2acfd9ef0710a6951499365ae0e9b6f72322d7e65cf770797646fa36de01effa6657abd521cf4dc6a60f
+  metadata.gz: 99696c27cf5fdcfede8e64be3791da418276f6dbd7b1edcb960b5dec585aa14587e82bf686e635d60cbccd0fbc4ab0c88e39150a24504c98e974b07048a55825
+  data.tar.gz: d3dfbe52f15833aada4cbe70559f93c3493511872a1af6f024c1f54d77c8697dab77f396debed19be074014bbe3e077442cfadb2e0a2da414a0126eecf89c07c

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/*.lock
+/gemfiles/.bundle

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - '.bundle/**/*'
+    - 'gemfiles/**/*'
     - Gemfile
   TargetRubyVersion: 2.6
   DisplayCopNames: true

data/.travis.yml

@@ -1,5 +1,31 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.13.7
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
+before_install: gem install bundler
+gemfile:
+  - gemfiles/5.0_stable.gemfile
+  - gemfiles/5.1_stable.gemfile
+  - gemfiles/5.2_stable.gemfile
+  - gemfiles/6.0_stable.gemfile
+  - gemfiles/6.1_stable.gemfile
+matrix:
+  exclude:
+    - rvm: 2.5.8
+      gemfile: gemfiles/6.1_stable.gemfile
+    - rvm: 2.6.6
+      gemfile: gemfiles/6.1_stable.gemfile
+    - rvm: 2.7.2
+      gemfile: gemfiles/6.1_stable.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/5.0_stable.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/5.1_stable.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/5.2_stable.gemfile
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Appraisals

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+appraise '5.0-stable' do
+  gem 'activerecord', '~> 5.0.0'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+appraise '5.1-stable' do
+  gem 'activerecord', '~> 5.1.0'
+end
+
+appraise '5.2-stable' do
+  gem 'activerecord', '~> 5.2.0'
+end
+
+appraise '6.0-stable' do
+  gem 'activerecord', '~> 6.0.0'
+end
+
+appraise '6.1-stable' do
+  gem 'activerecord', '~> 6.1.0.rc1'
+end
+
+appraise '7.0-stable' do
+  gem 'activerecord', '7.0.0.alpha2'
+end

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## 0.0.6
+
+* Deprecate `#attribute?(*args)` in favor of `#attribute_bitmask?(*args)`. #17
+* Support Rails 7.0.0.alpha1 #18
+
+## 0.0.5
+
+* Support Rails 6.1.0 #14
+
+## 0.0.4
+
+* Fixes security alert #9
+
+* Query methods supports string arguments #12
+
+## 0.0.3
+
+* Enumerize ActiveRecordBitmask::Map #4
+
+* Support old rails #5
+
+* Run RuboCop on CI. #6
+
+## 0.0.2
+
+* Support blank values for checkbox #3
+
+## 0.0.1
+
+* first release.

data/Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
-gem 'rubocop'
-
-group :test do
-  gem 'sqlite3'
-end
+# Don't update rubocop automatically because sometimes it fails test by breaking changes.
+gem 'rubocop', '0.86.0'
+gem 'appraisal'
+gem 'rake'
+gem 'rspec'
+gem 'sqlite3'

data/README.md

@@ -24,6 +24,8 @@ Simply declare an existing integer column as a bitmask.
 
 ```ruby
 class Post < ApplicationRecord
+  # bitmask attribute is integer column.
+  # `t.integer :roles, null: false, default: 0`
   bitmask(roles: [:administrator, :provider, :guest])
 end
 ```
@@ -41,8 +43,8 @@ You can check bitmask
 
 ```ruby
 post = Post.create(roles: [:provider, :guest])
-post.roles?(:provider) #=> false
-post.roles?(:guest, :provider) #=> true
+post.roles_bitmask?(:provider) #=> false
+post.roles_bitmask?(:guest, :provider) #=> true
 ```
 
 You can get the definition of bitmask
@@ -55,15 +57,45 @@ map.values #=> [1, 2, 4]
 
 ### Scopes
 
-#### `with_roles`
+Named scopes are defined when you call `.bitmask(attribute)`.
 
-#### `with_any_roles`
+#### `.with_attribute`
 
-#### `without_roles`
+```ruby
+# all users with roles
+User.with_roles
+
+# all administrators
+User.with_roles(:administrator)
+
+# all users who are both administrator and partner
+User.with_roles(:administrator, :partner)
+```
+
+#### `.with_any_attribute`
+
+```ruby
+# all users who are administrator or partner
+User.with_any_roles(:administrator, :partner)
+```
 
-#### `with_exact_roles`
+#### `.without_attribute`, `.no_attribute`
 
-#### `no_roles`
+```ruby
+# all users without role
+User.without_roles
+User.no_roles
+
+# all users who are not administrator
+User.without_roles(:administrator)
+```
+
+#### `.with_exact_attribute`
+
+```ruby
+# all users who are both administrator and partner and nothing else
+User.with_exact_roles(:administrator, :partner)
+```
 
 ## Development
 

data/active_record_bitmask.gemspec

@@ -14,13 +14,17 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Simple bitmask attribute support for ActiveRecord'
   spec.homepage      = 'https://github.com/alpaca-tc/active_record_bitmask'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.metadata      = {
+    'homepage_uri' => 'https://github.com/alpaca-tc/active_record_bitmask',
+    'changelog_uri' => 'https://github.com/alpaca-tc/active_record_bitmask/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/alpaca-tc/active_record_bitmask/',
+    'bug_tracker_uri' => 'https://github.com/alpaca-tc/active_record_bitmask/issues'
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activerecord', '>= 5.0'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
 end

data/gemfiles/5.0_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/5.1_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3"
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/5.2_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3"
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/6.0_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3"
+gem "activerecord", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/6.1_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3"
+gem "activerecord", "~> 6.1.0.rc1"
+
+gemspec path: "../"

data/gemfiles/7.0_stable.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry"
+gem "rubocop", "0.86.0"
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "sqlite3"
+gem "activerecord", "7.0.0.alpha2"
+
+gemspec path: "../"

data/lib/active_record_bitmask/attribute_methods/query.rb

@@ -1,24 +1,45 @@
 # frozen_string_literal: true
 
+require 'active_record'
+require 'active_support/concern'
+
 module ActiveRecordBitmask
   module AttributeMethods
     module Query
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix('_bitmask?')
+      end
+
       private
 
       def bitmask_attribute?(attribute_name)
         self.class.bitmasks.key?(attribute_name.to_sym)
       end
 
-      def attribute?(attribute_name, *values)
+      if ActiveRecord.gem_version < Gem::Version.create('7.0.0.alpha1')
+        # In Rails 7.0.0, calling attribute? with arguments is not working.
+        def attribute?(attribute_name, *values)
+          if bitmask_attribute?(attribute_name) && values.present?
+            ActiveSupport::Deprecation.warn("`#{attribute_name}?(*args)` is deprecated and will be removed in next major version. Call `#{attribute_name}_bitmask?(*args)` instead.")
+            attribute_bitmask?(attribute_name, *values)
+          else
+            super
+          end
+        end
+      end
+
+      def attribute_bitmask?(attribute_name, *values)
         if bitmask_attribute?(attribute_name) && values.present?
           # assert bitmask values
           map = self.class.bitmask_for(attribute_name)
-          map.attributes_to_bitmask(values)
+          expected_value = map.attributes_to_bitmask(values)
+          current_value = map.attributes_to_bitmask(attribute(attribute_name))
 
-          current_value = attribute(attribute_name)
-          values.all? { |value| current_value.include?(value) }
+          (current_value & expected_value) == expected_value
         else
-          super
+          attribute?(attribute_name)
         end
       end
     end

data/lib/active_record_bitmask/bitmask_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_model'
-
 module ActiveRecordBitmask
   class BitmaskType < ActiveModel::Type::Value
     # @param name [String]

data/lib/active_record_bitmask/map.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/module/delegation'
+
 module ActiveRecordBitmask
   class Map
+    include Enumerable
+
+    delegate(:each, :keys, :values, to: :mapping)
+
     # Default blank values for checkbox
     BLANK_VALUES = [:'', :'0'].freeze
 
@@ -64,16 +70,6 @@ module ActiveRecordBitmask
       end
     end
 
-    # @return [Array<Symbol>]
-    def keys
-      mapping.keys
-    end
-
-    # @return [Array<Integer>]
-    def values
-      mapping.values
-    end
-
     private
 
     def reject_blank_attributes(attributes)

data/lib/active_record_bitmask/model.rb

@@ -9,7 +9,10 @@ module ActiveRecordBitmask
 
     included do
       include ActiveRecordBitmask::AttributeMethods::Query
-      class_attribute(:bitmasks, instance_accessor: false, default: {})
+      class_attribute(:bitmasks, instance_accessor: false)
+
+      # `class_attribute` on Rails 5.0 doesn't support default option.
+      self.bitmasks = {}
     end
 
     class_methods do
@@ -48,11 +51,25 @@ module ActiveRecordBitmask
       private
 
       def define_bitmask_attribute(attribute, map)
-        decorate_attribute_type(attribute, :bitmask) do |subtype|
-          ActiveRecordBitmask::BitmaskType.new(attribute, map, subtype)
+        if ActiveRecord.gem_version >= Gem::Version.new('7.0.0.alpha1')
+          # Greater than or equal to 7.0.0
+          attribute(attribute) do |subtype|
+            ActiveRecordBitmask::BitmaskType.new(attribute, map, subtype)
+          end
+        elsif ActiveRecord.gem_version >= Gem::Version.new('6.1.0')
+          # Equal to 6.1.0
+          decorate_attribute_type(attribute) do |subtype|
+            ActiveRecordBitmask::BitmaskType.new(attribute, map, subtype)
+          end
+        else
+          # Less than 6.1.0
+          decorate_attribute_type(attribute, :bitmask) do |subtype|
+            ActiveRecordBitmask::BitmaskType.new(attribute, map, subtype)
+          end
         end
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def define_bitmask_scopes(attribute)
         blank = [0, nil].freeze
 
@@ -109,6 +126,7 @@ module ActiveRecordBitmask
           where(attribute => blank)
         }
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/active_record_bitmask/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordBitmask
-  VERSION = '0.0.2'
+  VERSION = '0.0.6'
 end

data/lib/active_record_bitmask.rb

@@ -5,11 +5,11 @@ require 'active_support/lazy_load_hooks'
 module ActiveRecordBitmask
   require 'active_record_bitmask/version'
   require 'active_record_bitmask/attribute_methods'
-  require 'active_record_bitmask/bitmask_type'
   require 'active_record_bitmask/map'
 end
 
 ActiveSupport.on_load :active_record do
   require 'active_record_bitmask/model'
+  require 'active_record_bitmask/bitmask_type'
   include(ActiveRecordBitmask::Model)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_bitmask
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - alpaca-tc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,48 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: '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: 
 email:
 - alpaca-tc@alpaca.tc
@@ -77,10 +35,18 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - active_record_bitmask.gemspec
+- gemfiles/5.0_stable.gemfile
+- gemfiles/5.1_stable.gemfile
+- gemfiles/5.2_stable.gemfile
+- gemfiles/6.0_stable.gemfile
+- gemfiles/6.1_stable.gemfile
+- gemfiles/7.0_stable.gemfile
 - lib/active_record_bitmask.rb
 - lib/active_record_bitmask/attribute_methods.rb
 - lib/active_record_bitmask/attribute_methods/query.rb
@@ -91,7 +57,11 @@ files:
 homepage: https://github.com/alpaca-tc/active_record_bitmask
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/alpaca-tc/active_record_bitmask
+  changelog_uri: https://github.com/alpaca-tc/active_record_bitmask/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/alpaca-tc/active_record_bitmask/
+  bug_tracker_uri: https://github.com/alpaca-tc/active_record_bitmask/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -107,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Simple bitmask attribute support for ActiveRecord