active_resource-dirty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bae3ae674fc1887feef90c75c2b1afab97b88f7ae1be51efbc3ea6a62934abc
+  data.tar.gz: '09c5686dff4d771bb2683ea6465b78dc4e582cc010cc988f53845e1f0ecd421d'
+SHA512:
+  metadata.gz: 6a16cada9b46458f3797f6c648fdd309e5c9f51c88559d516cc17631e72a0cad6283540ff56d0ddd210a51f041e99c652629df59cf32927e07b91d303231dece
+  data.tar.gz: 5e33f13ec08d58790eac191f29a4028b6add1765ec22f79b3baf2438c2d5469f3a1ed22ae1568e1ac7b3a992a91c2142e116a0a79f56936c688640370336caab

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Francisco Caiceo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# ActiveResource::Dirty
+`ActiveResource::Dirty` is a monkey patch that supports `ActiveModel::Dirty` methods in `ActiveResource`.
+
+## Usage
+Provides a way to track changes in your object. For example:
+```ruby
+person = Person.find(1)
+person.changed?         # => false
+person.name = 'Frank'
+person.changes          # => {"name"=>[nil, 'Frank']}
+person.name_was         # nil
+person.save
+person.changes          # => {}
+person.previous_changes # => {"name"=>[nil, 'Frank']}
+```
+
+### PATCH Requests
+It uses the http `PATCH` method instead of `PUT`, and sends in the body only the attributes that have changed. This feature requires the flag `patch_updates`.
+```ruby
+class Person < ActiveResource::Base
+  self.site = 'http://someapi.com'
+  self.patch_updates = true
+end
+```
+
+```ruby
+person = Person.find(1)
+person.name = 'Frank'
+person.save
+# Sends this request:
+# PATCH http://someapi.com/people/1.json
+# {"name":"Frank"}
+#
+```
+## Considerations
+This is a monkey patch that overrides methods from both `ActiveResource` and `ActiveModel::Dirty` (the latter one only for ActiveResource::Base. It does not affect `ActiveModel` for other uses). Any change in this methods in future versions can lead to unexpected results. So use with caution.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_resource-dirty'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_resource-dirty
+```
+
+## Requirements
+* activemodel ~> 5.2.0
+* activeresource ~> 5.1.0
+* activesupport ~> 5.2.0
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_resource/dirty/patch_updates.rb

@@ -0,0 +1,9 @@
+module ActiveResource
+  module Dirty
+    module PatchUpdates
+      def self.included(base)
+        base.class_attribute :patch_updates
+      end
+    end
+  end
+end

data/lib/active_resource/dirty/version.rb

@@ -0,0 +1,5 @@
+module ActiveResource
+  module Dirty
+    VERSION = '1.0.0'
+  end
+end

data/lib/active_resource/dirty.rb

@@ -0,0 +1,86 @@
+require 'active_resource/dirty/patch_updates'
+
+module ActiveResource
+  module Dirty
+    # Save the record and clears changed attributes if successful.
+    def save(*)
+      if (status = super)
+        changes_applied
+      end
+      status
+    end
+
+    # <tt>reload</tt> the record and clears changed attributes.
+    def reload(*)
+      super.tap do
+        clear_changes_information
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.end_with?('=') || super
+    end
+
+    # Monkey patch
+    def changes_applied
+      @previously_changed = changes
+      @attributes_changed_by_setter = ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    private
+
+    def method_missing(method_symbol, *arguments) #:nodoc:
+      method_name = method_symbol.to_s
+      if method_name =~ /(=)$/ && attributes.key?($`)
+        new_value = arguments.first
+
+        if attribute_changed?($`) && changed_attributes[$`] == new_value
+          # Reset status if already changed and we are returning to the original value
+          clear_attribute_changes([$`])
+        elsif attributes[$`] != new_value
+          # yield change if value changed otherwise
+          attribute_will_change!($`)
+        end
+      end
+      super
+    end
+
+    # Monkey patch
+    def mutations_from_database
+      @mutations_from_database ||= ActiveModel::NullMutationTracker.instance
+    end
+
+    # Monkey patch
+    def forget_attribute_assignments; end
+
+    def encode_changed_attributes(options = {})
+      format_options = options.merge(only: keys_for_partial_write)
+      send("to_#{self.class.format.extension}", format_options)
+    end
+
+    def keys_for_partial_write
+      changed_attributes.keys
+    end
+
+    protected
+
+    # Update the resource on the remote service.
+    def update
+      return super unless patch_updates
+
+      run_callbacks :update do
+        connection.patch(element_path(prefix_options),
+                         encode_changed_attributes,
+                         self.class.headers).tap do |response|
+          load_attributes_from_response(response)
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_resource) do
+  prepend ActiveResource::Dirty
+  include ActiveModel::Dirty
+  include ActiveResource::Dirty::PatchUpdates
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: active_resource-dirty
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francisco Caiceo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: Monkey Patch to support ActiveModel::Dirty methods in ActiveResource
+email:
+- jfcaiceo55@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_resource/dirty.rb
+- lib/active_resource/dirty/patch_updates.rb
+- lib/active_resource/dirty/version.rb
+homepage: https://github.com/jfcaiceo/devise-activeresource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: ActiveModel::Dirty support for ActiveResource
+test_files: []