smart_adapters 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eaeabe911a0b9b60e65687446a57cbd06669c329dfec08670866062f202af52
-  data.tar.gz: '082e37e56694963820b08257b6db3389ec024f53d695c730db60ee05bc3ef1e9'
+  metadata.gz: eb19d73886d1004c3f7a6013730e74d8850c2a62f9ebdbadc5bd73a20c4174b7
+  data.tar.gz: 5d84224b5c54ee3dee1b57f83d5cdc0d0e5d4009889da2ec0abd99eb60581e78
 SHA512:
-  metadata.gz: 103ce0a344b8988bfbbe946022cb599202fd7a5f9f31310eb3a039ccff7cb1711a22e1d102558e9fe4faefaf4fcaff350b17742a6c10e16c1e510691db74761b
-  data.tar.gz: 8739e38404a22d95125134ffe4e8d4b53e6d1812f0883791e7db5b9b70041848ca78b64afd5072dd581fd467ce2c96dd334716437632f1a6732541dae95b513a
+  metadata.gz: 27280726284035ae961f4c0e76da0a72d9d6cc2522300b09597b2632f7b10740fc239dd79b35472e9d12f3b8c656f3eaed8d901344e1808ebaf8384907c3b6b5
+  data.tar.gz: a692b2b8ae0c5848fc51f88c26cd0cc27fa94ef8fa3a437148c4a0e7fbf506225644fd968d350bbf20b962f522561532ade1496dfcce69c853b62b95a5ff6d90

data/README.md

@@ -2,8 +2,8 @@
 
 [![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:
+Smart Adapters neatly decouple the controllers from the views independently by the request format.
+In the [Ruby on Rails documentation](https://apidock.com/rails/ActionController/MimeResponds/InstanceMethods/respond_to), the controller decides the format of the answer based on the (Content-Type) request:
 
 ```ruby
 # app/controllers/people_controller.rb
@@ -16,28 +16,29 @@ def index
 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:
+The problem here is that over time the controllers inherit unnecessary complexity due to the evolution of the project (new logics and/or formats). The Smart Adapters solve the problem responding to a request with the appropriate format by using purposely designed classes.
 
 ```ruby
+# Controller
 # app/controllers/people_controller.rb
 def index
   current_adapter.success Person.all
 end
 
+# HTML Adapter
 # app/models/smart_adapters/people/index/html_adapter.rb
 def success(people)
   render 'people/show', locals: { people: people }
 end
 
+# XML Adapter
 # 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.
+The application can now be kept dry while introducing new formats and functionalities. 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
@@ -69,6 +70,14 @@ end
 
 Add the adapters for your **controller/action/format**.
 
+## Formats supported
+- HTML
+- JSON
+- JS
+- XML
+- CSV
+- TXT
+
 ### Example
 
 `app/controlles/users_controller.rb`

data/lib/smart_adapters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Andrea Rampin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Smart Adapters allow to keep the controllers DRY while being able to
-  respond to any request format.
+description: Smart Adapters keep Rails controllers dry.
 email:
 - andrea.rampin@gmail.com
 executables: []