vedeu 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12b0fae6d703370299d64a60380bda994664cf33
-  data.tar.gz: fb74af1f981c87f9bc09df39f5b111c24e4b42b3
+  metadata.gz: 194c0ec69e43bc4197b9cbd3be152b8be8c66ca5
+  data.tar.gz: 58b06a162a3b038247f82d69714e0a8cc601a38d
 SHA512:
-  metadata.gz: 861586738502f76491398375e341d13e6ac35d90d0a04d229760e654ef00fbf3a00d64dea83915fc6c6d9d7d941abf8b013b14eeb6b9e7ccf84c7f0e72c7610e
-  data.tar.gz: cab8c0a2fe8d6fa5612e44199986d24c22b60719568a83aba280ec3a02951049141b507c5fabd9d12c1051e0dda432f3231386741cde6d470da5474e86763d7d
+  metadata.gz: 6438bc4ad946856c2a3f552e8256c9aeb05413d3f8d5d1a055a27fc7d7b88c08eeb1dbbf4d30c7aebd59852cb70b524d868dbbf89742eb64b3694acf41eb34c2
+  data.tar.gz: 8ff06714885c53271469daaa1a0b09825ad2aa1829090e66100c3820f03a7d7d3cca1a72d851f4512f57ea11217401389ecb1b2c9cf02cd586a1dfde18cf6673

data/lib/vedeu.rb

@@ -23,7 +23,7 @@ module Vedeu
 
   # @return [Vedeu::Focus]
   def self.focusable
-    @_focusable ||= Vedeu::Focus
+    @focusable ||= Vedeu::Focus
   end
 
   # When Vedeu is included within one of your classes, you should have all

data/lib/vedeu/all.rb

@@ -7,6 +7,8 @@ require 'vedeu/exceptions'
 
 require 'vedeu/repositories/all'
 
+require 'vedeu/geometry/all'
+
 require 'vedeu/api'
 require 'vedeu/bindings'
 

data/lib/vedeu/buffers/buffer.rb

@@ -38,17 +38,6 @@ module Vedeu
       @repository = repository || Vedeu.buffers
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} ( " \
-      "back?:#{content_for?(:back)} " \
-      "front?:#{content_for?(:front)} " \
-      "previous?:#{content_for?(:previous)} " \
-      ")>"
-    end
-
     # Add the content to the back buffer, then update the repository. Returns
     # boolean indicating that the repository was updated.
     #

data/lib/vedeu/configuration/api.rb

@@ -40,12 +40,10 @@ module Vedeu
       # @return [Hash]
       def configuration
         options.merge!({
-          system_keys: Configuration.default_system_keys.merge(system_keys)
+          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
+        Vedeu::Config.log('API', options)
       end
 
       # Sets boolean to allow user input. The default behaviour of Vedeu is to
@@ -389,7 +387,7 @@ module Vedeu
       #
       # @return [Hash]
       def options
-        @_options ||= {}
+        @options ||= {}
       end
 
       # Returns the system keys set via the configuration API DSL or an empty
@@ -397,7 +395,7 @@ module Vedeu
       #
       # @return [Hash]
       def system_keys
-        @_system_keys ||= {}
+        @system_keys ||= {}
       end
 
       # Checks that the value provided to {#colour_mode} is valid.

data/lib/vedeu/configuration/cli.rb

@@ -121,9 +121,7 @@ module Vedeu
 
         parser.parse!(args)
 
-        options.each do |option, value|
-          Vedeu.log(type: :config, message: "CLI #{option.to_s}: #{value.to_s}")
-        end
+        Vedeu::Config.log('CLI', options)
       end
 
       private

data/lib/vedeu/configuration/configuration.rb

@@ -8,6 +8,21 @@ module Vedeu
   # Namespace for the API configuration and CLI configuration classes.
   #
   module Config
+
+    extend self
+
+    # Custom log for configuration.
+    #
+    # @param from [String] Which configuration set the options ('API' or 'CLI').
+    # @param options [Hash] The configuration options set.
+    # @return [Hash] The options param.
+    def log(from, options)
+      options.each do |option, value|
+        Vedeu.log(type:    :config,
+                  message: "#{from} #{option.to_s}: #{value.to_s}")
+      end
+    end
+
   end
 
   # Allows the customisation of Vedeu's behaviour through the configuration API

data/lib/vedeu/cursor/cursor.rb

@@ -1,6 +1,6 @@
 require 'vedeu/cursor/all'
 require 'vedeu/models/model'
-require 'vedeu/support/position'
+require 'vedeu/geometry/position'
 require 'vedeu/support/visible'
 
 module Vedeu
@@ -41,7 +41,7 @@ module Vedeu
         attributes = { name: attributes }
       end
 
-      @attributes = defaults.merge(attributes)
+      @attributes = defaults.merge!(attributes)
 
       @name       = @attributes.fetch(:name)
       @ox         = @attributes.fetch(:ox)
@@ -54,13 +54,6 @@ module Vedeu
       @position   = Vedeu::Position.new(@y, @x)
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} (#{@name}: x:#{@x} y:#{@y} ox:#{@ox} oy:#{@oy})>"
-    end
-
     # Returns an escape sequence to position the cursor and set its visibility.
     # When passed a block, will position the cursor, yield and return the
     # original position.

data/lib/vedeu/cursor/move_cursor.rb

@@ -1,6 +1,6 @@
 require 'vedeu/cursor/cursor'
-require 'vedeu/support/coordinate'
-require 'vedeu/support/position_validator'
+require 'vedeu/geometry/coordinate'
+require 'vedeu/geometry/position_validator'
 
 module Vedeu
 
@@ -17,19 +17,17 @@ module Vedeu
     def_delegators :geometry, :left,
                               :top,
                               :height,
-                              :width,
-                              :x,
-                              :y
+                              :width
 
     # @param cursor    [Cursor]
     # @param interface [Interface]
     # @param dy        [Fixnum] Move up (-1), or down (1), or no action (0).
     # @param dx        [Fixnum] Move left (-1), or right (1), or no action (0).
     # @return [MoveCursor]
-    def initialize(cursor, interface, dy, dx)
+    def initialize(cursor, interface, dy = 0, dx = 0)
       @cursor    = cursor
-      @dy        = dy
-      @dx        = dx
+      @dy        = dy || 0
+      @dx        = dx || 0
       @interface = interface
     end
 
@@ -76,7 +74,7 @@ module Vedeu
     #
     # @return [Cursor]
     def move
-      Cursor.new(cursor.attributes.merge(moved_attributes)).store
+      Cursor.new(cursor.attributes.merge!(moved_attributes)).store
     end
 
     private

data/lib/vedeu/cursor/toggle_cursor.rb

@@ -34,14 +34,14 @@ module Vedeu
     #
     # @return [Cursor]
     def hide
-      cursor.class.new(cursor.attributes.merge({ state: false })).store
+      cursor.class.new(cursor.attributes.merge!({ state: false })).store
     end
 
     # Shows the cursor.
     #
     # @return [Cursor]
     def show
-      cursor.class.new(cursor.attributes.merge({ state: true })).store
+      cursor.class.new(cursor.attributes.merge!({ state: true })).store
     end
 
     private

data/lib/vedeu/debug.rb

@@ -17,6 +17,9 @@ module Vedeu
 
     File.open('/tmp/' + filename, 'w') do |file|
       RubyProf::CallStackPrinter.new(result).print(file)
+
+      # Used with QTCacheGrind to analyse performance.
+      # RubyProf::CallTreePrinter.new(result).print(file)
     end
   end
 

data/lib/vedeu/distributed/test_application.rb

@@ -1,5 +1,3 @@
-require 'erb'
-
 module Vedeu
 
   # Create a test application as a string.
@@ -45,7 +43,7 @@ module Vedeu
     # @option attributes views [String]
     # @return [TestApplication]
     def initialize(attributes = {})
-      @attributes = defaults.merge(attributes)
+      @attributes = defaults.merge!(attributes)
 
       @attributes.each do |k, v|
         instance_variable_set("@#{k.to_s}", @attributes[k])
@@ -57,9 +55,7 @@ module Vedeu
     def build(&block)
       self.instance_eval(&block) if block_given?
 
-      @object = self
-
-      ERB.new(application, nil, '-').result(binding)
+      Template.parse(self, template)
     end
 
     # @return [String]
@@ -70,8 +66,8 @@ module Vedeu
     private
 
     # @return [String]
-    def application
-      @application ||= read('default_application.vedeu')
+    def template
+      File.dirname(__FILE__) + '/templates/default_application.vedeu'
     end
 
     # @todo Don't like all this file reading.

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

@@ -92,9 +92,7 @@ module Vedeu
             fail InvalidSyntax, 'An invalid value for `key` was encountered.'
           end
 
-          unless model.key_defined?(value)
-            model.add(model.member.build(value, &block))
-          end
+          model.add(model.member.new(value, &block))
         end
       end
 

data/lib/vedeu/dsl/composition.rb

@@ -38,10 +38,10 @@ module Vedeu
 
         new_member = if Vedeu.interfaces.registered?(name)
           existing_member = Vedeu.interfaces.find(name)
-          model.member.build(attributes.merge(existing_member.attributes), &block)
+          model.member.build(attributes.merge!(existing_member.attributes), &block)
 
         else
-          model.member.build(attributes.merge({ name: name }), &block)
+          model.member.build(attributes.merge!({ name: name }), &block)
 
         end
 

data/lib/vedeu/dsl/interface.rb

@@ -39,8 +39,8 @@ module Vedeu
       def border(&block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        border_attrs = attributes.merge({ enabled: true,
-                                          name:    model.name })
+        border_attrs = attributes.merge!({ enabled: true,
+                                           name:    model.name })
 
         Vedeu::Border.build(border_attrs, &block).store
       end

data/lib/vedeu/dsl/shared/text.rb

@@ -54,7 +54,7 @@ module Vedeu
       #   than the specified width.
       # @return [String]
       def text(value = '', options = {})
-        output = Vedeu::Text.with(value, options.merge({ anchor: __callee__ }))
+        output = Vedeu::Text.with(value, options.merge!({ anchor: __callee__ }))
 
         content = if model.is_a?(Vedeu::Interface)
           stream = stream_builder({ value: output })
@@ -94,7 +94,7 @@ module Vedeu
           colour: model.colour,
           parent: model,
           style:  model.style,
-        }.merge(attrs)
+        }.merge!(attrs)
       end
 
     end # Text

data/lib/vedeu/events/event.rb

@@ -278,7 +278,7 @@ module Vedeu
     #
     # @return [Hash]
     def options
-      defaults.merge(@options)
+      defaults.merge!(@options)
     end
 
     # The default values for a new instance of this class.

data/lib/vedeu/geometry/all.rb

@@ -0,0 +1,10 @@
+require 'vedeu/geometry/bounding_area'
+require 'vedeu/geometry/content_geometry'
+require 'vedeu/geometry/coordinate'
+require 'vedeu/geometry/grid'
+require 'vedeu/geometry/limit'
+require 'vedeu/geometry/position'
+require 'vedeu/geometry/position_validator'
+
+module Vedeu
+end # Vedeu

data/lib/vedeu/{support → geometry}/bounding_area.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # Provides coordinates based on the height and width provided.
+  # Coordinates always start from 1, 1.
   #
   class BoundingArea
 

data/lib/vedeu/{support → geometry}/content_geometry.rb

@@ -23,13 +23,6 @@ module Vedeu
       @interface = interface
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} (y:#{y} x:#{x} yn:#{yn} xn:#{xn})>"
-    end
-
     # Returns the height of the content, or when no content, the visible height
     # of the interface.
     #

data/lib/vedeu/{support → geometry}/coordinate.rb

@@ -21,20 +21,6 @@ module Vedeu
       @y      = y
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} ( " \
-        "height:#{height} " \
-        "width:#{width} " \
-        "x:#{x} " \
-        "xn:#{xn} " \
-        "y:#{y} " \
-        "yn:#{yn} " \
-        ")>"
-    end
-
     # Returns the maximum y coordinate for an area.
     #
     # @example

data/lib/vedeu/{support → geometry}/position.rb

@@ -21,6 +21,9 @@ module Vedeu
       elsif value.is_a?(Array)
         new(*value)
 
+      elsif value.is_a?(Hash)
+        new(value.fetch(:y, 1), value.fetch(:x, 1))
+
       else
         # not sure how to proceed
 
@@ -37,11 +40,6 @@ module Vedeu
       @x = (x.nil? || x < 1) ? 1 : x
     end
 
-    # @return [String]
-    def inspect
-      "<#{self.class.name} (y:#{@y} x:#{@x})>"
-    end
-
     # @param other [Vedeu::Position]
     # @return [Boolean]
     def ==(other)

data/lib/vedeu/{support → geometry}/position_validator.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/terminal'
+
 module Vedeu
 
   # Validates that the provided coordinates are within the terminal and

data/lib/vedeu/input/input.rb

@@ -40,7 +40,7 @@ module Vedeu
     #
     # @return [String]
     def input
-      @_input ||= reader.read
+      @input ||= reader.read
     end
 
     # Returns the translated (if possible) keypress(es) as either a String or a

data/lib/vedeu/input/key.rb

@@ -4,19 +4,6 @@ module Vedeu
   #
   class Key
 
-    class << self
-
-      # Creates a new instance of Key.
-      #
-      # @see Vedeu::Key#initialize
-      def build(input = nil, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
-
-        new(input, &block)
-      end
-
-    end
-
     # Returns a new instance of Key.
     #
     # @param input [String|Symbol]