dish 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 617dbc0f6b27306fc59b7b9779c60470c050c0da
-  data.tar.gz: fcd386da110affa4a0e381e7dc7acac6277c76b1
+  metadata.gz: cc7f03afd4235d643f705eb69e4090e957e976a4
+  data.tar.gz: 515e6465bb10f1abf86469cd3fdc0774c659c9b0
 SHA512:
-  metadata.gz: e356555d49c23b40f8c581a5f35dd3270bfab0d169a94cb0ada1a45e7872371b6a7048c5a1d9db8c8d77492bf88f650feddfa25fd5c6ea5df4e9bb2157b2417a
-  data.tar.gz: 0be9973a4b2a2a6c0cb7863c87ef2ab506b727c45c525a0514173b5f10d51fb02f59741fcac060edcaee3ca97788b8add3b1d3bad4cf2b11f8672a0424c169bb
+  metadata.gz: b1a8a91507d2d016656d74065e3fafb57843e8abbab074830384f7443b36dd4400c3f0c52060995006c2d65514731063440e500e574ef0c3393554688f29fed2
+  data.tar.gz: c575c4f366a7d8f7c2f5e19f1659b0189447f66560d3bd2b707c1406c6418d05a12acf93db7fdb5fdcb267be5bfce4a0d2625fadaf9fe8949903aa7711d28ae0

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.0.5
+
+* Supports setting values via `some_dish_object.key = 'value'`.
+* Values are now cached after their first conversion. This improves performance when calling the same methods repeatedly.
+* Available keys are returned by the `methods` method on a Dish object.
+* `as_hash` is deprecated and renamed to `to_h`.
+* Supports converting the Dish object to json via `to_json`.
+* `respond_to?` and `respond_to_missing?` now works correctly.
+
+## 0.0.4
+
+* Implements `respond_to_missing?`.
+
 ## 0.0.3
 
 * Adds coercion. See the readme for details.

data/README.md

@@ -40,27 +40,28 @@ Then run:
 
 And you're good to go.
 
-Note: If you're using Dish with the BubbleWrap JSON module, please see below.
+**NOTE:** If you're using Dish with the BubbleWrap JSON module, please see below.
 
 ## Example
-
-    hash = {
-      title: "My Title",
-      authors: [
-        { id: 1, name: "Mike Anderson" },
-        { id: 2, name: "Well D." }
-      ],
-      active: false
-    }
-
-    book = Dish(hash) # or hash.to_dish if you required "dish/ext"
-    book.title           # => "My Title"
-    book.authors.length  # => 2
-    book.authors[1].name # => "Well D."
-    book.title?          # => true
-    book.active?         # => false
-    book.other           # => nil
-    book.other?          # => false
+```ruby
+hash = {
+  title: "My Title",
+  authors: [
+    { id: 1, name: "Mike Anderson" },
+    { id: 2, name: "Well D." }
+  ],
+  active: false
+}
+
+book = Dish(hash) # or hash.to_dish if you required "dish/ext"
+book.title           # => "My Title"
+book.authors.length  # => 2
+book.authors[1].name # => "Well D."
+book.title?          # => true
+book.active?         # => false
+book.other           # => nil
+book.other?          # => false
+```
 
 ## Coercion
 
@@ -110,25 +111,29 @@ This is inspired by [Hashie](https://github.com/intridea/hashie)'s coercion meth
 
 Have fun!
 
-## Accessing the original hash
+## Converting back to Ruby/JSON objects
+
+You can use the `Dish::Plate#to_h` method for accessing the original hash. In addition `Dish::Plate#to_json` can be used for marshaling JSON if you are using RubyMotion (`NSJSONSerialization` is used) or have required [the "json" Ruby stdlib](http://www.ruby-doc.org/stdlib/libdoc/json/rdoc/JSON.html).
 
-You can use the `as_hash` method for accessing the original hash.
+**NOTE:** Previously `Dish::Plate#to_h` was called `Dish::Plate#as_hash`. The `Dish::Plate#as_hash` method is now deprecated.
 
 ## Notes
 
 ### Using with the BubbleWrap JSON module
 
 When you use the [BubbleWrap](https://github.com/rubymotion/BubbleWrap) gem to parse JSON into a hash, you can't use the
-`to_dish` methods directly because the `BW::JSON` module returns some sort of hash that hasn't got the methods from the real hash. I'm
+`Hash#to_dish` methods directly because the `BW::JSON` module returns some sort of hash that hasn't got the methods from the real hash. I'm
 fixing this, but in the meanwhile you can achieve the same result by doing this:
 
-    BW::HTTP.get("http://path.to/api/books/2") do |response|
-      json = BW::JSON.parse(response.body.to_s)
-      book = Dish(json) # This is the actual conversion
+```ruby
+BW::HTTP.get("http://path.to/api/books/2") do |response|
+  json = BW::JSON.parse(response.body.to_s)
+  book = Dish(json) # This is the actual conversion
 
-      title_label.text = book.title
-      author_label.text = book.authors.map(&:name).join(", ")
-    end
+  title_label.text = book.title
+  author_label.text = book.authors.map(&:name).join(", ")
+end
+```
 
 ## Contributing
 

data/lib/dish/plate.rb

@@ -12,13 +12,16 @@ module Dish
 
     def initialize(hash)
       @_original_hash = Hash[hash.map { |k, v| [k.to_s, v] }]
+      @_value_cache = {}
     end
 
     def method_missing(method, *args, &block)
       method = method.to_s
+      key = method[0..-2]
       if method.end_with?("?")
-        key = method[0..-2]
-        _check_for_presence(key)
+        !!_get_value(key)
+      elsif method.end_with? '='
+        _set_value(key, args.first)
       else
         _get_value(method)
       end
@@ -28,21 +31,52 @@ module Dish
       _check_for_presence(method.to_s) || super
     end
 
-    def as_hash
+    def to_h
       @_original_hash
     end
 
+    def as_hash
+      # TODO: Add the version number where this was deprecated?
+      warn 'Dish::Plate#as_hash has been deprecated. Use Dish::Plate#to_h.'
+      to_h
+    end
+
+    def to_json(*args)
+      # If we're using RubyMotion #to_json isn't available like with Ruby's JSON stdlib
+      if defined?(Motion::Project::Config)
+        # From BubbleWrap: https://github.com/rubymotion/BubbleWrap/blob/master/motion/core/json.rb#L30-L32
+        NSJSONSerialization.dataWithJSONObject(to_h, options: 0, error: nil).to_str
+      elsif defined?(JSON)
+        to_h.to_json(*args)
+      else
+        raise "#{self.class}#to_json depends on Hash#to_json. Try again after using `require 'json'`."
+      end
+    end
+
+    def methods(regular = true)
+      valid_keys = to_h.keys.map(&:to_sym)
+      valid_keys + super
+    end
+
     private
 
       attr_reader :_original_hash
 
       def _get_value(key)
         value = _original_hash[key]
-        _convert_value(value, self.class.coercions[key])
+        @_value_cache[_cache_key(value)] ||= _convert_value(value, self.class.coercions[key])
       end
 
+      def _cache_key(value)
+        [value.object_id, @_original_hash.hash].join('')
+      end
+
+      def _set_value(key, value)
+        @_original_hash[key] = value
+      end
+ 
       def _check_for_presence(key)
-        !!_get_value(key)
+        _original_hash.key?(key)
       end
 
       def _convert_value(value, coercion)
@@ -63,4 +97,4 @@ module Dish
         end
       end
   end
-end
+end

data/lib/dish/version.rb

@@ -1,3 +1,3 @@
 module Dish
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/coercion_test.rb

@@ -32,6 +32,23 @@ class DishTest < Test::Unit::TestCase
     assert products.map(&:authors).flatten.all? { |a| a.is_a?(Author) }
   end
 
+  def test_coercion_caching
+    products = api_response.to_dish(Product)
+
+    assert_equal products.first.authors.first.object_id, products.first.authors.first.object_id
+  end
+
+  def test_coercion_cache_busting
+    products = api_response.to_dish(Product)
+
+    author = products.first.authors.first
+    assert_equal author.name, products.first.authors.first.name
+
+    products.first.to_h['authors'].first['name'] = 'Johnny Cache'
+
+    assert_not_equal author.name, products.first.authors.first.name
+  end
+
   private
 
     class Author < Dish::Plate; end

data/test/deprecated_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class DeprecatedTest < Test::Unit::TestCase
+  def test_deprecated_as_hash
+    p = Dish({ a: 1, b: 2 })
+
+    out, err = capture_io do
+      assert_equal({ "a" => 1, "b" => 2}, p.as_hash)
+    end
+
+    assert_match /Dish::Plate#as_hash has been deprecated\./, err
+  end
+end

data/test/dish_test.rb

@@ -24,7 +24,7 @@ class DishTest < Test::Unit::TestCase
     assert_respond_to book,  :authors
     refute_respond_to book,  :doesnotexist
     assert_nothing_raised do
-      m = book.method(:title)
+      book.method(:title)
     end
   end
 
@@ -73,7 +73,7 @@ class DishTest < Test::Unit::TestCase
     assert_nil Dish(nil)
   end
 
-  def test_as_hash
+  def test_to_h
     hash = {
       "a" => "a",
       "b" => "b",
@@ -83,8 +83,8 @@ class DishTest < Test::Unit::TestCase
       }
     }
     dish = Dish(hash)
-    c_hash = dish.c.as_hash
-    assert_equal "Hash", dish.c.as_hash.class.to_s
+    c_hash = dish.c.to_h
+    assert_equal "Hash", dish.c.to_h.class.to_s
     assert_equal hash["c"]["1"], c_hash["1"]
     assert_equal hash["c"]["2"], c_hash["2"]
   end
@@ -107,4 +107,42 @@ class DishTest < Test::Unit::TestCase
       assert_instance_of Dish::Plate, d
     end
   end
+
+  def test_respond_to
+    hash = { a: 1, b: true, c: false, d: nil }
+    dish = Dish(hash)
+
+    hash.each do |key, _|
+      assert_respond_to dish, key
+    end
+  end
+
+  def test_set_value
+    hash = { a: 1, b: 2, c: false }
+    dish = Dish(hash)
+
+    dish.a = "other value"
+    assert_equal "other value", dish.a
+    
+    dish.b = nil
+    assert_equal nil, dish.b
+    assert_equal false, dish.b?
+
+    dish.c = true
+    assert_equal true, dish.c
+    assert_equal true, dish.c?
+
+    dish.d = "new value"
+    assert_equal "new value", dish.d
+
+    assert_equal({ "a" => "other value", "b" => nil, "c" => true, "d" => "new value" },
+                 dish.to_h)
+  end
+
+  def test_methods
+    hash = { a: 1, b: 2 }
+    dish = Dish(hash)
+
+    assert_equal [:a, :b], dish.methods[0..1]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dish
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - lib/dish/plate.rb
 - lib/dish/version.rb
 - test/coercion_test.rb
+- test/deprecated_test.rb
 - test/dish_test.rb
 - test/test_helper.rb
 homepage: https://github.com/lassebunk/dish
@@ -91,5 +92,6 @@ specification_version: 4
 summary: Super simple conversion of hashes to plain Ruby objects
 test_files:
 - test/coercion_test.rb
+- test/deprecated_test.rb
 - test/dish_test.rb
 - test/test_helper.rb