cot 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce57021ecbcd6f8ea2c6952a36d4ea28b38bf99
-  data.tar.gz: 26f2711ae9016dda7b0c633bae9e9f3a04821e44
+  metadata.gz: 80b8c78bd9fd2bedc92cfd64079c168662910a8b
+  data.tar.gz: d9f342d772816b891a3fa12d5db8a468e1bd0a58
 SHA512:
-  metadata.gz: 9b38415ebef6aec060d976c7f235ecb20db19d823ec131a3367d600a37484e69b4525a6ebd3f0b0f37b7745893ec78e4de6cdd1095517caf664d8f08b68a550c
-  data.tar.gz: ef4bc4c2b3129929629ae8ec2ff582eba6ac915b51d83d1008cc90f5367ba8ed5d4ce5759200a3d7632ae0b255e74c02a7ad7ba0a7f886b501c94832fcc00f60
+  metadata.gz: b6e988adce02b522f15553a385ecef83d990a08b2ae9b8065fdfc0fd3ce0089ec3a9f35c93f1719e46d936383f6300adcb6c0dfd2f335fb137fc40d181d94b21
+  data.tar.gz: 5f701c6224a24df45a82eee77fd87bf6fcb3a55788e37836bce51dec8988150dd7eccbca623764b1369d0eb0c996665df43b533c034e2509aea93e2c2fbb7589

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,58 @@ cot
 
 Cot is a gem designed to help convert rest based resources into ruby objects.  Currently it only handles converting the responses into objects and doesn't deal with the requests themselves, there are plenty of gems for that out there.
 
-### Usage
+### Example
+
+```ruby
+class NestedClass < Cot::Frame
+  property :parent_id
+  property :foo, from: :bar
+end
+
+class ExampleObject < Cot::Frame
+  property :id
+  property :name, :searchable => true
+  property :company_name, :from => :companyName
+  property :item do
+    from :place
+    value do |params|
+      NestedClass.new params.merge parent_id: id
+    end
+  end
+  enum :types do
+    entry :first
+    entry :third, value: 3
+    entry :fourth
+  end
+  search_property :created_at, :from => :createdOn
+end
+
+class ExampleCollection < Cot::Collection
+  def initialize(objects, options = {})
+    super ExampleObject, objects, options
+  end
+end
+
+thingy = ExampleObject.new(id: :my_id, name: 'awesome name', createdOn: Time.now, place: {bar: 'this is nested.foo'})
+thingy.id # 5
+thingy.name # awesome name
+ExampleObject.types.first # 1
+thingy.types.fourth # 4
+thingy.item # NestedClass instance
+thingy.item.foo # 'this is nested.foo'
+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 }], { default_attributes: { default: :attribute }
+collection.first.name # 'awesome name'
+collection.first.default # :attribute
+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'
+```
+
+
+### Details
 
 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.
 
@@ -12,8 +63,8 @@ Frame provides some helpful methods:
     - property
       - The first parameter is the name of the property and it is added as a method to the object.
       - You can pass additional options in two ways, first you can pass a hash of options to property and secondly you can pass a block to property.
-      - There are three optional arguments, value, from and searchable.  
-      - From indicates that the property has an alternate key in the incoming/outgoing data.  
+      - There are three optional arguments, value, 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.
       - Value takes a block and overwrites the value of the property to be the result of the block
         - This is useful for nested objects.
@@ -21,6 +72,7 @@ Frame provides some helpful methods:
         - The block takes one parameter, which is the value of the hash for that key (what the value would have been if there was no value block).
     - 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 takes a name and a block
+      - Enums are defined on the instances and the class
       - The block expects a series of entries to be declared
       - enum starts counting at 1 by default
       - Each entry will have the value of 1 higher than the previous by default
@@ -49,42 +101,3 @@ Collection provides the following methods:
   - 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
-  property :id
-  property :name, :searchable => true
-  property :company_name, :from => :companyName
-  property :item do
-    from :place
-    value do |params|
-      MyClass.new params.merge parent_id: id
-    end
-  end
-  enum :types do
-    entry :first
-    entry :third, value: 3
-    entry :fourth
-  end
-  search_property :created_at, :from => :createdOn
-end
-
-class ExampleCollection < Cot::Collection
-  def initialize(objects, options = {})
-    super ExampleObject, objects, options
-  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 }], { default_attributes: { default: :attribute }
-collection.first.name # 'awesome name'
-collection.first.default # :attribute
-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/frame_class_methods.rb

@@ -17,6 +17,9 @@ module Cot
     def enum(name, &block)
       obj = Enum.new
       obj.instance_eval(&block)
+      define_singleton_method name do
+        obj
+      end
       define_method name do
         obj
       end

data/lib/cot/version.rb

@@ -1,3 +1,3 @@
 module Cot
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/lib/cot/frame_spec.rb

@@ -181,16 +181,32 @@ describe Cot::Frame do
       end
       @foo = TestObject.new
     end
-    it 'sets the value starting at 1' do
-      expect(@foo.types.first).to eq 1
-    end
+    context 'object' do
+      it 'sets the value starting at 1' do
+        expect(@foo.types.first).to eq 1
+      end
 
-    it 'allows the value to be set' do
-      expect(@foo.types.third).to eq 3
+      it 'allows the value to be set' do
+        expect(@foo.types.third).to eq 3
+      end
+
+      it 'increments after the next value' do
+        expect(@foo.types.fourth).to eq 4
+      end
     end
 
-    it 'increments after the next value' do
-      expect(@foo.types.fourth).to eq 4
+    context 'class' do
+      it 'sets the value starting at 1' do
+        expect(TestObject.types.first).to eq 1
+      end
+
+      it 'allows the value to be set' do
+        expect(TestObject.types.third).to eq 3
+      end
+
+      it 'increments after the next value' do
+        expect(TestObject.types.fourth).to eq 4
+      end
     end
 
     it 'does not allow duplicates' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Joseph Henrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel