measured 2.8.2 → 3.1.0

data/lib/measured.rb

@@ -4,3 +4,5 @@ require "measured/base"
 require "measured/units/length"
 require "measured/units/weight"
 require "measured/units/volume"
+
+require "measured/railtie" if defined?(Rails::Railtie)

data/lib/tapioca/dsl/compilers/measured_rails.rb

@@ -0,0 +1,110 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(::Measured::Rails)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Dsl::Compilers::MeasuredRails` refines RBI files for subclasses of
+      # [`ActiveRecord::Base`](https://api.rubyonrails.org/classes/ActiveRecord/Base.html)
+      # that utilize the [`measured-rails`](https://github.com/shopify/measured-rails) DSL.
+      # This compiler is only responsible for defining the methods that would be created
+      # for measured fields that are defined in the Active Record model.
+      #
+      # For example, with the following model class:
+      #
+      # ~~~rb
+      # class Package < ActiveRecord::Base
+      #   measured Measured::Weight, :minimum_weight
+      #   measured Measured::Length, :total_length
+      #   measured Measured::Volume, :total_volume
+      # end
+      # ~~~
+      #
+      # this compiler will produce the following methods in the RBI file
+      # `package.rbi`:
+      #
+      # ~~~rbi
+      # # package.rbi
+      # # typed: true
+      #
+      # 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
+      # ~~~
+      class MeasuredRails < ::Tapioca::Dsl::Compiler
+        extend T::Sig
+
+        ConstantType = type_member { {
+          fixed: T.all(
+            T.class_of(::ActiveRecord::Base),
+            ::Measured::Rails::ActiveRecord::ClassMethods
+          )
+        } }
+
+        MeasuredMethodsModuleName = T.let("GeneratedMeasuredRailsMethods", String)
+
+        sig { override.void }
+        def decorate
+          return if constant.measured_fields.empty?
+
+          root.create_path(constant) do |model|
+            model.create_module(MeasuredMethodsModuleName) do |mod|
+              populate_measured_methods(mod)
+            end
+
+            model.create_include(MeasuredMethodsModuleName)
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def self.gather_constants
+          descendants_of(::ActiveRecord::Base)
+        end
+
+        private
+
+        sig { params(model: RBI::Scope).void }
+        def populate_measured_methods(model)
+          constant.measured_fields.each do |field, attrs|
+            class_name = qualified_name_of(attrs[:class])
+
+            next unless class_name
+
+            model.create_method(
+              field.to_s,
+              return_type: as_nilable_type(class_name)
+            )
+
+            model.create_method(
+              "#{field}=",
+              parameters: [create_param("value", type: as_nilable_type(class_name))],
+              return_type: "void"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/measured.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Shopify/measured"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 3.0.0"
+
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
@@ -33,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "mocha", ">= 1.4.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "sqlite3", "> 1.4"
+  spec.add_development_dependency "tapioca"
 end

data/test/internal/app/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/internal/app/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/internal/app/models/thing_with_custom_value_accessor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+class ThingWithCustomValueAccessor < ActiveRecord::Base
+  measured_length :length, value_field_name: :custom_length
+  validates :length, measured: true
+  measured_length :width, value_field_name: :custom_width
+  validates :width, measured: true
+
+  measured_volume :volume, value_field_name: :custom_volume
+  validates :volume, measured: true
+
+  measured_length :height, value_field_name: :custom_height
+  validates :height, measured: true
+
+  measured_weight :total_weight, value_field_name: :custom_weight
+  validates :total_weight, measured: true
+
+  measured_weight :extra_weight, value_field_name: :custom_extra_weight
+  validates :extra_weight, measured: true
+end

data/test/internal/app/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/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: ":memory:"

data/test/internal/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/test/internal/db/.gitignore

@@ -0,0 +1 @@
+measured.sqlite*

data/test/internal/db/schema.rb

@@ -0,0 +1,99 @@
+# 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 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
+
+  create_table "thing_with_custom_value_accessors", force: :cascade do |t|
+    t.decimal  "custom_length",                  precision: 10, scale: 2
+    t.string   "length_unit",         limit: 12
+    t.decimal  "custom_width",                   precision: 10, scale: 2
+    t.string   "width_unit",          limit: 12
+    t.decimal  "custom_height",                  precision: 10, scale: 2
+    t.string   "height_unit",         limit: 12
+    t.decimal  "custom_volume",                  precision: 10, scale: 2
+    t.string   "volume_unit",         limit: 12
+    t.decimal  "custom_weight",                  precision: 10, scale: 2, default: "10.0"
+    t.string   "total_weight_unit",   limit: 12
+    t.decimal  "custom_extra_weight",            precision: 10, scale: 2
+    t.string   "extra_weight_unit",   limit: 12
+    t.datetime "created_at",                                                              null: false
+    t.datetime "updated_at",                                                              null: false
+  end
+
+end

data/test/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/test/measurable_test.rb

@@ -41,6 +41,10 @@ class Measured::MeasurableTest < ActiveSupport::TestCase
     assert_equal BigDecimal("9.1234572342342"), Magic.new("9.1234572342342", :fire).value
   end
 
+  test "#initialize converts strings to Rational if they follow Rational pattern" do
+    assert_equal Rational(1, 3), Magic.new("1/3", :fire).value
+  end
+
   test "#initialize converts to the base unit" do
     assert_equal @fireball, Magic.new(1, :fire).unit
   end