vedeu 0.8.16 → 0.8.17

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

@@ -86,7 +86,7 @@ module Vedeu
         }
       end
 
-      # @return [NilClass|Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(options[:name])
       end

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

@@ -132,7 +132,7 @@ module Vedeu
         }
       end
 
-      # @return [NilClass|Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)
       end

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

@@ -59,7 +59,7 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(options[:name])
       end

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

@@ -166,7 +166,7 @@ module Vedeu
       # geometry is registered with this name, the width of the
       # geometry is used if the :width option was not given.
       #
-      # @return [String|Symbol]
+      # @macro return_name
       def name
         options[:name]
       end

data/lib/vedeu/dsl/view.rb

@@ -131,7 +131,7 @@ module Vedeu
         interface(name).attributes
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface(name)
         Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/dsl/views.rb

@@ -102,7 +102,7 @@ module Vedeu
         def renders(&block)
           raise Vedeu::Error::RequiresBlock unless block_given?
 
-          composition(eval('self', block.binding), true, &block)
+          composition(true, &block)
         end
         alias render renders
 
@@ -115,23 +115,39 @@ module Vedeu
         def views(&block)
           raise Vedeu::Error::RequiresBlock unless block_given?
 
-          composition(eval('self', block.binding), false, &block)
+          composition(false, &block)
         end
 
         private
 
+        # @param block [Proc] The directives you wish to send to
+        #   render. Typically includes `view` with associated
+        #   sub-directives. The binding of the block is also accessed
+        #   so that we can ascertain the calling client application
+        #   class, this is so that if there methods being called
+        #   inside your views, Vedeu will redirect that call to the
+        #   client class instance instead. (This actually occurs
+        #   when Vedeu rescues from method_missing. See {Vedeu::DSL}.)
+        def client_binding(&block)
+          eval('self', block.binding).tap do |client|
+            Vedeu.log(type:    :debug,
+                      message: "Client binding: #{client.class.name}")
+          end
+        end
+
         # Creates a new Vedeu::Views::Composition which may contain
         # one or more view {Vedeu::Views::View} objects.
         #
-        # @param client [Object] The client class which called the DSL
-        #   object.
         # @param refresh [Boolean]
         # @param block [Proc] The directives you wish to send to
         #   render. Typically includes `view` with associated
         #   sub-directives.
         # # @return [Vedeu::Views::Composition]
-        def composition(client, refresh = false, &block)
-          attrs = { client: client, colour: Vedeu.config.colour }
+        def composition(refresh = false, &block)
+          attrs = {
+            client: client_binding(&block),
+            colour: Vedeu.config.colour,
+          }
 
           Vedeu::Views::Composition.build(attrs, &block).update_buffers(refresh)
         end

data/lib/vedeu/editor/all.rb

@@ -8,6 +8,60 @@ module Vedeu
 
   end # Editor
 
+  # :nocov:
+
+  # See {file:docs/events/system.md#\_editor_}
+  Vedeu.bind(:_editor_) do |key|
+    Vedeu.timer('Executing editor keypress') do
+      Vedeu.trigger(:key, key)
+
+      Vedeu::Editor::Editor.keypress(name: Vedeu.focus, input: key)
+    end
+  end
+
+  # See {file:docs/events/document.md#\_editor_execute_}
+  Vedeu.bind(:_editor_execute_) do |name|
+    Vedeu.documents.by_name(name).execute
+  end
+
+  # See {file:docs/events/document.md#\_editor_delete_character_}
+  Vedeu.bind(:_editor_delete_character_) do |name|
+    Vedeu.documents.by_name(name).delete_character
+  end
+
+  # See {file:docs/events/document.md#\_editor_delete_line_}
+  Vedeu.bind(:_editor_delete_line_) do |name|
+    Vedeu.documents.by_name(name).delete_line
+  end
+
+  # See {file:docs/events/document.md#\_editor_down_}
+  Vedeu.bind(:_editor_down_) do |name|
+    Vedeu.documents.by_name(name).down
+  end
+
+  # See {file:docs/events/document.md#\_editor_insert_character_}
+  Vedeu.bind(:_editor_insert_character_) do |name, character|
+    Vedeu.documents.by_name(name).insert_character(character)
+  end
+
+  # See {file:docs/events/document.md#\_editor_insert_line_}
+  Vedeu.bind(:_editor_insert_line_) do |name|
+    Vedeu.documents.by_name(name).insert_line
+  end
+
+  # See {file:docs/events/document.md#\_editor_left_}
+  Vedeu.bind(:_editor_left_) { |name| Vedeu.documents.by_name(name).left }
+
+  # See {file:docs/events/document.md#\_editor_right_}
+  Vedeu.bind(:_editor_right_) do |name|
+    Vedeu.documents.by_name(name).right
+  end
+
+  # See {file:docs/events/document.md#\_editor_up_}
+  Vedeu.bind(:_editor_up_) { |name| Vedeu.documents.by_name(name).up }
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/editor/collection'

data/lib/vedeu/editor/cropper.rb

@@ -63,7 +63,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       # @!attribute [r] ox
@@ -100,11 +100,9 @@ module Vedeu
         line[ox...(ox + bordered_width)] || ''
       end
 
-      # Returns the border 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
 
     end # Editor

data/lib/vedeu/editor/cursor.rb

@@ -20,7 +20,7 @@ module Vedeu
                      :byn
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       # @!attribute [rw] ox
@@ -165,9 +165,7 @@ module Vedeu
 
       private
 
-      # 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)
       end

data/lib/vedeu/editor/document.rb

@@ -30,7 +30,7 @@ module Vedeu
       attr_accessor :data
 
       # @!attribute [rw] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_accessor :name
 
       # Returns the document as a string with line breaks if there is

data/lib/vedeu/editor/editor.rb

@@ -72,14 +72,12 @@ module Vedeu
       attr_reader :input
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
 
-      # Return the document by name from the documents repository.
-      #
-      # @return [Vedeu::Editor::Document]
+      # @macro document_by_name
       def document
         @document ||= Vedeu.documents.by_name(name)
       end
@@ -88,17 +86,4 @@ module Vedeu
 
   end # Editor
 
-  # :nocov:
-
-  # See {file:docs/events/system.md#\_editor_}
-  Vedeu.bind(:_editor_) do |key|
-    Vedeu.timer('Executing editor keypress') do
-      Vedeu.trigger(:key, key)
-
-      Vedeu::Editor::Editor.keypress(name: Vedeu.focus, input: key)
-    end
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/editor/repository.rb

@@ -28,49 +28,4 @@ module Vedeu
   def_delegators Vedeu::Editor::Repository,
                  :documents
 
-  # :nocov:
-
-  # See {file:docs/events/document.md#\_editor_execute_}
-  Vedeu.bind(:_editor_execute_) do |name|
-    Vedeu.documents.by_name(name).execute
-  end
-
-  # See {file:docs/events/document.md#\_editor_delete_character_}
-  Vedeu.bind(:_editor_delete_character_) do |name|
-    Vedeu.documents.by_name(name).delete_character
-  end
-
-  # See {file:docs/events/document.md#\_editor_delete_line_}
-  Vedeu.bind(:_editor_delete_line_) do |name|
-    Vedeu.documents.by_name(name).delete_line
-  end
-
-  # See {file:docs/events/document.md#\_editor_down_}
-  Vedeu.bind(:_editor_down_) do |name|
-    Vedeu.documents.by_name(name).down
-  end
-
-  # See {file:docs/events/document.md#\_editor_insert_character_}
-  Vedeu.bind(:_editor_insert_character_) do |name, character|
-    Vedeu.documents.by_name(name).insert_character(character)
-  end
-
-  # See {file:docs/events/document.md#\_editor_insert_line_}
-  Vedeu.bind(:_editor_insert_line_) do |name|
-    Vedeu.documents.by_name(name).insert_line
-  end
-
-  # See {file:docs/events/document.md#\_editor_left_}
-  Vedeu.bind(:_editor_left_) { |name| Vedeu.documents.by_name(name).left }
-
-  # See {file:docs/events/document.md#\_editor_right_}
-  Vedeu.bind(:_editor_right_) do |name|
-    Vedeu.documents.by_name(name).right
-  end
-
-  # See {file:docs/events/document.md#\_editor_up_}
-  Vedeu.bind(:_editor_up_) { |name| Vedeu.documents.by_name(name).up }
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/events/event.rb

@@ -170,7 +170,7 @@ module Vedeu
       attr_reader :closure
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private

data/lib/vedeu/geometries/all.rb

@@ -13,11 +13,56 @@ module Vedeu
 
   end # Geometries
 
+  # :nocov:
+
+  # See {file:docs/events/view.md#\_maximise_}
+  Vedeu.bind(:_maximise_) do |name|
+    Vedeu.geometries.by_name(name).maximise
+  end
+
+  # {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
+
+  # See {file:docs/events/view.md#\_unmaximise_}
+  Vedeu.bind(:_unmaximise_) do |name|
+    Vedeu.geometries.by_name(name).unmaximise
+  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
 
 require 'vedeu/geometries/area/all'
 require 'vedeu/geometries/dsl/all'
-
 require 'vedeu/geometries/geometry'
 require 'vedeu/geometries/move'
 require 'vedeu/geometries/position'

data/lib/vedeu/geometries/area/area.rb

@@ -281,12 +281,12 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
 
-      # @return [Vedeu::Borders::Border]
+      # @macro border_by_name
       def border
         @_border ||= Vedeu.borders.by_name(name)
       end

data/lib/vedeu/geometries/dsl/grid.rb

@@ -33,50 +33,46 @@ module Vedeu
         @value = value
       end
 
-      # @macro raise_out_of_range
       # @see Vedeu::Geometries::DSL#columns
       def columns
-        raise Vedeu::Error::OutOfRange if out_of_range?
-
         column * value
       end
 
-      # @macro raise_out_of_range
       # @see Vedeu::Geometries::DSL#rows
       def rows
-        raise Vedeu::Error::OutOfRange if out_of_range?
-
         row * value
       end
 
-      protected
-
-      # @!attribute [r] value
-      # @return [Fixnum]
-      attr_reader :value
-
       private
 
-      # Returns the height of a single row in characters.
+      # Returns the width of a single column in characters.
       #
       # @return [Fixnum]
-      def row
-        Vedeu.height / 12
+      def column
+        Vedeu.width / 12
       end
 
       # Returns a boolean indicating whether the value is out of
       # range.
       #
       # @return [Boolean]
-      def out_of_range?
-        value < 1 || value > 12
+      def out_of_range?(v)
+        v < 1 || v > 12
       end
 
-      # Returns the width of a single column in characters.
+      # Returns the height of a single row in characters.
       #
       # @return [Fixnum]
-      def column
-        Vedeu.width / 12
+      def row
+        Vedeu.height / 12
+      end
+
+      # @macro raise_out_of_range
+      # @return [Fixnum]
+      def value
+        raise Vedeu::Error::OutOfRange if out_of_range?(@value)
+
+        @value
       end
 
     end # Grid