conglomerate 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ecec2dd728808b6548bbd891a90a1ae6939afa1
-  data.tar.gz: a109f0656695f3abbfa1d99e4c71055cfc434c59
+  metadata.gz: f9f3f14b27e132968770842dd2d3fe7796a25fbc
+  data.tar.gz: 2174933a1f8470094242bbb92f77f967aaaa0dfc
 SHA512:
-  metadata.gz: 0e2f0834e369486e5d9e8d16d99d3d9683736b62a195713155b5dde44101ef0375ae59405d81cec6562f1ce3a39cc6fb108e239912a2b37a75ced1b76dafeae6
-  data.tar.gz: 466427fff930ebd97cbe510116ba80ad5075be0d15b2387c21e69475e0455b21bf26fcd6201c605533e705f6c7386d92c532e78d860edc4237fbff3e90c01a7e
+  metadata.gz: 080da2cec601bb44e310a6afad4dad3560bd47aa56f2de7feb0f9aef7ced1049fe5547d15028965583fe47e66486c42f9ad909458e7743ca0449635bfd211770
+  data.tar.gz: f5b2ea4b96a812f0f54d5b12a0f5bf5212d8af9d8441d4d8397bfe6586a63f8bfd7594eb21a0ed8236fb1fcaff88fe62b83813ce29b6a2e16b0fa9099e430218

data/.gitignore

@@ -8,6 +8,7 @@ InstalledFiles
 _yardoc
 coverage
 doc/
+bin/
 lib/bundler/man
 pkg
 rdoc

data/conglomerate.gemspec

@@ -6,7 +6,7 @@ require "conglomerate/version"
 Gem::Specification.new do |spec|
   spec.name          = "conglomerate"
   spec.version       = Conglomerate::VERSION
-  spec.authors       = ["Shane Emmons"]
+  spec.authors       = ["Shane Emmons", "Emily Dobervich"]
   spec.email         = ["oss@teamsnap.com"]
   spec.summary       = "A library to serialize Ruby objects into collection+json"
   spec.description   = "A library to serialize Ruby objects into collection+json"

data/lib/conglomerate/array.rb

@@ -0,0 +1,30 @@
+module Conglomerate
+  class Array
+    include Enumerable
+
+    def initialize(type)
+      self.type = type
+      self.storage = []
+    end
+
+    def <<(val)
+      if type
+        raise "TypeMismatch" unless val.is_a?(type)
+      end
+
+      storage << val
+    end
+
+    def empty?
+      storage.empty?
+    end
+
+    def each(&block)
+      storage.each(&block)
+    end
+
+    private
+
+    attr_accessor :storage, :type
+  end
+end

data/lib/conglomerate/collection.rb

@@ -0,0 +1,15 @@
+module Conglomerate
+  class Collection
+    include Particle
+
+    attribute :version, :default => "1.0"
+    attribute :href
+
+    attribute :template, :type => Template
+    attribute :error, :type => Error
+
+    array :items, :contains => Item
+    array :links, :contains => Link
+    array :queries, :contains => Query
+  end
+end

data/lib/conglomerate/datum.rb

@@ -0,0 +1,9 @@
+module Conglomerate
+  class Datum
+    include Conglomerate::Particle
+
+    attribute :name, :type => String, :required => true
+    attribute :value
+    attribute :prompt, :type => String
+  end
+end

data/lib/conglomerate/error.rb

@@ -0,0 +1,9 @@
+module Conglomerate
+  class Error
+    include Conglomerate::Particle
+
+    attribute :title, :type => String
+    attribute :code, :type => String
+    attribute :message, :type => String
+  end
+end

data/lib/conglomerate/item.rb

@@ -0,0 +1,10 @@
+module Conglomerate
+  class Item
+    include Conglomerate::Particle
+
+    attribute :href, :type => String
+
+    array :data, :contains => Datum
+    array :links, :contains => Link
+  end
+end

data/lib/conglomerate/link.rb

@@ -0,0 +1,11 @@
+module Conglomerate
+  class Link
+    include Conglomerate::Particle
+
+    attribute :href, :type => String, :required => true
+    attribute :rel, :type => String, :required => true
+    attribute :name, :type => String
+    attribute :render, :type => String
+    attribute :prompt, :type => String
+  end
+end

data/lib/conglomerate/particle.rb

@@ -0,0 +1,73 @@
+module Conglomerate
+  module Particle
+    def self.included(object)
+      object.send(:extend, ClassMethods)
+    end
+
+    def initialize(attributes = {})
+      self.class.attributes.each do |attr, attr_metadata|
+        if attr_metadata[:required]
+          raise "MissingAttribute" unless attributes[attr] || attributes[attr.to_s]
+        end
+
+        if attr_metadata[:type] == :array
+          self.instance_variable_set("@#{attr}", Conglomerate::Array.new(attr_metadata[:contains]))
+        end
+      end
+
+      attributes.each do |key, value|
+        attrs = self.class.attributes
+        if attrs[key.to_sym] && attrs[key.to_sym][:type] == :array
+          array = value
+          value = Conglomerate::Array.new(attrs[key.to_sym][:contains])
+          array.each { |item| value << item }
+          self.instance_variable_set("@#{key}", value)
+        end
+
+        self.send("#{key}=", value) if self.respond_to?("#{key}=")
+      end
+    end
+
+    private
+
+    module ClassMethods
+      def self.extended(klass)
+        klass.instance_variable_set("@attributes", {})
+      end
+
+      def attributes
+        instance_variable_get("@attributes").dup
+      end
+
+      private
+
+      def array(attr, contains: nil, cull: true)
+        attribute(attr, :type => :array, :contains => contains, :cull => cull)
+      end
+
+      def attribute(attr, default: nil, type: nil, contains: nil, cull: true, required: nil)
+        instance_variable_get("@attributes")[attr] = {
+          :default => default,
+          :type => type,
+          :contains => contains,
+          :cull => cull,
+          :required => required
+        }
+
+        self.send(:attr_reader, attr)
+
+        if type != :array
+          self.send(:define_method, :"#{attr}=") do |val|
+            attr_metadata = self.class.attributes[attr]
+
+            if type = attr_metadata[:type]
+              raise "TypeMismatch" if !val.is_a?(type)
+            end
+
+            self.instance_variable_set("@#{attr}", val)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conglomerate/query.rb

@@ -0,0 +1,12 @@
+module Conglomerate
+  class Query
+    include Conglomerate::Particle
+
+    attribute :href, :type => String, :required => true
+    attribute :rel, :type => String, :required => true
+    attribute :name, :type => String
+    attribute :prompt, :type => String
+
+    array :data, :contains => Datum
+  end
+end

data/lib/conglomerate/root.rb

@@ -0,0 +1,6 @@
+module Conglomerate
+  class Root
+    include Particle
+    attribute :collection
+  end
+end

data/lib/conglomerate/template.rb

@@ -0,0 +1,7 @@
+module Conglomerate
+  class Template
+    include Conglomerate::Particle
+
+    array :data, :contains => Datum
+  end
+end

data/lib/conglomerate/tree_deserializer.rb

@@ -0,0 +1,53 @@
+module Conglomerate
+  class TreeDeserializer
+    PARTICLES = [Collection, Item, Error, Template, Datum, Query, Item]
+
+    def initialize(object)
+      self.object = object
+    end
+
+    def deserialize(item = object)
+      raise "ObjectNotCollectionRoot" if !object["collection"]
+      deserialize_particle(object["collection"], Collection)
+    end
+
+    private
+
+    attr_accessor :object
+
+    def deserialize_particle(object, klass)
+      attributes = {}
+      attribute_info = klass.attributes
+
+      attribute_info.each do |attr, attr_metadata|
+        attr = attr.to_s
+        if object[attr]
+          attributes[attr] = deserialize_attribute(object[attr], attr_metadata)
+        end
+      end
+
+      particle = klass.new(attributes)
+    end
+
+    def deserialize_attribute(attribute, attr_metadata)
+      if PARTICLES.include?(attr_metadata[:type])
+        deserialize_particle(attribute, attr_metadata[:type])
+      elsif attr_metadata[:type] == :array
+        raise "ArrayExpected" unless attribute.is_a?(::Array)
+        deserialize_array(attribute, attr_metadata[:contains])
+      else
+        attribute
+      end
+    end
+
+    def deserialize_array(items, contains)
+      array = Conglomerate::Array.new(contains)
+
+      items.each do |item|
+        array << deserialize_particle(item, contains)
+      end
+
+      array
+    end
+  end
+end

data/lib/conglomerate/tree_serializer.rb

@@ -0,0 +1,48 @@
+module Conglomerate
+  class TreeSerializer
+    def initialize(object)
+      self.object = object
+    end
+
+    def serialize(item = object)
+      if Conglomerate::Particle === item
+        serialize_particle(item)
+      elsif Conglomerate::Array === item
+        serialize_array(item)
+      elsif Array === item
+        serialize_array(item)
+      elsif item.is_a?(Numeric) || item.is_a?(String) || item.nil?
+        item
+      end
+    end
+
+    private
+
+    attr_accessor :object
+
+    def serialize_particle(particle)
+      attributes = particle.class.attributes
+
+      attributes.inject({}) do |hash, (attr, attr_metadata)|
+        hash.tap do |h|
+          attribute = particle.send(attr)
+          attribute ||= attr_metadata[:default]
+
+          unless attr_metadata[:cull] && cull_attribute(attribute)
+            h[attr.to_s] = serialize(attribute)
+          end
+        end
+      end
+    end
+
+    def serialize_array(array)
+      array.map do |item|
+        serialize(item)
+      end
+    end
+
+    def cull_attribute(attribute)
+      !attribute || (Conglomerate::Array === attribute && attribute.empty?)
+    end
+  end
+end

data/lib/conglomerate/version.rb

@@ -1,3 +1,3 @@
 module Conglomerate
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/conglomerate.rb

@@ -1,6 +1,21 @@
+require_relative "conglomerate/tree_serializer"
+require_relative "conglomerate/array"
+require_relative "conglomerate/particle"
 require_relative "conglomerate/serializer"
+require_relative "conglomerate/link"
+require_relative "conglomerate/error"
+require_relative "conglomerate/datum"
+require_relative "conglomerate/template"
+require_relative "conglomerate/item"
+require_relative "conglomerate/query"
+require_relative "conglomerate/collection"
+require_relative "conglomerate/tree_deserializer"
 
 module Conglomerate
+  def self.serialize(serializable)
+    Conglomerate::TreeSerializer.new(serializable).serialize
+  end
+
   def self.serializer
     Module.new do
       def self.included(descendant)

data/spec/collection_spec.rb

@@ -0,0 +1,40 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+describe Conglomerate::Collection do
+  let(:collection) { Conglomerate::Collection.new }
+  subject(:serialized_empty_collection) { Conglomerate.serialize(collection) }
+  subject(:reference_empty_collection) {
+    {
+      "version" => "1.0"
+    }
+  }
+
+  it "empty collection serializes properly" do
+    expect(serialized_empty_collection).to eq(reference_empty_collection)
+  end
+
+  context "links" do
+    it "serializes links correctly" do
+      link = Conglomerate::Link.new(
+        :href => "http://this.is.a.link",
+        :rel => "Something"
+      )
+
+      collection.links << link
+      expect(Conglomerate.serialize(collection)["links"]).to include(Conglomerate.serialize(link))
+    end
+  end
+
+  context "queries" do
+    it "serializes queries correctly" do
+      query = Conglomerate::Query.new(
+        :href => "http://this.is.a.query",
+        :rel => "Something"
+      )
+
+      collection.queries << query
+      expect(Conglomerate.serialize(collection)["queries"]).to include(Conglomerate.serialize(query))
+    end
+  end
+end

data/spec/datum_spec.rb

@@ -0,0 +1,23 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+describe Conglomerate::Datum do
+  context "required attributes" do
+    specify "name" do
+      expect { Conglomerate::Datum.new }.to raise_error("MissingAttribute")
+    end
+  end
+
+  context "optional attributes" do
+    specify "value" do
+      datum = Conglomerate::Datum.new(:name => "name")
+      expect(datum).to respond_to(:"value=")
+    end
+
+    specify "prompt" do
+      datum = Conglomerate::Datum.new(:name => "name")
+      expect(datum).to respond_to(:"prompt=")
+      expect { datum.prompt = 3 }.to raise_error
+    end
+  end
+end

data/spec/link_spec.rb

@@ -0,0 +1,14 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+describe Conglomerate::Link do
+  context "required attributes" do
+    specify "href" do
+      expect { Conglomerate::Link.new(:rel => "") }.to raise_error("MissingAttribute")
+    end
+
+    specify "rel" do
+      expect { Conglomerate::Link.new(:href => "") }.to raise_error("MissingAttribute")
+    end
+  end
+end

data/spec/particle_spec.rb

@@ -0,0 +1,30 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+class ParticleTest
+  include Conglomerate::Particle
+
+  attribute :default, :default => "this is the default value"
+  attribute :string, :type => String
+end
+
+describe Conglomerate::Particle do
+  subject(:serialized_particle_test) { Conglomerate.serialize(ParticleTest.new) }
+  subject(:mass_assigned) { ParticleTest.new(:string => "An string", :default => "Not an default") }
+
+  it "default values are exposed when serialized" do
+    expect(serialized_particle_test["default"]).to eq("this is the default value")
+  end
+
+  it "enforces type on attributes" do
+    particle_test = ParticleTest.new
+    expect {
+      particle_test.string = 1
+    }.to raise_error("TypeMismatch")
+  end
+
+  it "allows mass-assignment via constructor" do
+    expect(mass_assigned.string).to eq("An string")
+    expect(mass_assigned.default).to eq("Not an default")
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,30 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+describe Conglomerate::Query do
+  let(:query) {
+    Conglomerate::Query.new(
+      :href => "http://this.is.a.query/",
+      :rel => "some_query"
+    )
+  }
+
+  context "required attributes" do
+    specify "href" do
+      expect { Conglomerate::Query.new(:rel => "") }.to raise_error("MissingAttribute")
+    end
+
+    specify "rel" do
+      expect { Conglomerate::Query.new(:href => "") }.to raise_error("MissingAttribute")
+    end
+  end
+
+  context "data" do
+    it "serializes properly" do
+      datum = Conglomerate::Datum.new(:name => "name")
+
+      query.data << datum
+      expect(Conglomerate.serialize(query)["data"]).to include(Conglomerate.serialize(datum))
+    end
+  end
+end

data/spec/tree_deserializer_spec.rb

@@ -0,0 +1,38 @@
+require_relative "spec_helper"
+require_relative "../lib/conglomerate"
+
+require "json"
+
+describe Conglomerate::TreeDeserializer do
+  it "deserializes collection with error" do
+    json = '{"collection":{"version":"1.0","href":"https://apiv3.teamsnap.com/","links":[{"rel":"root","href":"https://apiv3.teamsnap.com/"},{"rel":"self","href":"https://apiv3.teamsnap.com/"}],"error":{"message":"translation missing: en.errors.messages.unauthorized"}}}'
+    obj = JSON.parse(json)
+    deserializer = Conglomerate::TreeDeserializer.new(obj)
+    tree = deserializer.deserialize
+
+    expect(tree.class).to eq(Conglomerate::Collection)
+    expect(tree.error.class).to eq(Conglomerate::Error)
+    expect(tree.href).to eq("https://apiv3.teamsnap.com/")
+  end
+
+  it "deserializes collection with items" do
+    obj = {
+      "collection" => {
+        "version" => "1.0",
+        "href" => "http://example.com/",
+        "items" => [
+          { "href" => "http://example.com/1", "data" => [{
+            "name" => "is_unicorn", "value" => true
+          }]}
+        ]
+      }
+    }
+
+    deserializer = Conglomerate::TreeDeserializer.new(obj)
+    tree = deserializer.deserialize
+
+    expect(
+      tree.items.first.data.find { |datum| datum.name == "is_unicorn" }.value
+    ).to eq(true)
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: conglomerate
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Shane Emmons
+- Emily Dobervich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,10 +67,28 @@ files:
 - Rakefile
 - conglomerate.gemspec
 - lib/conglomerate.rb
+- lib/conglomerate/array.rb
+- lib/conglomerate/collection.rb
+- lib/conglomerate/datum.rb
+- lib/conglomerate/error.rb
+- lib/conglomerate/item.rb
+- lib/conglomerate/link.rb
+- lib/conglomerate/particle.rb
+- lib/conglomerate/query.rb
+- lib/conglomerate/root.rb
 - lib/conglomerate/serializer.rb
+- lib/conglomerate/template.rb
+- lib/conglomerate/tree_deserializer.rb
+- lib/conglomerate/tree_serializer.rb
 - lib/conglomerate/version.rb
+- spec/collection_spec.rb
 - spec/conglomerate_spec.rb
+- spec/datum_spec.rb
+- spec/link_spec.rb
+- spec/particle_spec.rb
+- spec/query_spec.rb
 - spec/spec_helper.rb
+- spec/tree_deserializer_spec.rb
 homepage: https://github.com/teamsnap/conglomerate
 licenses:
 - MIT
@@ -95,5 +114,11 @@ signing_key:
 specification_version: 4
 summary: A library to serialize Ruby objects into collection+json
 test_files:
+- spec/collection_spec.rb
 - spec/conglomerate_spec.rb
+- spec/datum_spec.rb
+- spec/link_spec.rb
+- spec/particle_spec.rb
+- spec/query_spec.rb
 - spec/spec_helper.rb
+- spec/tree_deserializer_spec.rb