Contents

module Dox
  module DSL
    class Resource
      include AttrProxy

      attr_writer :name
      attr_writer :group
      attr_writer :endpoint

      attr_writer :desc

      def initialize(name, &block)
        self.name = name

        instance_eval(&block)

        raise(Dox::Errors::InvalidResourceError, 'Resource name is required!') if @name.blank?
        raise(Dox::Errors::InvalidResourceError, 'Resource group is required!') if @group.blank?

        if Dox.config.check_file_presence_on_init
          raise(Dox::Errors::InvalidResourceError, "Resource desc #{@desc} is missing!") if desc_file_path.nil?
        end
      end

      def config
        {
          resource_name: @name.presence,
          resource_desc: @desc.presence,
          resource_group_name: @group.presence,
          apidoc: true
        }
      end

      private

      def desc_file_path
        return true if @desc.nil? || !@desc.end_with?('.md')

        Util::File.file_path(@desc).presence
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
dox-2.5.0	lib/dox/dsl/resource.rb