patch-patch 0.0.2 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a2adf47e7e17fb68da032b16997b7153f5fd27
-  data.tar.gz: 1bad23bfe88e71e844406b8a4978d3e80ba26c82
+  metadata.gz: 3e06fb21b3a5b5b8991e74ad7bcdd4ca7eb77865
+  data.tar.gz: 7cbaeeab287bd12430f542a6aab8cc1777e64fdc
 SHA512:
-  metadata.gz: d92eb149e8ead8a2fe576474e4d695215ea3ca49f94eb968e7115e82db1bdc26f8c80a0745778e3f70af3c8c90a2defe3ccbf95b17aee90fa27bd41fcec5504e
-  data.tar.gz: f58619c9d21a91d8419fb807d23d939d9083614553af82acf9b2473c83f98499f071f058d1c7ee5781f5af9ff3a6458447c3c6a53efb0d5452e7d157654ab258
+  metadata.gz: ab431b5c09a196d9006eae299f8161b816b1b96ab2fa191dd3996d2101c24ca88ea649a2fd0cf881184d28595fd3a27fbc885da9cd07b70bd07328c498799a90
+  data.tar.gz: adb4cdf7f1ae4bf5fe20fb6b0781f3282e2b1ae5bdb521fe3c9d67c782a1f8266038d0ccfbb334c9fd493bb6d7266e4d00aa3aaa2e47feed69d6a09b17a9136e

data/README.md

@@ -1,6 +1,6 @@
 # PatchPatch
 
-PatchPatch changes Rails’ default behavior of mapping PUT and PATCH requests on resources to the same action.
+PatchPatch changes Rails’ default behavior of mapping `PUT` and `PATCH` requests on resources to the same action.
 
 ## Installation
 
@@ -16,12 +16,52 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+## Usage
+
+PatchPatch hooks itself automatically into Rails’ routing engine. You don’t have to enable or configure it.
+
+Let’s say we have a RESTful API with a single `users` resource.
+
+```ruby
+# config/routes.rb
+Foo::Application.routes.draw do
+  resources :users
+end
+```
+
+### Before
 
 ```bash
-$ gem install patch-patch
+$ rake routes
+   Prefix Verb   URI Pattern               Controller#Action
+    users GET    /users(.:format)          users#index
+          POST   /users(.:format)          users#create
+ new_user GET    /users/new(.:format)      users#new
+edit_user GET    /users/:id/edit(.:format) users#edit
+     user GET    /users/:id(.:format)      users#show
+          PATCH  /users/:id(.:format)      users#update
+          PUT    /users/:id(.:format)      users#update
+          DELETE /users/:id(.:format)      users#destroy
 ```
 
+### After
+
+```bash
+$ rake routes
+   Prefix Verb   URI Pattern               Controller#Action
+    users GET    /users(.:format)          users#index
+          POST   /users(.:format)          users#create
+ new_user GET    /users/new(.:format)      users#new
+edit_user GET    /users/:id/edit(.:format) users#edit
+     user PATCH  /users/:id(.:format)      users#partial_update
+          GET    /users/:id(.:format)      users#show
+          PATCH  /users/:id(.:format)      users#update
+          PUT    /users/:id(.:format)      users#update
+          DELETE /users/:id(.:format)      users#destroy
+```
+
+_Note: the old `PATCH` route is still there but it will never be matched since our `#partial_update` route comes first. The old `PUT` route will still route to `#update` though._
+
 ## License
 
 `PatchPatch` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/patch-patch/blob/master/LICENSE.md) file.

data/lib/patch_patch/version.rb

@@ -1,3 +1,3 @@
 module PatchPatch
-  VERSION = '0.0.2'
+  VERSION = '0.1'
 end

data/patch-patch.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack', '>= 3.0.0'
+  spec.add_dependency 'actionpack', '>= 4.0.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patch-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: '0.1'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement