vedeu 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c55cc711fc37aa01aeaba23c8ababc6c983801c4
-  data.tar.gz: e86bdcf954386935f4710649322622de5afadb3e
+  metadata.gz: 50414317727dc7045eeb48bcc676bf11fd67a06b
+  data.tar.gz: c4d967105b00a59ddda739d06373b9a63653e3f9
 SHA512:
-  metadata.gz: 78f9a8eb02a9b61bdb6f9c0943f016bce77f4747d327d93ea62fc56b024a457af78b4268095ef3141a7085fb500de741ba0dee15c114ccb5715bf819444cc0ec
-  data.tar.gz: cd92b729793a54269549769f3ca235e465297cd6eedf92e752fb1eb72e9a12d1991b55a540466c455684b1fe986e24ab840e28c57b34c92acacaefbde0562b32
+  metadata.gz: 02424b6a19fb5f4d88ea39e7502cf47f2b56a2401c84504f6da103fd358109665060a4420f24700bd24580c7656c8b2646ceb759ff4d4ab82c2f03bccca19366
+  data.tar.gz: c5eac73a0ad542d6178a6fb8a3998b1a4d6404770d2b320c06e2e173cc53768a2ef710f8dd75e700058be4f4a427df604a9b659293389e63749bf522fca4f624

data/.ruby-version

@@ -1 +1 @@
-2.2
+2.1

data/docs/events.md

@@ -11,18 +11,6 @@ class SomeClassInYourApplication
   # ...
 ```
 
-## System Events
-
-System events generally control the internal state of Vedeu with respects to your application. They are soft-namespaced using underscores.
-
-### `:_refresh_group_(group_name)_`
-
-Will refresh all interfaces belonging to this group. E.g. `_refresh_group_home_` will refresh all interfaces with the group of `home`.
-
-### `:_refresh_(interface_name)_`
-
-Will refresh the interface with this name. E.g. `_refresh_widget_` will refresh the interface `widget`.
-
 
 ##### Notes:
 

data/examples/configuration_app.rb

@@ -44,7 +44,7 @@ class VedeuConfigurationApp
   end
 
   keymap('config') do
-    key(' ') { Vedeu.trigger(:_refresh_config_) }
+    key(' ') { Vedeu.trigger(:_refresh_, 'config') }
   end
 
   def self.start(argv = ARGV)

data/lib/vedeu/all.rb

@@ -24,7 +24,6 @@ require 'vedeu/events/all'
 require 'vedeu/input/all'
 require 'vedeu/models/all'
 require 'vedeu/output/all'
-require 'vedeu/presentation/all'
 require 'vedeu/support/all'
 
 require 'vedeu/main_loop'

data/lib/vedeu/bindings.rb

@@ -9,7 +9,7 @@ module Vedeu
   end
 
   # Creates system events which when called provide a variety of core functions
-  # and behaviours.
+  # and behaviours. They are soft-namespaced using underscores.
   #
   # @note
   #   Unbinding any of these events is likely to cause problems, so I would
@@ -219,8 +219,23 @@ module Vedeu
     # starting at the current item to the last item.
     Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
 
-    # Triggering this event will cause all interfaces to refresh.
-    Vedeu.bind(:_refresh_) { Vedeu::Refresh.all }
+    # Triggering this event will cause all interfaces to refresh, or the named
+    # interface if one is given.
+    Vedeu.bind(:_refresh_) do |name|
+      if name
+        Vedeu::Refresh.by_name(name)
+
+      else
+        Vedeu::Refresh.all
+
+      end
+    end
+
+    # Triggering this event will cause all interfaces in the named group to
+    # refresh.
+    Vedeu.bind(:_refresh_group_) do |name|
+      Vedeu::Refresh.by_group(name)
+    end
 
   end # Bindings
   # :nocov:

data/lib/vedeu/buffers/display_buffer.rb

@@ -55,28 +55,6 @@ module Vedeu
       self
     end
 
-    # Registers refresh events for the interface unless already registered.
-    #
-    # @return [Interface]
-    def store_refresh_events
-      options = { delay: delay }
-      event   = "_refresh_#{name}_".to_sym
-
-      unless Vedeu.events.registered?(event)
-        Vedeu.bind(event, options) { Vedeu::Refresh.by_name(name) }
-      end
-
-      unless group.nil? || group.empty?
-        event = "_refresh_group_#{group}_".to_sym
-
-        unless Vedeu.events.registered?(event)
-          Vedeu.bind(event, options) { Vedeu::Refresh.by_group(group) }
-        end
-      end
-
-      self
-    end
-
     # Registers interface name in focus list unless already registered.
     #
     # @return [Interface]

data/lib/vedeu/configuration/api.rb

@@ -39,14 +39,12 @@ module Vedeu
       #
       # @return [Hash]
       def configuration
-        if system_keys.any?
-          options.merge({
-            system_keys: Configuration.default_system_keys.merge(system_keys)
-          })
-
-        else
-          options
+        options.merge!({
+          system_keys: Configuration.default_system_keys.merge(system_keys)
+        }) if system_keys.any?
 
+        options.each do |option, value|
+          Vedeu.log(type: :config, message: "API #{option.to_s}: #{value.to_s}")
         end
       end
 
@@ -65,8 +63,6 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def interactive!(value = true)
-        Vedeu.log(type: :info, message: "Configuration::API interactive: #{value}")
-
         options[:interactive] = value
       end
       alias_method :interactive, :interactive!
@@ -82,8 +78,6 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def standalone!(value = true)
-        Vedeu.log(type: :info, message: "Configuration::API interactive: #{!value}")
-
         options[:interactive] = !value
       end
       alias_method :standalone, :standalone!
@@ -100,8 +94,6 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def run_once!(value = true)
-        Vedeu.log(type: :info, message: "Configuration::API once: #{value}")
-
         options[:once] = value
       end
       alias_method :run_once, :run_once!
@@ -116,8 +108,6 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def drb!(value = true)
-        Vedeu.log(type: :info, message: "Configuration::API drb: #{value}")
-
         options[:drb] = value
       end
       alias_method :drb, :drb!
@@ -183,8 +173,6 @@ module Vedeu
       #
       # @return [Boolean]
       def cooked!
-        Vedeu.log(type: :info, message: "Configuration::API terminal_mode: :cooked")
-
         options[:terminal_mode] = :cooked
       end
       alias_method :cooked, :cooked!
@@ -198,8 +186,6 @@ module Vedeu
       #
       # @return [Boolean]
       def raw!
-        Vedeu.log(type: :info, message: "Configuration::API terminal_mode: :raw")
-
         options[:terminal_mode] = :raw
       end
       alias_method :raw, :raw!
@@ -222,13 +208,9 @@ module Vedeu
       # @return [Boolean]
       def debug!(value = true)
         if options.key?(:trace) && options[:trace] != false
-          Vedeu.log(type: :info, message: "Configuration::API debug: true")
-
           options[:debug] = true
 
         else
-          Vedeu.log(type: :info, message: "Configuration::API debug: #{value}")
-
           options[:debug] = value
 
         end
@@ -252,9 +234,6 @@ module Vedeu
       # @return [Boolean]
       def trace!(value = true)
         options[:debug] = true if value === true
-
-        Vedeu.log(type: :info, message: "Configuration::API trace: #{value}")
-
         options[:trace] = value
       end
       alias_method :trace, :trace!
@@ -273,9 +252,6 @@ module Vedeu
       def colour_mode(value = nil)
         fail InvalidSyntax, '`colour_mode` must be `8`, `16`, `256`, ' \
                             '`16777216`.' unless valid_colour_mode?(value)
-
-        Vedeu.log(type: :info, message: "Configuration::API colour_mode: #{value}")
-
         options[:colour_mode] = value
       end
 
@@ -346,9 +322,6 @@ module Vedeu
       # @return [String|Symbol]
       def exit_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
-
-        Vedeu.log(type: :info, message: "Configuration::API exit_key: #{value}")
-
         system_keys[:exit] = value
       end
 
@@ -367,10 +340,7 @@ module Vedeu
       # @param value [String|Symbol]
       # @return [String|Symbol]
       def focus_next_key(value)
-        return invalid_key('exit_key') unless valid_key?(value)
-
-        Vedeu.log(type: :info, message: "Configuration::API focus_next: #{value}")
-
+        return invalid_key('focus_next_key') unless valid_key?(value)
         system_keys[:focus_next] = value
       end
 
@@ -389,10 +359,7 @@ module Vedeu
       # @param value [String|Symbol]
       # @return [String|Symbol]
       def focus_prev_key(value)
-        return invalid_key('exit_key') unless valid_key?(value)
-
-        Vedeu.log(type: :info, message: "Configuration::API focus_prev: #{value}")
-
+        return invalid_key('focus_prev_key') unless valid_key?(value)
         system_keys[:focus_prev] = value
       end
 
@@ -411,10 +378,7 @@ module Vedeu
       # @param value [String|Symbol]
       # @return [String|Symbol]
       def mode_switch_key(value)
-        return invalid_key('exit_key') unless valid_key?(value)
-
-        Vedeu.log(type: :info, message: "Configuration::API mode_switch: #{value}")
-
+        return invalid_key('mode_switch_key') unless valid_key?(value)
         system_keys[:mode_switch] = value
       end
 

data/lib/vedeu/configuration/cli.rb

@@ -40,55 +40,39 @@ module Vedeu
 
           opts.on('-i', '--interactive',
                   'Run the application in interactive mode (default).') do
-            Vedeu.log(type: :info, message: "Configuration::CLI interactive: true")
-
             options[:interactive] = true
           end
 
           opts.on('-I', '--noninteractive', '--standalone',
                   'Run the application non-interactively; i.e. not requiring ' \
                   'intervention from the user.') do
-            Vedeu.log(type: :info, message: "Configuration::CLI interactive: false")
-
             options[:interactive] = false
           end
 
           opts.on('-1', '--run-once',
                   'Run the application loop once.') do
-            Vedeu.log(type: :info, message: "Configuration::CLI once: true")
-
             options[:once] = true
           end
 
           opts.on('-n', '--run-many',
                   'Run the application loop continuously (default).') do
-            Vedeu.log(type: :info, message: "Configuration::CLI once: false")
-
             options[:once] = false
           end
 
           opts.on('-c', '--cooked', 'Run application in cooked mode.') do
-            Vedeu.log(type: :info, message: "Configuration::CLI terminal_mode: :cooked")
-
             options[:terminal_mode] = :cooked
           end
 
           opts.on('-r', '--raw', 'Run application in raw mode (default).') do
-            Vedeu.log(type: :info, message: "Configuration::CLI terminal_mode: :raw")
-
             options[:terminal_mode] = :raw
           end
 
           opts.on('-d', '--debug', 'Run application with debugging on.') do
-            Vedeu.log(type: :info, message: "Configuration::CLI debug: true")
-
             options[:debug] = true
           end
 
           opts.on('-D', '--trace', 'Run application with debugging on with ' \
                                    'method and event tracing (noisy!).') do
-            Vedeu.log(type: :info, message: "Configuration::CLI trace: true")
-
             options[:debug] = true
             options[:trace] = true
           end
@@ -97,13 +81,9 @@ module Vedeu
                   'Run application in either `8`, `16`, `256` or `16777216` ' \
                   'colour mode.') do |colours|
             if [8, 16, 256, 16777216].include?(colours)
-              Vedeu.log(type: :info, message: "Configuration::CLI colour_mode: #{colours}")
-
               options[:colour_mode] = colours
 
             else
-              Vedeu.log(type: :info, message: "Configuration::CLI colour_mode: 8 (defaulted)")
-
               options[:colour_mode] = 8
 
             end
@@ -111,49 +91,39 @@ module Vedeu
 
           opts.on('-l', '--log [FILENAME]', String,
                   'Specify the path for the log file.') do |filename|
-            Vedeu.log(type: :info, message: "Configuration::CLI log: #{filename}")
-
             options[:log] = filename
           end
 
           opts.on('--drb', 'Run application with DRb on.') do
-            Vedeu.log(type: :info, message: "Configuration::CLI drb: true")
-
             options[:drb] = true
           end
 
           opts.on('--drb-host', 'Set the hostname/IP for the DRb server.') do |hostname|
-            Vedeu.log(type: :info, message: "Configuration::CLI drb_host: #{hostname}")
-
             #options[:drb]      = true
             options[:drb_host] = hostname
           end
 
           opts.on('--drb-port', 'Set the port for the DRb server.') do |port|
-            Vedeu.log(type: :info, message: "Configuration::CLI drb_port: #{port}")
-
-            #options[:drb]      = true
+            # options[:drb]    = true
             options[:drb_port] = port
           end
 
           opts.on('--drb-height', 'Set the height for fake terminal of the DRb server.') do |height|
-            Vedeu.log(type: :info, message: "Configuration::CLI drb_height: #{height}")
-
-            #options[:drb]      = true
+            # options[:drb]      = true
             options[:drb_height] = height
           end
 
           opts.on('--drb-width', 'Set the width for fake terminal of the DRb server.') do |width|
-            Vedeu.log(type: :info, message: "Configuration::CLI drb_width: #{width}")
-
-            #options[:drb]      = true
+            # options[:drb]     = true
             options[:drb_width] = width
           end
         end
 
         parser.parse!(args)
 
-        options
+        options.each do |option, value|
+          Vedeu.log(type: :config, message: "CLI #{option.to_s}: #{value.to_s}")
+        end
       end
 
       private

data/lib/vedeu/configuration/configuration.rb

@@ -196,8 +196,6 @@ module Vedeu
       #
       # @return [Hash]
       def reset!
-        # Vedeu::Log.logger.debug('Resetting configuration.')
-
         instance.reset!
       end
 
@@ -233,8 +231,6 @@ module Vedeu
     #
     # @return [Hash]
     def reset!
-      # Vedeu::Log.logger.debug('Resetting configuration.')
-
       @options = defaults
     end
 

data/lib/vedeu/distributed/server.rb

@@ -73,19 +73,13 @@ module Vedeu
       def restart
         return not_enabled unless drb?
 
-        if drb_running?
-          log('Restarting')
-
-          stop
+        log('Not running') unless drb_running?
 
-          start
+        log('Restarting')
 
-        else
-          log('Not running')
+        stop
 
-          start
-
-        end
+        start
       end
 
       # When called will stop the DRb server and attempt to terminate the client

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

@@ -39,12 +39,10 @@ module Vedeu
         #
         # @raise [InvalidSyntax] The required block was not given.
         # @return [Keymap]
+        # @todo Try to remember why we need to pre-create the keymap in the
+        #   repository.
         def keymap(name, &block)
-          # fail InvalidSyntax, 'block not given' unless block_given?
-
-          # @todo Try to remember why we need to pre-create the keymap in the
-          #   repository.
-          Vedeu::Keymap.new(name).store
+          Vedeu::Keymap.new({ name: name }).store
 
           Vedeu::Keymap.build({ name: name }, &block).store
         end

data/lib/vedeu/input/keymap.rb

@@ -15,51 +15,18 @@ module Vedeu
 
     attr_accessor :name
 
-    class << self
-
-      # @param attributes [Hash]
-      # @param block [Proc]
-      # @option attributes client []
-      # @option attributes keys []
-      # @option attributes name [String]
-      # @option attributes repository [Vedeu::Repository]
-      # @raise [InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Keymap]
-      def build(attributes = {}, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
-
-        attributes = defaults.merge(attributes)
-
-        model = new(attributes[:name],
-                    attributes[:keys],
-                    attributes[:repository])
-        model.deputy(attributes[:client]).instance_eval(&block)
-        model.store
-      end
-
-      private
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash]
-      def defaults
-        {
-          client:     nil,
-          keys:       [],
-          name:       '',
-          repository: Vedeu::Keymaps.keymaps,
-        }
-      end
-
-    end
-
-    # @param name [String] The name of the keymap.
-    # @param keys [Vedeu::Model::Collection|Array] A collection of keys.
+    # @param attributes [Hash]
+    # @option attributes name [String] The name of the keymap.
+    # @option attributes keys [Vedeu::Model::Collection|Array] A collection of
+    #   keys.
+    # @option attributes repository [Vedeu::Repository] This model's storage.
     # @return [Vedeu::Keymap]
-    def initialize(name = '', keys = [], repository = nil)
-      @name       = name
-      @keys       = keys
-      @repository = repository || Vedeu::Keymaps.keymaps
+    def initialize(attributes = {})
+      @attributes = defaults.merge(attributes)
+
+      @name       = @attributes[:name]
+      @keys       = @attributes[:keys]
+      @repository = @attributes[:repository]
     end
 
     # @param key [Key]
@@ -99,6 +66,15 @@ module Vedeu
 
     private
 
+    # @return [Hash]
+    def defaults
+      {
+        name:       '',
+        keys:       [],
+        repository: Vedeu::Keymaps.keymaps,
+      }
+    end
+
     # Checks that the provided key is not already registered with this keymap.
     #
     # @param key [Vedeu::Key]
@@ -106,7 +82,8 @@ module Vedeu
     def valid?(key)
       return true unless key_defined?(key.input)
 
-      Vedeu.log(type: :debug, message: "Keymap '#{name}' already defines '#{key.input}'.")
+      Vedeu.log(type:    :debug,
+                message: "Keymap '#{name}' already defines '#{key.input}'.")
 
       false
     end

data/lib/vedeu/main_loop.rb

@@ -34,6 +34,8 @@ module Vedeu
       @loop = false
     end
 
+    private
+
     # Check the application has started and we wish to continue running.
     #
     # @raise [VedeuInterrupt] When we wish to terminate the running application.

data/lib/vedeu/models/focus.rb

@@ -102,7 +102,7 @@ module Vedeu
     #
     # @return [Array]
     def refresh
-      Vedeu.trigger("_refresh_#{current}_".to_sym)
+      Vedeu.trigger(:_refresh_, current)
     end
 
     # Returns a collection of the names of all the registered entities.

data/lib/vedeu/models/geometry.rb

@@ -261,6 +261,8 @@ module Vedeu
       right + value
     end
 
+    private
+
     # Provides a virtual y position within the interface's dimensions.
     #
     # @example
@@ -285,8 +287,6 @@ module Vedeu
       (left...right).to_a
     end
 
-    private
-
     # The default values for a new instance of this class.
     #
     # @return [Hash]

data/lib/vedeu/models/view/char.rb

@@ -1,5 +1,5 @@
 require 'vedeu/output/html_char'
-require 'vedeu/presentation/presentation'
+require 'vedeu/output/presentation'
 
 module Vedeu
 

data/lib/vedeu/models/view/composition.rb

@@ -1,6 +1,6 @@
 require 'vedeu/dsl/composition'
 require 'vedeu/models/collection'
-require 'vedeu/presentation/presentation'
+require 'vedeu/output/presentation'
 require 'vedeu/support/common'
 
 require 'vedeu/models/view/interfaces'

data/lib/vedeu/models/view/interface.rb

@@ -1,6 +1,6 @@
 require 'vedeu/support/content_geometry'
 require 'vedeu/models/model'
-require 'vedeu/presentation/presentation'
+require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
 require 'vedeu/buffers/buffer'
 
@@ -108,6 +108,9 @@ module Vedeu
       end
     end
 
+    # Fetch the cursor belonging to this interface (by name), if one does not
+    # exist, it will be created, stored and returned.
+    #
     # @return [Vedeu::Cursor]
     def cursor
       Vedeu.cursors.by_name(name)
@@ -144,7 +147,6 @@ module Vedeu
       super
 
       store_new_buffer
-      store_refresh_events
       store_focusable
       store_cursor
       store_group

data/lib/vedeu/models/view/line.rb

@@ -1,5 +1,4 @@
-require 'vedeu/presentation/presentation'
-
+require 'vedeu/output/presentation'
 require 'vedeu/models/view/streams'
 require 'vedeu/models/view/stream'
 

data/lib/vedeu/models/view/stream.rb

@@ -1,4 +1,4 @@
-require 'vedeu/presentation/presentation'
+require 'vedeu/output/presentation'
 require 'vedeu/models/view/char'
 
 module Vedeu

data/lib/vedeu/output/all.rb

@@ -1,5 +1,13 @@
+require 'vedeu/output/translator'
+require 'vedeu/output/background'
+require 'vedeu/output/foreground'
+
 require 'vedeu/output/border'
+require 'vedeu/output/colour'
 require 'vedeu/output/compositor'
+
+require 'vedeu/output/presentation'
+require 'vedeu/output/style'
 require 'vedeu/output/position_index'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/output/html_char'

data/lib/vedeu/{presentation → output}/foreground.rb

@@ -1,5 +1,5 @@
 require 'vedeu/configuration/configuration'
-require 'vedeu/presentation/translator'
+require 'vedeu/output/translator'
 require 'vedeu/support/esc'
 
 module Vedeu