lazy_doc 0.1.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTYzNGFkNWU2YjdkM2I4OGE4YzAyY2UyNmRmOGNmOTFkMWI4ZDQ3Yg==
+    OGMxMGUwZTdmMDk4OGUyZGRhMTliNTI3NmUzM2RjZDMwYjY0ODM3Yg==
   data.tar.gz: !binary |-
-    Nzk4YzFiNjhkMzg1YTI2YTI0YWIwY2QzZGIzYjk1OGE0NDVjYTNmMw==
+    MTNhYWFlY2MzOTQ0YWFmNDYyZTMxZTBkMDI0Mjk3YmVjMjg2YWFkZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmY4NmIwMGRjYmEzYTEwMWI2N2MxY2ZhYTRjYjc2NGNhZjU2NzBjYTllMmM0
-    MzdlOWI1ZmY2ZGMzZmUxM2IwMjE1YWQ5OTE3NTRkZjBjYmIxZWNiNjkyOTk0
-    Y2RjOTYwMzI1M2ViYTAyYjNjZWVlZDBhNzdmMTdlZDY1NzdkZmI=
+    MTJjMjgwZmYyZTA5ZWIxNWFmODBiMWUwZGNjZTM3ZGNiMDFlYzRhOTI4ZmE2
+    MjFiZWFhZWI2YmI5YzZmOTlmNWMwNmQwODg2M2MxNDgzYzM1ODBkYjJhZDlm
+    MTNmMjkzMGIyNWY5MzY3MTgzYWI1YmZkZDc2ZDMzZmQwMWMxODQ=
   data.tar.gz: !binary |-
-    N2UzNDQ5OGVkNDlkZGQ3MmU0NzU2YzIyNTJiZDI2NDZmN2ZlNTZiN2ZhMmNi
-    ZjkwNDY4M2EwY2YxYWI4MGQxYmUwOWZlNTRmNGE5YTk2ZmVjYzFkODA3ZGZh
-    NDljN2U5ODg5NGQwYWJlOGJhN2IwN2IzMjVlM2I3ZTMzMTViOTY=
+    ZTQ0MWIxMjJmMzJiNmFlMjcxNTg1MTIxMDEyYjNkNjc5MDI5NDE0YzIxMTcx
+    MDJkMzM5NmIzOTIxOWQ4ZjNmNzY2NmM0ODJkZWJiYzc3NDEyMGMyMzFjYWRk
+    OGExNjc5MmIxMTU3MjQ4MzdkOTFlOTQ3ZjE4ODE0M2UxNzc5ODY=

data/README.md

@@ -66,13 +66,13 @@ puts user.job
 5. DONE - Objects from sub-trees.  ex: `access :profile, as: Profile` (This would construct a LazyDoc Profile object and pass the json found at "profile" to it)
 6. Collections.
     - DONE - Map. For example, extract array of customer names from array of customers. ex: `access :customers, extract: :name`
-    - Objects from collection. Instead of extracting just the name, extract whole objects like in #5.  ex:  `access :customers, as: Customer`
-    - Other Collection manipulations, select, inject, etc
+    - DONE - Objects from collection. Instead of extracting just the name, extract whole objects like in #5.  ex:  `access :customers, as: Customer`
+    - Other Collection manipulations, select, inject, count, etc
 7. Joins
     - Using previously defined attributes. ex: `join :address, from: [:street, :city, :state:, :zip]`
     - Defining attributes in place.
 8. DONE - Multiple simple paths in one line (ex: `access :name, :street, :city, :state`)
-9. Infer camelCase to snake_case and vice versa in JSON ex: `access :customer_name` (Where the json has customerName)
+9. DONE- Infer camelCase to snake_case and vice versa in JSON ex: `access :customer_name` (Where the json has customerName)
 10. XML support
 
 ## Contributing

data/lib/lazy_doc.rb

@@ -1,4 +1,5 @@
 require 'lazy_doc/attribute_not_found_error'
+require 'lazy_doc/camelizable_string'
 require 'lazy_doc/commands'
 require 'lazy_doc/dsl'
 require 'lazy_doc/memoizer'

data/lib/lazy_doc/attribute_not_found_error.rb

@@ -1,3 +1,3 @@
 module LazyDoc
-  class AttributeNotFoundError < StandardError ;end
+  class AttributeNotFoundError < StandardError; end
 end

data/lib/lazy_doc/camelizable_string.rb

@@ -0,0 +1,15 @@
+module LazyDoc
+  class CamelizableString
+    attr_reader :original
+
+    def initialize(original)
+      @original = original
+    end
+
+    def camelize
+      original.gsub(/(_)(.)/) { $2.upcase }
+    end
+
+  end
+
+end

data/lib/lazy_doc/commands.rb

@@ -8,3 +8,21 @@ require 'lazy_doc/commands/default_value_command'
 require 'lazy_doc/commands/extract_command'
 require 'lazy_doc/commands/finally_command'
 require 'lazy_doc/commands/via_command'
+
+module LazyDoc::Commands
+  OPTIONAL_COMMAND_CLASSES = {
+    default: DefaultValueCommand,
+    as: AsClassCommand,
+    extract: ExtractCommand,
+    finally: FinallyCommand
+  }
+
+  def self.create_commands_for(options)
+    options.map do |key, initialization_value|
+      if OPTIONAL_COMMAND_CLASSES.has_key?(key)
+        OPTIONAL_COMMAND_CLASSES[key].new(initialization_value)
+      end
+    end.compact
+
+  end
+end

data/lib/lazy_doc/commands/as_class_command.rb

@@ -7,7 +7,16 @@ module LazyDoc::Commands
     end
 
     def execute(value)
-      klass.nil? ? value : klass.new(value.to_json)
+      if klass.nil?
+        value
+      else
+        if value.is_a? Array
+          value.map { |element| klass.new(element.to_json) }
+        else
+          klass.new(value.to_json)
+        end
+      end
+
     end
   end
 end

data/lib/lazy_doc/commands/via_command.rb

@@ -7,15 +7,28 @@ module LazyDoc::Commands
     end
 
     def execute(document)
-      path.inject(document) do |final_value, attribute|
-        unless final_value.has_key?(attribute.to_s)
-          raise LazyDoc::AttributeNotFoundError.new("Unable to access #{attribute} via #{path.join(', ')}")
-        end
+      path.inject(document) do |sub_document, attribute|
+        attribute_identifier = determine_attribute_identifier(attribute, sub_document)
 
-        final_value[attribute.to_s]
+        sub_document[attribute_identifier]
       end
     end
 
+    private
+
+    def determine_attribute_identifier(attribute, sub_document)
+      camelizable_attribute = LazyDoc::CamelizableString.new(attribute.to_s)
+
+      if sub_document.has_key?(camelizable_attribute.original)
+         camelizable_attribute.original
+      elsif sub_document.has_key?(camelizable_attribute.camelize)
+         camelizable_attribute.camelize
+      else
+        raise LazyDoc::AttributeNotFoundError.new("Unable to access #{attribute} via #{path.join(', ')}")
+      end
+
+    end
+
   end
 
 end

data/lib/lazy_doc/dsl.rb

@@ -33,11 +33,8 @@ module LazyDoc
       end
 
       def define_access_method_for(attribute, options)
-        create_method(attribute,  Commands::ViaCommand.new(options[:via] || attribute),
-                                  Commands::DefaultValueCommand.new(options[:default]),
-                                  Commands::AsClassCommand.new(options[:as]),
-                                  Commands::ExtractCommand.new(options[:extract]),
-                                  Commands::FinallyCommand.new(options[:finally]))
+        optional_commands = Commands.create_commands_for options
+        create_method(attribute, Commands::ViaCommand.new(options[:via] || attribute), optional_commands)
       end
 
       def define_access_methods_for(attributes)
@@ -47,10 +44,10 @@ module LazyDoc
 
       end
 
-      def create_method(attribute, required_command, *optional_commands)
+      def create_method(attribute, via_command, optional_commands = [])
         define_method attribute do
           memoizer.memoize attribute do
-            value = required_command.execute(embedded_doc)
+            value = via_command.execute(embedded_doc)
 
             optional_commands.inject(value) do |final_value, command|
               final_value = command.execute(final_value)

data/lib/lazy_doc/version.rb

@@ -1,3 +1,3 @@
 module LazyDoc
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/spec/acceptance/basic_behavior_spec.rb

@@ -4,7 +4,7 @@ describe 'basic behavior with a simple JSON document' do
   class Friends
     include LazyDoc::DSL
 
-    access :best_friend, via: :bestFriend
+    access :best_friend
     access :lover
 
     def initialize(json)
@@ -12,18 +12,29 @@ describe 'basic behavior with a simple JSON document' do
     end
   end
 
+  class Accomplishment
+    include LazyDoc::DSL
+
+    access :description
+
+    def initialize(json)
+      lazily_embed(json)
+    end
+  end
+
   class User
     include LazyDoc::DSL
 
     access :name
     access :phone, :zip
     access :home_town
-    access :address, via: :streetAddress
+    access :street_address
     access :job_title, via: [:profile, :occupation, :title]
     access :born_on, via: [:profile, :bornOn], finally: lambda { |born_on| born_on.to_i }
     access :friends, as: Friends
     access :father, default: 'Chuck Palahniuk'
     access :fight_club_rules, via: [:fightClub, :rules], extract: :title
+    access :accomplishments, as: Accomplishment
 
     def initialize(json)
       lazily_embed(json)
@@ -38,7 +49,7 @@ describe 'basic behavior with a simple JSON document' do
   its(:name) { should == 'Tyler Durden' }
   its(:phone) { should == '288-555-0153' }
   its(:zip) { should == '00000' }
-  its(:address) { should == 'Paper Street' }
+  its(:street_address) { should == 'Paper Street' }
   its(:job_title) { should == 'Soap Maker' }
   its(:born_on) { should == 1999 }
   specify { expect { user.home_town }.to raise_error(LazyDoc::AttributeNotFoundError) }
@@ -54,4 +65,12 @@ describe 'basic behavior with a simple JSON document' do
   its(:fight_club_rules) { should == ['You do not talk about Fight Club',
                                       'You DO NOT talk about Fight Club',
                                       'If someone says stop or goes limp, taps out the fight is over'] }
+
+  context 'accomplishments' do
+    let(:accomplishments) { user.accomplishments }
+
+    specify { expect(accomplishments[0].description).to eq('Sold a lot of soap') }
+    specify { expect(accomplishments[1].description).to eq('Started fight club with himself') }
+    specify { expect(accomplishments[2].description).to eq('Blew up a bunch of credit card companies') }
+  end
 end

data/spec/acceptance/support/user.json

@@ -21,5 +21,10 @@
       {"number": 2, "title": "You DO NOT talk about Fight Club"},
       {"number": 3, "title": "If someone says stop or goes limp, taps out the fight is over"}
     ]
-  }
+  },
+  "accomplishments": [
+    {"description": "Sold a lot of soap"},
+    {"description": "Started fight club with himself"},
+    {"description": "Blew up a bunch of credit card companies"}
+  ]
 }

data/spec/lib/lazy_doc/camelizable_string_spec.rb

@@ -0,0 +1,21 @@
+require_relative '../../spec_helper'
+
+module LazyDoc
+  describe CamelizableString do
+    describe '#camelize' do
+      it 'converts a string from snake_case to camelCase' do
+        camelized_string = CamelizableString.new('snake_case').camelize
+
+        expect(camelized_string).to eq('snakeCase')
+      end
+
+      it 'has no effect on a string with no underscores' do
+        camelized_string = CamelizableString.new('snakecase').camelize
+
+        expect(camelized_string).to eq('snakecase')
+      end
+    end
+
+  end
+
+end

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

@@ -3,8 +3,7 @@ require_relative '../../../spec_helper'
 module LazyDoc
   describe Commands::AsClassCommand do
     class Foo
-      def initialize(value)
-      end
+      def initialize(value) end
     end
 
     let(:value) { {foo: 'bar'} }
@@ -38,5 +37,19 @@ module LazyDoc
 
       as_class_command.execute(value)
     end
+
+    context 'when the value being sent to the AsClassCommand is an array' do
+      let(:value) { [{foo: 'bar'}, {foo: 'baz'}] }
+
+      it 'returns an array of objects of the specified class' do
+        as_class_command = Commands::AsClassCommand.new(Foo)
+
+        as_class_value = as_class_command.execute(value)
+
+        expect(as_class_value).to be_an Array
+        expect(as_class_value[0]).to be_a Foo
+        expect(as_class_value[1]).to be_a Foo
+      end
+    end
   end
 end

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

@@ -32,5 +32,14 @@ module LazyDoc
 
       expect { via.execute(document) }.to raise_error(AttributeNotFoundError)
     end
+
+    it 'finds the attribute when specified as snake_case but is found in camelCase' do
+      document = {'helloWorld' => 'foobar'}
+      via = Commands::ViaCommand.new(:hello_world)
+
+      final_value = via.execute(document)
+
+      expect(final_value).to eq('foobar')
+    end
   end
 end

data/spec/lib/lazy_doc/commands_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../../spec_helper'
+
+module LazyDoc
+  describe Commands do
+    describe '#create_commands_for' do
+      class FooCommand
+        def initialize(_) end
+      end
+      class BarCommand
+        def initialize(_) end
+      end
+
+      before(:all) do
+        @optional_command_classes = Commands::OPTIONAL_COMMAND_CLASSES.dup
+        Commands::OPTIONAL_COMMAND_CLASSES = {foo: FooCommand, bar: BarCommand}
+      end
+
+      after(:all) do
+        Commands::OPTIONAL_COMMAND_CLASSES = @optional_command_classes
+      end
+
+      let(:initialization_value) { 'initialization value' }
+
+      it 'creates a command object for the specified option' do
+        options = {foo: initialization_value}
+        commands = Commands.create_commands_for(options)
+
+        expect(commands[0]).to be_a FooCommand
+      end
+
+      it 'creates a command object for multiple options' do
+        options = {foo: initialization_value, bar: initialization_value}
+        commands = Commands.create_commands_for(options)
+
+        expect(commands[0]).to be_a FooCommand
+        expect(commands[1]).to be_a BarCommand
+      end
+
+      it 'ignores options for which it does not have a matching command' do
+        options = {unknown: initialization_value}
+        commands = Commands.create_commands_for(options)
+
+        expect(commands).to be_empty
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryan Oglesby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,6 +58,7 @@ files:
 - lazy_doc.gemspec
 - lib/lazy_doc.rb
 - lib/lazy_doc/attribute_not_found_error.rb
+- lib/lazy_doc/camelizable_string.rb
 - lib/lazy_doc/commands.rb
 - lib/lazy_doc/commands/as_class_command.rb
 - lib/lazy_doc/commands/default_value_command.rb
@@ -69,11 +70,13 @@ files:
 - lib/lazy_doc/version.rb
 - spec/acceptance/basic_behavior_spec.rb
 - spec/acceptance/support/user.json
+- spec/lib/lazy_doc/camelizable_string_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
 - spec/lib/lazy_doc/commands/finally_command_spec.rb
 - spec/lib/lazy_doc/commands/via_command_spec.rb
+- spec/lib/lazy_doc/commands_spec.rb
 - spec/lib/lazy_doc/dsl_spec.rb
 - spec/lib/lazy_doc/memoizer_spec.rb
 - spec/spec_helper.rb
@@ -105,11 +108,13 @@ summary: An implementation of the Embedded Document pattern for POROs
 test_files:
 - spec/acceptance/basic_behavior_spec.rb
 - spec/acceptance/support/user.json
+- spec/lib/lazy_doc/camelizable_string_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
 - spec/lib/lazy_doc/commands/finally_command_spec.rb
 - spec/lib/lazy_doc/commands/via_command_spec.rb
+- spec/lib/lazy_doc/commands_spec.rb
 - spec/lib/lazy_doc/dsl_spec.rb
 - spec/lib/lazy_doc/memoizer_spec.rb
 - spec/spec_helper.rb