vedeu 0.4.43 → 0.4.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cffdbe3379ae8f53f8e224ad01f554f697291aeb
-  data.tar.gz: 48dacd852a9ece5238fd2986a64897335416f0c6
+  metadata.gz: 0e923ab136ae9285466e5526700a91bd23b78f03
+  data.tar.gz: 8af995c9b432d7ee21c51837bb6dd6a508b5e485
 SHA512:
-  metadata.gz: b36dc6810c4e595f8ddacb09f2c076c0b9d00d457b281a4d03b31cb980db8a547881b458707e6f456b4be1a5ab2c7cbdfd65a8da3b8d06fb7c2463a03b440857
-  data.tar.gz: 2709588855899d5f3d107ab9ccccc66d6b93bfb7693d59cad06865d84bff61e3be0398b8c07d532d3614ffd32bf019c1c96c576941fec30da6d075127c56f08a
+  metadata.gz: b907622dd0291801638870f6456ecf0876c1e66395e3b87a75d433c5ba4449ca9ce23ad27c1520832d0843e7067dcd4969dd7a5b35735dadead4ff2365881f7e
+  data.tar.gz: 1533041a4c03464a27846e11bca3b6f4a4e948fcd8f95f5bfb6a33c8cae92e0a6e398e545785e78101888a59d96c25547c806f5d5d6e38026f5a75425202cbfa

data/Dockerfile

@@ -71,6 +71,6 @@ USER vedeu
 # Once we're up and running, we can create a shell to the docker instance and
 # start running commands against it.
 #
-#     sudo docker run -it -v $PWD:/home/vedeu/gem:rw vedeu/my_first_app /bin/bash
+#     sudo docker run -it -v $PWD:/home/vedeu/gem:rw -v ~/Docker/:/home/vedeu/docker:rw vedeu/my_first_app /bin/bash
 #
 #

data/bin/vedeu

@@ -1,5 +1,24 @@
 #!/usr/bin/env ruby
 
+require 'rake'
+
+bundler_message = 'Bundler is required. Please install bundler with ' \
+                  "'gem install bundler'"
+begin
+  require 'bundler'
+
+rescue LoadError
+  puts bundler_message
+
+end
+
+fail bundler_message unless defined?(Bundler)
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# load Gem.bin_path('bundler', 'bundle')
+
+Bundler.setup
+
 gem_dir = File.expand_path('..', File.dirname(__FILE__))
 $LOAD_PATH.unshift(gem_dir) unless $LOAD_PATH.include?(gem_dir)
 

data/lib/vedeu.rb

@@ -49,40 +49,6 @@ module Vedeu
     receiver.extend(API)
   end
 
-  # ModelNotFound: Raised with Vedeu attempts to access a named model that does
-  #   not exist.
-  #
-  # InvalidSyntax: Raised when Vedeu attempts to parse a {Vedeu.view} or
-  #   {Vedeu.interface} and encounters a problem.
-  #
-  # MissingRequired: Raised when a name is not provided for a model when
-  #   attempting to store it in a repository.
-  #
-  # ModeSwitch: Raised intentionally when the client application wishes to
-  #   switch between cooked and raw (or vice versa) terminal modes. Vedeu is
-  #   hard-wired to use the `Escape` key to trigger this change for the time
-  #   being.
-  #
-  # NotImplemented: Raised to remind me (or client application developers) that
-  #   the subclass implements the functionality sought.
-  #
-  # OutOfRange: Raised when trying to access an interface column less than 1 or
-  #   greater than 12. Vedeu is hard-wired to a 12-column layout for the time
-  #   being.
-  #
-  # VedeuInterrupt: Raised when Vedeu wishes to exit.
-  #
-  EXCEPTIONS = %w(
-    ModelNotFound
-    InvalidSyntax
-    MissingRequired
-    ModeSwitch
-    NotImplemented
-    OutOfRange
-    VedeuInterrupt
-  )
-  EXCEPTIONS.each { |e| const_set(e, Class.new(StandardError)) }
-
 end # Vedeu
 
 require 'vedeu/all'

data/lib/vedeu/all.rb

@@ -2,6 +2,7 @@
 # load order is important
 
 require 'vedeu/version'
+require 'vedeu/exceptions'
 require 'vedeu/debug'
 require 'vedeu/traps'
 
@@ -11,7 +12,9 @@ require 'vedeu/storage/all'
 require 'vedeu/repositories/all'
 
 require 'vedeu/api'
-require 'vedeu/bindings'
+require 'vedeu/bindings/drb'
+require 'vedeu/bindings/menus'
+require 'vedeu/bindings/bindings'
 
 require 'vedeu/cli/generator/all'
 

data/lib/vedeu/application/application_view.rb

@@ -11,25 +11,25 @@ module Vedeu
 
     # Renders the view.
     #
-    # @param object [void]
+    # @param args [void]
     # @return [void]
-    def self.render(object = nil)
-      new(object).render
+    def self.render(*args)
+      new(args).render
     end
 
     # Returns a new instance of Vedeu::ApplicationView.
     #
-    # @param object [void]
+    # @param args [void]
     # @return [Vedeu::ApplicationView]
-    def initialize(object = nil)
-      @object = object
+    def initialize(*args)
+      @args = args
     end
 
     protected
 
-    # @!attribute [r] object
+    # @!attribute [r] args
     # @return [void]
-    attr_reader :object
+    attr_reader :args
 
     # # @!attribute [r] template
     # # @return [void]
@@ -41,7 +41,7 @@ module Vedeu
     # @return [String]
     def template(value)
       @template = Vedeu::Configuration.base_path +
-        "/app/views/templates/#{value}.erb"
+                  "/app/views/templates/#{value}.erb"
     end
 
   end # ApplicationView

data/lib/vedeu/application/controller.rb

@@ -1,18 +1,20 @@
 module Vedeu
 
+  # Provides methods to be used by Vedeu::ApplicationController.
+  #
+  # @api private
   module Controller
 
+    # When included, provide these methods as class methods.
     module ClassMethods
 
+      # @param name [Symbol] The name of the controller.
       def controller_name(name)
-        Vedeu.bind("show_#{name}".to_sym) { self.new }
+        Vedeu.bind("show_#{name}".to_sym) { new }
       end
 
     end # ClassMethods
 
-    module InstanceMethods
-    end # InstanceMethods
-
     # When this module is included in a class, provide ClassMethods as class
     # methods for the class.
     #
@@ -20,7 +22,6 @@ module Vedeu
     # @return [void]
     def self.included(klass)
       klass.send :extend, ClassMethods
-      klass.send :include, InstanceMethods
     end
 
   end # Controller

data/lib/vedeu/application/helper.rb

@@ -1,23 +1,10 @@
 module Vedeu
 
+  # Provides methods to be used by Vedeu::ApplicationHelper.
+  #
+  # @api private
   module Helper
 
-    module ClassMethods
-    end # ClassMethods
-
-    module InstanceMethods
-    end # InstanceMethods
-
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
-    def self.included(klass)
-      klass.send :extend, ClassMethods
-      klass.send :include, InstanceMethods
-    end
-
   end # Helper
 
 end # Vedeu

data/lib/vedeu/application/view.rb

@@ -1,23 +1,10 @@
 module Vedeu
 
+  # Provides methods to be used by Vedeu::ApplicationView.
+  #
+  # @api private
   module View
 
-    module ClassMethods
-    end # ClassMethods
-
-    module InstanceMethods
-    end # InstanceMethods
-
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
-    def self.included(klass)
-      klass.send :extend, ClassMethods
-      klass.send :include, InstanceMethods
-    end
-
   end # View
 
 end # Vedeu

data/lib/vedeu/bindings/all.rb

@@ -0,0 +1,5 @@
+require_relative 'visibility'
+require_relative 'movement'
+require_relative 'menus'
+require_relative 'drb'
+require_relative 'bindings'

data/lib/vedeu/bindings/bindings.rb

@@ -0,0 +1,115 @@
+require_relative 'drb'
+require_relative 'menus'
+require_relative 'movement'
+require_relative 'visibility'
+
+module Vedeu
+
+  # 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: if the name starts with an
+  #   underscore, it's probably used by Vedeu internally.
+  #
+  # @api public
+  module Bindings
+
+    include Vedeu::Bindings::DRB
+    include Vedeu::Bindings::Menus
+    include Vedeu::Bindings::Movement
+    include Vedeu::Bindings::Visibility
+
+    # Vedeu triggers this event when `:_exit_` is triggered. You can hook into
+    # this to perform a special action before the application terminates. Saving
+    # the user's work, session or preferences might be popular here.
+    Vedeu.bind(:_cleanup_) do
+      Vedeu.trigger(:_drb_stop_)
+      Vedeu.trigger(:cleanup)
+    end
+
+    # When triggered, Vedeu will trigger a `:cleanup` event which you can define
+    # (to save files, etc) and attempt to exit.
+    Vedeu.bind(:_exit_) { Vedeu::Application.stop }
+
+    # Vedeu triggers this event when it is ready to enter the main loop. Client
+    # applications can listen for this event and perform some action(s), like
+    # render the first screen, interface or make a sound. When Vedeu triggers
+    # this event, the :_refresh_ event is also triggered automatically.
+    Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+    # Will cause the triggering of the `:key` event; which
+    # you should define to 'do things'. If the `escape` key is pressed, then
+    # `key` is triggered with the argument `:escape`, also an internal event
+    # `_mode_switch_` is triggered.
+    Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
+
+    # Will cause the triggering of the `:command` event; which you should define
+    # to 'do things'.
+    Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
+
+    # When triggered with a message will cause Vedeu to log the message if
+    # logging is enabled in the configuration.
+    Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
+
+    # 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.
+    Vedeu.bind(:_mode_switch_) { fail ModeSwitch }
+
+    # When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_`
+    # events. Please see those events for their behaviour.
+    Vedeu.bind(:_resize_, delay: 0.15) { Vedeu.resize }
+
+    # When triggered will return the current position of the cursor.
+    Vedeu.bind(:_cursor_position_) do |name|
+      Vedeu.cursors.by_name(name).position
+    end
+
+    # When triggered with an interface name will focus that interface and
+    # restore the cursor position and visibility.
+    Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
+
+    # When triggered will focus the next interface and restore the cursor
+    # position and visibility.
+    Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
+
+    # When triggered will focus the previous interface and restore the cursor
+    # position and visibility.
+    Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
+
+    # Clears the whole terminal space, or the named interface area to be cleared
+    # if given.
+    Vedeu.bind(:_clear_) { |name| Vedeu::Clear.by_name(name) }
+
+    # Will cause all interfaces to refresh, or the named interface if given.
+    #
+    # @note
+    #   Hidden interfaces will be still refreshed in memory but not shown.
+    Vedeu.bind(:_refresh_) do |name|
+      name ? Vedeu::Refresh.by_name(name) : Vedeu::Refresh.all
+    end
+
+    # Will cause the named cursor to refresh, or the cursor of the interface
+    # which is currently in focus.
+    Vedeu.bind(:_refresh_cursor_) { |name| Vedeu::RefreshCursor.render(name) }
+
+    # Will cause all interfaces in the named group to refresh.
+    Vedeu.bind(:_refresh_group_) { |name| Vedeu::Refresh.by_group(name) }
+
+    # Clears the spaces occupied by the interfaces belonging to the named group.
+    Vedeu.bind(:_clear_group_) { |name| Vedeu::Clear.by_group(name) }
+
+    # @see Vedeu::Geometry#maximise
+    Vedeu.bind(:_maximise_) { |name| Vedeu.geometries.by_name(name).maximise }
+
+    # @see Vedeu::Geometry#unmaximise
+    Vedeu.bind(:_unmaximise_) do |name|
+      Vedeu.geometries.by_name(name).unmaximise
+    end
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bindings/drb.rb

@@ -0,0 +1,45 @@
+module Vedeu
+
+  module Bindings
+
+    # System events relating to the DRb server implementation.
+    #
+    # @api public
+    module DRB
+
+      # Triggering this event will send input to the running application as long
+      # as it has the DRb server running.
+      Vedeu.bind(:_drb_input_) do |data, type|
+        Vedeu.log(type: :drb, message: "Sending input (#{type})")
+
+        case type
+        when :command then Vedeu.trigger(:_command_, data)
+        else Vedeu.trigger(:_keypress_, data)
+        end
+      end
+
+      Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
+
+      # Triggering this event with 'data' will push data into the running
+      # application's virtual buffer.
+      Vedeu.bind(:_drb_store_output_) do |data|
+        Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
+      end
+
+      # Use the DRb server to request the client application to restart.
+      Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
+
+      # Use the DRb server to request the client application to start.
+      Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
+
+      # Use the DRb server to request the status of the client application.
+      Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
+
+      # Use the DRb server to request the client application to stop.
+      Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
+
+    end # DRB
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bindings/menus.rb

@@ -0,0 +1,53 @@
+module Vedeu
+
+  module Bindings
+
+    # Each of the Bindings::Menus events require a target menu name as an
+    # argument.
+    #
+    # @api public
+    module Menus
+
+      # Makes the last menu item the current menu item.
+      Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
+
+      # Returns the current menu item.
+      Vedeu.bind(:_menu_current_) { |name| Vedeu.menus.find(name).current_item }
+
+      # Deselects all menu items.
+      Vedeu.bind(:_menu_deselect_) do |name|
+        Vedeu.menus.find(name).deselect_item
+      end
+
+      # Returns all the menu items with respective `current` or `selected`
+      # boolean indicators.
+      Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(name).items }
+
+      # Makes the next menu item the current menu item, until it reaches the
+      # last item.
+      Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(name).next_item }
+
+      # Makes the previous menu item the current menu item, until it reaches the
+      # first item.
+      Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
+
+      # Returns the selected menu item.
+      Vedeu.bind(:_menu_selected_) do |name|
+        Vedeu.menus.find(name).selected_item
+      end
+
+      # Makes the current menu item also the selected menu item.
+      Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
+
+      # Makes the first menu item the current menu item.
+      Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(name).top_item }
+
+      # Returns a subset of the menu items; starting at the current item to the
+      # last item.
+      Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
+
+    end # Menus
+
+  end # Bindings
+
+end # Vedeu