hash-to-obj 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee934fea5eddeefa8540e7691d2b39b28e1e948c
-  data.tar.gz: b5b7c45e8ffd2d74b4cd84f4051a2184a85c4d2f
+  metadata.gz: fac97be8d0c513fd32e27704024deea023fa55cb
+  data.tar.gz: 930bb5f01ff267421a7ced58c3b1f89e89a3fcb9
 SHA512:
-  metadata.gz: b79470f4236a73cab06c10bb5494fdcd20e62ee98c9802854b4325497203e4193dbca745ff1c66857b8da66cf0eed2fecd62b25975d15780e5de3c1fdd6e7321
-  data.tar.gz: e19f7befcd4897b53aa8cbb170928222317570532bdbe6c5180e651dc718443709cb82b95cb88c71367898ca8eae5bfc110d8e4932641d78c9132735b2835e02
+  metadata.gz: 9ba08e29a2f015b144c345c5b177c4e39c36b86030d9d8a3c609524cce6448923c4bb5567f2256b74f8865ccc0e941981037af97151f79cecf950116c102402f
+  data.tar.gz: a481b39b901627e060070d6d509abbb472294925cd5a27c80688a48550d0fd0fec39a4b2ae88839aa6d4f45dab9951dbf245373ab7f10a359678735f48feec72

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem

data/lib/hash-to-obj.rb

@@ -11,32 +11,76 @@ module HashToObj
   # Anything that you want to objectify needs to respond to these methods like a
   # Hash would. If it doesn't at least respond_to? these methods, an error will
   # be thrown when objectifying.
-  DUCK_TYPE_API = [:[], :[]=].freeze
+  DUCK_TYPE_API = [:[], :[]=, :each_key].freeze
 
   ##
   # Throws an error if hash doesn't have all messages defined in DUCK_TYPE_API.
-  # Generates the accessors for all keys on the passed hash. Unless
-  # override_warnings is true-y, this will throw errors if we're gonna screw
-  # anything up. If you pass something that responds to :puts in
-  # override_warnings then warnings will just be puts'd to that, and things will
-  # continue.
-  def self.objectify(hash, override_warnings = false)
-    # Make sure it looks SOMEWHAT familiar.
-    DUCK_TYPE_API.each do |method_sym|
-      unless hash.respond_to?(method_sym) then
-        raise(ArgumentError,
-              "Cannot objectify something that doesn't look like a hash.")
+  # Generates the accessors for all keys on the passed hash.
+  #
+  # Accepted options:
+  # [override_warnings] Unless override_warnings is truthy, this will throw
+  #                     errors if we're gonna screw anything up. If you pass
+  #                     something that responds to :puts in override_warnings
+  #                     then warnings will just be puts'd to that, and things
+  #                     will continue.
+  # [default_module] If a default_module is specified, that will be included
+  #                  in the hash before adding our accessors, essentially
+  #                  allowing you to define a set of methods that should be
+  #                  present after objectifying regardless of the keys in the
+  #                  hash.
+  def self.objectify(hash, options = {})
+    if options.is_a?(Hash) then
+      internal_objectify(hash,
+                         options[:override_warnings],
+                         options[:default_module])
+    else
+      unless HashToObj.const_defined?(:SQUELCH_GLOBAL_WARNINGS) then
+        puts "objectify(hash, override_warnings) is deprecated.\n"\
+             '  please use objectify(hash, override_warnings: true) instead.'
       end
+      # Looks like they're using 0.1.0 API.
+      internal_objectify(hash, options)
+    end
+  end
+  
+  #-------------------------------------------------------------------------
+  # :section: Internal Methods
+  # Usually don't want to mess with these if you're not part of hash-to-obj.
+  #-------------------------------------------------------------------------
+  
+  ##
+  # Internal version of objectify. Uses seperated arguments instead of options
+  # hash.
+  def self.internal_objectify(hash,
+                              override_warnings = false,
+                              default_module = nil)
+    # Make sure it looks SOMEWHAT familiar.
+    unless quacks?(hash) then
+      raise(ArgumentError,
+            "Cannot objectify something that doesn't look like a hash.")
     end
 
     # Now lets actually add those methods.
-    hash.each_key do |key|
-      generate_accessors(hash, key, override_warnings)
-    end
+    hash.each_key { |key| generate_accessors(hash, key, override_warnings) }
+
+    hash.extend(default_module) if default_module
 
     hash
   end
 
+  ##
+  # Returns true if the passed object responds to all methods defined in
+  # DUCK_TYPE_API.
+  def self.quacks?(obj)
+    DUCK_TYPE_API.each do |method_sym|
+      unless obj.respond_to?(method_sym) then
+        return false
+      end
+    end
+
+    true
+  end
+
   ##
   # Generates the accessors for the passed key on the passed hash. Unless
   # override_warnings is true-y, this will throw errors if we're gonna screw
@@ -109,7 +153,9 @@ if begin
          'Call HashToObj.objectify instead.'
   end
 else
-  def objectify(hash, override_warnings = false)
-    HashToObj.objectify(hash, override_warnings)
+  ##
+  # See {HashToObj::objectify}[rdoc-ref:HashToObj::objectify]
+  def objectify(*args)
+    HashToObj.objectify(*args)
   end
 end

data/lib/hash-to-obj/version.rb

@@ -1,3 +1,5 @@
 module HashToObj
-  VERSION = '0.1.0'.freeze
+  # :category: 
+  # Current version of hash-to-obj
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash-to-obj
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Maxwell