geckorate 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4368265d1232c7456946e705182d89e4f515b0ba182cd2028c02287096ba21a7
-  data.tar.gz: 2648e7f27065c9ce0f3980635ae9a63cb44f8c4e0611a83706a71abb0f26b6b8
+  metadata.gz: ae64051898a555265e590a35db8dd7772269f7d03b1305dda594bcd3fbe1c31e
+  data.tar.gz: 211bdf9f83780632ff92c01f3a46e96c64b0606c3abcc43ce0bd41105d3e3960
 SHA512:
-  metadata.gz: e1190360f285279d08756159094328a1b46bbebe8ba0d9a03f33b33a088b3ce739c3172c19461693a106ccb82fe1b9419636105c0853f265e6f3aaac50853d5a
-  data.tar.gz: 307a7a3c98e7aa4e7e4e375f6901274bb2d869fe560fdf760a677f17f2790efe1ea5e7dec4c9d7d71fa132aec4deb9d9049e197268bbcf92819ad581fc2e6bc7
+  metadata.gz: d132d63d8176d5940a9a022634b0f663a0dbf730b4f0d89e0eb5b696870fae5364633f759300d91eeda96c8d4ccb644d9d438f93c156037050e04fc03e90ba47
+  data.tar.gz: 02f6595dcf68fa25ff1e8f3478373802a5160fade930d755d08ecaf99c2866e422f912957bc4a32720990d612fef8ed91ae9880566b881195bc2e4d059bb3bc1

data/README.md

@@ -2,6 +2,12 @@
 
 A dead simple decorator for Ruby
 
+# Why
+
+This gem groups the functionality I used to implement in every Rails project I
+had so I thought of packaging it into a gem and get over with it. Also, see
+[Build your own decorator pattern](https://pdabrowski.com/blog/build-your-own-decorator-pattern).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,7 +46,7 @@ Now, define your decorator as such:
 # app/decorators/post_decorator.rb
 
 class PostDecorator < Geckorate::Decorator
-  def decorate
+  def decorate(options = {})
     {
       title: title,
       username: user.name
@@ -65,15 +71,15 @@ end
 
 ### For collections
 
-There's a method `decorate_collection(collection)` for decorating collections.
+There's a method `decorate_collection(collection, options = {})` for decorating collections.
 Example: `PostDecorator.decorate_collection(Post.all)` returns an array of
 decorated Post objects.
 
 ### With paginated collections
 
 Currently, there are two methods for pagination; one for Kaminari
-`decorate_kaminari_collection(collection)` and another for will_paginate
-`decorate_will_paginate_collection(collection)`. The returned hash from both
+`decorate_kaminari_collection(collection, options = {})` and another for will_paginate
+`decorate_will_paginate_collection(collection, options = {})`. The returned hash from both
 methods looks like this:
 
 ```ruby

data/lib/geckorate/version.rb

@@ -1,3 +1,3 @@
 module Geckorate
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/geckorate.rb

@@ -2,36 +2,36 @@ require "geckorate/version"
 
 module Geckorate
   class Decorator < SimpleDelegator
-    def decorate(options: {}); end
+    def decorate(options = {}); end
 
     class << self
-      def decorate_collection(collection, class_name: nil, options: {})
+      def decorate_collection(collection, options = {})
         return [] if collection.empty?
 
-        klass           = class_name || collection.first.class
+        klass           = options.fetch(:class_name, collection.first.class)
         full_klass_name = klass.to_s.concat('Decorator')
         decorator_klass = Class.const_get(full_klass_name)
 
         collection.map do |item|
-          decorator_klass.new(item).decorate(options: options)
+          decorator_klass.new(item).decorate(options)
         end
       end
 
-      def decorate_kaminari_collection(collection, class_name: nil, options: {})
+      def decorate_kaminari_collection(collection, options = {})
         {
           page: collection.current_page,
           per_page: collection.current_per_page,
           total: collection.total_count,
-          records: decorate_collection(collection, class_name: class_name, options: options)
+          records: decorate_collection(collection, options)
         }
       end
 
-      def decorate_will_paginate_collection(collection, class_name: nil, options: {})
+      def decorate_will_paginate_collection(collectionf, options = {})
         {
           page: collection.current_page,
           per_page: collection.per_page,
           total: collection.total_entries,
-          records: decorate_collection(collection, class_name: class_name, options: options)
+          records: decorate_collection(collection, options)
         }
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geckorate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ahmed Saleh