basic_serializer 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6467159fe28710d9e2d7be99ce5fb44b79d459b95a9e5ecfc76ded853aed33ef
+  data.tar.gz: 9994936cc0cfe8af377e2bdc08c0331951b4e5e093131fd087c48242d2bb1fdf
+SHA512:
+  metadata.gz: 48ff1802dcd59c109e90258d562b58eeff2e0c8f45120373685e752b6e1bb426c21e4a39bcc036a0e3f2e7c8ca7920dd762194d6aa40c00a281e1792379cc509
+  data.tar.gz: 8d8feab99a1fc2daddf3b4d060c9d13b45f2a4007f696b4aa09c4271f9aca8ad7e71c010fad0e20f899f1df2f29f1836b06343207bb45df44172ed65afc015ee

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adam Ladachowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# 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:
+
+    $ bundle add basic_serializer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install basic_serializer
+
+## Usage
+
+```ruby
+class UserSerializer < BasicSerializer
+  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
+  schema_ref "#/components/schemas/User" # optional swagger schema reference
+end
+
+serializer = UserSerializer.new(name: 'Foobar', email: 'email@domain.com', id: 1)
+serializer.serialize
+```
+```json
+{
+  "id": 1,
+  "name": "Foobar",
+  "email": "email@domain.com"
+}
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/simple_serializer/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleSerializer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_serializer/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/basic_serializer/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module Config
+    OJ_FORMAT = {
+      mode: :compat,
+      indent: "  ",
+      space: " ",
+      space_before: "",
+      object_nl: "\n",
+      array_nl: "\n"
+    }.freeze
+  end
+end

data/lib/basic_serializer/dsl.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module DSL
+    def attributes
+      @attributes ||= {}
+    end
+
+    def attribute(name, type = nil)
+      attributes[name] = type || :default
+
+      return if @defined_methods&.include?(name)
+
+      @defined_methods ||= Set.new
+      @defined_methods << name
+
+      define_method(name) { object.public_send(name) }
+    end
+
+    def model_name(name)
+      @model_name = name
+    end
+
+    def custom_model_name
+      @custom_model_name ||= @model_name || name.delete_suffix("Serializer")
+    end
+
+    def schema_ref(ref)
+      @schema_ref = ref
+    end
+
+    def format(name, pretty: false)
+      @format = { name: name, pretty: pretty }
+    end
+
+    def format_settings
+      @format_settings ||= {}
+    end
+  end
+end

data/lib/basic_serializer/hash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  class Hash < ::Hash
+    def deep_stringify_keys
+      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
+  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,28 @@
+# frozen_string_literal: true
+
+class BasicSerializer
+  module Swagger
+    def swagger_ref
+      @swagger_ref ||= @schema_ref || "#/components/schemas/#{custom_model_name}"
+    end
+
+    def swagger_schema
+      @swagger_schema ||= build_swagger_schema
+    end
+
+    private
+
+    def build_swagger_schema
+      {
+        type: "object",
+        properties: build_properties
+      }
+    end
+
+    def build_properties
+      attributes.transform_values do |type|
+        { type: type }
+      end
+    end
+  end
+end

data/lib/basic_serializer.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "oj"
+require "yaml"
+require "set"
+require "basic_serializer/dsl"
+require "basic_serializer/swagger"
+require "basic_serializer/struct"
+require "basic_serializer/config"
+require "basic_serializer/hash"
+class BasicSerializer
+  extend DSL
+  extend Swagger
+
+  attr_reader :object
+
+  def initialize(object)
+    @object = object
+
+    @object = @object.is_a?(::Hash) ? struct : @object
+
+    remove_instance_variable(:@struct) if defined?(@struct)
+  end
+
+  def stringified_attributes
+    hash.deep_stringify_keys
+  end
+
+  alias as_json stringified_attributes
+
+  def to_json(*_args)
+    Oj.dump(stringified_attributes, **json_format_options)
+  end
+
+  def to_yaml
+    YAML.dump(stringified_attributes)
+  end
+
+  def serialize
+    case self.class.format_settings[:name]
+    when :json then to_json
+    when :yaml then to_yaml
+    else stringified_attributes
+    end
+  end
+
+  singleton_class.alias_method :openapi_ref, :swagger_ref
+  singleton_class.alias_method :openapi_schema, :swagger_schema
+
+  private
+
+  def hash
+    @hash ||= BasicSerializer::Hash.new
+
+    self.class.attributes.each_key do |attr_name|
+      @hash[attr_name] = send(attr_name)
+    end
+
+    @hash
+  end
+
+  def struct
+    return @struct if @struct
+
+    basic_struct ||= BasicSerializer::Struct.new(*object.keys.map(&:to_sym), keyword_init: true)
+
+    @struct ||= basic_struct.new(**object)
+  end
+
+  def json_format_options
+    @json_format_options ||= self.class.format_settings[:pretty] ? Config::OJ_FORMAT : {}
+  end
+end

data/sig/simple_serializer.rbs

@@ -0,0 +1,4 @@
+module SimpleSerializer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: basic_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Adam Ladachowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-08 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight and straightforward serializer for Ruby objects without
+  heavy dependencies
+email:
+- adam.ladachowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/basic_serializer.rb
+- lib/basic_serializer/config.rb
+- lib/basic_serializer/dsl.rb
+- lib/basic_serializer/hash.rb
+- lib/basic_serializer/struct.rb
+- lib/basic_serializer/swagger.rb
+- sig/simple_serializer.rbs
+homepage: https://github.com/aladac/basic_serializer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/aladac/basic_serializer
+  source_code_uri: https://github.com/aladac/basic_serializer
+  changelog_uri: https://github.com/aladac/basic_serializer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A simple serializer for Ruby objects
+test_files: []