vedeu 0.5.13 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a3b30fd311b0147e59815b8665b9b0cfd337d9
-  data.tar.gz: 1dd71d249cb99304d00f7cb51a44345f73665b88
+  metadata.gz: 28c51799d818421857c42dfc95970d49794fa75f
+  data.tar.gz: dd35047e639be0064234964695a8b4f853ea4e54
 SHA512:
-  metadata.gz: 245b56f9f631573bad0ca75880c56b4f72b3bee92068ca49d67a94bf4435cd78d4111c747c57b55ec77bb9d1ee3f09790f24ee9e7738a744cee92c152ed7db44
-  data.tar.gz: 0a9b9d0bf6ada6f16396c56f6a683e5f104bddab17632f5a85c76765bb176e7b5053fc0f91e55a31ca2adbd7919a64e9056c4cb4850b0fc8e6f848fd0e5dc482
+  metadata.gz: ae7a0e4eca0ba65eb6e285681147f9938fba540bda076c10c09a47bcd8fae0eee253508f335540bd049be3ad85885974103332012ca4c878e526669fd0337fb8
+  data.tar.gz: 93cb36006d06bdf9acfd10fca1c527bdfb9cbd12eb5d73ee4feae73bb51a33e49bc5fdbd8a34d13a64ef905adac9493605711ba21072f9220750d588fd953ce0

data/.rubocop.yml

@@ -96,6 +96,9 @@ Style/Next:
     - skip_modifier_ifs
     - always
 
+Style/SpaceAroundOperators:
+  Enabled: false
+
 Style/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: space
 
@@ -180,3 +183,6 @@ Lint/DefEndAlignment:
     - start_of_line
     - def
 
+Lint/Eval:
+  Description: 'The use of eval represents a serious security risk.'
+  Enabled: false

data/bin/vedeu_drb_server

@@ -20,6 +20,7 @@ class VedeuTestApplication
 
     # terminal_mode :raw
     # cooked!
+    # fake!
     # raw!
 
     # run_once!

data/config/rubocop_enabled.yml

@@ -609,7 +609,7 @@ Style/SpaceAroundEqualsInParameterDefault:
 Style/SpaceAroundOperators:
   Description: 'Use a single space around operators.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
-  Enabled: true
+  Enabled: false
 
 Style/SpaceBeforeModifierKeyword:
   Description: 'Put a space before the modifier keyword.'
@@ -858,7 +858,7 @@ Lint/EnsureReturn:
 
 Lint/Eval:
   Description: 'The use of eval represents a serious security risk.'
-  Enabled: true
+  Enabled: false
 
 Lint/HandleExceptions:
   Description: "Don't suppress exception."

data/docs/events.md

@@ -7,6 +7,8 @@ See {Vedeu::Bindings::Application}
 
 ## System Events
 
+See {Vedeu::Bindings::Focus}
+See {Vedeu::Bindings::Refresh}
 See {Vedeu::Bindings::System}
 
 ## DRB Events

data/docs/getting_started.md

@@ -94,7 +94,7 @@ in focus. By default the global keymap contains a few simple definitions:
 
 - **`<esc>`**
 
-  **Mode Switch**. Toggle between cooked and raw terminal modes.
+  **Mode Switch**. Toggle between cooked, fake and raw terminal modes.
 
 - **`<tab>`**
 

data/examples/drb_app.rb

@@ -27,6 +27,7 @@ class VedeuTestApplication
 
     # terminal_mode :raw
     # cooked!
+    # fake!
     # raw!
 
     # run_once!

data/examples/editor_app.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+# An example application to demonstrate colours, cursor and interface movement,
+# maximising/unmaximising of interfaces and toggling of cursors and interfaces.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/material_colours_app.rb
+#
+# Running this application once, and immediately exiting produces the diagram
+# at `./examples/material_colours_app_20150721.svg`. Hopefully this will help
+# you to understand how parts of Vedeu work together. Questions are always
+# welcome at `https://github.com/gavinlaking/vedeu/issues`
+#
+class VedeuEditorApp
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  # Be aware that running an application with debugging enabled will affect
+  # performance.
+  Vedeu.configure do
+    # debug!
+    fake!
+    log '/tmp/vedeu_editor_app.log'
+    # renderers Vedeu::Renderers::File.new
+  end
+
+  Vedeu.interface 'main_interface' do
+    border 'main_interface' do
+      colour foreground: '#ffffff', background: :default
+      title 'Editor'
+      caption('Ctrl+C = Quit')
+    end
+    colour foreground: '#ffffff', background: :default
+    cursor!
+    geometry 'main_interface' do
+      x  columns(1)
+      xn columns(11)
+      y  rows(1)
+      yn rows(1) + 4
+    end
+    zindex 1
+  end
+
+  Vedeu.keymap('_global_') do
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
+
+    key('q')        { Vedeu.trigger(:_exit_) }
+    key(:escape)    { Vedeu.trigger(:_mode_switch_) }
+    key(:shift_tab) { Vedeu.trigger(:_focus_prev_) }
+    key(:tab)       { Vedeu.trigger(:_focus_next_) }
+  end
+
+  Vedeu.renders do
+    view 'main_interface' do
+      line { line '' }
+    end
+  end
+
+  Vedeu.focus_by_name 'main_interface'
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # VedeuEditorApp
+
+VedeuEditorApp.start(ARGV)

data/lib/vedeu/all.rb

@@ -9,14 +9,16 @@ require 'vedeu/log/debug'
 require 'vedeu/log/timer'
 require 'vedeu/runtime/traps'
 require 'vedeu/common'
-require 'vedeu/terminal_mode'
 require 'vedeu/runtime/router'
 
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
 
-require 'vedeu/terminal'
+require 'vedeu/terminal/mode'
+require 'vedeu/terminal/terminal'
+require 'vedeu/terminal/content'
+
 require 'vedeu/runtime/main_loop'
 require 'vedeu/runtime/flags'
 require 'vedeu/runtime/application'
@@ -26,7 +28,7 @@ require 'vedeu/models/toggleable'
 require 'vedeu/repositories/collection'
 require 'vedeu/input/keys'
 require 'vedeu/events/event_collection'
-require 'vedeu/repositories'
+require 'vedeu/repositories/repositories'
 
 require 'vedeu/repositories/model'
 require 'vedeu/repositories/store'
@@ -123,7 +125,7 @@ require 'vedeu/distributed/client'
 require 'vedeu/distributed/subprocess'
 require 'vedeu/distributed/test_application'
 
-require 'vedeu/dsl'
+require 'vedeu/dsl/dsl'
 require 'vedeu/dsl/shared'
 require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'
@@ -139,16 +141,19 @@ require 'vedeu/dsl/menu'
 require 'vedeu/dsl/stream'
 require 'vedeu/dsl/view'
 
+require 'vedeu/input/input_translator'
 require 'vedeu/input/mapper'
 require 'vedeu/input/key'
 require 'vedeu/input/input'
 require 'vedeu/input/keymap'
 require 'vedeu/input/keymaps'
+require 'vedeu/input/editor/all'
 
 require 'vedeu/borders/render_border'
 require 'vedeu/borders/border'
 require 'vedeu/borders/borders'
 
+require 'vedeu/output/direct'
 require 'vedeu/output/clear/named_group'
 require 'vedeu/output/clear/named_interface'
 require 'vedeu/output/presentation'
@@ -168,10 +173,11 @@ require 'vedeu/bindings/application'
 require 'vedeu/bindings/drb'
 require 'vedeu/bindings/menus'
 require 'vedeu/bindings/movement'
+require 'vedeu/bindings/focus'
+require 'vedeu/bindings/refresh'
 require 'vedeu/bindings/system'
 require 'vedeu/bindings/visibility'
+require 'vedeu/bindings/bindings'
 
-require 'vedeu/bindings'
-
-require 'vedeu/plugins'
+require 'vedeu/plugins/plugins'
 require 'vedeu/plugins/plugin'

data/lib/vedeu/{bindings.rb → bindings/bindings.rb}

@@ -22,6 +22,8 @@ module Vedeu
       Vedeu::Bindings::Movement.setup!
       Vedeu::Bindings::Menus.setup!
       Vedeu::Bindings::DRB.setup!
+      Vedeu::Bindings::Focus.setup!
+      Vedeu::Bindings::Refresh.setup!
       Vedeu::Bindings::System.setup!
 
       true

data/lib/vedeu/bindings/focus.rb

@@ -0,0 +1,66 @@
+module Vedeu
+
+  module Bindings
+
+    # Creates system events which when called provide a variety of core
+    # functions and behaviours. They are soft-namespaced using underscores.
+    #
+    # @note
+    #   Unbinding any of these events is likely to cause problems, so I would
+    #   advise leaving them alone. A safe rule: when the name starts with an
+    #   underscore, it's probably used by Vedeu internally.
+    #
+    # :nocov:
+    module Focus
+
+      extend self
+
+      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      #
+      # @return [TrueClass]
+      def setup!
+        focus_by_name!
+        focus_next!
+        focus_prev!
+      end
+
+      private
+
+      # When triggered with an interface name will focus that interface and
+      # restore the cursor position and visibility.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_by_name_, name)
+      #
+      # @return [TrueClass]
+      def focus_by_name!
+        Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
+      end
+
+      # When triggered will focus the next interface and restore the cursor
+      # position and visibility.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_next_)
+      #
+      # @return [TrueClass]
+      def focus_next!
+        Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
+      end
+
+      # When triggered will focus the previous interface and restore the cursor
+      # position and visibility.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_prev_)
+      #
+      # @return [TrueClass]
+      def focus_prev!
+        Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
+      end
+
+    end # Focus
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bindings/refresh.rb

@@ -0,0 +1,77 @@
+module Vedeu
+
+  module Bindings
+
+    # Creates system events which when called provide a variety of core
+    # functions and behaviours. They are soft-namespaced using underscores.
+    #
+    # @note
+    #   Unbinding any of these events is likely to cause problems, so I would
+    #   advise leaving them alone. A safe rule: when the name starts with an
+    #   underscore, it's probably used by Vedeu internally.
+    #
+    # :nocov:
+    module Refresh
+
+      extend self
+
+      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      #
+      # @return [TrueClass]
+      def setup!
+        refresh!
+        refresh_cursor!
+        refresh_group!
+      end
+
+      private
+
+      # Refreshes all registered interfaces or the named interface.
+      #
+      # @note
+      #   The interfaces will be refreshed in z-index order, meaning that
+      #   interfaces with a lower z-index will be drawn first. This means
+      #   overlapping interfaces will be drawn as specified.
+      #   Hidden interfaces will be still refreshed in memory but not shown.
+      #
+      # @example
+      #   Vedeu.trigger(:_refresh_)
+      #   Vedeu.trigger(:_refresh_, name)
+      #
+      # @return [TrueClass]
+      def refresh!
+        Vedeu.bind(:_refresh_) do |name|
+          name ? Vedeu::RefreshBuffer.by_name(name) : Vedeu::Refresh.all
+        end
+      end
+
+      # Will cause the named cursor to refresh, or the cursor of the interface
+      # which is currently in focus.
+      #
+      # @example
+      #   Vedeu.trigger(:_refresh_cursor_, name)
+      #
+      # @return [TrueClass]
+      def refresh_cursor!
+        Vedeu.bind(:_refresh_cursor_) do |name|
+          Vedeu::RefreshCursor.by_name(name)
+        end
+      end
+
+      # Will cause all interfaces in the named group to refresh.
+      #
+      # @example
+      #   Vedeu.trigger(:_refresh_group_, name)
+      #
+      # @return [TrueClass]
+      def refresh_group!
+        Vedeu.bind(:_refresh_group_) do |name|
+          Vedeu::RefreshGroup.by_name(name)
+        end
+      end
+
+    end # Refresh
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bindings/system.rb

@@ -22,18 +22,13 @@ module Vedeu
         cleanup!
         clear!
         command!
+        editor!
         exit!
-        focus_next!
-        focus_prev!
-        focus_by_name!
         initialize!
         keypress!
         log!
         maximise!
         mode_switch!
-        refresh!
-        refresh_cursor!
-        refresh_group!
         resize!
         unmaximise!
       end
@@ -87,49 +82,29 @@ module Vedeu
         Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
       end
 
-      # When triggered, Vedeu will trigger a `:cleanup` event which you can
-      # define (to save files, etc) and attempt to exit.
-      #
-      # @example
-      #   Vedeu.trigger(:_exit_)
-      #   Vedeu.exit
-      #
-      # @return [TrueClass]
-      def exit!
-        Vedeu.bind(:_exit_) { Vedeu::Application.stop }
-      end
-
-      # When triggered with an interface name will focus that interface and
-      # restore the cursor position and visibility.
+      # This event is called by {Vedeu::Input#capture}. When invoked, the
+      # key will be passed to the editor for currently focussed view.
       #
       # @example
-      #   Vedeu.trigger(:_focus_by_name_, name)
+      #   Vedeu.trigger(:_editor_, key)
       #
       # @return [TrueClass]
-      def focus_by_name!
-        Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
-      end
-
-      # When triggered will focus the next interface and restore the cursor
-      # position and visibility.
-      #
-      # @example
-      #   Vedeu.trigger(:_focus_next_)
-      #
-      # @return [TrueClass]
-      def focus_next!
-        Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
+      def editor!
+        Vedeu.bind(:_editor_) do |key|
+          Vedeu::Editor::Editor.keypress(name: Vedeu.focus, input: key)
+        end
       end
 
-      # When triggered will focus the previous interface and restore the cursor
-      # position and visibility.
+      # When triggered, Vedeu will trigger a `:cleanup` event which you can
+      # define (to save files, etc) and attempt to exit.
       #
       # @example
-      #   Vedeu.trigger(:_focus_prev_)
+      #   Vedeu.trigger(:_exit_)
+      #   Vedeu.exit
       #
       # @return [TrueClass]
-      def focus_prev!
-        Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
+      def exit!
+        Vedeu.bind(:_exit_) { Vedeu::Application.stop }
       end
 
       # Vedeu triggers this event when it is ready to enter the main loop.
@@ -183,11 +158,11 @@ module Vedeu
         end
       end
 
-      # When triggered (after the user presses `escape`), Vedeu switches from a
-      # "raw mode" terminal to a "cooked mode" terminal. The idea here being
-      # that the raw mode is for single keypress actions, whilst cooked mode
-      # allows the user to enter more elaborate commands- such as commands with
-      # arguments.
+      # When triggered (by default, after the user presses `escape`), Vedeu
+      # switches between modes of the terminal. The idea here being
+      # that the raw mode is for single keypress actions, whilst fake and cooked
+      # modes allow the user to enter more elaborate commands- such as commands
+      # with arguments.
       #
       # @example
       #   Vedeu.trigger(:_mode_switch_)
@@ -197,50 +172,6 @@ module Vedeu
         Vedeu.bind(:_mode_switch_) { fail Vedeu::ModeSwitch }
       end
 
-      # Refreshes all registered interfaces or the named interface.
-      #
-      # @note
-      #   The interfaces will be refreshed in z-index order, meaning that
-      #   interfaces with a lower z-index will be drawn first. This means
-      #   overlapping interfaces will be drawn as specified.
-      #   Hidden interfaces will be still refreshed in memory but not shown.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_)
-      #   Vedeu.trigger(:_refresh_, name)
-      #
-      # @return [TrueClass]
-      def refresh!
-        Vedeu.bind(:_refresh_) do |name|
-          name ? Vedeu::RefreshBuffer.by_name(name) : Vedeu::Refresh.all
-        end
-      end
-
-      # Will cause the named cursor to refresh, or the cursor of the interface
-      # which is currently in focus.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_cursor_, name)
-      #
-      # @return [TrueClass]
-      def refresh_cursor!
-        Vedeu.bind(:_refresh_cursor_) do |name|
-          Vedeu::RefreshCursor.by_name(name)
-        end
-      end
-
-      # Will cause all interfaces in the named group to refresh.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_group_, name)
-      #
-      # @return [TrueClass]
-      def refresh_group!
-        Vedeu.bind(:_refresh_group_) do |name|
-          Vedeu::RefreshGroup.by_name(name)
-        end
-      end
-
       # When triggered will cause Vedeu to trigger the `:_clear_` and
       # `:_refresh_` events. Please see those events for their behaviour.
       #