cot 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8718cf838c838590a4c3c8fa565d136d3de861b9
-  data.tar.gz: 875186e08f60fe759f77ddeab1b0f50aa6ba3a25
+  metadata.gz: b47b0825bf582a0dded1ff4736bef69945d6f485
+  data.tar.gz: f10875feef7630460c617c154dd6564bb1eb210a
 SHA512:
-  metadata.gz: e08b26c691f494eaff718912b694c13fd92a850bf928f3f67ede2510cbc5a16b63522c6e06318ad8f3ff256a439b25639cb92b73016348287b79697b992083d4
-  data.tar.gz: bd6f6bdcda4fd1499b936fe93c79fcdde2e8353cebcafa8872f21bb3e3956fb325f7fa74560e1314187b7d9eddf03e37192ccd411c4e38fd08dffc544a96a148
+  metadata.gz: b1c6d69f790c266a5e73a29d4ed74dbb491d0f2111a3f1224c03abcc87e4520822ebd094e8a6979a77ede993cfb64a5e78187ce1a506468c5c8a62e0ba5f20e2
+  data.tar.gz: 155a93d43a4b96ed4f71d3e4e08653c251b4235ba4d35f53d61396327136e103b3a8972b66e809bd96a9896764f29bbe24d52e85e2275412a36b5c42fcb696b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cot (0.1.2)
+    cot (0.2.0)
       activemodel
 
 GEM

data/README.md

@@ -5,12 +5,13 @@ Cot is a gem designed to help convert rest based resources into ruby objects.  C
 
 ### Usage
 
-Using cot is pretty simple, include it in your project and then have your class inherit from Cot::Frame.
+Using cot is pretty simple. There are two main classes: Collection and Frame. Collections are basically big arrays that contain objects (presumably Frame objects). Collection provides some helper methods to manage the collection, but also delegates to Array, so each, map and all that good stuff are there as well. Frame allows you to declare how the object will convert a json payload into an object.
 
 Frame provides some helpful methods:
 - Class Methods
     - property adds the first parameter as an accessor on the object.  There are two optional arguments, from and searchable.  From indicates that the property has an alternate key in the incoming/outgoing data.  Searchable adds the property to the search mappings.
     - search\_property adds the parameter to the search mapping.  It takes an optional from argument which inidates the property has an alternate key in the incoming/outgoing data.
+    - enum *NOT SUPPORTED* If you'd like to see this let me know. Also let me know what you'd want it to look like.
 - Instance Methods
     - defined\_properties returns a list of the defined properties
     - properties\_mapping returns a hash containing all of the renamed properties.  The keys are the values of the from argument and the values are the property name.
@@ -19,6 +20,18 @@ Frame provides some helpful methods:
     - inverted\_search\_mappings returns an inverted search\_mappings hash.
     - serializable\_hash returns hash with the correct keys to post back.  AKA, it reverts the keys to what the from arguments (if any) were.
     - to\_json returns a json encoded version of serializable\_hash.
+    - valid? true if errors is empty
+    - errors used to store any errors associated with the object
+
+Collection provides the following methods:
+- Instance Methods
+  - The following methods collate the results from members
+    - serializable\_hash
+    - to\_json
+    - errors (pulls into a hash with member.id as the key)
+  - exists? returns true if *all* the members exist
+  - changed? returns true if *any* of the members have changed
+  - update\_members updates the members of the collection to based on the payload (this can add or remove members)
 
 ```ruby
 class ExampleObject < Cot::Frame
@@ -28,9 +41,21 @@ class ExampleObject < Cot::Frame
   search_property :created_at, :from => :createdOn
 end
 
+class ExampleCollection < Cot::Collection
+  def initialize(params)
+    super ExampleObject, params
+  end
+end
+
 thingy = ExampleObject.new(id: :my_id, name: 'awesome name', createdOn: Time.now)
 thingy.id # 5
 thingy.name # awesome name
 thingy.created_at # what time it is now
 thingy.defined\_properties # [:id, :name, :created_at]
+
+collection = ExampleCollection.new [{ id: :my_id, name: 'awesome name', createdOn: Time.now }, { id: :my_id, name: 'awesome name', createdOn: Time.now }]
+collection.first.name # 'awesome name'
+collection.exists? # Do all of the entries exist?
+collection.update_members [{ id: 1, name: 'new awesome name', createdOn: Time.now }, { id: 2, name: 'new awesome name', createdOn: Time.now }]
+collection.first.name # 'new awesome name'
 ```

data/lib/cot.rb

@@ -2,10 +2,8 @@ require 'active_model'
 
 require 'cot/version'
 require 'cot/frame'
+require 'cot/collection'
 require 'json'
 
 module Cot
-  def version_string
-    "Cot version #{Cot::VERSION}"
-  end
 end

data/lib/cot/collection.rb

@@ -0,0 +1,55 @@
+module Cot
+  class Collection < SimpleDelegator
+    def initialize(klass, objects, sub_key = false)
+      @klass = klass
+      @sub_key = sub_key
+      @objects = objects
+
+      # If you pass in different types of things here we can't be friends
+      initialize_objects(objects) unless objects.first.is_a? klass
+
+      super @objects
+    end
+
+    def serializable_hash
+      @objects.map(&:serializable_hash)
+    end
+
+    def to_json
+      serializable_hash.to_json
+    end
+
+    def exists?
+      @objects.map(&:exists?).all?
+    end
+
+    def errors
+      Hash[@objects.reject { |x| x.valid? }.map { |x| [x.id, x.errors] }]
+    end
+
+    def update_members(payload)
+      # NOTE: replacing objects is lazy, but I don't want to deal with updating and such right now
+      initialize_objects(payload)
+    end
+
+    def changed?
+      @objects.map(&:changed?).include? true
+    end
+
+    private
+
+    def initialize_objects(objects)
+      @objects = []
+      @objects = objects.map do |payload|
+        if @sub_key
+          @klass.new payload[@sub_key]
+        else
+          @klass.new payload
+        end
+      end
+
+      # Set the delegator methods to point to the new objects array
+      __setobj__(@objects)
+    end
+  end
+end

data/lib/cot/frame.rb

@@ -6,6 +6,7 @@ module Cot
     include ActiveModel::Dirty
 
     def initialize(payload = {})
+      @errors = {}
       @data = convert_keys payload
     end
 
@@ -68,6 +69,8 @@ module Cot
       define_attribute_method name
     end
 
+    attr_accessor :errors
+
     def [](key)
       @data[convert_key key]
     end
@@ -76,6 +79,10 @@ module Cot
       @data[convert_key key] = value
     end
 
+    def valid?
+      errors.empty?
+    end
+
     def to_json
       serializable_hash.to_json
     end

data/lib/cot/version.rb

@@ -1,3 +1,3 @@
 module Cot
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/spec/lib/cot/collection_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+class FakeDouble < Cot::Frame
+  property :id
+  property :foo
+  property :fooy
+end
+
+describe Cot::Collection do
+  let(:obj1) { FakeDouble.new id: 1, foo: :bar }
+  let(:obj2) { FakeDouble.new id: 2, foo: :bar }
+  subject(:collection) { Cot::Collection.new FakeDouble, [obj1, obj2] }
+
+  context 'array like' do
+    it 'should take an array of objects and store them in a hash' do
+      expect(collection.length).to eq 2
+    end
+
+    it 'should respond to array methods' do
+
+      # In theory we'd test more, but that's good enough for me
+      expect(collection).to respond_to :[]
+      expect(collection).to respond_to :first
+      expect(collection).to respond_to :reverse
+    end
+  end
+
+  context 'serializable_hash' do
+    it 'is an array' do
+      expect(collection.serializable_hash).to be_kind_of Array
+    end
+
+    it 'has hash members' do
+      expect(collection.serializable_hash.first).to be_kind_of Hash
+    end
+  end
+
+  context 'to_json' do
+    it 'returns a string' do
+      expect(collection.to_json).to be_kind_of String
+    end
+
+    it 'is parseable json' do
+      expect(JSON.parse(collection.to_json)).to be_kind_of Array
+    end
+  end
+
+  context 'exists?' do
+    it 'returns true if all the objects exist' do
+      expect(obj1).to receive(:exists?).and_return true
+      expect(obj2).to receive(:exists?).and_return true
+      expect(collection.exists?).to be true
+    end
+
+    it 'returns false if any of the objects do not exist' do
+      expect(obj1).to receive(:exists?).and_return true
+      expect(obj2).to receive(:exists?).and_return false
+      expect(collection.exists?).to be false
+    end
+  end
+
+  context 'errors' do
+    it 'is empty if there are no errors' do
+      expect(collection.errors).to be_empty
+    end
+
+    it 'collates the errors of the contained objects' do
+      obj2.errors = { status: 400 }
+      expect(collection.errors.size).to be 1
+      expect(collection.errors[2]).to have_key :status
+    end
+  end
+
+  context 'initialize' do
+    it 'does not process the objects if they are already the correct class' do
+      coll = Cot::Collection.new FakeDouble, [FakeDouble.new(fooy: :bar), FakeDouble.new(asdf: :fdas)]
+      expect(coll.first).to be_kind_of FakeDouble
+    end
+
+    it 'creates new instances of the passed klass if the objects are not already the class' do
+      coll = Cot::Collection.new FakeDouble, [{ fooy: :bar }, { asdf: :fdas }]
+      expect(coll.first).to be_kind_of FakeDouble
+    end
+
+    it 'takes an optional sub_key to pull the object out of the payload' do
+      coll = Cot::Collection.new FakeDouble, [{ inner: { fooy: :bar } }, { inner: { asdf: :fdas } }], :inner
+      expect(coll.first).to be_kind_of FakeDouble
+      expect(coll.first.fooy).to eq :bar
+    end
+  end
+
+  context 'update members' do
+    it 'updates members' do
+      coll = Cot::Collection.new FakeDouble, [{ fooy: :bar }]
+      expect(coll.length).to eq 1
+      coll.update_members [{ id: 123, foo: :bar }]
+      expect(coll.first.id).to eq 123
+    end
+
+    it 'removes members that are not in the payload' do
+      coll = Cot::Collection.new FakeDouble, [{ fooy: :bar }, { asdf: :fdas }]
+      expect(coll.length).to eq 2
+      coll.update_members [{ id: 123, foo: :bar }]
+      expect(coll.first.id).to eq 123
+      expect(coll.length).to eq 1
+    end
+  end
+
+  context 'changed?' do
+    it 'returns true if one of the objects has changed' do
+      coll = Cot::Collection.new FakeDouble, [{ fooy: :bar }]
+      coll.first.fooy = 'baz'
+      expect(coll.changed?).to be true
+    end
+
+    it 'return false if none of the objects have changed' do
+      coll = Cot::Collection.new FakeDouble, [{ fooy: :bar }]
+      expect(coll.changed?).to be false
+    end
+  end
+end

data/spec/lib/cot/frame_spec.rb

@@ -52,6 +52,7 @@ describe Cot::Frame do
     it 'is true if id is present' do
       expect(@foo.exists?).to be_truthy
     end
+
     it 'is false if id is not present' do
       foo = TestObject.new(foo: 5)
       expect(foo.exists?).to be_falsey
@@ -61,6 +62,7 @@ describe Cot::Frame do
     it 'includes foo' do
       expect(@foo.defined_properties).to include :foo
     end
+
     it 'is an array' do
       expect(@foo.defined_properties).to be_kind_of Array
     end
@@ -100,6 +102,7 @@ describe Cot::Frame do
       expect(TestObject.mappings).to have_key :bar
       expect(TestObject.mappings[:bar]).to be :foo
     end
+
     it 'creates accessor methods' do
       foo = TestObject.new
       expect(foo).to respond_to :foo
@@ -116,4 +119,27 @@ describe Cot::Frame do
       expect(foo.foo).to eq 'this is foo'
     end
   end
+
+  context 'errors' do
+    it 'has an errors property' do
+      expect(@foo).to respond_to :errors
+      expect(@foo.errors).to be_empty
+    end
+  end
+
+  context 'errors=' do
+    it 'sets errors' do
+      @foo.errors = { status: 200 }
+      expect(@foo.errors[:status]).to eq 200
+    end
+  end
+  context 'enum' do
+    it 'is not implemented' do
+      expect do
+        class TestObject < Cot::Frame
+          enum 'asdf'
+        end
+      end.to raise_exception StandardError
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,9 @@ require 'simplecov'
 
 ENV['RAILS_ENV'] ||= 'test'
 
+require 'simplecov'
+SimpleCov.start
+
 require 'cot'
 require 'rspec'
 require 'rspec/its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Joseph Henrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -127,9 +127,11 @@ files:
 - Rakefile
 - cot.gemspec
 - lib/cot.rb
+- lib/cot/collection.rb
 - lib/cot/frame.rb
 - lib/cot/rspec/matchers.rb
 - lib/cot/version.rb
+- spec/lib/cot/collection_spec.rb
 - spec/lib/cot/frame_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/crimsonknave/cot
@@ -151,10 +153,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Simplifies creating models for rest based resources
 test_files:
+- spec/lib/cot/collection_spec.rb
 - spec/lib/cot/frame_spec.rb
 - spec/spec_helper.rb