acfs 0.32.1.1.b275 → 0.32.1.1.b276

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGZmNGMyYTFkNTc3MDVlNzE2OTYxN2FkZjI5YmFiYzFlZTIyMWIwNQ==
+    YmRiYmQxMWZhODVlMWQxMjIwYTY3NDhkMjlkM2NjNjQ2YjA0NjIwMQ==
   data.tar.gz: !binary |-
-    MGFhMTlhN2U0MmY5NDZlZDhiYzk2ZmI1MTliY2I3MjM0OGNkY2IxMQ==
+    MmQ5YzdiNjJhYmM0Y2NjZDM2OWRhMzZlMjhiY2JjODM0MzY4YjdkZA==
 SHA512:
   metadata.gz: !binary |-
-    NzMyNDkzYTI4YTE5MzRkYTY0NWEzMjUwNThhYzliZjc1ZWMzNDYwNWE3N2E2
-    Njg3YWY4NWU2OTNlNzk4MDNmNWQ1ZjdjNGM5MTE3ZmRhYjIwYTM3NDJlNWRi
-    NzRkZjA0ZjU4OTRmMjdiMWYxOGNkNmYyOTMxMWU3YmNjNWUyOGM=
+    Yzk4YTk4ZGU2NGY0ZGZhNTk4YzY4MzIzZmUyMTkyODY3ZjdlNDFhMGRlNzc4
+    OTA1NDc4YjU3MGUwOTMwNzNmMWUyOGIyZGNiMjVlNDExMGRhZDE4NTA4NDVm
+    NDY0NDhkZTE1MTgyYzllMjlkMGRkODMzMGQ1Njg5N2RlYWFhYjE=
   data.tar.gz: !binary |-
-    NDllMTVmMjU2ZmE5NjQwOGQxNWU4MGIyMTI5Yjg0ZDg4NWZmZDUxYmM1NWY3
-    YTM5Mjc1ZTFhMDVlNTU1ZTRmOGQ4OWVlMDFkZDg3ZWJiZDFjMmI2NzBlODhj
-    MDIwZjM5MGI5ZWQzOGU3MmFiOWFkMjBmZmFkYTM1YzkwNzZjMzc=
+    YjY1YjYzZjU1YjZhNGQwZGFmYTNkNDgyZWI2NTNjMzE0NWU3ZTIzOTA3Yjky
+    MDdhNTQ4MGZhMTJjZjgzZmRjZWQ2N2M3ZDQzMTQ0NWZkYWJiMzZjNzYzNjY4
+    ZThkMzAzY2U0ZWM2MDM3M2FhZWQ5NTgzMmQyOTNjYThjOWUxMmU=

data/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Next
 
 * Do not raise errors on unknown attributes by default, add :unknown option.
+* Add support to store unknown attributes
 
 ## 0.32.1
 

data/lib/acfs/model.rb

@@ -3,6 +3,7 @@ require 'active_model'
 # @api public
 #
 module Acfs::Model
+  require 'acfs/model/initialization'
   require 'acfs/model/attributes'
   require 'acfs/model/dirty'
   require 'acfs/model/loadable'
@@ -24,11 +25,10 @@ module Acfs::Model
       extend  ActiveModel::Translation
       include ActiveModel::Conversion
       include ActiveModel::Validations
-
-      require 'acfs/model/initialization'
-      include Initialization
     end
 
+    include Initialization
+
     include Attributes
     include Loadable
     include Persistence

data/lib/acfs/model/attributes.rb

@@ -27,7 +27,8 @@ module Acfs::Model
     # @see ClassMethods#attributes
     #
     def initialize(*attrs)
-      self.write_attributes self.class.attributes, change: false
+      self.write_attributes self.class.attributes
+      reset_changes
       super
     end
 
@@ -46,7 +47,7 @@ module Acfs::Model
     # @return [ HashWithIndifferentAccess{ Symbol => Object } ] Attributes and their values.
     #
     def attributes
-      HashWithIndifferentAccess.new self.class.attributes.keys.inject({}) { |h, k| h[k.to_sym] = public_send k; h }
+      @attributes ||= HashWithIndifferentAccess.new
     end
 
     # @api public
@@ -73,7 +74,7 @@ module Acfs::Model
     # @return [ Object ] Attribute value.
     #
     def read_attribute(name)
-      instance_variable_get :"@#{name}"
+      self.attributes[name.to_s]
     end
 
     # @api public
@@ -96,7 +97,9 @@ module Acfs::Model
     # @see #write_attribute Delegates attribute values to `#write_attribute`.
     #
     def write_attributes(attributes, opts = {})
-      return false unless attributes.respond_to? :each
+      unless attributes.respond_to?(:each) && attributes.respond_to?(:keys)
+        return false
+      end
 
       if opts.fetch(:unknown,:ignore) == :raise
         if (attributes.keys.map(&:to_s) - self.class.attributes.keys).any?
@@ -104,27 +107,39 @@ module Acfs::Model
         end
       end
 
-      attributes = attributes.select do |k, v|
-        self.class.attributes.keys.include? k.to_s
-      end
-
       procs = {}
 
       attributes.each do |key, _|
         if attributes[key].is_a? Proc
           procs[key] = attributes[key]
         else
-          write_attribute key, attributes[key], opts
+          write_local_attribute key, attributes[key], opts
         end
       end
 
       procs.each do |key, proc|
-        write_attribute key, instance_exec(&proc), opts
+        write_local_attribute key, instance_exec(&proc), opts
       end
 
       true
     end
 
+    # @api private
+    #
+    # Check if a public getter for attribute exists that should be called to
+    # write it or of {#write_attribute} should be called directly. This is
+    # necessary as {#write_attribute} should go though setters but can also
+    # handle unknown attribute that will not have a generated setter method.
+    #
+    def write_local_attribute(name, value, opts = {})
+      method = "#{name}="
+      if respond_to? method, true
+        public_send method, value
+      else
+        write_attribute name, value, opts
+      end
+    end
+
     # @api public
     #
     # Write single attribute with given value. Value will be casted
@@ -135,11 +150,12 @@ module Acfs::Model
     # @raise [ ArgumentError ] If no attribute with given name is defined.
     #
     def write_attribute(name, value, opts = {})
-      if (attr = self.class.defined_attributes[name.to_s]).nil?
-        raise ArgumentError.new "Unknown attribute `#{name}`."
+      attr_type = self.class.defined_attributes[name.to_s]
+      if attr_type
+        write_raw_attribute name, attr_type.cast(value), opts
+      else
+        write_raw_attribute name, value, opts
       end
-
-      write_raw_attribute name, attr.cast(value), opts
     end
 
     # @api private
@@ -152,7 +168,7 @@ module Acfs::Model
     # @param [ Object ] value Attribute value.
     #
     def write_raw_attribute(name, value, _ = {})
-      instance_variable_set :"@#{name}", value
+      self.attributes[name.to_s] = value
     end
 
     module ClassMethods

data/lib/acfs/model/initialization.rb

@@ -24,9 +24,7 @@ module Acfs::Model
     # @param [ Hash{ Symbol => Object } ] params Attributes to set on resource.
     #
     def initialize(params = {})
-      params.each do |attr, value|
-        self.public_send("#{attr}=", value)
-      end if params
+      self.write_attributes params if params
     end
 
   end

data/lib/acfs/model/persistence.rb

@@ -195,8 +195,8 @@ module Acfs
         # @see #create
         #
         def create!(data, opts = {})
-          new.tap do |model|
-            model.save! opts.merge data: data
+          new(data).tap do |model|
+            model.save!
           end
         end
 
@@ -218,8 +218,8 @@ module Acfs
         # @see #create!
         #
         def create(data, opts = {})
-          model = new
-          model.save opts.merge data: data
+          model = new data
+          model.save
           model
         end
       end

data/lib/acfs/stub.rb

@@ -23,7 +23,13 @@ module Acfs
       params = op.full_params.stringify_keys
       data   = op.data.stringify_keys
 
-      opts[:with] == params || data == opts[:with] || (opts[:with].nil? && params.empty? && data.empty?)
+      return true if opts[:with] == params || data == opts[:with]
+      return true if (opts[:with].nil? && params.empty? && data.empty?)
+
+      return true if opts[:with].reject{|k,v|v.nil?} == params.reject{|k,v|v.nil?}
+      return true if opts[:with].reject{|k,v|v.nil?} == data.reject{|k,v|v.nil?}
+
+      false
     end
 
     def calls

data/spec/acfs/model/attributes_spec.rb

@@ -41,6 +41,9 @@ describe Acfs::Model::Attributes do
     before do
       model.attribute :name, :string, default: 'John'
       model.attribute :age, :integer, default: 25
+      model.send :define_method, :name= do |name|
+        write_attribute :name, "The Great #{name}"
+      end
     end
     let(:args) { [params] }
     let(:params){ {name: 'James'} }
@@ -50,8 +53,8 @@ describe Acfs::Model::Attributes do
 
     it 'should update attributes'  do
       should change(m, :attributes)
-             .from({'name' => 'John', 'age' => 25})
-             .to({'name' => 'James', 'age' => 25})
+             .from({'name' => 'The Great John', 'age' => 25})
+             .to({'name' => 'The Great James', 'age' => 25})
     end
 
     context 'without non-hash params' do
@@ -62,14 +65,14 @@ describe Acfs::Model::Attributes do
     end
 
     context 'with unknown attributes' do
-      let(:params) { {name: 'James', born_at: Time.now} }
+      let(:params) { {name: 'James', born_at: 'today'} }
 
       it { should_not raise_error }
 
-      it 'should update known attributes'  do
+      it 'should update known attributes and store unknown'  do
         should change(m, :attributes)
-               .from({'name' => 'John', 'age' => 25})
-               .to({'name' => 'James', 'age' => 25})
+               .from({'name' => 'The Great John', 'age' => 25})
+               .to({'name' => 'The Great James', 'age' => 25, 'born_at' => 'today'})
       end
 
       context 'with unknown: :raise option' do
@@ -94,13 +97,6 @@ describe Acfs::Model::Attributes do
     it 'should return default value' do
       expect(model.new.name).to be == 'John'
     end
-
-    it 'should return matching ivar\'s value' do
-      o = model.new
-      o.instance_variable_set :@name, 'Johannes'
-
-      expect(o.name).to be == 'Johannes'
-    end
   end
 
   describe '#_setter_' do
@@ -116,13 +112,6 @@ describe Acfs::Model::Attributes do
       expect(o.name).to be == 'Paul'
     end
 
-    it 'should set instance var' do
-      o = model.new
-      o.name = 'Paul'
-
-      expect(o.instance_variable_get(:@name)).to be == 'Paul'
-    end
-
     it 'should update attributes hash' do
       o = model.new
       o.name = 'Johannes'

data/spec/acfs/model/initialization_spec.rb

@@ -13,7 +13,7 @@ describe 'Acfs::Model::Initialization' do
 
   describe '#initialize' do
     it 'should allow to set attributes with initializer' do
-      m = model.new(name: "John")
+      m = model.new name: "John"
       expect(m.name).to be == "John"
     end
 

data/spec/acfs/model/persistance_spec.rb

@@ -18,11 +18,11 @@ describe Acfs::Model::Persistence do
       .to_return response({ id: 5, name: 'Anon', age: 12 })
 
     stub_request(:post, 'http://users.example.org/users')
-      .with(body: '{"name":"Idefix","age":12}')
+      .with(body: '{id:null,"name":"Idefix","age":12}')
       .to_return response({ id: 5, name: 'Idefix', age: 12 })
 
     stub_request(:post, 'http://users.example.org/users')
-      .with(body: '{"age":12}')
+      .with(body: '{"id":null,"name":null,"age":12}')
       .to_return response({ errors: { name: [ 'required' ] }}, status: 422)
 
     @del = stub_request(:delete, 'http://users.example.org/users/1')
@@ -60,6 +60,30 @@ describe Acfs::Model::Persistence do
 
           expect(@post_stub).to have_been_requested
         end
+
+        context 'with unknown attributes' do
+          let!(:req) do
+            stub_request(:post, 'http://users.example.org/users')
+              .with(body: '{"id":null,"name":"Idefix","age":null,"born_at":"Berlin"}')
+              .to_return response({id: 5, name: 'Idefix', age: 12, wuff: 'woa'})
+          end
+          let(:model) { model_class.new name: 'Idefix', born_at: 'Berlin' }
+
+          it 'should POST to collection URL' do
+            model.save!
+            expect(req).to have_been_requested
+          end
+
+          it 'should still have unknown attribute' do
+            model.save!
+            expect(model.attributes).to include 'born_at' => 'Berlin'
+          end
+
+          it 'should include server send unknown attribute' do
+            model.save!
+            expect(model.attributes).to include 'wuff' => 'woa'
+          end
+        end
       end
     end
 
@@ -205,43 +229,56 @@ describe Acfs::Model::Persistence do
     end
 
     context 'with invalid data' do
-      let(:data) { { age: 12 } }
+      let(:data) { {name: nil, age: 12} }
 
       it 'should raise an error' do
-        expect { model_class.create! data }.to raise_error(::Acfs::InvalidResource) do |error|
-          expect(error.errors).to be == { 'name' => %w(required) }
-        end
+        expect{ model_class.create! data }.to \
+          raise_error(::Acfs::InvalidResource) do |error|
+            expect(error.errors).to be == { 'name' => %w(required) }
+          end
       end
     end
   end
 
   describe '.create' do
+    subject { model_class.create data }
+
     context 'with valid data' do
-      let(:data) { { name: 'Idefix', age: 12 } }
+      let(:data) { {name: 'Idefix', age: 12} }
 
       it 'should create new resource' do
-        model = model_class.create! data
-        expect(model.name).to be == 'Idefix'
-        expect(model.age).to be == 12
+        expect(subject.name).to be == 'Idefix'
+        expect(subject.age).to be == 12
       end
 
       it 'should be persisted' do
-        model = model_class.create! data
-        expect(model).to be_persisted
+        expect(subject).to be_persisted
       end
     end
 
     context 'with invalid data' do
-      let(:data) { { age: 12 } }
+      let(:data) { {name: nil, age: 12} }
 
       it 'should return not persisted resource' do
-        model = model_class.create data
-        expect(model).to_not be_persisted
+        expect(subject).to_not be_persisted
       end
 
       it 'should contain error hash' do
-        model = model_class.create data
-        expect(model.errors.to_hash).to be == { name: %w(required) }
+        expect(subject.errors.to_hash).to eq name: %w(required)
+      end
+    end
+
+    context 'with additional data' do
+      let!(:req) do
+        stub_request(:post, 'http://users.example.org/users')
+          .with(body: '{"id":null,"name":"Anon","age":9,"born_at":"today"}')
+          .to_return response({id: 5, name: 'Anon', age: 9})
+      end
+      let(:data) { {age: 9, born_at: 'today'} }
+
+      it 'should store them in attributes' do
+        expect(subject.attributes).to eq 'id' => 5, 'name' => 'Anon',
+          'age' => 9, 'born_at' => 'today'
       end
     end
   end

data/spec/acfs/model/query_methods_spec.rb

@@ -7,15 +7,16 @@ describe Acfs::Model::QueryMethods do
     context 'with single id' do
       context 'with successful response' do
         before do
-          stub_request(:get, 'http://users.example.org/users/1').to_return response({ id: 1, name: 'Anon', age: 12 })
-          stub_request(:get, 'http://users.example.org/users/2').to_return response({ id: 2, type: 'Customer', name: 'Clare Customer', age: 24 })
+          stub_request(:get, 'http://users.example.org/users/1').to_return response({id: 1, name: 'Anon', age: 12, born_at: 'Berlin'})
+          stub_request(:get, 'http://users.example.org/users/2').to_return response({id: 2, type: 'Customer', name: 'Clare Customer', age: 24 })
         end
 
         it 'should load a single remote resource' do
           user = model.find 1
           Acfs.run
 
-          expect(user.attributes).to be == { id: 1, name: 'Anon', age: 12 }.stringify_keys
+          expect(user.attributes).to eq(
+            {id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}.stringify_keys)
         end
 
         it 'should invoke callback after model is loaded' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.32.1.1.b275
+  version: 0.32.1.1.b276
 platform: ruby
 authors:
 - Jan Graichen