rrod 1.0.0.alpha.7 → 1.0.0.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7c4fed6f4b07652c23c34383bad82edc55ef84f
-  data.tar.gz: ded28382a99937aecdf3d0f02718abc0f2dfb65f
+  metadata.gz: 21bcd59f68557a964682ed550e6f066b4b62d8c7
+  data.tar.gz: cb7eb976f82092d7013d48418a2de2dbcb1d4a7d
 SHA512:
-  metadata.gz: 70db13dd62184794148611c3fa4a1258ae1f560d52cb0cad10b6c677b1f4320bf6886cfb63d1a28c204d40c5549c4d01128633821a12ce2fb55672030d5e7369
-  data.tar.gz: eef5ddd4e356cdaf0e07d9e785d62c5bcf27260d3256146e4f7be73b2dfb976e0fdbe9f2ea8f01b0073de175209dac32ad4d521bf0d079e157dd7eaa96323bf6
+  metadata.gz: ebced7c3a04e6efe2a2b31bae0ee25eadebad2f2120dae03cc6ff646f98f4c7ca4e1a575398ae5a8655d4d69b79757121b4d9b2d3f473386602f414b087e2101
+  data.tar.gz: 084cdd4c9358b4c0ef399667bb5126b59594cec7f806490911865b1ecc37ebd16fb81feedcaeba8509f50821b4e244d1240cc65554fd6eda3aefd9531c451cec

data/lib/rrod/model/attribute.rb

@@ -30,6 +30,7 @@ module Rrod
       end
 
       def define
+        define_attribute_method
         define_attribute
         define_reader
         define_writer
@@ -65,6 +66,10 @@ module Rrod
         -> { Rrod::Model::Collection.new(self, model_class) }
       end
 
+      def define_attribute_method
+        model.define_attribute_method name
+      end
+
       def define_attribute
         _self = self # i am a shadow of self
         model.define_singleton_method(

data/lib/rrod/model/attribute_methods.rb

@@ -2,29 +2,40 @@ module Rrod
   module Model
     module AttributeMethods
       extend ActiveSupport::Concern
+      include ActiveModel::Dirty
 
       attr_accessor :_parent
 
+      included do
+        define_attribute_method :id
+      end
+
       def initialize(attributes = {})
         @attributes        = {}
         self.magic_methods = attributes.keys
         self.attributes    = attributes
+        changes_applied
       end
 
       def id
-        read_attribute :id
+        robject.key
       end
 
       def id=(value)
-        write_attribute :id, value
+        id_will_change! unless id == value
+        robject.key = value
       end
 
       # Returns a new hash with all of the object's attributes.
       # @return [Hash] the object's attributes
       def attributes
-        @attributes.keys.inject({}) { |acc, key|
-          acc.tap { |hash| hash[key] = respond_to?(key) ? public_send(key) : nil }
-        }
+        self.class.attributes.keys.inject({}) { |acc, key|
+        # @attributes.keys.inject({}) { |acc, key|
+          acc.tap { |hash| 
+            next hash unless self.class.attributes.keys.include?(key.to_s)
+            hash[key] = public_send(key)
+          }
+        }.tap { |hash| hash['id'] = id unless nested_model? }
       end
 
       # Mass assign the attributes of the object.
@@ -39,7 +50,7 @@ module Rrod
       # @param [Symbol, String] the key of the attribute to read
       # @return the attribute at the given key
       def read_attribute(key)
-        @attributes[key.to_s] || write_attribute(key, read_default(key))
+        @attributes[key.to_s] || read_default(key)
       end
       alias :[] :read_attribute
 
@@ -47,13 +58,22 @@ module Rrod
       # @param [Symbol, String] the key of the attribute to write
       # @param the value to write to attributes
       def write_attribute(key, value)
-        @attributes[key.to_s] = self.class.cast_attribute(key, value, self)
+        public_send("#{key}_will_change!") unless read_attribute(key) == value
+        cast_attribute(key, value)
       end
       alias :[]= :write_attribute
 
+      def cast_attribute(key, value)
+        @attributes[key.to_s] = self.class.cast_attribute(key, value, self)
+      end
+
       def read_default(key)
         method = "#{key}_default"
-        send(method) if respond_to?(method)
+        cast_attribute(key, public_send(method)) if respond_to?(method)
+      end
+
+      def nested_model?
+        _parent.present?
       end
 
       private

data/lib/rrod/model/collection.rb

@@ -20,7 +20,8 @@ module Rrod
       end
 
       def collection=(collection)
-        raise InvalidCollectionTypeError.new unless collection.respond_to?(:each)
+        message = "#{collection.inspect} does not respond to :each"
+        raise InvalidCollectionTypeError.new(message) unless collection.respond_to?(:each)
         collection.map { |member| push member }
       rescue InvalidMemberTypeError => e
         clear and raise e
@@ -49,6 +50,10 @@ module Rrod
         collection.all?(&:valid?)
       end
 
+      def inspect
+        %Q[[#{map(&:inspect).join(', ')}]]
+      end
+
       InvalidCollectionTypeError = Class.new(StandardError)
       InvalidMemberTypeError     = Class.new(StandardError)
     end

data/lib/rrod/model/finders.rb

@@ -59,8 +59,10 @@ module Rrod
         }
       end
 
+      # when searching documents do not come back with robjects,
+      # we must set the key manually on it via `id=`
       def instantiate(key, data)
-        new(data).tap { |instance| instance.id = key if key }
+        new data.merge(id: key)
       end
 
     end

data/lib/rrod/model/persistence.rb

@@ -15,7 +15,7 @@ module Rrod
       alias :new_record? :new?
 
       def save
-        persist
+        persist.tap { changes_applied }
       end
 
       def update(attributes)
@@ -26,8 +26,7 @@ module Rrod
  
       def persist
         bucket.enable_index!
-        robject.raw_data = to_json
-        robject.key = id unless id.nil?
+        robject.raw_data = to_json(except: :id)
         robject.store
         self.id = robject.key
         @persisted = true

data/lib/rrod/model/schema.rb

@@ -3,12 +3,13 @@ module Rrod
     module Schema
 
       RROD_ATTRIBUTE_PREFIX = "rrod_attribute_".freeze
+      ANONYMOUS             = "anonymous".freeze
 
       def attributes
         @attributes ||= public_methods.map(&:to_s).reduce({}) { |acc, method|
           next acc unless method.starts_with?(RROD_ATTRIBUTE_PREFIX)
           key = method[RROD_ATTRIBUTE_PREFIX.length..-1]
-          acc.tap { |hash| hash[key] = send(method) }
+          acc.tap { |hash| hash[key] = public_send(method) }
         }.with_indifferent_access
       end
      
@@ -18,8 +19,12 @@ module Rrod
       end
 
       def cast_attribute(key, value, instance)
-        attribute = attributes[key]
-        attribute ? attribute.cast(value, instance) : value
+        method = "#{RROD_ATTRIBUTE_PREFIX}#{key}"
+        if respond_to?(method)
+          public_send(method).cast(value, instance)
+        else
+          value
+        end
       end
 
       def nested_in(parent)
@@ -42,7 +47,7 @@ module Rrod
         when Rrod::Model
           value
         when Hash
-          instantiate(nil, value)
+          new(value)
         else
           raise UncastableObjectError.new("#{value.inspect} cannot be rrod_cast") unless Hash === value
         end

data/lib/rrod/model/serialization.rb

@@ -13,7 +13,7 @@ module Rrod
       end
      
       def to_json(options={})
-        MultiJson.dump serializable_hash(options) 
+        MultiJson.dump as_json(options)
       end
 
     end

data/lib/rrod/model.rb

@@ -23,9 +23,8 @@ module Rrod
         @bucket ||= client[bucket_name]
       end
 
-      # TODO make class attribute
       def bucket_name
-        name.tableize
+        (name.presence || Rrod::Model::Schema::ANONYMOUS).tableize
       end
     end
 
@@ -36,5 +35,18 @@ module Rrod
     def bucket
       self.class.bucket
     end
+
+    def inspect
+      %Q[#<#{inspect_name} attributes: #{inspect_attributes} object_id: #{object_id}>]
+    end
+
+    def inspect_name
+      storage_name = nested_model? ?  "(nested)" : "[#{bucket.name}]"
+      "#{self.class.name || self.class.to_s}#{storage_name}"
+    end
+
+    def inspect_attributes
+      %Q[{#{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')}}]
+    end
   end
 end

data/lib/rrod/version.rb

@@ -1,2 +1,2 @@
 Rrod = Module.new unless defined? Rrod
-Rrod::VERSION = '1.0.0.alpha.7'
+Rrod::VERSION = '1.0.0.alpha.8'

data/spec/rrod/model/attribute_methods_spec.rb

@@ -14,13 +14,36 @@ describe Rrod::Model do
       expect(instance.make).to eq 'Jeep'
     end
 
+    it "is not dirty when created" do
+      expect(instance).not_to be_changed
+    end
+
     it "always has an id property" do
       expect(instance).to respond_to :id
       expect(instance.id).to be_nil
     end
 
+    it "includes the id property in the attributes hash" do
+      instance.save
+      expect(instance.attributes.keys).to include('id')
+    end
+
+    describe "nested models" do
+      let(:model)  { BatMobile }
+      let(:hash)   { {weapons: [{type: 'Rocket', damage: 12_345}]} }
+      let(:nested) { instance.weapons.first }
+
+      it "has a nil id" do
+        expect(nested.id).to be_nil
+      end
+
+      it "excludes id from attributes" do
+        expect(nested.attributes.keys).not_to include('id')
+      end
+    end
+
     it "manages attribute keys as strings" do
-      expect(instance.attributes.keys).to eq hash.stringify_keys.keys
+      expect(instance.attributes.keys.sort).to eq hash.stringify_keys.keys.push('id').sort
     end
 
     it "ignores modifications to the attribute hash" do
@@ -28,12 +51,6 @@ describe Rrod::Model do
       expect(instance.attributes[:model]).to be_nil
     end
 
-    it "will return nil for an attribute that exists in the hash but does not have a corresponding method" do
-      instance.instance_variable_get(:@attributes)['foo'] = 'bar'
-      expect(instance).not_to respond_to(:foo)
-      expect(instance.attributes).to include('foo' => nil)
-    end
-
     describe "mass assignment" do
       it "will merge attributes when mass assigning" do
         instance.attributes = {wheels: 5}
@@ -46,7 +63,9 @@ describe Rrod::Model do
     end
 
     describe "with schema" do
-      let(:model) { Class.new(Car) { attribute :wheels, Integer } }
+      # let(:model) { Class.new(Car) { attribute :wheels, Integer } }
+      # let(:model) { Car }
+      let(:model) { Class.new(Car) }
 
       it "does not allow creating with arbitrary attributes" do
         expect { model.new(model: 'Jeep') }.to raise_error(NoMethodError, /model=/)
@@ -72,4 +91,19 @@ describe Rrod::Model do
       expect(instance.instance_variable_get(:@attributes)['wheels']).to eq 4
     end
   end
+
+  describe "dirty tracking" do
+    let(:model)    { Class.new(Car) { attribute :wheels, Integer, default: 4 } }
+    let(:instance) { model.new }
+
+    it "will track if an attribute is changing" do
+      instance.wheels = 5
+      expect(instance.wheels_changed?).to be true
+    end
+
+    it "will not track if an attribute is not changing" do
+      instance.wheels = 4
+      expect(instance.wheels_changed?).to be false
+    end
+  end
 end

data/spec/rrod/model/attribute_spec.rb

@@ -65,6 +65,13 @@ describe Rrod::Model::Attribute do
         expect(model.send("rrod_attribute_#{name}")).to eq attribute
       end
     end
+
+    describe "attribute methods" do
+      it "declares the attribute an ActiveModel attribute method" do
+        expect(model).to receive(:define_attribute_method).with(name)
+        attribute.define
+      end
+    end
   end
 
   describe "casting" do

data/spec/rrod/model/finders_spec.rb

@@ -16,18 +16,29 @@ describe Rrod::Model::Finders, integration: true do
     expect(found).to be_a model
   end
 
+  it "will have the id of the key it is found with" do
+    found = model.find(instance.id)
+    expect(found.id).to eq instance.id
+  end
+
   it "will raise an error if it can't be found" do
     expect { model.find("id that is not there") }.to raise_error(Rrod::Model::NotFound)
   end
 
-  it "is persisted" do
-    found = model.find(instance.id)
-    expect(found).to be_persisted
-  end
+  describe "when finding" do
+    let(:found) { model.find(instance.id) }
 
-  it "sets the robject on the found instance" do
-    found = model.find(instance.id)
-    expect(found.robject).to be_a Riak::RObject
+    it "is persisted" do
+      expect(found).to be_persisted
+    end
+
+    it "is not changed" do
+      expect(found).not_to be_changed
+    end
+
+    it "sets the robject on the found instance" do
+      expect(found.robject).to be_a Riak::RObject
+    end
   end
 
   describe "finding by attributes in the hash" do

data/spec/rrod/model/persistence_spec.rb

@@ -38,6 +38,14 @@ describe Rrod::Model::Persistence, integration: true do
       it "has an id" do
         expect(instance.id).not_to be_nil
       end
+
+      it "does not store the id in the model json" do
+        expect(instance.robject.data).not_to have_key('id')
+      end
+
+      it "does not have changes" do
+        expect(instance).not_to be_changed
+      end
     end
 
     describe "update models" do

data/spec/rrod/model/schema_spec.rb

@@ -75,13 +75,18 @@ describe Rrod::Model::Schema do
 
     it "will properly serialize nested models" do
       instance.address = Address.new(street: '123 Fancy Pants Lane')
-      instance.pets    = [Pet.new(name: 'Molle')]
+      instance.pets    = [Pet.new(name: 'Molle', friendly: true)]
       instance.name    = 'Zoolander'
       hash             = instance.serializable_hash
 
       expect(hash).to be_a Hash
-      expect(hash['pets']).to    eq [{'name' => 'Molle'}]
-      expect(hash['address']).to eq 'street' => '123 Fancy Pants Lane'
+      expect(hash['pets']).to    eq [{'name' => 'Molle',
+        'species' => nil, 'friendly' => true, 'vaccinations' => [
+          'type' => 'rabies', 'when' => Date.today
+        ]
+      }]
+      expect(hash['address']).to eq 'street' => '123 Fancy Pants Lane',
+        'city' => nil, 'state_abbr' => nil, 'zip' => nil
     end
 
     it "will set the parent on a nested model when assigned" do
@@ -108,8 +113,9 @@ describe Rrod::Model::Schema do
     expect { Pet.rrod_cast(Object.new) }.to raise_error(Rrod::Model::UncastableObjectError)
   end
 
-  it "will not add ids to models instantiated via `rrod_cast`" do
-    expect(Pet.rrod_cast(name: 'Molle').attributes).to_not have_key('id')
+  it "will not add ids to models that are nested" do
+    instance.pets = [Pet.new(name: 'Molle')]
+    expect(instance.pets.first.attributes).not_to have_key('id')
   end
 
 end

data/spec/rrod/model/serialization_spec.rb

@@ -7,11 +7,16 @@ describe Rrod::Model::Serialization do
   let(:instance) { model.new(attributes) }
 
   it "serializes its attributes for json" do
-    expect(instance.as_json).to eq attributes.stringify_keys
+    hash = attributes.stringify_keys.tap { |h| h['id'] = h['color'] = nil }
+    expect(instance.as_json).to eq hash
   end
 
   it "calls to_json on its as_json representation" do
     expect(instance.as_json).to eq(JSON.parse instance.to_json)
   end
 
+  it "includes the id in the standard json representation" do
+    expect(instance.as_json.keys).to include("id")
+  end
+
 end

data/spec/rrod/model_spec.rb

@@ -25,6 +25,10 @@ describe Rrod::Model do
       it "names the bucket based off the class" do
         expect(model.bucket.name).to eq 'cars'
       end
+
+      it "uses anonymous for the bucket name on unnamed classes" do
+        expect(Class.new { include Rrod::Model }.bucket.name).to eq Rrod::Model::Schema::ANONYMOUS
+      end
     end
 
     describe "instance methods" do
@@ -45,6 +49,13 @@ describe Rrod::Model do
       it "has a bucket" do
         expect(instance.bucket).to be_a Riak::Bucket
       end
+
+      it "is inspectable" do
+        inspectable = BatMobile.new(wheels: 7, weapons: [{type: 'Gattling Gun', damage: 4_321}])
+        # used for human debugging of inspection output
+        # expect(inspectable.inspect).to eq("fancy string")
+        expect(inspectable.inspect).to be_a String
+      end
     end
   end
 end

data/spec/support/models/car.rb

@@ -4,3 +4,22 @@ class Car
   attribute :wheels, Integer
   attribute :color,  String
 end
+
+class Seat
+  include Rrod::Model
+  attribute :ejected, Boolean, default: false
+end
+
+class Weapon
+  include Rrod::Model
+  attribute :type,   String
+  attribute :damage, Integer
+end
+
+class BatMobile < Car
+  include Rrod::Model
+  attribute :make,    String, default: 'BatMobile'
+  attribute :color,   String, default: 'Black'
+  attribute :seat,    Seat,   default: -> { Seat.new }
+  attribute :weapons, [Weapon]
+end

data/spec/support/models/person.rb

@@ -24,7 +24,7 @@ class Pet
   attribute :friendly, Boolean
 
   attribute :vaccinations, [Vaccination], default: -> { 
-    Vaccination.new(type: :rabies, when: Date.today)
+    [Vaccination.new(type: :rabies, when: Date.today)]
   }
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrod
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.7
+  version: 1.0.0.alpha.8
 platform: ruby
 authors:
 - Adam Hunter