act_with_flags 0.2.3 → 3.1.0

data/test/benchmark_test.rb

@@ -0,0 +1,73 @@
+# For development purposes; do not waste your tine reading it!
+# YAGNI
+
+require "test_helper"
+require "benchmark"
+require "benchmark/ips"
+# ENV["MORE"] = "true"
+
+describe "Internal timings flag" 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
+
+describe "Internal timings mask" do
+  let(:order) { Order.create }
+  let(:admin) { Order.act_with_flags }
+
+  def setup
+    reset_order
+    Order.add_to_flags a: 1, b: 7, c: 3
+    # Order.add_to_flags a: 1, b: 60, c: 3
+    # Order.add_to_flags a: 1, b: 1000, c: 3
+  end
+
+  it "times ips" do
+    return unless ENV["MORE"]
+
+    Benchmark.ips do |x|
+      x.report("mask(:a, :b):  ") { admin.mask(:a, :b) }
+      x.report("any?(:a, :b):  ") { order.flags_any?(:a, :b) }
+      x.report("all?(:a, :b):  ") { order.flags_all?(:a, :b) }
+      x.report("none?(:a, :b): ") { order.flags_none?(:a, :b) }
+
+      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/clear_test.rb

@@ -1,7 +1,6 @@
-require 'test_helper'
+require "test_helper"
 
-describe 'Clear Flags at Save' do
-  let(:admin) { Order.act_with_flags }
+describe "Clear flags at save" do
   let(:order) { Order.create }
 
   def setup
@@ -10,21 +9,20 @@ describe 'Clear Flags at Save' do
     order.a = order.b = order.c = true
   end
 
-  it 'checks sanity' do
+  it "checks sanity" do
     assert_equal 0x8a, order.flags
     assert order.b
   end
 
-  it 'clear flags during save' do
+  it "clear flags during save" do
     Order.clear_flags_at_save :b
     order.save
     order.reload
     assert_equal 0x0a, order.flags
   end
 
-  it 'does not remove accessor' do
+  it "does not remove accessor" do
     Order.clear_flags_at_save :b
     Order.respond_to? :b
   end
-
 end

data/test/coding_check_add_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+describe "Internal check add flag" do
+  let(:order) { Order.create }
+
+  def setup
+    reset_order
+    Order.add_to_flags a: 1, b: 7
+  end
+
+  it "skip reserved position" do
+    Order.add_to_flags :xx
+    order.xx = true
+    assert_equal 0x100, order.flags
+
+    Order.add_to_flags :yy
+    order.yy = true
+    assert_equal 0x300, order.flags
+  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
+end

data/test/coding_coverage_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+describe "Coverage" do
+  let(:order) { Order.create }
+
+  def setup
+    reset_order
+    Order.add_to_flags a: 1, b: 7
+  end
+
+  it "coverage to_s" do
+    res = order.act_with_flags.to_s
+    puts res if ENV["MORE"]
+  end
+
+  it "coverage location raise" do
+    assert_raises { order.act_with_flags.location(:unknown) }
+  end
+end

data/test/coding_mask2d_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+# There is an interference with Class B in another test: call it BB!
+class BB < Order
+  add_to_flags x: 1
+end
+
+describe "mask2d" do
+  let(:admin) { BB.act_with_flags }
+
+  def setup
+    reset_order
+    Order.add_to_flags y: 2
+  end
+
+  it "is a non splitted mask" do
+    mask = admin.mask2d(:x)
+    assert_equal 1, mask.length
+  end
+
+  it "is a splitted mask" do
+    mask = admin.mask2d(:x, :y)
+    assert_equal 2, mask.length
+  end
+end

data/test/coding_null_test.rb

@@ -0,0 +1,29 @@
+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)
+    assert admin.to_boolean("true")
+    assert admin.to_boolean(1)
+    assert admin.to_boolean("1")
+    refute admin.to_boolean(false)
+    refute admin.to_boolean("false")
+    refute admin.to_boolean(0)
+    refute admin.to_boolean("0")
+    assert_raises { admin.to_boolean(nil) }
+    assert_raises { admin.to_boolean(2) }
+    assert_raises { admin.to_boolean("unknown") }
+  end
+end

data/test/coding_one_test.rb

@@ -0,0 +1,26 @@
+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
+    assert_equal admin, order.act_with_flags
+    assert_equal admin, Order.act_with_flags
+  end
+
+  it "checks definition of methods for flag" do
+    msg = "method '#{flag}' not defined"
+    assert order.respond_to?(flag.to_s), msg
+    assert order.respond_to?("#{flag}?"), msg
+    assert order.respond_to?("#{flag}="), msg
+  end
+end

data/test/coding_reset_test.rb

@@ -0,0 +1,18 @@
+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
+    empty = {}
+    refute_equal empty, Order.add_to_flags.locations
+
+    Order.act_with_flags&.reset
+    assert_equal empty, Order.add_to_flags.locations
+  end
+end

data/test/inheritance_any_test.rb

@@ -1,20 +1,18 @@
-# rubocop: disable all
-
-require 'test_helper'
+require "test_helper"
 
 class A < Order
-  add_to_flags y: 2
+  add_to_flags x: 1, y: 2
 end
 
-describe 'inheritance' do
+describe "inheritance" do
   let(:a) { A.create }
 
   def setup
     reset_order
-    Order.add_to_flags x: 1
+    Order.add_to_flags z: 3
   end
 
-  it 'consistency' do
+  it "consistency" do
     assert a.respond_to?(:x)
     assert a.respond_to?(:y)
     assert_equal false, a.x
@@ -23,34 +21,12 @@ describe 'inheritance' do
     assert_equal true, a.y
   end
 
-  it 'checks any?' do
+  it "checks any?" do
     a.x = true
     assert a.flags_any?(:x, :y)
-    a.x = false
-    refute a.flags_any?(:x, :y)
-  end
 
-  it 'checks any? #2' do
-    a.y = true
-    assert a.flags_any?(:x, :y)
-    a.y = false
-    refute a.flags_any?(:x, :y)
+    assert_raises(RuntimeError) {
+      assert a.flags_any?(:x, :y, :z)
+    }
   end
-
-  it 'checks all?' do
-    a.x = a.y = true
-    assert a.flags_all?(:x, :y)
-    a.x = false
-    refute a.flags_all?(:x, :y)
-  end
-
-  it 'checks none? #2' do
-    a.x = a.y = true
-    refute a.flags_none?(:x, :y)
-    a.x = false
-    refute a.flags_none?(:x, :y)
-    a.y = false
-    assert a.flags_none?(:x, :y)
-  end
-
 end

data/test/inheritance_test.rb

@@ -1,6 +1,4 @@
-# rubocop: disable all
-
-require 'test_helper'
+require "test_helper"
 
 class A < Order
 end
@@ -10,13 +8,13 @@ class B < Order
 end
 
 class C < Order
-  before_create { |row|  row.flags2 = 0 }
+  before_create { |row| row.flags2 = 0 }
 
   attr_accessor :flags2
   add_to_flags z: 3, origin: :flags2
 end
 
-describe 'inheritance' do
+describe "inheritance" do
   let(:admina) { A.act_with_flags }
   let(:adminb) { B.act_with_flags }
 
@@ -29,14 +27,14 @@ describe 'inheritance' do
     Order.add_to_flags x: 1
   end
 
-  it 'inheritance #1' do
+  it "inheritance #1" do
     assert a.respond_to?(:flags)
     assert a.respond_to?(:x)
     assert_equal 0, a.flags
     assert_equal false, a.x
   end
 
-  it 'inheritance #2' do
+  it "inheritance #2" do
     a.x = false
     assert_equal false, a.x
     a.x = true
@@ -44,7 +42,7 @@ describe 'inheritance' do
     assert_equal 0x02, a.flags
   end
 
-  it 'inheritance #3' do
+  it "inheritance #3" do
     assert b.respond_to?(:flags)
     assert b.respond_to?(:x)
     assert b.respond_to?(:y)
@@ -58,7 +56,7 @@ describe 'inheritance' do
     assert_equal 0x06, b.flags
   end
 
-  it 'inheritance #4' do
+  it "inheritance #4" do
     assert c.respond_to?(:x)
     assert c.respond_to?(:z)
     assert_equal false, c.z
@@ -69,5 +67,4 @@ describe 'inheritance' do
     assert_equal 0x02, c.flags
     assert_equal 0x08, c.flags2
   end
-
 end

data/test/internal/app/controllers/orders_controller.rb

@@ -1,5 +1,4 @@
 class OrdersController < ApplicationController
-
   def index
     @orders = Order.all
   end
@@ -9,8 +8,7 @@ class OrdersController < ApplicationController
   end
 
   def show
-    Order.create :name => 'hugo'
+    Order.create name: "hugo"
     @order = Order.find(params[:id])
   end
-
 end

data/test/internal/app/models/order.rb

@@ -1,9 +1,5 @@
 class Order < ApplicationRecord
-
   before_save do |row|
-    row.flags ||= 0
-    row.bigflags ||= ''
-    row.errors.add :base, 'panic'  if row.name == 'error'
+    row.errors.add :base, "panic" if row.name == "error"
   end
-
 end

data/test/internal/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
   resources :orders
-  root :to => 'orders#index'
+  root to: "orders#index"
 end

data/test/internal/db/schema.rb

@@ -1,13 +1,12 @@
 ActiveRecord::Schema.define(version: 201910) do
-
   create_table "orders", force: true do |t|
-    t.string   "name"
-    t.string   "qty"
-    t.integer  "flags"
-    t.text     "bigflags"
-    t.integer  "category"
+    t.string "name"
+    t.string "qty"
+    t.integer "flags", default: 0
+    t.text "bigflags", default: "0"
+    t.integer "origin1", default: 0
+    t.integer "origin2", default: 0
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end
-
 end

data/test/legacy_test.rb

@@ -1,7 +1,6 @@
-# rubocop:disable all
-require 'test_helper'
+require "test_helper"
 
-describe 'Legacy Flag' do
+describe "Legacy Flag" do
   let(:order) { Order.create }
 
   def setup
@@ -9,23 +8,24 @@ describe 'Legacy Flag' do
     Order.add_to_flags a: 1, b: 7, c: 3
   end
 
-  it 'set true' do
+  it "set true" do
     test3 true, true, true
   end
 
-  it 'set false' do
+  it "set false" do
     test3 false, false, false
   end
 
-  it 'set mixture' do
+  it "set mixture" do
     test3 false, true, false
   end
 
-  it 'set mixture #2' do
+  it "set mixture #2" do
     test3 true, false, true
   end
 
- private
+  private
+
   def test3(a, b, c)
     order.a = a
     order.b = b
@@ -35,5 +35,4 @@ describe 'Legacy Flag' do
     assert_equal b, order.b
     assert_equal c, order.c
   end
-
 end

data/test/mask_test.rb

@@ -1,6 +1,6 @@
-require 'test_helper'
+require "test_helper"
 
-describe 'mask' do
+describe "mask" do
   let(:admin) { Order.act_with_flags }
 
   def setup
@@ -8,21 +8,20 @@ describe 'mask' do
     Order.add_to_flags a: 1, b: 7, c: 3
   end
 
-  it 'mask empty' do
+  it "mask empty" do
     assert_equal 0x00, admin.mask
   end
 
-  it 'mask of one flag' do
+  it "mask of one flag" do
     assert_equal 0x80, admin.mask(:b)
   end
 
-  it 'mask of several flags' do
+  it "mask of several flags" do
     assert_equal 0x8a, admin.mask(:a, :b, :c)
   end
 
-  it 'order is not relevant' do
+  it "order is not relevant" do
     mask = admin.mask(:a, :b, :c)
     assert_equal mask, admin.mask(:c, :b, :a)
   end
-
 end

data/test/null_test.rb

@@ -1,17 +1,15 @@
-require 'test_helper'
-
-describe 'No Flags' do
+require "test_helper"
 
+describe "No Flags" do
   def setup
     reset_order
     Order.add_to_flags
   end
 
-  it 'respond to ActWithFlags API' do
+  it "respond to ActWithFlags API" do
     assert Order.respond_to?(:add_to_flags)
     assert Order.respond_to?(:remove_from_flags)
     assert Order.respond_to?(:clear_flags_at_save)
     assert Order.respond_to?(:act_with_flags)
   end
-
 end

data/test/one_test.rb

@@ -1,8 +1,7 @@
-# rubocop:disable all
-require 'test_helper'
+require "test_helper"
 
-describe 'One Flag' do
-  let(:flag)  { :blocked }
+describe "One Flag" do
+  let(:flag) { :blocked }
   let(:order) { Order.create }
 
   def setup
@@ -10,24 +9,23 @@ describe 'One Flag' do
     Order.add_to_flags flag
   end
 
-  it 'set flag (:blocked)' do
+  it "set flag (:blocked)" do
     order.blocked = true
     assert_equal true, order.blocked
     assert_equal true, order.blocked?
 
-    order.blocked = 'false'
+    order.blocked = "false"
     assert_equal false, order.blocked
     assert_equal false, order.blocked?
   end
 
-  it 'rejects redefining' do
+  it "rejects redefining" do
     assert_raises { Order.add_to_flags :id }
     assert_raises { Order.add_to_flags flag }
   end
 
-  it 'rejects redefining #2' do
+  it "rejects redefining #2" do
     Order.add_to_flags :berta
     assert_raises { Order.add_to_flags :berta }
   end
-
 end

data/test/origin_test.rb

@@ -1,8 +1,6 @@
-# rubocop: disable all
+require "test_helper"
 
-require 'test_helper'
-
-describe 'Testing origin' do
+describe "Testing origin" do
   let(:admin) { Order.act_with_flags }
   let(:order) { Order.new }
 
@@ -10,30 +8,13 @@ describe 'Testing origin' do
     reset_order
   end
 
-  it 'origin category' do
-    Order.add_to_flags :x, origin: :category
-    assert_equal :category, admin.origin
-  end
-
-  it 'origin category #2' do
-    Order.add_to_flags :x, origin: :category
-    assert_raises { Order.add_to_flags origin: :category2 }
-  end
-
-  it 'origin category #3' do
-    Order.add_to_flags :x, origin: :category
-    Order.add_to_flags origin: :category
+  it "location origin1" do
+    Order.add_to_flags :x, origin: :origin1
+    assert_equal :origin1, admin.location(:x).origin
   end
 
-  it 'origin default' do
+  it "origin default" do
     Order.add_to_flags :x
-    assert_equal :flags, admin.origin
-  end
-
-  it 'origin 1' do
-    Order.add_to_flags origin: 1
-    assert_equal :flags, admin.origin
-    assert order.respond_to?(:origin)
+    assert_equal :flags, admin.location(:x).origin
   end
-
 end