measured 2.8.2 → 3.0.0

data/test/rails/validation_test.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+require "test_helper"
+
+class Measured::Rails::ValidationTest < ActiveSupport::TestCase
+  setup do
+    reset_db
+  end
+
+  test "validation mock is valid" do
+    assert thing.valid?
+  end
+
+  test "validation measurable: validation leaves a model valid and deals with blank unit" do
+    assert ValidatedThing.new(length_presence: Measured::Length.new(4, :in)).valid?
+  end
+
+  test "validation fails when unit is nil" do
+    thing.length_unit = ''
+    refute thing.valid?
+    assert_equal({ length: ["is not a valid unit"] }, thing.errors.to_hash)
+  end
+
+  test "validation fails on model with custom unit with nil value" do
+    custom_unit_thing.size_unit = ''
+    refute custom_unit_thing.valid?
+    assert_equal(
+      {
+        length: ["is not a valid unit"],
+        width:  ["is not a valid unit"],
+        height: ["is not a valid unit"],
+      },
+      custom_unit_thing.errors.to_hash
+    )
+  end
+
+  test "validation true works by default" do
+    thing.length_unit = "junk"
+    refute thing.valid?
+    assert_equal ["Length is not a valid unit"], thing.errors.full_messages
+  end
+
+  test "validation can override the message with a static string" do
+    thing.length_message_unit = "junk"
+    refute thing.valid?
+    assert_equal ["Length message has a custom failure message"], thing.errors.full_messages
+  end
+
+  test "validation can override the message with a block" do
+    thing.length_message_from_block_unit = "junk"
+    refute thing.valid?
+    assert_equal ["Length message from block junk is not a valid unit"], thing.errors.full_messages
+  end
+
+  test "validation may be any valid unit" do
+    length_units.each do |unit|
+      thing.length_unit = unit
+      assert thing.valid?
+      thing.length_unit = unit.to_s
+      assert thing.valid?
+      thing.length = Measured::Length.new(123, unit)
+      assert thing.valid?
+    end
+  end
+
+  test "validation accepts a list of units in any format as an option and only allows them to be valid" do
+    thing.length_units_unit = :m
+    assert thing.valid?
+    thing.length_units_unit = :cm
+    assert thing.valid?
+    thing.length_units_unit = "cm"
+    assert thing.valid?
+    thing.length_units_unit = "meter"
+    assert thing.valid?
+    thing.length_units = Measured::Length.new(3, :cm)
+    assert thing.valid?
+    thing.length_units_unit = :mm
+    refute thing.valid?
+    thing.length_units = Measured::Length.new(3, :ft)
+    refute thing.valid?
+  end
+
+  test "validation lets the unit be singular" do
+    thing.length_units_singular_unit = :ft
+    assert thing.valid?
+    thing.length_units_singular_unit = "feet"
+    assert thing.valid?
+    thing.length_units_singular_unit = :mm
+    refute thing.valid?
+    thing.length_units_singular_unit = "meter"
+    refute thing.valid?
+  end
+
+  test "validation for unit reasons uses the default message" do
+    thing.length_units_unit = :mm
+    refute thing.valid?
+    assert_equal ["Length units is not a valid unit"], thing.errors.full_messages
+  end
+
+  test "validation for unit reasons also uses the custom message" do
+    thing.length_units_singular_unit = :mm
+    refute thing.valid?
+    assert_equal ["Length units singular custom message too"], thing.errors.full_messages
+  end
+
+  test "validation for unit reasons adds one message if unit is not supported by default and is not custom supported" do
+    thing.length_units_singular_unit = :t
+    refute thing.valid?
+
+    assert_equal ["Length units singular custom message too"], thing.errors.full_messages
+  end
+
+  test "validation presence works on measured columns" do
+    thing.length_presence = nil
+    refute thing.valid?
+    assert_equal ["Length presence can't be blank"], thing.errors.full_messages
+    thing.length_presence_unit = "m"
+    refute thing.valid?
+    thing.length_presence_value = "3"
+    assert thing.valid?
+  end
+
+  test "validation fails if only only the value is set" do
+    thing.length_unit = nil
+    refute thing.valid?
+  end
+
+  test "validation checks that numericality comparisons are against a Measurable subclass" do
+    thing.length_invalid_comparison = Measured::Length.new(30, :in)
+    assert_raises ArgumentError, ":not_a_measured_subclass must be a Measurable object" do
+      thing.valid?
+    end
+  end
+
+  test "validation for numericality uses a default invalid message" do
+    thing.length_numericality_inclusive = Measured::Length.new(30, :in)
+    refute thing.valid?
+    assert_equal ["Length numericality inclusive 30 in must be <= 20 in"], thing.errors.full_messages
+
+    thing.length_numericality_inclusive = Measured::Length.new(1, :mm)
+    refute thing.valid?
+    assert_equal ["Length numericality inclusive 1 mm must be >= 10 in"], thing.errors.full_messages
+  end
+
+  test "validation for numericality uses the override message" do
+    thing.length_numericality_exclusive = Measured::Length.new(2, :m)
+    refute thing.valid?
+    assert_equal ["Length numericality exclusive is super not ok"], thing.errors.full_messages
+
+    thing.length_numericality_exclusive = Measured::Length.new(6000, :mm)
+    refute thing.valid?
+    assert_equal ["Length numericality exclusive is super not ok"], thing.errors.full_messages
+  end
+
+  test "validation for numericality checks :greater_than and :less_than and can use symbols as method names to look up values" do
+    thing.length_numericality_exclusive = Measured::Length.new(4, :m)
+    assert thing.valid?
+
+    thing.length_numericality_exclusive = Measured::Length.new(1, :m)
+    refute thing.valid?
+  end
+
+  test "validation for numericality checks :greater_than_or_equal_to and :less_than_or_equal_to" do
+    thing.length_numericality_inclusive = Measured::Length.new(10, :in)
+    assert thing.valid?
+
+    thing.length_numericality_exclusive = Measured::Length.new(3, :m)
+    refute thing.valid?
+  end
+
+  test "validation for numericality checks :equal_to and can use procs to look up values" do
+    thing.length_numericality_equality = Measured::Length.new(100, :cm)
+    assert thing.valid?
+
+    thing.length_numericality_equality = Measured::Length.new(1, :m)
+    assert thing.valid?
+
+    thing.length_numericality_equality = Measured::Length.new("99.9", :cm)
+    refute thing.valid?
+
+    thing.length_numericality_equality = Measured::Length.new(101, :cm)
+    refute thing.valid?
+  end
+
+  test "validation for numericality handles a nil unit but a valid value" do
+    thing.length_numericality_exclusive_unit = nil
+    thing.length_numericality_exclusive_value = 1
+    refute thing.valid?
+  end
+
+  test "allow a nil value but a valid unit" do
+    thing.length_numericality_exclusive_unit = :cm
+    thing.length_numericality_exclusive_value = nil
+    assert thing.valid?
+  end
+
+  test "validations work as expected given a measured field with custom validators" do
+    assert custom_unit_thing.valid?
+
+    assert custom_unit_thing.size_unit = 'invalid'
+
+    refute custom_unit_thing.valid?
+
+    assert_equal(custom_unit_thing.errors[:length], ["is not a valid unit"])
+    assert_equal(custom_unit_thing.errors[:height], ["is not a valid unit"])
+    assert_equal(custom_unit_thing.errors[:width], ["is not a valid unit"])
+  end
+
+  test "validations work as expected on measured field with custom value accessor" do
+    assert custom_value_thing.valid?
+  end
+
+  private
+
+  def thing
+    @thing ||= ValidatedThing.new(
+      length: Measured::Length.new(1, :m),
+      length_true: Measured::Length.new(2, :cm),
+      length_message: Measured::Length.new(3, :mm),
+      length_message_from_block: Measured::Length.new(7, :mm),
+      length_units: Measured::Length.new(4, :m),
+      length_units_singular: Measured::Length.new(5, :ft),
+      length_presence: Measured::Length.new(6, :m),
+      length_numericality_inclusive: Measured::Length.new(15, :in),
+      length_numericality_exclusive: Measured::Length.new(4, :m),
+      length_numericality_equality: Measured::Length.new(100, :cm),
+    )
+  end
+
+  def custom_unit_thing
+    @custom_unit_thing ||= ThingWithCustomUnitAccessor.new(
+      length: Measured::Length.new(1, :m),
+      width: Measured::Length.new(2, :m),
+      height: Measured::Length.new(3, :m),
+      total_weight: Measured::Weight.new(10, :g),
+      extra_weight: Measured::Weight.new(12, :g),
+    )
+  end
+
+  def custom_value_thing
+    @custom_value_thing = ThingWithCustomValueAccessor.new(
+      length: Measured::Length.new(1, :m),
+      width: Measured::Length.new(2, :m),
+      height: Measured::Length.new(3, :m),
+      total_weight: Measured::Weight.new(10, :g),
+      extra_weight: Measured::Weight.new(12, :g),
+    )
+  end
+
+  def length_units
+    @length_units ||= [:m, :meter, :cm, :mm, :millimeter, :in, :ft, :feet, :yd]
+  end
+end

data/test/tapioca/dsl/compilers/measured_rails_test.rb

@@ -0,0 +1,220 @@
+# typed: true
+# frozen_string_literal: true
+
+require "test_helper"
+require "tapioca/internal"
+require "tapioca/helpers/test/dsl_compiler"
+require "tapioca/dsl/compilers/measured_rails"
+
+module Tapioca
+  module Dsl
+    module Compilers
+      class MeasuredRailsTest < ActiveSupport::TestCase
+        include Tapioca::Helpers::Test::DslCompiler
+
+        setup do
+          use_dsl_compiler(Tapioca::Dsl::Compilers::MeasuredRails)
+        end
+
+        test "#initialize gathers only ActiveRecord subclasses" do
+          add_ruby_file("content.rb", <<~RUBY)
+            class Post < ActiveRecord::Base
+            end
+            class Current
+            end
+          RUBY
+
+          assert_includes(gathered_constants, "Post")
+          refute_includes(gathered_constants, "Current")
+        end
+
+        test "generates empty RBI file if there are no measured fields" do
+          add_ruby_file("package.rb", <<~RUBY)
+            class Package < ActiveRecord::Base
+            end
+          RUBY
+
+          expected = <<~RBI
+            # typed: strong
+          RBI
+
+          assert_equal(expected, rbi_for(:Package))
+        end
+
+        test "generates RBI file for measured method" do
+          add_ruby_file("schema.rb", <<~RUBY)
+            ActiveRecord::Migration.suppress_messages do
+              ActiveRecord::Schema.define do
+                create_table :packages, force: :cascade do |t|
+                  t.decimal :minimum_weight_value, precision: 10, scale: 2
+                  t.string :minimum_weight_unit, limit: 12
+                  t.decimal :total_length_value, precision: 10, scale: 2, default: 0
+                  t.string :total_length_unit, limit: 12, default: "cm"
+                  t.decimal :total_volume_value, precision: 10, scale: 2, default: 0
+                  t.string :total_volume_unit, limit: 12, default: "l"
+                end
+              end
+            end
+          RUBY
+
+          add_ruby_file("package.rb", <<~RUBY)
+            class Package < ActiveRecord::Base
+              measured Measured::Weight, :minimum_weight
+              measured Measured::Length, :total_length
+              measured Measured::Volume, :total_volume
+            end
+          RUBY
+
+          expected = <<~RBI
+            # typed: strong
+
+            class Package
+              include GeneratedMeasuredRailsMethods
+
+              module GeneratedMeasuredRailsMethods
+                sig { returns(T.nilable(::Measured::Weight)) }
+                def minimum_weight; end
+
+                sig { params(value: T.nilable(::Measured::Weight)).void }
+                def minimum_weight=(value); end
+
+                sig { returns(T.nilable(::Measured::Length)) }
+                def total_length; end
+
+                sig { params(value: T.nilable(::Measured::Length)).void }
+                def total_length=(value); end
+
+                sig { returns(T.nilable(::Measured::Volume)) }
+                def total_volume; end
+
+                sig { params(value: T.nilable(::Measured::Volume)).void }
+                def total_volume=(value); end
+              end
+            end
+          RBI
+
+          assert_equal(expected, rbi_for(:Package))
+        end
+
+        test "generates RBI file for measured_weight method" do
+          add_ruby_file("schema.rb", <<~RUBY)
+            ActiveRecord::Migration.suppress_messages do
+              ActiveRecord::Schema.define do
+                create_table :packages, force: :cascade do |t|
+                  t.decimal :minimum_weight_value, precision: 10, scale: 2
+                  t.string :minimum_weight_unit, limit: 12
+                  t.decimal :total_length_value, precision: 10, scale: 2, default: 0
+                  t.string :total_length_unit, limit: 12, default: "cm"
+                  t.decimal :total_volume_value, precision: 10, scale: 2, default: 0
+                  t.string :total_volume_unit, limit: 12, default: "l"
+                end
+              end
+            end
+          RUBY
+
+          add_ruby_file("package.rb", <<~RUBY)
+            class Package < ActiveRecord::Base
+              measured_weight :minimum_weight
+            end
+          RUBY
+
+          expected = <<~RBI
+            # typed: strong
+
+            class Package
+              include GeneratedMeasuredRailsMethods
+
+              module GeneratedMeasuredRailsMethods
+                sig { returns(T.nilable(::Measured::Weight)) }
+                def minimum_weight; end
+
+                sig { params(value: T.nilable(::Measured::Weight)).void }
+                def minimum_weight=(value); end
+              end
+            end
+          RBI
+
+          assert_equal(expected, rbi_for(:Package))
+        end
+
+        test "generates RBI file for measured_length method" do
+          add_ruby_file("schema.rb", <<~RUBY)
+            ActiveRecord::Migration.suppress_messages do
+              ActiveRecord::Schema.define do
+                create_table :packages, force: :cascade do |t|
+                  t.decimal :minimum_weight_value, precision: 10, scale: 2
+                  t.string :minimum_weight_unit, limit: 12
+                  t.decimal :total_length_value, precision: 10, scale: 2, default: 0
+                  t.string :total_length_unit, limit: 12, default: "cm"
+                  t.decimal :total_volume_value, precision: 10, scale: 2, default: 0
+                  t.string :total_volume_unit, limit: 12, default: "l"
+                end
+              end
+            end
+          RUBY
+
+          add_ruby_file("package.rb", <<~RUBY)
+            class Package < ActiveRecord::Base
+              measured_length :total_length
+            end
+          RUBY
+
+          expected = <<~RBI
+            # typed: strong
+
+            class Package
+              include GeneratedMeasuredRailsMethods
+
+              module GeneratedMeasuredRailsMethods
+                sig { returns(T.nilable(::Measured::Length)) }
+                def total_length; end
+
+                sig { params(value: T.nilable(::Measured::Length)).void }
+                def total_length=(value); end
+              end
+            end
+          RBI
+
+          assert_equal(expected, rbi_for(:Package))
+        end
+
+        test "generates RBI file for measured_volume method" do
+          add_ruby_file("schema.rb", <<~RUBY)
+            ActiveRecord::Migration.suppress_messages do
+              ActiveRecord::Schema.define do
+                create_table :packages, force: :cascade do |t|
+                  t.decimal :total_volume_value, precision: 10, scale: 2, default: 0
+                  t.string :total_volume_unit, limit: 12, default: "l"
+                end
+              end
+            end
+          RUBY
+
+          add_ruby_file("package.rb", <<~RUBY)
+            class Package < ActiveRecord::Base
+              measured_volume :total_volume
+            end
+          RUBY
+
+          expected = <<~RBI
+            # typed: strong
+
+            class Package
+              include GeneratedMeasuredRailsMethods
+
+              module GeneratedMeasuredRailsMethods
+                sig { returns(T.nilable(::Measured::Volume)) }
+                def total_volume; end
+
+                sig { params(value: T.nilable(::Measured::Volume)).void }
+                def total_volume=(value); end
+              end
+            end
+          RBI
+
+          assert_equal(expected, rbi_for(:Package))
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
+
 require "pry" unless ENV["CI"]
+require "combustion"
+Combustion.path = "test/internal"
+Combustion.initialize! :active_record, :active_model
 require "measured"
 require "minitest/reporters"
 require "minitest/autorun"
@@ -7,6 +11,13 @@ require "mocha/minitest"
 
 ActiveSupport.test_order = :random
 
+# Prevent two reporters from printing
+# https://github.com/kern/minitest-reporters/issues/230
+# https://github.com/rails/rails/issues/30491
+Minitest.load_plugins
+Minitest.extensions.delete('rails')
+Minitest.extensions.unshift('rails')
+
 Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new(color: true)]
 
 require "support/subclasses"
@@ -44,4 +55,8 @@ class ActiveSupport::TestCase
     error = assert_raise(exception) { yield }
     assert_equal expected_message, error.message, "Exception #{exception} raised but messages are not equal"
   end
+
+  def reset_db
+    Combustion::Database::LoadSchema.call
+  end
 end

data/test/units/weight_test.rb

@@ -15,6 +15,8 @@ class Measured::WeightTest < ActiveSupport::TestCase
       g
       gram
       grams
+      gm
+      gms
       imperial_ton
       imperial_tons
       lb
@@ -39,7 +41,7 @@ class Measured::WeightTest < ActiveSupport::TestCase
       weight_tons
     )
     expected_units += Measured::UnitSystemBuilder::SI_PREFIXES.flat_map do |short, long, _|
-      ["#{short}g", "#{long}gram", "#{long}grams"]
+      ["#{short}g", "#{long}gram", "#{long}grams", "#{long}gm", "#{long}gms"]
     end
 
     assert_equal expected_units.sort, Measured::Weight.unit_names_with_aliases

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Kevin McPhillips
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -96,6 +96,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper objects which encapsulate measurements and their associated units
   in Ruby.
 email:
@@ -105,7 +147,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -116,9 +160,10 @@ files:
 - cache/volume.json
 - cache/weight.json
 - dev.yml
-- gemfiles/activesupport-5.2.gemfile
-- gemfiles/activesupport-6.0.gemfile
-- gemfiles/activesupport-6.1.gemfile
+- gemfiles/rails-6.0.gemfile
+- gemfiles/rails-6.1.gemfile
+- gemfiles/rails-7.0.gemfile
+- gemfiles/rails-edge.gemfile
 - lib/measured.rb
 - lib/measured/arithmetic.rb
 - lib/measured/base.rb
@@ -130,6 +175,9 @@ files:
 - lib/measured/measurable.rb
 - lib/measured/missing_conversion_path.rb
 - lib/measured/parser.rb
+- lib/measured/rails/active_record.rb
+- lib/measured/rails/validations.rb
+- lib/measured/railtie.rb
 - lib/measured/unit.rb
 - lib/measured/unit_already_added.rb
 - lib/measured/unit_error.rb
@@ -139,6 +187,7 @@ files:
 - lib/measured/units/volume.rb
 - lib/measured/units/weight.rb
 - lib/measured/version.rb
+- lib/tapioca/dsl/compilers/measured_rails.rb
 - measured.gemspec
 - shipit.rubygems.yml
 - test/arithmetic_test.rb
@@ -147,11 +196,23 @@ files:
 - test/cache/null_test.rb
 - test/cache_consistency_test.rb
 - test/conversion_table_builder_test.rb
+- test/internal/app/models/thing.rb
+- test/internal/app/models/thing_with_custom_unit_accessor.rb
+- test/internal/app/models/thing_with_custom_value_accessor.rb
+- test/internal/app/models/validated_thing.rb
+- test/internal/config.ru
+- test/internal/config/database.yml
+- test/internal/db/.gitignore
+- test/internal/db/schema.rb
+- test/internal/log/.gitignore
 - test/measurable_test.rb
 - test/parser_test.rb
+- test/rails/active_record_test.rb
+- test/rails/validation_test.rb
 - test/support/always_true_cache.rb
 - test/support/fake_system.rb
 - test/support/subclasses.rb
+- test/tapioca/dsl/compilers/measured_rails_test.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
 - test/unit_system_builder_test.rb
@@ -173,14 +234,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Encapsulate measurements with their units in Ruby
@@ -191,11 +252,23 @@ test_files:
 - test/cache/null_test.rb
 - test/cache_consistency_test.rb
 - test/conversion_table_builder_test.rb
+- test/internal/app/models/thing.rb
+- test/internal/app/models/thing_with_custom_unit_accessor.rb
+- test/internal/app/models/thing_with_custom_value_accessor.rb
+- test/internal/app/models/validated_thing.rb
+- test/internal/config.ru
+- test/internal/config/database.yml
+- test/internal/db/.gitignore
+- test/internal/db/schema.rb
+- test/internal/log/.gitignore
 - test/measurable_test.rb
 - test/parser_test.rb
+- test/rails/active_record_test.rb
+- test/rails/validation_test.rb
 - test/support/always_true_cache.rb
 - test/support/fake_system.rb
 - test/support/subclasses.rb
+- test/tapioca/dsl/compilers/measured_rails_test.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
 - test/unit_system_builder_test.rb

data/gemfiles/activesupport-5.2.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'activesupport', '~> 5.2'