vedeu 0.8.1 → 0.8.2

data/docs/dsl/by_method/all_keypresses.md

@@ -0,0 +1,3 @@
+Returns an array of all keypresses received by Vedeu.
+
+    Vedeu.all_keypresses

data/docs/dsl/by_method/background_colours.md

@@ -1,3 +1,7 @@
 Manipulate the repository of background colours.
 
     Vedeu.background_colours
+
+    Vedeu.background_colours # => [Vedeu::Colours::Backgrounds]
+
+    Vedeu.background_colours.all # => [Hash<String => String>]

data/docs/dsl/by_method/bind.md

@@ -0,0 +1,43 @@
+Register an event by name with optional delay (throttling)
+which when triggered will execute the code contained within
+the passed block.
+
+@param name [Symbol] The name of the event to be triggered
+  later.
+@param options [Hash<Symbol => void>] The options to
+  register the event with.
+@option options :delay [Fixnum|Float] Limits the execution
+  of the triggered event to only execute when first
+  triggered, with subsequent triggering being ignored until
+  the delay has expired.
+@option options :debounce [Fixnum|Float] Limits the
+  execution of the triggered event to only execute once the
+  debounce has expired. Subsequent triggers before debounce
+  expiry are ignored.
+@param block [Proc] The event to be executed when triggered.
+  This block could be a method call, or the triggering of
+  another event, or sequence of either/both.
+
+    Vedeu.bind :my_event do |some, args|
+      # ... some code here ...
+      Vedeu.trigger(:my_other_event)
+    end
+
+    T = Triggered, X = Executed, i = Ignored.
+    0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6.
+    .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T..
+    .X...i...i...i...i...X...i...i...i...i...X...i...i...i...i...i...i..
+
+    Vedeu.bind(:my_delayed_event, { delay: 0.5 })
+      # ... some code here ...
+    end
+
+    T = Triggered, X = Executed, i = Ignored.
+    0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6.
+    .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T..
+    .i...i...i...i...i...i...i...X...i...i...i...i...i...i...X...i...i..
+
+    Vedeu.bind(:my_debounced_event, { debounce: 0.7 })
+      # ... some code here ...
+    end
+

data/docs/dsl/by_method/bind_alias.md

@@ -0,0 +1,4 @@
+Add events by name to the alias name group. When an alias is
+triggered, all the events stored in the group are also triggered.
+
+    Vedeu.bind_alias(alias_name, event_name)

data/docs/dsl/by_method/borders.md

@@ -0,0 +1,6 @@
+Repository method. Access registered borders.
+
+    Vedeu.borders # [Vedeu::Borders::Repository]
+
+    Vedeu.borders.all # [Array<Vedeu::Borders::Border>]
+

data/docs/dsl/by_method/bound.md

@@ -0,0 +1,3 @@
+Check if an event by name has been registered.
+
+    Vedeu.bound?(:some_event)

data/docs/dsl/by_method/buffer_update.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/buffer_write.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/buffers.md

@@ -0,0 +1,5 @@
+Repository method. Access registered borders.
+
+    Vedeu.buffers # [Vedeu::Buffers::Repository]
+
+    Vedeu.buffers.all # [Array<Vedeu::Buffers::Buffer>]

data/docs/dsl/by_method/clear_by_group.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/clear_by_name.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/clear_content_by_name.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/clock_time.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/cursor.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/cursors.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/direct_write.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/documents.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/drb_restart.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/drb_start.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/drb_status.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/drb_stop.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/events.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/exit.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/focus.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/focus_by_name.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/focus_next.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/focus_previous.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/focussed.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometries.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/goto.md

@@ -1,6 +1,5 @@
-# Instruct Vedeu to load the client application controller
-# action with parameters.
-#
-# @example
-#   Vedeu.goto(controller, action, args)
-#
+Instruct Vedeu to load the client application controller action with
+parameters.
+
+    Vedeu.goto(controller, action, args)
+

data/docs/dsl/by_method/group.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/groups.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/hide_cursor.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/hide_group.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/hide_interface.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/interface.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/interfaces.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/keymap.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/keymap/interface.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/keymap/key.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/keymap/name.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/keymaps.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/last_command.md

@@ -0,0 +1,4 @@
+Access the last command stored. If no commands have been entered since
+the client application started, then this will return nil.
+
+  Vedeu.last_command

data/docs/dsl/by_method/last_keypress.md

@@ -0,0 +1,4 @@
+Access the last keypress stored. If no keys have been pressed since
+the client application started, then this will return nil.
+
+    Vedeu.last_keypress

data/docs/dsl/by_method/log.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/log_stderr.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/log_stdout.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/log_timestamp.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/menu.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/menus.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/read.md

@@ -0,0 +1,33 @@
+### Vedeu.read
+
+This allows the direct reading from the terminal, unencumbered by the
+framework.
+
+    Vedeu.read("some input here") # => programmatic cooked mode
+                                  #    (default)
+
+    Vedeu.read("\e[24;2~", mode: :raw) # => programmatic raw mode
+                                       #    (provides :shift_f12 in
+                                       #    this example)
+
+    Vedeu.read(nil, mode: :raw) # => for a single keypress
+
+    Vedeu.read(nil, mode: :cooked) # => (default mode) for a 'line at
+                                   #    a time' (pressing 'return'
+                                   #    ends the line)
+
+The way that these are used will depend on the mode your terminal is currently set to. Vedeu by default sets this to `:raw` (single character, hidden cursor). `Vedeu.read` by default expects the terminal to be in `:cooked` mode unless you provide the `mode: :raw` option.
+
+- In `:cooked` mode (default), it will trigger a `:_command_` event
+  with the input provided, meaning you should bind to :command to
+  receive the input.
+- In `:raw` mode, it will trigger a `:_keypress_` event with the input
+  provided, meaning you should bind to `:key` to receive the input.
+
+You can also access the input given using the API methods:
+
+    Vedeu.all_commands
+    Vedeu.all_keypresses
+    Vedeu.last_command
+    Vedeu.last_keypress
+

data/docs/dsl/by_method/ready.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/render.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/render_output.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/renderer.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/renderers.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/renders.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/show_cursor.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/show_group.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/show_interface.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/toggle_cursor.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/toggle_group.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/toggle_interface.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/trigger.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/unbind.md

@@ -0,0 +1,5 @@
+Unbind events from a named handler.
+
+Removes all events associated with the given name.
+
+    Vedeu.unbind(:some_event)

data/docs/dsl/by_method/unbind_alias.md

@@ -0,0 +1,4 @@
+Remove an alias by name. The alias name group is destroyed, but events
+stored within this alias are not.
+
+    Vedeu.unbind_alias(alias_name)

data/docs/dsl/by_method/views.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/write.md

@@ -0,0 +1,5 @@
+This allows the direct writing to the terminal, unencumbered by the
+framework.
+
+@todo Add more documentation.
+

data/examples/views/lines_streams.rb

@@ -28,6 +28,36 @@ class DSLApp
     end
   end
 
+  Vedeu.interface :help1_interface do
+    geometry do
+      x  use(:test1_interface).x
+      y  use(:test1_interface).south
+      xn use(:test1_interface).xn
+      yn use(:test1_interface).south(3)
+    end
+  end
+
+  Vedeu.interface :test2_interface do
+    border do
+      title 'Test 2'
+    end
+    geometry do
+      x      use(:test1_interface).east(6)
+      y      use(:test1_interface).y
+      width  use(:test1_interface).width
+      height use(:test1_interface).height
+    end
+  end
+
+  Vedeu.interface :help2_interface do
+    geometry do
+      x  use(:test2_interface).x
+      y  use(:test2_interface).south
+      xn use(:test2_interface).xn
+      yn use(:test2_interface).south(3)
+    end
+  end
+
   Vedeu.render do
     view(:test1_interface) do
       lines do
@@ -37,6 +67,21 @@ class DSLApp
         end
       end
     end
+
+    view(:help1_interface) do
+    end
+
+    view(:test2_interface) do
+      lines do
+        streams do
+          stream 'v->ls->ss->stream 1', { foreground: '#00ff00' }
+          stream 'v->ls->ss->stream 2', { foreground: '#ff0000' }
+        end
+      end
+    end
+
+    view(:help2_interface) do
+    end
   end
 
   def self.start(argv = ARGV)

data/lib/vedeu/application/application_view.rb

@@ -52,7 +52,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def template(value)
-      @template = Vedeu::Configuration.base_path +
+      @template = Vedeu.config.base_path +
                   "/app/views/templates/#{value}.erb"
     end
 

data/lib/vedeu/borders/border.rb

@@ -302,7 +302,7 @@ module Vedeu
           client:            nil,
           colour:            nil,
           enabled:           false,
-          horizontal:        Vedeu::EscapeSequences::Borders.horizontal,
+          horizontal:        Vedeu.esc.horizontal,
           left_vertical:     nil,
           name:              '',
           parent:            nil,
@@ -317,7 +317,7 @@ module Vedeu
           top_horizontal:    nil,
           top_left:          nil,
           top_right:         nil,
-          vertical:          Vedeu::EscapeSequences::Borders.vertical,
+          vertical:          Vedeu.esc.vertical,
         }
       end
 

data/lib/vedeu/cells/border.rb

@@ -46,7 +46,7 @@ module Vedeu
       def value
         return '' unless present?(@value)
 
-        Vedeu::EscapeSequences::Esc.border { @value }
+        Vedeu.esc.border { @value }
       end
 
       private

data/lib/vedeu/cells/borders/bottom_horizontal.rb

@@ -20,7 +20,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+        super.merge!(value: Vedeu.esc.horizontal)
       end
 
     end # BottomHorizontal

data/lib/vedeu/cells/borders/bottom_left.rb

@@ -21,7 +21,7 @@ module Vedeu
       # @return [Hash<Symbol => String>]
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.coerce([yn, x]),
-                     value:    Vedeu::EscapeSequences::Borders.bottom_left)
+                     value:    Vedeu.esc.bottom_left)
       end
 
     end # BottomLeft