vedeu 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2572d8a6656ea1dabfd4fc7ffb4fe69b661d7f1
-  data.tar.gz: 5f682d6d0b7948c52014ce4ab11e390dff755c6c
+  metadata.gz: 95b04552ad105549ad207ff5111b8a524a3295e2
+  data.tar.gz: 501502ff4b2358f6bca2740343581d399512fdc3
 SHA512:
-  metadata.gz: 75e150c79ba83513d5e55310479b76c5c2f4710786d274fd43959814a0659cdeee9385b0d74e86f2444c27a06a083d2e259c7f39ae567eb96d24e1be22c46b3a
-  data.tar.gz: b19de309102aecf1b8ccb88a093b575ae201565de462a57119234c15e7d183581f9841d7e89634ae6d9f91f2a5c533b328c80f0e3096585a9ca52bb664486c44
+  metadata.gz: 53154cedb87837dce360e41dbfd01fc0a7081acb70294dd9ef09bc74618e76cc4937edc66f23607e467987346cc8f00933b1cf4252988b1f96ca747537dc8583
+  data.tar.gz: 9eaaceffc2eae74600586814a726ad512ed0d8f2381380978439cde334ceb393a86803a0810cb5faea4fab2f2742f8eff4ef222cf0cc500a694e74d54a339185

data/lib/vedeu/all.rb

@@ -27,7 +27,6 @@ require 'vedeu/models/toggleable'
 
 require 'vedeu/repositories/collection'
 require 'vedeu/input/keys'
-require 'vedeu/events/event_collection'
 require 'vedeu/repositories/repositories'
 
 require 'vedeu/repositories/model'
@@ -52,13 +51,7 @@ require 'vedeu/geometry/geometries'
 require 'vedeu/geometry/grid'
 require 'vedeu/geometry/position'
 
-require 'vedeu/colours/colours'
-require 'vedeu/colours/backgrounds'
-require 'vedeu/colours/foregrounds'
-require 'vedeu/colours/colour_translator'
-require 'vedeu/colours/background'
-require 'vedeu/colours/foreground'
-require 'vedeu/colours/colour'
+require 'vedeu/colours/all'
 
 require 'vedeu/buffers/buffer'
 require 'vedeu/buffers/buffers'
@@ -90,11 +83,7 @@ require 'vedeu/output/renderers/terminal'
 require 'vedeu/output/renderers/text'
 require 'vedeu/output/renderers'
 
-require 'vedeu/events/event_aliases'
-require 'vedeu/events/trigger'
-require 'vedeu/events/events'
-require 'vedeu/events/event'
-
+require 'vedeu/events/all'
 require 'vedeu/models/views/all'
 
 require 'vedeu/models/cell'

data/lib/vedeu/api.rb

@@ -110,22 +110,22 @@ module Vedeu
     #   Vedeu.unbind(name)
     #
     # @!method bind
-    #   @see Vedeu::Event.bind
+    #   @see Vedeu::Events::Event.bind
     # @!method bound?
-    #   @see Vedeu::Event.bound?
+    #   @see Vedeu::Events::Event.bound?
     # @!method unbind
-    #   @see Vedeu::Event.unbind
-    def_delegators Vedeu::Event, :bind, :bound?, :unbind
+    #   @see Vedeu::Events::Event.unbind
+    def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind
 
     # @example
     #   Vedeu.bind_alias(alias_name, event_name)
     #   Vedeu.unbind_alias(alias_name)
     #
     # @!method bind_alias
-    #   @see Vedeu::EventAliases.bind_alias
+    #   @see Vedeu::Events::Aliases.bind_alias
     # @!method unbind_alias
-    #   @see Vedeu::EventAliases.unbind_alias
-    def_delegators Vedeu::EventAliases, :bind_alias, :unbind_alias
+    #   @see Vedeu::Events::Aliases.unbind_alias
+    def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias
 
     # @example
     #   Vedeu.focus
@@ -205,8 +205,8 @@ module Vedeu
     #   Vedeu.trigger(:name)
     #
     # @!method trigger
-    #   @see Vedeu::Trigger.trigger
-    def_delegators Vedeu::Trigger, :trigger
+    #   @see Vedeu::Events::Trigger.trigger
+    def_delegators Vedeu::Events::Trigger, :trigger
 
     # Exit the client application using Vedeu.
     #

data/lib/vedeu/application/application_view.rb

@@ -27,10 +27,10 @@ module Vedeu
       end
     end
 
-    # @raise [Vedeu::NotImplemented] Subclasses of this class must implement
-    #   this method.
+    # @raise [Vedeu::Error::NotImplemented] Subclasses of this class must
+    #   implement this method.
     def render
-      fail Vedeu::NotImplemented,
+      fail Vedeu::Error::NotImplemented,
            'The subclass of Vedeu::ApplicationView must implement the #render' \
            'method.'
     end
@@ -48,12 +48,10 @@ module Vedeu
     #
     # @param value [String]
     # @return [String]
-    # :nocov:
     def template(value)
       @template = Vedeu::Configuration.base_path +
                   "/app/views/templates/#{value}.erb"
     end
-    # :nocov:
 
   end # ApplicationView
 

data/lib/vedeu/bindings/bindings.rb

@@ -7,6 +7,10 @@ module Vedeu
   #   directly, however the produced events are all public and are highly
   #   recommended to be used.
   #
+  #   Unbinding any of these events is likely to cause problems, so I would
+  #   advise leaving them alone. A safe rule: when the name starts and ends with
+  #   an underscore, it's probably used by Vedeu internally.
+  #
   module Bindings
 
     extend self
@@ -15,7 +19,7 @@ module Vedeu
     #
     # @return [TrueClass]
     def setup!
-      Vedeu::Events.reset!
+      Vedeu::Events::Repository.reset!
 
       Vedeu::Bindings::Application.setup!
       Vedeu::Bindings::Document.setup!

data/lib/vedeu/bindings/focus.rb

@@ -5,11 +5,6 @@ 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: when the name starts with an
-    #   underscore, it's probably used by Vedeu internally.
-    #
     # :nocov:
     module Focus
 

data/lib/vedeu/bindings/refresh.rb

@@ -5,11 +5,6 @@ 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: when the name starts with an
-    #   underscore, it's probably used by Vedeu internally.
-    #
     # :nocov:
     module Refresh
 

data/lib/vedeu/bindings/system.rb

@@ -5,11 +5,6 @@ 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: when the name starts with an
-    #   underscore, it's probably used by Vedeu internally.
-    #
     # :nocov:
     module System
 
@@ -169,7 +164,7 @@ module Vedeu
       #
       # @return [TrueClass]
       def mode_switch!
-        Vedeu.bind(:_mode_switch_) { fail Vedeu::ModeSwitch }
+        Vedeu.bind(:_mode_switch_) { fail Vedeu::Error::ModeSwitch }
       end
 
       # When triggered will cause Vedeu to trigger the `:_clear_` and

data/lib/vedeu/colours/all.rb

@@ -0,0 +1,17 @@
+module Vedeu
+
+  # Provides colour support to Vedeu.
+  #
+  module Colours
+
+  end # Colours
+
+end # Vedeu
+
+require 'vedeu/colours/repository'
+require 'vedeu/colours/backgrounds'
+require 'vedeu/colours/foregrounds'
+require 'vedeu/colours/translator'
+require 'vedeu/colours/background'
+require 'vedeu/colours/foreground'
+require 'vedeu/colours/colour'

data/lib/vedeu/colours/background.rb

@@ -1,32 +1,36 @@
 module Vedeu
 
-  # The class represents one half (the other, can be found at
-  # {Vedeu::Foreground}) of a terminal colour escape sequence.
-  #
-  class Background < Vedeu::ColourTranslator
-
-    private
-
-    # @return [String]
-    def named_codes
-      Vedeu::Esc.background_codes[colour]
-    end
-
-    # @return [String]
-    def numbered_prefix
-      "\e[48;5;"
-    end
-
-    # @return [Vedeu::Backgrounds]
-    def repository
-      Vedeu.background_colours
-    end
-
-    # @return [String]
-    def rgb_prefix
-      "\e[48;2;%s;%s;%sm"
-    end
-
-  end # Background
+  module Colours
+
+    # The class represents one half (the other, can be found at
+    # {Vedeu::Colours::Foreground}) of a terminal colour escape sequence.
+    #
+    class Background < Vedeu::Colours::Translator
+
+      private
+
+      # @return [String]
+      def named_codes
+        Vedeu::Esc.background_codes[colour]
+      end
+
+      # @return [String]
+      def numbered_prefix
+        "\e[48;5;"
+      end
+
+      # @return [Vedeu::Colours::Backgrounds]
+      def repository
+        Vedeu.background_colours
+      end
+
+      # @return [String]
+      def rgb_prefix
+        "\e[48;2;%s;%s;%sm"
+      end
+
+    end # Background
+
+  end # Colours
 
 end # Vedeu

data/lib/vedeu/colours/backgrounds.rb

@@ -1,15 +1,19 @@
 module Vedeu
 
-  # Store background colour escape sequences by HTML/CSS code.
-  #
-  class Backgrounds < Colours
+  module Colours
 
-    # @return [Vedeu::Backgrounds]
-    # @see Vedeu::Repository
-    def self.background_colours
-      @background_colours ||= new
-    end
+    # Store background colour escape sequences by HTML/CSS code.
+    #
+    class Backgrounds < Vedeu::Colours::Repository
 
-  end # Backgrounds
+      # @return [Vedeu::Colours::Backgrounds]
+      # @see Vedeu::Repository
+      def self.background_colours
+        @background_colours ||= new
+      end
+
+    end # Backgrounds
+
+  end # Colours
 
 end # Vedeu

data/lib/vedeu/colours/colour.rb

@@ -1,113 +1,117 @@
 module Vedeu
 
-  # Provides a container for terminal escape sequences controlling the
-  # foreground and background colours of a character or collection of
-  # characters.
-  #
-  # Vedeu uses HTML/CSS style notation (i.e. '#aadd00'), they can be used at the
-  # stream level, the line level or for the whole interface. Terminals generally
-  # support either 8, 16 or 256 colours, with few supporting full 24-bit colour
-  # (see notes below).
-  #
-  # Vedeu attempts to detect the colour depth using the `$TERM` environment
-  # variable.
-  #
-  # To set your `$TERM` variable to allow 256 colour support:
-  #
-  # ```bash
-  # echo "export TERM=xterm-256color" >> ~/.bashrc
-  # ```
-  #
-  # Notes:
-  # Terminals which support the 24-bit colour mode include (but are not limited
-  # to): iTerm2 (OSX), Gnome Terminal (Linux).
-  #
-  # Setting your `$TERM` environment variable as above gets you up to 256
-  # colours, but when you then add the `colour_mode 16_777_216` configuration to
-  # your client application, it's really a hit and miss affair. iTerm2 renders
-  # all the colours correctly as does Gnome Terminal. Terminator (Linux) goes
-  # crazy though and defaults to 16 colours despite the `$TERM` setting. This
-  # area needs more work in Vedeu.
-  #
-  # @todo Fix colours in all terminals. (GL: 2015-04-13)
-  #
-  class Colour
-
-    # @!attribute [r] background
-    # @return [Vedeu::Background]
-    attr_reader :background
-
-    # @!attribute [r] foreground
-    # @return [Vedeu::Foreground]
-    attr_reader :foreground
-
-    # @param value [Vedeu::Colour|Hash<Symbol => void>]
-    # @return [Object]
-    def self.coerce(value)
-      return value if value.is_a?(self)
-      return new unless value.is_a?(Hash)
-
-      if value[:colour] && value[:colour].is_a?(self)
-        value[:colour]
-
-      elsif value[:colour] && value[:colour].is_a?(Hash)
-        new(value[:colour])
-
-      elsif value[:background] || value[:foreground]
-        new(value)
-
-      else
-        new
+  module Colours
 
-      end
-    end
-
-    # Returns a new instance of Vedeu::Colour.
+    # Provides a container for terminal escape sequences controlling the
+    # foreground and background colours of a character or collection of
+    # characters.
     #
-    # @param attributes [Hash]
-    # @option attributes background [String]
-    # @option attributes foreground [String]
-    # @return [Vedeu::Colour]
-    def initialize(attributes = {})
-      @background = Vedeu::Background.coerce(attributes[:background])
-      @foreground = Vedeu::Foreground.coerce(attributes[:foreground])
-    end
-
-    # Converts the value into a Vedeu::Background.
+    # Vedeu uses HTML/CSS style notation (i.e. '#aadd00'), they can be used at
+    # the stream level, the line level or for the whole interface. Terminals
+    # generally support either 8, 16 or 256 colours, with few supporting full
+    # 24-bit colour (see notes below).
     #
-    # @param value [String]
-    # @return [String]
-    def background=(value)
-      @background = Vedeu::Background.coerce(value)
-    end
-
-    # An object is equal when its values are the same.
+    # Vedeu attempts to detect the colour depth using the `$TERM` environment
+    # variable.
+    #
+    # To set your `$TERM` variable to allow 256 colour support:
     #
-    # @param other [Vedeu::Views::Char]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && background == other.background &&
-        foreground == other.foreground
-    end
-    alias_method :==, :eql?
-
-    # Converts the value into a Vedeu::Foreground.
+    # ```bash
+    # echo "export TERM=xterm-256color" >> ~/.bashrc
+    # ```
     #
-    # @param value [String]
-    # @return [String]
-    def foreground=(value)
-      @foreground = Vedeu::Foreground.coerce(value)
-    end
-
-    # Returns both or either of the converted attributes into a single escape
-    # sequence.
+    # Notes:
+    # Terminals which support the 24-bit colour mode include (but are not
+    # limited to): iTerm2 (OSX), Gnome Terminal (Linux).
     #
-    # @return [String]
-    def to_s
-      foreground.to_s + background.to_s
-    end
-    alias_method :to_str, :to_s
+    # Setting your `$TERM` environment variable as above gets you up to 256
+    # colours, but when you then add the `colour_mode 16_777_216` configuration
+    # to your client application, it's really a hit and miss affair. iTerm2
+    # renders all the colours correctly as does Gnome Terminal. Terminator
+    # (Linux) goes crazy though and defaults to 16 colours despite the `$TERM`
+    # setting. This area needs more work in Vedeu.
+    #
+    # @todo Fix colours in all terminals. (GL: 2015-04-13)
+    #
+    class Colour
+
+      # @!attribute [r] background
+      # @return [Vedeu::Colours::Background]
+      attr_reader :background
+
+      # @!attribute [r] foreground
+      # @return [Vedeu::Colours::Foreground]
+      attr_reader :foreground
+
+      # @param value [Vedeu::Colours::Colour|Hash<Symbol => void>]
+      # @return [Object]
+      def self.coerce(value)
+        return value if value.is_a?(self)
+        return new unless value.is_a?(Hash)
+
+        if value[:colour] && value[:colour].is_a?(self)
+          value[:colour]
+
+        elsif value[:colour] && value[:colour].is_a?(Hash)
+          new(value[:colour])
+
+        elsif value[:background] || value[:foreground]
+          new(value)
+
+        else
+          new
+
+        end
+      end
+
+      # Returns a new instance of Vedeu::Colours::Colour.
+      #
+      # @param attributes [Hash]
+      # @option attributes background [String]
+      # @option attributes foreground [String]
+      # @return [Vedeu::Colours::Colour]
+      def initialize(attributes = {})
+        @background = Vedeu::Colours::Background.coerce(attributes[:background])
+        @foreground = Vedeu::Colours::Foreground.coerce(attributes[:foreground])
+      end
+
+      # Converts the value into a Vedeu::Colours::Background.
+      #
+      # @param value [String]
+      # @return [String]
+      def background=(value)
+        @background = Vedeu::Colours::Background.coerce(value)
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Views::Char]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && background == other.background &&
+          foreground == other.foreground
+      end
+      alias_method :==, :eql?
+
+      # Converts the value into a Vedeu::Colours::Foreground.
+      #
+      # @param value [String]
+      # @return [String]
+      def foreground=(value)
+        @foreground = Vedeu::Colours::Foreground.coerce(value)
+      end
+
+      # Returns both or either of the converted attributes into a single escape
+      # sequence.
+      #
+      # @return [String]
+      def to_s
+        foreground.to_s + background.to_s
+      end
+      alias_method :to_str, :to_s
+
+    end # Colour
 
-  end # Colour
+  end # Colours
 
 end # Vedeu