dish 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b80bdc6eac863a3ca01536cb0af8034ebfdab5a3
-  data.tar.gz: 993e1729fc762ebbdd7857e1c17f162a3c48d476
+  metadata.gz: f491f4e6dd55335d75c28db8a8cbfc68f5ef445e
+  data.tar.gz: 56472250206b5de7862205d6074fcb3233cb1bc8
 SHA512:
-  metadata.gz: 7b219fc03d52b0dbdf9610d583cd2e76af17665fefec414dadade3bbf9c8379ef070923d0b4715903e09834bb3538196c2e97156eec41028a53b505b40ac8b86
-  data.tar.gz: 7fc189d6b1fee5c77d6ea06a8afeb40f5009be2797fe35a885acf71cd6c6a994170b0a131163cd694e77e47609b1b9b4490460392f900f320a2e09e054c8bbf7
+  metadata.gz: c652e54b74c3d55db537774ccace1a900fc89a74bfb88f3d12d88474e8226167da3c1cd840823813e5de60c11146f46811ccacea444d0554b7048b041fb247a1
+  data.tar.gz: fcc7e13e2b51c93012f6b0058a0f1dfd81c0f52cece0e6a7686b994b3295aac6f442d045fc06eca52bb7efbaadac1390f3f1f9d2cfc52f641691916041530316

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.0.3
+
+* Adds coercion. See the readme for details.
+* Adds an `as_hash` method for accessing the original source hash.

data/README.md

@@ -41,7 +41,7 @@ And you're good to go.
 
 Note: If you're using Dish with the BubbleWrap JSON module, please see below.
 
-# Example
+## Example
 
     hash = {
       title: "My Title",
@@ -61,6 +61,58 @@ Note: If you're using Dish with the BubbleWrap JSON module, please see below.
     book.other           # => nil
     book.other?          # => false
 
+## Coercion
+
+Values can automatically be coerced, for example into a custom `Dish` object or a `Time`, for example if you have an `updated_at` in the source.
+
+```ruby
+class Author < Dish::Plate; end
+
+class Product < Dish::Plate
+  coerce :updated_at, -> (value) { Time.parse(value) }
+  coerce :authors, Author
+end
+
+source_products = [
+  {
+    title: "Test Product",
+    updated_at: "2013-01-28 13:23:11",
+    authors: [
+      { id: 1, name: "First Author" },
+      { id: 2, name: "Second Author" }
+    ]
+  },
+  {
+    title: "Second Product",
+    updated_at: "2012-07-11 19:54:07",
+    authors: [
+      { id: 1, name: "Third Author" },
+      { id: 2, name: "Fourth Author" }
+    ]
+  }
+]
+
+products = Dish(source_products, Product)
+products.first.updated_at    # => instance of Time (2013-01-28 13:23:11)
+products.first.authors.first # => instance of Author
+
+# If you required "dish/ext", you can also:
+products = source_products.to_dish(Product)
+
+# The above example uses an array. You can do the same directly on a hash:
+hash = { title: "My Product", updated_at: "2014-01-15 09:12:45" }
+product = Dish(hash, Product) # => instance of Product
+product = hash.to_dish(Product) # => instance of Product when using "dish/ext"
+```
+
+This is inspired by [Hashie](https://github.com/intridea/hashie)'s coercion methods.
+
+Have fun!
+
+## Accessing the original hash
+
+You can use the `as_hash` method for accessing the original hash.
+
 ## Notes
 
 ### Using with the BubbleWrap JSON module

data/lib/dish/ext/array.rb

@@ -1,5 +1,5 @@
 class Array
-  def to_dish
-    Dish(self)
+  def to_dish(klass = Dish::Plate)
+    Dish(self, klass)
   end
 end

data/lib/dish/ext/hash.rb

@@ -1,5 +1,5 @@
 class Hash
-  def to_dish
-    Dish(self)
+  def to_dish(klass = Dish::Plate)
+    Dish(self, klass)
   end
 end

data/lib/dish/helper.rb

@@ -1,7 +1,7 @@
-def Dish(hash_or_array)
+def Dish(hash_or_array, klass = Dish::Plate)
   case hash_or_array
-  when Hash then Dish::Plate.new(hash_or_array)
-  when Array then hash_or_array.map { |v| Dish(v) }
+  when Hash then klass.new(hash_or_array)
+  when Array then hash_or_array.map { |v| Dish(v, klass) }
   else hash_or_array
   end
 end

data/lib/dish/plate.rb

@@ -1,43 +1,61 @@
 module Dish
   class Plate
+    class << self
+      def coercions
+        @coercions ||= Hash.new(Plate)
+      end
+
+      def coerce(key, klass_or_proc)
+        coercions[key.to_s] = klass_or_proc
+      end
+    end
+
     def initialize(hash)
-      @dish_original_hash = Hash[hash.map { |k, v| [k.to_s, v] }]
+      @_original_hash = Hash[hash.map { |k, v| [k.to_s, v] }]
     end
 
     def method_missing(method, *args, &block)
       method = method.to_s
       if method.end_with?("?")
         key = method[0..-2]
-        dish_check_for_presence(key)
+        _check_for_presence(key)
       else
-        dish_get_value(method)
+        _get_value(method)
       end
     end
 
+    def as_hash
+      @_original_hash
+    end
+
     private
 
-      attr_reader :dish_original_hash
+      attr_reader :_original_hash
 
-      def dish_get_value(key)
-        value = dish_original_hash[key]
-        dish_convert_value(value)
+      def _get_value(key)
+        value = _original_hash[key]
+        _convert_value(value, self.class.coercions[key])
       end
 
-      def dish_check_for_presence(key)
-        !!dish_get_value(key)
+      def _check_for_presence(key)
+        !!_get_value(key)
       end
 
-      def dish_convert_value(value)
+      def _convert_value(value, coercion)
         case value
-        when Hash then self.class.new(value)
-        when Array then value.map { |v| dish_convert_value(v) }
-        else value
-        end
-      end
-
-      def dish_metaclass
-        class << self
-          self
+        when Array then value.map { |v| _convert_value(v, coercion) }
+        when Hash
+          if coercion.is_a?(Proc)
+            coercion.call(value)
+          else
+            coercion.new(value)
+          end
+        else
+          if coercion.is_a?(Proc)
+            coercion.call(value)
+          else
+            value
+          end
         end
       end
   end

data/lib/dish/version.rb

@@ -1,3 +1,3 @@
 module Dish
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/coercion_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+class DishTest < Test::Unit::TestCase
+  def test_coercion
+    product = Dish(api_response.first, Product)
+
+    assert_equal Time.new(2013, 1, 28, 13, 23, 11), product.updated_at
+    assert product.authors.all? { |a| a.is_a? Author }
+    assert_equal ["First Author", "Second Author"], product.authors.map(&:name)
+  end
+
+  def test_hash_helper_coercion
+    product = api_response.first.to_dish(Product)
+
+    assert_equal Time.new(2013, 1, 28, 13, 23, 11), product.updated_at
+    assert product.authors.all? { |a| a.is_a? Author }
+    assert_equal ["First Author", "Second Author"], product.authors.map(&:name)
+  end
+
+  def test_array_coercion
+    products = Dish(api_response, Product)
+
+    assert products.all? { |p| p.is_a?(Product) }
+    assert products.map(&:authors).flatten.all? { |a| a.is_a?(Author) }
+  end
+
+  def test_array_helper_coercion
+    products = api_response.to_dish(Product)
+
+    assert products.all? { |p| p.is_a?(Product) }
+    assert products.map(&:authors).flatten.all? { |a| a.is_a?(Author) }
+  end
+
+  private
+
+    class Author < Dish::Plate; end
+
+    class Product < Dish::Plate
+      coerce :updated_at, -> (value) { Time.parse(value) }
+      coerce :authors, Author
+    end
+
+    def api_response
+      [
+        {
+          title: "Test Product",
+          updated_at: "2013-01-28 13:23:11",
+          authors: [
+            { id: 1, name: "First Author" },
+            { id: 2, name: "Second Author" }
+          ]
+        },
+        {
+          title: "Second Product",
+          updated_at: "2012-07-11 19:54:07",
+          authors: [
+            { id: 1, name: "Third Author" },
+            { id: 2, name: "Fourth Author" }
+          ]
+        }
+      ]
+    end
+end

data/test/dish_test.rb

@@ -67,6 +67,22 @@ class DishTest < Test::Unit::TestCase
     assert_nil Dish(nil)
   end
 
+  def test_as_hash
+    hash = {
+      "a" => "a",
+      "b" => "b",
+      "c" => {
+        "1" => 1,
+        "2" => 2
+      }
+    }
+    dish = Dish(hash)
+    c_hash = dish.c.as_hash
+    assert_equal "Hash", dish.c.as_hash.class.to_s
+    assert_equal hash["c"]["1"], c_hash["1"]
+    assert_equal hash["c"]["2"], c_hash["2"]
+  end
+
   def test_hash_ext
     hash = { a: 1, b: 2 }
     dish = hash.to_dish

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dish
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -61,6 +62,7 @@ files:
 - lib/dish/motion.rb
 - lib/dish/plate.rb
 - lib/dish/version.rb
+- test/coercion_test.rb
 - test/dish_test.rb
 - test/test_helper.rb
 homepage: https://github.com/lassebunk/dish
@@ -88,5 +90,6 @@ signing_key:
 specification_version: 4
 summary: Super simple conversion of hashes to plain Ruby objects
 test_files:
+- test/coercion_test.rb
 - test/dish_test.rb
 - test/test_helper.rb