vedeu 0.8.10 → 0.8.12

data/docs/dsl_elements.md

@@ -1,100 +1,107 @@
-# view :name do
-#   lines do
-#     line 'view->lines->line', {}
-#
-#     line do
-#       streams do
-#         stream 'view->lines->line->streams->stream', {}
-#         stream do
-#           text 'view->lines->line->streams->stream->text', {}
-#         end
-#         text 'view->lines->line->streams->text', {}
-#       end
-#
-#       stream 'view->lines->line->stream', {}
-#
-#       stream do
-#         text 'view->lines->line->stream->text', {}
-#       end
-#
-#       text 'view->lines->line->text', {}
-#     end
-#
-#     streams do
-#       stream 'view->lines->streams->stream', {}
-#       stream do
-#         text 'view->lines->streams->stream->text', {}
-#       end
-#       text 'view->lines->streams->text', {}
-#     end
-#
-#     stream 'view->lines->stream', {}
-#     stream do
-#       text 'view->lines->stream->text', {}
-#     end
-#
-#     text 'view->lines->text', {}
-#   end
-#
-#   line 'view->line', {}
-#
-#   line do
-#     streams do
-#       stream 'view->line->streams->stream', {}
-#       stream do
-#         text 'view->line->streams->stream->text', {}
-#       end
-#       text 'view->line->streams->text', {}
-#     end
-#
-#     stream 'view->line->stream->stream', {}
-#     stream do
-#       text 'view->line->stream->text', {}
-#     end
-#
-#     text 'view->line->text', {}
-#   end
-#
-#   streams do
-#     stream 'view->streams->stream', {}
-#     stream do
-#       text 'view->streams->stream->text', {}
-#     end
-#     text 'view->streams->text', {}
-#   end
-#
-#   stream 'view->stream', {}
-#
-#   stream do
-#     text 'view->stream->text', {}
-#   end
-#
-#   text 'view->text', {}
-# end
-#
-# 'view->line'
-# 'view->line->stream->stream'
-# 'view->line->stream->text'
-# 'view->line->streams->stream'
-# 'view->line->streams->stream->text'
-# 'view->line->streams->text'
-# 'view->line->text'
-# 'view->lines->line'
-# 'view->lines->line->stream'
-# 'view->lines->line->stream->text'
-# 'view->lines->line->streams->stream'
-# 'view->lines->line->streams->stream->text'
-# 'view->lines->line->streams->text'
-# 'view->lines->line->text'
-# 'view->lines->stream'
-# 'view->lines->stream->text'
-# 'view->lines->streams->stream'
-# 'view->lines->streams->stream->text'
-# 'view->lines->streams->text'
-# 'view->lines->text'
-# 'view->stream'
-# 'view->stream->text'
-# 'view->streams->stream'
-# 'view->streams->stream->text'
-# 'view->streams->text'
-# 'view->text'
+# @title Vedeu View Templates
+# Vedeu View Templates
+
+More coming soon.
+
+```ruby
+  # view :name do
+  #   lines do
+  #     line 'view->lines->line', {}
+  #
+  #     line do
+  #       streams do
+  #         stream 'view->lines->line->streams->stream', {}
+  #         stream do
+  #           text 'view->lines->line->streams->stream->text', {}
+  #         end
+  #         text 'view->lines->line->streams->text', {}
+  #       end
+  #
+  #       stream 'view->lines->line->stream', {}
+  #
+  #       stream do
+  #         text 'view->lines->line->stream->text', {}
+  #       end
+  #
+  #       text 'view->lines->line->text', {}
+  #     end
+  #
+  #     streams do
+  #       stream 'view->lines->streams->stream', {}
+  #       stream do
+  #         text 'view->lines->streams->stream->text', {}
+  #       end
+  #       text 'view->lines->streams->text', {}
+  #     end
+  #
+  #     stream 'view->lines->stream', {}
+  #     stream do
+  #       text 'view->lines->stream->text', {}
+  #     end
+  #
+  #     text 'view->lines->text', {}
+  #   end
+  #
+  #   line 'view->line', {}
+  #
+  #   line do
+  #     streams do
+  #       stream 'view->line->streams->stream', {}
+  #       stream do
+  #         text 'view->line->streams->stream->text', {}
+  #       end
+  #       text 'view->line->streams->text', {}
+  #     end
+  #
+  #     stream 'view->line->stream->stream', {}
+  #     stream do
+  #       text 'view->line->stream->text', {}
+  #     end
+  #
+  #     text 'view->line->text', {}
+  #   end
+  #
+  #   streams do
+  #     stream 'view->streams->stream', {}
+  #     stream do
+  #       text 'view->streams->stream->text', {}
+  #     end
+  #     text 'view->streams->text', {}
+  #   end
+  #
+  #   stream 'view->stream', {}
+  #
+  #   stream do
+  #     text 'view->stream->text', {}
+  #   end
+  #
+  #   text 'view->text', {}
+  # end
+  #
+  # 'view->line'
+  # 'view->line->stream->stream'
+  # 'view->line->stream->text'
+  # 'view->line->streams->stream'
+  # 'view->line->streams->stream->text'
+  # 'view->line->streams->text'
+  # 'view->line->text'
+  # 'view->lines->line'
+  # 'view->lines->line->stream'
+  # 'view->lines->line->stream->text'
+  # 'view->lines->line->streams->stream'
+  # 'view->lines->line->streams->stream->text'
+  # 'view->lines->line->streams->text'
+  # 'view->lines->line->text'
+  # 'view->lines->stream'
+  # 'view->lines->stream->text'
+  # 'view->lines->streams->stream'
+  # 'view->lines->streams->stream->text'
+  # 'view->lines->streams->text'
+  # 'view->lines->text'
+  # 'view->stream'
+  # 'view->stream->text'
+  # 'view->streams->stream'
+  # 'view->streams->stream->text'
+  # 'view->streams->text'
+  # 'view->text'
+```

data/examples/dsl_alignment.rb

@@ -13,7 +13,7 @@ class AlignmentApp
     debug!
     log '/tmp/alignment.log'
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/alignment.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/alignment.out'))
     run_once!
     standalone!
   end

data/examples/dsl_colours.rb

@@ -13,7 +13,7 @@ class ColoursApp
     debug!
     log '/tmp/colours.log'
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/colours.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/colours.out'))
   end
 
   Vedeu.interface :interface_colours_view do

data/examples/dsl_editor.rb

@@ -13,7 +13,7 @@ class EditorApp
     debug!
     log '/tmp/editor.log'
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/editor.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/editor.out'))
     fake!
   end
 

data/examples/dsl_horizontal_alignment.rb

@@ -52,7 +52,7 @@ class HorizontalAlignmentApp
     debug!
     log '/tmp/vedeu_horizontal.log'
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/vedeu_horizontal.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/vedeu_horizontal.out'))
   end
 
   Vedeu.interface :left_interface do

data/examples/dsl_vertical_alignment.rb

@@ -52,7 +52,7 @@ class VerticalAlignmentApp
     debug!
     log '/tmp/vedeu_vertical.log'
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/vedeu_vertical.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/vedeu_vertical.out'))
   end
 
   Vedeu.interface :top_interface do

data/examples/views/misc_view.rb

@@ -13,7 +13,7 @@ class DSLApp
     run_once!
     standalone!
     renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::File.new(filename: '/tmp/misc_view.out'))
+              Vedeu::Renderers::Text.new(filename: '/tmp/misc_view.out'))
     height 40
   end
 

data/lib/vedeu/application/application_controller.rb

@@ -6,6 +6,8 @@ module Vedeu
   # application controllers. The client application's
   # ApplicationController will inherit from this class.
   #
+  # @api public
+  #
   class ApplicationController
 
     include Vedeu::Controller

data/lib/vedeu/application/application_view.rb

@@ -6,6 +6,8 @@ module Vedeu
   # The client application's ApplicationView will inherit from this
   # class.
   #
+  # @api public
+  #
   class ApplicationView
 
     include Vedeu::View

data/lib/vedeu/borders/dsl.rb

@@ -332,6 +332,7 @@ module Vedeu
 
   end # DSL
 
+  # @api public
   # @!method border
   #   @see Vedeu::Borders::DSL.border
   def_delegators Vedeu::Borders::DSL,

data/lib/vedeu/borders/repository.rb

@@ -19,6 +19,7 @@ module Vedeu
   end # Borders
 
   # {include:file:docs/dsl/by_method/borders.md}
+  # @api public
   # @!method borders
   # @return [Vedeu::Borders::Repository]
   def_delegators Vedeu::Borders::Repository,

data/lib/vedeu/buffers/empty.rb

@@ -8,6 +8,7 @@ module Vedeu
     # height and width.
     #
     # @api private
+    #
     class Empty
 
       include Vedeu::Repositories::Defaults

data/lib/vedeu/buffers/repository.rb

@@ -28,6 +28,7 @@ module Vedeu
   # @example
   #   Vedeu.buffers
   #
+  # @api public
   # @!method buffers
   # @return [Vedeu::Buffers::Repository]
   def_delegators Vedeu::Buffers::Repository,

data/lib/vedeu/buffers/terminal.rb

@@ -70,7 +70,7 @@ module Vedeu
       # @param value_or_values [Array<Array<Vedeu::Cells::Char>>]
       # @return [Array<Array<Vedeu::Cells::Char>>]
       def write(value_or_values)
-        buffer.update(value_or_values)
+        update(value_or_values)
 
         refresh
       end
@@ -90,8 +90,10 @@ module Vedeu
 
   end # Buffers
 
+  # @api public
   # @!method clear
   #   @see Vedeu::Buffers::Terminal#clear
+  # @api public
   # @!method refresh
   #   @see Vedeu::Buffers::Terminal#refresh
   def_delegators Vedeu::Buffers::Terminal,

data/lib/vedeu/cells/border.rb

@@ -29,11 +29,6 @@ module Vedeu
         }
       end
 
-      # @return [Boolean]
-      def cell?
-        false
-      end
-
       # @param value [String|Symbol]
       # @return [Vedeu::Cells::Border]
       def name=(value)

data/lib/vedeu/cells/char.rb

@@ -21,11 +21,6 @@ module Vedeu
         super
       end
 
-      # @return [Boolean]
-      def cell?
-        false
-      end
-
       # @return [String]
       def text
         @value || ' '

data/lib/vedeu/cells/clear.rb

@@ -14,11 +14,6 @@ module Vedeu
     #
     class Clear < Vedeu::Cells::Empty
 
-      # @return [Boolean]
-      def cell?
-        false
-      end
-
       # @return [Symbol]
       def type
         :clear

data/lib/vedeu/cells/cursor.rb

@@ -11,11 +11,6 @@ module Vedeu
     #
     class Cursor < Vedeu::Cells::Empty
 
-      # @return [Boolean]
-      def cell?
-        false
-      end
-
       # @return [NilClass]
       def null
         nil

data/lib/vedeu/cells/empty.rb

@@ -33,11 +33,6 @@ module Vedeu
         ' '
       end
 
-      # @return [Boolean]
-      def cell?
-        true
-      end
-
       # An object is equal when its values are the same.
       #
       # @param other [void]

data/lib/vedeu/cells/escape.rb

@@ -19,11 +19,6 @@ module Vedeu
     #
     class Escape < Vedeu::Cells::Empty
 
-      # @return [Boolean]
-      def cell?
-        false
-      end
-
       # @return [NilClass]
       def null
         nil

data/lib/vedeu/cells/support/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Cells

data/lib/vedeu/colours/backgrounds.rb

@@ -19,6 +19,7 @@ module Vedeu
 
   end # Colours
 
+  # @api public
   # @!method background_colours
   # @return [Vedeu::Colours::Backgrounds]
   def_delegators Vedeu::Colours::Backgrounds,

data/lib/vedeu/colours/foregrounds.rb

@@ -19,6 +19,7 @@ module Vedeu
 
   end # Colours
 
+  # @api public
   # @!method foreground_colours
   # @return [Vedeu::Colours::Foregrounds]
   def_delegators Vedeu::Colours::Foregrounds,

data/lib/vedeu/common.rb

@@ -17,15 +17,6 @@ module Vedeu
       !present?(variable)
     end
 
-    # Converts one class into another.
-    #
-    # @param klass [Class] The class to become an instance of.
-    # @param attributes [Hash] The attributes of klass.
-    # @return [Class] Returns a new instance of klass.
-    def become(klass, attributes)
-      klass.new(attributes)
-    end
-
     # Returns a boolean indicating the value was a boolean.
     #
     # @param value [void]

data/lib/vedeu/configuration/configuration.rb

@@ -406,14 +406,19 @@ module Vedeu
 
   end # Configuration
 
+  # @api public
   # @!method config
   #   @see Vedeu::Configuration.config
+  # @api public
   # @!method configure
   #   @see Vedeu::Configuration.configure
+  # @api public
   # @!method configuration
   #   @see Vedeu::Configuration.configuration
+  # @api public
   # @!method height
   #   @see Vedeu::Configuration.height
+  # @api public
   # @!method width
   #   @see Vedeu::Configuration.width
   def_delegators Vedeu::Configuration,

data/lib/vedeu/cursors/cursor.rb

@@ -266,10 +266,13 @@ module Vedeu
 
   end # Cursors
 
+  # @api public
   # @!method hide_cursor
   #   @see Vedeu::Toggleable::SingletonMethods.hide
+  # @api public
   # @!method show_cursor
   #   @see Vedeu::Toggleable::SingletonMethods#show
+  # @api public
   # @!method toggle_cursor
   #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Cursors::Cursor,

data/lib/vedeu/cursors/repository.rb

@@ -34,12 +34,14 @@ module Vedeu
   end # Cursors
 
   # {include:file:docs/dsl/by_method/cursors.md}
+  # @api public
   # @!method cursors
   #   @return [Vedeu::Cursors::Repository]
   def_delegators Vedeu::Cursors::Repository,
                  :cursors
 
   # {include:file:docs/dsl/by_method/cursor.md}
+  # @api public
   # @!method cursor
   #   @see Vedeu::Cursors::Repository.cursor
   def_delegators Vedeu::Cursors::Repository,

data/lib/vedeu/distributed/server.rb

@@ -238,12 +238,16 @@ module Vedeu
 
   end # Distributed
 
+  # @api public
   # @!method drb_restart
   #   @see Vedeu::Distributed::Server#restart
+  # @api public
   # @!method drb_start
   #   @see Vedeu::Distributed::Server#start
+  # @api public
   # @!method drb_status
   #   @see Vedeu::Distributed::Server#status
+  # @api public
   # @!method drb_stop
   #   @see Vedeu::Distributed::Server#stop
   def_delegators Vedeu::Distributed::Server,

data/lib/vedeu/dsl/helpers/attributes.rb

@@ -22,6 +22,9 @@ module Vedeu
         new(context, model, value, options, &block).attributes
       end
 
+      # @param context [NilClass]
+      # @param model [NilClass]
+      # @param value [NilClass|String]
       # @param options [Hash]
       # @option options align [Symbol] One of :center, :centre, :left,
       #   :none (default) or :right.
@@ -41,6 +44,7 @@ module Vedeu
       #   value.
       # @option options wordwrap [Boolean] Whether the value should be
       #   wordwrapped.
+      # @param block [Proc]
       # @return [Vedeu::DSL::Attributes]
       def initialize(context = nil,
                      model   = nil,

data/lib/vedeu/dsl/views.rb

@@ -142,10 +142,13 @@ module Vedeu
 
   end # DSL
 
+  # @api public
   # @!method render
   #   @see Vedeu::DSL::Views.render
+  # @api public
   # @!method renders
   #   @see Vedeu::DSL::Views.renders
+  # @api public
   # @!method views
   #   @see Vedeu::DSL::Views.views
   def_delegators Vedeu::DSL::Views,

data/lib/vedeu/editor/repository.rb

@@ -22,6 +22,7 @@ module Vedeu
   # @example
   #   Vedeu.documents
   #
+  # @api public
   # @!method documents
   # @return [Vedeu::Editor::Repository]
   def_delegators Vedeu::Editor::Repository,

data/lib/vedeu/esc/background.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Provides background colour related escape sequences.
     #
+    # @api public
+    # See {file:docs/dsl/by_method/esc.md}
     module Background
 
       extend self

data/lib/vedeu/esc/foreground.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Provides foreground colour related escape sequences.
     #
+    # @api public
+    # See {file:docs/dsl/by_method/esc.md}
     module Foreground
 
       extend self

data/lib/vedeu/events/aliases.rb

@@ -85,8 +85,10 @@ module Vedeu
 
   end # Events
 
+  # @api public
   # @!method bind_alias
   #   @see Vedeu::Events::Aliases#bind_alias
+  # @api public
   # @!method unbind_alias
   #   @see Vedeu::Events::Aliases#unbind_alias
   def_delegators Vedeu::Events::Aliases,

data/lib/vedeu/events/all.rb

@@ -10,7 +10,7 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/events/collection'
+require 'vedeu/events/events'
 require 'vedeu/events/aliases'
 require 'vedeu/events/trigger'
 require 'vedeu/events/repository'

data/lib/vedeu/events/event.rb

@@ -142,7 +142,7 @@ module Vedeu
                            repository.find(name).add(self)
 
                          else
-                           Vedeu::Events::Collection.new([self], nil, name)
+                           Vedeu::Events::Events.new([self], nil, name)
 
                          end
 
@@ -292,10 +292,13 @@ module Vedeu
 
   end # Events
 
+  # @api public
   # @!method bind
   #   @see Vedeu::Events::Event.bind
+  # @api public
   # @!method bound?
   #   @see Vedeu::Events::Event.bound?
+  # @api public
   # @!method unbind
   #   @see Vedeu::Events::Event.unbind
   def_delegators Vedeu::Events::Event,

data/lib/vedeu/events/{collection.rb → events.rb}

@@ -7,9 +7,10 @@ module Vedeu
     # A collection of {Vedeu::Events::Event} instances.
     #
     # @api private
-    class Collection < Vedeu::Repositories::Collection
+    #
+    class Events < Vedeu::Repositories::Collection
 
-    end # Collection
+    end # Events
 
   end # Events