highlighter 0.5.0.pre.alpha → 0.6.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fed8b6305a5a4231734f7658d2577617ad4c32df1ec070871371c70225ae5296
-  data.tar.gz: f2c18df64f442916800fc6011849cce93e1256e4bf8a3ec93830e87bf3eefd0b
+  metadata.gz: da9405d1bba458ff552240bdeed67c2abcd06eeb584db494a9bbb33c92527573
+  data.tar.gz: d01563fa024c95fe7ae3ba9f7e6b14a2db3fb5d829bcfe32f7bd08ddec22db01
 SHA512:
-  metadata.gz: 79a2cb71a0e784547f3f10e006f22a96f516b8428b3a7e66892bdf067dfa8c9ddd97ce3dc3b338fe88c22a88a3d28ca3050b0ccc4f7fc359cda9f815b682e193
-  data.tar.gz: 85244d986e0ff0c5545e74f6df9d740f8f1f97af0d9ad2e890a80ca5b0d9b8cf3384b872abdacc74d4f1f593974da9d7c8f171a5a2986eed2008702b0a4cb7db
+  metadata.gz: 48a77c360a0e83fd0fc5c4d766fe8b0a9bd4d9b81fff7845f4d62fefbfc9c53d603d8d81f12cc867c580bdca46512275070bdf1a06f7677edf831f8e5b3ef3bd
+  data.tar.gz: 42061bf99fd777e7bcac9ad6fe5c8af85ab888926eaadc5e5ae5e28f873617ad6abbc13b3b450969acf40300f3acc5a263020a0cac39363b14273db121831713

data/CHANGELOG.md

@@ -10,4 +10,16 @@
 
 ## [0.3.0-alpha] - 2022-09-03
 
-- Feature: rename attribute
+- Feature: rename attribute
+
+## [0.4.0-alpha] - 2022-09-04
+
+- Feature: accept list of fields
+
+## [0.5.0-alpha] - 2022-09-09
+
+- Feature: field supports block
+
+## [0.6.0-alpha] - 2022-11-19
+
+- Feature: add support to choose which fields will be shown

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    highlighter (0.5.0.pre.alpha)
+    highlighter (0.6.0.pre.alpha)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -66,11 +66,11 @@ cars = [
       Car.new(id: 1, name: 'Polo', manufacturer: 'VW'),
       Car.new(id: 2, name: 'Focus', manufacturer: 'Ford')
     ]
-user = User.new(id: 1, name: "Kelly", cars: cars)
+user = User.new(id: 1, name: "Kelly", cars: cars, )
 ```
 Now that we have the instances of cars and user in place we just need to instatiate the serializer and call `to_h`
 ```ruby
-UserSerializer.new(user).to_h
+UserSerializer.new(user, show_description: false).to_h
 ```
 And it will return:
 ```ruby
@@ -118,6 +118,40 @@ class UserSerializer
 
   attributes :id, :name
 end
+```
+```ruby
+{
+  id: 1,
+  name: "Kelly"
+}
+```
+Passing a block:
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attributes :id, :name
+  attribute :description do |object|
+    "My name is #{object.name}"
+  end
+end
+```
+```ruby
+{
+  id: 1,
+  name: "Kelly",
+  description: "My name is John Wick"
+}
+```
+Hiding field
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attributes :id, :name
+  attribute :description, if: ->(_object, options) { option[:show_description] }
+end
+
 ```
 ```ruby
 {

data/lib/highlighter/attribute.rb

@@ -3,12 +3,13 @@
 module Highlighter
   # Holds info on attribute
   class Attribute
-    attr_reader :field, :serializer, :rename_to, :block
+    attr_reader :field, :serializer, :rename_to, :block, :show_if
 
-    def initialize(field:, serializer: nil, rename_to: nil, &block)
+    def initialize(field:, serializer: nil, rename_to: nil, show_if: nil, &block)
       @field = field
       @serializer = serializer
       @rename_to = rename_to
+      @show_if = show_if
       @block = block
     end
 
@@ -19,5 +20,11 @@ module Highlighter
     def block?
       !block.nil?
     end
+
+    def show?(object, options)
+      return true unless show_if.is_a? Proc
+
+      show_if.call(object, options)
+    end
   end
 end

data/lib/highlighter/commands/attribute_serializer.rb

@@ -14,7 +14,8 @@ module Highlighter
         @options = options
       end
 
-      def call
+      def call # rubocop:disable Metrics/AbcSize
+        return unless attribute.show?(object, options)
         return attribute.block.call(object) if attribute.block?
 
         value = object.send(attribute.field)

data/lib/highlighter/commands/object_serializer.rb

@@ -16,7 +16,7 @@ module Highlighter
 
       def call
         attributes.each_with_object({}) do |attr, hash|
-          hash[attr.name] = serialize_attribute(attr)
+          hash[attr.name] = serialize_attribute(attr) if attr.show?(object, options)
           hash
         end
       end

data/lib/highlighter/serializer.rb

@@ -23,12 +23,12 @@ module Highlighter
 
   # Add methods to expose and set up attributes
   module ClassMethods
-    def attribute(field, serializer: nil, rename_to: nil, &block)
-      attribute_list << if block_given?
-                          Attribute.new(field:, serializer:, rename_to:, &block)
-                        else
-                          Attribute.new(field:, serializer:, rename_to:)
-                        end
+    def attribute(field, **options, &block)
+      attribute_list << Attribute.new(field:,
+                                      serializer: options[:serializer],
+                                      rename_to: options[:rename_to],
+                                      show_if: options[:if],
+                                      &block)
     end
 
     def attributes(*fields)

data/lib/highlighter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Highlighter
-  VERSION = "0.5.0-alpha"
+  VERSION = "0.6.0-alpha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highlighter
 version: !ruby/object:Gem::Version
-  version: 0.5.0.pre.alpha
+  version: 0.6.0.pre.alpha
 platform: ruby
 authors:
 - Caio Rodriguez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-10 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies: []
 description: Serializer ruby objects in simple and straightforward way
 email: