Contents

module Vedeu

  module Buffers

    # Refreshes the given named interface.
    #
    class Refresh

      include Vedeu::Common

      # @example
      #   Vedeu.trigger(:_refresh_view_, name)
      #
      # @param (see #initialize)
      # @return (see #by_name)
      def self.by_name(name)
        new(name).by_name
      end

      # @example
      #   Vedeu.trigger(:_refresh_view_content_, name)
      #
      # @param (see #initialize)
      # @return (see #by_name)
      def self.refresh_content_by_name(name)
        new(name, content_only: true).by_name
      end

      # Return a new instance of Vedeu::Buffers::Refresh.
      #
      # @param name [String|Symbol] The name of the interface to be refreshed
      #   using the named buffer.
      # @param options [Hash]
      # @option options content_only [Boolean]
      # @return [Vedeu::Buffers::Refresh]
      def initialize(name, options = {})
        @name    = name
        @options = options
      end

      # @return [Array|Vedeu::Error::ModelNotFound]
      def by_name
        Vedeu.timer("Refresh Buffer: '#{name}'") do
          Vedeu.buffers.by_name(name).render
          Vedeu.borders.by_name(name).render unless content_only?
        end if Vedeu.ready?
      end

      protected

      # @!attribute [r] name
      # @return [String|Symbol]
      attr_reader :name

      # @return [Boolean]
      def content_only?
        options[:content_only] == true
      end

      # @return [Hash<Symbol => Boolean>]
      def options
        defaults.merge!(@options)
      end

      # @return [Hash<Symbol => Boolean>]
      def defaults
        {
          content_only: false,
        }
      end

    end # Refresh

  end # Buffers

end # Vedeu

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.6.22	lib/vedeu/buffers/refresh.rb