Contents

module Vedeu

  module Editor

    # Manipulate the lines of an Vedeu::Editor::Document.
    #
    # @api private
    #
    class Insert

      include Vedeu::Common

      # @param (see #initialize)
      # @return (see #insert)
      def self.into(collection, entity, index = nil, size = 0)
        new(collection, entity, index, size).insert
      end

      # Returns a new instance of Vedeu::Editor::Insert.
      #
      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
      # @param entity [String]
      # @param index [Fixnum]
      # @param size [Fixnum]
      # @return [Vedeu::Editor::Insert]
      def initialize(collection, entity, index = nil, size = 0)
        @collection = collection
        @entity     = entity
        @index      = index
        @size       = size
      end

      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
      def insert
        return collection.insert(position, entity) if index?

        collection << entity
      end

      protected

      # @!attribute [r] collection
      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
      attr_reader :collection

      # @!attribute [r] entity
      # @return [String]
      attr_reader :entity

      # @!attribute [r] index
      # @return [Fixnum]
      attr_reader :index

      # @!attribute [r] size
      # @return [Fixnum]
      attr_reader :size

      private

      # @return [Boolean]
      def index?
        numeric?(index)
      end

      # @return [Fixnum]
      def position
        if index < 0
          0

        elsif index > size
          size

        else
          index

        end
      end

    end # Insert

  end # Editor

end # Vedeu

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.8.0	lib/vedeu/editor/insert.rb