vedeu 0.8.16 → 0.8.17

data/lib/vedeu/geometries/geometry.rb

@@ -57,7 +57,7 @@ module Vedeu
       alias maximised? maximised
 
       # @!attribute [rw] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_accessor :name
 
       # @!attribute [rw] vertical_alignment

data/lib/vedeu/geometries/move.rb

@@ -53,7 +53,7 @@ module Vedeu
       attr_reader :direction
 
       # @!attribute [r] name
-      # @return [String|Symbol] The name of the interface/view.
+      # @macro return_name
       attr_reader :name
 
       # @!attribute [r] offset
@@ -97,7 +97,7 @@ module Vedeu
         }[direction]
       end
 
-      # @return [Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
@@ -207,40 +207,4 @@ module Vedeu
 
   end # Geometries
 
-  # :nocov:
-
-  # {include:file:docs/events/by_name/movement_refresh.md}
-  Vedeu.bind(:_movement_refresh_) do |name|
-    Vedeu.trigger(:_clear_)
-    Vedeu.trigger(:_refresh_)
-    Vedeu.trigger(:_clear_view_, name)
-    Vedeu.trigger(:_refresh_view_, name)
-  end
-
-  # {include:file:docs/events/by_name/view_down.md}
-  Vedeu.bind(:_view_down_) do |name, offset|
-    Vedeu::Geometries::Move.move(name: name, offset: offset, direction: :down)
-  end
-
-  # {include:file:docs/events/by_name/view_left.md}
-  Vedeu.bind(:_view_left_) do |name, offset|
-    Vedeu::Geometries::Move.move(name: name, offset: offset, direction: :left)
-  end
-
-  # {include:file:docs/events/by_name/view_right.md}
-  Vedeu.bind(:_view_right_) do |name, offset|
-    Vedeu::Geometries::Move.move(name: name, offset: offset, direction: :right)
-  end
-
-  # {include:file:docs/events/by_name/view_up.md}
-  Vedeu.bind(:_view_up_) do |name, offset|
-    Vedeu::Geometries::Move.move(name: name, offset: offset, direction: :up)
-  end
-
-  [:down, :left, :right, :up].each do |direction|
-    Vedeu.bind_alias(:"_geometry_#{direction}_", :"_view_#{direction}_")
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/geometries/repository.rb

@@ -29,18 +29,4 @@ module Vedeu
   def_delegators Vedeu::Geometries::Repository,
                  :geometries
 
-  # :nocov:
-
-  # See {file:docs/events/view.md#\_maximise_}
-  Vedeu.bind(:_maximise_) do |name|
-    Vedeu.geometries.by_name(name).maximise
-  end
-
-  # See {file:docs/events/view.md#\_unmaximise_}
-  Vedeu.bind(:_unmaximise_) do |name|
-    Vedeu.geometries.by_name(name).unmaximise
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/groups/all.rb

@@ -9,6 +9,29 @@ module Vedeu
 
   end # Groups
 
+  # :nocov:
+
+  # See {file:docs/events/visibility.md#\_clear_group_}
+  Vedeu.bind(:_clear_group_) do |name|
+    Vedeu.clear_by_group(name) if Vedeu.ready?
+  end
+
+  # See {file:docs/events/visibility.md#\_hide_group_}
+  Vedeu.bind(:_hide_group_) { |name| Vedeu.hide_group(name) }
+
+  # See {file:docs/events/refresh.md}
+  Vedeu.bind(:_refresh_group_) do |name|
+    Vedeu::Groups::Refresh.by_name(name) if Vedeu.ready?
+  end
+
+  # See {file:docs/events/visibility.md#\_show_group_}
+  Vedeu.bind(:_show_group_) { |name| Vedeu.show_group(name) }
+
+  # See {file:docs/events/visibility.md#\_toggle_group_}
+  Vedeu.bind(:_toggle_group_) { |name| Vedeu.toggle_group(name) }
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/groups/clear'

data/lib/vedeu/groups/clear.rb

@@ -37,7 +37,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
@@ -62,13 +62,4 @@ module Vedeu
   def_delegators Vedeu::Groups::Clear,
                  :clear_by_group
 
-  # :nocov:
-
-  # See {file:docs/events/visibility.md#\_clear_group_}
-  Vedeu.bind(:_clear_group_) do |name|
-    Vedeu.clear_by_group(name) if Vedeu.ready?
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/groups/group.rb

@@ -193,17 +193,5 @@ module Vedeu
                  :show_group,
                  :toggle_group
 
-  # :nocov:
-
-  # See {file:docs/events/visibility.md#\_hide_group_}
-  Vedeu.bind(:_hide_group_) { |name| Vedeu.hide_group(name) }
-
-  # See {file:docs/events/visibility.md#\_show_group_}
-  Vedeu.bind(:_show_group_) { |name| Vedeu.show_group(name) }
-
-  # See {file:docs/events/visibility.md#\_toggle_group_}
-  Vedeu.bind(:_toggle_group_) { |name| Vedeu.toggle_group(name) }
-
-  # :nocov:
 
 end # Vedeu

data/lib/vedeu/groups/refresh.rb

@@ -46,7 +46,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
@@ -66,7 +66,7 @@ module Vedeu
         @_group_name ||= interface.group
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface
         Vedeu.interfaces.by_name(name)
       end
@@ -75,13 +75,4 @@ module Vedeu
 
   end # Groups
 
-  # :nocov:
-
-  # See {file:docs/events/refresh.md}
-  Vedeu.bind(:_refresh_group_) do |name|
-    Vedeu::Groups::Refresh.by_name(name) if Vedeu.ready?
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/input/all.rb

@@ -9,6 +9,41 @@ module Vedeu
 
   end # Input
 
+  # :nocov:
+
+  # See {file:docs/events/system.md#\_keypress_}
+  Vedeu.bind(:_keypress_) do |key, name|
+    Vedeu.timer('Executing keypress') do
+      Vedeu.add_keypress(key)
+
+      Vedeu.keypress(key, name)
+    end
+  end
+
+  # See {file:docs/events/drb.md#\_drb_input_}
+  Vedeu.bind(:_drb_input_) do |data, type|
+    Vedeu.log(type: :drb, message: "Sending input (#{type})")
+
+    if type == :command
+      Vedeu.trigger(:_command_, data)
+
+    else
+      Vedeu.trigger(:_keypress_, data)
+
+    end
+  end
+
+  # See {file:docs/events/system.md#\_command_}
+  Vedeu.bind(:_command_) do |command|
+    Vedeu.timer('Executing command') do
+      Vedeu.add_command(command)
+
+      Vedeu.trigger(:command, command)
+    end
+  end
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/input/raw'

data/lib/vedeu/input/capture.rb

@@ -106,7 +106,7 @@ module Vedeu
         end
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface
         Vedeu.interfaces.by_name(name)
       end
@@ -135,7 +135,7 @@ module Vedeu
         console.gets.chomp
       end
 
-      # @return [String|Symbol]
+      # @macro return_name
       def name
         Vedeu.focus
       end

data/lib/vedeu/input/mapper.rb

@@ -172,39 +172,4 @@ module Vedeu
   def_delegators Vedeu::Input::Mapper,
                  :keypress
 
-  # :nocov:
-
-  # See {file:docs/events/system.md#\_keypress_}
-  Vedeu.bind(:_keypress_) do |key, name|
-    Vedeu.timer('Executing keypress') do
-      Vedeu.add_keypress(key)
-
-      Vedeu.keypress(key, name)
-    end
-  end
-
-  # See {file:docs/events/drb.md#\_drb_input_}
-  Vedeu.bind(:_drb_input_) do |data, type|
-    Vedeu.log(type: :drb, message: "Sending input (#{type})")
-
-    if type == :command
-      Vedeu.trigger(:_command_, data)
-
-    else
-      Vedeu.trigger(:_keypress_, data)
-
-    end
-  end
-
-  # See {file:docs/events/system.md#\_command_}
-  Vedeu.bind(:_command_) do |command|
-    Vedeu.timer('Executing command') do
-      Vedeu.add_command(command)
-
-      Vedeu.trigger(:command, command)
-    end
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/input/raw.rb

@@ -38,7 +38,7 @@ module Vedeu
 
       # @return [IO]
       def console
-        @console ||= Vedeu::Terminal.console
+        @_console ||= Vedeu::Terminal.console
       end
 
     end # Raw

data/lib/vedeu/input/read.rb

@@ -52,7 +52,7 @@ module Vedeu
 
       # @return [IO]
       def console
-        @console ||= Vedeu::Terminal.console
+        @_console ||= Vedeu::Terminal.console
       end
 
       # @return [Boolean]

data/lib/vedeu/interfaces/all.rb

@@ -7,6 +7,30 @@ module Vedeu
 
   end # Interfaces
 
+  # :nocov:
+
+  # See {file:docs/events/visibility.md#\_clear_view_}
+  Vedeu.bind(:_clear_view_) { |name| Vedeu.clear_by_name(name) if Vedeu.ready? }
+
+  # See {file:docs/events/visibility.md#\_clear_view_content_}
+  Vedeu.bind(:_clear_view_content_) do |name|
+    Vedeu.clear_content_by_name(name) if Vedeu.ready?
+  end
+
+  # 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
 
 require 'vedeu/interfaces/interface'

data/lib/vedeu/interfaces/clear.rb

@@ -67,19 +67,19 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
 
       # @return [String] A string of blank characters.
       def chars
-        @chars ||= (' ' * width)
+        @_chars ||= (' ' * width)
       end
 
       # @return [Vedeu::Colours::Colour]
       def colour
-        @colour ||= interface.colour
+        @_colour ||= interface.colour
       end
 
       # @return [Boolean]
@@ -100,25 +100,23 @@ module Vedeu
         options[:direct]
       end
 
-      # Returns the geometry for the interface.
-      #
-      # @return (see Vedeu::Geometries::Repository#by_name)
+      # @macro geometry_by_name
       def geometry
-        @geometry ||= Vedeu.geometries.by_name(name)
+        @_geometry ||= Vedeu.geometries.by_name(name)
       end
 
       # @return [Fixnum]
       def height
-        @height ||= if content_only?
-                      geometry.bordered_height
+        @_height ||= if content_only?
+                       geometry.bordered_height
 
-                    else
-                      geometry.height
+                     else
+                       geometry.height
 
-                    end
+                     end
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface
         Vedeu.interfaces.by_name(name)
       end
@@ -149,7 +147,7 @@ module Vedeu
       # @return [Array<Array<Vedeu::Cells::Char>>]
       def output
         Vedeu.timer("Clearing #{clearing}: '#{name}'") do
-          @clear ||= Array.new(height) do |iy|
+          @_clear ||= Array.new(height) do |iy|
             Array.new(width) do |ix|
               position = Vedeu::Geometries::Position.new((y + iy), (x + ix))
               Vedeu::Cells::Clear.new(colour:   colour,
@@ -162,13 +160,13 @@ module Vedeu
 
       # @return [String]
       def clearing
-        @clearing ||= if content_only?
-                        'content'
+        @_clearing ||= if content_only?
+                         'content'
 
-                      else
-                        'interface'
+                       else
+                         'interface'
 
-                      end
+                       end
       end
 
       # @param pos_y [Fixnum]
@@ -181,35 +179,35 @@ module Vedeu
 
       # @return [Fixnum]
       def width
-        @width ||= if content_only?
-                     geometry.bordered_width
+        @_width ||= if content_only?
+                      geometry.bordered_width
 
-                   else
-                     geometry.width
+                    else
+                      geometry.width
 
-                   end
+                    end
       end
 
       # @return [Fixnum]
       def y
-        @y ||= if content_only?
-                 geometry.by
+        @_y ||= if content_only?
+                  geometry.by
 
-               else
-                 geometry.y
+                else
+                  geometry.y
 
-               end
+                end
       end
 
       # @return [Fixnum]
       def x
-        @x ||= if content_only?
-                 geometry.bx
+        @_x ||= if content_only?
+                  geometry.bx
 
-               else
-                 geometry.x
+                else
+                  geometry.x
 
-               end
+                end
       end
 
     end # Clear
@@ -226,16 +224,4 @@ module Vedeu
                  :clear_by_name,
                  :clear_content_by_name
 
-  # :nocov:
-
-  # See {file:docs/events/visibility.md#\_clear_view_}
-  Vedeu.bind(:_clear_view_) { |name| Vedeu.clear_by_name(name) if Vedeu.ready? }
-
-  # See {file:docs/events/visibility.md#\_clear_view_content_}
-  Vedeu.bind(:_clear_view_content_) do |name|
-    Vedeu.clear_content_by_name(name) if Vedeu.ready?
-  end
-
-  # :nocov:
-
 end # Vedeu