foraneus 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWMwYTU4OWRiZmI3YWMyYzVjYTc3OTc1YzJiOTUzZDM4YmU5YzZjNw==
-  data.tar.gz: !binary |-
-    Mjc1YzUwODZhMTRiZmFhNTcxZjljYTQ3YzY1Nzk3NDA3Y2YyOTkyZQ==
+SHA1:
+  metadata.gz: 9cc94a9dc63702c1d2b3c8cbfb61fb4df4c0184c
+  data.tar.gz: a17c6451c968d63a195d242c95633aa9a10430d2
 SHA512:
-  metadata.gz: !binary |-
-    MjY2MmFlYmQ2MzhlMzBhOWM0MTE0ZWQ1N2ZmZDI4MmVhMzkxMzA5Nzg0NmY4
-    MzM1YjJmNzNiNzQ0YWU4MTY4ZDcxNTkzNjMzZTdjMjY5ZTdiNDY4ODJlYjdh
-    YWRhOWZmNTY0NTBmMDhiMTIyNjk4ZTU4M2ZmODI2NjMwM2ZhZDM=
-  data.tar.gz: !binary |-
-    ZmRmZGI3NjFiODYzOGU1NDNjMGUwMTQ1NTkxODUzNGYwZmYzNzQxZWY0ZTY2
-    NjA4NjZmMjQxYTY5ZGJkNzQwOWYyMGYxN2UxNmVhYzgzYzQ5MzI4ZTZlNTA3
-    YTZhNTUyYWUwZjAwODE4YzBiZThkM2M3NWI1NWNkODg4YjAxMzk=
+  metadata.gz: 72d2b1d0693b01fe09d794b3cfc25f3316ff732e2df92fcfe5316645a5f6063c8c1e8fadae7b2827050297295d4c2c82415d16ce60c33b0a7fac56656ae179e8
+  data.tar.gz: 707019d7e8a43204dea773430eada124306bda384fcff69664b393ac4db9372379cfa11fc1cc61874bcc4e0436c1321d2539d29ab445670a0a75b43c594c102b

data/README.md

@@ -91,11 +91,13 @@ Converters have two interrelated responsibilities:
  - Parse data, like the string `"3,000"`, into an object, `like 3_000`.
  - Serialize data, like integer `3_000`, into string `"3,000"`
 
-A converter is simply an object that responds to `#parse(s)` and `#raw(v)` methods.
+A converter is simply an object that responds to `#parse(s)`, `#raw(v)`, and `#opts` methods.
 
 When `#parse(s)` raises a StandardError exception, or any of its descendants, the exception is
 rescued and a Foraneus::Error instance is added to `Foraneus#errors` map.
 
+`#opts` should return the opts hash used to instantiate the converter.
+
 Built-in converters:
 
  - Boolean

data/lib/foraneus/converters/boolean.rb

@@ -8,6 +8,12 @@ class Foraneus
     # When converting to a raw value, a true value => 'true', a false value => 'false'.
     class Boolean
 
+      attr_reader :opts
+
+      def initialize(opts = {})
+        @opts = opts
+      end
+
       # @return [Boolean]
       def parse(s)
         if s == 'true'

data/lib/foraneus/converters/date.rb

@@ -7,9 +7,12 @@ class Foraneus
 
       DEFAULT_FORMAT = '%Y-%m-%d'
 
+      attr_reader :opts
+
       # @param [Hash] opts
       # @option opts [String] format Date format.
       def initialize(opts = {})
+        @opts = opts
         @format = opts[:format] || DEFAULT_FORMAT
       end
 

data/lib/foraneus/converters/decimal.rb

@@ -1,34 +1,14 @@
 require 'bigdecimal'
+require 'foraneus/converters/float'
 
 class Foraneus
   module Converters
 
-    class Decimal
-      DEFAULT_SEPARATOR = '.'
-
-      DELIMITED_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/
-
-      # @param [Hash] opts
-      # @option opts [String] delimiter Thousands delimiter.
-      # @option opts [String] separator Decimal separator.
-      # @option opts [Integer] precision Minimum precision.
-      def initialize(opts = {})
-        @delimiter = opts[:delimiter]
-        @precision = opts[:precision]
-        @separator = opts[:separator] || DEFAULT_SEPARATOR
-      end
+    class Decimal < Foraneus::Converters::Float
 
       # @return [BigDecimal]
       def parse(s)
-        parts = s.split(@separator)
-
-        integer_part = (parts[0] || '0')
-
-        if @delimiter
-          integer_part.gsub!(@delimiter, '')
-        end
-
-        fractional_part = parts[1] || '0'
+        integer_part, fractional_part = split(s)
 
         BigDecimal.new("#{integer_part}.#{fractional_part}")
       end
@@ -36,15 +16,7 @@ class Foraneus
       def raw(v)
         left, right = v.to_s('F').split('.')
 
-        if @precision && right.length < @precision
-          right = add_trailing_zeros(right, @precision - right.length)
-        end
-
-        if @delimiter
-          left.gsub!(DELIMITED_REGEX) { "#{$1}#{@delimiter}" }
-        end
-
-        "#{left}#{@separator}#{right}"
+        join(left, right)
       end
 
       private

data/lib/foraneus/converters/float.rb

@@ -7,11 +7,15 @@ class Foraneus
 
       DELIMITED_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/
 
+      attr_reader :opts
+
       # @param [Hash] opts
       # @option opts [String] delimiter Thousands delimiter.
       # @option opts [String] separator Decimal separator.
       # @option opts [Integer] precision Minimum precision.
       def initialize(opts = {})
+        @opts = opts
+
         @delimiter = opts[:delimiter]
         @precision = opts[:precision]
         @separator = opts[:separator] || DEFAULT_SEPARATOR
@@ -19,19 +23,7 @@ class Foraneus
 
       # @return [Float]
       def parse(s)
-        if s == ''
-          raise ArgumentError, 'invalid value for Float(): ""'
-        end
-
-        parts = s.split(@separator)
-
-        integer_part = parts[0] || '0'
-
-        if @delimiter
-          integer_part.gsub!(@delimiter, '')
-        end
-
-        fractional_part = parts[1] || '0'
+        integer_part, fractional_part = split(s)
 
         Kernel.Float("#{integer_part}.#{fractional_part}")
       end
@@ -39,6 +31,19 @@ class Foraneus
       def raw(v)
         left, right = v.to_s.split('.')
 
+        join(left, right)
+      end
+
+      protected
+      # Joins both integer and fractional parts.
+      #
+      # It adds trailing zeros according to the current precision.
+      #
+      # @param [Integer] left Integer part
+      # @param [Integer] right Fractional part
+      #
+      # @return [String]
+      def join(left, right)
         if @precision && right.length < @precision
           right = add_trailing_zeros(right, @precision - right.length)
         end
@@ -50,6 +55,25 @@ class Foraneus
         "#{left}#{@separator}#{right}"
       end
 
+      # Splits a float representation into its integer and fractional parts.
+      #
+      # @param [String] s
+      #
+      # @return [Array [integer_part, fractional_part] ]
+      def split(s)
+        parts = s.split(@separator)
+
+        integer_part = parts[0] || '0'
+
+        if @delimiter
+          integer_part.gsub!(@delimiter, '')
+        end
+
+        fractional_part = parts[1] || '0'
+
+        [integer_part, fractional_part]
+      end
+
       private
       def add_trailing_zeros(s, n)
         zeros = '0' * n

data/lib/foraneus/converters/integer.rb

@@ -4,9 +4,12 @@ class Foraneus
     class Integer
       DELIMITED_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/
 
+      attr_reader :opts
+
       # @param [Hash] opts
       # @option opts [String] delimiter Thousands delimiter.
       def initialize(opts = {})
+        @opts = opts
         @delimiter = opts[:delimiter]
       end
 

data/lib/foraneus/converters/noop.rb

@@ -6,6 +6,12 @@ class Foraneus
     # It does not perform any conversion at all. Useful when its needed to have a field but
     # conversion is handled at another level.
     class Noop
+      attr_reader :opts
+
+      def initialize(opts = {})
+        @opts = opts
+      end
+
       # @return [Object]
       def parse(o)
         o

data/lib/foraneus/converters/string.rb

@@ -3,6 +3,12 @@ class Foraneus
 
     class String
 
+      attr_reader :opts
+
+      def initialize(opts = {})
+        @opts = opts
+      end
+
       # @return [String]
       def parse(s)
         s.to_s

data/lib/foraneus.rb

@@ -186,11 +186,15 @@ class Foraneus
     field = k.to_s
     converter = fields[field]
 
-    return unless converter
-
     foraneus[k] = v
 
-    unless v.nil?
+    return unless converter
+
+    if (v.nil? || v == '') && converter.opts[:required]
+      raise KeyError, "required parameter not found: #{field.inspect}"
+    elsif v.nil? || v == ''
+      v = nil
+    else
       v = converter.parse(v)
     end
 

data/spec/lib/foraneus/converters/float_converter_spec.rb

@@ -66,22 +66,6 @@ describe Foraneus::Converters::Float do
         }.to raise_error
       end
     end
-
-    context 'with empty values' do
-      it 'raises an error' do
-        expect {
-          subject.parse('')
-        }.to raise_error
-      end
-    end
-
-    context 'with nil values' do
-      it 'raises an error' do
-        expect {
-          subject.parse(nil)
-        }.to raise_error
-      end
-    end
   end
 
   describe '#raw' do

data/spec/lib/foraneus_spec.rb

@@ -16,9 +16,11 @@ describe Foraneus do
 
       its(:delay) { should eq(5) }
 
+      its(:data) { should include(:delay => 5) }
+
       its([:delay]) { should eq('5') }
 
-      its(:data) { should include(:delay => 5) }
+      its(['delay']) { should be_nil }
 
       its([]) { should include(:delay => '5') }
 
@@ -37,18 +39,6 @@ describe Foraneus do
 
         its([]) { should include('delay' => '5') }
       end
-
-      context 'with nil values' do
-        subject(:form) { form_spec.parse('delay' => nil) }
-
-        its(['delay']) { should eq(nil) }
-
-        its([:delay]) { should eq(nil) }
-
-        its(:data) { should include('delay' => nil) }
-
-        its([]) { should include('delay' => nil) }
-      end
     end
 
     context 'with non parseable data' do
@@ -80,6 +70,68 @@ describe Foraneus do
         its(:message) { should eq(converter_exception.message) }
       end
     end
+
+    context 'with unexpected data' do
+      subject(:form) { form_spec.parse(:position => 'north') }
+
+      it 'does not have a getter for the received param' do
+        expect {
+          form.position
+        }.to raise_error(NoMethodError)
+      end
+
+      its(:data) { should_not include(:position) }
+
+      its([:position]) { should eq('north') }
+
+      its([]) { should include(:position => 'north') }
+
+      it { should be_valid }
+    end
+
+    shared_examples 'an absent parameters handler' do |missing_value|
+      subject(:form) { form_spec.parse(:delay => missing_value) }
+
+      it { should be_valid }
+
+      its(:delay) { should be_nil }
+
+      its(:data) { should include(:delay => nil) }
+
+      its([:delay]) { should eq(missing_value) }
+
+      its([]) { should include(:delay => missing_value) }
+
+      context 'when required field' do
+        let(:converter) { Foraneus::Converters::Integer.new(:required => true) }
+
+        it { should_not be_valid }
+
+        its(:delay) { should be_nil }
+
+        its(:data) { should_not include(:delay) }
+
+        its([:delay]) { should eq(missing_value) }
+
+        its([]) { should include(:delay => missing_value) }
+
+        its([:errors]) { should include(:delay) }
+
+        describe 'an error' do
+          subject(:error) { form[:errors].values.first }
+
+          its(:key) { should eq('KeyError') }
+        end
+      end
+    end
+
+    context 'with nil values' do
+      it_behaves_like 'an absent parameters handler', nil
+    end
+
+    context 'with empty values' do
+      it_behaves_like 'an absent parameters handler', ''
+    end
   end
 
   describe '.raw' do

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: foraneus
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Gianfranco Zas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
+  name: yard-kramdown
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 description: Provides two way transformation mechanisms to external data.
 email: snmgian@gmail.com
 executables: []
@@ -70,6 +70,7 @@ files:
 - COPYING
 - COPYING.LESSER
 - README.md
+- spec/spec_helper.rb
 - spec/lib/foraneus_spec.rb
 - spec/lib/foraneus/converters/noop_converter_spec.rb
 - spec/lib/foraneus/converters/decimal_converter_spec.rb
@@ -78,32 +79,32 @@ files:
 - spec/lib/foraneus/converters/string_converter_spec.rb
 - spec/lib/foraneus/converters/float_converter_spec.rb
 - spec/lib/foraneus/converters/boolean_converter_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/snmgian/foraneus
 licenses:
 - LGPL
 metadata: {}
-post_install_message: 
+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.1.5
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Transforms external data.
 test_files:
+- spec/spec_helper.rb
 - spec/lib/foraneus_spec.rb
 - spec/lib/foraneus/converters/noop_converter_spec.rb
 - spec/lib/foraneus/converters/decimal_converter_spec.rb
@@ -112,5 +113,4 @@ test_files:
 - spec/lib/foraneus/converters/string_converter_spec.rb
 - spec/lib/foraneus/converters/float_converter_spec.rb
 - spec/lib/foraneus/converters/boolean_converter_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+has_rdoc: