mimoco 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d005db7d29601313d32a107b3e0f4c5c2a97cf57458208c48f3647b8504310f
-  data.tar.gz: 6e2eadc55c6d207ca53b5dfc1208093ca5099c731fcf8ccbaca700a6d4736cac
+  metadata.gz: 9410e1d42f9675bc7e26b423c3a74796d70834af501e169df0016a6ad3cdd427
+  data.tar.gz: 50ec876f43843b9846bed7f5491976ba685b758e56a2bfd753472d05cacae20b
 SHA512:
-  metadata.gz: eb42f23837494c9c0811b94d95304d01364394d396de5e58338b5aa1025fdfbacb8bdddfc71398612e641ebc2f5d41bded49ac578cff36eb7afecf26476932b1
-  data.tar.gz: 41eb22c914323da8eb91b72111c0bccad4a8c7f1f86ce1ba399c8ddf3656e8219631a25a34e19788fb12973265cfd352496366b44d631c4b74f3cc85f668a556
+  metadata.gz: efa7bd3f3089f895727970c11dfaf55a3f121755feed3bf0fe9b9fd44461e56b5957fe0787c94100231c4083df6c393d2f2d1c7bdd0a80f567e8b79234875bb6
+  data.tar.gz: 2eaf0e98b508eb891e55f90c0ceacc2be5de45c2b3c3313b8ec87596ffde5f7aabee8e5dfb7724d494cb0cea1d015315a3636f5be37217ded98592a43c36c97b

data/.gitignore

@@ -6,4 +6,4 @@ coverage/
 *.log
 *.lock
 
-**/db/*.sqlite3
+**/db/test.sqlite3*

data/README.md

@@ -73,9 +73,21 @@ class ControllersTest < ActionDispatch::IntegrationTest
 end
 ```
 
+## Parameter
+
+Rails magic adds a few additional methods to a model or a controller
+(e.g. #column_headers).
+
+MiMoCo ignores them, but future versions of Rails may add more.
+They can be ignored by:
+
+```ruby
+check_models models, ignore_methods: magic_method
+...
+check_controllers controllers, ignore_methods: %i[magic2 magic3]
+```
+
 ## Miscellaneous
 
 Copyright (c) 2022-2023 Dittmar Krall (www.matiq.com),
-released under the MIT license:
-
-* https://opensource.org/licenses/MIT
+released under the [MIT license](https://opensource.org/licenses/MIT).

data/lib/mimoco/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Mimoco
-  VERSION = "0.3.2" # 2023-04-25
+  VERSION = "1.0.0" # 2023-12-06
+  # VERSION = "0.3.2" # 2023-04-25
   # VERSION = "0.3.1" # 2022-12-25
   # VERSION = "0.3.0" # 2022-02-11
   # VERSION = "0.2.0" # 2022-01-06

data/lib/mimoco.rb

@@ -1,140 +1,20 @@
 require "minitest"
+require "mimoco_base"
+require "mimoco_valid"
+require "mimoco_models"
+require "mimoco_controllers"
 
 module Minitest
   module Checks
-    def check_models(data)
-      Models.run data, self
+    def check_models(data, ignore_methods: nil)
+      Models.run data, self, ignore_methods
     end
 
-    def check_controllers(data)
-      Controllers.run data, self
+    def check_controllers(data, ignore_methods: nil)
+      Controllers.run data, self, ignore_methods
     end
 
     class ValidMissingError < StandardError; end
-
-    class Base
-      attr_accessor :minitest, :klass, :klass_hash, :where
-
-      def self.run(data, minitest)
-        @minitest = minitest
-        data.each do |klass, hash|
-          @klass = klass
-          @klass_hash = hash
-          hash.each do |function, value|
-            @where = "#{klass}##{function}"
-            send(function, value)
-          end
-        end
-      end
-
-      def self.check_equal(expected, actual, msg = nil)
-        expected = expected.sort.map(&:to_sym)
-        actual = actual.sort.map(&:to_sym)
-        msg = msg ? "#{@where}: #{msg}" : @where
-        @minitest.assert_equal expected, actual, msg
-      end
-
-      def self.check_no_nil(actual, msg = nil)
-        msg = msg ? "#{@where}: #{msg}" : @where
-        @minitest.refute_nil actual, msg
-      end
-    end
-
-    class Models < Base
-      def self.valid(params)
-        valids([params])
-      end
-
-      def self.valids(arr)
-        arr.each { |params| one_valid(params) }
-      end
-
-      def self.invalid(params)
-        invalids([params])
-      end
-
-      def self.invalids(arr)
-        arr.each { |params| one_invalid(params) }
-      end
-
-      def self.class_methods(expected)
-        cls = @klass.methods(false).sort
-        cls.delete_if { |x| /^_/ =~ x }
-        cls.delete_if { |x| /^(after|before|find_by)_/ =~ x }
-        cls -= %i[column_headers attribute_type_decorations
-          attributes_to_define_after_schema_loads
-          default_scope_override defined_enums]
-        check_equal expected, cls
-      end
-
-      # call class methods; don't check result
-      def self.call_class_methods(methods)
-        methods.each { |meth|
-          check_no_nil @klass.send(meth), "<#{meth}> should return no nil"
-        }
-      end
-
-      def self.public_methods(expected)
-        cls = @klass.public_instance_methods(false).sort
-        cls.delete_if { |x| /.*_associated_records_.*/ =~ x }
-        #  validate_associated_records_for_projects]
-        check_equal expected, cls
-      end
-
-      # call_public_methods; don't check result
-      def self.call_public_methods(methods)
-        klass_params = @klass_hash[:valid] || @klass_hash[:valids]&.first
-        raise ValidMissingError unless klass_params
-
-        methods.each { |meth|
-          row, _msg = @klass.create(klass_params)
-          check_no_nil row.send(meth), "<#{meth}> should return no nil"
-        }
-      end
-
-      def self.one_valid(params)
-        row, msg = create_model(params)
-        @minitest.assert row.valid?, "#{msg} #{row.errors.full_messages}"
-      end
-
-      def self.one_invalid(params)
-        row, msg = create_model(params)
-        @minitest.refute row.valid?, "#{msg} expected to be invalid"
-      end
-
-      def self.create_model(params)
-        row = @klass.create(params)
-        [row, "#{@klass}: #{params}"]
-      end
-    end
-
-    class Controllers < Base
-      def self.respond_to(methods)
-        instance = @klass.new
-        methods.each { |method|
-          msg = "#{@klass} should respond to #{method}"
-          @minitest.assert instance.respond_to?(method), msg
-        }
-      end
-
-      def self.class_methods(expected)
-        cls = @klass.methods(false).sort
-        cls.delete_if { |x| /^_/ =~ x }
-        cls -= %i[__callbacks helpers_path middleware_stack]
-        check_equal expected, cls
-      end
-
-      def self.call_class_methods(methods)
-        methods.each { |meth|
-          check_no_nil @klass.send(meth), "<#{meth}> should return no nil"
-        }
-      end
-
-      def self.public_methods(expected)
-        cls = @klass.new.public_methods(false).sort
-        check_equal expected, cls
-      end
-    end
   end
 
   class Test

data/lib/mimoco_base.rb

@@ -0,0 +1,48 @@
+require "minitest"
+
+module Minitest
+  module Checks
+    class Base
+      attr_accessor :minitest, :klass, :klass_hash, :where
+
+      def self.run(data, minitest, ignore_methods)
+        @minitest = minitest
+        @ignore = [ignore_methods].flatten
+        data.each do |klass, hash|
+          @klass = klass
+          @klass_hash = hash
+          hash.each do |function, value|
+            @where = "#{klass}##{function}"
+            send(function, value)
+          end
+        end
+      end
+
+      def self.check_equal(expected, actual, msg = nil)
+        expected = expected.sort.map(&:to_sym)
+        actual = actual.sort.map(&:to_sym)
+        msg = msg ? "#{@where}: #{msg}" : @where
+        @minitest.assert_equal expected, actual, msg
+      end
+
+      def self.check_no_nil(actual, msg = nil)
+        msg = msg ? "#{@where}: #{msg}" : @where
+        @minitest.refute_nil actual, msg
+      end
+
+      def self.delete_methods(which)
+        ignore2 = %i[attribute_aliases
+          attributes_to_define_after_schema_loads column_headers
+          default_scope_override]
+        # cls -= %i[__callbacks helpers_path middleware_stack]
+        # cls -= %i[attribute_type_decorations defined_enums]
+        methods = @klass.send(which, false).sort
+        methods.delete_if { |x| /^_/ =~ x }
+        methods.delete_if { |x| /^(after|before|find_by)_/ =~ x }
+        methods.delete_if { |x| /.*_associated_records_.*/ =~ x }
+        methods2 = @klass.superclass.send(which, false).sort
+        methods - methods2 - @ignore - ignore2
+      end
+    end
+  end
+end

data/lib/mimoco_controllers.rb

@@ -0,0 +1,31 @@
+require "minitest"
+
+module Minitest
+  module Checks
+    class Controllers < Base
+      def self.respond_to(methods)
+        instance = @klass.new
+        methods.each { |method|
+          msg = "#{@klass} should respond to #{method}"
+          @minitest.assert instance.respond_to?(method), msg
+        }
+      end
+
+      def self.class_methods(expected)
+        meths = delete_methods(:methods)
+        check_equal expected, meths
+      end
+
+      def self.call_class_methods(methods)
+        methods.each { |meth|
+          check_no_nil @klass.send(meth), "<#{meth}> should return no nil"
+        }
+      end
+
+      def self.public_methods(expected)
+        cls = @klass.new.public_methods(false).sort
+        check_equal expected, cls
+      end
+    end
+  end
+end

data/lib/mimoco_models.rb

@@ -0,0 +1,35 @@
+require "minitest"
+
+module Minitest
+  module Checks
+    class Models < Base
+      def self.class_methods(expected)
+        meths = delete_methods(:methods)
+        check_equal expected, meths
+      end
+
+      # call class methods; don't check result
+      def self.call_class_methods(methods)
+        methods.each { |meth|
+          check_no_nil @klass.send(meth), "<#{meth}> should return no nil"
+        }
+      end
+
+      def self.public_methods(expected)
+        meths = delete_methods(:public_instance_methods)
+        check_equal expected, meths
+      end
+
+      # call_public_methods; don't check result
+      def self.call_public_methods(methods)
+        klass_params = @klass_hash[:valid] || @klass_hash[:valids]&.first
+        raise ValidMissingError unless klass_params
+
+        methods.each { |meth|
+          row, _msg = @klass.create(klass_params)
+          check_no_nil row.send(meth), "<#{meth}> should return no nil"
+        }
+      end
+    end
+  end
+end

data/lib/mimoco_valid.rb

@@ -0,0 +1,38 @@
+require "minitest"
+
+module Minitest
+  module Checks
+    class Models < Base
+      def self.valid(params)
+        valids([params])
+      end
+
+      def self.valids(arr)
+        arr.each { |params| one_valid(params) }
+      end
+
+      def self.invalid(params)
+        invalids([params])
+      end
+
+      def self.invalids(arr)
+        arr.each { |params| one_invalid(params) }
+      end
+
+      def self.one_valid(params)
+        row, msg = create_model(params)
+        @minitest.assert row.valid?, "#{msg} #{row.errors.full_messages}"
+      end
+
+      def self.one_invalid(params)
+        row, msg = create_model(params)
+        @minitest.refute row.valid?, "#{msg} expected to be invalid"
+      end
+
+      def self.create_model(params)
+        row = @klass.create(params)
+        [row, "#{@klass}: #{params}"]
+      end
+    end
+  end
+end

data/mimoco.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = "Some testing for models and controllers"
   s.authors = ["Dittmar Krall"]
   s.email = ["dittmar.krall@matiq.com"]
-  s.homepage = "http://matiq.com"
+  s.homepage = "https://github.com/matique/mimoco"
   s.license = "MIT"
 
   s.metadata["source_code_uri"] = "https://github.com/matique/mimoco"

data/test/models/models_ignore_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+require "mimoco"
+
+class ModelsIgnoreTest < Minitest::Test
+  def test_no_ignore_class_methods
+    models = {Order => {class_methods: %i[class_method]}}
+    check_models models
+  end
+
+  def test_ignore_class_methods
+    models = {Order => {class_methods: %i[]}}
+    check_models models, ignore_methods: :class_method
+  end
+
+  def test_no_ignore_public_methods
+    models = {Order => {public_methods: %i[public_method]}}
+    check_models models
+  end
+
+  def test_ignore_public_methods
+    models = {Order => {public_methods: %i[]}}
+    check_models models, ignore_methods: :public_method
+  end
+
+  def test_controllers_no_ignore_class_methods
+    controllers = {OrdersController => {class_methods: %i[class_method]}}
+    check_controllers controllers
+  end
+
+  def test_controllers_ignore_class_methods
+    controllers = {OrdersController => {class_methods: %i[]}}
+    check_controllers controllers, ignore_methods: :class_method
+  end
+end

data/test/models/models_test.rb

@@ -2,40 +2,6 @@ require "test_helper"
 require "mimoco"
 
 class ModelsTest < Minitest::Test
-  def test_valid
-    models = {Order => {valid: {name: "Name", qty: 123}}}
-    check_models models
-  end
-
-  def test_valids
-    models = {
-      Order => {
-        valids: [
-          {name: "Name", qty: 123},
-          {qty: 123}
-        ]
-      }
-    }
-    check_models models
-  end
-
-  def test_invalid
-    models = {Order => {invalid: {qty: :abc}}}
-    check_models models
-  end
-
-  def test_invalids
-    models = {
-      Order => {
-        invalids: [
-          {qty: :abc},
-          {name: "Name", qty: :def}
-        ]
-      }
-    }
-    check_models models
-  end
-
   def test_class_methods
     models = {Order => {class_methods: %i[class_method]}}
     check_models models

data/test/models/models_valid_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+require "mimoco"
+
+class ModelsTest < Minitest::Test
+  def test_valid
+    models = {Order => {valid: {name: "Name", qty: 123}}}
+    check_models models
+  end
+
+  def test_valids
+    models = {
+      Order => {
+        valids: [
+          {name: "Name", qty: 123},
+          {qty: 123}
+        ]
+      }
+    }
+    check_models models
+  end
+
+  def test_invalid
+    models = {Order => {invalid: {qty: :abc}}}
+    check_models models
+  end
+
+  def test_invalids
+    models = {
+      Order => {
+        invalids: [
+          {qty: :abc},
+          {name: "Name", qty: :def}
+        ]
+      }
+    }
+    check_models models
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mimoco
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combustion
@@ -69,6 +69,10 @@ files:
 - Rakefile
 - lib/mimoco.rb
 - lib/mimoco/version.rb
+- lib/mimoco_base.rb
+- lib/mimoco_controllers.rb
+- lib/mimoco_models.rb
+- lib/mimoco_valid.rb
 - mimoco.gemspec
 - test/controllers/controllers_test.rb
 - test/controllers/orders_controller_test.rb
@@ -89,9 +93,11 @@ files:
 - test/internal/config/routes.rb
 - test/internal/db/migrate/20141016161801_create_orders.rb
 - test/internal/db/schema.rb
+- test/models/models_ignore_test.rb
 - test/models/models_test.rb
+- test/models/models_valid_test.rb
 - test/test_helper.rb
-homepage: http://matiq.com
+homepage: https://github.com/matique/mimoco
 licenses:
 - MIT
 metadata:
@@ -111,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: 'Mimoco: some minitests for models and controllers'