Contents

# frozen_string_literal: true

module Vedeu

  module Renderers

    # Provides shared functionality to Vedeu::Renderer classes.
    #
    module Options

      # :nocov:

      # @!attribute [w] options
      # @return [Hash<Symbol => void>]
      attr_writer :options

      # Returns a boolean indicating whether the content should be
      # compressed if compression is available.
      #
      # @return [Boolean]
      def compress?
        options[:compression] || Vedeu.config.compression? || false
      end

      private

      # Combines the options provided at instantiation with the
      # default values.
      #
      # @return [Hash<Symbol => void>]
      def options
        defaults.merge!(@options)
      end

      # The default values for a new instance of this class.
      #
      # @return [Hash<Symbol => void>]
      def defaults
        {}
      end

      # :nocov:

    end # Options

  end # Renderers

end # Vedeu

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.8.2	lib/vedeu/renderers/options.rb