act_with_flags 0.2.4 → 3.1.1

data/test/origins_test.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+
+describe "Several origins" do
+  let(:order) { Order.create }
+
+  def setup
+    reset_order
+    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
+  end
+
+  it "checks flags" do
+    order.a = true
+    order.b = true
+    order.b2 = true
+    assert_equal 0x8000000000000003, order.flags
+    order.b2 = false
+    assert_equal 0x03, order.flags
+    assert_equal 0x01, Order.act_with_flags.mask(:a) # should work
+    assert_equal 0x8000000000000002, Order.act_with_flags.mask(:b, :b2) # should work
+  end
+
+  it "checks origin1" do
+    order.c = true
+    assert_equal 0x01, order.origin1
+    assert_equal 0x01, Order.act_with_flags.mask(:c)
+  end
+
+  it "checks origin2" do
+    order.d = true
+    assert_equal 0x08, order.origin2
+    assert_equal 0x18, Order.act_with_flags.mask(:d2, :d)
+  end
+
+  it "should reject mask for different origins" do
+    assert_raises(RuntimeError) {
+      Order.act_with_flags.mask :c, :d
+    }
+  end
+
+  it "allows any? et all for same origins" do
+    order.flags_any? :b, :b2
+    order.flags_all? :d2, :d
+  end
+
+  it "rejects any? et all for different origins" do
+    assert_raises(RuntimeError) {
+      order.flags_any? :a, :c
+    }
+    assert_raises(RuntimeError) {
+      order.flags_all? :d2, :c
+    }
+  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

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

data/test/remove_from_test.rb

@@ -1,6 +1,6 @@
-require 'test_helper'
+require "test_helper"
 
-describe 'Delete from Flags' do
+describe "Delete from Flags" do
   let(:order) { Order.create }
 
   def setup
@@ -9,10 +9,9 @@ describe 'Delete from Flags' do
     order.a = order.b = order.c = true
   end
 
-  it 'remove accessors' do
+  it "remove accessors" do
     Order.remove_from_flags :b
     assert_raises { order.b }
     refute Order.respond_to?(:b)
   end
-
 end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
-if ENV['COVERAGE']
-  require 'simplecov'
+if ENV["COVERAGE"]
+  require "simplecov"
   SimpleCov.start do
-    add_filter '/test/'
+    add_filter "/test/"
   end
 end
 
@@ -9,11 +9,11 @@ require "combustion"
 Combustion.path = "test/internal"
 Combustion.initialize! :active_record
 
-require 'rails/test_help'
-require 'minitest/autorun'
-require 'minitest/benchmark'
-#require 'capybara/rails'
+require "rails/test_help"
+require "minitest/autorun"
+require "minitest/benchmark"
+# require 'capybara/rails'
 
 def reset_order
-  Order.act_with_flags.reset  if Order.act_with_flags
+  Order.act_with_flags&.reset
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_with_flags
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 3.1.1
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,16 +94,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Handles flags in a Rails model instance
+description: Handles flags/booleans in a Rails model instance
 email:
-- dittmar.krall@matique.de
+- dittmar.krall@matiq.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
 - ".gitignore"
-- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".watchr"
@@ -116,14 +115,24 @@ files:
 - act_with_flags.gemspec
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/act_with_flags.rb
 - lib/act_with_flags/admin.rb
+- lib/act_with_flags/clear.rb
 - lib/act_with_flags/define.rb
+- lib/act_with_flags/flags.rb
 - lib/act_with_flags/print.rb
 - lib/act_with_flags/utils.rb
 - lib/act_with_flags/version.rb
 - test/any_all_none_test.rb
+- test/benchmark_test.rb
 - test/clear_test.rb
+- test/coding_check_add_test.rb
+- test/coding_coverage_test.rb
+- test/coding_mask2d_test.rb
+- test/coding_null_test.rb
+- test/coding_one_test.rb
+- test/coding_reset_test.rb
 - test/inheritance_any_test.rb
 - test/inheritance_test.rb
 - test/internal/app/assets/config/manifest.js
@@ -136,23 +145,23 @@ files:
 - test/internal/config/routes.rb
 - test/internal/config/secrets.yml
 - test/internal/db/schema.rb
-- test/internal_benchmark_test.rb
-- test/internal_check_add_test.rb
-- test/internal_null_test.rb
-- test/internal_one_test.rb
 - test/legacy_test.rb
 - test/mask_test.rb
 - test/null_test.rb
 - 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/reset_test.rb
 - test/string_test.rb
 - test/test_helper.rb
-homepage: http://matique.de
+homepage: http://matiq.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/matique/act_with_flags
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -168,35 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: act_with_flags gem
-test_files:
-- test/any_all_none_test.rb
-- test/clear_test.rb
-- test/inheritance_any_test.rb
-- test/inheritance_test.rb
-- test/internal/app/assets/config/manifest.js
-- test/internal/app/controllers/application_controller.rb
-- test/internal/app/controllers/orders_controller.rb
-- test/internal/app/models/application_record.rb
-- test/internal/app/models/order.rb
-- test/internal/app/views/layouts/application.html.erb
-- test/internal/config/database.yml
-- test/internal/config/routes.rb
-- test/internal/config/secrets.yml
-- test/internal/db/schema.rb
-- test/internal_benchmark_test.rb
-- test/internal_check_add_test.rb
-- test/internal_null_test.rb
-- test/internal_one_test.rb
-- test/legacy_test.rb
-- test/mask_test.rb
-- test/null_test.rb
-- test/one_test.rb
-- test/origin_test.rb
-- test/remove_from_test.rb
-- test/reset_test.rb
-- test/string_test.rb
-- test/test_helper.rb
+test_files: []

data/.rubocop.yml

@@ -1,9 +0,0 @@
-inherit_from:
-  - ~/configs/.rubocop.yml
-
-AllCops:
-  NewCops: enable
-  Include:
-    - 'lib/**/*.rb'
-  Exclude:
-    - 'test/**/*'

data/test/internal_benchmark_test.rb

@@ -1,52 +0,0 @@
-# For development purposes; do not waste your tine reading it!
-# YAGNI
-# rubocop:disable all
-
-require 'test_helper'
-require 'benchmark'
-require 'benchmark/ips'
-# ENV['MORE'] = 'true'
-
-describe 'Internal timings' do
-  let(:order) { Order.create }
-
-  def setup
-    reset_order
-    Order.add_to_flags :blocked
-  end
-
-  it 'times ips' do
-    return  unless ENV['MORE']
-
-    Benchmark.ips do |x|
-      x.report('assign true : ')        { order.blocked = true }
-      x.report('assign false: ')        { order.blocked = false }
-      x.report('assign "false": ')      { order.blocked = 'false' }
-      x.report('x = order.blocked? ')   { x = order.blocked? }
-      x.report('x = order.blocked ')    { x = order.blocked }
-
-      x.compare!
-    end
-  end
-
-end
-
-class BenchFoo < Minitest::Benchmark
-
-  def bench_order_blocked
-    return  unless ENV['MORE']
-
-    n = 1_000_000
-    n = 100_000
-    n = 10_000
-    Order.add_to_flags :blocked2
-    order = Order.create
-    assert_performance_constant do |input|
-      n.times do
-        order.blocked2 = true
-        order.blocked2 = !order.blocked2
-      end
-    end
-  end
-
-end

data/test/internal_check_add_test.rb

@@ -1,36 +0,0 @@
-require 'test_helper'
-
-describe 'Internal check add flag' do
-  let(:admin) { Order.act_with_flags }
-
-  def setup
-    reset_order
-    Order.add_to_flags a: 1, b: 7, c: 3
-  end
-
-  it 'skip reserved position' do
-    Order.add_to_flags :xx
-    assert_equal 0, admin.position(:xx)
-    Order.add_to_flags :yy
-    assert_equal 2, admin.position(:yy)
-  end
-
-  it 'rejects redefinition' do
-    Order.add_to_flags :z
-    assert_raises { Order.add_to_flags :z }
-  end
-
-  it 'rejects reuse of position' do
-    assert_raises { Order.add_to_flags qq: 1 }
-  end
-
-  it 'coverage to_s' do
-    res = admin.to_s
-    puts res  if ENV['MORE']
-  end
-
-  it 'coverage position raise' do
-    assert_raises { admin.position(:aaaa) }
-  end
-
-end

data/test/internal_null_test.rb

@@ -1,29 +0,0 @@
-require 'test_helper'
-
-describe 'Internal Null' do
-  let(:admin) { Order.act_with_flags }
-
-  def setup
-    reset_order
-    Order.add_to_flags
-  end
-
-  it 'respond to act_with_flags' do
-    assert Order.respond_to?(:act_with_flags)
-    refute_nil Order.act_with_flags
-  end
-
-  it 'tests to_boolean' do
-    assert admin.to_boolean(true)
-    refute admin.to_boolean(false)
-    assert_raises { admin.to_boolean(nil) }
-    assert_raises { admin.to_boolean(2) }
-    assert_raises { admin.to_boolean('unknown') }
-  end
-
-  it 'tests a simple administration: names' do
-    refute_nil admin.names
-    assert_equal [], admin.names
-  end
-
-end

data/test/internal_one_test.rb

@@ -1,27 +0,0 @@
-# rubocop: disable all
-
-require 'test_helper'
-
-describe 'Internal One Flag' do
-  let(:flag)  { :blocked }
-  let(:admin) { Order.act_with_flags }
-  let(:order) { Order.new }
-
-  def setup
-    reset_order
-    Order.add_to_flags flag
-  end
-
-  it 'test Order.act_with_flags' do
-    refute_nil admin
-    assert_equal admin, order.class.act_with_flags
-  end
-
-  it 'checks definition of methods for flag' do
-    msg = "method '#{flag}' not defined'
-    assert order.respond_to?("#{flag}"), msg
-    assert order.respond_to?("#{flag}?"), msg
-    assert order.respond_to?("#{flag}="), msg
-  end
-
-end

data/test/reset_test.rb

@@ -1,17 +0,0 @@
-require 'test_helper'
-
-describe 'Testing reset' do
-  let(:order) { Order.new }
-
-  def setup
-    reset_order
-    Order.add_to_flags :a
-  end
-
-  it 'reset hard' do
-    refute_equal [], Order.add_to_flags.names
-    Order.act_with_flags&.reset
-    assert_equal [], Order.add_to_flags.names
-  end
-
-end