sequel-units 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b04f1f3670f5c69a64727468e9061c00859c0de5
+  data.tar.gz: e551ec30fc463e77c51d8f6b0a5001f4243422b2
+SHA512:
+  metadata.gz: 1cf74fb1f20ec3b10410675d6fc43c752308311c960276acc4f71653fb540f04dd21f0df60fb00985c74e59e8789f66c63a6b187880bdf3863600e6bdb673a91
+  data.tar.gz: 5843bf27f62df539937a9b46d80f19cb2b913bac2e68cf66d1a7ba23cfcb22f0149ce53fad2377b72c0cd6b5663c7e3f0fa370842e6cbad6b479ea2e2c984a2a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akihiko Itoh
+
+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,48 @@
+# Sequel::Units
+
+Sequel plugin for working with numeric values with unit.
+
+## Basic usage
+
+Let's say you have a Sequel model `Product` which has a numeric attribute called `quantity` with unit (e.g. "10 kg").
+
+Your migration file would look like
+
+```ruby
+DB.create_table(:products) do
+  primary_key :id
+  column :quantity_scalar, Integer # "{attribute}_scalar" which stands for the scalar value ("10" in this case).
+  column :quantity_unit, String # "{attribute}_unit" which stands for the unit ("kg" in this case).
+end
+```
+
+Your model definition then looks like
+
+```ruby
+class Product < Sequel::Model
+  plugin :units
+  
+  value_with_unit :quantity
+end
+```
+
+Now instances of the model Product have an instance method `#quantity`.
+
+```ruby
+product = Product.new(quantity_scalar: 10, quantity_unit: 'kg')
+# => #<Product @values={:quantity_scalar=>10, :quantity_unit=>"kg"}>
+quantity = product.quantity
+# => 10 kg
+```
+
+Note `product.quantity` here is an instance of `RubyUnits::Unit`, so you can get the original scalar value or the unit 
+by calling methods `#scalar` or `#units`. 
+See [Ruby Units](https://github.com/olbrich/ruby-units) for more details.
+
+```ruby
+quantity.scalar
+# => 10
+quantity.units
+# => "kg"
+```
+

data/lib/sequel/plugins/units/class_methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sequel::Plugins::Units
+  module ClassMethods
+    def value_with_unit(method_name)
+      define_method method_name do
+        scalar = _validate_scalar(send("#{method_name}_scalar".to_sym))
+        unit = _validate_unit(send("#{method_name}_unit".to_sym))
+        Unit.new("#{scalar} #{unit}")
+      end
+    end
+  end
+end

data/lib/sequel/plugins/units/instance_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sequel::Plugins::Units
+  module InstanceMethods
+    private
+
+    def _validate_scalar(scalar)
+      raise ArgumentError, "#{scalar} is not a numeric value" unless scalar.is_a?(Numeric)
+      scalar
+    end
+
+    def _validate_unit(unit)
+      raise ArgumentError, "#{unit} is not a string" unless unit.is_a?(String)
+      unit
+    end
+  end
+end

data/lib/sequel/plugins/units.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'ruby-units'
+require_relative 'units/instance_methods'
+require_relative 'units/class_methods'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sequel-units
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akihiko Itoh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-units
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Sequel::Units provides a simple way to work with numeric values with
+  units in Sequel models.
+email:
+- akihiko.mus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sequel/plugins/units.rb
+- lib/sequel/plugins/units/class_methods.rb
+- lib/sequel/plugins/units/instance_methods.rb
+homepage: https://github.com/AkihikoITOH/sequel-units
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Sequel plugin for working with numeric values with unit
+test_files: []