vedeu 0.4.40 → 0.4.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f097662b914c6da5ad5928cf49ed800854dc0062
-  data.tar.gz: ee5e7fc8f279cc4613ae8f1b7df48dd4fb8515bd
+  metadata.gz: d5bade3d3d45fdc2dd04f64bacfe2e42350b5b98
+  data.tar.gz: a4f39d6b2625bb378ce2b84d5b7f16c3f2cd5529
 SHA512:
-  metadata.gz: c6faaf146d5888abee75910a14b5c3dd1846a738c7d77b19efe2b4d17b4cdf3747ac2f4db03cd48a0bd7b9131516efe5b135487d6be569f132bcdfba0f7107a6
-  data.tar.gz: 522fd6ec674864207e9244bb8bbb48c9b35fb8c9db218391b195b7481476e7f4d0b32f14cbf0585a7c469db303249ab5b7f1581e9069889782ed5168093d2b66
+  metadata.gz: 43b4cf698da18c2ac3579730abcf18ad1bd9bb013048aa0a0c8542987b324196e52294e599771cd6da7bf62aa61b5d2c557dc95501576efc0f724f0a39c56ba9
+  data.tar.gz: 5ea2e7f70d2b77fb389d94f6eba5d2c2413bd12ff158a97f8d0f62ef7fd947cc1a3ba9adee689feef3c62e34aa86f8ff7b8a7a79e41ba3681cd521fe23fc7c11

data/Dockerfile

@@ -3,32 +3,38 @@ MAINTAINER Gavin Laking <gavinlaking@gmail.com>
 
 # Build dependencies
 RUN apt-get update && apt-get install -y --force-yes \
-    software-properties-common \
+    autoconf \
+    automake \
+    bison \
     build-essential \
-    openssl \
     ca-certificates \
-    git-core \
-    autoconf \
+    curl \
     gawk \
-    libreadline-dev \
-    libyaml-dev \
+    git-core \
+    libffi-dev \
     libgdbm-dev \
     libncurses5-dev \
-    automake \
+    libreadline-dev \
+    libssl-dev \
     libtool \
-    bison \
+    libxml2-dev \
+    libxslt-dev \
+    libyaml-dev \
+    make \
+    openssl \
     pkg-config \
-    curl \
-    wget \
+    software-properties-common \
     vim \
-    libxslt-dev \
-    libxml2-dev \
-    libffi-dev \
-    libssl-dev \
-    zlib1g-dev \
-    make
+    wget \
+    zlib1g-dev
+
 RUN apt-get clean -y && apt-get autoremove -y
 
+# Create a fake home directory
+RUN usr/sbin/useradd --create-home --home-dir /home/vedeu --shell /bin/bash vedeu
+RUN mkdir /home/vedeu/gem
+RUN chown -R vedeu:vedeu /home/vedeu
+
 # Chruby
 RUN wget -O chruby-0.3.9.tar.gz https://github.com/postmodern/chruby/archive/v0.3.9.tar.gz
 RUN tar -xzvf chruby-0.3.9.tar.gz && cd chruby-0.3.9/ && make install
@@ -39,6 +45,7 @@ RUN tar -xzvf ruby-install-0.5.0.tar.gz && cd ruby-install-0.5.0/ && make instal
 
 # Install Ruby 2.2.2
 RUN ruby-install ruby 2.2.2
+RUN chown -R vedeu:vedeu /opt/rubies
 
 # Setup Chruby
 RUN echo '[ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ] || return' >> /etc/profile.d/chruby.sh
@@ -50,20 +57,8 @@ RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:ver
 # Setup PATH
 ENV PATH /opt/rubies/ruby-2.2.2/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/vedeu/gem/bin
 
-# Get ruby version
-RUN ruby -v
-
-# Create a fake home directory
-RUN usr/sbin/useradd --create-home --home-dir /home/vedeu --shell /bin/bash vedeu
-
-# Make files
-RUN mkdir /home/vedeu/gem
-RUN chown -R vedeu:vedeu /home/vedeu
-RUN chown -R vedeu:vedeu /opt/rubies
 RUN gem install bundler
 
-# VOLUME .:/home/vedeu/gem
-
 ADD . /home/vedeu/gem/
 WORKDIR /home/vedeu
 USER vedeu

data/Guardfile

@@ -1,11 +1,3 @@
-# guard 'cucumber' do
-#   watch(%r{^features/.+\.feature$})
-#   watch(%r{^features/support/.+$}) { 'features' }
-#   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
-#     Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
-#   end
-# end
-
 guard :minitest, all_after_pass: true,
                  focus_on_failed: true,
                  env: { 'no_simplecov' => true } do

data/Rakefile

@@ -1,15 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-# require 'cucumber'
-# require 'cucumber/rake/task'
 require 'inch/rake'
 require 'yard'
 require 'rubocop/rake_task'
 
-# Cucumber::Rake::Task.new(:cucumber) do |t|
-#   t.cucumber_opts = 'features --format progress'
-# end
-
 Rake::TestTask.new(:test) do |t|
   t.libs.push 'lib'
   t.libs.push 'test'

data/docs/applications.md

@@ -19,7 +19,6 @@ hopefully these generators will get you off the ground.
     |   |- models/
     |   |   |- keymaps/
     |   |       |- _global_.rb
-    |   |       |- _system_.rb
     |   |
     |   |- views/
     |       |- interfaces/

data/docs/dsl.md

@@ -6,7 +6,7 @@ Coupled with the API (for interacting with the running client application), the
 
 An Interface is a basic element in the GUI. It usually but does not necessarily
 correspond to a region of the terminal screen (for example, an Interface might
-not be displayed at certain points in an application life cycle). 
+not be displayed at certain points in an application life cycle).
 
 Much of the behavior of an Interface comes from child objects that are defined
 under the Interface. These objects are described in more detail in their
@@ -23,16 +23,16 @@ interface 'main' do
          background: '#000033'  # and background colors
   group 'general' # set interface group
 
-  geometry do 
+  geometry do
     # size and position details
   end
-  border do 
+  border do
     # border properties
   end
-  keymap do 
+  keymap do
     # keymap that is in effect when this interface is focused
   end
-  views do 
+  views do
     # details about how to render the interface
   end
 end
@@ -46,9 +46,9 @@ an `interface` block or explicitly, by passing the interface name as a first
 argument to the declaration.
 
 That is, these are equivalent ways to declare a Geometry for an existing
-interface 
+interface
 
-```ruby 
+```ruby
 interface 'main' do
   geometry do
     # some geometry
@@ -130,11 +130,6 @@ Interfaces can be configured to be part of a named group. Once an interface is a
 
 ### 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

data/examples/borders_app.rb

@@ -168,6 +168,11 @@ class VedeuBordersApp
 
   keymap '_global_' do
     key('r') { Vedeu.trigger(:_refresh_) }
+
+    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
 
   # Borders can be defined as part of a view (see below), or standalone.

data/examples/configuration_app.rb

@@ -47,6 +47,11 @@ class VedeuConfigurationApp
 
   keymap('config') do
     key(' ') { Vedeu.trigger(:_refresh_, 'config') }
+
+    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
 
   def self.start(argv = ARGV)

data/examples/drb_app.rb

@@ -81,6 +81,11 @@ class VedeuTestApplication
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { 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.menu 'test_interface' do

data/examples/geometry_app.rb

@@ -52,6 +52,11 @@ class VedeuGeometryApp
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { 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
 
   renders do

data/examples/material_colours_app.rb

@@ -64,6 +64,11 @@ class VedeuMaterialColoursApp
     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_) }
+
     key('a') { Vedeu.trigger(:_view_left_, 'main_interface')  }
     key('s') { Vedeu.trigger(:_view_down_, 'main_interface')  }
     key('d') { Vedeu.trigger(:_view_up_, 'main_interface')    }

data/examples/panel_app.rb

@@ -44,6 +44,11 @@ class VedeuPanelApp
     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
 
   renders do

data/examples/typed_commands/typed_commands_app.rb

@@ -38,6 +38,11 @@ class VedeuTypedCommands
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { 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
 
   border('output') do

data/examples/view_templates_app/view_templates_app.rb

@@ -35,6 +35,11 @@ class VedeuViewTemplateApp
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { 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.border('default') do

data/lib/vedeu/api.rb

@@ -34,8 +34,8 @@ module Vedeu
     module_function
 
     # @!method background_colours
-    #   @see Vedeu::BackgroundColours.background_colours
-    def_delegators Vedeu::BackgroundColours, :background_colours
+    #   @see Vedeu::Backgrounds.background_colours
+    def_delegators Vedeu::Backgrounds, :background_colours
 
     # @!method borders
     #   @see Vedeu::Borders.borders
@@ -88,8 +88,8 @@ module Vedeu
     def_delegators Vedeu::Event, :bind, :unbind
 
     # @!method events
-    #   @see Vedeu::EventsRepository.events
-    def_delegators Vedeu::EventsRepository, :events
+    #   @see Vedeu::Events.events
+    def_delegators Vedeu::Events, :events
 
     # @!method focus
     #   @see Vedeu::Focus#focus
@@ -105,8 +105,8 @@ module Vedeu
                    :focus_next, :focus_previous
 
     # @!method foreground_colours
-    #   @see Vedeu::ForegroundColours.foreground_colours
-    def_delegators Vedeu::ForegroundColours, :foreground_colours
+    #   @see Vedeu::Foregrounds.foreground_colours
+    def_delegators Vedeu::Foregrounds, :foreground_colours
 
     # @!method geometries
     #   @see Vedeu::Geometries.geometries
@@ -117,8 +117,8 @@ module Vedeu
     def_delegators Vedeu::Groups, :groups
 
     # @!method interfaces
-    #   @see Vedeu::InterfacesRepository.interfaces
-    def_delegators Vedeu::InterfacesRepository, :interfaces
+    #   @see Vedeu::Interfaces.interfaces
+    def_delegators Vedeu::Interfaces, :interfaces
 
     # @!method keymaps
     #   @see Vedeu::Keymaps.keymaps

data/lib/vedeu/application/all.rb

@@ -1,3 +1,6 @@
+require_relative 'controller'
+require_relative 'helper'
+require_relative 'view'
 require_relative 'application_controller'
 require_relative 'application_helper'
 require_relative 'application_view'

data/lib/vedeu/application/application_controller.rb

@@ -1,3 +1,5 @@
+require_relative 'controller'
+
 module Vedeu
 
   # Provides methods which should be available to all client application
@@ -6,6 +8,8 @@ module Vedeu
   # @api private
   class ApplicationController
 
+    include Vedeu::Controller
+
   end # ApplicationController
 
 end # Vedeu

data/lib/vedeu/application/application_helper.rb

@@ -1,3 +1,5 @@
+require_relative 'helper'
+
 module Vedeu
 
   # Provides methods which should be available to all client application
@@ -6,6 +8,8 @@ module Vedeu
   # @api private
   module ApplicationHelper
 
+    include Vedeu::Helper
+
   end # ApplicationHelper
 
 end # Vedeu

data/lib/vedeu/application/application_view.rb

@@ -1,3 +1,5 @@
+require_relative 'view'
+
 module Vedeu
 
   # Provides the mechanism to render views for the client application.
@@ -5,6 +7,8 @@ module Vedeu
   # @api private
   class ApplicationView
 
+    include Vedeu::View
+
     # Renders the view.
     #
     # @param object [void]
@@ -13,6 +17,8 @@ module Vedeu
       new(object).render
     end
 
+    # Returns a new instance of Vedeu::ApplicationView.
+    #
     # @param object [void]
     # @return [Vedeu::ApplicationView]
     def initialize(object = nil)

data/lib/vedeu/application/controller.rb

@@ -0,0 +1,23 @@
+module Vedeu
+
+  module Controller
+
+    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 # Controller
+
+end # Vedeu

data/lib/vedeu/application/helper.rb

@@ -0,0 +1,23 @@
+module Vedeu
+
+  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

@@ -0,0 +1,23 @@
+module Vedeu
+
+  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/application.rb

@@ -52,15 +52,13 @@ module Vedeu
     def start
       Vedeu.trigger(:_drb_start_)
 
-      output = Vedeu::Terminal.open do
+      Vedeu::Terminal.open do
         Vedeu::Terminal.set_cursor_mode
 
         Vedeu.trigger(:_initialize_)
 
         runner { main_sequence }
       end
-
-      output
     end
 
     protected