hashstructor 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53417f9ad796f3bdbadd248016ebb1aed623160c
-  data.tar.gz: 0a653553b55d4d333bc0be0d4d53d337beb7b7a5
+  metadata.gz: 09a0c03bda60b67da2ec5b83fc21e42b6347bfd9
+  data.tar.gz: 965e9e766544974d6afd2e70a94dc1339cd513f1
 SHA512:
-  metadata.gz: 2f2ffb6a2a38ea3577dc2352d017af7b57f0ba5a4ada604703c4b500859b0ccb5c18328801e3a11555c9c4fd93d8792b2dcb18178723e3daf61c0c018ea21ec6
-  data.tar.gz: 88e18912f12e341dc4427b015c6e594b9990e78f227d8cdc167ddf8f3d4f9d84b18089549d00546bc0d76bf1358b4de27670fc846c78478cf44e2beefa706af1
+  metadata.gz: 67d10c1f1d44188d219b2675ede43e3a3b4a7510b2824df4cdf8f808456326f4a7efc5d170ffb44b9886735afc358b7d2346fee8fadf93e838f5680929b07e34
+  data.tar.gz: a5635377333bcd518bf166d0f8e3a2080cbd24c420b241c6a09716e87ee6e1a5ff2e6367674e8ca6eb1ce748e08599d2faeaf85c551d438c9861ad00eb987851

data/README.md

@@ -2,7 +2,7 @@
 
 There comes a time in every wee programmer's life (and all programmers are, for the purposes of this readme, wee or previously wee) when one must take a big blob of JSON or YAML and make it into an object. Or worse, a hierarchy of objects. This leads to lots of very manual parsing and gnashing of teeth. Some libraries, like the mildly spiffy [constructor](https://github.com/atomicobject/constructor), allow you to defray some of this pain by letting you pass in hashes to build objects, but this only goes so far: no type coercion, no nested types.
 
-Finally I got tired of this mess when building a game prototype and writing enough stupid read-in code of data files that I decided to Fix This Situation. (You can argue that I got sidetracked; I won't disagree.) After about three hours of late-night work, I'm somewhat proud to unveil **Hashstructor**: your one-stop shop for mangling the heck out of Ruby hashes and building neat-o object trees out of them. (The reverse, breaking these data structures down into hashes, is a TODO.)
+Finally I got tired of this mess when building a game prototype and writing enough stupid read-in code of data files that I decided to Fix This Situation. (You can argue that I got sidetracked; I won't disagree.) After about three hours of late-night work, I'm somewhat proud to unveil **Hashstructor**: your one-stop shop for mangling the heck out of Ruby hashes and building neat-o object trees out of them. You can also turn them back into hashes with `#to_hash`--I've found this really useful for transient domain objects in message queues. The creator can create objects with validation and structure and then `#to_hash` them when they go into the queue, and the same can be done when you get them back out.
 
 Hashstructor is _fully documented_ (100% coverage in `yard`) and comes with a fairly exhaustive set of tests to prove that it actually does what it's supposed to do.
 

data/lib/hashstructor/instance_methods.rb

@@ -3,6 +3,57 @@ require 'set'
 module Hashstructor
   # Instance methods for {Hashstructor} objects.
   module InstanceMethods
+
+
+    # Converts the class back to a hash.
+    #
+    # @returns [Hash] the hash representation of this class
+    def to_h
+      to_hash
+    end
+
+    # Converts the class back to a hash.
+    #
+    # @returns [Hash] the hash representation of this class
+    def to_hash
+      hash = {}
+
+      self.class.hashstructor_members.each do |member|
+        member_value = instance_variable_get("@#{member.name}")
+
+        out_value = 
+          case member.member_type
+            when :normal
+              member_value.nil? ? nil : member.to_hash_value(member_value)
+            when :array
+              # There's some weird Ruby thing I don't get here, but if I use
+              # a #select instead of an each + container, I end up returning
+              # the actual objects rather than their to_hashes.
+              container = []
+              member_value.each do |v|
+                container << member.to_hash_value(v) 
+              end
+              container
+            when :set
+              container = Set.new
+              member_value.each do |v|
+                container << member.to_hash_value(v) 
+              end
+              container
+            when :hash
+              container = {}
+              member_value.each do |k, v| 
+                container[k] = member.to_hash_value(v)
+              end
+              container
+          end
+
+        hash[member.name.to_sym] = out_value
+      end
+
+      hash
+    end
+
     private
     # Initializes the object. This exists for objects that `prepend`
     # {Hashstructor}; objects that `include` it must explicitly invoke

data/lib/hashstructor/member.rb

@@ -51,20 +51,32 @@ module Hashstructor
     # not frozen; if you want to extend it for your own use cases, I'm not
     # going to get in your way.
     VALID_VALUE_TYPES = {
-      String => Proc.new do |v|
-        v.to_s
-      end,
-      Symbol => Proc.new do |v|
-        v.to_sym
-      end,
-      Integer => Proc.new do |v|
-        Integer(v.to_s)
-      end,
-      Float => Proc.new do |v|
-        Float(v.to_s)
-      end,
-      TrueClass => BOOL_PROC,
-      FalseClass => BOOL_PROC,
+      String => {
+        :in =>  Proc.new do |v|
+                  v.to_s
+                end
+      },
+      Symbol => {
+        :in =>  Proc.new do |v|
+                  v.to_sym
+                end
+      },
+      Integer => {
+        :in =>  Proc.new do |v|
+                  Integer(v.to_s)
+                end
+      },
+      Float => {
+        :in =>  Proc.new do |v|
+                  Float(v.to_s)
+                end
+      },
+      TrueClass => {
+        :in => BOOL_PROC
+      },
+      FalseClass => {
+        :in => BOOL_PROC
+      },
     }
     # Determines the class that Hashstructor should attempt to coerce a
     # given value into. For example, `Fixnum` will attempt to coerce a
@@ -159,7 +171,7 @@ module Hashstructor
 
           value_type.new(value)
         else
-          VALID_VALUE_TYPES[value_type].call(value)
+          VALID_VALUE_TYPES[value_type][:in].call(value)
         end
 
       if options[:validation]
@@ -173,5 +185,29 @@ module Hashstructor
 
       retval
     end
+
+    # The inverse of {#parse_single}, which turns a hashstructed member into a hash value. This should
+    # always be a strict inverse; anything this returns should be able to be fed into {#parse_single}
+    # to return the value passed into this function in the first place.
+    def to_hash_value(member_value)
+      if member_value.class.ancestors.include?(Hashstructor)
+        member_value.to_hash
+      else
+        out_proc = VALID_VALUE_TYPES[value_type][:out]
+
+        if (out_proc && !value_type.nil?)
+          out_proc.call(member_value)
+        else
+          if member_value.respond_to?(:to_h)
+            member_value.to_h
+          elsif member_value.respond_to?(:to_hash)
+            member_value.to_hash
+          else
+            member_value
+          end
+        end
+      end
+    end
+
   end
 end

data/lib/hashstructor/version.rb

@@ -1,4 +1,4 @@
 module Hashstructor
   # The gem version. As one does.
-  VERSION = "1.0.6"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashstructor
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Ed Ropple
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby DSL and parser for converting hashes into trees of data objects.