basic_serializer 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ea4dc4f2674c0a329bef40b71c99753c5008e24da663da0062a71b43610749c
-  data.tar.gz: 7ecb72f526ade7efe422288afa410511b6d2beed02d64d3c4c17bb9c52066017
+  metadata.gz: 92045b1fba9ae2936d58f4dc47127467a4264dd53e7e1622a410d0f75e984daf
+  data.tar.gz: e2c8f5bd89a2955a10c505ab88449f5c8e19e3ad83de58a0dafcb81f357ba286
 SHA512:
-  metadata.gz: 41f731dee50291393c7f92afc02b66be970d956b53f94274e073cd4c1821eaeca137e2258fd414fe6e184000e4519bcd9bad4531005e10c142c85049af503b2f
-  data.tar.gz: f628620f170cedcfa4d0f4683dbfa31a9d0617d357ee8ef66662d6a2ee48eec91916af373696fac6cfa2540f66c820499b35f1dbd1e3eeb0754c7bd7cf63508c
+  metadata.gz: 101db57a5015c1c6be60590dfb7c5a04d4144a30811a0a1ade238ed1492dbc156d076cd4691ad062d277d6765df4919918d532ffe320ca8544a3f92f41799217
+  data.tar.gz: 7202ed9ffea28ba0c26f71577b68c06fc6b66ff62da718c0af91689f1be3834b89ecc53f42f0165d5ffc05ae0ad25f6d757c3a7ec4271d4ee02f5587a04a0ddd

data/README.md

@@ -1,8 +1,8 @@
 # BasicSerializer
+[![Ruby](https://github.com/aladac/basic_serializer/actions/workflows/main.yml/badge.svg)](https://github.com/aladac/basic_serializer/actions/workflows/main.yml)
 
 This is a simple serializer for Ruby objects without heavy dependencies.
 
-
 ## Installation
 
 Add to the application's Gemfile by executing:
@@ -17,17 +17,25 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ```ruby
 class UserSerializer < BasicSerializer
-  attribute :id, :integer
-  attribute :name, :string
-  attribute :email, :string
+  attribute :id, :integer                # attribute definition
+  attribute :name, :string               # attribute definition
+  attribute :email, :string              # attribute definition
+
+  format :json, pretty: true             # output format and options
 
-  model_name "User" # optional model name metadata
+  model_name "User"                      # optional model name metadata
   schema_ref "#/components/schemas/User" # optional swagger schema reference
 end
 
 serializer = UserSerializer.new(name: 'Foobar', email: 'email@domain.com', id: 1)
-serializer.to_json
-serializer.as_json
+serializer.serialize
+```
+```json
+{
+  "id": 1,
+  "name": "Foobar",
+  "email": "email@domain.com"
+}
 ```
 
 ## Development

data/lib/basic_serializer/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module Config
+    OJ_FORMAT = {
+      mode: :compat,
+      indent: "  ",
+      space: " ",        # This controls both spaces after commas AND colons
+      space_before: "",  # This controls space before colons
+      object_nl: "\n",
+      array_nl: "\n"
+    }.freeze
+  end
+end

data/lib/basic_serializer/dsl.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module DSL
+    def attributes
+      @attributes ||= {}
+    end
+
+    def attribute(name, type)
+      attributes[name] = type
+
+      return if method_defined?(name)
+
+      define_method(name) { object.send(name) }
+    end
+
+    def model_name(name)
+      @model_name ||= name
+    end
+
+    def custom_model_name
+      @model_name || name.gsub("Serializer", "")
+    end
+
+    def schema_ref(ref)
+      @schema_ref ||= ref
+    end
+
+    def format(name, pretty: false)
+      @format ||= { name: name, pretty: pretty }
+    end
+  end
+end

data/lib/basic_serializer/struct.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+BasicSerializer::Struct = Class.new(Struct)

data/lib/basic_serializer/swagger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module Swagger
+    def swagger_ref
+      @schema_ref || "#/components/schemas/#{custom_model_name}"
+    end
+
+    def swagger_schema
+      hash = {
+        type: "object",
+        properties: {}
+      }
+
+      attributes.each_pair do |name, type|
+        hash[:properties][name] = { type: type }
+      end
+
+      hash
+    end
+  end
+end

data/lib/basic_serializer.rb

@@ -1,79 +1,51 @@
 # frozen_string_literal: true
 
-# class UserSerializer < BasicSerializer
-#   attribute :id, :integer
-#   attribute :name, :string
-#   attribute :email, :string
-# end
-
 require "oj"
-
-BasicStruct = Class.new(Struct)
+require "yaml"
+require "basic_serializer/dsl"
+require "basic_serializer/swagger"
+require "basic_serializer/struct"
+require "basic_serializer/config"
 
 class BasicSerializer
-  VERSION = "0.1.0"
-
-  class << self
-    def attributes
-      @attributes ||= {}
-    end
-
-    def attribute(name, type)
-      attributes[name] = type
-
-      return if method_defined?(name)
-
-      define_method(name) { object.send(name) }
-    end
-
-    def model_name(name)
-      @model_name ||= name
-    end
-
-    def custom_model_name
-      @model_name || name.gsub("Serializer", "")
-    end
-
-    def schema_ref(ref)
-      @schema_ref ||= ref
-    end
-  end
+  extend DSL
+  extend Swagger
 
   attr_reader :object
 
   def initialize(object)
     @object = object.is_a?(Hash) ? struct(object) : object
+    remove_instance_variable(:@struct) if defined?(@struct)
   end
 
-  def as_json
+  def stringified_attributes
     hash = {}
 
     self.class.attributes.each_key do |attr_name|
       hash[attr_name] = send(attr_name)
     end
 
-    hash.transform_keys(&:to_s)
+    deep_stringify_keys(hash)
   end
 
+  alias as_json stringified_attributes
+
   def to_json(*_args)
-    Oj.dump(as_json)
-  end
+    pretty = self.class.instance_variable_get(:@format)&.dig(:pretty)
 
-  def self.swagger_ref
-    @schema_ref || "#/components/schemas/#{custom_model_name}"
+    Oj.dump(stringified_attributes, **(pretty ? Config::OJ_FORMAT : {}))
   end
 
-  def self.swagger_schema
-    hash = {
-      type: "object",
-      properties: {}
-    }
+  def to_yaml
+    YAML.dump(stringified_attributes)
+  end
 
-    attributes.each_pair do |name, type|
-      hash[:properties][name] = { type: type }
+  def serialize
+    case self.class.instance_variable_get(:@format)&.dig(:name)
+    when :json then to_json
+    when :yaml then to_yaml
+    else stringified_attributes
     end
-
-    hash
   end
 
   singleton_class.alias_method :openapi_ref, :swagger_ref
@@ -81,10 +53,20 @@ class BasicSerializer
 
   private
 
+  def deep_stringify_keys(hash)
+    hash.transform_keys(&:to_s).transform_values do |value|
+      case value
+      when Hash then deep_stringify_keys(value)
+      when Array then value.map { |item| item.is_a?(Hash) ? deep_stringify_keys(item) : item }
+      else value
+      end
+    end
+  end
+
   def struct(object)
     return @struct if @struct
 
-    basic_struct ||= BasicStruct.new(*object.keys.map(&:to_sym), keyword_init: true)
+    basic_struct ||= BasicSerializer::Struct.new(*object.keys.map(&:to_sym), keyword_init: true)
 
     @struct ||= basic_struct.new(**object)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basic_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Adam Ladachowski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies: []
 description: A lightweight and straightforward serializer for Ruby objects without
   heavy dependencies
@@ -25,6 +25,10 @@ files:
 - README.md
 - Rakefile
 - lib/basic_serializer.rb
+- lib/basic_serializer/config.rb
+- lib/basic_serializer/dsl.rb
+- lib/basic_serializer/struct.rb
+- lib/basic_serializer/swagger.rb
 - sig/simple_serializer.rbs
 homepage: https://github.com/aladac/basic_serializer
 licenses: