vedeu 0.4.17 → 0.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adae57ef3023290f75d36a2744e07ef707297278
-  data.tar.gz: ae4a68bbb7eb2254a774a93bfc41eac41b9e57b2
+  metadata.gz: 9465a952ab6e8149c69de234c8e51c5e6f09a2a2
+  data.tar.gz: 6eb60784e45eea477870787e5a5ced902dc5f1c9
 SHA512:
-  metadata.gz: 70f4525ba7779abc257a051e2c82952f36ec208a207f511d67c70a1eb7e5d8c0ff741c36fc54c887a7265580bfc042e18de418b537af661af332317980806ce6
-  data.tar.gz: be52af102efe89af2e0b17419ce9bae9b815eb45516a72970f7f4efafe74614f8516912e2602fd2c066bdcdad3af1a823bc47cd8b5d32f0da0ea3f824326cf55
+  metadata.gz: 48866fecffced7581f359ed1fb6107aedfa746d1035dd0c26443920b158f090ab45199c0d4cdcb84c4cea5d9aefdcc3210895e9cb86bc6d53e033b71692f646d
+  data.tar.gz: 1774d54f66bf61ff8639891c5ec3572740f9ae8f8be1d7019b9a603315720f17ccf61f92b534fc2c78c4f1a8e80577221bf98e944745966d3753feefb59f0d39

data/docs/dsl.md

@@ -0,0 +1,54 @@
+Coupled with the API (for interacting with the running client application), the
+ DSL provides the mechanism to configure aspects of your application whilst
+ using Vedeu.
+
+
+### Borders
+
+Borders are defined by name for each of the client application's interfaces or
+ views. They can be enabled or disabled (which controls whether they are
+ rendered or not), they have their own colours and styles, and each aspect of
+ the border can be controlled. The RubyDoc contains information for
+ configuring borders.
+
+### Geometry
+
+Geometry is defined by name and allows the configuration of the position and
+ size of an interface.
+
+### Groups
+
+Interfaces can be configured to be part of a named group. Once an interface is a
+ member of group, the group can be affected by other controls. For example,
+ assuming the client application is a simple Git client, it may have a group
+ called 'commit'. The 'commit' group will contain the interfaces 'diff' (to show
+ the changes), 'staged' (to show which files are staged) and 'unstaged'. A
+ refresh of the 'commit' group would cause all interfaces belonging to the group
+ to refresh. Similarly, showing or hiding the group would of course, show or
+ hide the interfaces of that group.
+
+### Interfaces
+
+
+
+### Keymaps
+
+There are two built in keymaps with Vedeu, 'system' (keys needed by Vedeu to
+ operate, e.g. 'q' for quit, to quit the client application), and 'global' which
+ holds keys which perform actions no matter which interface is currently
+ focussed.
+
+You can define keymaps by name which matches a defined interface. When that
+ interface is in focus, keys pressed as part of this definition will affect
+ that interface. This allows you to form context driven behaviour for your
+ application.
+
+
+### Menus
+
+
+
+### Views
+
+
+

data/docs/views.md

@@ -1,14 +1,14 @@
 ## Views with Vedeu
 
 There are two ways to construct views with Vedeu. You would like to draw the
-view to the screen immediately (immediate render) or you want to save a view to
-be drawn when you trigger a refresh event later (deferred view).
+ view to the screen immediately (immediate render) or you want to save a view to
+ be drawn when you trigger a refresh event later (deferred view).
 
 ** LINK Both of these approaches require that you have defined an interface (or
-'visible area') first. You can find out how to define an interface with Vedeu
-here. The examples in 'Immediate Render' and 'Deferred View' use these interface
-definitions: (Note: if you use these examples, ensure your terminal is at least
-70 characters in width and 5 lines in height.)
+ 'visible area') first. You can find out how to define an interface with Vedeu
+ here. The examples in 'Immediate Render' and 'Deferred View' use these
+ interface definitions: (Note: if you use these examples, ensure your terminal
+ is at least 70 characters in width and 5 lines in height.)
 
 ```ruby
   Vedeu.interface 'main' do
@@ -30,31 +30,31 @@ definitions: (Note: if you use these examples, ensure your terminal is at least
 ```
 
 Both of these approaches use a concept of Buffers in Vedeu. There are three
-buffers for any defined interface. These are imaginatively called: 'back',
-'front' and 'previous'.
+ buffers for any defined interface. These are imaginatively called: 'back',
+ 'front' and 'previous'.
 
 The 'back' buffer is the content for an interface which will be shown next time
-a refresh event is fired globally or for that interface. So, 'back' becomes
-'front'.
+ a refresh event is fired globally or for that interface. So, 'back' becomes
+ 'front'.
 
 The 'front' buffer is the content for an interface which is currently showing.
 When a refresh event is fired, again, globally or for that interface
-specifically, the content of this 'front' buffer is first copied to the
-'previous' buffer, and then the current 'back' buffer overwrites this 'front'
-buffer.
+ specifically, the content of this 'front' buffer is first copied to the
+ 'previous' buffer, and then the current 'back' buffer overwrites this 'front'
+ buffer.
 
 The 'previous' buffer contains what was shown on the 'front' before the current
-'front'.
+ 'front'.
 
 You can only write to either the 'front' (you want the content to be drawn
-immediately) or the 'back' (you would like the content to be drawn on the next
-refresh).
+ immediately (immediate render)) or the 'back' (you would like the content to be
+ drawn on the next refresh (deferred view)).
 
 ### Immediate Render
 
 The immediate render DSL for Vedeu is accessed via `Vedeu.renders`. When this
-approach is used, the content defined is written directly to the 'front'
-buffer(s) for the interface(s) concerned. Take a glance at the example below:
+ approach is used, the content defined is written directly to the 'front'
+ buffer(s) for the interface(s) concerned. Take a glance at the example below:
 
 ```ruby
   Vedeu.renders do
@@ -81,13 +81,13 @@ buffer(s) for the interface(s) concerned. Take a glance at the example below:
 ### Deferred View
 
 The deferred view DSL for Vedeu is accessed via `Vedeu.views`. This approach
-writes the content defined to the 'back' buffer(s) for the interface(s)
-concerned. It will become the front when your application triggers the refresh
-event for the interface(s).
+ writes the content defined to the 'back' buffer(s) for the interface(s)
+ concerned. It will become the front when your application triggers the refresh
+ event for the interface(s).
 
 As you can see by comparing the examples above to these below, the immediate
-render simply wraps what is already here in the deferred view. Again, more
-specific information is available in the Rubydoc.
+ render simply wraps what is already here in the deferred view. Again, more
+ specific information is available in the Rubydoc.
 
 ```ruby
   Vedeu.views do
@@ -151,8 +151,8 @@ renders/views
 #### Authors Notes
 
 The Rubydoc documentation has more specific information about the DSL methods
-demonstrated above: [RubyDoc](http://rubydoc.info/gems/vedeu).
+ demonstrated above: [RubyDoc](http://rubydoc.info/gems/vedeu).
 
 I've tried to write the DSL in a way which makes it read nice; believing that
-this will make it easier to use. I hope this is the case for you.
+ this will make it easier to use. I hope this is the case for you.
 

data/examples/cursor_app.rb

@@ -23,7 +23,7 @@ class VedeuCursorApp
 
     geometry do
       centred true
-      height  20
+      height  10
       width   20
     end
   end

data/examples/material_colours_app.rb

@@ -14,7 +14,7 @@ class VedeuMaterialColoursApp
   configure do
     # debug!
     log '/tmp/vedeu_material_colours_app.log'
-    renderers Vedeu::FileRenderer
+    renderers Vedeu::Renderers::File
   end
 
   interface 'main_interface' do

data/lib/vedeu/all.rb

@@ -4,6 +4,7 @@
 require 'vedeu/debug'
 require 'vedeu/traps'
 
+require 'vedeu/null/all'
 require 'vedeu/geometry/all'
 require 'vedeu/storage/all'
 require 'vedeu/repositories/all'

data/lib/vedeu/bindings.rb

@@ -229,14 +229,7 @@ module Vedeu
     # Triggering the ':_hide_group_' event to which this named interface belongs
     # will also hide the interface.
     Vedeu.bind(:_hide_interface_) do |name|
-      if name && Vedeu.interfaces.registered?(name)
-        interface = Vedeu.interfaces.find(name)
-
-        if interface.visible?
-          interface = Vedeu::Visibility.hide(interface)
-          Vedeu.buffers.clear(interface.name)
-        end
-      end
+      Vedeu.buffers.by_name(name).hide
     end
 
     # Will show the named interface. If the interface is currently invisible, it
@@ -245,13 +238,7 @@ module Vedeu
     # Triggering the ':_show_group_' event to which this named interface belongs
     # will also show the interface.
     Vedeu.bind(:_show_interface_) do |name|
-      if name && Vedeu.interfaces.registered?(name)
-        interface = Vedeu.interfaces.find(name)
-
-        interface = Vedeu::Visibility.show(interface) unless interface.visible?
-
-        Vedeu.buffers.render(interface.name)
-      end
+      Vedeu.buffers.by_name(name).show
     end
 
     # Will toggle the visibility of the named interface. If the interface is

data/lib/vedeu/buffers/buffer.rb

@@ -65,6 +65,23 @@ module Vedeu
       true
     end
 
+    # Returns the front buffer or, if that is empty, the interface cleared.
+    #
+    # @return [void]
+    def clear
+      Vedeu::Output.render(clear_buffer) unless clear_buffer.empty?
+
+      clear_buffer
+    end
+
+    # @return [void]
+    def hide
+      if visible?
+        Vedeu::Visibility.hide(interface)
+        clear
+      end
+    end
+
     # Return the content for this buffer.
     #
     # - If we have new content (i.e. content on 'back') to be shown, we first
@@ -84,13 +101,12 @@ module Vedeu
     end
     alias_method :content, :render
 
-    # Returns the front buffer or, if that is empty, the interface cleared.
-    #
     # @return [void]
-    def clear
-      Vedeu::Output.render(clear_buffer) unless clear_buffer.empty?
-
-      clear_buffer
+    def show
+      unless visible?
+        Vedeu::Visibility.show(interface)
+        render
+      end
     end
 
     private
@@ -131,6 +147,8 @@ module Vedeu
     #
     # @return [Boolean]
     def swap
+      Vedeu.log(type: :output, message: "Buffer swapping: '#{name}'")
+
       @previous = front
       @front    = back
       @back     = nil
@@ -153,7 +171,7 @@ module Vedeu
 
     # @return [Vedeu::Interface]
     def interface
-      @interface ||= Vedeu.interfaces.find(name)
+      @interface ||= Vedeu.interfaces.by_name(name)
     end
 
     # @return [Vedeu::Interface]
@@ -167,6 +185,11 @@ module Vedeu
       end
     end
 
+    # @see Vedeu::Interface#visible
+    def visible?
+      interface.visible?
+    end
+
   end # Buffer
 
 end # Vedeu

data/lib/vedeu/buffers/display_buffer.rb

@@ -78,7 +78,7 @@ module Vedeu
     # @return [Interface]
     def store_group
       unless group.nil? || group.empty? || Vedeu.groups.registered?(group)
-        Vedeu::Group.new(name, group).store
+        Vedeu::Group.new(members: name, name: group).store
       end
 
       self

data/lib/vedeu/configuration/configuration.rb

@@ -270,7 +270,7 @@ module Vedeu
         interactive:   true,
         log:           '/tmp/vedeu.log',
         once:          false,
-        renderers:     [Vedeu::TerminalRenderer],
+        renderers:     [Vedeu::Renderers::Terminal],
         stdin:         nil,
         stdout:        nil,
         stderr:        nil,

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -24,6 +24,10 @@ module Vedeu
       @name = name
     end
 
+    # Renders the cursor in the terminal. If the cursor's x or y offsets are
+    # greater or equal to the interface's width or height respectively, then
+    # the view is also refreshed, causing the content to be offset also.
+    #
     # @return [Array]
     def render
       Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'")

data/lib/vedeu/dsl/components/border.rb

@@ -12,7 +12,12 @@ module Vedeu
     # drawn or not.
     #
     # @example
-    #   # Borders can be defined as part of a view definition...
+    #   # Borders can be defined when defining your interface...
+    #   Vedeu.interface 'my_interface' do
+    #     border do
+    #       # ...
+    #
+    #   # ...or as part of a view definition...
     #   Vedeu.renders do
     #     view 'border_demo' do
     #       border do

data/lib/vedeu/geometry/all.rb

@@ -5,7 +5,6 @@ require_relative 'dimension'
 require_relative 'geometry'
 require_relative 'grid'
 require_relative 'index_position'
-require_relative 'null_geometry'
 require_relative 'position_index'
 require_relative 'position'
 require_relative 'position_validator'

data/lib/vedeu/geometry/area.rb

@@ -148,26 +148,6 @@ module Vedeu
       x - offset
     end
 
-    # @return [Vedeu::Position]
-    def top_left
-      Vedeu::Position[y, x]
-    end
-
-    # @return [Vedeu::Position]
-    def bottom_left
-      Vedeu::Position[yn, x]
-    end
-
-    # @return [Vedeu::Position]
-    def top_right
-      Vedeu::Position[y, xn]
-    end
-
-    # @return [Vedeu::Position]
-    def bottom_right
-      Vedeu::Position[yn, xn]
-    end
-
   end # Area
 
 end # Vedeu

data/lib/vedeu/geometry/coordinate.rb

@@ -70,56 +70,6 @@ module Vedeu
       end
     end
 
-    # Returns the index for a given y position.
-    #
-    # @example
-    #   # y_range  = [7, 8, 9, 10]
-    #   # y = 8
-    #   y_index     # => 1 # because (y_range[1] = 8)
-    #   y_index(10) # => 3
-    #   y_index(5)  # => 0
-    #   y_index(15) # => 3
-    #
-    # @param position [Fixnum]
-    # @return [Fixnum]
-    def y_index(position = y)
-      if height <= 0 || position <= y
-        0
-
-      elsif position >= yn
-        yn_index
-
-      else
-        y_range.index(position)
-
-      end
-    end
-
-    # Returns the index for a given x position.
-    #
-    # @example
-    #   # x_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
-    #   # x = 8
-    #   x_index     # => 4 # because (x_range[4] = 8)
-    #   x_index(11) # => 7
-    #   x_index(2)  # => 0
-    #   x_index(15) # => 9
-    #
-    # @param position [Fixnum]
-    # @return [Fixnum]
-    def x_index(position = x)
-      if width <= 0 || position <= x
-        0
-
-      elsif position >= xn
-        xn_index
-
-      else
-        x_range.index(position)
-
-      end
-    end
-
     # Returns the y coordinate for a given index.
     #
     # @example

data/lib/vedeu/geometry/geometry.rb

@@ -46,11 +46,7 @@ module Vedeu
                    :yn,
                    :x,
                    :height,
-                   :width,
-                   :top_left,
-                   :top_right,
-                   :bottom_left,
-                   :bottom_right
+                   :width
 
     # @!attribute [rw] centred
     # @return [Boolean]

data/lib/vedeu/geometry/position.rb

@@ -15,6 +15,8 @@ module Vedeu
     alias_method :first, :y
     alias_method :last, :x
 
+    # Convenience constructor for Vedeu::Position.
+    #
     # @param (see #initialize)
     def self.[](y, x)
       new(y, x)
@@ -52,6 +54,13 @@ module Vedeu
     end
     alias_method :==, :eql?
 
+    # Return a tuple containing the y and x coordinates.
+    #
+    # @return [Array<Fixnum>]
+    def to_a
+      [y, x]
+    end
+
     # Return the escape sequence required to position the cursor at a particular
     # point on the screen. When passed a block, will do the aforementioned,
     # call the block and then reposition to this location.

data/lib/vedeu/geometry/position_index.rb

@@ -4,17 +4,8 @@ module Vedeu
   #
   class PositionIndex
 
-    # @!attribute [r] y
-    # @return [Fixnum]
-    attr_reader :y
-
-    # @!attribute [r] x
-    # @return [Fixnum]
-    attr_reader :x
-
-    alias_method :first, :y
-    alias_method :last, :x
-
+    # Convenience constructor for Vedeu::Position.
+    #
     # @param (see #initialize)
     def self.[](y, x)
       new(y, x).[]
@@ -26,11 +17,13 @@ module Vedeu
     # @param x [Fixnum]
     # @return [Vedeu::PositionIndex]
     def initialize(y, x)
-      @y = ((y - 1) <= 1) ? 0 : (y - 1)
-      @x = ((x - 1) <= 1) ? 0 : (x - 1)
+      @y = y
+      @x = x
     end
 
-    # @return [Array]
+    # Returns a tuple containing the y and x coordinates.
+    #
+    # @return [Array<Fixnum>]
     def []
       [y, x]
     end
@@ -47,6 +40,18 @@ module Vedeu
       Vedeu::Position.new(y, x)
     end
 
+    # @return [Fixnum]
+    def x
+      @_x ||= ((@x - 1) <= 1) ? 0 : (@x - 1)
+    end
+    alias_method :last, :x
+
+    # @return [Fixnum]
+    def y
+      @_y ||= ((@y - 1) <= 1) ? 0 : (@y - 1)
+    end
+    alias_method :first, :y
+
   end # PositionIndex
 
 end # Vedeu

data/lib/vedeu/geometry/position_validator.rb

@@ -53,6 +53,9 @@ module Vedeu
       @y    = y
     end
 
+    # Ensures the coordinates provided are within the terminal, interface and
+    # if applicable, bordered interface area.
+    #
     # @return [PositionValidator]
     def validate
       terminal_validation

data/lib/vedeu/models/all.rb

@@ -1,8 +1,5 @@
 require 'vedeu/repositories/all'
 
-require_relative 'null'
-require_relative 'null_interface'
-
 require_relative 'cell'
 require_relative 'char'
 require_relative 'stream'

data/lib/vedeu/models/interface.rb

@@ -1,8 +1,6 @@
 require 'vedeu/models/all'
-require 'vedeu/output/null_border'
 require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
-require 'vedeu/buffers/buffer'
 
 module Vedeu
 
@@ -42,7 +40,7 @@ module Vedeu
     attr_accessor :parent
 
     # @!attribute [rw] visible
-    # @return [String|Symbol]
+    # @return [Boolean] Whether the interface is visible.
     attr_accessor :visible
     alias_method :visible?, :visible
 
@@ -111,7 +109,7 @@ module Vedeu
         hide_cursor,
         Vedeu::Clear.new(self).render,
         Vedeu.borders.by_name(name).render,
-        Vedeu::Viewport.new(self).render,
+        Vedeu::Viewport.render(self),
         show_cursor,
       ]
     end

data/lib/vedeu/null/all.rb

@@ -0,0 +1,5 @@
+require_relative 'border'
+require_relative 'buffer'
+require_relative 'generic'
+require_relative 'geometry'
+require_relative 'interface'

data/lib/vedeu/null/border.rb

@@ -0,0 +1,79 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent Vedeu::Border that acts like the real thing, but
+    # does nothing.
+    #
+    class Border
+
+      # @!attribute [r] name
+      # @return [String|NilClass]
+      attr_reader :name
+
+      # Returns a new instance of Vedeu::Null::Border.
+      #
+      # @param name [String|NilClass]
+      # @return [Vedeu::Null::Border]
+      def initialize(name = nil)
+        @name = name
+      end
+
+      # @return [Fixnum]
+      def bx
+        geometry.x
+      end
+      alias_method :x, :bx
+
+      # @return [Fixnum]
+      def bxn
+        geometry.xn
+      end
+      alias_method :xn, :bxn
+
+      # @return [Fixnum]
+      def by
+        geometry.y
+      end
+      alias_method :y, :by
+
+      # @return [Fixnum]
+      def byn
+        geometry.yn
+      end
+      alias_method :yn, :byn
+
+      # @return [FalseClass]
+      def enabled?
+        false
+      end
+
+      # @return [Fixnum]
+      def height
+        (by..byn).size
+      end
+
+      # @return [Array]
+      def render
+        []
+      end
+
+      # @return [Fixnum]
+      def width
+        (bx..bxn).size
+      end
+
+      private
+
+      # Returns the geometry for the interface.
+      #
+      # @return (see Vedeu::Geometries#by_name)
+      def geometry
+        @geometry ||= Vedeu.geometries.by_name(name)
+      end
+
+    end # Border
+
+  end # Null
+
+end # Vedeu