vedeu 0.8.16 → 0.8.17

data/lib/vedeu/interfaces/interface.rb

@@ -183,20 +183,4 @@ module Vedeu
                  :show_interface,
                  :toggle_interface
 
-  # :nocov:
-
-  # See {file:docs/events/visibility.md#\_hide_interface_}
-  Vedeu.bind(:_hide_interface_) { |name| Vedeu.hide_interface(name) }
-  Vedeu.bind_alias(:_hide_view_, :_hide_interface_)
-
-  # See {file:docs/events/visibility.md#\_show_interface_}
-  Vedeu.bind(:_show_interface_) { |name| Vedeu.show_interface(name) }
-  Vedeu.bind_alias(:_show_view_, :_show_interface_)
-
-  # See {file:docs/events/visibility.md#\_toggle_interface_}
-  Vedeu.bind(:_toggle_interface_) { |name| Vedeu.toggle_interface(name) }
-  Vedeu.bind_alias(:_toggle_view_, :_toggle_interface_)
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/menus/all.rb

@@ -9,6 +9,50 @@ module Vedeu
 
   end # Menus
 
+  # :nocov:
+
+  # See {file:docs/events/menu.md#\_menu_bottom_}
+  Vedeu.bind(:_menu_bottom_) do |name|
+    Vedeu.menus.by_name(name).bottom_item
+  end
+
+  # See {file:docs/events/menu.md#\_menu_current_}
+  Vedeu.bind(:_menu_current_) do |name|
+    Vedeu.menus.by_name(name).current_item
+  end
+
+  # See {file:docs/events/menu.md#\_menu_deselect_}
+  Vedeu.bind(:_menu_deselect_) do |name|
+    Vedeu.menus.by_name(name).deselect_item
+  end
+
+  # See {file:docs/events/menu.md#\_menu_items_}
+  Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.by_name(name).items }
+
+  # See {file:docs/events/menu.md#\_menu_next_}
+  Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.by_name(name).next_item }
+
+  # See {file:docs/events/menu.md#\_menu_prev_}
+  Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.by_name(name).prev_item }
+
+  # See {file:docs/events/menu.md#\_menu_selected_}
+  Vedeu.bind(:_menu_selected_) do |name|
+    Vedeu.menus.by_name(name).selected_item
+  end
+
+  # See {file:docs/events/menu.md#\_menu_select_}
+  Vedeu.bind(:_menu_select_) do |name|
+    Vedeu.menus.by_name(name).select_item
+  end
+
+  # See {file:docs/events/menu.md#\_menu_top_}
+  Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.by_name(name).top_item }
+
+  # See {file:docs/events/menu.md#\_menu_view_}
+  Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/menus/dsl'

data/lib/vedeu/menus/menu.rb

@@ -11,9 +11,9 @@ module Vedeu
 
       include Vedeu::Repositories::Model
 
-      # @!attribute [rw] collection
+      # @!attribute [w] collection
       # @return [Array]
-      attr_accessor :collection
+      attr_writer :collection
 
       # Returns the index of the value in the collection which is
       # current.
@@ -50,12 +50,17 @@ module Vedeu
         end
       end
 
+      # @return [Array]
+      def collection
+        @collection || []
+      end
+
       # Returns the item from the collection which shares the same
       # index as the value of {Vedeu::Menus::Menu#current}.
       #
       # @return [void]
       def current_item
-        @collection[@current]
+        collection[@current]
       end
 
       # Returns a DSL instance responsible for defining the DSL
@@ -77,7 +82,7 @@ module Vedeu
       def selected_item
         return nil unless @selected
 
-        @collection[@selected]
+        collection[@selected]
       end
 
       # Returns a new collection of items.
@@ -94,7 +99,7 @@ module Vedeu
       # @return [Array]
       def items
         items = []
-        @collection.each_with_index do |item, index|
+        collection.each_with_index do |item, index|
           items << if index == @current && index == @selected
                      [true, true, item]
 
@@ -116,7 +121,7 @@ module Vedeu
       #
       # @return [Array]
       def view
-        items[@current, @collection.size]
+        items[@current, collection.size]
       end
 
       # Sets the value of current to be the first item of the
@@ -183,14 +188,14 @@ module Vedeu
       #
       # @return [Fixnum]
       def last
-        @collection.size - 1
+        collection.size - 1
       end
 
       # Returns the size of the collection.
       #
       # @return [Fixnum]
       def size
-        @collection.size
+        collection.size
       end
 
       private

data/lib/vedeu/menus/repository.rb

@@ -28,48 +28,4 @@ module Vedeu
   def_delegators Vedeu::Menus::Repository,
                  :menus
 
-  # :nocov:
-
-  # See {file:docs/events/menu.md#\_menu_bottom_}
-  Vedeu.bind(:_menu_bottom_) do |name|
-    Vedeu.menus.by_name(name).bottom_item
-  end
-
-  # See {file:docs/events/menu.md#\_menu_current_}
-  Vedeu.bind(:_menu_current_) do |name|
-    Vedeu.menus.by_name(name).current_item
-  end
-
-  # See {file:docs/events/menu.md#\_menu_deselect_}
-  Vedeu.bind(:_menu_deselect_) do |name|
-    Vedeu.menus.by_name(name).deselect_item
-  end
-
-  # See {file:docs/events/menu.md#\_menu_items_}
-  Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.by_name(name).items }
-
-  # See {file:docs/events/menu.md#\_menu_next_}
-  Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.by_name(name).next_item }
-
-  # See {file:docs/events/menu.md#\_menu_prev_}
-  Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.by_name(name).prev_item }
-
-  # See {file:docs/events/menu.md#\_menu_selected_}
-  Vedeu.bind(:_menu_selected_) do |name|
-    Vedeu.menus.by_name(name).selected_item
-  end
-
-  # See {file:docs/events/menu.md#\_menu_select_}
-  Vedeu.bind(:_menu_select_) do |name|
-    Vedeu.menus.by_name(name).select_item
-  end
-
-  # See {file:docs/events/menu.md#\_menu_top_}
-  Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.by_name(name).top_item }
-
-  # See {file:docs/events/menu.md#\_menu_view_}
-  Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/models/all.rb

@@ -8,6 +8,19 @@ module Vedeu
 
   end # Models
 
+  # :nocov:
+
+  # See {file:docs/events/focus.md#\_focus_by_name_}
+  Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
+
+  # See {file:docs/events/focus.md#\_focus_next_}
+  Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
+
+  # See {file:docs/events/focus.md#\_focus_prev_}
+  Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/models/toggleable'

data/lib/vedeu/models/focus.rb

@@ -271,17 +271,4 @@ module Vedeu
                  :focus_next,
                  :focus_previous
 
-  # :nocov:
-
-  # See {file:docs/events/focus.md#\_focus_by_name_}
-  Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
-
-  # See {file:docs/events/focus.md#\_focus_next_}
-  Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
-
-  # See {file:docs/events/focus.md#\_focus_prev_}
-  Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/models/toggleable.rb

@@ -138,7 +138,7 @@ module Vedeu
       end
 
       # @macro param_name
-      # @return [Vedeu::Buffers::Buffer]
+      # @macro buffer_by_name
       def buffer(name)
         Vedeu.buffers.by_name(name)
       end

data/lib/vedeu/null/generic.rb

@@ -13,7 +13,7 @@ module Vedeu
       attr_reader :attributes
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       # Returns a new instance of the Vedeu::Null::Generic class.

data/lib/vedeu/output/all.rb

@@ -9,6 +9,13 @@ module Vedeu
 
   end # Output
 
+  # :nocov:
+
+  # See {file:docs/events/refresh.md}
+  Vedeu.bind(:_refresh_) { Vedeu::Output::Refresh.all if Vedeu.ready? }
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/output/compressors/all'

data/lib/vedeu/output/compressor.rb

@@ -24,7 +24,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Output::Compressor.
       #
-      # @param output [Array<Array<Vedeu::Cells::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @param options [Hash]
       # @option options compression [Boolean]
       # @return [Vedeu::Output::Compressor]
@@ -41,6 +41,10 @@ module Vedeu
       def render
         return [] unless output?
 
+        Vedeu.log(type:    :compress,
+                  message: "Original size: #{original_size} / " \
+                           "New size: #{content_size}")
+
         Vedeu::Output::CompressorCache.cache(content, compression?)
       end
 
@@ -57,17 +61,18 @@ module Vedeu
       #
       # @return [Array]
       def content
-        output.content.reject do |cell|
+        @_content ||= output.content.reject do |cell|
           cell.class == Vedeu::Cells::Empty
-        end.tap do |cells|
-          Vedeu.log(type:    :compress,
-                    message: "Orignal size: #{content_size} / " \
-                             "New size: #{cells.size}")
         end
       end
 
       # @return [Fixnum]
       def content_size
+        content.size
+      end
+
+      # @return [Fixnum]
+      def original_size
         output.content.size
       end
 

data/lib/vedeu/output/compressors/character.rb

@@ -60,6 +60,8 @@ module Vedeu
         # @return [void]
         attr_reader :content
 
+        private
+
         # Compress by not repeatedly sending the same colours for each
         # character which has the same colours as the last character
         # output.

data/lib/vedeu/output/refresh.rb

@@ -32,11 +32,4 @@ module Vedeu
 
   end # Output
 
-  # :nocov:
-
-  # See {file:docs/events/refresh.md}
-  Vedeu.bind(:_refresh_) { Vedeu::Output::Refresh.all if Vedeu.ready? }
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/output/viewport.rb

@@ -97,15 +97,12 @@ module Vedeu
         offset - dimension
       end
 
-      # @return [Vedeu::Cursors::Cursor]
-      # @see Vedeu::Cursors::Repository#by_name
+      # @macro cursor_by_name
       def cursor
         Vedeu.cursors.by_name(name)
       end
 
-      # Returns the geometry for the interface.
-      #
-      # @return (see Vedeu::Geometries::Repository#by_name)
+      # @macro geometry_by_name
       def geometry
         Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/plugins/plugin.rb

@@ -7,7 +7,7 @@ module Vedeu
   class Plugin
 
     # @!attribute [r] name
-    # @return [String|Symbol]
+    # @macro return_name
     attr_reader :name
 
     # @!attribute [r] gem

data/lib/vedeu/presentation/colour.rb

@@ -118,9 +118,14 @@ module Vedeu
 
       private
 
+      # @macro interface_by_name
+      def interface
+        Vedeu.interfaces.by_name(name)
+      end
+
       # @return [Vedeu::Colours::Colour]
       def named_colour
-        Vedeu.interfaces.by_name(name).colour
+        interface.colour
       end
 
       # @return [Boolean]

data/lib/vedeu/renderers/all.rb

@@ -86,7 +86,7 @@ module Vedeu
 
     # @return [Mutex]
     def mutex
-      @mutex ||= Mutex.new
+      @_mutex ||= Mutex.new
     end
 
     # @param block [Proc]

data/lib/vedeu/repositories/repositories.rb

@@ -65,7 +65,7 @@ module Vedeu
     #
     # @return [Array]
     def storage
-      @storage ||= Set.new
+      @_storage ||= Set.new
     end
 
   end # Repositories

data/lib/vedeu/runtime/all.rb

@@ -8,6 +8,34 @@ module Vedeu
 
   end # Runtime
 
+  # :nocov:
+
+  # See {file:docs/events/system.md#\_cleanup_}
+  Vedeu.bind(:_cleanup_) do
+    Vedeu.trigger(:_drb_stop_)
+    Vedeu.trigger(:cleanup)
+  end
+
+  # See {file:docs/events/system.md#\_exit_}
+  Vedeu.bind(:_exit_) { Vedeu.exit }
+
+  # See {file:docs/events/application.md#\_goto_}
+  Vedeu.bind(:_goto_) do |controller, action, **args|
+    Vedeu::Runtime::Router.goto(controller, action, **args)
+  end
+
+  # Vedeu.bind_alias(:_action_, :_goto_)
+
+  # See {file:docs/events/system.md#\_initialize_}
+  Vedeu.bind(:_initialize_) { Vedeu.ready! }
+
+  # See {file:docs/events/system.md#\_mode_switch_}
+  Vedeu.bind(:_mode_switch_) do |mode|
+    Vedeu::Runtime::MainLoop.mode_switch!(mode)
+  end
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/runtime/traps'

data/lib/vedeu/runtime/application.rb

@@ -144,22 +144,4 @@ module Vedeu
   def_delegators Vedeu::Runtime::Application,
                  :exit
 
-  # :nocov:
-
-  # See {file:docs/events/system.md#\_exit_}
-  Vedeu.bind(:_exit_) { Vedeu.exit }
-
-  # See {file:docs/events/system.md#\_mode_switch_}
-  Vedeu.bind(:_mode_switch_) do |mode|
-    Vedeu::Runtime::MainLoop.mode_switch!(mode)
-  end
-
-  # See {file:docs/events/system.md#\_cleanup_}
-  Vedeu.bind(:_cleanup_) do
-    Vedeu.trigger(:_drb_stop_)
-    Vedeu.trigger(:cleanup)
-  end
-
-  # :nocov:
-
 end # Vedeu