Contents

# frozen_string_literal: true

require 'rom/files/constants'
require 'rom/files/types'

module ROM
  module Files
    module Plugins
      module Schema
        # A plugin for automatically adding contents of file
        # to the schema definition
        #
        # @example Generic `DATA` field with String type
        #   schema do
        #     use :contents
        #   end
        #
        # @example Specify another type
        #   schema do
        #     use :contents, type: Types::YAML
        #   end
        #
        # @example Specify another name
        #   # using other types
        #   schema do
        #     use :contents, name: :contents
        #   end
        #
        # @api public
        module Contents
          NAME = Files::DATA
          TYPE = Types::String

          # @api private
          def self.apply(schema, name: NAME, type: TYPE)
            contents = type.meta(name: name, source: schema.name, DATA: true)

            schema.attributes.concat(
              schema.class.attributes([contents], schema.attr_class)
            )
          end

          # @api private
          module DSL
            # Sets non-default contents attribute
            #
            # @example Set custom attribute name
            #   schema do
            #     use :contents
            #     contents :contents
            #   end
            #
            # @example Set custom type
            #   schema do
            #     use :contents
            #     contents type: Types::JSON
            #   end
            #
            # @api public
            def contents(name = NAME, inline_type = TYPE, type: inline_type)
              options = plugin_options(:contents)
              options[:name] = name
              options[:type] = type

              self
            end
          end
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rom-files-0.2.0	lib/rom/files/plugins/schema/contents.rb