act_with_flags 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743598329586132b56037a7f83e282e0a23f7f7ebcf33c0281ca29ac9285b50f
-  data.tar.gz: 108e19ed8834782c421e247e76713bc4129113bef80a3389cb469a69d7fc8982
+  metadata.gz: 4e2b18cdaf7777bddb191c830bc942a6fd7c377a4267c8e7beae3b2ace3552e9
+  data.tar.gz: 1aed1f1e86fdbdd1cff793c0296c1b6e23c7400dc43f7df17ad8e13c3b1998d0
 SHA512:
-  metadata.gz: c37311aab7060cf9f57063e5e60c74840042180aea327a5a3d224b62e687bee59b31876d9367ecb44978cf868df93e778f760fe6a74f8fd6610df9e44bc451cb
-  data.tar.gz: 040b721cbc34321535dbdf281c3778fed4876c4f9cfe074c0c36ef38c9bd1b64ec5a3ae13db7b67517f396bdc826d0146e1acd88cc074845952fbd0e55c0a27c
+  metadata.gz: 11154bcaf21ff519f34863fdb847ffefd1e9a2fb493cfcdd8d0e015de42b601a9b3bf20d9e914d0e8681f39e321194ba3a27048a74fb43ce3972b9844cf0f14c
+  data.tar.gz: 4471f2dc9a7b48654fa9ea689e4f51e660f6eacb0012fc1ea75c43fd2cb9c91149c49243e24a78e4527407d4c75dd51e7b0066095efebb14f007eb3dda36a839

data/Gemfile

@@ -5,7 +5,7 @@ gem "rails"
 
 group :test do
   gem "observr"
-  gem "rubocop", require: false
+  gem "standardrb", require: false
   gem "simplecov", require: false
   gem "benchmark-ips"
   gem "ricecream"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    act_with_flags (3.0.1)
+    act_with_flags (3.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -100,7 +100,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.16.2)
+    minitest (5.16.3)
     net-imap (0.2.3)
       digest
       net-protocol
@@ -120,7 +120,7 @@ GEM
       racc (~> 1.4)
     observr (1.0.5)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     racc (1.6.0)
     rack (2.2.4)
@@ -157,18 +157,21 @@ GEM
     regexp_parser (2.5.0)
     rexml (3.2.5)
     ricecream (0.2.1)
-    rubocop (1.33.0)
+    rubocop (1.35.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.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)
@@ -177,6 +180,11 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     sqlite3 (1.4.4)
+    standard (1.16.0)
+      rubocop (= 1.35.0)
+      rubocop-performance (= 1.14.3)
+    standardrb (1.0.1)
+      standard
     strscan (3.0.4)
     thor (1.2.1)
     timeout (0.3.0)
@@ -202,9 +210,9 @@ DEPENDENCIES
   rails
   rake
   ricecream
-  rubocop
   simplecov
   sqlite3
+  standardrb
 
 BUNDLED WITH
    2.3.14

data/README.md

@@ -1,40 +1,80 @@
 # ActWithFlags
+
 [![Gem Version](https://badge.fury.io/rb/act_with_flags.png)](http://badge.fury.io/rb/act_with_flags)
 
-Required by key.matiq.
+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
+```
 
-    gem 'act_with_flags'
 
-And then execute:
+## Version 3.1.x
+
+Added option "range" limiting the position of booleans.
+
+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.
 
-    $ bundle install
+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.
 
-Or install it yourself as:
+The option ":max_bits" is deprecated.
 
-    $ gem install act_with_flags
 
-## Version 3.x
+## 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.
+
+The "gem appraisal" is used for an additional set of configurations.
+Feel free to inspect the corresponding file.
+
+
 ## Links
 
 Further reading:
@@ -45,9 +85,10 @@ Further reading:
 - [gem has-bit-field](https://github.com/pjb3/has-bit-field)
 - [gem bitfield_attribute](https://github.com/gzigzigzeo/bitfield_attribute)
 
+
 ## License MIT
 
-Copyright (c) 2019-2022 [Dittmar Krall](matiq.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/lib/act_with_flags/flags.rb

@@ -42,7 +42,6 @@ class ActWithFlags::Admin
   end
 
   def add_to_locations(flag, location)
-    location = check_position(location)
     who = "<#{flag}: #{location.origin}@#{location.position}>"
     raise "name already used #{who}" if @locations.key?(flag)
     bool = @locations.has_value?(location)
@@ -50,18 +49,17 @@ class ActWithFlags::Admin
     @locations[flag] = location
   end
 
-  def check_position(location)
-    model, orig, pos = location.values
-    return location if pos
+  def check_pos(model, origin, pos)
+    return pos if pos
 
     max_position = -1
     @locations.each { |name, location|
       model2, orig2, pos2 = location.values
-      next unless model == model2 && orig == orig2
+      next unless model == model2 && origin == orig2
 
       max_position = pos2 if pos2 > max_position
     }
 
-    Location.new(model, orig, max_position + 1)
+    max_position + 1
   end
 end

data/lib/act_with_flags/utils.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 class ActWithFlags::Admin
-  def add_flag(name, origin, pos)
+  def add_flag(name, pos, origin, range)
     accessor = name.to_sym
     validate_accessor accessor, "#{accessor}?", "#{accessor}="
 
+    pos = check_pos(model, origin, pos)
     loc = Location.new(model, origin, pos)
     add_to_locations accessor, loc
+
+    unless range.nil?
+      unless range.cover?(pos)
+        raise RangeError, "Position <#{loc.position}> out of range <#{range}>"
+      end
+    end
+
     mask = mask(accessor)
     add_accessors(accessor, origin, mask)
   end

data/lib/act_with_flags/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module ActWithFlags
-  VERSION = "3.0.1" # 2022-08-07
+  VERSION = "3.1.0" # 2022-08-29
+  # VERSION = "3.0.1" # 2022-08-07
   # VERSION = "3.0.0" # 2022-07-27
   # VERSION = "0.2.4" # 2021-06-21
   # VERSION = "0.2.3" # 2020-07-14

data/lib/act_with_flags.rb

@@ -9,30 +9,36 @@
 #  TDD considered harmful
 #  TGCB
 
-class << ActiveRecord::Base
-  attr_reader :act_with_flags
+module ActWithFlags
+  module Base
+    attr_reader :act_with_flags
 
-  def add_to_flags(*flags, origin: :flags, **hash)
-    unless @act_with_flags
-      @act_with_flags ||= ActWithFlags::Admin.new self
-      @act_with_flags.add_mask_et_all origin
-    end
+    def add_to_flags(*flags, origin: :flags, range: nil, **hash)
+      unless @act_with_flags
+        @act_with_flags ||= ActWithFlags::Admin.new self
+        @act_with_flags.add_mask_et_all origin
+      end
 
-    flags.each { |name| @act_with_flags.add_flag(name, origin, nil) }
-    hash.each { |name, pos| @act_with_flags.add_flag(name, origin, pos) }
+      flags.each { |name| @act_with_flags.add_flag(name, nil, origin, range) }
+      hash.each { |name, pos| @act_with_flags.add_flag(name, pos, origin, range) }
 
-    @act_with_flags
-  end
+      @act_with_flags
+    end
 
-  def remove_from_flags(*flags)
-    flags.each { |name| @act_with_flags.remove_accessor(name) }
-  end
+    def remove_from_flags(*flags)
+      flags.each { |name| @act_with_flags.remove_accessor(name) }
+    end
 
-  def clear_flags_at_save(*flags)
-    @act_with_flags.clear_at_save(*flags)
+    def clear_flags_at_save(*flags)
+      @act_with_flags.clear_at_save(*flags)
+    end
   end
 end
 
+class ActiveRecord::Base
+  extend ActWithFlags::Base
+end
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
 require "act_with_flags/version"
 require "act_with_flags/utils"

data/test/range_test.rb

@@ -0,0 +1,89 @@
+require "test_helper"
+
+describe "range" do
+  def setup
+    reset_order
+  end
+
+  it "runs without range" do
+    Order.add_to_flags :a
+    Order.add_to_flags :b
+  end
+
+  it "runs with range(inside)" do
+    Order.add_to_flags range: 2..4, a: 2
+    Order.add_to_flags range: 2..4, b: 3
+  end
+
+  it "fails with outside range" do
+    assert_raises(RangeError) { Order.add_to_flags range: 2..3, a: 1 }
+    assert_raises(RangeError) { Order.add_to_flags range: 2..3, b: 4 }
+  end
+
+  it "runs at borders" do
+    Order.add_to_flags range: 2..3, a: 2
+    Order.add_to_flags range: 2..3, b: 3
+  end
+
+  it "runs with ... as range" do
+    Order.add_to_flags range: 2...3, a: 2
+    assert_raises(RangeError) { Order.add_to_flags range: 2...3, b: 3 }
+  end
+
+  it "detects wrong range" do
+    assert_raises(RangeError) { Order.add_to_flags range: "a".."z", a: 2 }
+  end
+
+  it "tests range 0..0 no position" do
+    Order.add_to_flags :a, range: 0..0
+    assert_raises(RangeError) { Order.add_to_flags :b, range: 0..0 }
+  end
+
+  it "tests range ..0 no position" do
+    Order.add_to_flags :a, range: ..0
+    assert_raises(RangeError) { Order.add_to_flags :b, range: ..0 }
+  end
+
+  it "tests range ...0 no position" do
+    assert_raises(RangeError) { Order.add_to_flags :a, range: ...0 }
+  end
+
+  # YAGNI
+  # # includes range: ( .. 3 ) equivalent to range: ..3
+  # n = 100
+  # (0..n).each do |i|
+  #   rng = ..i
+  #
+  #   (0..i).each do |j|
+  #     it "tests range ..#{i} with position #{j}" do
+  #       Order.add_to_flags a: j, range: rng
+  #     end
+  #   end
+  #
+  #   it "fails range ..#{i} with position overflow" do
+  #     assert_raises(RangeError) { Order.add_to_flags b: (i + 1), range: rng }
+  #   end
+  # end
+  #
+  # it "runs ii plus" do
+  #   ii = 0
+  #   (0..2).each { |íí|
+  #     sym = "x#{ii}".to_sym
+  #     j = f(ii, ii + 1) # filler
+  #     rand j
+  #     Order.add_to_flags :range => ii..f(íí, íí), sym => (ii += 1)
+  #     orden = Order.new
+  #     refute orden.send("#{sym}?") # checks that accessor is active
+  #     orden.x0 = true # checks that first accessor is still there
+  #     assert orden.x0?
+  #   }
+  # end
+  #
+  # private
+  #
+  # def f(x, y)
+  #   return y + 1 if x == 0
+  #   return f(x - 1, 1) if y == 0
+  #   f(x - 1, f(x, y - 1))
+  # end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_with_flags
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +112,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- TODO
 - act_with_flags.gemspec
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
@@ -152,6 +151,7 @@ files:
 - test/one_test.rb
 - test/origin_test.rb
 - test/origins_test.rb
+- test/range_test.rb
 - test/remove_from_test.rb
 - test/string_test.rb
 - test/test_helper.rb

data/TODO

@@ -1,21 +0,0 @@
-# max_bits
-
-  add_to_flags(
-    ...
-    max_bits: 63
-  )
-
-Sinn und Zweck von :max_bits. Beispiel ein bigint Feld von PostgreSQL hat
-64 Bits. Das Bit 2**63 ist allerdings nur bei negativen Zahlen gesetzt.
-Damit stehen für add_to_flags bei solch einem Feld nur 63 Bits also
-höchstens das Bit 2**62 zur Verfügung. Die Option max_bits: 62 würde sichern,
-dass kein höheres Bit verwendet wird. Falls doch würde bereits bei
-add_to_flags eine Exception bereits beim Start der Rails-Web-App  geworfen und
-nicht erst bei der Verwendung des Bits.
-
-## Solution
-
-Rails supports already "validate" which is, IMHO,
-the right way to limit values to be stored in the database.
-Furthermore, invalid values, stored by equivocation,
-are detected by "validate".