highlighter 0.1.1 → 0.4.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3c586f7e61fcde95b897c059b304e52a577b36ce47ee90af831c478a3fe9a4
-  data.tar.gz: d881765b127d531a04892a7018a73c7fd0e7f86078796d4543a705eeead9c306
+  metadata.gz: fc57165cc3381a2749507abc7746f95d2ede9786820b7ff3e8d2f9624981fd66
+  data.tar.gz: 593a5b19b6d616a407dd7b214186c43d3d478514f2607b318957485e717dcb21
 SHA512:
-  metadata.gz: 9285161b7647b13e7a02b4002b4fada32c4f25e6c1a7918f3914fcdfcfc9ef572459483589f8257c80b491f35fc649a606f895ec3c33c6dd29d06d470691f83e
-  data.tar.gz: 156b4030920abcf5e7dcf49f717820bb1ee1fcf832bd5faa1bd8fc6bae7306590736b0ec9537425591fb8804b7655a582e244ba7642f0c22d2180488d4409523
+  metadata.gz: 70557187e4553b5049f2bf15da03c5f40710b6cc5daf133c15190d51d01193272f147d91e14b7c43a632c832abcfef2325cd2ae5b20608a3f95080c2525dc45d
+  data.tar.gz: 9601811f3dc47ef0396432d4fa949d1098a95dee414e7d3e921f59ee8662ce3a884d1a453e0434698c8763b2127d4b3b77630f3cf6e34ace048d944528eafbd3

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.1.0] - 2022-08-13
 
 - Initial release
+
+## [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.1.1)
+    highlighter (0.4.0.pre.alpha)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -85,6 +85,48 @@ And it will return:
         ]
 }
 ```
+It also supports lambdas to set serializer on the fly:
+```ruby
+class UserSerializer
+  include Highlighter::Serializer
+
+  attribute :id
+  attribute :name
+  attribute :cars, serializer: ->(options) { options[:custom_serializer] }
+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
 

data/lib/highlighter/attribute.rb

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

data/lib/highlighter/commands/attribute_serializer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Highlighter
+  module Commands
+    # Command to serialize attribute
+    class AttributeSerializer
+      def self.call(object:, attribute:, options: {})
+        new(object:, attribute:, options:).call
+      end
+
+      def initialize(object:, attribute:, options:)
+        @object = object
+        @attribute = attribute
+        @options = options
+      end
+
+      def call
+        value = object.send(attribute.field)
+        return serialize_array(value) if value.instance_of? Array
+
+        apply_serializer(value, attribute)
+      end
+
+      private
+
+      attr_reader :object, :attribute, :options
+
+      def serialize_array(array)
+        array.map do |value|
+          apply_serializer(value, attribute)
+        end
+      end
+
+      def apply_serializer(value, attr)
+        serializer = attr.serializer
+        return value if serializer.nil?
+
+        serializer = serializer.call(options) if serializer.is_a? Proc
+
+        serializer.new(value).to_h
+      end
+    end
+  end
+end

data/lib/highlighter/commands/object_serializer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Highlighter
+  module Commands
+    # Command to serialize object
+    class ObjectSerializer
+      def self.call(object:, attributes:, options:)
+        new(object:, attributes:, options:).call
+      end
+
+      def initialize(object:, attributes:, options:)
+        @object = object
+        @attributes = attributes
+        @options = options
+      end
+
+      def call
+        attributes.each_with_object({}) do |attr, hash|
+          hash[attr.name] = serialize_attribute(attr)
+          hash
+        end
+      end
+
+      private
+
+      attr_reader :object, :attributes, :options
+
+      def serialize_attribute(attribute)
+        AttributeSerializer.call(object:, attribute:, options:)
+      end
+    end
+  end
+end

data/lib/highlighter/serializer.rb

@@ -7,48 +7,36 @@ module Highlighter
       base.extend(ClassMethods)
     end
 
-    def initialize(object)
+    def initialize(object, options = {})
       @object = object
+      @options = options
     end
 
     def to_h
       return if @object.nil?
 
-      self.class.attributes.each_with_object({}) do |attr, hash|
-        hash[attr.name] = serialize_attribute(attr)
-        hash
-      end
+      Commands::ObjectSerializer.call(object: @object,
+                                      attributes: self.class.attribute_list,
+                                      options: @options)
     end
+  end
 
-    def serialize_attribute(attr)
-      value = @object.send(attr.name)
-      return serialize_array(value, attr) if value.instance_of? Array
-
-      apply_serializer(value, attr)
+  # Add methods to expose and set up attributes
+  module ClassMethods
+    def attribute(field, serializer: nil, rename_to: nil)
+      attribute_list << Attribute.new(field:, serializer:, rename_to:)
     end
 
-    def serialize_array(array, attr)
-      array.map do |value|
-        apply_serializer(value, attr)
+    def attributes(*fields)
+      fields.each do |field|
+        attribute_list << Attribute.new(field:)
       end
     end
 
-    def apply_serializer(value, attr)
-      return value if attr.serializer.nil?
-
-      attr.serializer.new(value).to_h
-    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:)
-      end
+    def attribute_list
+      instance_variable_set(:@attribute_list, []) unless instance_variable_defined?(:@attribute_list)
 
-      def attributes
-        instance_variable_get(:@attributes)
-      end
+      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.1.1"
+  VERSION = "0.4.0-alpha"
 end

data/lib/highlighter.rb

@@ -3,6 +3,8 @@
 require_relative "highlighter/version"
 require_relative "highlighter/serializer"
 require_relative "highlighter/attribute"
+require_relative "highlighter/commands/object_serializer"
+require_relative "highlighter/commands/attribute_serializer"
 
 module Highlighter
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highlighter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0.pre.alpha
 platform: ruby
 authors:
 - Caio Rodriguez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies: []
 description: Serializer ruby objects in simple and straightforward way
 email:
@@ -28,6 +28,8 @@ files:
 - highlighter.gemspec
 - lib/highlighter.rb
 - lib/highlighter/attribute.rb
+- lib/highlighter/commands/attribute_serializer.rb
+- lib/highlighter/commands/object_serializer.rb
 - lib/highlighter/serializer.rb
 - lib/highlighter/version.rb
 - sig/highlighter.rbs
@@ -49,9 +51,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: