act_with_flags 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e2b18cdaf7777bddb191c830bc942a6fd7c377a4267c8e7beae3b2ace3552e9
-  data.tar.gz: 1aed1f1e86fdbdd1cff793c0296c1b6e23c7400dc43f7df17ad8e13c3b1998d0
+  metadata.gz: c995a59c8536ec6e012c9bf671e087b9f333c7a327512a42e1ffe725f0a12a0f
+  data.tar.gz: 63e16f84e582fd6427846d9391e3f02b3a528cda8cbdf16670c368c719af399e
 SHA512:
-  metadata.gz: 11154bcaf21ff519f34863fdb847ffefd1e9a2fb493cfcdd8d0e015de42b601a9b3bf20d9e914d0e8681f39e321194ba3a27048a74fb43ce3972b9844cf0f14c
-  data.tar.gz: 4471f2dc9a7b48654fa9ea689e4f51e660f6eacb0012fc1ea75c43fd2cb9c91149c49243e24a78e4527407d4c75dd51e7b0066095efebb14f007eb3dda36a839
+  metadata.gz: e82dc33cbc493c8b849a3053c5d28e2d73522a9308bbb7d59fa698dfa8a58c7380b9c58df082aa3190010f112c32b51583356373a935064a6f8222cb449283d7
+  data.tar.gz: 2fe6db8a4d0177db3d679e57b3851d79559ddbbe741352b0144cd0a6bcaba717584241bccae242e862c60bf0109c32252ca8472acdab1591ca61b3aa579ee31e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    act_with_flags (3.1.0)
+    act_with_flags (3.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -157,7 +157,7 @@ GEM
     regexp_parser (2.5.0)
     rexml (3.2.5)
     ricecream (0.2.1)
-    rubocop (1.35.0)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -180,8 +180,8 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     sqlite3 (1.4.4)
-    standard (1.16.0)
-      rubocop (= 1.35.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
     standardrb (1.0.1)
       standard

data/README.md

@@ -23,9 +23,50 @@ $ gem install act_with_flags
 ```
 
 
-## Version 3.1.x
+## Version 3.1.1
 
-Added option "range" limiting the position of booleans.
+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

data/lib/act_with_flags/admin.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 class ActWithFlags::Admin
-  attr_reader :model
+  attr_reader :model, :ranges
 
   def initialize(model)
     @locations = {}
     @clears = {}
+    @ranges = {}
     @model = model
     @boolean_hash = {}
     [true, "true", 1, "1"].each { |x| @boolean_hash[x] = true }

data/lib/act_with_flags/print.rb

@@ -5,7 +5,6 @@ class ActWithFlags::Admin
     res = []
     res << title("Variables")
     res << variables(:boolean_hash)
-    res << variables(:delete_mask)
 
     res << blk("Flags sorted alfabetically") { |key, loc|
       "#{key} #{loc}"
@@ -17,6 +16,8 @@ class ActWithFlags::Admin
       "FLAG_#{key.upcase} = #{sprintf("0x%08X", mask(key))}"
     }
 
+    res << title("@ranges")
+    res << @ranges
     res << title("@locations")
     res << @locations
     res.flatten.join("\n")

data/lib/act_with_flags/utils.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 class ActWithFlags::Admin
-  def add_flag(name, pos, origin, range)
+  def add_flag(name, pos, origin)
+    range = ranges[origin]
     accessor = name.to_sym
     validate_accessor accessor, "#{accessor}?", "#{accessor}="
 
     pos = check_pos(model, origin, pos)
+    msg = "Invalid position <#{pos}>"
+    raise(ArgumentError, msg) unless pos.is_a?(Integer)
+    raise(ArgumentError, msg) unless pos >= 0
     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
+    validate_position(range, pos)
 
     mask = mask(accessor)
     add_accessors(accessor, origin, mask)
@@ -50,6 +50,14 @@ class ActWithFlags::Admin
     reset_model model
   end
 
+  def validate_position(range, position)
+    return if range.nil?
+    return if range.cover?(position)
+
+    msg = "Position #{position} out of range #{range}"
+    raise RangeError, msg
+  end
+
   private
 
   def validate_accessor(*names)

data/lib/act_with_flags/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module ActWithFlags
-  VERSION = "3.1.0" # 2022-08-29
+  VERSION = "3.1.1" # 2022-09-01
+  # 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

data/lib/act_with_flags.rb

@@ -14,13 +14,11 @@ module ActWithFlags
     attr_reader :act_with_flags
 
     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
+      origin = origin.to_sym
+      init(origin, range)
 
-      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) }
+      flags.each { |name| @act_with_flags.add_flag(name, nil, origin) }
+      hash.each { |name, pos| @act_with_flags.add_flag(name, pos, origin) }
 
       @act_with_flags
     end
@@ -32,6 +30,45 @@ module ActWithFlags
     def clear_flags_at_save(*flags)
       @act_with_flags.clear_at_save(*flags)
     end
+
+    private
+
+    def init(origin, range)
+      unless @act_with_flags
+        @act_with_flags ||= ActWithFlags::Admin.new self
+        @act_with_flags.add_mask_et_all origin
+      end
+
+      unless range.nil?
+        validate_range_value range.begin
+        validate_range_value range.end
+      end
+
+      rng = @act_with_flags.ranges[origin]
+      unless range.nil? || (range == rng)
+        msg = "incompatible ranges #{range} - #{rng}"
+        raise ArgumentError, msg unless rng.nil?
+        @act_with_flags.ranges[origin] = range if range
+        validate_previous_positions(origin, range)
+      end
+    end
+
+    def validate_previous_positions(origin, range)
+      return if range.nil?
+
+      @act_with_flags.locations.each do |name, location|
+        next unless location.origin == origin
+
+        @act_with_flags.validate_position(range, location.position)
+      end
+    end
+
+    def validate_range_value(range_value)
+      return if range_value.nil?
+      return if range_value.is_a?(Integer) && range_value >= 0
+
+      raise RangeError, "Invalid range value #{range_value}"
+    end
   end
 end
 

data/test/range2_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+
+describe "range #2" do
+  def setup
+    reset_order
+  end
+
+  it "succeeds specifying just a range" do
+    Order.add_to_flags range: 0...0
+  end
+
+  it "succeeds specifying just a (same) range with an origin" do
+    Order.add_to_flags range: 0..0
+    Order.add_to_flags range: 0..0, origin: :dummy
+  end
+
+  it "rejects more than one range specification" do
+    Order.add_to_flags range: 0..0
+    assert_raises(ArgumentError) { Order.add_to_flags range: 1..1 }
+  end
+
+  it "succeeds validation (pre specification of range)" do
+    Order.add_to_flags range: ..0
+    Order.add_to_flags :a
+  end
+
+  it "succeeds validation (post specification of range)" do
+    Order.add_to_flags :a
+    Order.add_to_flags range: ..0
+  end
+
+  it "fails validation (pre specification of range)" do
+    Order.add_to_flags range: (1..)
+    assert_raises(RangeError) { Order.add_to_flags :a }
+  end
+
+  it "fails validation (post specification of range)" do
+    Order.add_to_flags :b, origin: :hugo
+    Order.add_to_flags :a
+    assert_raises(RangeError) { Order.add_to_flags range: 1.. }
+  end
+
+  it "succeeds validation for two flags (post specification of range)" do
+    Order.add_to_flags :a, :b # bits 0 & 1
+    Order.add_to_flags range: ..1
+  end
+
+  it "rejects validation for two flags (post specification of range)" do
+    Order.add_to_flags :a, :b # bits 0 & 1
+    # :a (bit 0) triggers an exception on the validation of range
+    assert_raises(RangeError) { Order.add_to_flags range: 1.. }
+  end
+
+  it "rejects post validation" do
+    Order.add_to_flags :a, :b # bits 0 & 1
+    # :b (bit 1) triggers an exception on the validation of range
+    assert_raises(RangeError) { Order.add_to_flags range: ..0 }
+  end
+end

data/test/range3_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+
+describe "range #3" do
+  def setup
+    reset_order
+  end
+
+  it "accepts an integer as position" do
+    Order.add_to_flags a: 0
+    Order.add_to_flags b: 1
+    Order.add_to_flags c: 2
+    Order.add_to_flags d: 100
+
+    msk = Order.add_to_flags.mask(:a, :b, :c)
+    assert 0x07, msk
+
+    msk = Order.add_to_flags.mask(:d)
+    assert 0x10000000000000000000000000, msk
+  end
+
+  it "rejects ivalid position" do
+    assert_raises(ArgumentError) { Order.add_to_flags a: -1 }
+    assert_raises(ArgumentError) { Order.add_to_flags a: :a_symbol }
+  end
+
+  [0..0, 0..1, ..0, 1.., 100..100, 0...1, ...1, 1..., ...100].each do |range|
+    it "checks valid range #{range}" do
+      Order.add_to_flags range: range
+    end
+  end
+
+  [-1..0, :a..:z, "a".."z"].each do |range|
+    it "rejects invalid range #{range}" do
+      assert_raises(RangeError) { Order.add_to_flags range: range }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_with_flags
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,8 @@ files:
 - test/one_test.rb
 - test/origin_test.rb
 - test/origins_test.rb
+- test/range2_test.rb
+- test/range3_test.rb
 - test/range_test.rb
 - test/remove_from_test.rb
 - test/string_test.rb