embedded_document 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99fa4b46c8c6f50abac6598a7814d9b0aee20d76
+  data.tar.gz: 6db4d87b169be3f96ce4a945d9889f89f4fddf5e
+SHA512:
+  metadata.gz: 8153a45acabc2c411ebb27bbb3923e6c43c4c2bb82488d9d299877138605252c929a96dbdc48f3a2b5b359308551df9f4ef1900a7fabfbc76f3781cb4bafa2ab
+  data.tar.gz: 84b94e168be3b9291c586cf4ce3629e2ad60d159b3964f5dd13dd2561caed7fbdfaee9b2a5733151d41674cd64107e30d6885f44b64b4362442b027113d06f4b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea/*
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+vendor/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in embedded_document.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sumit Mahamuni And Rahul Phulore
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# EmbeddedDocument
+Abstract away the smaller patterns that occur when using Embedded Document pattern. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'embedded_document'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install embedded_document
+
+## Usage
+
+```
+class Item < EmbeddedDocument::Document
+end
+ 
+class Delivery < EmbeddedDocument::Document
+  key :shipDate, date, :ship_date
+  key :items, sequence_of(Item)
+end
+ 
+class Order < EmbeddedDocument::Document
+  key :deliveries, sequence_of(Delivery)
+  key :items, sequence_of(Item)
+ 
+  def quantity_for(a_product)
+    item = items.detect{|i| a_product == i.product}
+    item ? item.quantity : 0
+  end
+end
+ 
+order_hash = JSON.parse(
+  '{ "id": 1234,
+    "customer": "martin",
+    "items": [
+      {"product": "talisker", "quantity": 500},
+      {"product": "macallan", "quantity": 800},
+      {"product": "ledaig",   "quantity": 1100}
+    ],
+    "deliveries": [
+      { "id": 7722,
+        "shipDate": "2013-04-19",
+        "items": [
+          {"product": "talisker", "quantity": 300},
+          {"product": "ledaig",   "quantity": 500}
+        ]
+      },
+      { "id": 6533,
+        "shipDate": "2013-04-18",
+        "items": [
+          {"product": "talisker", "quantity": 200},
+          {"product": "ledaig",   "quantity": 300},
+          {"product": "macallan", "quantity": 300}
+        ]
+      }
+    ]
+  }'
+)
+ 
+order = Order.new(order_hash)
+p order.deliveries
+p order.quantity_for('talisker')
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/embedded_document/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## References
+
+1. Embedded Document pattern: (http://martinfowler.com/bliki/EmbeddedDocument.html)
+2. Easing the use of Embedded Document pattern: (http://missingfaktor.blogspot.in/2013/07/easing-use-of-embedded-document-pattern.html)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/embedded_document.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'embedded_document/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'embedded_document'
+  spec.version       = EmbeddedDocument::VERSION
+  spec.authors       = ['Sumit Mahamuni', 'Rahul Phulore']
+  spec.email         = ['mahamunisumit@gmail.com']
+  spec.summary       = %q{Convenient way of dealing with JSON documents in web apps}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-debugger'
+end

data/lib/embedded_document.rb

@@ -0,0 +1,27 @@
+require 'embedded_document/version'
+require 'embedded_document/embedders'
+require 'embedded_document/embedder_combinators'
+
+module EmbeddedDocument
+  class Document < Struct.new(:data)
+    extend Embedders
+    extend EmbedderCombinators
+
+    def self.key(name, embedder, accessor_name = nil)
+      name = name.to_s
+      accessor_name ||= name
+      define_method(accessor_name) do
+        embedder.call(self.data[name])
+      end
+    end
+
+    def self.call(value)
+      self.new(value)
+    end
+
+    def method_missing name
+      return self.data[name.to_s] if self.data[name.to_s]
+      super name
+    end
+  end
+end

data/lib/embedded_document/embedder_combinators.rb

@@ -0,0 +1,11 @@
+module EmbeddedDocument
+  module EmbedderCombinators
+    def sequence_of embedder
+      lambda { |array| array.map { |x| embedder.call(x) } }
+    end
+
+    def defaulted embedder, default_value
+      lambda { |value| value.nil? ? default_value : embedder.call(value) }
+    end
+  end
+end

data/lib/embedded_document/embedders.rb

@@ -0,0 +1,11 @@
+module EmbeddedDocument
+  module Embedders
+    def identity
+      lambda { |x| x }
+    end
+
+    def datetime
+      lambda { |x| DateTime.parse x }
+    end
+  end
+end

data/lib/embedded_document/version.rb

@@ -0,0 +1,3 @@
+module EmbeddedDocument
+  VERSION = '0.0.2'
+end

data/spec/lib/embedded_document_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe EmbeddedDocument::Document do
+  context '.key' do
+    class AnyEmbedder < EmbeddedDocument::Document
+      key :anykey, identity, :any_key
+      key :example_key, identity
+    end
+
+    it 'should define instance method with accessor_name' do
+      expect { AnyEmbedder.new({}).any_key }.not_to raise_error
+    end
+
+    it 'should define instance method key_name if accessor_name is not given' do
+      expect { AnyEmbedder.new({}).example_key }.not_to raise_error
+    end
+
+    it 'should return value for undefined_key if data contains key' do
+      expect(AnyEmbedder.new({'undefined_key' => 'anything'}).undefined_key).to eq('anything')
+    end
+
+    it 'should raise no method error if data key is missing' do
+      expect { AnyEmbedder.new({}).missing_key }.to raise_error(NoMethodError)
+    end
+  end
+end

data/spec/lib/embedder_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'Embedder' do
+  class AnyEmbedder < EmbeddedDocument::Document
+    key :anyKey, identity, :any_key
+  end
+
+  class NestedEmbedderExample < EmbeddedDocument::Document
+    key :anyEmbedder, AnyEmbedder, :any_embedder
+  end
+
+  class NestedSequenceEmbedderExample < EmbeddedDocument::Document
+    key :anyEmbedders, sequence_of(AnyEmbedder), :any_embedders
+  end
+
+  class DefaultedEmbedderExample < EmbeddedDocument::Document
+    key :anyEmbedder, defaulted(identity, 0), :any_embedder
+  end
+
+  it 'should return any_key value' do
+    subject = AnyEmbedder.new({'anyKey' => 'anything'})
+
+    expect(subject.any_key).to eq('anything')
+  end
+
+  it 'should return any_embedder' do
+    subject = NestedEmbedderExample.new({'anyEmbedder' => {'anyKey' => 'anything'}})
+
+    expect(subject.any_embedder).to be_a AnyEmbedder
+    expect(subject.any_embedder.any_key).to eq('anything')
+  end
+
+  it 'should return sequence of any_embedder' do
+    subject = NestedSequenceEmbedderExample.new({'anyEmbedders' => [{'anyKey' => 'anything'}]})
+
+    expect(subject.any_embedders).to be_a Array
+    expect(subject.any_embedders.first).to be_a AnyEmbedder
+  end
+
+  it 'should return default value if key is nil' do
+    subject = DefaultedEmbedderExample.new({'anyEmbedder' => nil})
+
+    expect(subject.any_embedder).to eq(0)
+  end
+
+  it 'should return value if key is not nil' do
+    subject = DefaultedEmbedderExample.new({'anyEmbedder' => 'anything'})
+
+    expect(subject.any_embedder).to eq('anything')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift 'lib'
+
+require 'embedded_document'
+require 'pry'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: embedded_document
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sumit Mahamuni
+- Rahul Phulore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- mahamunisumit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embedded_document.gemspec
+- lib/embedded_document.rb
+- lib/embedded_document/embedder_combinators.rb
+- lib/embedded_document/embedders.rb
+- lib/embedded_document/version.rb
+- spec/lib/embedded_document_spec.rb
+- spec/lib/embedder_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convenient way of dealing with JSON documents in web apps
+test_files:
+- spec/lib/embedded_document_spec.rb
+- spec/lib/embedder_spec.rb
+- spec/spec_helper.rb