highlighter 0.1.0 → 0.3.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb5ff98b735f8db19cce93c9c60a1770583bfe79f4f2eafde3edb416ac1720c
-  data.tar.gz: abe29e519393a81c5c3dd5f4aa75c065584695c910badc26207a4d6295f30e1f
+  metadata.gz: 0da81f118da4f0f966398170d013bfbde42783d862a416b668d28f7680036ea1
+  data.tar.gz: b4419445f9c3427a7c65b4f12d138f17cc86f74d65587ee24ce45f3b8c0f09ab
 SHA512:
-  metadata.gz: a0fa614bdeac9734737e552c2a3ca2081dfe1359b03786d818d315049433164e2e1488a96071c32d190bd0d57ab0e8a10b6529b4ebca1f1cdca13eb5416fafb1
-  data.tar.gz: 1a698647c970a53d078f66093452593b84b5bbac22dde8f5d5a9e9180da73ed8cf2ad7f6048dac0d7d6f562398e56b6f8e146901adfed3223c89140ed9801308
+  metadata.gz: e7f0ef49bebdc089c5d0a11da23aaad9fcddb68dc5f21297b0505451ea0d4ea3e10345bf0884964d653567aa9c37ae61f7263a00f42c291d94270d14a6ffbb43
+  data.tar.gz: 0ff8249c987ba58b2a6a585d0caa3e8655c17d0af07ce5599ad29126ccbf890f5f7719f6401946b5c87966ada2cb3757447d0788230e8a67c7fa1447b49f8d78

data/.rubocop.yml

@@ -11,3 +11,6 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Max: 600

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.0)
+    highlighter (0.3.0.pre.alpha)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -85,7 +85,34 @@ 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"
+}
+```
 ## 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,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,46 +7,29 @@ module Highlighter
       base.extend(ClassMethods)
     end
 
-    def initialize(object)
+    def initialize(object, options = {})
       @object = object
+      @options = options
     end
 
     def to_h
-      self.class.attributes.each_with_object({}) do |attr, hash|
-        hash[attr.name] = serialize_attribute(attr)
-        hash
-      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)
-    end
+      return if @object.nil?
 
-    def serialize_array(array, attr)
-      array.map do |value|
-        apply_serializer(value, attr)
-      end
+      Commands::ObjectSerializer.call(object: @object,
+                                      attributes: self.class.attributes,
+                                      options: @options)
     end
+  end
 
-    def apply_serializer(value, attr)
-      return value if attr.serializer.nil?
-
-      attr.serializer.new(value).to_h
+  # Add methods to expose and set up attributes
+  module ClassMethods
+    def attribute(field, serializer: nil, rename_to: nil)
+      instance_variable_set(:@attributes, []) unless instance_variable_defined?(:@attributes)
+      instance_variable_get(:@attributes) << Attribute.new(field:, serializer:, rename_to:)
     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 attributes
-        instance_variable_get(:@attributes)
-      end
+    def attributes
+      instance_variable_get(:@attributes)
     end
   end
 end

data/lib/highlighter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Highlighter
-  VERSION = "0.1.0"
+  VERSION = "0.3.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.0
+  version: 0.3.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-03 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: