vedeu 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab3b3e107a170520a384cb15529a6cb087b6aae
-  data.tar.gz: 96170b0362f0584f7ce527290cf3068bb2fe26bf
+  metadata.gz: d92eea450aa078936ad63e48458e87bffc1b94ef
+  data.tar.gz: 7b58b5c6c47151c7635971abc608b7951e1cfa77
 SHA512:
-  metadata.gz: 08584d6388fbac9ee09e678a22362aaff1028cbd547b3583dad82c67ae8cfb790989066412bc9de4ca0ff800127f7c5fd7a3f36281ee7329c0c04e6eec1ff574
-  data.tar.gz: 96a95d7eca4e92b3794eb96e3183fb75b908e74ea77aff7f561051ee37aac9ec2dd057e128c27e4acec3815c0c3bf0079cf4c8fc6fe312b59845cf639730a9a5
+  metadata.gz: 9363fca14b44becccaa8b29c32185175270e1ae9769d9ec0410db5c71a48cfcb199e3797e79a7bca7b4771743225641aeb44462bfe1d9c7205f3e2e06d215382
+  data.tar.gz: da6d294f0a25f2b010972e6cdcee7ec8a3fe8b3cadf21cc28f34d6f602d1ff73e2a7c11aa03df2f3d2d0e2cf478af48812cca6f34e494eebff76fa2d7029c2cd

data/.gitignore

@@ -19,4 +19,6 @@ tmp
 .gemtags
 .tags
 .tags_sorted_by_file
-logs/vedeu.log
+logs/vedeu.log
+vedeu.sublime-project
+vedeu.sublime-workspace

data/LICENSE.txt

@@ -1,6 +1,11 @@
 Copyright (c) 2014 Gavin Laking
 Copyright (c) 2013 Steve Klabnik - Monologger
                    (https://github.com/steveklabnik/mono_logger)
+                   Note: Code used inline in Vedeu::Log.
+Copyright (c) 2013 Michael Grosser - Ruco
+                   (https://github.com/grosser/ruco)
+                   Note: Code from ruco's Window class was used as basis of
+                     Vedeu::Viewport.
 
 MIT License
 

data/bin/vedeu

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 -> { its -> { a } }
 trap('INT') { exit! }

data/docs/api.md

@@ -60,6 +60,7 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
 
 - interface
   - centred (or centred!)
+  - cursor
   - colour
   - delay
   - group
@@ -79,6 +80,7 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
     - view
   - view
     - colour
+    - cursor
     - line
       - background
       - colour

data/examples/cursor_app/cursor_app.rb

@@ -11,16 +11,26 @@ require 'vedeu'
 class VedeuCursorApp
   include Vedeu
 
-  event(:_initialize_) { trigger(:_refresh_) }
+  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'iron' do
+    cursor  true
     centred true
     colour  foreground: '#ff0000', background: '#000000'
     height  4
     width   15
+
+    # provide 'vim' direction keys
+    keys do
+      key('k') { Vedeu.trigger(:_cursor_up_)    }
+      key('l') { Vedeu.trigger(:_cursor_right_) }
+      key('j') { Vedeu.trigger(:_cursor_down_)  }
+      key('h') { Vedeu.trigger(:_cursor_left_)  }
+    end
   end
 
   interface 'gold' do
+    cursor false
     colour foreground: '#00ff00', background: '#001100'
     height 4
     width  15
@@ -29,14 +39,12 @@ class VedeuCursorApp
   end
 
   keys do
-    key(:up)    { trigger(:_cursor_up_)    }
-    key(:right) { trigger(:_cursor_right_) }
-    key(:down)  { trigger(:_cursor_down_)  }
-    key(:left)  { trigger(:_cursor_left_)  }
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
   end
 
-  focus('iron')
-
   render do
     view 'iron' do
       line do
@@ -87,8 +95,15 @@ class VedeuCursorApp
         end
       end
     end
+
+    view 'gold' do
+      cursor false
+      line 'Cursor: '
+    end
   end
 
+  focus('iron') # not working right?!
+
   def self.start
     Vedeu::Launcher.new(['--debug']).execute!
   end

data/examples/hello_world.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+trap('INT') { exit! }
+
+# require 'bundler/setup' # uncomment to remove the need to do `bundle exec`.
+require 'vedeu'
+
+class HelloWorldApp
+  include Vedeu
+
+  configure do
+    debug!
+    log '/tmp/hello_world_vedeu.log'
+  end
+
+  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  interface 'messages' do
+    background '#000000'
+    centred!
+    foreground '#00ff00'
+    height     3
+    width      20
+  end
+
+  render do
+    view 'messages' do
+      line '    Hello World!'
+      line
+      line " Press 'q' to exit. "
+    end
+  end
+
+  def self.start
+    Vedeu::Launcher.execute!(ARGV)
+  end
+end
+
+HelloWorldApp.start

data/lib/vedeu.rb

@@ -36,6 +36,8 @@ require 'vedeu/configuration/configuration'
 require 'vedeu/support/log'
 require 'vedeu/support/trace'
 
+require 'vedeu/models/keymap'
+require 'vedeu/api/keymap'
 require 'vedeu/api/api'
 
 require 'vedeu/support/coercions'
@@ -56,7 +58,7 @@ require 'vedeu/models/colour'
 require 'vedeu/models/style'
 require 'vedeu/models/interface'
 require 'vedeu/models/cursor'
-require 'vedeu/models/keymap'
+
 require 'vedeu/models/char'
 require 'vedeu/models/line'
 require 'vedeu/models/stream'
@@ -68,12 +70,12 @@ require 'vedeu/api/defined'
 require 'vedeu/api/composition'
 require 'vedeu/api/helpers'
 require 'vedeu/api/interface'
-require 'vedeu/api/keymap'
 require 'vedeu/api/line'
 require 'vedeu/api/menu'
 require 'vedeu/api/stream'
 
 require 'vedeu/support/keymap_validator'
+require 'vedeu/repositories/positional'
 require 'vedeu/repositories/offsets'
 require 'vedeu/repositories/menus'
 require 'vedeu/repositories/keymaps'
@@ -85,18 +87,16 @@ require 'vedeu/repositories/buffers'
 require 'vedeu/repositories/cursors'
 
 require 'vedeu/support/registrar'
+require 'vedeu/support/refresh'
 
-require 'vedeu/output/area'
 require 'vedeu/output/clear'
 require 'vedeu/output/compositor'
-require 'vedeu/output/refresh'
 require 'vedeu/output/render'
 require 'vedeu/output/view'
 require 'vedeu/output/viewport'
 
 require 'vedeu/support/grid'
 require 'vedeu/support/menu'
-require 'vedeu/support/move'
 
 require 'vedeu/input/input'
 

data/lib/vedeu/api/api.rb

@@ -6,6 +6,10 @@ module Vedeu
   # @api public
   module API
 
+    extend Forwardable
+
+    def_delegators Keymap, :keys
+
     # Configure Vedeu using a simple configuration DSL.
     #
     # @param block [Proc]
@@ -119,6 +123,8 @@ module Vedeu
 
     # Simulate a keypress.
     #
+    # @todo Replace with: def_delegators Keymaps, :keypress
+    #
     # @example
     #   Vedeu.keypress('s')
     #
@@ -127,38 +133,6 @@ module Vedeu
       Vedeu::Keymaps.use(key)
     end
 
-    # Define actions for keypresses for when specific interfaces are in focus.
-    # Unless an interface is specified, the key will be assumed to be global,
-    # meaning its action will happen regardless of the interface in focus.
-    #
-    # @api public
-    # @param name_or_names [String] The name or names of the interface(s) which
-    #   will handle these keys.
-    # @param block [Proc]
-    #
-    # @example
-    #   keys do                    # => will be global
-    #     key('s') { :something }
-    #     ...
-    #
-    #   keys 'my_interface' do     # => will only function when 'my_interface'
-    #     ...                      #    is in focus
-    #
-    #   keys('main', 'other') do   # => will function for both 'main' and
-    #     ...                      #    'other' interfaces
-    #
-    #   keys do
-    #     interface 'my_interface' # => will only function when 'my_interface'
-    #     ...                      #    is in focus
-    #
-    # @raise [InvalidSyntax] When the required block is not given.
-    # @return [API::Keymap]
-    def keys(*name_or_names, &block)
-      fail InvalidSyntax, '`keys` requires a block.' unless block_given?
-
-      API::Keymap.define({ interfaces: name_or_names }, &block)
-    end
-
     # Write a message to the Vedeu log file located at `$HOME/.vedeu/vedeu.log`
     #
     # @param message [String] The message you wish to emit to the log
@@ -214,6 +188,10 @@ module Vedeu
     #       view 'my_interface' do
     #         ...
     #
+    #   Vedeu.render do
+    #     view 'my_interface' do
+    #       ...
+    #
     # @raise [InvalidSyntax] When the required block is not given.
     # @return [Array] A collection of strings, each defining containing the
     #   escape sequences and content. This data has already been sent to the
@@ -294,6 +272,11 @@ module Vedeu
 
     # Instruct Vedeu to treat contents of block as a single composition.
     #
+    # @note The views declared within this block are stored in their respective
+    #   interface back buffers until a refresh event occurs. When the refresh
+    #   event is triggered, the back buffers are swapped into the front buffers
+    #   and the content here will be rendered to {Terminal.output}.
+    #
     # @param block [Proc] Instructs Vedeu to treat all of the 'view' directives
     #   therein as one instruction. Useful for redrawing multiple interfaces at
     #   once.
@@ -314,7 +297,7 @@ module Vedeu
     #   ...
     #
     # @raise [InvalidSyntax] When the required block is not given.
-    # @return [Hash]
+    # @return [Array]
     def views(&block)
       fail InvalidSyntax, '`views` requires a block.' unless block_given?
 

data/lib/vedeu/api/helpers.rb

@@ -8,6 +8,50 @@ module Vedeu
     # @api public
     module Helpers
 
+      include Common
+
+      # Define the background colour for an interface, line, or a stream. When
+      # called with a block, will create a new stream with the background colour
+      # specified; see {Vedeu::API::Stream} for directives which are valid
+      # within the block. When the block terminates, the background will return
+      # to that of the parent.
+      #
+      # @param value [String]
+      # @param block [Proc]
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     background '#0022ff'
+      #     ...
+      #
+      #   line do
+      #     background '#0022ff'
+      #     ...
+      #
+      #   stream do
+      #     background '#0022ff'
+      #     ...
+      #
+      #   foreground('#0022ff') { 'This will be blue.' }
+      #
+      # @raise [InvalidSyntax] When the value is not defined.
+      # @return [Hash]
+      def background(value = '', &block)
+        unless defined_value?(value)
+          fail InvalidSyntax, '`background` requires a value.'
+        end
+
+        if block_given?
+          attributes[:streams] << API::Stream
+            .build({ colour: { background: value },
+                     parent: self.view_attributes }, &block)
+
+        else
+          attributes[:colour].merge!({ background: value })
+
+        end
+      end
+
       # Define either or both foreground and background colours for an
       # interface, line or a stream.
       #
@@ -38,6 +82,48 @@ module Vedeu
         attributes[:colour] = values
       end
 
+      # Define the foreground colour for an interface, line, or a stream. When
+      # called with a block, will create a new stream with the foreground colour
+      # specified; see {Vedeu::API::Stream} for directives which are valid
+      # within the block. When the block terminates, the foreground will return
+      # to that of the parent.
+      #
+      # @param value [String]
+      # @param block [Proc]
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     foreground '#0022ff'
+      #     ...
+      #
+      #   line do
+      #     foreground '#0022ff'
+      #     ...
+      #
+      #   stream do
+      #     foreground '#0022ff'
+      #     ...
+      #
+      #   foreground('#0022ff') { 'This will be blue.' }
+      #
+      # @raise [InvalidSyntax] When the value is not defined.
+      # @return [Hash]
+      def foreground(value = '', &block)
+        unless defined_value?(value)
+          fail InvalidSyntax, '`foreground` requires a value.'
+        end
+
+        if block_given?
+          attributes[:streams] << API::Stream
+            .build({ colour: { foreground: value },
+                     parent: self.view_attributes }, &block)
+
+        else
+          attributes[:colour].merge!({ foreground: value })
+
+        end
+      end
+
       # Define a style or styles for an interface, line or a stream.
       #
       # @param values [Array|String]

data/lib/vedeu/api/interface.rb

@@ -23,24 +23,54 @@ module Vedeu
       #     centred false
       #     ...
       #
-      # @return [API::Interface]
+      # @return [Boolean]
       def centred(value = true)
         attributes[:geometry][:centred] = !!(value)
       end
       alias_method :centred!, :centred
 
+      # Set the cursor visibility on an interface or view.
+      #
+      # @param value [Boolean] Any value other than nil or false will evaluate
+      #   to true.
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     cursor true
+      #     ...
+      #
+      #   view 'my_interface' do
+      #     cursor true
+      #     ...
+      #
+      # @return [Symbol]
+      def cursor(value = true)
+        attributes[:cursor] = if !!value
+          :show
+
+        else
+          :hide
+
+        end
+      end
+
       # To maintain performance interfaces can be delayed from refreshing too
       # often, the reduces artefacts particularly when resizing the terminal
       # screen.
       #
       # @param value [Fixnum|Float]
       #
-      # @return [API::Interface]
+      # @example
+      #   interface 'my_interface' do
+      #     delay 0.5 # interface will not update more often than every 500ms.
+      #     ...
+      #
+      # @return [Fixnum|Float]
       def delay(value)
         attributes[:delay] = value
       end
 
-      # Define a group for an interface. Interfaces of the same group can be
+      # Specify a group for an interface. Interfaces of the same group can be
       # targetted together; for example you may want to refresh multiple
       # interfaces at once.
       #
@@ -51,12 +81,12 @@ module Vedeu
       #     group 'main_screen'
       #     ...
       #
-      # @return [API::Interface]
+      # @return [String]
       def group(value)
         attributes[:group] = value
       end
 
-      # Define the number of characters/rows/lines tall the interface will be.
+      # Specify the number of characters/rows/lines tall the interface will be.
       #
       # @param value [Fixnum]
       #
@@ -65,14 +95,19 @@ module Vedeu
       #     height 8
       #     ...
       #
-      # @return [API::Interface]
+      # @return [Fixnum]
       def height(value)
         Vedeu.log(out_of_bounds('height')) if y_out_of_bounds?(value)
 
         attributes[:geometry][:height] = value
       end
 
-      # Define a single line in a view.
+      # @see Vedeu::API#keys
+      def keys(&block)
+        Keymap.keys(attributes[:name], &block)
+      end
+
+      # Specify a single line in a view.
       #
       # @param value [String]
       # @param block [Proc]
@@ -85,11 +120,11 @@ module Vedeu
       #
       #   view 'my_interface' do
       #     line do
-      #       ... some line attributes ...
+      #       ... see {API::Line} and {API::Stream}
       #     end
       #   end
       #
-      # @return [API::Interface]
+      # @return [API::Line]
       def line(value = '', &block)
         if block_given?
           attributes[:lines] << API::Line
@@ -112,13 +147,21 @@ module Vedeu
       #     name 'my_interface'
       #     ...
       #
-      # @return [API::Interface]
+      # @return [String]
       def name(value)
         attributes[:name] = value
       end
 
       # Use the specified interface; useful for sharing attributes with other
-      # interfaces.
+      # interfaces. Any public method of #{Vedeu::Interface} is available.
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     use('my_other_interface').width # use the width of another interface
+      #     ...
+      #
+      #   Vedeu.use('my_other_interface').width # can be used in your code to
+      #                                         # get this value
       #
       # @param value [String]
       # @see Vedeu::API#use
@@ -126,7 +169,7 @@ module Vedeu
         Vedeu.use(value)
       end
 
-      # Define the number of characters/columns wide the interface will be.
+      # Specify the number of characters/columns wide the interface will be.
       #
       # @param value [Fixnum]
       #
@@ -135,14 +178,14 @@ module Vedeu
       #     width 25
       #     ...
       #
-      # @return [API::Interface]
+      # @return [Fixnum]
       def width(value)
         Vedeu.log(out_of_bounds('width')) if x_out_of_bounds?(value)
 
         attributes[:geometry][:width] = value
       end
 
-      # Define the starting x position (column) of the interface.
+      # Specify the starting x position (column) of the interface.
       #
       # @param value [Fixnum]
       # @param block [Proc]
@@ -156,7 +199,7 @@ module Vedeu
       #                                    # `my_interface` changes position,
       #                                    # `other_interface` will too.
       #
-      # @return [API::Interface]
+      # @return [Fixnum]
       def x(value = 0, &block)
         return attributes[:geometry][:x] = block if block_given?
 
@@ -165,7 +208,7 @@ module Vedeu
         attributes[:geometry][:x] = value
       end
 
-      # Define the starting y position (row/line) of the interface.
+      # Specify the starting y position (row/line) of the interface.
       #
       # @param value [Fixnum]
       # @param block [Proc]
@@ -180,7 +223,7 @@ module Vedeu
       #     ...                              # `my_interface` changes position,
       #                                      # `other_interface` will too.
       #
-      # @return [API::Interface]
+      # @return [Fixnum]
       def y(value = 0, &block)
         return attributes[:geometry][:y] = block if block_given?