much-decimal 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 8327ce133aaff24d5e5e1a64b0a9b1ff0d36a6e8
-  data.tar.gz: aa9bbbbcb110c82ef27f3568b8b2aa85e4c930e7
+  data.tar.gz: 617e4bc9765ffab1e22828a378f130a2b324324b
+  metadata.gz: d6a848633d4d805c2bb72fd67d05c21b2f4cf02e
 SHA512: 
-  metadata.gz: af8fc04ea539ed937a76d862a1ee3502e20ca11124ef8711761124d832de0612428cb34f2dbe59be0a79c719c5ffdaca79555f07dc664c1a10d44afdad031de0
-  data.tar.gz: e4249e91a04087fa035c156c2f339b0a8a25eb418a22eba1434c7468a33632c2f406bd5dca1e3b312ff9bcfe348a940fa40cffe209da86243c6dd2a930653b8c
+  data.tar.gz: 4a824dfd66b88e3590ee928bf3e43c6032af340d67161376173e72faf26ce6c6aa906002b6a1180d2632449c16ae4c21af18e469c6bf8f9c862cdcac18a235a1
+  metadata.gz: 6502e2327e568bf68a1f4623fa0dc958f677df0288f5ed26f068a330cfb85ad47c3df25e680919fc78c3563cde68c240f3ad80ea5862d8f24149a8ce9f66f84b

data/lib/much-decimal.rb

@@ -1,5 +1,77 @@
-require "much-decimal/version"
+require 'much-plugin'
+
+require 'much-decimal/version'
 
 module MuchDecimal
+  include MuchPlugin
+
+  DEFAULT_PRECISION = 2.freeze
+
+  def self.integer_to_decimal(integer, precision)
+    if integer.respond_to?(:to_i) && !integer.to_s.empty?
+      base_10_modifier = (10.0 ** precision)
+      integer.to_i / base_10_modifier
+    end
+  end
+
+  def self.decimal_to_integer(decimal, precision)
+    if decimal.respond_to?(:to_f) && !decimal.to_s.empty?
+      base_10_modifier = (10.0 ** precision)
+      (decimal.to_f * base_10_modifier).round.to_i
+    end
+  end
+
+  plugin_included do
+    extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def decimal_as_integer(attribute, options = nil)
+      options ||= {}
+      source    = options[:source] || "#{attribute}_as_integer"
+      precision = (options[:precision] || DEFAULT_PRECISION).to_i
+
+      define_method(attribute) do
+        integer = self.send(source)
+        MuchDecimal.integer_to_decimal(integer, precision)
+      end
+
+      define_method("#{attribute}=") do |decimal|
+        integer = MuchDecimal.decimal_to_integer(decimal, precision)
+        self.send("#{source}=", integer)
+      end
+    end
+
+  end
+
+  module TestHelpers
+    include MuchPlugin
+
+    plugin_included do
+      include InstanceMethods
+
+      require 'assert/factory'
+    end
+
+    module InstanceMethods
+
+      def assert_decimal_as_integer(subject, attribute, options = nil)
+        options ||= {}
+        source    = options[:source] || "#{attribute}_as_integer"
+        precision = (options[:precision] || DEFAULT_PRECISION).to_i
+
+        value = Assert::Factory.float
+        subject.send("#{attribute}=", value)
+
+        exp = MuchDecimal.decimal_to_integer(value, precision)
+        assert_equal exp, subject.send(source)
+        exp = MuchDecimal.integer_to_decimal(exp, precision)
+        assert_equal exp, subject.send(attribute)
+      end
+
+    end
+
+  end
 
 end

data/lib/much-decimal/version.rb

@@ -1,3 +1,3 @@
 module MuchDecimal
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/much-decimal.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency("assert", ["~> 2.16.1"])
-  # TODO: gem.add_dependency("gem-name", ["~> 0.0.0"])
+
+  gem.add_dependency('much-plugin', ["~> 0.1.1"])
 
 end

data/test/unit/much_decimal_tests.rb

@@ -0,0 +1,220 @@
+require 'assert'
+require 'much-decimal'
+
+module MuchDecimal
+
+  class UnitTests < Assert::Context
+    desc "MuchDecimal"
+    setup do
+      @module = MuchDecimal
+    end
+    subject{ @module }
+
+    should have_imeths :integer_to_decimal, :decimal_to_integer
+
+    should "use much-plugin" do
+      assert_includes MuchPlugin, subject
+    end
+
+    should "know its default precision" do
+      assert_equal 2, DEFAULT_PRECISION
+    end
+
+    should "know how to convert an integer to a decimal" do
+      integer          = Factory.integer
+      precision        = Factory.integer(10)
+      base_10_modifier = (10.0 ** precision)
+
+      exp = integer / base_10_modifier
+      assert_equal exp, subject.integer_to_decimal(integer,      precision)
+      assert_equal exp, subject.integer_to_decimal(integer.to_s, precision)
+
+      invalid_value = [nil, '', true, false].sample
+      assert_nil subject.integer_to_decimal(invalid_value, precision)
+    end
+
+    should "know how to convert a decimal to an integer" do
+      decimal          = Factory.float
+      precision        = Factory.integer(10)
+      base_10_modifier = (10.0 ** precision)
+
+      exp = (decimal * base_10_modifier).round.to_i
+      assert_equal exp, subject.decimal_to_integer(decimal,      precision)
+      assert_equal exp, subject.decimal_to_integer(decimal.to_s, precision)
+
+      invalid_value = [nil, '', true, false].sample
+      assert_nil subject.decimal_to_integer(invalid_value, precision)
+    end
+
+  end
+
+  class MixinSetupTests < UnitTests
+    setup do
+      @class = Class.new do
+        include MuchDecimal
+        attr_accessor :seconds_as_integer, :integer_seconds
+      end
+    end
+    subject{ @class }
+
+  end
+
+  class MixinTests < MixinSetupTests
+    desc "when mixed in"
+
+    should have_imeths :decimal_as_integer
+
+    should "add a decimal-as-integer accessor using `decimal_as_integer`" do
+      subject.decimal_as_integer :seconds
+
+      instance = subject.new
+      assert_respond_to :seconds,  instance
+      assert_respond_to :seconds=, instance
+
+      decimal = Factory.float
+      integer = Factory.integer
+
+      instance.seconds = decimal
+      exp = @module.decimal_to_integer(decimal, DEFAULT_PRECISION)
+      assert_equal exp, instance.seconds_as_integer
+
+      instance.seconds_as_integer = integer
+      exp = @module.integer_to_decimal(integer, DEFAULT_PRECISION)
+      assert_equal exp, instance.seconds
+    end
+
+    should "allow specifying custom options using `decimal_as_integer`" do
+      source    = :integer_seconds
+      precision = Factory.integer(5)
+      subject.decimal_as_integer :seconds, {
+        :source    => source,
+        :precision => precision
+      }
+
+      instance = subject.new
+      assert_respond_to :seconds,  instance
+      assert_respond_to :seconds=, instance
+
+      decimal = Factory.float
+      integer = Factory.integer
+
+      instance.seconds = decimal
+      exp = @module.decimal_to_integer(decimal, precision)
+      assert_equal exp, instance.send(source)
+
+      instance.send("#{source}=", integer)
+      exp = @module.integer_to_decimal(integer, precision)
+      assert_equal exp, instance.seconds
+    end
+
+  end
+
+  class EdgeCaseTests < UnitTests
+    desc "edge cases"
+    setup do
+      @class = Class.new do
+        include MuchDecimal
+
+        attr_accessor :ten_thousandth_seconds
+
+        decimal_as_integer(:seconds, {
+          :source    => :ten_thousandth_seconds,
+          :precision => 4
+        })
+      end
+      @instance = @class.new
+    end
+    subject{ @instance }
+
+    should "allow writing and reading `nil` values" do
+      assert_nil subject.ten_thousandth_seconds
+      assert_nil subject.seconds
+
+      subject.seconds = 1.2345
+      assert_equal 12345,  subject.ten_thousandth_seconds
+      assert_equal 1.2345, subject.seconds
+
+      assert_nothing_raised{ subject.seconds = nil }
+      assert_nil subject.seconds
+      assert_nil subject.ten_thousandth_seconds
+    end
+
+    should "write empty string values as `nil` values" do
+      subject.seconds = 1.2345
+      assert_not_nil subject.ten_thousandth_seconds
+      assert_not_nil subject.seconds
+
+      assert_nothing_raised{ subject.seconds = '' }
+      assert_nil subject.seconds
+      assert_nil subject.ten_thousandth_seconds
+    end
+
+    should "write values that can't be converted as `nil` values" do
+      subject.seconds = 1.2345
+      assert_not_nil subject.ten_thousandth_seconds
+      assert_not_nil subject.seconds
+
+      assert_nothing_raised{ subject.seconds = true }
+      assert_nil subject.seconds
+      assert_nil subject.ten_thousandth_seconds
+    end
+
+    should "handle decimals with less significant digits" do
+      subject.seconds = 1.12
+      assert_equal 11200, subject.ten_thousandth_seconds
+      assert_equal 1.12,  subject.seconds
+    end
+
+    should "handle integers" do
+      subject.seconds = 5
+      assert_equal 50000, subject.ten_thousandth_seconds
+      assert_equal 5.0,   subject.seconds
+    end
+
+    should "handle decimals that are less than 1" do
+      subject.seconds = 0.0001
+      assert_equal 1,      subject.ten_thousandth_seconds
+      assert_equal 0.0001, subject.seconds
+    end
+
+    should "handle decimals with too many significant digits by rounding" do
+      subject.seconds = 1.00005
+      assert_equal 10001,  subject.ten_thousandth_seconds
+      assert_equal 1.0001, subject.seconds
+    end
+
+    should "handle repeating decimals" do
+      subject.seconds = 1 / 3.0
+      assert_equal 3333,   subject.ten_thousandth_seconds
+      assert_equal 0.3333, subject.seconds
+    end
+
+  end
+
+  class TestHelpersTests < MixinSetupTests
+    include MuchDecimal::TestHelpers
+
+    desc "TestHelpers"
+    setup do
+      @class.decimal_as_integer :seconds
+      @custom_precision = Factory.integer(10)
+      @class.decimal_as_integer :other_seconds, {
+        :source    => :integer_seconds,
+        :precision => @custom_precision
+      }
+
+      @instance = @class.new
+    end
+    subject{ @instance }
+
+    should "provide helpers for testing that a class has json fields" do
+      assert_decimal_as_integer subject, :seconds
+      assert_decimal_as_integer subject, :other_seconds, {
+        :source    => :integer_seconds,
+        :precision => @custom_precision
+      }
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: much-decimal
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-06-06 00:00:00 Z
+date: 2016-06-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -22,6 +22,16 @@ dependencies:
         version: 2.16.1
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: much-plugin
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id002
 description: Define decimal attributes that are stored as integers
 email: 
 - kelly@kellyredding.com
@@ -43,6 +53,7 @@ files:
 - much-decimal.gemspec
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much_decimal_tests.rb
 - tmp/.gitkeep
 homepage: https://github.com/redding/much-decimal
 licenses: 
@@ -56,20 +67,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - &id002 
+  - &id003 
     - ">="
     - !ruby/object:Gem::Version 
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - *id002
+  - *id003
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Define decimal attributes that are stored as integers
 test_files: 
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much_decimal_tests.rb