measured-rails 2.3.0 → 2.6.0

data/test/support/models/thing.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Thing < ActiveRecord::Base
+
+  measured_length :length, :width
+
+  measured Measured::Length, :height
+  measured Measured::Volume, :volume
+
+  measured_weight :total_weight
+
+  measured "Measured::Weight", :extra_weight
+
+  measured_length :length_with_max_on_assignment, {max_on_assignment: 500}
+end

data/test/support/models/thing_with_custom_unit_accessor.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+class ThingWithCustomUnitAccessor < ActiveRecord::Base
+  measured_length :length, :width, unit_field_name: :size_unit
+  validates :length, measured: true
+  validates :width, measured: true
+
+  measured_volume :volume
+  validates :volume, measured: true
+
+  measured Measured::Length, :height, unit_field_name: :size_unit
+  validates :height, measured: true
+
+  measured_weight :total_weight, unit_field_name: :weight_unit
+  validates :total_weight, measured: true
+
+  measured "Measured::Weight", :extra_weight, unit_field_name: :weight_unit
+  validates :extra_weight, measured: true
+end

data/test/support/models/validated_thing.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+class ValidatedThing < ActiveRecord::Base
+  measured_length :length
+  validates :length, measured: true
+
+  measured_length :length_true
+  validates :length_true, measured: true
+
+  measured_length :length_message
+  validates :length_message, measured: {message: "has a custom failure message"}
+
+  measured_length :length_message_from_block
+  validates :length_message_from_block, measured: { message: Proc.new { |record| "#{record.length_message_from_block_unit} is not a valid unit" } }
+
+  measured_length :length_units
+  validates :length_units, measured: {units: [:meter, "cm"]}
+
+  measured_length :length_units_singular
+  validates :length_units_singular, measured: {units: :ft, message: "custom message too"}
+
+  measured_length :length_presence
+  validates :length_presence, measured: true, presence: true
+
+  measured_length :length_numericality_inclusive
+  validates :length_numericality_inclusive, measured: {greater_than_or_equal_to: :low_bound, less_than_or_equal_to: :high_bound }
+
+  measured_length :length_numericality_exclusive
+  validates :length_numericality_exclusive, measured: {greater_than: Measured::Length.new(3, :m), less_than: Measured::Length.new(500, :cm), message: "is super not ok"}
+
+  measured_length :length_numericality_equality
+  validates :length_numericality_equality, measured: {equal_to: Proc.new { Measured::Length.new(100, :cm) }, message: "must be exactly 100cm"}
+
+  measured_length :length_invalid_comparison
+  validates :length_invalid_comparison, measured: {equal_to: "not_a_measured_subclass"}
+
+  private
+
+  def low_bound
+    Measured::Length.new(10, :in)
+  end
+
+  def high_bound
+    Measured::Length.new(20, :in)
+  end
+end

data/test/support/schema.rb

@@ -0,0 +1,83 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20161118203701) do
+
+  create_table "thing_with_custom_unit_accessors", force: :cascade do |t|
+    t.decimal  "length_value",                  precision: 10, scale: 2
+    t.decimal  "width_value",                   precision: 10, scale: 2
+    t.decimal  "height_value",                  precision: 10, scale: 2
+    t.decimal  "volume_value",                  precision: 10, scale: 2
+    t.string   "volume_unit",          limit: 12
+    t.string   "size_unit",          limit: 12
+    t.decimal  "total_weight_value",            precision: 10, scale: 2, default: "10.0"
+    t.decimal  "extra_weight_value",            precision: 10, scale: 2
+    t.string   "weight_unit",        limit: 12
+    t.datetime "created_at",                                                              null: false
+    t.datetime "updated_at",                                                              null: false
+  end
+
+  create_table "things", force: :cascade do |t|
+    t.decimal  "length_value",                                   precision: 10, scale: 2
+    t.string   "length_unit",                         limit: 12
+    t.decimal  "width_value",                                    precision: 10, scale: 2
+    t.string   "width_unit",                          limit: 12
+    t.decimal  "height_value",                                   precision: 10, scale: 2
+    t.string   "height_unit",                         limit: 12
+    t.decimal  "volume_value",                                   precision: 10, scale: 2
+    t.string   "volume_unit",                         limit: 12
+    t.decimal  "total_weight_value",                             precision: 10, scale: 2, default: "10.0"
+    t.string   "total_weight_unit",                   limit: 12,                          default: "g"
+    t.decimal  "extra_weight_value",                             precision: 10, scale: 2
+    t.string   "extra_weight_unit",                   limit: 12
+    t.decimal  "length_with_max_on_assignment_value",            precision: 10, scale: 2
+    t.string   "length_with_max_on_assignment_unit",  limit: 12
+    t.datetime "created_at",                                                                               null: false
+    t.datetime "updated_at",                                                                               null: false
+  end
+
+  create_table "validated_things", force: :cascade do |t|
+    t.decimal  "length_value",                                               precision: 10, scale: 2
+    t.string   "length_unit",                                     limit: 12
+    t.decimal  "length_true_value",                                          precision: 10, scale: 2
+    t.string   "length_true_unit",                                limit: 12
+    t.decimal  "length_message_value",                                       precision: 10, scale: 2
+    t.string   "length_message_unit",                             limit: 12
+    t.decimal  "length_message_from_block_value",                            precision: 10, scale: 2
+    t.string   "length_message_from_block_unit",                  limit: 12
+    t.decimal  "length_units_value",                                         precision: 10, scale: 2
+    t.string   "length_units_unit",                               limit: 12
+    t.decimal  "length_units_singular_value",                                precision: 10, scale: 2
+    t.string   "length_units_singular_unit",                      limit: 12
+    t.decimal  "length_presence_value",                                      precision: 10, scale: 2
+    t.string   "length_presence_unit",                            limit: 12
+    t.decimal  "length_invalid_value",                                       precision: 10, scale: 2
+    t.string   "length_invalid_unit",                             limit: 12
+    t.datetime "created_at",                                                                          null: false
+    t.datetime "updated_at",                                                                          null: false
+    t.decimal  "length_numericality_inclusive_value",                        precision: 10, scale: 2
+    t.string   "length_numericality_inclusive_unit",              limit: 12
+    t.decimal  "length_numericality_exclusive_value",                        precision: 10, scale: 2
+    t.string   "length_numericality_exclusive_unit",              limit: 12
+    t.decimal  "length_numericality_equality_value",                         precision: 10, scale: 2
+    t.string   "length_numericality_equality_unit",               limit: 12
+    t.decimal  "length_invalid_comparison_value",                            precision: 10, scale: 2
+    t.string   "length_invalid_comparison_unit",                  limit: 12
+    t.decimal  "length_non_zero_scalar_value",                               precision: 10, scale: 2
+    t.string   "length_non_zero_scalar_unit",                     limit: 12
+    t.decimal  "length_zero_scalar_value",                                   precision: 10, scale: 2
+    t.string   "length_zero_scalar_unit",                         limit: 12
+    t.decimal  "length_numericality_less_than_than_scalar_value",            precision: 10, scale: 2
+    t.string   "length_numericality_less_than_than_scalar_unit",  limit: 12
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "pry" unless ENV["CI"]
+require "measured"
+require "measured-rails"
+require "minitest/autorun"
+require "minitest/reporters"
+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)]
+
+class ActiveSupport::TestCase
+  def reset_db
+    ActiveRecord::Base.subclasses.each do |model|
+      model.delete_all
+    end
+  end
+end
+
+Dir.glob(File.expand_path("../support/models/*.rb", __FILE__)).each { |r| require r }
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+require_relative "support/schema.rb"

data/test/validation_test.rb

@@ -0,0 +1,238 @@
+# 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
+
+  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 length_units
+    @length_units ||= [:m, :meter, :cm, :mm, :millimeter, :in, :ft, :feet, :yd]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measured-rails
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: measured
@@ -16,42 +16,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +112,16 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -139,37 +153,46 @@ dependencies:
 description: Rails adapter for assigning and managing measurements with their units
   provided by the measured gem.
 email:
-- github@kevinmcphillips.ca
+- gems@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - dev.yml
-- gemfiles/rails-4.2.gemfile
-- gemfiles/rails-5.0.gemfile
+- gemfiles/rails-5.2.gemfile
+- gemfiles/rails-6.0.gemfile
+- gemfiles/rails-6.1.gemfile
 - gemfiles/rails-master.gemfile
 - lib/measured-rails.rb
 - lib/measured/rails/active_record.rb
 - lib/measured/rails/base.rb
 - lib/measured/rails/railtie.rb
 - lib/measured/rails/units/length.rb
+- lib/measured/rails/units/volume.rb
 - lib/measured/rails/units/weight.rb
 - lib/measured/rails/validations.rb
 - lib/measured/rails/version.rb
 - measured-rails.gemspec
 - shipit.rubygems.yml
+- test/active_record_test.rb
+- test/support/models/thing.rb
+- test/support/models/thing_with_custom_unit_accessor.rb
+- test/support/models/validated_thing.rb
+- test/support/schema.rb
+- test/test_helper.rb
+- test/validation_test.rb
 homepage: https://github.com/Shopify/measured-rails
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -185,9 +208,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails adaptor for measured
-test_files: []
+test_files:
+- test/active_record_test.rb
+- test/support/models/thing.rb
+- test/support/models/thing_with_custom_unit_accessor.rb
+- test/support/models/validated_thing.rb
+- test/support/schema.rb
+- test/test_helper.rb
+- test/validation_test.rb