action_schema 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1900a8787c395b5cfa7fce53e3feb8d049f33a08a0498c766d98c389aa1a30ca
-  data.tar.gz: b51df6ac12c67618e34ad5deed5d4615a751b4d1cf999d0b38cdf7aa063d29ed
+  metadata.gz: f9c6d088972b4743ea5546ac98057b3f9135a9eb33ba9f942fe674322fe776a3
+  data.tar.gz: a8f82b40e0af0d3d00b64378552b807e98afcb37c4da5c65278a7a83452eeb91
 SHA512:
-  metadata.gz: 9f5f8d04be3a8dfde7b46c06580446934e810b1f1486bfa5a73c3b586003d2fe5fbcad63507b4b33005f9bc4944e5570b141eb704fad20f5f61bfbe9603fec82
-  data.tar.gz: 4f9936bc68703ab3a0ad4dcd7e3a217cf022a4cdf2cf5859b47097e8e5b543be6c5220c558e9eb86583357f06335bd55482d78c545033c44210f21246d477f0c
+  metadata.gz: e91dfd4a7a03bc8ce3edec61626cb129517b8dcb9e3aa5ca2b90de4b9e0f9b548f58563d24c4c4d537a15dbcdca3ccfcae65768820a3e87183da4944f17176a0
+  data.tar.gz: 263251f5f9d8ca9ba1ece0b3597bf45e2b74f9d0494df9383bb5b0bc3e91b7b90461251dd4fa8b6021bdb4e9c49be2a0d007126af5423148b25b8837dd38fe36

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1] - 2024-12-09
+
+- **More Closures:** Support procs and lambdas anywhere a block is accepted in the DSL
+
 ## [0.1.0] - 2024-12-08
 
 ### Added
@@ -49,5 +53,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 100% test coverage
 - Comprehensive documentation
 
-[Unreleased]: https://github.com/jtnegrotto/action_schema/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/jtnegrotto/action_schema/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/jtnegrotto/action_schema/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/jtnegrotto/action_schema/releases/tag/v0.1.0

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/action_schema.svg)](https://badge.fury.io/rb/action_schema)
+
 # ActionSchema
 
 ActionSchema provides a flexible, Rails-friendly approach to rendering ~and
@@ -8,7 +10,7 @@ parsing~ (coming soon) structured data in your controllers.
 **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"`) 
+* Lock the version in your Gemfile (e.g. `gem "action_schema", "= 0.1.1"`) 
 * 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
@@ -18,7 +20,7 @@ significant changes. If you do choose to use it, please:
 Add the gem to your Gemfile:
 
 ```bash
-bundle add action_schema -v '= 0.1.0'
+bundle add action_schema -v '= 0.1.1'
 ```
 
 ## Usage
@@ -33,10 +35,10 @@ The simplest way to define a schema is inline in your controller action:
 class UsersController < ApplicationController
   def index
     users = User.all
-    render json: schema_for(users) do
+    render json: schema_for(users, -> {
       fields :id, :email
-      computed(:full_name) { |user| "#{user.first_name} #{user.last_name}" }
-    end
+      computed :full_name, ->(user) { "#{user.first_name} #{user.last_name}" }
+    })
   end
 end
 ```
@@ -203,8 +205,8 @@ 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
+takes a closure that receives the record or collection to be rendered. The
+`after_render` hook takes a closure that receives the rendered data. Both hooks
 allow you to replace the data with a new value using the `transform` method:
 
 ```ruby

data/lib/action_schema/base.rb

@@ -15,19 +15,25 @@ module ActionSchema
         new(*args, **kwargs, &block).render
       end
 
-      def before_render(&block)
-        self.before_render_hooks ||= []
-        before_render_hooks << block
+      def before_render_hooks
+        @before_render_hooks ||= []
       end
 
-      def after_render(&block)
-        self.after_render_hooks ||= []
-        after_render_hooks << block
+      def after_render_hooks
+        @after_render_hooks ||= []
+      end
+
+      def before_render(lambda_or_proc = nil, &block)
+        self.before_render_hooks << (lambda_or_proc || block)
+      end
+
+      def after_render(lambda_or_proc = nil, &block)
+        self.after_render_hooks << (lambda_or_proc || block)
       end
 
       def inherited(subclass)
-        subclass.before_render_hooks = (before_render_hooks || []).dup
-        subclass.after_render_hooks = (after_render_hooks || []).dup
+        subclass.before_render_hooks = before_render_hooks.dup
+        subclass.after_render_hooks = after_render_hooks.dup
         subclass.schema = schema.dup
       end
 
@@ -43,6 +49,8 @@ module ActionSchema
             ->(controller) { controller.resolve_schema(schema_definition) }
           elsif schema_definition.is_a?(Class)
             schema_definition
+          elsif schema_definition.is_a?(Proc)
+            Class.new(base_schema_class, &Dalambda[schema_definition])
           elsif block_given?
             Class.new(base_schema_class, &block)
           else
@@ -52,8 +60,8 @@ module ActionSchema
         schema[name] = { association: resolved_schema }
       end
 
-      def computed(name, &block)
-        schema[name] = { computed: true, value: block }
+      def computed(name, lambda_or_proc = nil, &block)
+        schema[name] = { computed: true, value: (lambda_or_proc || block) }
       end
 
       def fields(*names)
@@ -109,7 +117,7 @@ module ActionSchema
 
         result[transformed_key] =
           if config[:computed]
-            instance_exec(record, context, &config[:value])
+            instance_exec(record, context, &Dalambda[config[:value]])
           elsif association = config[:association]
             associated_record_or_collection = record.public_send(key)
             if associated_record_or_collection.nil?
@@ -138,7 +146,7 @@ module ActionSchema
       hooks = self.class.public_send("#{type}_hooks") || []
       hooks.each do |hook|
         @transformed = nil
-        instance_exec(data, &hook)
+        instance_exec(data, &Dalambda[hook])
         data = @transformed || data
       end
       data

data/lib/action_schema/controller.rb

@@ -21,19 +21,21 @@ module ActionSchema
       resolve_schema_context(self.class.default_schema_context)
     end
 
-    def schema_for(record_or_collection, schema_name = :default, context: {}, &block)
+    def schema_for(record_or_collection, schema_name_or_proc = :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
+        elsif schema_name_or_proc.is_a?(Proc)
+          Class.new(ActionSchema.configuration.base_class, &Dalambda[schema_name_or_proc])
+        elsif schema_name_or_proc.is_a?(Class)
+          schema_name_or_proc
         else
-          self.class.action_schemas[schema_name]
+          self.class.action_schemas[schema_name_or_proc]
         end
 
-      raise ArgumentError, "Schema `#{schema_name}` not defined" unless schema_definition
+      raise ArgumentError, "Schema `#{schema_name_or_proc}` not defined" unless schema_definition
 
       schema_definition.new(record_or_collection, context: combined_schema_context, controller: self).render
     end

data/lib/action_schema/dalambda.rb

@@ -0,0 +1,27 @@
+module ActionSchema
+  # Dalambda is a stupid name for a stupid class.
+  # Forces your lambdas to ignore extra arguments and blocks.
+  # Works with instance_exec, etc.
+  class Dalambda
+    def self.[](lambda_or_proc, &block)
+      new(lambda_or_proc || block)
+    end
+
+    def initialize(lambda_or_proc, &block)
+      @lambda = lambda_or_proc || block
+      raise ArgumentError, "You must provide a lambda, proc, or block" unless @lambda.is_a?(Proc)
+    end
+
+    def to_proc
+      da_actual_lambda = @lambda
+      arity = @lambda.arity
+      proc do |*args, &block|
+        if da_actual_lambda.parameters.any? { |type, _| type == :block }
+          instance_exec(*args.take(arity), block, &da_actual_lambda)
+        else
+          instance_exec(*args.take(arity), &da_actual_lambda)
+        end
+      end
+    end
+  end
+end

data/lib/action_schema/version.rb

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

data/lib/action_schema.rb

@@ -8,6 +8,7 @@ module ActionSchema
 end
 
 require_relative "action_schema/version"
+require_relative "action_schema/dalambda"
 require_relative "action_schema/configuration"
 require_relative "action_schema/base"
 require_relative "action_schema/controller"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julien Negrotto
@@ -140,6 +140,7 @@ files:
 - lib/action_schema/base.rb
 - lib/action_schema/configuration.rb
 - lib/action_schema/controller.rb
+- lib/action_schema/dalambda.rb
 - lib/action_schema/railtie.rb
 - lib/action_schema/version.rb
 - sig/action_schema.rbs