action_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1900a8787c395b5cfa7fce53e3feb8d049f33a08a0498c766d98c389aa1a30ca
+  data.tar.gz: b51df6ac12c67618e34ad5deed5d4615a751b4d1cf999d0b38cdf7aa063d29ed
+SHA512:
+  metadata.gz: 9f5f8d04be3a8dfde7b46c06580446934e810b1f1486bfa5a73c3b586003d2fe5fbcad63507b4b33005f9bc4944e5570b141eb704fad20f5f61bfbe9603fec82
+  data.tar.gz: 4f9936bc68703ab3a0ad4dcd7e3a217cf022a4cdf2cf5859b47097e8e5b543be6c5220c558e9eb86583357f06335bd55482d78c545033c44210f21246d477f0c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-12-08
+
+### Added
+
+#### Core Features
+
+- **Rendering:** Render data in controller actions with `schema_for` 
+- **Inline schemas:** Define schemas inline in controller actions
+- **Controller schemas:** Define reusable schemas directly in controllers with `schema`
+- **Class schemas:** Define global schemas in standalone schema classes inheriting from `ActionSchema::Base`
+
+#### Field Definitions
+
+- **Fields:** Define a field with `field` or `fields`
+- **Conditional Fields:** Conditionally render fields using `if:` and `unless:`
+- **Computed Fields:** Define dynamically calculated fields with `computed`
+- **Omitting Fields:** Exclude fields with `omit`
+
+#### Associations
+
+- **Schema Associations:** Nest schemas using `association`. Supports inline, controller, and class schemas.
+
+#### Context & Hooks
+
+- **Contexts:** Pass additional context to schemas
+- **Hooks:** Execute code before and after rendering with `before_render` and `after_render`
+- **Transformation:** Transform data within hooks with `transform`
+
+#### Configuration
+
+- **Key Transformations:** Define global key transformations with `ActionSchema.configuration.transform_keys`
+- **Base Class:** Define your own base class for schemas with `ActionSchema.configuration.base_class`
+
+#### Rails Integration
+
+- **Rails Integration:** Automatically include `ActionSchema::Controller` in Rails controllers via a Railtie.
+
+#### Other
+
+- 100% test coverage
+- Comprehensive documentation
+
+[Unreleased]: https://github.com/jtnegrotto/action_schema/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/jtnegrotto/action_schema/releases/tag/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Julien Negrotto
+
+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,269 @@
+# ActionSchema
+
+ActionSchema provides a flexible, Rails-friendly approach to rendering ~and
+parsing~ (coming soon) structured data in your controllers.
+
+## Status: Experimental 🚧
+
+**ActionSchema** is currently in early development. Its API is subject to
+significant changes. If you do choose to use it, please:
+
+* Lock the version in your Gemfile (e.g. `gem "action_schema", "= 0.1.0"`) 
+* Be prepared to update your code as the library evolves
+* Refer to the [CHANGELOG](CHANGELOG.md) for updates
+* [Report](https://github.com/jtnegrotto/action_schema/issues/new) any issues you encounter to help improve the library
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```bash
+bundle add action_schema -v '= 0.1.0'
+```
+
+## Usage
+
+### Defining Schemas
+
+#### Inline Schemas
+
+The simplest way to define a schema is inline in your controller action:
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    users = User.all
+    render json: schema_for(users) do
+      fields :id, :email
+      computed(:full_name) { |user| "#{user.first_name} #{user.last_name}" }
+    end
+  end
+end
+```
+
+This approach is ideal for quick, one-off schemas. Think of it as a step up from `as_json` with added flexibility and readability.
+
+#### Controller Schemas
+
+For reusable schemas, define them in your controller. This keeps your code DRY and allows schemas to be shared across multiple actions:
+
+```ruby
+class UsersController < ApplicationController
+  schema :index do
+    fields :id, :email
+    computed(:full_name) { |user| "#{user.first_name} #{user.last_name}" }
+  end
+
+  def index
+    users = User.all
+    render json: schema_for(users, :index)
+  end
+end
+```
+
+**Tip:** Controller schemas are inherited by subclasses. This makes it easy to define a common schemas in a base controller.
+
+#### Class Schemas
+
+For global schemas, use schema classes:
+
+```ruby
+class UserSchema < ActionSchema::Base
+  fields :id, :email
+  computed(:full_name) { |user| "#{user.first_name} #{user.last_name}" }
+end
+```
+
+You can use these in your controllers like so:
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    users = User.all
+    render json: schema_for(users, UserSchema)
+  end
+end
+```
+
+### Schema Definition DSL
+
+#### Fields
+
+Regular fields are defined using the `field` and `fields` methods:
+
+```ruby
+field :id
+field :name
+field :created_at
+field :updated_at
+```
+
+or
+
+```ruby
+fields :id, :name, :created_at, :updated_at
+```
+
+Fields can be conditionally rendered using the `if` and `unless` options:
+
+```ruby
+field :email, if: ->(user) { user.email.present? }
+field :phone, unless: ->(user) { user.phone.nil? }
+```
+
+#### Omitting Fields
+
+You can omit fields using the `omit` method:
+
+```ruby
+omit :created_at, :updated_at
+```
+
+This can be useful when your schema inherits fields from a superclass, but you
+don't need all of them in a particular action.
+
+#### Computed Fields
+
+Computed fields are defined using the `computed` method:
+
+```ruby
+computed(:full_name) { |user| "#{user.first_name} #{user.last_name}" }
+```
+
+#### Associations
+
+Association schemas are specified using the `association` method, and like
+other schemas, these can be defined inline, at the controller level, or in a
+schema class.
+
+##### Inline
+
+```ruby
+schema do
+  fields :id, :email
+  association :posts do
+    fields :id, :title
+  end
+end
+```
+
+##### Named Schema
+
+```ruby
+schema :index do
+  fields :id, :email
+  association :posts, :post
+end
+
+schema :post do
+  fields :id, :title
+end
+```
+
+##### Class Schema
+
+```ruby
+class UserSchema < ActionSchema::Base
+  fields :id, :email
+  association :posts, PostSchema
+end
+
+class PostSchema < ActionSchema::Base
+  fields :id, :title
+end
+```
+
+#### Contexts
+
+Computed fields can access contextual data:
+
+```ruby
+computed(:is_current_user) { |user, context| user == context[:current_user] }
+```
+
+In your controller, you can pass the context to `#schema_for`:
+
+```ruby
+render json: schema_for(users, context: { current_user: current_user })
+```
+
+Alternatively, you can define the context at the controller level:
+
+```ruby
+class UsersController < ApplicationController
+  schema_context({ current_user: :current_user })
+end
+```
+
+Controller-level contexts are inherited, and are merged with contexts defined
+in the subclass. Action-level contexts inherit from the controller-level
+context, and are similarly merged. More specific contexts take precedence over
+less specific ones.
+
+#### Hooks
+
+You can define hooks to run before or after rendering. The `before_render` hook
+takes a block that receives the record or collection to be rendered. The
+`after_render` hook takes a block that receives the rendered data. Both hooks
+allow you to replace the data with a new value using the `transform` method:
+
+```ruby
+schema :default do
+  fields :id, :email
+
+  before_render do |user|
+    user.email.downcase!
+  end
+
+  after_render do |data|
+    transform({ user: data })
+  end
+end
+```
+
+**Tip:** Keep in mind that hooks are run whether the rendered object is a
+single record or a collection. Be sure to handle both cases as necessary.
+
+## Rationale
+
+The main reason that **ActionSchema** exists is that I find serialization in
+Rails to be a bit of a pain. While Rails' built-in serialization methods
+(`as_json`) are fine for simple cases, they quickly fall apart when you need to
+handle anything more complex. On the other hand, many serialization libraries
+feel like overkill, requiring too much boilerplate for tasks that should be
+straightforward.
+
+I believe that serialization is fundamentally the controller's responsibility.
+After all, you can't effectively optimize your queries if you don't know what
+data will be used. Integrating serialization into the controller, close to the
+query, makes it easier to reason about and ensures a tighter integration
+between your data and its representation.
+
+That said, I understand that not everyone shares this view. While
+**ActionSchema** provides a seamless API for defining schemas entirely within
+controllers, it also supports defining reusable schema classes outside of
+controllers for those who prefer a more decoupled approach. My goal is to
+strike a balance: to make serialization simple when you need it to be, while
+remaining flexible enough to adapt to a variety of use cases and scenarios.
+
+## 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/jtnegrotto/action_schema.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

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/action_schema/base.rb

@@ -0,0 +1,151 @@
+module ActionSchema
+  class FieldError < ActionSchema::Error
+    def initialize(field, record)
+      @field = field
+      @record = record
+      super("Field '#{field}' does not exist on record: #{record.inspect}")
+    end
+  end
+
+  class Base
+    class << self
+      attr_accessor :schema, :before_render_hooks, :after_render_hooks
+
+      def call(*args, **kwargs, &block)
+        new(*args, **kwargs, &block).render
+      end
+
+      def before_render(&block)
+        self.before_render_hooks ||= []
+        before_render_hooks << block
+      end
+
+      def after_render(&block)
+        self.after_render_hooks ||= []
+        after_render_hooks << block
+      end
+
+      def inherited(subclass)
+        subclass.before_render_hooks = (before_render_hooks || []).dup
+        subclass.after_render_hooks = (after_render_hooks || []).dup
+        subclass.schema = schema.dup
+      end
+
+      def field(name, value = nil, **options, &block)
+        schema[name] = { value: block || value || name, **options }
+      end
+
+      def association(name, schema_definition = nil, &block)
+        base_schema_class = ActionSchema.configuration.base_class
+
+        resolved_schema =
+          if schema_definition.is_a?(Symbol)
+            ->(controller) { controller.resolve_schema(schema_definition) }
+          elsif schema_definition.is_a?(Class)
+            schema_definition
+          elsif block_given?
+            Class.new(base_schema_class, &block)
+          else
+            raise ArgumentError, "An association schema or block must be provided"
+          end
+
+        schema[name] = { association: resolved_schema }
+      end
+
+      def computed(name, &block)
+        schema[name] = { computed: true, value: block }
+      end
+
+      def fields(*names)
+        names.each { |name| field(name) }
+      end
+
+      def omit(*names)
+        names.each { |name| schema.delete(name) }
+      end
+
+      def schema
+        @schema ||= {}
+      end
+
+      def parse(data)
+        raise NotImplementedError, "Parsing is not yet implemented"
+      end
+    end
+
+    attr_reader :record_or_collection, :context, :controller
+
+    def initialize(record_or_collection, context: {}, controller: nil)
+      @record_or_collection = record_or_collection
+      @context = context
+      @controller = controller
+    end
+
+    def render
+      renderable = @record_or_collection
+      renderable = apply_hooks(:before_render, @record_or_collection)
+
+      output =
+        if renderable.respond_to?(:map)
+          renderable.map { |record| render_record(record) }
+        else
+          render_record(renderable)
+        end
+
+      apply_hooks(:after_render, output)
+    end
+
+    private
+
+    def render_record(record)
+      self.class.schema.each_with_object({}) do |(key, config), result|
+        if_condition = config[:if]
+        unless_condition = config[:unless]
+
+        next if if_condition && !instance_exec(record, &if_condition)
+        next if unless_condition && instance_exec(record, &unless_condition)
+
+        transformed_key = transform_key(key)
+
+        result[transformed_key] =
+          if config[:computed]
+            instance_exec(record, context, &config[:value])
+          elsif association = config[:association]
+            associated_record_or_collection = record.public_send(key)
+            if associated_record_or_collection.nil?
+              nil
+            else
+              resolved_schema = association.is_a?(Proc) ? association.call(controller) : association
+              child_context = context.merge(parent: record)
+              resolved_schema.new(record.public_send(key), context: child_context, controller: controller).render
+            end
+          else
+            if record.respond_to?(config[:value])
+              record.public_send(config[:value])
+            else
+              raise FieldError.new(config[:value], record)
+            end
+          end
+      end
+    end
+
+    def transform_key(key)
+      transform_keys = ActionSchema.configuration.transform_keys
+      transform_keys ? transform_keys.call(key) : key
+    end
+
+    def apply_hooks(type, data)
+      hooks = self.class.public_send("#{type}_hooks") || []
+      hooks.each do |hook|
+        @transformed = nil
+        instance_exec(data, &hook)
+        data = @transformed || data
+      end
+      data
+    end
+
+    def transform(data)
+      @transformed = data
+    end
+  end
+end

data/lib/action_schema/configuration.rb

@@ -0,0 +1,29 @@
+module ActionSchema
+  class Configuration
+    attr_accessor :base_class, :transform_keys, :type_serializers
+
+    def initialize
+      @base_class = ActionSchema::Base
+      @transform_keys = nil
+      @type_serializers = {}
+    end
+
+    def base_class
+      if @base_class.is_a?(String)
+        @base_class.constantize
+      else
+        @base_class
+      end
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/action_schema/controller.rb

@@ -0,0 +1,58 @@
+module ActionSchema
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :action_schemas, default: {}
+      class_attribute :default_schema_context, default: {}
+    end
+
+    class_methods do
+      def schema(name = :default, &block)
+        action_schemas[name] = Class.new(ActionSchema.configuration.base_class, &block)
+      end
+
+      def schema_context(context)
+        self.default_schema_context = self.default_schema_context.merge(context)
+      end
+    end
+
+    def schema_context
+      resolve_schema_context(self.class.default_schema_context)
+    end
+
+    def schema_for(record_or_collection, schema_name = :default, context: {}, &block)
+      combined_schema_context = schema_context.merge(resolve_schema_context(context))
+
+      schema_definition =
+        if block_given?
+          Class.new(ActionSchema.configuration.base_class, &block)
+        elsif schema_name.is_a?(Class)
+          schema_name
+        else
+          self.class.action_schemas[schema_name]
+        end
+
+      raise ArgumentError, "Schema `#{schema_name}` not defined" unless schema_definition
+
+      schema_definition.new(record_or_collection, context: combined_schema_context, controller: self).render
+    end
+
+    def resolve_schema(schema_name)
+      self.class.action_schemas[schema_name] ||
+        raise(ArgumentError, "Schema `#{schema_name}` not defined")
+    end
+
+    private
+
+    def resolve_schema_context(context)
+      context.transform_values do |value|
+        if value.is_a?(Proc)
+          instance_exec(&value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/action_schema/railtie.rb

@@ -0,0 +1,9 @@
+module ActionSchema
+  class Railtie < ::Rails::Railtie
+    initializer "action_schema.controller" do
+      ActiveSupport.on_load(:action_controller_base) do
+        include ActionSchema::Controller
+      end
+    end
+  end
+end

data/lib/action_schema/version.rb

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

data/lib/action_schema.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+
+module ActionSchema
+  class Error < StandardError; end
+end
+
+require_relative "action_schema/version"
+require_relative "action_schema/configuration"
+require_relative "action_schema/base"
+require_relative "action_schema/controller"
+require_relative "action_schema/railtie" if defined?(Rails)

data/sig/action_schema.rbs

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

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: action_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Negrotto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActionSchema provides a flexible, Rails-friendly approach to rendering
+  and parsing structured data in your controllers.
+email:
+- jtnegrotto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/action_schema.rb
+- lib/action_schema/base.rb
+- lib/action_schema/configuration.rb
+- lib/action_schema/controller.rb
+- lib/action_schema/railtie.rb
+- lib/action_schema/version.rb
+- sig/action_schema.rbs
+homepage: https://github.com/jtnegrotto/action_schema
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jtnegrotto/action_schema
+  source_code_uri: https://github.com/jtnegrotto/action_schema
+  changelog_uri: https://github.com/jtnegrotto/action_schema/blob/master/CHANGELOG.md
+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.23
+signing_key:
+specification_version: 4
+summary: A lightweight schema library for Rails controllers.
+test_files: []