measured-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95f2b762444dc351bf41886d19054fe2679893ae
+  data.tar.gz: 233c3ddf282c3b5a54be7df01ed11c9220682a6d
+SHA512:
+  metadata.gz: 4eed05964aa33c9319aa450b20a44976736e7be1db767a55a18aa1787484a78a6f8bf85514668047efa08fe4d585125029f6c175aff4ba6db2e07ff1f0bee6dc
+  data.tar.gz: 4f757002ed6692ab97feefd2d3b19be9093e6f74dfdfc470736b6d2323500a114cafc0c63734d28e4461cecc9a0f79d1835b82a6fba17b14adf14eae1e1178dc

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.log
+*.sqlite3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+install:
+  - gem uninstall bundler
+  - gem install bundler --version '1.8.4'
+  - bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in measured-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin McPhillips
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,120 @@
+# Measured Rails [![Build Status](https://travis-ci.org/Shopify/measured-rails.svg)](https://travis-ci.org/Shopify/measured-rails)
+
+This gem is the Rails integration for the [measured](https://github.com/Shopify/measured) gem.
+
+It provides ActiveRecord adapter for persisting and retrieving measurements with their units, and model validations.
+
+## 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:
+
+```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
+end
+```
+
+There are some simpler methods for predefined types:
+
+```ruby
+class Thing < ActiveRecord::Base
+  measured_weight :minimum_weight
+  measured_length :total_length
+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   # #<Measured::Length: 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.
+
+Validations can 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
+
+* [Kevin McPhillips](https://github.com/kmcphillips) at [Shopify](http://shopify.com/careers)

data/Rakefile

@@ -0,0 +1,21 @@
+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'
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "measured/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/measured-rails.rb

@@ -0,0 +1,4 @@
+require "measured/rails/base"
+
+require "measured/rails/units/length"
+require "measured/rails/units/weight"

data/lib/measured/rails/active_record.rb

@@ -0,0 +1,71 @@
+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)
+
+      raise Measured::Rails::Error, "Expecting #{ measured_class } to be a subclass of Measured::Measurable" if !measured_class.is_a?(Class) || !measured_class.ancestors.include?(Measured::Measurable)
+
+      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.keys.include?(field)
+        measured_fields[field] = options
+
+        # Reader to retrieve measured object
+        define_method(field) do
+          value = public_send("#{ field }_value")
+          unit = public_send("#{ field }_unit")
+
+          return nil unless value && unit
+
+          instance = instance_variable_get("@measured_#{ field }")
+          new_instance = begin
+            measured_class.new(value, unit)
+          rescue Measured::UnitError
+            nil
+          end
+
+          if instance && 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)
+            public_send("#{ field }_value=", incoming.value)
+            public_send("#{ field }_unit=", incoming.unit)
+          else
+            instance_variable_set("@measured_#{ field }", nil)
+            public_send("#{ field }_value=", nil)
+            public_send("#{ field }_unit=", nil)
+          end
+        end
+
+        # Writer to override unit assignment
+        define_method("#{ field }_unit=") do |incoming|
+          incoming = measured_class.conversion.to_unit_name(incoming) if measured_class.valid_unit?(incoming)
+          write_attribute("#{ field }_unit", 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

data/lib/measured/rails/base.rb

@@ -0,0 +1,17 @@
+require "measured/rails/version"
+require "measured"
+
+require "active_support"
+
+module Measured
+  module Rails
+    class Error < StandardError ; end
+  end
+end
+
+require "measured/rails/active_record"
+require "measured/rails/validations"
+
+if defined? Rails
+  require "measured/rails/railtie"
+end

data/lib/measured/rails/railtie.rb

@@ -0,0 +1,4 @@
+module Measured::Rails
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/measured/rails/units/length.rb

@@ -0,0 +1,13 @@
+module Measured::Rails::ActiveRecord::Length
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def measured_length(*fields)
+      measured(Measured::Length, *fields)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send :include, Measured::Rails::ActiveRecord::Length
+end

data/lib/measured/rails/units/weight.rb

@@ -0,0 +1,13 @@
+module Measured::Rails::ActiveRecord::Weight
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def measured_weight(*fields)
+      measured(Measured::Weight, *fields)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send :include, Measured::Rails::ActiveRecord::Weight
+end

data/lib/measured/rails/validations.rb

@@ -0,0 +1,18 @@
+class MeasuredValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, measurable)
+    measured_config = record.class.measured_fields[attribute]
+
+    measured_class = measured_config[:class]
+    measurable_unit = record.send("#{ attribute }_unit")
+    measurable_value = record.send("#{ attribute }_value")
+
+    message = options[:message] || "is not a valid unit"
+
+    if options[:units]
+      valid_units = [options[:units]].flatten.map{|u| measured_class.conversion.to_unit_name(u) }
+      record.errors.add(attribute, message) unless valid_units.include?(measured_class.conversion.to_unit_name(measurable_unit))
+    end
+
+    record.errors.add(attribute, message) unless measured_class.valid_unit?(measurable_unit)
+  end
+end

data/lib/measured/rails/version.rb

@@ -0,0 +1,5 @@
+module Measured
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/measured-rails.gemspec

@@ -0,0 +1,30 @@
+# 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.authors       = ["Kevin McPhillips"]
+  spec.email         = ["github@kevinmcphillips.ca"]
+  spec.summary       = %q{Rails adaptor for measured}
+  spec.description   = %q{Rails adapter for assigning and managing measurements with their units provided by the measured gem.}
+  spec.homepage      = "https://github.com/Shopify/measured-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", ">= 4.0"
+  spec.add_runtime_dependency "measured", "0.0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.1"
+  spec.add_development_dependency "mocha", "~> 1.1.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sqlite3"
+end

data/repodb.yml

@@ -0,0 +1,3 @@
+classification: library
+ci_urls:
+  - https://travis-ci.org/Shopify/measured-rails

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: measured-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin McPhillips
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: measured
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.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'
+description: Rails adapter for assigning and managing measurements with their units
+  provided by the measured gem.
+email:
+- github@kevinmcphillips.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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/weight.rb
+- lib/measured/rails/validations.rb
+- lib/measured/rails/version.rb
+- measured-rails.gemspec
+- repodb.yml
+homepage: https://github.com/Shopify/measured-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails adaptor for measured
+test_files: []