rest-in-peace 2.0.4 → 3.0.0

data/.travis.yml

@@ -1,7 +1,13 @@
 language: ruby
+cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+  - gemfiles/Gemfile.rails-4.1.x
+  - gemfiles/Gemfile.rails-4.2.x
 script:
   - bundle exec rake spec

data/README.md

@@ -36,11 +36,13 @@ rest_in_peace do
 end
 ```
 
+**There must be at least an attribute called `id` to allow REST-in-Peace to work properly.** 
+
 #### API Endpoints
 
-You need to define all the API endpoints you want to consume with `RESTinPeace`. Currently the four HTTP Verbs `GET`, `POST`, `PATCH` and `DELETE` are supported.
+You need to define all the API endpoints you want to consume with `RESTinPeace`. Currently the four HTTP verbs `GET`, `POST`, `PATCH` and `DELETE` are supported.
 
-There are two sections where you can specify endpoints: `resource` and `collection`:
+There are two sections where you can specify endpoints: `resource` and `collection`. `collection` supports the HTTP verb `GET` only.
 
 ```ruby
 rest_in_peace do
@@ -95,7 +97,7 @@ resource.create # calls "POST /rip"
 resource.reload # calls "GET /rip/1"
 ```
 
-**For any writing action (`:post`, `:put`, `:patch`) RESTinPeace will include the writable attributes in the body and `id`.**
+**For any writing action (`:post`, `:put`, `:patch`) RESTinPeace will include the *changed* attributes in the body and `id`.**
 
 #### Collection
 

data/VERSION

@@ -1 +1 @@
-2.0.4
+3.0.0

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 3.2.0'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 4.0.0'

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 4.1.0'

data/gemfiles/Gemfile.rails-4.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 4.2.0'

data/lib/rest_in_peace/active_model_api.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'active_support/core_ext/object/blank'
 
 module RESTinPeace
   module ActiveModelAPI
@@ -12,25 +13,12 @@ module RESTinPeace
     def self.included(base)
       check_for_missing_methods(base)
 
-      base.send(:include, ActiveModel::Dirty)
       base.send(:include, ActiveModel::Conversion)
       base.extend ActiveModel::Naming
 
       base.send(:alias_method, :save_without_dirty_tracking, :save)
       base.send(:alias_method, :save, :save_with_dirty_tracking)
 
-      base.send :define_attribute_methods, base.rip_attributes[:write]
-
-      base.rip_attributes[:write].each do |attribute|
-        base.send(:define_method, "#{attribute}_with_dirty_tracking=") do |value|
-          attribute_will_change!(attribute) unless send(attribute) == value
-          send("#{attribute}_without_dirty_tracking=", value)
-        end
-
-        base.send(:alias_method, "#{attribute}_without_dirty_tracking=", "#{attribute}=")
-        base.send(:alias_method, "#{attribute}=", "#{attribute}_with_dirty_tracking=")
-      end
-
       def base.human_attribute_name(attr, options = {})
         attr.to_s
       end
@@ -47,7 +35,7 @@ module RESTinPeace
 
     def save_with_dirty_tracking
       save_without_dirty_tracking.tap do
-        @changed_attributes.clear if @changed_attributes
+        clear_changes
       end
     end
 

data/lib/rest_in_peace/definition_proxy/attributes_definitions.rb

@@ -12,8 +12,25 @@ module RESTinPeace
 
       def write(*attributes)
         read(*attributes)
-        @target.send(:attr_writer, *attributes)
+        @target.send :attr_writer, *attributes
+        @target.send :define_attribute_methods, attributes
         @target.rip_attributes[:write].concat(attributes)
+
+        attributes.each do |attribute|
+          define_dirty_tracking attribute
+        end
+      end
+
+      private
+
+      def define_dirty_tracking(attribute)
+        @target.send(:define_method, "#{attribute}_with_dirty_tracking=") do |value|
+          attribute_will_change!(attribute) unless send(attribute) == value
+          send("#{attribute}_without_dirty_tracking=", value)
+        end
+
+        @target.send(:alias_method, "#{attribute}_without_dirty_tracking=", "#{attribute}=")
+        @target.send(:alias_method, "#{attribute}=", "#{attribute}_with_dirty_tracking=")
       end
     end
   end

data/lib/rest_in_peace.rb

@@ -1,9 +1,12 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 require 'rest_in_peace/definition_proxy'
 
 module RESTinPeace
 
   def self.included(base)
     base.send :extend, ClassMethods
+    base.send :include, ActiveModel::Dirty
   end
 
   def api
@@ -16,9 +19,9 @@ module RESTinPeace
 
   def hash_for_updates
     hash_representation = { id: id }
-    self.class.rip_attributes[:write].map do |key|
+    changed.each do |key|
       value = send(key)
-      hash_representation[key] = hash_representation_of_object(value)
+      hash_representation[key.to_sym] = hash_representation_of_object(value)
     end
     if self.class.rip_namespace
       { id: id, self.class.rip_namespace => hash_representation }
@@ -27,6 +30,18 @@ module RESTinPeace
     end
   end
 
+  def clear_changes
+    case
+    when respond_to?(:clear_changes_information) # ActiveModel >= 4.2
+      clear_changes_information
+    when respond_to?(:reset_changes) # ActiveModel >= 4.0 && <= 4.1
+      reset_changes
+    else # ActiveModel <= 3.2
+      return unless @changed_attributes
+      @changed_attributes.clear
+    end
+  end
+
   def update_attributes(attributes)
     attributes.each do |key, value|
       next unless respond_to?("#{key}=")
@@ -51,6 +66,7 @@ module RESTinPeace
         instance_variable_set("@#{key}", value)
       end
     end
+    clear_changes
   end
 
   def hash_representation_of_object(object)

data/spec/rest_in_peace/active_model_api_spec.rb

@@ -99,27 +99,6 @@ describe RESTinPeace do
       allow(api_double).to receive(:post).and_return(response)
     end
 
-    describe '#changed?' do
-      context 'a new instance' do
-        specify { expect(instance.changed?).to eq(false) }
-      end
-
-      context 'a modified instance' do
-        before do
-          instance.description = 'new value'
-        end
-        specify { expect(instance.changed?).to eq(true) }
-      end
-
-      context 'a saved instance' do
-        before do
-          instance.description = 'new value'
-          instance.save
-        end
-        specify { expect(instance.changed?).to eq(false) }
-      end
-    end
-
     describe 'attribute methods' do
       specify { expect(instance).to respond_to(:description_changed?) }
       specify { expect(instance).to respond_to(:title_changed?) }

data/spec/rest_in_peace_spec.rb

@@ -9,7 +9,7 @@ describe RESTinPeace do
       rest_in_peace do
         attributes do
           read :id, :name, :relation
-          write :my_array, :my_hash, :array_with_hash, :overridden_attribute
+          write :my_array, :my_hash, :array_with_hash, :overridden_attribute, :description
         end
       end
 
@@ -31,6 +31,7 @@ describe RESTinPeace do
   let(:my_hash) { { element1: 'yolo' } }
   let(:array_with_hash) { [my_hash.dup] }
   let(:overridden_attribute) { 'initial value' }
+  let(:description) { 'old description' }
   let(:attributes) do
     {
       id: 1,
@@ -40,6 +41,7 @@ describe RESTinPeace do
       my_hash: my_hash,
       array_with_hash: array_with_hash,
       overridden_attribute: overridden_attribute,
+      description: description,
     }
   end
   let(:instance) { extended_class.new(attributes) }
@@ -75,8 +77,8 @@ describe RESTinPeace do
     specify { expect(extended_class).to respond_to(:rip_attributes) }
     specify do
       expect(extended_class.rip_attributes).to eq(
-        read: [:id, :name, :relation, :my_array, :my_hash, :array_with_hash, :overridden_attribute],
-        write: [:my_array, :my_hash, :array_with_hash, :overridden_attribute])
+        read: [:id, :name, :relation, :my_array, :my_hash, :array_with_hash, :overridden_attribute, :description],
+        write: [:my_array, :my_hash, :array_with_hash, :overridden_attribute, :description])
     end
   end
 
@@ -110,6 +112,9 @@ describe RESTinPeace do
       end
 
       context 'overridden getter' do
+        before do
+          subject.overridden_attribute = 'new value'
+        end
         specify { expect(subject.hash_for_updates).to include(overridden_attribute: 'something else') }
       end
 
@@ -119,13 +124,22 @@ describe RESTinPeace do
       end
 
       context 'hash' do
-        specify { expect(subject.hash_for_updates[:my_hash]).to eq(element1: 'yolo') }
+        before do
+          subject.my_hash = { element1: 'swag' }
+        end
+
+        specify { expect(subject.hash_for_updates[:my_hash]).to eq(element1: 'swag') }
       end
 
       context 'with objects assigned' do
-        let(:my_hash) { double('OtherClass') }
+        let(:new_hash) { double('OtherClass') }
+
+        before do
+          subject.my_hash = new_hash
+        end
+
         it 'deeply calls hash_for_updates' do
-          expect(my_hash).to receive(:hash_for_updates).and_return({})
+          expect(new_hash).to receive(:hash_for_updates).and_return({})
           subject.hash_for_updates
         end
       end
@@ -139,7 +153,7 @@ describe RESTinPeace do
           rest_in_peace do
             attributes do
               read :id
-              write :name
+              write :name, :description
             end
 
             namespace_attributes_with :blubb
@@ -147,7 +161,11 @@ describe RESTinPeace do
         end
       end
 
-      specify { expect(subject.hash_for_updates).to eq(id: 1, blubb: { id: 1, name: 'test' }) }
+      before do
+        subject.name = 'new value'
+      end
+
+      specify { expect(subject.hash_for_updates).to eq(id: 1, blubb: { id: 1, name: 'new value' }) }
     end
   end
 
@@ -204,4 +222,27 @@ describe RESTinPeace do
         to_not change(instance, :name).from(attributes[:name])
     end
   end
+
+  describe '#changed?' do
+    subject { instance }
+
+    context 'a new instance' do
+      it { is_expected.to_not be_changed }
+    end
+
+    context 'a modified instance' do
+      before do
+        instance.description = 'new value'
+      end
+      it { is_expected.to be_changed }
+    end
+
+    context 'a saved instance' do
+      before do
+        instance.description = 'new value'
+        instance.clear_changes
+      end
+      it { is_expected.to_not be_changed }
+    end
+  end
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: rest-in-peace
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Raffael Schmid
@@ -13,6 +14,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -23,6 +25,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -33,6 +36,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -40,6 +44,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -47,6 +52,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,6 +60,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -61,6 +68,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -71,6 +79,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -81,6 +90,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -91,6 +101,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -101,6 +112,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,6 +123,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -137,6 +150,10 @@ files:
 - Rakefile
 - VERSION
 - examples/pagination_with_headers.rb
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
+- gemfiles/Gemfile.rails-4.1.x
+- gemfiles/Gemfile.rails-4.2.x
 - images/rest_in_peace.gif
 - lib/rest-in-peace.rb
 - lib/rest_in_peace.rb
@@ -165,26 +182,27 @@ files:
 homepage: http://github.com/ninech/
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: REST in peace
 test_files:
 - spec/rest_in_peace/active_model_api_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzVkMWFiODFlNGQ2ZTVkMTM0MTRkYTg1OGRmNjBmYWI1NGM3YWNmYw==
-  data.tar.gz: !binary |-
-    ZWZlYjY3NjNkNzQwNjcwOGVlZmU5YzVjZTM2YjBlNjk3YTA2ZTY1Yw==
-SHA512:
-  metadata.gz: !binary |-
-    ZDRkZjlmY2NlNGU4MDgzM2UyY2ZmZTc5NmQxOWZiMTcxYTdjZTBiN2Y0NTc5
-    MTg1ZDY5YzA2NDFjNjNkNzFiOWZhZmUyZDBhMGVjNWQxYzNjZGVkZDJiNzRj
-    YjM2ODBkNDA3NWFkZmU3NWViZmVkNWU1Y2Q0MDQyYmVlYjM1MmY=
-  data.tar.gz: !binary |-
-    ZjY1MjExMjJlNGU1MDEzYzEwMzgyZTY3MmQ3ZGNkZDI5NWM2OWM2M2VkYmQ4
-    NTU1NzY3MmE5N2JlODIyODYxM2ZmNjdhYTk3YWNhMmUzMWRhOTc4MWZkODYx
-    YmYwMTcyMGUxOTg3YTRmYjRkYTcyYjRhYjIwMmFjMTU1Mjg3MjA=