measured-rails 2.8.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f5d42d6f68a07206f65244200601d778a45d98d2082fa6e3219ef6c0ef1d7a
-  data.tar.gz: f6c02b4a808080c43694621964947b92ed3a943edc2c474a016459890e3d8e5a
+  metadata.gz: 9b55237558354338d84cefa5601b2598c56df76e505e9d242e634fbe0c29c06e
+  data.tar.gz: 4ebb417899eabda3cde19d8a2653cfeb1a58070891d31721ffa8dafffdc092a4
 SHA512:
-  metadata.gz: 4fe858682b711f08f552b73c1cf0d2e56d7b89fa398ae7c36261178e7a1196e0f3e48e19e2104f263bc581c91b3e4a6c9a98a32f187f97818b4d503d98941b60
-  data.tar.gz: 7ed2063fe8249390a14c2bdd455f4d99aecc2b0a630bbb8ebd8334f3bcfe493e383512b6f994e47420bccbec45dfff4369aa0688c86bbe963a7d60b42b6c9709
+  metadata.gz: c4bda2138bde85df71997975f97aaf475b846cc5dc544abe0a441a7b5fd59759b7c59aa6a226b37e3eb40b537e7571a61283c3e96e8b62e0119a51526ff9640b
+  data.tar.gz: 5789a4bf8aee26246f8c6517fd94e6fb3377cbb9d445c558eadbbb6ece4c7164718852aefe7bbbe95a2a00a5dea78a79fa8472d2be41760c91e140c0e3ba08fa

data/.github/workflows/cla.yml

@@ -0,0 +1,23 @@
+# .github/workflows/cla.yml
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-Unreleased
+3.0.0
 -----
 
+* This gem is now deprecated. The functionality of this gem has been merged into the [measured](https://github.com/Shopify/measured).
 
+2.8.2
+-----
+
+* Bump measured to 2.8.2
 
 2.8.1
 -----

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails'
+gem "rake", "> 10.0"

data/README.md

@@ -1,146 +1,10 @@
 # Measured Rails [![Build Status](https://travis-ci.org/Shopify/measured-rails.svg)](https://travis-ci.org/Shopify/measured-rails) [![Gem Version](https://badge.fury.io/rb/measured-rails.svg)](http://badge.fury.io/rb/measured-rails)
 
-This gem is the Rails integration for the [measured](https://github.com/Shopify/measured) gem.
+Since version 3.0.0, the functionality of this gem has been merged into the [measured](https://github.com/Shopify/measured) gem. This gem no longer does anything useful and is not maintained.
 
-It provides ActiveRecord adapter for persisting and retrieving measurements with their units, and model validations.
+If you are using this gem, you should switch to using the `measured` gem directly.
 
-## Installation
-
-Using bundler, add to the Gemfile:
-
-```ruby
-gem 'measured-rails'
-```
-
-Or stand alone:
-
-    $ gem install measured-rails
-
-## Usage
-
-### ActiveRecord
-
-Columns are expected to have the `_value` and `_unit` suffix, and be `DECIMAL` and `VARCHAR`, and defaults are accepted. Customizing the column used to hold units is supported, see below for details.
-
-```ruby
-class AddWeightAndLengthToThings < ActiveRecord::Migration
-  def change
-    add_column :things, :minimum_weight_value, :decimal, precision: 10, scale: 2
-    add_column :things, :minimum_weight_unit, :string, limit: 12
-
-    add_column :things, :total_length_value, :decimal, precision: 10, scale: 2, default: 0
-    add_column :things, :total_length_unit, :string, limit: 12, default: "cm"
-  end
-end
-```
-
-A column can be declared as a measurement with its measurement subclass:
-
-```ruby
-class Thing < ActiveRecord::Base
-  measured Measured::Weight, :minimum_weight
-  measured Measured::Length, :total_length
-  measured Measured::Volume, :total_volume
-end
-```
-
-You can optionally customize the model's unit column by specifying it in the `unit_field_name` option, as follows:
-
-```ruby
-class ThingWithCustomUnitAccessor < ActiveRecord::Base
-  measured_length :length, :width, :height,     unit_field_name: :size_unit
-  measured_weight :total_weight, :extra_weight, unit_field_name: :weight_unit
-  measured_volume :total_volume, :extra_volume, unit_field_name: :volume_unit
-end
-```
-
-Similarly, you can optionally customize the model's value column by specifying it in the `value_field_name` option, as follows:
-
-```ruby
-class ThingWithCustomValueAccessor < ActiveRecord::Base
-  measured_length :length, value_field_name: :custom_length
-  measured_weight :total_weight, value_field_name: :custom_weight
-  measured_volume :volume, value_field_name: :custom_volume
-end
-```
-
-There are some simpler methods for predefined types:
-
-```ruby
-class Thing < ActiveRecord::Base
-  measured_weight :minimum_weight
-  measured_length :total_length
-  measured_volume :total_volume
-end
-```
-
-This will allow you to access and assign a measurement object:
-
-```ruby
-thing = Thing.new
-thing.minimum_weight = Measured::Weight.new(10, "g")
-thing.minimum_weight_unit     # "g"
-thing.minimum_weight_value    # 10
-```
-
-Order of assignment does not matter, and each property can be assigned separately and with mass assignment:
-
-```ruby
-params = { total_length_unit: "cm", total_length_value: "3" }
-thing = Thing.new(params)
-thing.total_length.to_s   # 3 cm
-```
-
-### Validations
-
-Validations are available:
-
-```ruby
-class Thing < ActiveRecord::Base
-  measured_length :total_length
-
-  validates :total_length, measured: true
-end
-```
-
-This will validate that the unit is defined on the measurement, and that there is a value.
-
-Rather than `true` the validation can accept a hash with the following options:
-
-* `message`: Override the default "is invalid" message.
-* `units`: A subset of units available for this measurement. Units must be in existing measurement.
-* `greater_than`
-* `greater_than_or_equal_to`
-* `equal_to`
-* `less_than`
-* `less_than_or_equal_to`
-
-All comparison validations require `Measured::Measurable` values, not scalars. Most of these options replace the `numericality` validator which compares the measurement/method name/proc to the column's value. Validations can also be combined with `presence` validator.
-
-**Note:** Validations are strongly recommended since assigning an invalid unit will cause the measurement to return `nil`, even if there is a value:
-
-```ruby
-thing = Thing.new
-thing.total_length_value = 1
-thing.total_length_unit = "invalid"
-thing.total_length  # nil
-```
-
-## Tests
-
-```
-$ bundle exec rake test
-```
-
-## Contributing
-
-1. Fork it ( https://github.com/Shopify/measured-rails/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
-## Authors
+## Original Authors
 
 * [Kevin McPhillips](https://github.com/kmcphillips) at [Shopify](http://shopify.com/careers)
 * [Sai Warang](https://github.com/cyprusad) at [Shopify](http://shopify.com/careers)

data/Rakefile

@@ -2,20 +2,13 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "measured/rails/version"
 
 task default: :test
 
-desc 'Run the test stuite'
+desc 'Run the test suite'
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.libs << "lib/**/*"
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
-
-task tag: :build do
-  system "git commit -m'Released version #{ Measured::VERSION }' --allow-empty"
-  system "git tag -a v#{ Measured::VERSION } -m 'Tagging #{ Measured::VERSION }'"
-  system "git push --tags"
-end

data/dev.yml

@@ -1,8 +1,7 @@
 name: measured-rails
 
 up:
-  - ruby:
-      version: 3.0.2
+  - ruby
   - bundler
 
 commands:

data/lib/measured-rails.rb

@@ -1,6 +1,3 @@
 # frozen_string_literal: true
-require "measured/rails/base"
 
-require "measured/rails/units/length"
-require "measured/rails/units/weight"
-require "measured/rails/units/volume"
+# don't define anything, this gem is a no-op

data/measured-rails.gemspec

@@ -1,11 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'measured/rails/version'
-
 Gem::Specification.new do |spec|
   spec.name          = "measured-rails"
-  spec.version       = Measured::Rails::VERSION
+  spec.version       = "3.0.0"
   spec.authors       = ["Kevin McPhillips"]
   spec.email         = ["gems@shopify.com"]
   spec.summary       = %q{Rails adaptor for measured}
@@ -26,16 +22,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "measured", Measured::Rails::VERSION
-
-  spec.add_runtime_dependency "railties", ">= 5.2"
-  spec.add_runtime_dependency "activemodel", ">= 5.2"
-  spec.add_runtime_dependency "activerecord", ">= 5.2"
+  spec.post_install_message = <<~MSG
+    Since version 3.0.0, the functionality of the `measured-rails` gem has been
+    merged into the `measured` gem. This gem will no longer be maintained. Please
+    remove the gem from your `Gemfile` and replace it with just the `measured` gem.
+  MSG
 
-  spec.add_development_dependency "rake", "> 10.0"
-  spec.add_development_dependency "minitest", "> 5.5.1"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "mocha", ">= 1.4.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "sqlite3"
+  spec.required_ruby_version = ">= 3.0"
 end

metadata

@@ -1,155 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: measured-rails
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: measured
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-- !ruby/object:Gem::Dependency
-  name: railties
-  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: activemodel
-  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: 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
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 5.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 5.5.1
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  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: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-04-19 00:00:00.000000000 Z
+dependencies: []
 description: Rails adapter for assigning and managing measurements with their units
   provided by the measured gem.
 email:
@@ -158,43 +18,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - dev.yml
-- gemfiles/rails-5.2.gemfile
-- gemfiles/rails-6.0.gemfile
-- gemfiles/rails-6.1.gemfile
-- gemfiles/rails-edge.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/thing_with_custom_value_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:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: |
+  Since version 3.0.0, the functionality of the `measured-rails` gem has been
+  merged into the `measured` gem. This gem will no longer be maintained. Please
+  remove the gem from your `Gemfile` and replace it with just the `measured` gem.
 rdoc_options: []
 require_paths:
 - lib
@@ -202,23 +46,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.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: Rails adaptor for measured
-test_files:
-- test/active_record_test.rb
-- test/support/models/thing.rb
-- test/support/models/thing_with_custom_unit_accessor.rb
-- test/support/models/thing_with_custom_value_accessor.rb
-- test/support/models/validated_thing.rb
-- test/support/schema.rb
-- test/test_helper.rb
-- test/validation_test.rb
+test_files: []

data/.github/workflows/ci.yml

@@ -1,38 +0,0 @@
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - '2.6'
-          - '2.7'
-          - '3.0'
-        gemfile:
-          - Gemfile
-          - gemfiles/rails-5.2.gemfile
-          - gemfiles/rails-6.0.gemfile
-          - gemfiles/rails-6.1.gemfile
-          - gemfiles/rails-edge.gemfile
-        exclude:
-          - ruby: '2.6'
-            gemfile: gemfiles/rails-edge.gemfile
-          - ruby: '3.0'
-            gemfile: gemfiles/rails-5.2.gemfile
-    name: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}
-    steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run tests
-        run: |
-          bundle exec rake

data/gemfiles/rails-5.2.gemfile

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

data/gemfiles/rails-6.0.gemfile

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

data/gemfiles/rails-6.1.gemfile

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

data/gemfiles/rails-edge.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', github: 'rails/rails', branch: 'main'

data/lib/measured/rails/active_record.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-module Measured::Rails::ActiveRecord
-  extend ActiveSupport::Concern
-
-  module ClassMethods
-    def measured(measured_class, *fields)
-      options = fields.extract_options!
-      options = {}.merge(options)
-
-      measured_class = measured_class.constantize if measured_class.is_a?(String)
-      unless measured_class.is_a?(Class) && measured_class.ancestors.include?(Measured::Measurable)
-        raise Measured::Rails::Error, "Expecting #{ measured_class } to be a subclass of Measured::Measurable"
-      end
-
-      options[:class] = measured_class
-
-      fields.map(&:to_sym).each do |field|
-        raise Measured::Rails::Error, "The field #{ field } has already been measured" if measured_fields.key?(field)
-
-        measured_fields[field] = options
-
-        unit_field_name = if options[:unit_field_name]
-          measured_fields[field][:unit_field_name] = options[:unit_field_name].to_s
-        else
-          "#{ field }_unit"
-        end
-
-        value_field_name = if options[:value_field_name]
-          measured_fields[field][:value_field_name] = options[:value_field_name].to_s
-        else
-          "#{ field }_value"
-        end
-
-        # Reader to retrieve measured object
-        define_method(field) do
-          value = public_send(value_field_name)
-          unit = public_send(unit_field_name)
-
-          return nil unless value && unit
-
-          instance = instance_variable_get("@measured_#{ field }") if instance_variable_defined?("@measured_#{ field }")
-          new_instance = begin
-            measured_class.new(value, unit)
-          rescue Measured::UnitError
-            nil
-          end
-
-          if instance == new_instance
-            instance
-          else
-            instance_variable_set("@measured_#{ field }", new_instance)
-          end
-        end
-
-        # Writer to assign measured object
-        define_method("#{ field }=") do |incoming|
-          if incoming.is_a?(measured_class)
-            instance_variable_set("@measured_#{ field }", incoming)
-            precision = self.column_for_attribute(value_field_name).precision
-            scale = self.column_for_attribute(value_field_name).scale
-            rounded_to_scale_value = incoming.value.round(scale)
-
-            max = self.class.measured_fields[field][:max_on_assignment]
-            if max && rounded_to_scale_value > max
-              rounded_to_scale_value = max
-            elsif rounded_to_scale_value.to_i.to_s.length > (precision - scale)
-              raise Measured::Rails::Error, "The value #{rounded_to_scale_value} being set for column '#{value_field_name}' has too many significant digits. Please ensure it has no more than #{precision - scale} significant digits."
-            end
-
-            public_send("#{ value_field_name }=", rounded_to_scale_value)
-            public_send("#{ unit_field_name }=", incoming.unit.name)
-          else
-            instance_variable_set("@measured_#{ field }", nil)
-            public_send("#{ value_field_name}=", nil)
-            public_send("#{ unit_field_name }=", nil)
-          end
-        end
-
-        # Writer to override unit assignment
-        redefine_method("#{ unit_field_name }=") do |incoming|
-          unit_name = measured_class.unit_system.unit_for(incoming).try!(:name)
-          write_attribute(unit_field_name, unit_name || incoming)
-        end
-      end
-    end
-
-    def measured_fields
-      @measured_fields ||= {}
-    end
-
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ::ActiveRecord::Base.send :include, Measured::Rails::ActiveRecord
-end