traitorous 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51c87b262becc747a334dce20c4b0f149de698d4
-  data.tar.gz: 384664790edbfbbcbc95043b7f4cc3fbe78c78e0
+  metadata.gz: 147aa556988fc13509f445eb0887d4d943c6384b
+  data.tar.gz: 3eeb33815f1a8bd1c9f3ee83aa19961c053b15a1
 SHA512:
-  metadata.gz: 27cecb8725cfe6914c81e26ae45cc2e5f9669228e01f3c139d4e02a309af4763918c45a22e75bd9453b9fbd8254c70248ed3f0ed4a0c7eb5e10e9626cedd47ba
-  data.tar.gz: 052ece595a8928766a34eaede53b690981834db33cbedeb2215f940e3d354d2b165118e7e3a2403ff179ecc7d538103c7edf0aa8f645539269c13825627b841e
+  metadata.gz: 0613a5b93cacd2a046d2ae996b606adcbc1051421ddec3e1b3b88906927816e1b0daa3c15618990f74a8f5fe50af7b8fe6cacb9f8048270ea7562f221459932e
+  data.tar.gz: 05c16f0da36240e35a124d086f10c0860027d60128b9137c6e09bc1e86fb50985cae32dff2ed937bfcc28ab4bbf03689fc2a392bcc840f1131e6905c8c37e603

data/README.md

@@ -86,6 +86,48 @@ puts Area.new(area.export) == area
 # true
 ```
 
+## Converters
+The purpose of the converters are to facilitate the importation of simple
+JSON or YAML data and import that data into an arbitrarily nested tree
+of objects.  And then to take those object and be able to export that data
+in a simple form ready to save.
+
+This system should be flexible enough to account for an large variety of data
+structures that can be read in and out of storage easily and in 1 tree.
+
+#### Traitorous::Converter::Identity
+This converter is meant as a pass through converter that doesn't alter the
+incoming value on either do_import or do_export.  
+
+#### Traitorous::Converter::DefaultValueStatic
+THis converter is similar to the Traitorous::Converter::Identity except that
+when doing do_import it will return a default value if the opts are nil or 
+false.
+
+#### Traitorous::Converter::Model
+This converter takes a model_klass argument and on do_import, will instantiate 
+a new object of that class passing in the opts as params.  do_export calls 
+.export on the object and returns the result.
+
+#### Traitorous::Converter::UniformArray
+This converter takes a uniform_klass argument.  It expects an array as input for
+.do_import and will instantiate an uniform_klass object for each element of the
+array and return the resulting array.
+
+#### Traitorous::Converter::MethodKeyedUniformHash
+This converter takes key_method and uniform_class arguments.  It expects an 
+array as input for .do_import and will instantiate an uniform_klass object for 
+each element of the array, then call key_method on that object and add them
+to a hash as a key instance pair.
+
+### More Converters
+
+more intelligent conversions?  Expand the model, array and hash converters to
+accept an override to instantiating with ::new to allow for more flexibility in
+usage.  This especially would be important if you wanted to import a list of 
+object that represents different klasses that are given with a sub_type or 
+sub_class attributes that are part of the do_import data.  
+
 ## Roadmap
 
 1.  Add better documentation

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.2

data/lib/traitorous/converter/method_keyed_uniform_hash.rb

@@ -7,26 +7,26 @@ module Traitorous
     # Exported data will be converted into an array calling do_export on each
     #   element
     class MethodKeyedUniformHash
-      attr_accessor :key_method, :uniform_class
-      # @param key_method [Symbol] the method to call on the uniform_class instance
+      attr_accessor :key_method, :uniform_klass
+      # @param key_method [Symbol] the method to call on the uniform_klass instance
       #   to generate the key in the returned hash
-      # @param uniform_class [Class, #new] the class to instantiate with each
+      # @param uniform_klass [Class, #new] the class to instantiate with each
       #   element of the do_import array
-      def initialize(key_method, uniform_class)
+      def initialize(key_method, uniform_klass)
         @key_method = key_method
-        @uniform_class = uniform_class
+        @uniform_klass = uniform_klass
       end
 
       # The import instantiates each element of the array as an instance of
-      #   the uniform_class, the key is determined by calling key_method on the
+      #   the uniform_klass, the key is determined by calling key_method on the
       #   instance and then they are joined to the result hash as a key,
       #   instance pair.
       # @param arr_data [Array] the array of data to instantiate
       # @return [Hash] hash containing key, instance pairs
       def do_import(arr_data)
         out = {}
-        arr_data.each do |elem_data|
-          obj = uniform_class.new(elem_data)
+        Array(arr_data).each do |elem_data|
+          obj = uniform_klass.new(elem_data)
           out[obj.send(key_method)] = obj
         end
         out

data/lib/traitorous/converter/uniform_array.rb

@@ -1,15 +1,15 @@
 module Traitorous
   module Converter
     class UniformArray
-      def initialize(uniform_class)
-        @uniform_class ||= uniform_class
+      def initialize(uniform_klass)
+        @uniform_klass ||= uniform_klass
       end
       def do_export(data_arr)
-        data_arr.map(&:export)
+        Array(data_arr).map(&:export)
       end
 
       def do_import(opts_arr)
-        opts_arr.map{|d| @uniform_class.new(d)}
+        Array(opts_arr).map{|d| @uniform_klass.new(d)}
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traitorous
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - scott m parrish