act_with_flags 0.2.4 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c723baaa15bf9f4e86987bb20e3c85984cb465d7758ab05866a41baaa6ed5a1
-  data.tar.gz: 29ac2c9336dedd278f2e3ee2a71710a4cc34117c07bc28869b989e5cf454cccb
+  metadata.gz: c995a59c8536ec6e012c9bf671e087b9f333c7a327512a42e1ffe725f0a12a0f
+  data.tar.gz: 63e16f84e582fd6427846d9391e3f02b3a528cda8cbdf16670c368c719af399e
 SHA512:
-  metadata.gz: 4bd31e1bf3a0f0a6721fa8ed916ae799e20022b46bfc78521f13ccd40d359737812bb4ae35a02ef601d0e654551f758eea795cc2defe8e0079301bda5e2644bb
-  data.tar.gz: 51a34e9a84543e5d36a709f82332b5a188414ee0425723fb1a25a483574d2ab0bc1b33a60d629d4e055808acdfb982fdc8e0983806e6d4a2ad2c9669479b3106
+  metadata.gz: e82dc33cbc493c8b849a3053c5d28e2d73522a9308bbb7d59fa698dfa8a58c7380b9c58df082aa3190010f112c32b51583356373a935064a6f8222cb449283d7
+  data.tar.gz: 2fe6db8a4d0177db3d679e57b3851d79559ddbbe741352b0144cd0a6bcaba717584241bccae242e862c60bf0109c32252ca8472acdab1591ca61b3aa579ee31e

data/.github/workflows/rake.yml

@@ -1,3 +1,4 @@
+# see also https://github.com/whitequark/parser/blob/master/.github/workflows/test.yml
 name: Rake
 
 #on: [push, pull_request]
@@ -12,7 +13,8 @@ jobs:
         os: [ubuntu-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
 #        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head, truffleruby, truffleruby-head]
-        ruby: [2.7]
+        ruby: ["2.7.2", "3.0.1", "3.1.2"]
+        test_command: ["bundle exec rake test"]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -20,5 +22,9 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - run: bundle exec rake
+    - name: Bundle install
+      run: |
+        bundle config path /home/runner/bundle
+        bundle install
+        bundle update
+    - run: ${{ matrix.test_command }}

data/.ruby-gemset

@@ -1 +1 @@
-rails-6.1
+rails-7.0

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.2
+ruby-3.1.2

data/.watchr

@@ -1,5 +1,6 @@
-HH = '#' * 22  unless defined?(HH)
-H = '#' * 5    unless defined?(H)
+TESTING = %w[test]
+HH = "#" * 22 unless defined?(HH)
+H = "#" * 5 unless defined?(H)
 
 def usage
   puts <<-EOS
@@ -14,35 +15,47 @@ def run(cmd)
   system "/usr/bin/time --format '#{HH} Elapsed time %E' #{cmd}"
 end
 
-def run_it(type, file)
-  case type
-  when 'test';  run %(bundle exec ruby -I test #{file})
-#  when 'spec';  run %(rspec -X #{file})
-  else;         puts "#{H} unknown type: #{type}, file: #{file}"
+def run_it(type, files)
+  files.split(" ").flatten.each do |file|
+    case type
+    when "test" then run %(bundle exec ruby -I test #{file})
+    #  when 'spec';  run %(rspec -X #{file})
+    else; puts "#{H} unknown type: #{type}, file: #{file}"
+    end
   end
 end
 
 def run_all_tests
   puts "\n#{HH} Running all tests #{HH}\n"
-  %w[test spec].each { |dir| run "bundle exec rake #{dir}" if  File.exist?(dir) }
+  TESTING.each { |dir| run "bundle exec rake #{dir}" if File.exist?(dir) }
 end
 
 def run_matching_files(base)
-  base = base.split('_').first
-  %w[test spec].each { |type|
+  base = base.split("_").first
+  TESTING.each { |type|
     files = Dir["#{type}/**/*.rb"].select { |file| file =~ /#{base}_.*\.rb/ }
-    run_it type, files.join(' ')  unless files.empty?
+    run_it type, files.join(" ") unless files.empty?
   }
 end
 
-%w[test spec].each { |type|
+TESTING.each { |type|
   watch("#{type}/#{type}_helper\.rb") { run_all_tests }
-  watch('lib/.*\.rb')                 { run_all_tests }
-  watch("#{type}/.*/*_#{type}\.rb")   { |match| run_it type, match[0] }
+  watch("lib/.*\.rb") { run_all_tests }
+  watch("#{type}/.*/*_#{type}\.rb") { |match| run_it type, match[0] }
+  watch("#{type}/data/(.*)\.rb") { |match|
+    m1 = match[1]
+    run_matching_files("#{type}/#{m1}/#{m1}_#{type}.rb")
+  }
+}
+
+%w[rb erb haml slim].each { |type|
+  watch("app/.*/(.*)\.#{type}") { |match|
+    run_matching_files(match[1])
+  }
 }
 
 # Ctrl-\ or ctrl-4
-    Signal.trap('QUIT') { run_all_tests }
+Signal.trap("QUIT") { run_all_tests }
 # Ctrl-C
-    Signal.trap('INT')  { abort("Interrupted\n") }
+Signal.trap("INT") { abort("Interrupted\n") }
 usage

data/Appraisals

@@ -1,11 +1,15 @@
-appraise 'rails-6.1' do
-  gem 'rails', '~> 6.0'
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0"
 end
 
-appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0'
+# appraise "rails-6.1" do
+#   gem "rails", "~> 6.0"
+# end
+
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.0"
 end
 
-#appraise 'rails-5.2' do
+# appraise 'rails-5.2' do
 #  gem 'rails', '~> 5.2.0'
-#end
+# end

data/Gemfile

@@ -1,11 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
-gem 'rails'
+gem "rails"
 
 group :test do
-  gem 'observr'
-  gem 'rubocop', require: false
-  gem 'simplecov', require: false
-  gem 'benchmark-ips'
+  gem "observr"
+  gem "standardrb", require: false
+  gem "simplecov", require: false
+  gem "benchmark-ips"
+  gem "ricecream"
 end

data/Gemfile.lock

@@ -1,173 +1,200 @@
 PATH
   remote: .
   specs:
-    act_with_flags (0.2.4)
+    act_with_flags (3.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      actionview (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.3.2)
-      actionview (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    activejob (7.0.3.1)
+      activesupport (= 7.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activerecord (6.1.3.2)
-      activemodel (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activestorage (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-      marcel (~> 1.0.0)
-      mini_mime (~> 1.0.2)
-    activesupport (6.1.3.2)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    appraisal (2.4.0)
+    appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
-    benchmark-ips (2.9.1)
+    benchmark-ips (2.10.0)
     builder (3.2.4)
-    combustion (1.3.1)
+    combustion (1.3.7)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
+    digest (3.1.0)
     docile (1.4.0)
-    erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.10)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    json (2.6.2)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.0.3)
-    minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.11.7-x86_64-linux)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
     observr (1.0.5)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.1.3.2)
-      actioncable (= 6.1.3.2)
-      actionmailbox (= 6.1.3.2)
-      actionmailer (= 6.1.3.2)
-      actionpack (= 6.1.3.2)
-      actiontext (= 6.1.3.2)
-      actionview (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activemodel (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.3.2)
-      sprockets-rails (>= 2.0.0)
+      railties (= 7.0.3.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.17.0)
+    ricecream (0.2.1)
+    rubocop (1.35.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (1.4.4)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    standardrb (1.0.1)
+      standard
+    strscan (3.0.4)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.2.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-linux
@@ -182,9 +209,10 @@ DEPENDENCIES
   observr
   rails
   rake
-  rubocop
+  ricecream
   simplecov
   sqlite3
+  standardrb
 
 BUNDLED WITH
-   2.2.17
+   2.3.14

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019-2020 Dittmar Krall - www.matique.com
+Copyright 2019-2022 Dittmar Krall - www.matiq.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,26 +1,135 @@
 # ActWithFlags
+
 [![Gem Version](https://badge.fury.io/rb/act_with_flags.png)](http://badge.fury.io/rb/act_with_flags)
 
-Required by key.matique.
+A Rails gem required by key.matiq.
+
+Handles booleans in "flags".
+Defines setters and getters to access the booleans.
+
 
 ## Installation
 
-Add this line to your application's Gemfile:
+As usual:
+```ruby
+# Gemfile
+...
+gem 'act_with_flags'
+```
+
+or manually:
+```shell
+$ gem install act_with_flags
+```
+
+
+## Version 3.1.1
+
+Option "range" can be specified just once for all
+"add_to_flags" for a specific "origin".
+
+For example:
+~~~ruby
+Order.add_to_flags range: ..0
+...
+Order.add_to_flags :a
+~~~
+
+Same as:
+~~~ruby
+Order.add_to_flags :a
+...
+Order.add_to_flags range: ..0
+~~~
+
+or:
+~~~ruby
+Order.add_to_flags :a, range: ..0
+~~~
+
+Examples for "range":
+~~~ruby
+Order.add_to_flags range: 0..17   # legal flag position from 0 to 17
+Order.add_to_flags range: ..17    # legal flag position from 0 to 17
+Order.add_to_flags range: nil..17 # legal flag position from 0 to 17
+Order.add_to_flags range: 3..     # legal flag position from 3 to big_number
+Order.add_to_flags range: 3..nil  # legal flag position from 3 to big_number
+~~~
+
+Invalid ranges:
+~~~ruby
+Order.add_to_flags range: -1..17   # range starting with a negative position
+Order.add_to_flags range: :a..:z   # invalid range
+Order.add_to_flags range: "a".."z" # invalid range
+~~~
+
+
+## Version 3.1.0
+
+Added option "range" limiting the position of flags.
+
+An example:
+```ruby
+ii = 3
+Order.add_to_flags range: (2..4), a: (ii += 1) # accepted
+Order.add_to_flags range: (2..4), b: (ii += 1) # raises exception
+```
+
+Option "range" enables an early static check.
+
+Option "range" does not replace the dynamic "validate" in models,
+which is strongly recommended for complex applications.
+Due to Ruby "act_with_flags" can handle a huge quantity
+of booleans in an integer (or a string),
+but your database may fail above a certain amount of bits.
+
+The option ":max_bits" is deprecated.
+
+
+## Version 3.0.x
+
+As required by key.matiq an enhanced "origin:" has been implemented.
+Act_with_flags now supports many "origin:"s
+(not just renaming the default "flags").
+
+An example:
+```ruby
+Order.add_to_flags :a # origin is :flags
+Order.add_to_flags :b, b2: 63 # origin is :flags
+Order.add_to_flags :c, origin: :origin1
+Order.add_to_flags d: 3, origin: :origin2
+Order.add_to_flags :d2, origin: :origin2
+```
+
+The default "origin:" continues to be "flags".
+
+
+## Testing
+
+As "Best Practice" a test coverage of 100% has been achieved
+(and should be kept).
+
+GitHub workflow enable tests for several configurations.
+Please, feel free to inspect the corresponding file.
 
-    gem 'act_with_flags'
+The "gem appraisal" is used for an additional set of configurations.
+Feel free to inspect the corresponding file.
 
-And then execute:
 
-    $ bundle
+## Links
 
-Or install it yourself as:
+Further reading:
 
-    $ gem install act_with_flags
+- [gem bitmask_attributes](https://github.com/joelmoss/bitmask_attributes)
+- [gem bitfields](https://github.com/grosser/bitfields)
+- [gem active_flag](https://github.com/kenn/active_flag)
+- [gem has-bit-field](https://github.com/pjb3/has-bit-field)
+- [gem bitfield_attribute](https://github.com/gzigzigzeo/bitfield_attribute)
 
 
 ## License MIT
 
-ActWithFlags is Copyright (c) 2019 [Dittmar Krall](matique.com UG) and
-is released under the MIT license:
+Copyright (c) 2019-2022 [Dittmar Krall](matiq UG (haftungsbeschränkt))
+and is released under the MIT license:
 
 * https://opensource.org/licenses/MIT

data/Rakefile

@@ -1,10 +1,10 @@
-require 'rake/testtask'
+require "rake/testtask"
 
-desc 'Run the tests.'
+desc "Run the tests."
 Rake::TestTask.new do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end