act_with_flags 0.0.4 → 0.2.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019-2020 Dittmar Krall - www.matique.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,8 @@
 # ActWithFlags
+[![Gem Version](https://badge.fury.io/rb/act_with_flags.png)](http://badge.fury.io/rb/act_with_flags)
+[![Build Status](https://travis-ci.org/matique/act_with_flags.png?branch=master)](https://travis-ci.org/matique/act_with_flags)
 
-
+Required by key.matique.
 
 ## Installation
 

data/Rakefile

@@ -1,23 +1,11 @@
-require "bundler/setup"
-
 require 'rake/testtask'
 
-desc 'Test the act_with_flags plugin.'
-Rake::TestTask.new(:test) do |t|
+desc 'Run the tests.'
+Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 
-task :default => :test
-
-
-=begin
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative 'config/application'
-
-Rails.application.load_tasks
-=end
+task default: :test

data/act_with_flags.gemspec

@@ -18,6 +18,11 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 1'
-  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'bundler', '~>1'
+  s.add_development_dependency 'rake', '~>13'
+  s.add_development_dependency 'appraisal', '~> 2'
+  s.add_development_dependency 'combustion', '~> 1'
+
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'sqlite3', '~> 1'
 end

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+group :test do
+  gem "observr"
+  gem "benchmark-ips"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+
+group :test do
+  gem "observr"
+  gem "benchmark-ips"
+end
+
+gemspec path: "../"

data/lib/act_with_flags/admin.rb

@@ -12,7 +12,7 @@ class ActWithFlags::Admin
     @origin = :flags
     @map = {}
     @delete_mask = 0
-    @max_position = 128 - 1
+    @max_position = 512 - 1
     @boolean_hash = {}
     [true,  'true',  1, '1'].each { |x| @boolean_hash[x] = true }
     [false, 'false', 0, '0'].each { |x| @boolean_hash[x] = false }
@@ -39,14 +39,16 @@ class ActWithFlags::Admin
   end
 
   def position(name)
-    @map[name]
-  end
+    pos = @map[name]
+    return pos  if pos
 
-  def mask(*names)
-    names.inject(0) { |msk, name| msk | ( 1 << position(name) ) }
+    parent = self.model.superclass.act_with_flags
+    return parent.position(name)  if parent
+
+    raise "unknown flag '#{model}##{name}'"
   end
 
-  def all?(*names)
+  def mask(*names)
     names.inject(0) { |msk, name| msk | ( 1 << position(name) ) }
   end
 

data/lib/act_with_flags/define.rb

@@ -4,24 +4,45 @@
 class ActWithFlags::Admin
 
   def add_accessors(origin, accessor, mask)
+#p ["act_with_flags#add_accessors:", model, origin, accessor, mask]
+    unless model.method_defined?(:act_with_flags)
+      model.class_eval %(
+        def act_with_flags
+          #{model}.act_with_flags
+        end
+      )
+    end
+
     model.class_eval %(
       def #{accessor}
         #{accessor}?
       end
 
       def #{accessor}?
-        !( self.#{origin} & #{mask} ).zero?
+        raise "Uninitialized '#{model}.#{origin}'"  if #{origin}.nil?
+        if #{origin}.is_a?(String)
+          flags = self.#{origin}.to_i
+          !( flags & #{mask} ).zero?
+        else
+          !( self.#{origin} & #{mask} ).zero?
+        end
       end
 
       def #{accessor}=(value)
-        self.#{origin} ||= 0
-        if self.class.act_with_flags.to_boolean(value)
-          self.#{origin} |= #{mask}
-          true
+        raise "Uninitialized '#{model}.#{origin}'"  if #{origin}.nil?
+        is_a_string = #{origin}.is_a?(String)
+        flags = is_a_string ? self.#{origin}.to_i : self.#{origin}
+        flags ||= 0
+
+        result = self.act_with_flags.to_boolean(value)
+        if result
+          flags |= #{mask}
         else
-          self.#{origin} &= ~#{mask}
-          false
+          flags &= ~#{mask}
         end
+        self.#{origin} = is_a_string ? flags.to_s : flags
+
+        result
       end
     )
   end

data/lib/act_with_flags/print.rb

@@ -6,7 +6,7 @@ class ActWithFlags::Admin
   def to_s
     res = []
     res << title('Variables')
-    res << variables(:origin, :max_position, :boolean_hash)
+    res << variables(:origin, :boolean_hash)
     res << variables(:delete_mask)
 
     res << title('Flags sorted alfabetically')

data/lib/act_with_flags/utils.rb

@@ -1,5 +1,4 @@
-# xrubocop:disable all
-# xfrozen_string_literal: true
+# rubocop: disable all
 
 class ActWithFlags::Admin
 
@@ -46,7 +45,7 @@ class ActWithFlags::Admin
     names.each { |name|
       remove_accessor name
     }
-    self.reset_model model
+    reset_model model
   end
 
 end

data/lib/act_with_flags/version.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
+# rubocop: disable all
 
 module ActWithFlags
-  VERSION = '0.0.4'     # 2019-03-03
-#  VERSION = '0.0.3'     # 2019-03-01
-#  VERSION = '0.0.2'     # 2019-02-28
-#  VERSION = '0.0.1'     # 2019-02-24
+  VERSION = '0.2.3'     # 2020-07-14
+# VERSION = '0.2.2'     # 2020-04-27
+# VERSION = '0.2.1'     # 2020-03-01
+# VERSION = '0.2.0'     # 2019-10-04
+# VERSION = '0.1.0'     # 2019-04-07
+# VERSION = '0.0.7'     # 2019-03-23
+# VERSION = '0.0.6'     # 2019-03-08
+# VERSION = '0.0.5'     # 2019-03-05
+# VERSION = '0.0.4'     # 2019-03-03
+# VERSION = '0.0.3'     # 2019-03-01
+# VERSION = '0.0.2'     # 2019-02-28
+# VERSION = '0.0.1'     # 2019-02-24
 end

data/test/any_all_none_test.rb

@@ -1,7 +1,9 @@
+# rubocop: disable all
+
 require 'test_helper'
 
 describe 'any? all? and none?' do
-  let(:order) { Order.new }
+  let(:order) { Order.create }
 
   def setup
     reset_order
@@ -30,7 +32,7 @@ describe 'any? all? and none?' do
   end
 
   it 'checks none? #2' do
-    order.a = order.b =  true
+    order.a = order.b = true
     refute order.flags_none?(:a, :b)
     order.a = false
     refute order.flags_none?(:a, :b)

data/test/clear_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 describe 'Clear Flags at Save' do
   let(:admin) { Order.act_with_flags }
-  let(:order) { Order.new }
+  let(:order) { Order.create }
 
   def setup
     reset_order

data/test/inheritance_any_test.rb

@@ -0,0 +1,56 @@
+# rubocop: disable all
+
+require 'test_helper'
+
+class A < Order
+  add_to_flags y: 2
+end
+
+describe 'inheritance' do
+  let(:a) { A.create }
+
+  def setup
+    reset_order
+    Order.add_to_flags x: 1
+  end
+
+  it 'consistency' do
+    assert a.respond_to?(:x)
+    assert a.respond_to?(:y)
+    assert_equal false, a.x
+    assert_equal false, a.y
+    a.y = true
+    assert_equal true, a.y
+  end
+
+  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)
+  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

@@ -0,0 +1,73 @@
+# rubocop: disable all
+
+require 'test_helper'
+
+class A < Order
+end
+
+class B < Order
+  add_to_flags y: 2
+end
+
+class C < Order
+  before_create { |row|  row.flags2 = 0 }
+
+  attr_accessor :flags2
+  add_to_flags z: 3, origin: :flags2
+end
+
+describe 'inheritance' do
+  let(:admina) { A.act_with_flags }
+  let(:adminb) { B.act_with_flags }
+
+  let(:a) { A.create }
+  let(:b) { B.create }
+  let(:c) { C.create }
+
+  def setup
+    reset_order
+    Order.add_to_flags x: 1
+  end
+
+  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
+    a.x = false
+    assert_equal false, a.x
+    a.x = true
+    assert_equal true, a.x
+    assert_equal 0x02, a.flags
+  end
+
+  it 'inheritance #3' do
+    assert b.respond_to?(:flags)
+    assert b.respond_to?(:x)
+    assert b.respond_to?(:y)
+    assert_equal 0, b.flags
+    assert_equal false, b.x
+    assert_equal false, b.y
+    b.x = true
+    assert_equal true, b.x
+    b.y = true
+    assert_equal true, b.y
+    assert_equal 0x06, b.flags
+  end
+
+  it 'inheritance #4' do
+    assert c.respond_to?(:x)
+    assert c.respond_to?(:z)
+    assert_equal false, c.z
+    c.x = true
+    assert_equal true, c.x
+    c.z = true
+    assert_equal true, c.z
+    assert_equal 0x02, c.flags
+    assert_equal 0x08, c.flags2
+  end
+
+end

data/test/internal/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link_tree ../images

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,16 @@
+class OrdersController < ApplicationController
+
+  def index
+    @orders = Order.all
+  end
+
+  def new
+    @order = Order.new
+  end
+
+  def show
+    Order.create :name => 'hugo'
+    @order = Order.find(params[:id])
+  end
+
+end

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

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

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

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

data/test/internal/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%#= stylesheet_link_tag    "application" %>
+  <%#= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>