halitosis 0.1.0

data/lib/halitosis/resource.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Halitosis
+  # Behavior for serializers with a single primary resource
+  #
+  module Resource
+    def self.included(base)
+      if base.included_modules.include?(Collection)
+        raise InvalidResource, "#{base.name} has already defined a collection"
+      end
+
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+
+      base.send :attr_reader, :resource
+
+      base.class.send :attr_accessor, :resource_name
+    end
+
+    module ClassMethods
+      # @param name [Symbol, String] name of the resource
+      #
+      # @return [Module] self
+      #
+      def define_resource(name)
+        self.resource_name = name.to_s
+
+        alias_method name, :resource
+      end
+
+      # Override standard property field for resource-based serializers
+      #
+      # @param name [Symbol, String] name of the property
+      # @param options [nil, Hash] property options for field
+      #
+      def property(name, options = {}, &procedure)
+        super.tap do |field|
+          unless field.procedure || field.options.key?(:value)
+            field.procedure = proc { resource.send(name) }
+          end
+        end
+      end
+    end
+
+    module InstanceMethods
+      # Override standard initializer to assign primary resource
+      #
+      # @param resource [Object] the primary resource
+      #
+      def initialize(resource, **)
+        @resource = resource
+
+        super(**)
+      end
+    end
+  end
+end

data/lib/halitosis/version.rb

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

data/lib/halitosis.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "halitosis/version"
+
+require "json"
+
+# HAL-like JSON generator
+#
+# Provides an interface for serializing resources as JSON
+# with HAL-like links and relationships.
+#
+# @example
+#   class ArticleSerializer
+#     include Halitosis
+#
+#     resource :article
+#
+#     property :id, required: true
+#
+#     property :title
+#
+#     link :self, -> { article_path(article) }
+#
+#     link :external, optional: true, -> { "http://example.com/read/#{article.id}" }
+#
+#     rel :author, -> { UserSerializer.new(article.author) }
+#     # or relatioinship :author, -> { UserSerializer.new(article.author) }
+#   end
+#
+#   render json: ArticleSerializer.new(article, include: :author, fields: :title)
+module Halitosis
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.include Base
+
+    config.extensions.each { |extension| base.send :include, extension }
+  end
+
+  module ClassMethods
+    def resource(name)
+      include Halitosis::Resource
+
+      define_resource(name)
+    end
+
+    def collection(name, ...)
+      include Halitosis::Collection
+
+      define_collection(name, ...)
+    end
+  end
+
+  class << self
+    # @yield [Halitosis::Configuration] configuration instance for modification
+    #
+    def configure
+      yield config
+    end
+
+    # Configuration instance
+    #
+    # @return [Halitosis::Configuration]
+    #
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end
+
+require_relative "halitosis/base"
+require_relative "halitosis/errors"
+require_relative "halitosis/field"
+require_relative "halitosis/fields"
+require_relative "halitosis/properties"
+require_relative "halitosis/links"
+require_relative "halitosis/meta"
+require_relative "halitosis/permissions"
+require_relative "halitosis/relationships"
+require_relative "halitosis/resource"
+require_relative "halitosis/collection"
+require_relative "halitosis/hash_util"
+require_relative "halitosis/configuration"
+
+require "halitosis/railtie" if defined?(::Rails)

data/sig/halitosis.rbs

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: halitosis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Morrall
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-30 00:00:00.000000000 Z
+dependencies: []
+description: Provides an interface for serializing resources as JSON with HAL-like
+  links and relationships.
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/halitosis.rb
+- lib/halitosis/base.rb
+- lib/halitosis/collection.rb
+- lib/halitosis/collection/field.rb
+- lib/halitosis/configuration.rb
+- lib/halitosis/errors.rb
+- lib/halitosis/field.rb
+- lib/halitosis/fields.rb
+- lib/halitosis/hash_util.rb
+- lib/halitosis/links.rb
+- lib/halitosis/links/field.rb
+- lib/halitosis/meta.rb
+- lib/halitosis/meta/field.rb
+- lib/halitosis/permissions.rb
+- lib/halitosis/permissions/field.rb
+- lib/halitosis/properties.rb
+- lib/halitosis/properties/field.rb
+- lib/halitosis/railtie.rb
+- lib/halitosis/relationships.rb
+- lib/halitosis/relationships/field.rb
+- lib/halitosis/resource.rb
+- lib/halitosis/version.rb
+- sig/halitosis.rbs
+homepage: https://github.com/bmorrall/halitosis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bmorrall/halitosis
+  source_code_uri: https://github.com/bmorrall/halitosis
+  changelog_uri: https://github.com/bmorrall/halitosis/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: HAL-like API client for Ruby
+test_files: []