foraneus 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 6a1af4481bfbdeb0cc0aa78900c6b7f4512d7a21
-  data.tar.gz: 58cd1c7f084558def0575754919263b6763ba17a
-SHA512: 
-  metadata.gz: 093a3fdc5eecea2934cd2ef01c88191bcf62fe317f61ed73519d8a77b4afcadd2ff96b5af17d4e5337e43da96bdd325861b6f94ca53d0a6642db6ffaf0aa5a03
-  data.tar.gz: cbf2a485c1df7a4da036256ea27f6a8097f7433cb8b4bcd3e5c922e1ef985b2003ed6a5e442f3755af1f89a66da393efd6c80f314787f54c6d9767223304fd1f
+---
+SHA1:
+  metadata.gz: d581bebcc546182ffb84546ff4fb8ad667ee126f
+  data.tar.gz: 241b1dfc78a1837a6ec6404904ab1a4b1f6d3125
+SHA512:
+  metadata.gz: 457b8493632fb86f01ea610b164f05df68c0f85f156ab26d3c7fe98ee62a2262c9a2281dd037f636ffb31fac42b49f68ad66386dcd264db5023134d9ef0fbe15
+  data.tar.gz: 4c668906d942e090e563b7ec8a8241c4cfa1cb42096bad58146c168aca89672cdd82b1a92c99896fd8bcf7af7c354d5a9e525fb7a32122f9900103fc4060d52d

data/lib/foraneus.rb

@@ -10,13 +10,14 @@ require 'foraneus/converters/integer'
 require 'foraneus/converters/noop'
 require 'foraneus/converters/string'
 require 'foraneus/errors'
+require 'foraneus/utils'
 
 # Foraneus base class used to declare a data set, aka 'form'.
 class Foraneus
 
   # @api private
   def initialize
-    @_ = {}
+    @_ = {} # Hash that holds external representation data
   end
 
   # Declares a boolean field.
@@ -99,6 +100,11 @@ class Foraneus
     @fields ||= {}
   end
 
+  # Return the names of data and error accessors
+  #
+  # Returned hash contains the keys :data and :errors, where values are the proper accesor names
+  #
+  # @return [Hash]
   def self.accessors
     @accessors ||= {
       :data => :data,
@@ -106,11 +112,14 @@ class Foraneus
     }
   end
 
+  # Create a new instance while setting up data and error accessors
+  #
+  # @return [Foraneus]
   def self.create_instance
     instance = self.new
 
-    __singleton_attr_reader(instance, :data, {})
-    __singleton_attr_reader(instance, :errors, {})
+    Utils.singleton_attr_accessor(instance, :data, {})
+    Utils.singleton_attr_accessor(instance, :errors, {})
 
     instance
   end
@@ -122,24 +131,12 @@ class Foraneus
   # @return [Foraneus] An instance of a form.
   def self.parse(data = {})
     instance = self.create_instance
+    data = data.dup
 
-    parsed_keys = []
+    instance.instance_variable_set(:@_, data.dup)
 
     fields.each do |field, converter|
-      given_key = field
-      v = data.fetch(given_key) do
-        given_key = field.to_sym
-        data.fetch(given_key, nil)
-      end
-
-      parsed_keys << given_key
-      __parse_raw_datum(given_key, v, instance, converter)
-    end
-
-    data.each do |k, v|
-      unless parsed_keys.include?(k)
-        instance[k] = v
-      end
+      __parse_field(data, field, converter, instance)
     end
 
     instance
@@ -152,16 +149,12 @@ class Foraneus
   # @return [Foraneus] An instance of a form.
   def self.raw(data = {})
     instance = self.create_instance
+    data = data.dup
 
-    fields.each do |field, converter|
-      given_key = field
-
-      v = data.fetch(given_key) do
-        given_key = field.to_sym
-        data.fetch(given_key, nil)
-      end
+    instance.send("#{self.accessors[:data]}=", data)
 
-      __raw_datum(given_key, v, instance, converter)
+    fields.each do |field, converter|
+      __raw_field(data, field, converter, instance)
     end
 
     instance
@@ -174,8 +167,8 @@ class Foraneus
     if m.nil?
       @_
     else
-      @_.fetch(m) do
-        @_[m.to_s]
+      @_.fetch(m.to_s) do
+        @_[m.to_sym]
       end
     end
   end
@@ -198,100 +191,33 @@ class Foraneus
     @errors.empty?
   end
 
-  # @api private
-  #
-  # Parses a value and assigns it to the corresponding field.
-  #
-  # It also registers errors if the conversion fails.
-  #
-  # @param [String, Symbol] k
-  # @param [String] v
-  # @param [Foraneus] foraneus
-  # @param [Converter] converter
-  def self.__parse_raw_datum(k, v, foraneus, converter)
-    field = k.to_s
-
-    foraneus[k] = v
-
-    v = __parse(k, v, converter)
+  def self.__parse_field(data, field, converter, instance)
+    s, is_present = Utils.fetch(data, field)
 
-    foraneus.send("#{field}=", v)
-    foraneus.send(self.accessors[:data])[k] = v
+    v, error = Utils.parse_datum(field, s, converter)
 
-  rescue
-    error = Foraneus::Error.new($!.class.name, $!.message)
-    foraneus.send(self.accessors[:errors])[k] = error
-  end
-  private_class_method :__parse_raw_datum
-
-  # @api private
-  #
-  # Parses a raw value.
-  #
-  # @param [String, Symbol] field
-  # @param [String] v Raw value.
-  # @param converter
-  #
-  # @raise [KeyError] if converter requires a value but no one is given.
-  #
-  # @return [Object]
-  def self.__parse(field, v, converter)
-    if v == '' && converter.opts.fetch(:blanks_as_nil, true)
-      v = nil
+    unless error
+      instance.send("#{field}=", v)
+      instance.send(self.accessors[:data])[field.to_sym] = v if is_present || converter.opts.include?(:default)
     end
 
-    if v.nil? && converter.opts[:required]
-      raise KeyError, "required parameter not found: #{field.inspect}"
-    elsif v.nil?
-      converter.opts[:default]
-    else
-      converter.parse(v)
-    end
+    instance.send(self.accessors[:errors])[field.to_sym] = error if error
   end
-  private_class_method :__parse
+  private_class_method :__parse_field
 
-  # @api private
-  #
-  # Obtains a raw representation of a value and assigns it to the corresponding field.
-  #
-  # It also registers errors if the conversion fails.
-  #
-  # @param [String, Symbol] k
-  # @param [String] v
-  # @param [Foraneus] foraneus
-  # @param [Converter] converter
-  def self.__raw_datum(k, v, foraneus, converter)
-    foraneus.send("#{k}=", v)
+  def self.__raw_field(data, field, converter, instance)
+    v, is_present = Utils.fetch(data, field)
+
+    instance.send("#{field}=", v)
 
     if v.nil?
       v = converter.opts[:default]
     end
 
-    s = unless v.nil?
-      converter.raw(v)
-    end
-
-    foraneus[k] = s
-    foraneus.send(self.accessors[:data])[k] = v
-  end
-  private_class_method :__raw_datum
-
-  # @api private
-  #
-  # Creates a singleton attribute reader on an instance.
-  #
-  # @param [Foraneus] instance
-  # @param [Symbol] attribute
-  # @param initial_value
-  def self.__singleton_attr_reader(instance, attribute, initial_value = nil)
-    spec = instance.class
+    s = Utils.raw_datum(v, converter)
 
-    instance.singleton_class.send(:attr_reader, spec.accessors[attribute])
-
-    instance.instance_exec do
-      instance.instance_variable_set(:"@#{spec.accessors[attribute]}", initial_value)
-    end
+    instance[field.to_sym] = s if is_present || converter.opts.include?(:default)
   end
-  private_class_method :__singleton_attr_reader
+  private_class_method :__raw_field
 
 end

data/lib/foraneus/utils.rb

@@ -0,0 +1,86 @@
+class Foraneus
+  module Utils
+
+    # Return the value of a key in the given hash and flag indicating whether the keys exists or not
+    #
+    # If the given key is not present then tries fetching key#to_sym
+    #
+    # @param [Hash] data
+    # @param [String] field
+    #
+    # @return [Object, Boolean]
+    def self.fetch(hash, key)
+      v = nil
+      is_present = true
+
+      v = hash.fetch(key) do
+        hash.fetch(key.to_sym) do
+          is_present = false
+          nil
+        end
+      end
+
+      [v, is_present]
+    end
+
+    # Parses a raw value.
+    #
+    # @param [String, Symbol] field
+    # @param [String] s Raw value.
+    # @param converter
+    #
+    # @raise [KeyError] if converter requires a value but no one is given.
+    #
+    # @return [Object, nil] when parsing succeeds
+    # @return [nil, Foraneus::Error] when parsing fails
+    def self.parse_datum(field, s, converter)
+      if s == '' && converter.opts.fetch(:blanks_as_nil, true)
+        s = nil
+      end
+
+      if s.nil? && converter.opts[:required]
+        raise KeyError, "required parameter not found: #{field.inspect}"
+      end
+
+      result = if s.nil?
+        converter.opts[:default]
+
+      else
+        converter.parse(s)
+      end
+
+      [result, nil]
+
+    rescue
+      error = Foraneus::Error.new($!.class.name, $!.message)
+
+      [nil, error]
+    end
+
+    # Obtains a raw representation of a value and assigns it to the corresponding field.
+    #
+    # @param [Object] v
+    # @param [Converter] converter
+    #
+    # @return [String]
+    def self.raw_datum(v, converter)
+      converter.raw(v) unless v.nil?
+    end
+
+    # Creates a singleton attribute accessor on an instance.
+    #
+    # @param [Foraneus] instance
+    # @param [Symbol] attribute
+    # @param initial_value
+    def self.singleton_attr_accessor(instance, attribute, initial_value = nil)
+      spec = instance.class
+
+      instance.singleton_class.send(:attr_accessor, spec.accessors[attribute])
+
+      instance.instance_exec do
+        instance.instance_variable_set(:"@#{spec.accessors[attribute]}", initial_value)
+      end
+    end
+
+  end
+end

data/spec/lib/foraneus_spec.rb

@@ -82,9 +82,10 @@ describe Foraneus do
 
         assert_equal 5, subject.delay
         assert_equal 5, subject.data[:delay]
+        assert_equal({ :delay => 5 }, subject.data)
 
         assert_equal '5', subject[:delay]
-        assert_nil subject['delay']
+        assert_equal '5', subject['delay']
         assert_equal({ :delay => '5' }, subject[])
 
         assert subject.valid?
@@ -98,7 +99,8 @@ describe Foraneus do
         it 'parses given data' do
           assert_equal '5', subject['delay']
           assert_equal '5', subject[:delay]
-          assert_equal 5, subject.data['delay']
+
+          assert_equal({ :delay => 5 }, subject.data)
 
           assert_equal({ 'delay' => '5' }, subject[])
         end
@@ -267,11 +269,7 @@ describe Foraneus do
 
           assert_equal 1, subject.delay
 
-          assert_equal 1, subject.data[:delay]
-
-          assert_nil subject[:delay]
-
-          assert_nil subject[][:delay]
+          assert_equal({ :delay => 1}, subject.data)
 
           refute subject.errors.include?(:delay)
         end
@@ -289,6 +287,21 @@ describe Foraneus do
             assert_nil subject[:delay]
           end
         end
+
+        describe 'when missing optional field' do
+          let(:converter) { Foraneus::Converters::Integer.new(:required => false) }
+
+          subject { form_spec.parse }
+
+          it 'parses' do
+            assert subject.valid?
+
+            assert_nil subject.delay
+            refute_includes subject.data, :delay
+
+            refute_includes subject[], :delay
+          end
+        end
       end
     end
   end
@@ -303,7 +316,7 @@ describe Foraneus do
 
       assert_equal '5', subject[:delay]
 
-      assert_equal '5', subject[][:delay]
+      assert_equal({ :delay => '5' }, subject[])
 
       assert subject.valid?
 
@@ -320,7 +333,7 @@ describe Foraneus do
 
         assert_equal '5', subject[:delay]
 
-        assert_equal '5', subject[]['delay']
+        assert_equal({ :delay => '5' }, subject[])
 
         assert subject.valid?
 
@@ -349,11 +362,22 @@ describe Foraneus do
 
       it 'parses' do
         assert_nil subject.delay
+        refute_includes subject.data, :delay
 
         assert_equal '1', subject[:delay]
         assert_equal '1', subject[][:delay]
       end
     end
-  end
 
+    describe 'with absent values' do
+      subject { form_spec.raw }
+
+      it 'parses' do
+        assert_nil subject.delay
+
+        assert_equal({}, subject.data)
+        assert_equal({}, subject[])
+      end
+    end
+  end
 end

metadata

@@ -1,52 +1,63 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: foraneus
-version: !ruby/object:Gem::Version 
-  version: 0.0.14
+version: !ruby/object:Gem::Version
+  version: 0.0.15
 platform: ruby
-authors: 
+authors:
 - Gianfranco Zas
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-12-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: kramdown
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides two way transformation mechanisms to external data.
 email: snmgian@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - COPYING
 - COPYING.LESSER
 - README.md
@@ -60,6 +71,7 @@ files:
 - lib/foraneus/converters/noop.rb
 - lib/foraneus/converters/string.rb
 - lib/foraneus/errors.rb
+- lib/foraneus/utils.rb
 - spec/lib/foraneus/converters/boolean_converter_spec.rb
 - spec/lib/foraneus/converters/date_converter_spec.rb
 - spec/lib/foraneus/converters/decimal_converter_spec.rb
@@ -70,42 +82,38 @@ files:
 - spec/lib/foraneus_spec.rb
 - spec/runner.rb
 - spec/spec_helper.rb
-- spec/spec_helper_its.rb
 homepage: https://github.com/snmgian/foraneus
-licenses: 
+licenses:
 - LGPL
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Transforms external data.
-test_files: 
-- spec/lib/foraneus_spec.rb
+test_files:
+- spec/lib/foraneus/converters/float_converter_spec.rb
 - spec/lib/foraneus/converters/noop_converter_spec.rb
-- spec/lib/foraneus/converters/decimal_converter_spec.rb
 - spec/lib/foraneus/converters/date_converter_spec.rb
+- spec/lib/foraneus/converters/decimal_converter_spec.rb
 - spec/lib/foraneus/converters/integer_converter_spec.rb
-- 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
-- spec/spec_helper_its.rb
+- spec/lib/foraneus/converters/string_converter_spec.rb
+- spec/lib/foraneus_spec.rb
 - spec/runner.rb
-has_rdoc: 
+- spec/spec_helper.rb

data/spec/spec_helper_its.rb

@@ -1,42 +0,0 @@
-
-require 'minitest/autorun'
-require 'minitest/spec'
-require 'minitest/unit'
-
-require 'foraneus'
-
-module MiniTest
-  class Spec
-    #module
-
-      def self.its(getter, &block)
-        block ||= proc { skip "(no tests defined)" }
-
-        @specs ||= 0
-        @specs += 1
-
-        name = "test_%04d_%s" % [ @specs, getter ]
-
-        define_method(name) {
-          #&block
-          case getter
-          when Symbol, String
-            expression = subject.public_send(getter)
-          when Array
-            expression = subject[*getter]
-          end
-
-          expression.instance_exec &block
-        }
-
-        self.children.each do |mod|
-          mod.send :undef_method, name if mod.public_method_defined? name
-        end
-
-        name
-      end
-
-    #end
-  end
-end
-