smart_adapters 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff08aa5ca3d972fa315b5bcb3f9f3b716221cbff7e6c6318fab4bb4529a0448
-  data.tar.gz: fb1e5e836802441405daac310352ebe31604acac6c96846cb3d076393be8a6c6
+  metadata.gz: 6bc9acf4e7970034d8d7686621dd8e3d796db5e2f6a0be6b95019fc4907fd0a1
+  data.tar.gz: e072efc3832e85caed186bf930361f742e06635d23018fdd3c8243b80c7d2c75
 SHA512:
-  metadata.gz: 4feb3505ba4a7f2ce62da178104f75c7c25cede1d9072dc45c92ab5d64475fa92f531e7b7be9a83f36d22a693b97369870d90fcc505f848ba1f2debf3dd7be39
-  data.tar.gz: d8226283bb31a841978fcf7ed9e95199573eb35ed08ad958b84f0b54351ab274f99297cb405723f6d0116489e5ad389e53386586f9d12bfac025b188b3e8f198
+  metadata.gz: 8a9c3baba90c72167965bf87cf4b277e2c56b64d81b61e1f60ce5fcecb4bfe6c033f7cda52528cfcd343c0730610f4fbcdd568ff6172dc394a0ca976f6c75902
+  data.tar.gz: 93101103f2e19c2c72161d7af7042f5748675f8e9f326d9e30792992d3b98f6543d3a14d5920cb74e0fc95d5eb4127759223e986c0d787f5a30be6e82d2acd25

data/README.md

@@ -1,10 +1,52 @@
-# WIP
-
 # SmartAdapters
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+[![Gem Version](https://badge.fury.io/rb/smart_adapters.svg)](https://badge.fury.io/rb/smart_adapters) [![Build Status](https://travis-ci.org/andrearampin/smart_adapters.svg?branch=master)](https://travis-ci.org/andrearampin/smart_adapters) [![Maintainability](https://api.codeclimate.com/v1/badges/9d55d1d054401ab93a6e/maintainability)](https://codeclimate.com/github/andrearampin/smart_adapters/maintainability)
+
+Smart Adapters were born from the need to fully decouple the controller logic from the rendering of the response.
+In the [Ruby on Rails documentation](https://apidock.com/rails/ActionController/MimeResponds/InstanceMethods/respond_to), the controller has to decide the format of the answer based on the (Content-Type) request:
+
+```ruby
+# app/controllers/people_controller.rb
+def index
+  @people = Person.all
+  respond_to do |format|
+    format.html
+    format.xml { render :xml => @people.to_xml }
+  end
+end
+```
+
+Although, this method looks simple it's already highlighting how two distinct formats might have a slightly different implementation. The problem here is that over time this controller might inherit unnecessary complexity by simply introducting new properties or formats.
+
+The Smart Adapters solve this problem by delegating the task of properly render the response based on the request format to well-defined classes, one per format. The following implementation makes use of the Smart Adapters:
+
+```ruby
+# app/controllers/people_controller.rb
+def index
+  current_adapter.success Person.all
+end
+
+# app/models/smart_adapters/people/index/html_adapter.rb
+def success(people)
+  render 'people/show', locals: { people: people }
+end
+
+# app/models/smart_adapters/people/index/xml_adapter.rb
+def success(people)
+  render xml: people, status: :ok
+end
+```
+
+Now that the application has a class per format, it is easy to keep the controller dry while implementing format specific features. For instance, in case of an XML request, the adapter could add more details to the `people` collection or track some metrics without bloating the controller.
+
+```ruby
+# app/models/smart_adapters/people/index/xml_adapter.rb
+def success(people)
+  metric_tracker.push('New XML request')
+  people.filter_private_details!
+  render xml: people, status: :ok
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -18,7 +60,172 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install smart_adapters
+Update the `ApplicationController` by adding the `SmartAdapters` concern:
+```ruby
+class ApplicationController < ActionController::Base
+  include SmartAdapters
+end
+```
+
+Add the adapters for your **controller/action/format**.
+
+### Example
+
+`app/controlles/users_controller.rb`
+```ruby
+class UsersController < ApplicationController
+  # GET /users
+  def index
+    current_adapter.success User.all
+  end
+
+  # GET /users/1
+  def show
+    if user
+      current_adapter.success(user)
+    else
+      current_adapter.failure(user)
+    end
+  end
+
+  # PATCH/PUT /users/1
+  def update
+    if user.update_attributes(update_params)
+      current_adapter.success(user)
+    else
+      current_adapter.failure(user)
+    end
+  end
+
+  private
+
+  def update_params
+    params.require(:user).permit(:first_name, :last_name)
+  end
+
+  def user
+    @user ||= User.find_by(id: params[:id])
+  end
+end
+```
+`app/models/smart_adapters/users/index/html_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Index
+      class HtmlAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Html::Default
+
+        def success(resource)
+          render 'users/show', locals: { resource: resource }
+        end
+      end
+    end
+  end
+end
+```
+`app/models/smart_adapters/users/index/json_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Index
+      class JsonAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Json::Default
+
+        def success(resource)
+          render json: resource, status: :ok
+        end
+      end
+    end
+  end
+end
+
+```
+`app/models/smart_adapters/users/show/html_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Show
+      class HtmlAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Html::Default
+
+        def success(resource)
+          render 'objects/show', locals: { resource: resource }
+        end
+
+        def failure(resource)
+          redirect_back fallback_location: root_path, flash: { error: 'Resource not found' }
+        end
+      end
+    end
+  end
+end
 ```
+`app/models/smart_adapters/users/show/json_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Show
+      class JsonAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Json::Default
+
+        def success(resource)
+          render json: resource, status: :ok
+        end
+
+        def failure(resource)
+          render json: {}, status: :not_found
+        end
+      end
+    end
+  end
+end
+```
+`app/models/smart_adapters/users/update/html_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Update
+      class HtmlAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Html::Default
+
+        def success(resource)
+          render 'objects/show', locals: { resource: resource }
+        end
+
+        def failure(resource)
+          unless resource.present?
+            return redirect_back fallback_location: root_path, flash: { error: 'Resource not found' }
+          end
+          return redirect_back fallback_location: root_path, flash: { error: resource.errors }
+        end
+      end
+    end
+  end
+end
+```
+`app/models/smart_adapters/users/update/json_adapter.rb`
+```ruby
+module SmartAdapters
+  module Users
+    module Update
+      class JsonAdapter < SimpleDelegator
+        include SmartAdapters::Util::Adapters::Json::Default
+
+        def success(resource)
+          render json: resource, status: :ok
+        end
+
+        def failure(resource)
+          return render json: {}, status: :not_found unless resource.present?
+          render json: { errors: resource.errors }, status: :bad_request
+        end
+      end
+    end
+  end
+end
+```
+
+## TODO
+- Add remaining formats: `:text`, `:ics`, `:csv`, `:yaml`, `:rss`, `:atom`
+- Add generator

data/lib/smart_adapters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartAdapters
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrea Rampin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement