halitosis 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dc2b6951bb551687107ecbf28dd84ef5d616b86a01f405bfd0578592e2ae572
-  data.tar.gz: a98c1b99cc9973958db53bd3ea5d6acd11de9b6f79fb9a5c9fcf07f97514de01
+  metadata.gz: 0576b2d1e7ce15303f1bdc4a845bc7e81d1f2e497d3e49b220f1dd68920938cb
+  data.tar.gz: 79a5d29e8ec21cf3f035719dab8ef719216424a8514c2ff045d8f0f0d1cbe552
 SHA512:
-  metadata.gz: dfed5ec625a1764322fa5ddc3df08b3fe0ee2dca6bcbe21da0c92daa00a168518f2f31e69ac0c7834ef4dded8ba3c62e93ba9349f9e68d63e7403ce98131d96b
-  data.tar.gz: bb36dc686ccecdefc51500b9cf5d8142a72d4e460ad562ea020de9b93b57f00f9a2ff4ddac12351afe3060c2494408dbefa3735002672bb80e39d97bb88e2f34
+  metadata.gz: '02779ecf3fd87d66cab25c245c1ca82a2eee370241088d1af6fcc72bde1f3e7917687119260e4d5d04f22dfb363c1d8d9b54730caece6a82825d2ca65f6d9ef5'
+  data.tar.gz: 2e77dae400e7f5ece72aa1604898444b90c43cca04694b495f23dda4aaf38e4b62b05bc1cdd67b1f32d1e5c1014924756e2b242bd4c5a648df944bee18d61520

data/lib/halitosis/attributes/field.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Halitosis
-  module Attributes
+  module Identifiers
     class Field < Halitosis::Field
     end
   end

data/lib/halitosis/base.rb

@@ -48,8 +48,8 @@ module Halitosis
 
       # @return [Hash] rendered representation
       #
-      def render
-        render_with_context(build_context)
+      def render(**options)
+        render_with_context(build_context(options))
       end
 
       # @param context [Halitosis::Context] the context instance

data/lib/halitosis/collection.rb

@@ -39,6 +39,21 @@ module Halitosis
       def collection_field
         fields.for_type(Field).last || raise(InvalidCollection, "#{name || Collection.name} collection is not defined")
       end
+
+      # Provide an alias for root_link
+      def link(*, **, &)
+        root_link(*, **, &)
+      end
+
+      # Provide an alias for root_meta
+      def meta(*, **, &)
+        root_meta(*, **, &)
+      end
+
+      # Provide an alias for root_permission
+      def permission(*, **, &)
+        root_permission(*, **, &)
+      end
     end
 
     module InstanceMethods

data/lib/halitosis/identifiers/field.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module Attributes
+    class Field < Halitosis::Field
+    end
+  end
+end

data/lib/halitosis/identifiers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module Identifiers
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      # Rails-style identifier definition
+      #
+      # @param name [Symbol, String]
+      # @param options [nil, Hash]
+      #
+      # @return [Halitosis::Identifiers::Field]
+      #
+      def identifier(name, options = {}, &procedure)
+        if fields.for_type(Field).any?
+          raise InvalidField, "You can only define one identifier per serializer"
+        end
+
+        fields.add(Field.new(name, options, procedure))
+      end
+    end
+
+    module InstanceMethods
+      # @return [Hash] the rendered hash with identifiers, if any
+      #
+      def render_with_context(context)
+        super.merge(identifiers(context))
+      end
+
+      # @return [Hash] identifiers from fields
+      #
+      def identifiers(context = build_context)
+        render_fields(Field, context) do |field, result|
+          result[field.name] = field.value(context)
+        end
+      end
+    end
+  end
+end
+
+require "halitosis/identifiers/field"

data/lib/halitosis/railtie.rb

@@ -3,8 +3,13 @@ module Halitosis
   #
   class Railtie < ::Rails::Railtie
     module Renderable
+      def render_with_params(params)
+        render(include: params[:include])
+      end
+
       def render_in(view_context)
-        view_context.render json: self
+        rendered = render_with_params(view_context.params)
+        view_context.render plain: rendered.to_json
       end
 
       def format

data/lib/halitosis/relationships.rb

@@ -37,9 +37,7 @@ module Halitosis
         render_fields(Field, context) do |field, result|
           value = field.value(context)
 
-          child = relationships_child(field.name.to_s, context, value)
-
-          result[field.name] = child if child
+          result[field.name] = relationships_child(field.name.to_s, context, value)
         end
       end
 

data/lib/halitosis/resource.rb

@@ -27,6 +27,18 @@ module Halitosis
         alias_method name, :resource
       end
 
+      # Override standard identifier field for resource-based serializers
+      #
+      # @param name [Symbol, String] name of the identifier
+      # @param options [nil, Hash] identifier options for field
+      #
+      def identifier(name, options = {}, &procedure)
+        unless procedure || options.key?(:value)
+          procedure = proc { resource.public_send(name) }
+        end
+        super(name, options, &procedure)
+      end
+
       # Override standard attribute field for resource-based serializers
       #
       # @param name [Symbol, String] name of the attribute

data/lib/halitosis/root_links/field.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootLinks
+    class Field < Halitosis::Links::Field
+    end
+  end
+end

data/lib/halitosis/root_links.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootLinks
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      # @return [Halitosis::RootLinks::Field]
+      #
+      def root_link(name, **options, &procedure)
+        fields.add(Field.new(name, options, procedure))
+      end
+    end
+
+    module InstanceMethods
+      # @return [Hash] the rendered hash with link, if any
+      #
+      def render(**)
+        super.tap do |result|
+          next unless options.fetch(:include_root) { true }
+
+          value = root_links
+          result[:_links] = result.fetch(:_links, {}).merge(value) if value.any?
+        end
+      end
+
+      # @return [Hash] link from fields
+      #
+      # @return [Hash] root_links from fields
+      #
+      def root_links(context = build_context)
+        render_fields(Field, context) do |field, result|
+          value = field.value(context)
+
+          result[field.name] = value if value
+        end
+      end
+    end
+  end
+end
+
+require "halitosis/root_links/field"

data/lib/halitosis/root_meta/field.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootMeta
+    class Field < Halitosis::Meta::Field
+    end
+  end
+end

data/lib/halitosis/root_meta.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootMeta
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      # @return [Halitosis::RootMeta::Field]
+      #
+      def root_meta(name, **options, &procedure)
+        fields.add(Field.new(name, options, procedure))
+      end
+    end
+
+    module InstanceMethods
+      # @return [Hash] the rendered hash with meta, if any
+      #
+      def render(**)
+        super.tap do |result|
+          next unless options.fetch(:include_root) { true }
+
+          value = root_meta
+          result[:_meta] = result.fetch(:_meta, {}).merge(value) if value.any?
+        end
+      end
+
+      # @return [Hash] meta from fields
+      #
+      def root_meta(context = build_context)
+        render_fields(Field, context) do |field, result|
+          value = field.value(context)
+
+          result[field.name] = value
+        end
+      end
+    end
+  end
+end
+
+require "halitosis/root_meta/field"

data/lib/halitosis/root_permissions/field.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootPermissions
+    class Field < Halitosis::Permissions::Field
+    end
+  end
+end

data/lib/halitosis/root_permissions.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module RootPermissions
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      # @return [Halitosis::RootPermission::Field]
+      #
+      def root_permission(name, **options, &procedure)
+        fields.add(Field.new(name, options, procedure))
+      end
+    end
+
+    module InstanceMethods
+      # @return [Hash] the rendered hash with permissions, if any
+      #
+      def render(**)
+        super.tap do |result|
+          value = root_permissions
+          result[:_permissions] = result.fetch(:_permissions, {}).merge(value) if value.any?
+        end
+      end
+
+      # @return [Hash] permissions from fields
+      #
+      def root_permissions(context = build_context)
+        render_fields(Field, context) do |field, result|
+          next unless options.fetch(:include_root) { true }
+
+          value = field.value(context)
+          result[field.name] = value || false
+        end
+      end
+    end
+  end
+end
+
+require "halitosis/root_permissions/field"

data/lib/halitosis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Halitosis
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/halitosis.rb

@@ -33,24 +33,31 @@ module Halitosis
     base.extend ClassMethods
 
     base.include Base
-    base.include Links
-    base.include Meta
-    base.include Permissions
     base.include Attributes
-    base.include Relationships
 
     config.extensions.each { |extension| base.send :include, extension }
   end
 
   module ClassMethods
     def resource(name)
+      include Identifiers
+      include Links
+      include Meta
+      include Permissions
+      include Relationships
       include Halitosis::Resource
+      include RootLinks
+      include RootMeta
+      include RootPermissions
 
       define_resource(name)
     end
 
     def collection(name, ...)
       include Halitosis::Collection
+      include RootLinks
+      include RootMeta
+      include RootPermissions
 
       define_collection(name, ...)
     end
@@ -79,10 +86,14 @@ require_relative "halitosis/errors"
 require_relative "halitosis/field"
 require_relative "halitosis/fields"
 require_relative "halitosis/attributes"
+require_relative "halitosis/identifiers"
 require_relative "halitosis/links"
 require_relative "halitosis/meta"
 require_relative "halitosis/permissions"
 require_relative "halitosis/relationships"
+require_relative "halitosis/root_links"
+require_relative "halitosis/root_meta"
+require_relative "halitosis/root_permissions"
 require_relative "halitosis/resource"
 require_relative "halitosis/collection"
 require_relative "halitosis/hash_util"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: halitosis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Morrall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies: []
 description: Provides an interface for serializing resources as JSON with HAL-like
   links and relationships.
@@ -37,6 +37,8 @@ files:
 - lib/halitosis/field.rb
 - lib/halitosis/fields.rb
 - lib/halitosis/hash_util.rb
+- lib/halitosis/identifiers.rb
+- lib/halitosis/identifiers/field.rb
 - lib/halitosis/links.rb
 - lib/halitosis/links/field.rb
 - lib/halitosis/meta.rb
@@ -47,6 +49,12 @@ files:
 - lib/halitosis/relationships.rb
 - lib/halitosis/relationships/field.rb
 - lib/halitosis/resource.rb
+- lib/halitosis/root_links.rb
+- lib/halitosis/root_links/field.rb
+- lib/halitosis/root_meta.rb
+- lib/halitosis/root_meta/field.rb
+- lib/halitosis/root_permissions.rb
+- lib/halitosis/root_permissions/field.rb
 - lib/halitosis/version.rb
 - sig/halitosis.rbs
 homepage: https://github.com/bmorrall/halitosis