highlighter 0.2.0.pre.alpha → 0.5.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b858676f9797dd49895ba65127dad51d3e4884592a7c542f22b9e120b8c05618
-  data.tar.gz: '049a27f4096feba8cf4967fea14d249cee3d9093416206e99389813966b01420'
+  metadata.gz: fed8b6305a5a4231734f7658d2577617ad4c32df1ec070871371c70225ae5296
+  data.tar.gz: f2c18df64f442916800fc6011849cce93e1256e4bf8a3ec93830e87bf3eefd0b
 SHA512:
-  metadata.gz: 7444b6856724a83cb30a8533164967cf949bd9e279091d593123ef9c694a6f0b581bfe01ccceba6c7252725bd64a7db185372e1a0ab495183ab6c4e216fdb225
-  data.tar.gz: b04bd46c3ba05d7d8deca7a17b2807ee1c7e620492d5f1f96442cd47aefbf4e8dad78608c1a298f24ed327bff2bead87ad7fabc8391db592dee6e59541784d8e
+  metadata.gz: 79a2cb71a0e784547f3f10e006f22a96f516b8428b3a7e66892bdf067dfa8c9ddd97ce3dc3b338fe88c22a88a3d28ca3050b0ccc4f7fc359cda9f815b682e193
+  data.tar.gz: 85244d986e0ff0c5545e74f6df9d740f8f1f97af0d9ad2e890a80ca5b0d9b8cf3384b872abdacc74d4f1f593974da9d7c8f171a5a2986eed2008702b0a4cb7db

data/CHANGELOG.md

@@ -7,3 +7,7 @@
 ## [0.2.0-alpha] - 2022-09-02
 
 - Feature: add support to assign serializers on the fly
+
+## [0.3.0-alpha] - 2022-09-03
+
+- Feature: rename attribute

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,6 @@
 # Highlighter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/highlighter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An easy way to serialize ruby objects :) 
 
 ## Installation
 
@@ -98,6 +96,36 @@ end
 ```ruby
 UserSerializer.new(user, custom_serializer: CarSerializer).to_h
 ```
+Renaming attribute:
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attribute :id
+  attribute :name, rename_to: :full_name
+end
+```
+```ruby
+{
+  id: 1,
+  full_name: "Kelly"
+}
+```
+Passing a list of fields:
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attributes :id, :name
+end
+```
+```ruby
+{
+  id: 1,
+  name: "Kelly"
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/highlighter/attribute.rb

@@ -3,11 +3,21 @@
 module Highlighter
   # Holds info on attribute
   class Attribute
-    attr_reader :name, :serializer
+    attr_reader :field, :serializer, :rename_to, :block
 
-    def initialize(name:, serializer: nil)
-      @name = name
+    def initialize(field:, serializer: nil, rename_to: nil, &block)
+      @field = field
       @serializer = serializer
+      @rename_to = rename_to
+      @block = block
+    end
+
+    def name
+      rename_to.nil? ? field : rename_to
+    end
+
+    def block?
+      !block.nil?
     end
   end
 end

data/lib/highlighter/commands/attribute_serializer.rb

@@ -15,7 +15,9 @@ module Highlighter
       end
 
       def call
-        value = object.send(attribute.name)
+        return attribute.block.call(object) if attribute.block?
+
+        value = object.send(attribute.field)
         return serialize_array(value) if value.instance_of? Array
 
         apply_serializer(value, attribute)

data/lib/highlighter/serializer.rb

@@ -16,20 +16,31 @@ module Highlighter
       return if @object.nil?
 
       Commands::ObjectSerializer.call(object: @object,
-                                      attributes: self.class.attributes,
+                                      attributes: self.class.attribute_list,
                                       options: @options)
     end
   end
 
   # Add methods to expose and set up attributes
   module ClassMethods
-    def attribute(name, serializer: nil)
-      instance_variable_set(:@attributes, []) unless instance_variable_defined?(:@attributes)
-      instance_variable_get(:@attributes) << Attribute.new(name:, serializer:)
+    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
     end
 
-    def attributes
-      instance_variable_get(:@attributes)
+    def attributes(*fields)
+      fields.each do |field|
+        attribute_list << Attribute.new(field:)
+      end
+    end
+
+    def attribute_list
+      instance_variable_set(:@attribute_list, []) unless instance_variable_defined?(:@attribute_list)
+
+      instance_variable_get(:@attribute_list)
     end
   end
 end

data/lib/highlighter/version.rb

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

metadata

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