lazy_doc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjE5Nzc1Y2ZiNTYzN2Q3ZGZmZjJlYTMxYzdlOGJkMGNjYTUwZDgzMw==
+    NGFlOWEyOWNhZWExN2I2ZmI4MGEwZTFjZDcxZDdhYjM4ZWRlNzVkMg==
   data.tar.gz: !binary |-
-    MzczZTY4YTI0N2Y3OGU0YjYwMTQwYWM1MjkwMzczMzg0MWZlYTYyYg==
+    ZDg0OWU4OTNjNDQ3NDk2N2VjNTY2YzkxYjkwMmQ3ZGRiY2MwMGNiMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjI3NTY4MmU5MmY5OThjMzNhZDc2OGM2OTU2NTViYmYwNDFiMTkyMDgxZDZk
-    NDY1ZjIyZTlmMTVkYmNhYzkxMzBlZWRlNWU5MjRjYWQ0MWEwNDFkOTMyNGM5
-    ODhmMDg2ZTRmN2RiNmQ2MzcxMDNhNzMxNGY0MGNhZTc3ZDRhYTk=
+    M2ZjZDY4ZGVlNjczOTA4NzU0MDFkZTQwY2M0M2I3OTVkZGZhMTZmNGJiNzVh
+    N2ZiZmI5ZmY0YTViMDcxMjI4YTMzYzIwNTUxNDkzODhkZjA0MGFkNjYyYjdi
+    OTY2YTI2NDdhNmM3MDk0MDdiMTc3YTE2NjhkY2EyODFkZTlmM2I=
   data.tar.gz: !binary |-
-    YWU5MmEyNTA3N2M2MTA3MGI1NDk5NjBiZTMyYzRkYTEwYmFlNDM1NTUwNGU5
-    NjUzZjBiNjI1ODA0MDIyMmQ5YzE3OTZlYTI2YzFmNGViNWMyNWQzZDI3YzJm
-    MjNhOWRlY2ZkOGE0NzU5MjI1ZWU0NWMwODU1N2FjMGE0MTNjZDk=
+    MWU3NzkxMzViMTllNmFlM2I1YzM3MDIwMDgyZTU2OTVlNWQxZjMwZmJkZjcx
+    YWEwNTBlMTI5MjVkMTM1OTA2NTVjMTExYWJjMjRkNDFhYmQ1OGE3ZTE2Njc4
+    YWZjZjk4MTYxMWM3M2JmMDRlMWUzZjlkNDNiNzViOWFmMTk0NWE=

data/README.md

@@ -55,6 +55,28 @@ puts user.address
 puts user.job
 ```
 
+## Collections
+
+When the document has a top-level array, use the `LazyDoc::Collection` class to transform it into an array of LazyDoc objects.
+
+usage:
+```ruby
+class User
+    include LazyDoc::DSL
+
+	access :name
+
+    # more...
+end
+
+json = '[{"name": "Brian"}, {"name": "Chris"}]'
+users = LazyDoc::Collection.build(json, User)
+
+users.each do |user|
+    puts user.name
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/lazy_doc.rb

@@ -1,6 +1,8 @@
 require 'lazy_doc/attribute_not_found_error'
 require 'lazy_doc/camelizable_string'
+require 'lazy_doc/parse_if_necessary'
 require 'lazy_doc/commands'
-require 'lazy_doc/dsl'
+require 'lazy_doc/collection'
 require 'lazy_doc/memoizer'
+require 'lazy_doc/dsl'
 require 'lazy_doc/version'

data/lib/lazy_doc/collection.rb

@@ -0,0 +1,12 @@
+module LazyDoc
+  class Collection
+    extend ParseIfNecessary
+
+    def self.build(document, element_class)
+      as_class_command = Commands::AsClassCommand.new(element_class)
+      collection = as_class_command.execute(parse_if_necessary(document))
+
+      [collection].flatten
+    end
+  end
+end

data/lib/lazy_doc/commands/as_class_command.rb

@@ -11,9 +11,9 @@ module LazyDoc::Commands
         value
       else
         if value.is_a? Array
-          value.map { |element| klass.new(element.to_json) }
+          value.map { |element| klass.new(element) }
         else
-          klass.new(value.to_json)
+          klass.new(value)
         end
       end
 

data/lib/lazy_doc/dsl.rb

@@ -1,23 +1,23 @@
-require 'json'
-
 module LazyDoc
   module DSL
+    include ParseIfNecessary
+
     def self.included(base)
       base.extend ClassMethods
     end
 
-    def lazily_embed(json)
-      @_embedded_doc_source = json
+    def lazily_embed(document)
+      @embedded_doc_source = document
     end
 
     private
 
     def memoizer
-      @_memoizer ||= Memoizer.new
+      @memoizer ||= Memoizer.new
     end
 
     def embedded_doc
-      @_embedded_doc ||= JSON.parse(@_embedded_doc_source)
+      @embedded_doc ||= parse_if_necessary(@embedded_doc_source)
     end
 
 

data/lib/lazy_doc/parse_if_necessary.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+module LazyDoc
+  module ParseIfNecessary
+    def parse_if_necessary(document)
+      already_parsed?(document) ? document : JSON.parse(document)
+    end
+
+    private
+
+    def already_parsed?(document)
+      document.is_a?(Hash) || document.is_a?(Array)
+    end
+  end
+end

data/lib/lazy_doc/version.rb

@@ -1,3 +1,3 @@
 module LazyDoc
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/acceptance/collections_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../spec_helper'
+
+describe 'behavior when the JSON is an array' do
+  class LotrCharacter
+    include LazyDoc::DSL
+
+    access :name, :race
+
+    def initialize(json)
+      lazily_embed(json)
+    end
+  end
+
+  let(:json_file) { File.read(File.join(File.dirname(__FILE__), 'support/lotr_characters.json')) }
+
+  subject(:users) { LazyDoc::Collection.build(json_file, LotrCharacter) }
+
+  context 'frodo' do
+    let(:frodo) { users[0] }
+
+    specify { expect(frodo.name).to eq('Frodo Baggins') }
+    specify { expect(frodo.race).to eq('Hobbit') }
+  end
+
+  context 'sam' do
+    let(:sam) { users[1] }
+
+    specify { expect(sam.name).to eq('Samwise Gamgee') }
+    specify { expect(sam.race).to eq('Hobbit') }
+  end
+
+  context 'gandolf' do
+    let(:gandolf) { users[2] }
+
+    specify { expect(gandolf.name).to eq('Gandolf the Grey') }
+    specify { expect(gandolf.race).to eq('Wizard') }
+  end
+end

data/spec/acceptance/support/lotr_characters.json

@@ -0,0 +1,14 @@
+[
+  {
+    "name": "Frodo Baggins",
+    "race": "Hobbit"
+  },
+  {
+    "name": "Samwise Gamgee",
+    "race": "Hobbit"
+  },
+  {
+    "name": "Gandolf the Grey",
+    "race": "Wizard"
+  }
+]

data/spec/lib/lazy_doc/collection_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../../spec_helper'
+
+module LazyDoc
+  describe Collection do
+    class FooBar
+      include LazyDoc::DSL
+
+      access :foo
+
+      def initialize(json)
+        lazily_embed(json)
+      end
+    end
+
+    let(:json) { '[{"foo": "bar"}, {"foo": "blarg"}, {"foo": "wibble"}]' }
+
+    let(:collection) { LazyDoc::Collection.build(json, FooBar) }
+
+    it 'is an Enumerable' do
+      collection.each do |foo_bar|
+        expect(foo_bar).to be_a FooBar
+      end
+    end
+
+    context 'when the expected document collection is actually a single element' do
+      let(:json) { '{"foo": "bar"}' }
+
+      specify { expect(collection).to have(1).element }
+      specify { expect(collection.first).to be_a FooBar }
+    end
+
+  end
+
+end

data/spec/lib/lazy_doc/commands/as_class_command_spec.rb

@@ -30,10 +30,10 @@ module LazyDoc
       expect(as_class_value).to eq(value)
     end
 
-    it 'passes the value as json to the specified class' do
+    it 'passes the value to the specified class' do
       as_class_command = Commands::AsClassCommand.new(Foo)
 
-      Foo.should_receive(:new).with("{\"foo\":\"bar\"}")
+      Foo.should_receive(:new).with(value)
 
       as_class_command.execute(value)
     end

data/spec/lib/lazy_doc/dsl_spec.rb

@@ -49,6 +49,14 @@ module LazyDoc
         expect { test_find.singleton_class.access :foo, :blarg, as: Foo}.to raise_error(ArgumentError, 'Options provided for multiple attributes')
       end
 
+      it 'can access properties when the supplied document is already a hash' do
+        test_find.singleton_class.access :foo, :blarg
+        test_find.lazily_embed(JSON.parse(json))
+
+        expect(test_find.foo).to eq("bar")
+        expect(test_find.blarg).to eq("wibble")
+      end
+
       context 'via' do
         it 'defines a method that accesses a named json attribute' do
           test_find.singleton_class.access :my_foo, via: :foo

data/spec/lib/lazy_doc/parse_if_necessary_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../../spec_helper'
+
+module LazyDoc
+  describe ParseIfNecessary do
+    class TestParseIfNecessary
+      include ParseIfNecessary
+    end
+
+    let(:test_parser) { TestParseIfNecessary.new }
+
+    it 'parses a JSON string' do
+      hash = test_parser.parse_if_necessary('{"foo":"bar"}')
+
+      expect(hash).to be_a Hash
+      expect(hash['foo']).to eq('bar')
+    end
+
+    it 'does not parse a Hash' do
+      JSON.should_not_receive(:parse)
+
+      hash = test_parser.parse_if_necessary({foo: 'bar'})
+
+      expect(hash).to be_a Hash
+      expect(hash[:foo]).to eq('bar')
+    end
+
+    it 'does not parse an Array' do
+      JSON.should_not_receive(:parse)
+
+      array = test_parser.parse_if_necessary([{foo: 'bar'}, {foo: 'bang'}])
+
+      expect(array).to be_an Array
+      expect(array[0]).to eq({foo: 'bar'})
+      expect(array[1]).to eq({foo: 'bang'})
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_doc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Oglesby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,6 +59,7 @@ files:
 - lib/lazy_doc.rb
 - lib/lazy_doc/attribute_not_found_error.rb
 - lib/lazy_doc/camelizable_string.rb
+- lib/lazy_doc/collection.rb
 - lib/lazy_doc/commands.rb
 - lib/lazy_doc/commands/as_class_command.rb
 - lib/lazy_doc/commands/default_value_command.rb
@@ -67,10 +68,14 @@ files:
 - lib/lazy_doc/commands/via_command.rb
 - lib/lazy_doc/dsl.rb
 - lib/lazy_doc/memoizer.rb
+- lib/lazy_doc/parse_if_necessary.rb
 - lib/lazy_doc/version.rb
 - spec/acceptance/basic_behavior_spec.rb
+- spec/acceptance/collections_spec.rb
+- spec/acceptance/support/lotr_characters.json
 - spec/acceptance/support/user.json
 - spec/lib/lazy_doc/camelizable_string_spec.rb
+- spec/lib/lazy_doc/collection_spec.rb
 - spec/lib/lazy_doc/commands/as_class_command_spec.rb
 - spec/lib/lazy_doc/commands/default_value_command_spec.rb
 - spec/lib/lazy_doc/commands/extract_command_spec.rb
@@ -79,6 +84,7 @@ files:
 - spec/lib/lazy_doc/commands_spec.rb
 - spec/lib/lazy_doc/dsl_spec.rb
 - spec/lib/lazy_doc/memoizer_spec.rb
+- spec/lib/lazy_doc/parse_if_necessary_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
 homepage: https://github.com/ryanoglesby08/lazy-doc
@@ -107,8 +113,11 @@ specification_version: 4
 summary: An implementation of the Embedded Document pattern for POROs
 test_files:
 - spec/acceptance/basic_behavior_spec.rb
+- spec/acceptance/collections_spec.rb
+- spec/acceptance/support/lotr_characters.json
 - spec/acceptance/support/user.json
 - spec/lib/lazy_doc/camelizable_string_spec.rb
+- spec/lib/lazy_doc/collection_spec.rb
 - spec/lib/lazy_doc/commands/as_class_command_spec.rb
 - spec/lib/lazy_doc/commands/default_value_command_spec.rb
 - spec/lib/lazy_doc/commands/extract_command_spec.rb
@@ -117,5 +126,6 @@ test_files:
 - spec/lib/lazy_doc/commands_spec.rb
 - spec/lib/lazy_doc/dsl_spec.rb
 - spec/lib/lazy_doc/memoizer_spec.rb
+- spec/lib/lazy_doc/parse_if_necessary_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb