donatello 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fc1cb1e5179e6acc73f3d93625665ecfc3bb4e3097d1858723070ddf98045fd
+  data.tar.gz: b499b9e438011d5e5e80ebd8df6e0bde09037288e8aac5f923c7e7ee55accad3
+SHA512:
+  metadata.gz: 91ad3fb4dc6c934d3fe463ee8e9853ce8fa7cb318ac4aff65ab97f6c4d782df44d66827cf40a2e610855dc2445c301bafe1e8639dc18e1e4d4bce6b1befabeb9
+  data.tar.gz: 1bb867434862d3bc2d9cf26c0d979f5d815cd891ec13ef50fbe70e56f3d4dc576dc10372a71ced5dfe5b369f750243c2ec26c601f372579d8e2fc65f9119bffa

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 dave@devfarm.io. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dave Rogers
+
+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,151 @@
+# Donatello
+
+Donatello is a Ruby gem for effortlessly applying YAML-defined serialization schemas to Ruby objects, utilizing the speed of the Oj gem for optimal JSON output.
+
+After spending a lot of time with GraphQL, when I started working with other types of JSON APIs, I missed being able to define my schema centrally.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'donatello'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself with:
+
+```bash
+$ gem install donatello
+```
+
+## Usage
+
+### Defining a Schema
+
+Create a YAML file in your Rails project (e.g., config/serialization_schema.yml) that defines your serialization schema:
+
+```yaml
+# Mixed-in field set serializers (similar concept to fragments in GraphQL)
+common_fields:
+  - id
+  - created_at
+  - updated_at
+
+engagement:
+  - likes_count
+  - comments_count
+
+# User-related serializers
+
+public_user:
+  - with: common_fields # use a single mixin
+  - first_name
+  - last_name
+
+private_user:
+  - with: public_user
+  - access_token
+  - email
+
+author:
+  - first_name
+  - middle_initial
+  - last_name
+  - joined_at
+  - total_posts_count
+
+hidden_identity:
+  - first_name
+  - last_initial
+
+# Other Objects/Entities serializers
+
+post:
+  # include multiple mixins:
+  - with:
+      - common_fields
+      - engagement
+  - title
+  - body
+  # If no serializer is given, all fields will be dumped to the output:
+  - widgets
+  - comments:
+      # If a serializer is given, only the attributes defined in the schema will be included:
+      - serializer: comment
+  - author:
+      - serializer: author
+      - alias: author
+
+comment:
+  - with: common_fields
+  - content
+  - creator:
+      # The root of this node will be "commenter" but the `creator` message will be sent to the `comment` object
+      - alias: commenter
+      # only include the first name, and last initial
+      - serializer: hidden_identity
+```
+
+### Serializing an Object
+
+In your controller, use Donatello to serialize an object according to the schema:
+
+```ruby
+class PostsController < ApplicationController
+  # provides the "serialize" method. Note: Just put this in ApplicationController
+  include Donatello
+
+  def index
+    render json: serialize(Post.all, :post)
+    # or `current_user.posts` or `Post.first`, or a hash like `{ title: "Foo", ... }`
+
+    # or `render json: { posts: serialize(Post.all) }
+  end
+end
+```
+
+This will produce JSON output like:
+
+```JSON
+[{
+  "id": "1",
+  "title": "How to Defeat Shredder, and Look Good While Doing It.",
+  "body": "Once upon a time, in a sewer ...",
+  "author": {
+    "first_name": "Master",
+    "middle_initial": "P",
+    "last_name": "Splinter",
+    "total_posts_count": 25
+  },
+  "created_at": "...",
+  "updated_at": "...",
+  "comments": [{
+    "content": "I'll get you Splinter!!!11~!~!",
+    "creator": {
+      "first_name": "Shred",
+      "last_initial": "R"
+    }
+    // ...
+  },{
+    // ...
+  }],
+  "likes_count": 444,
+  "comments_count": 33
+},{
+  // ...
+}]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/devfarm-io/donatello].
+
+## License
+
+The gem is available as open source under the terms of the MIT License in this repo.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/donatello/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails"
+module Donatello
+  # Railtie for incorporating into a rails app
+  class Railtie < Rails::Railtie
+    initializer "donatello.configure" do |_app|
+      Donatello.setup
+    end
+  end
+end

data/lib/donatello/serializer.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Donatello # rubocop:disable Style/Documentation
+  MAX_LEVELS = 4 # TODO: make this configurable
+
+  def serialize(object, schema_name)
+    applied = apply_schema(object, schema_name, 0)
+    # Don't include the root
+    applied ? Oj.dump(applied[schema_name]) : Oj.dump(nil)
+  end
+
+  def apply_schema(object, schema_name, current_level = 0) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    # Stack level is too deep, return
+    return { schema_name => nil } if current_level > MAX_LEVELS || object.nil?
+
+    schema = Donatello.schema[schema_name.to_s]
+
+    # Handle empty schemas
+    # ex. schema: `empty:`
+    return nil if schema.nil?
+
+    # Handle collections of objects
+    if non_hash_enumerable?(object)
+      result = object.map do |o|
+        apply_schema(o, schema_name, current_level + 1)[schema_name]
+      end
+      return { schema_name => result }
+    end
+
+    # We can process this schema
+    result = schema.inject({}) do |acc, item|
+      # TODO: detect cycles
+      # TODO: add a test for cycles
+      # TODO: add a pretty print to show the stack when stack level too deep
+      # TODO: add a pretty print to show the stack when there's a cycle
+      if item.is_a?(Hash)
+        if item["with"]
+          acc.merge(
+            handle_with(object, item, current_level)
+          )
+        else
+          acc.merge(
+            handle_attribute_config(object, item, current_level)
+          )
+        end
+      elsif object.respond_to?(item)
+        acc.merge(
+          handle_attribute(object, item)
+        )
+      else
+        handle_exception(object, item)
+      end
+    end
+
+    { schema_name => result }
+  end
+
+  private
+
+  def handle_exception(object, item)
+    raise StandardError,
+          "Error: Cannot process item - object (#{object.class}) (#{object.inspect}) does not respond to '#{item}'."
+  end
+
+  def handle_attribute(object, item)
+    result = object.send(item)
+    case result
+    when Date, DateTime, Time
+      { item => result.iso8601 }
+    else
+      { item => result }
+    end
+  end
+
+  def entry_for(key, item)
+    attr_config = item.values.first || {}
+    item[key.to_sym] || item[key.to_s] || attr_config[key.to_sym] || attr_config[key.to_s]
+  end
+
+  def handle_attribute_config(object, item, current_level)
+    serializer_entry = entry_for(:serializer, item)
+    alias_entry = entry_for(:alias, item)
+    attribute_name = item.keys.map(&:to_s).find { |k| !%w[alias serializer].include?(k) }
+    schema_key = serializer_entry || attribute_name
+    alias_key = alias_entry || attribute_name
+    sub_object = object.send(attribute_name)
+
+    { alias_key => apply_schema(sub_object, schema_key, current_level + 1)[schema_key] }
+  end
+
+  def handle_with(object, item, current_level)
+    with_entry = item["with"]
+    if with_entry.is_a?(String)
+      apply_schema(object, with_entry, current_level + 1)[with_entry]
+    elsif with_entry.is_a?(Array)
+      handle_multiple_with(object, with_entry, current_level)
+    else
+      {}
+    end
+  end
+
+  def handle_multiple_with(object, with_entry, current_level)
+    with_entry.inject({}) do |with_combined, with_key|
+      res = apply_schema(object, with_key, current_level + 1)[with_key]
+      with_combined.merge(res || {})
+    end
+  end
+
+  def non_hash_enumerable?(object)
+    object.respond_to?(:each) && !object.is_a?(Hash)
+  end
+end

data/lib/donatello/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Donatello
+  VERSION = "0.1.0"
+end

data/lib/donatello.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "oj"
+
+require "donatello/version"
+require "donatello/serializer" # assuming this is your main module
+require "donatello/railtie" if defined?(Rails)
+
+module Donatello # rubocop:disable Style/Documentation
+  if defined?(Rails)
+    Oj.optimize_rails # Optimizes Oj for compatibility with Rails
+
+  else
+    Oj.default_options = {
+      use_to_json: true,
+      use_as_json: true,
+      time_format: :xmlschema,
+      second_precision: 3
+    }
+    Oj.add_to_json
+  end
+  class << self
+    extend Forwardable
+
+    def setup
+      yield config if block_given?
+    end
+
+    def reset!
+      @config = nil
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def_delegator :config, :schema_location
+    def_delegator :config, :schema
+  end
+
+  class Config # rubocop:disable Style/Documentation
+    def initialize
+      @schema_location = if defined?(Rails)
+                           Rails.root.join(
+                             "config", "serialization_schema.yml"
+                           )
+                         else
+                           File.join(Dir.pwd, "config", "serialization_schema.yaml")
+                         end
+    end
+
+    attr_accessor :schema_location
+
+    def schema
+      @schema ||= YAML.load_file(schema_location)
+    end
+  end
+end

data/sig/donatello.rbs

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: donatello
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Rogers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Donatello is a Ruby gem for effortlessly applying YAML-defined serialization
+  schemas to Ruby objects, utilizing the speed of the Oj gem for optimal JSON output
+email:
+- dave@devfarm.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/donatello.rb
+- lib/donatello/railtie.rb
+- lib/donatello/serializer.rb
+- lib/donatello/version.rb
+- sig/donatello.rbs
+homepage: https://github.com/devfarm-io/donatello
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/devfarm-io/donatello
+  source_code_uri: https://github.com/devfarm-io/donatello
+  changelog_uri: https://github.com/devfarm-io/donatello/CHANGELOG
+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.5.3
+signing_key:
+specification_version: 4
+summary: Donatello lets you sculpt your serialized JSON according to a YAML schema.
+test_files: []