lazy_mapper 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc96addc98f7d62a27df00a602599d7ea6d20ba9deb7f673e7ac3a4f4d65035f
-  data.tar.gz: ecf6e0704b94222ecde509b6a12c4493e971065ed065e709d335ee35d4d33f2f
+  metadata.gz: 9fc03c578aa1fc21f450802874c88cacfd78512e963d8dd840c59a3258bb18cf
+  data.tar.gz: 6566aec14a6fd1c00eac05f3e5c973c5a48628e086c2631641c426426240bd97
 SHA512:
-  metadata.gz: 632309a3f02d26685fbd352e237f713a4e5e16faa7d0eaa16e25233a789f8d8f39ac88eefb77c009d269e12eadfd62666c05c2b25a5b9da2cd05162c66ace7c1
-  data.tar.gz: 39d1a63b02163c110950da5b3f399079c0f39d2e7b19aef4df97b63e173a7b6f1375fa7dcd5aa0c61f2c4ef3b8c87549e4d68bdb747979329dcbd47c440dec51
+  metadata.gz: 8ef3c23e999803cae1da99eeb44cc6185be584507e32f1cf2ba827fe218d09ee9ff3d7d891b3647fa8bb71500d8208d0fbc868af7d72c1c3fc4b748ac6a01d2a
+  data.tar.gz: abd2639ae80601c08b13a861e9d76ae7271e3da5d93f1027e81f4623f681614b6c8fadaed0bb22ef54ffb4806eb81b7e09e54a5e494f78ca43af5ea53bb58ef1

data/.gitignore

@@ -5,6 +5,7 @@ vendor/bundle
 bin/
 log/
 tmp/
+doc/
 .idea/
 Gemfile.lock
 *.gem

data/README.md

@@ -13,6 +13,10 @@ Example:
       many :users, User, map: ->(u) { User.new(u) }
     end
 
+## Documentation
+
+See [RubyDoc](https://www.rubydoc.info/gems/lazy_mapper/LazyMapper)
+
 ## License
 
-See `LICENSE` file.
+See [LICENSE](./LICENSE) file.

data/lazy_mapper.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lazy_mapper'
-  spec.version       = '0.2.0'
+  spec.version       = '0.2.1'
   spec.summary       = "A lazy object mapper"
   spec.description   = "Wraps primitive data in a semantically rich model"
   spec.authors       = ["Adam Lett"]

data/lib/lazy_mapper.rb

@@ -2,7 +2,7 @@ require 'bigdecimal'
 require 'bigdecimal/util'
 require 'time'
 
-##
+#
 # Wraps a JSON object and lazily maps its attributes to domain objects
 # using either a set of default mappers (for Ruby's built-in types), or
 # custom mappers specified by the client.
@@ -20,20 +20,25 @@ require 'time'
 
 class LazyMapper
 
+  #
   # Default mappings for built-in types
+  #
   DEFAULT_MAPPINGS = {
-    Object     => ->(o) { o },
-    String     => ->(s) { s.to_s },
-    Integer    => ->(i) { i.to_i },
-    BigDecimal => ->(d) { d.to_d },
-    Float      => ->(f) { f.to_f },
-    Symbol     => ->(s) { s.to_sym },
-    Hash       => ->(h) { h.to_h },
+    Object     => :itself.to_proc,
+    String     => :to_s.to_proc,
+    Integer    => :to_i.to_proc,
+    BigDecimal => :to_d.to_proc,
+    Float      => :to_f.to_proc,
+    Symbol     => :to_sym.to_proc,
+    Hash       => :to_h.to_proc,
     Time       => Time.method(:iso8601),
     Date       => Date.method(:parse),
     URI        => URI.method(:parse)
   }.freeze
 
+  #
+  # Adds (or overrides) a default type for a given type
+  #
   def self.default_value_for type, value
     default_values[type] = value
   end
@@ -42,8 +47,9 @@ class LazyMapper
     @default_values ||= DEFAULT_VALUES
   end
 
-
-  # Default values for primitive types
+  #
+  # Default values for built-in value types
+  #
   DEFAULT_VALUES = {
     String     => '',
     Integer    => 0,
@@ -53,6 +59,9 @@ class LazyMapper
     Array      => []
   }.freeze
 
+  #
+  # Adds a mapper for a give type
+  #
   def self.mapper_for(type, mapper)
     mappers[type] = mapper
   end
@@ -82,9 +91,11 @@ class LazyMapper
 
   WRITER = -> name { (name.to_s.gsub('?', '') + '=').to_sym }
 
-  # = ::new
   #
-  # Create a new instance by giving a Hash of attribues.
+  # Creates a new instance by giving a Hash of attribues.
+  #
+  # Attribute values are type checked according to how they were defined.
+  # If a value has the wrong type, a `TypeError` is raised.
   #
   # == Example
   #
@@ -106,23 +117,34 @@ class LazyMapper
     end
   end
 
-  # = ::from_json
   #
   # Create a new instance by giving a Hash of unmapped attributes.
   #
   # The keys in the Hash are assumed to be camelCased strings.
   #
+  # == Arguments
+  #
+  # +json+ - The unmapped data as a Hash(-like object). Must respond to #to_h.
+  # Keys are assumed to be camelCased string
+  #
+  # +mappers:+ - Optional instance-level mappers.
+  # Keys can either be classes or symbols corresponding to named attributes.
+  #
+  #
   # == Example
   #
-  #     Foo.from_json "xmlId" => 42,
+  #     Foo.from_json({
+  #       "xmlId" => 42,
   #       "createdAt" => "2015-07-29 14:07:35 +0200",
   #       "amount" => "$2.00",
   #       "users" => [
   #         { "id" => 23, "name" => "Adam" },
   #         { "id" => 45, "name" => "Ole" },
   #         { "id" => 66, "name" => "Anders" },
-  #         { "id" => 91, "name" => "Kristoffer" }
-  #       ]
+  #         { "id" => 91, "name" => "Kristoffer" } ]},
+  #       mappers: {
+  #         :amount => -> x { Money.new(x) },
+  #         User    => User.method(:new) })
   #
   def self.from_json json, mappers: {}
     return nil if json.nil?
@@ -137,29 +159,24 @@ class LazyMapper
     @attributes ||= {}
   end
 
-  # = ::one
   #
   # Defines an attribute and creates a reader and a writer for it.
   # The writer verifies the type of it's supplied value.
   #
   # == Arguments
   #
-  # +name+    - The name of the attribue
+  # +name+ - The name of the attribue
   #
-  # +type+    - The type of the attribute. If the wrapped value is already of
-  #             that type, the mapper is bypassed.
-  #             If the type is allowed be one of several, use an Array to
-  #             to specify which ones
+  # +type+ - The type of the attribute. If the wrapped value is already of that type, the mapper is bypassed.
+  # If the type is allowed be one of several, use an Array to to specify which ones
   #
-  # +from:+    - Specifies the name of the wrapped value in the JSON object.
-  #              Defaults to camelCased version of +name+.
+  # +from:+ - Specifies the name of the wrapped value in the JSON object. Defaults to camelCased version of +name+.
   #
-  # +map:+     - Specifies a custom mapper to apply to the wrapped value. Must be
-  #              a Callable. If unspecified, it defaults to the default mapper for the
-  #              specified +type+ or simply the identity mapper if no default mapper exists.
+  # +map:+ - Specifies a custom mapper to apply to the wrapped value.
+  # If unspecified, it defaults to the default mapper for the specified +type+ or simply the identity mapper
+  # if no default mapper exists.
   #
-  # +default:+  - The default value to use, if the wrapped value is not present
-  #              in the wrapped JSON object.
+  # +default:+ - The default value to use, if the wrapped value is not present in the wrapped JSON object.
   #
   # +allow_nil:+ - If true, allows the mapped value to be nil. Defaults to true.
   #
@@ -192,11 +209,11 @@ class LazyMapper
     attributes[name] = type
   end
 
-  ##
+  #
   # Converts a value to true or false according to its truthyness
+  #
   TO_BOOL = -> b { !!b }
 
-  # = ::is
   #
   # Defines an boolean attribute
   #
@@ -205,13 +222,12 @@ class LazyMapper
   # +name+ - The name of the attribue
   #
   # +from:+ - Specifies the name of the wrapped value in the JSON object.
-  #           Defaults to camelCased version of +name+.
+  # Defaults to camelCased version of +name+.
   #
-  # +map:+  - Specifies a custom mapper to apply to the wrapped value. Must be
-  #           a Callable.
-  #           Defaults to TO_BOOL if unspecified.
+  # +map:+ - Specifies a custom mapper to apply to the wrapped value. Must be a Callable.
+  # Defaults to TO_BOOL if unspecified.
   #
-  # +default:+ - The default value to use if the value is missing. False, if unspecified
+  # +default:+ The default value to use if the value is missing. False, if unspecified
   #
   # == Example
   #
@@ -226,28 +242,24 @@ class LazyMapper
 
   singleton_class.send(:alias_method, :has, :is)
 
-
-  # = ::many
   #
-  # Wraps a collection
+  # Defines a collection attribute
   #
   # == Arguments
   #
-  # +name+ - The name of the attribue
+  # +name+ - The name of the attribute
   #
-  # +type+ - The type of the elemnts in the collection. If an element is
-  #          already of that type, the mapper is bypassed for that element.
+  # +type+ - The type of the elements in the collection.
   #
   # +from:+ - Specifies the name of the wrapped array in the JSON object.
-  #           Defaults to camelCased version of +name+.
+  # Defaults to camelCased version of +name+.
   #
-  # +map:+ - Specifies a custom mapper to apply to the elements in the wrapped
-  #          array. Must respond to +#call+. If unspecified, it defaults to the default
-  #          mapper for the specified +type+ or simply the identity mapper if no default
-  #          mapper exists.
+  # +map:+ - Specifies a custom mapper to apply to each elements in the wrapped collection.
+  # If unspecified, it defaults to the default mapper for the specified +type+ or simply the identity mapper
+  # if no default mapper exists.
   #
   # +default:+ - The default value to use, if the wrapped value is not present
-  #              in the wrapped JSON object.
+  # in the wrapped JSON object.
   #
   # == Example
   #
@@ -277,6 +289,9 @@ class LazyMapper
     }
   end
 
+  #
+  # Adds an instance-level type mapper
+  #
   def add_mapper_for(type, &block)
     mappers[type] = block
   end
@@ -305,7 +320,7 @@ class LazyMapper
     @json ||= {}
   end
 
-  ##
+  #
   # Defines how to map an attribute name
   # to the corresponding name in the unmapped
   # JSON object.
@@ -360,6 +375,6 @@ class LazyMapper
     instance_variable_get(ivar)
   end
 
-  SNAKE_CASE_PATTERN = /(_[a-z])/
+  SNAKE_CASE_PATTERN = /(_[a-z])/ # :nodoc:
   CAMELIZE = -> name { name.to_s.gsub(SNAKE_CASE_PATTERN) { |x| x[1].upcase }.gsub('?', '') }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_mapper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Adam Lett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler