Feature/gemika #71

fractaledmind · 2020-04-21T09:30:37Z

This is a quite the branch. It uses the gemika gem to setup running the test suite (which is already trying to be as thorough and expansive as reasonable for the business logic) against a matrix of rails versions, ruby versions, and database engines. Once I got the test suite set up, I started running different scenarios and trying to fix things. MySQL has been quite the pain in my ass, suffice it to say.

The core code for the business logic isn't pretty or finalized. I want to optimize for getting the matrix of tests passing with as little indirection as seems reasonable and then take a step back at that point to consider how best to slice up the objects and functions.

If you want to run tests for a particular scenario, you will need to know about a couple of things:

set the Ruby version you want for the scenario either via the .ruby-version file or using the RBENV_VERSION env variable
set the Rails version and database engine you want to use by specifying which Gemfile you want from the options in the /gemfiles directory
there are a number of options you can set for the test suite:
- LOGICALLY_EXHAUSTIVE_REQUEST_SPECS=true will run, well, the full logically exhaustive set of tests; whereas, by default, the test suite just runs a random sampling. This is needed if you want to rerun a particular test, as without this flag you will get a different random test at that location
- INSPECT_FAILURE=true will output the data in the instance variables used in the failed test

For example, this is how I have been testing Rails 4.2.x with Ruby 2.6.5 and MySQL:

RBENV_VERSION=2.6.5 BUNDLE_GEMFILE=gemfiles/Gemfile\[rails-4.2.x\]\[mysql2-0.4.x\] LOGICALLY_EXHAUSTIVE_REQUEST_SPECS=true INSPECT_FAILURE=true bundle exec rspec spec

… to your project root

# Conflicts: # Gemfile.lock # Rakefile

# Conflicts: # .ruby-version # .travis.yml # Gemfile.lock

…opriate scope

…ome other helper method somewhere

…te/time objects safely

…adapters

https://dev.mysql.com/doc/refman/8.0/en/problems-with-float.html

…nt Ruby versions

hound · 2020-04-21T09:30:52Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_with_nils_large_then_ascending_with_nils_large_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :large },
+                 { direction: :ascending, accessor: 'assoc.int', nils: :large })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:52Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_with_nils_small_then_ascending_with_nils_large_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :small },
+                 { direction: :ascending, accessor: 'assoc.int', nils: :large })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:52Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_with_nils_large_then_ascending_with_nils_small_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :large },
+                 { direction: :ascending, accessor: 'assoc.int', nils: :small })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:52Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_with_nils_small_then_ascending_with_nils_small_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :small },
+                 { direction: :ascending, accessor: 'assoc.int', nils: :small })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:52Z

sorter.rb

+    boolean_nil_tuple_array = boolean_array.product(nil_array)
+    nil_integer_tuple_array = nil_array.product(integer_array)
+
+    @array_of_tuples_to_array_of_objs_transformer = ->(array) { array.map { |bool, int| obj.new(bool, assoc.new(int)) } }


Metrics/LineLength: Line is too long. [121/120]

hound · 2020-04-21T09:30:54Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_descending_then_ascending_order
+    assert_equal(
+      Sorter.new({ direction: :descending, accessor: :bool },
+                 { direction: :ascending, accessor: 'assoc.int' })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:54Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_then_descending_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool },
+                 { direction: :descending, accessor: 'assoc.int' })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:54Z

sorter.rb

+  def test_sort_nested_object_bool_then_int_in_ascending_then_ascending_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool },
+                 { direction: :ascending, accessor: 'assoc.int' })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:30:55Z

sorter.rb

+    boolean_array = [true, false]
+    integer_array = (1..2).to_a
+
+    @array_of_tuples_to_array_of_objs_transformer = ->(array) { array.map { |bool, int| obj.new(bool, assoc.new(int)) } }


Metrics/LineLength: Line is too long. [121/120]

hound · 2020-04-21T09:30:55Z

sorter.rb

+  def test_sort_object_bool_then_int_in_ascending_with_nils_large_then_ascending_with_nils_large_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :large },
+                 { direction: :ascending, accessor: :int, nils: :large })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-04-21T09:43:25Z

spec/support/initializers/combustion.rb

+require 'gemika'
+require 'combustion'
+
+class Combustion::Database::Reset


IrresponsibleModule: Combustion::Database::Reset has no descriptive comment. More info.

hound · 2020-04-21T09:43:26Z

spec/support/helpers/path_helpers.rb

  end

-  def value_for(object:, path:)
+  def attr_value_for(object:, path:)


UtilityFunction: PathHelpers#attr_value_for doesn't depend on instance state (maybe move it to another class?). More info.

hound · 2020-04-21T09:43:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+                            # In order to use equality matchers for :float fields in MySQL, we need to cast to :decimal
+                            # https://dev.mysql.com/doc/refman/8.0/en/problems-with-float.html
+                            Arel::Nodes::NamedFunction.new('CAST', [arel_column.as('DECIMAL(8,2)')])
+                          elsif arel_type_is_string_or_text_or_binary && arel_operator_is_between_type && arel_column_collation_is_not_comparable


Metrics/LineLength: Line is too long. [145/120]

hound · 2020-04-21T09:43:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+                            # NOTE: this is can be quite inefficient, as it forces the DB engine to perform that cast on all rows.
+                            # https://www.ryadel.com/en/like-operator-equivalent-integer-numeric-columns-sql-t-sql-database/
+                            Arel::Nodes::NamedFunction.new('CAST', [arel_column.as('CHAR')])
+                          elsif adapter_is_mysql && arel_type_is_float && (query_value_is_numeric || query_value_is_collection_of_numerics || query_value_is_range_of_numerics)


Metrics/LineLength: Line is too long. [175/120]

hound · 2020-04-21T09:43:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+
+          @query_column = if arel_type_integer_or_float && arel_operator_is_match_type
+                            # In order to use LIKE, we must CAST the column as a CHAR column.
+                            # NOTE: this is can be quite inefficient, as it forces the DB engine to perform that cast on all rows.


Metrics/LineLength: Line is too long. [130/120]

hound · 2020-04-21T09:43:28Z

lib/active_set/filtering/active_record/set_instruction.rb

+                if v.respond_to?(:map)
+                  v.map { |vv| sprintf("%0.#{arel_column_scale}f", vv) }
+                else
+                  sprintf("%0.#{arel_column_scale}f", v)


Style/FormatString: Favor format over sprintf.

hound · 2020-04-21T09:43:28Z

lib/active_set/filtering/active_record/set_instruction.rb

+            if value.respond_to?(:map)
+              value.map do |v|
+                if v.respond_to?(:map)
+                  v.map { |vv| sprintf("%0.#{arel_column_scale}f", vv) }


Style/FormatString: Favor format over sprintf.

hound · 2020-04-21T09:43:28Z

lib/active_set/filtering/active_record/set_instruction.rb

+          adapter_is_mysql = adapter_type.presence_in(%i[mysql mysql2])
+          arel_column = attribute_model.column_for_attribute(attribute)
+          arel_column_scale = arel_column&.scale
+          value = begin


Style/MultilineIfModifier: Favor a normal if-statement over a modifier clause in a multiline statement.

hound · 2020-04-21T09:43:28Z

lib/active_set/filtering/active_record/set_instruction.rb

        end

-        private
+        def query_value


Metrics/AbcSize: Assignment Branch Condition size for query_value is too high. [43.47/15]
Metrics/CyclomaticComplexity: Cyclomatic complexity for query_value is too high. [13/6]
Metrics/PerceivedComplexity: Perceived complexity for query_value is too high. [17/7]

hound · 2020-04-21T09:43:29Z

spec/internal/app/models/concerns/scopes.rb

+
+  included do
+    ApplicationRecord::DB_FIELD_TYPES.each do |field|
+      scope "#{field}_scope_method", (lambda do |v|


UncommunicativeVariableName: Scopes has the variable name 'v'. More info.

…le on a failed spec

…a float field

spec/support/helpers/path_helpers.rb

sorter.rb

hound · 2020-05-19T16:17:39Z

sorter.rb

+  def test_sort_object_bool_then_int_in_ascending_with_nils_small_then_ascending_with_nils_large_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :small },
+                 { direction: :ascending, accessor: :int, nils: :large })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-05-19T16:17:39Z

sorter.rb

+  def test_sort_object_bool_then_int_in_ascending_with_nils_large_then_ascending_with_nils_small_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :large },
+                 { direction: :ascending, accessor: :int, nils: :small })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-05-19T16:17:39Z

sorter.rb

+  def test_sort_object_bool_then_int_in_ascending_with_nils_small_then_ascending_with_nils_small_order
+    assert_equal(
+      Sorter.new({ direction: :ascending, accessor: :bool, nils: :small },
+                 { direction: :ascending, accessor: :int, nils: :small })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-05-19T16:17:40Z

sorter.rb

+  def test_sort_object_int_then_bool_in_descending_then_descending_order
+    assert_equal(
+      Sorter.new({ direction: :descending, accessor: :int },
+                 { direction: :descending, accessor: :bool })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-05-19T16:17:40Z

sorter.rb

+  def test_sort_object_int_then_bool_in_descending_then_ascending_order
+    assert_equal(
+      Sorter.new({ direction: :descending, accessor: :int },
+                 { direction: :ascending, accessor: :bool })


Style/BracesAroundHashParameters: Redundant curly braces around a hash parameter.

hound · 2020-05-19T16:17:41Z

sorter.rb

+  def segment(string) # https://stackoverflow.com/a/15170063/2884386
+    string                                          # "a12b34c"
+      .scan(/\d+|\D/)                               # ["a", "12", "b", "34", "c"]
+      .map { |a| a =~ /\d+/ ? a.to_i : a }          # ["a", 12, "b", 34, "c"]


Performance/RegexpMatch: Use match? instead of =~ when MatchData is not used.

hound · 2020-05-19T16:17:41Z

sorter.rb

+      .join                                         # "aaaasss"
+  end
+
+  def segment(string) # https://stackoverflow.com/a/15170063/2884386


Style/CommentedKeyword: Do not place comments on the same line as the def keyword.

hound · 2020-05-19T16:17:41Z

sorter.rb

+    string                                          # "Äaáäßs"
+      .unicode_normalize(:nfd)                      # "Äaáäßs"
+      .downcase(:fold)                              # "äaáässs"
+      .chars                                        # ["a", "̈", "a", "a", "́", "a", "̈", "s", "s", "s"]


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-05-19T16:17:41Z

sorter.rb

+  def normalize(string) # https://github.com/grosser/sort_alphabetical
+    string                                          # "Äaáäßs"
+      .unicode_normalize(:nfd)                      # "Äaáäßs"
+      .downcase(:fold)                              # "äaáässs"


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-05-19T16:17:42Z

sorter.rb

+
+  def normalize(string) # https://github.com/grosser/sort_alphabetical
+    string                                          # "Äaáäßs"
+      .unicode_normalize(:nfd)                      # "Äaáäßs"


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-10-27T12:56:23Z

sorter.rb

+  end
+
+  def normalize(string) # https://github.com/grosser/sort_alphabetical
+    string                                          # "Äaáäßs"


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-10-27T12:56:23Z

sorter.rb

+      .to_r                                         # (980130990351/10000000000)
+  end
+
+  def normalize(string) # https://github.com/grosser/sort_alphabetical


Style/CommentedKeyword: Do not place comments on the same line as the def keyword.

hound · 2020-10-27T12:56:24Z

sorter.rb

+      .to_r                                         # (24266512014313/250000000000)
+  end
+
+  def time_to_numeric_value(time) # https://stackoverflow.com/a/30604935/2884386


Style/CommentedKeyword: Do not place comments on the same line as the def keyword.

hound · 2020-10-27T12:56:24Z

sorter.rb

+
+  def string_to_numeric_value(string)
+    string                                          # "aB09ü""
+      .chars                                        # ["a", "B", "0", "9", "ü"]


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-10-27T12:56:24Z

sorter.rb

+  end
+
+  def string_to_numeric_value(string)
+    string                                          # "aB09ü""


Style/AsciiComments: Use only ascii symbols in comments.

hound · 2020-10-27T12:56:25Z

lib/active_set/filtering/active_record/set_instruction.rb

-          Operators.get(instruction_operator)
+        def arel_column_to_sql(arel_column)
+          # the ARel column can already be rendered as SQL (because it is wrapped in a LOWER function, for example)
+          if arel_column.respond_to?(:to_sql)


ManualDispatch: ActiveSet::Filtering::ActiveRecord::SetInstruction#arel_column_to_sql manually dispatches method call. More info.

hound · 2020-10-27T12:56:25Z

lib/active_set/filtering/active_record/set_instruction.rb

+        end

-          Operators.get(instruction_operator)
+        def arel_column_to_sql(arel_column)


UtilityFunction: ActiveSet::Filtering::ActiveRecord::SetInstruction#arel_column_to_sql doesn't depend on instance state (maybe move it to another class?). More info.

hound · 2020-10-27T12:56:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+          unwrap_sql_str(sql_value)
+        end
+
+        def unwrap_sql_str(sql_str)


UtilityFunction: ActiveSet::Filtering::ActiveRecord::SetInstruction#unwrap_sql_str doesn't depend on instance state (maybe move it to another class?). More info.

hound · 2020-10-27T12:56:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+        end
+
+        def to_sql_str(value)
+          return value.map { |a| to_sql_str(a) } if value.respond_to?(:map)


ManualDispatch: ActiveSet::Filtering::ActiveRecord::SetInstruction#to_sql_str manually dispatches method call. More info.
UncommunicativeVariableName: ActiveSet::Filtering::ActiveRecord::SetInstruction#to_sql_str has the variable name 'a'. More info.

hound · 2020-10-27T12:56:26Z

lib/active_set/filtering/active_record/set_instruction.rb

+                                              .to_sym
+        end
+
+        def to_sql_str(value)


TooManyStatements: ActiveSet::Filtering::ActiveRecord::SetInstruction#to_sql_str has approx 6 statements. More info.

fractaledmind added 30 commits August 9, 2019 11:18

$@fractaledmind$

Add gemika as a test dep

1558a83

$@fractaledmind$

Bring the gemika Rake tasks into the gem's Rakefile

7d8110a

$@fractaledmind$

Move test deps into the gemspec

308e358

$@fractaledmind$

Create a suite of Gemfiles for cross-env testing

8e7fc74

$@fractaledmind$

Choose a default dependency set and symlink both gemfile and lockfile…

aeb64ce

… to your project root

$@fractaledmind$

Setup Gemika and run with Ruby 2.4.6

a2f6853

$@fractaledmind$

Get travis and database support setup

97442a4

$@fractaledmind$

Work on getting Gemika and Combustion to play nicely together

abf9102

$@fractaledmind$

Set a limit for sqlite3 gem with 4.2 Rails

2f5a287

$@fractaledmind$

update the name of the test tables for TravisCI

eaf3233

$@fractaledmind$

Merge branch 'master' into feature/gemika

3531b89

# Conflicts: # Gemfile.lock # Rakefile

$@fractaledmind$

Update gems

f6c5a28

$@fractaledmind$

Merge branch 'master' into feature/gemika

fefdc93

# Conflicts: # .ruby-version # .travis.yml # Gemfile.lock

$@fractaledmind$

Merge branch 'master' into feature/gemika

11b4456

$@fractaledmind$

Add updated lockfile

4abe55c

$@fractaledmind$

Start work on getting gemika setup; need to get tests running next

cc1fa39

$@fractaledmind$

Ensure that the scopes defined in the test models are run in the appr…

7896051

…opriate scope

$@fractaledmind$

Clean up some dep issues in the gemfiles

985c4ba

$@fractaledmind$

Add descriptions for the AttributeValue specs

2e725d2

$@fractaledmind$

Rename the value_for spec helper method, as it was conflicting with s…

90ec071

…ome other helper method somewhere

$@fractaledmind$

Fix the guaranteed_unique_attributes_for helper method to handle da…

e00d4a3

…te/time objects safely

$@fractaledmind$

Be sure to initialize Combustion _before_ setting up Bundler

000cf92

$@fractaledmind$

Binary values can't be type casted, it messes up the querying across …

83792a6

…adapters

$@fractaledmind$

MySQL can't match against float properly, so cast to decimals

cafbaa3

https://dev.mysql.com/doc/refman/8.0/en/problems-with-float.html

$@fractaledmind$

Don't make any ActiveRecordSetInstruction methods private

b35b58a

$@fractaledmind$

Override the PG adapter to use LIKE instead of ILIKE

b6346b2

$@fractaledmind$

Handle Rails 4.2 typecasting

7e6db0d

$@fractaledmind$

[WIP] try to get the bin/console script working

1006e4f

$@fractaledmind$

Ensure pry is in all gemfiles

f850ca7

$@fractaledmind$

Fix some problems

69a7153

fractaledmind added 11 commits April 19, 2020 18:08

$@fractaledmind$

Ignore another warning

727070f

$@fractaledmind$

Try to get the travis-ci builds working

0905991

$@fractaledmind$

Try again to get travis-ci working

7382607

$@fractaledmind$

Another try at travic-ci

532d28f

$@fractaledmind$

Only check for collation mismatches on MySQL engines

6b240cb

$@fractaledmind$

Set precision and scale for float fields for tests

bd01b20

$@fractaledmind$

Bump the mysql2 gem versions"

b95a81c

$@fractaledmind$

Ignore a couple more warnings

17e78a8

$@fractaledmind$

Handle the bigdecimal dependency and its required relation to differe…

91f841f

…nt Ruby versions

$@fractaledmind$

Quiet warnings in the test output

1bbe17b

$@fractaledmind$

Ignore byebug history

cd14bed

hound bot reviewed Apr 21, 2020

View reviewed changes

fractaledmind added 2 commits April 21, 2020 11:42

$@fractaledmind$

Reorganize the support files and have Travis use SQLite via a file

41100cf

$@fractaledmind$

Update the exclusion Gemfile name for Ruby 2.4.9 and MySQL

b24c9cd

hound bot reviewed Apr 21, 2020

View reviewed changes

fractaledmind added 6 commits April 21, 2020 23:27

$@fractaledmind$

Add an INTERRUPT_FAILURE hook as well for getting into a byebug conso…

cf7ee83

…le on a failed spec

$@fractaledmind$

For numeric test fields to start at 5 digits

e7087f5

$@fractaledmind$

No need to reload matching items for specs

3dc30b6

$@fractaledmind$

Return empty sets when filtering

ef6086d

$@fractaledmind$

Try to use the appropriate truncated value when testing filtering by …

fc8ea19

…a float field

$@fractaledmind$

CAN I GET THE TESTS TO PASS IF I IGNORE FLOAT FIELDS??!!??

d2d1751

hound bot reviewed Apr 21, 2020

View reviewed changes

fractaledmind added 5 commits May 18, 2020 14:35

$@fractaledmind$

Fix the console script

aa03d2b

$@fractaledmind$

Fix the Postgres handling of matching integers

bc336a2

$@fractaledmind$

Add some links for documentation to README

36c5a89

$@fractaledmind$

Handle Postrgres Boolean matching

c375cdd

$@fractaledmind$

Add some notes files

5bc57c5

hound bot reviewed May 19, 2020

View reviewed changes

$@fractaledmind$

Merge branch 'master' into feature/gemika

9a2dbc8

hound bot reviewed Oct 27, 2020

View reviewed changes

Feature/gemika #71

Are you sure you want to change the base?

Feature/gemika #71

Uh oh!

Conversation

fractaledmind commented Apr 21, 2020

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

hound bot Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hound bot May 19, 2020

Choose a reason for hiding this comment

Uh oh!

$@fractaledmind$ fractaledmind commented Apr 21, 2020