vedeu 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 522afbcf7e2a24c1059b645ad484d1508f665c89
-  data.tar.gz: 33f8e2f388e083fc3f2e18638ced642692047b62
+  metadata.gz: 2990a71171d7d18e057affb7e509d13267efbcfb
+  data.tar.gz: 65566020c8f8fa0a069bcf3d8ebff832e5ac378d
 SHA512:
-  metadata.gz: 03e7507a1f364b8c5c6c236a98a7a48ca5a86ac2985f1f3856af4ba9e314eafa546e3a02c7e861182a665c14d69e290fc8f87496c32da1bdb2718dece6cd8c33
-  data.tar.gz: 96249c16c65ca1b929e2d0b20a1e1330902338fc3cf04fede864918760bbcefc41b511634c14318624ba750a0669b3d6c865ae69891696fd47685c04578208d5
+  metadata.gz: c2a5b89fc277c8200f574717dd643c2c9b1b689f15f9a913a13ad67ac6f275fa4c7755493eb7452022a53e0941bb97574bdf2e692a1bbdabb93001a2d9a5e674
+  data.tar.gz: a1259cc57c8a5425171af9f16707ea73daa66e709e71dc5ea78ce3d9af756976d55aa8cb3b659cab92469edd1896174ce948984b1e4cda4fc529221d34a24f61

data/examples/borders_app.rb

@@ -164,10 +164,23 @@ class VedeuBordersApp
     key('r') { Vedeu.trigger(:_refresh_) }
   end
 
+  # Borders can be defined as part of a view (see below), or standalone.
+  border 'no_bottom' do
+    show_bottom false
+  end
+  border 'no_left' do
+    show_left false
+  end
+  border 'no_right' do
+    show_right false
+  end
+  border 'no_top' do
+    show_top false
+  end
+
   renders do
     view('default_border') do
-      border do
-      end
+      border!
       lines do
         line 'on'
       end
@@ -178,33 +191,21 @@ class VedeuBordersApp
       end
     end
     view('no_top') do
-      border do
-        show_top false
-      end
       lines do
         line 'no t'
       end
     end
     view('no_bottom') do
-      border do
-        show_bottom false
-      end
       lines do
         line 'no b'
       end
     end
     view('no_left') do
-      border do
-        show_left false
-      end
       lines do
         line 'no l'
       end
     end
     view('no_right') do
-      border do
-        show_right false
-      end
       lines do
         line 'no r'
       end

data/examples/colours_app.rb

@@ -20,8 +20,6 @@ class VedeuColoursApp
   bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'colours' do
-    border do
-    end
     geometry do
       centred!
       height 8
@@ -32,6 +30,7 @@ class VedeuColoursApp
 
   renders do
     view('colours') do
+      border!
       lines do
 
       end

data/examples/cursor_app.rb

@@ -20,12 +20,8 @@ class VedeuCursorApp
   bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'main_interface' do
-    border do
-      # adds default border
-    end
-
-    cursor true
     colour foreground: '#ff0000', background: '#000000'
+    cursor!
 
     geometry do
       centred true
@@ -43,6 +39,7 @@ class VedeuCursorApp
 
   renders do
     view 'main_interface' do
+      border!
       lines do
         streams do
           text 'A.3456789 '

data/examples/geometry_app.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+-> { its -> { a } }
+trap('INT') { exit! }
+
+require 'vedeu'
+
+class VedeuGeometryApp
+  include Vedeu
+
+  configure do
+    colour_mode 16777216
+    debug!
+    log '/tmp/vedeu_geometry_app.log'
+  end
+
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  interface 'main_interface' do
+    colour foreground: '#ff0000', background: '#000000'
+    cursor!
+
+    # Geometry can be defined within the interface.
+    geometry do
+      height  8
+      width   8
+      x       2
+      y       2
+    end
+  end
+
+  interface 'second' do
+    colour foreground: '#0000ff', background: '#000000'
+    cursor!
+  end
+
+  # Geometry can be defined either before or after the interface.
+  geometry 'second' do
+    height  8
+    width   8
+    x       12
+    y       2
+  end
+
+  keymap('_global_') do
+    key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
+    key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
+    key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
+    key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
+  end
+
+  renders do
+    view 'second' do
+      border!
+      lines do
+        line 'A.987654321'
+        line 'B.987654321'
+        line 'C.987654321'
+        line 'D.987654321'
+        line 'E.987654321'
+        line 'F.987654321'
+        line 'G.987654321'
+        line 'H.987654321'
+      end
+    end
+    view 'main_interface' do
+      border!
+      lines do
+        streams do
+          text 'A.3456789 '
+        end
+        streams do
+          background '#550000'
+          foreground '#ffff00'
+          text 'hydrogen'
+        end
+        streams do
+          text ' helium'
+        end
+      end
+      lines do
+        streams do
+          text 'B.3456789 lithium beryllium boron nitrogen'
+        end
+      end
+      lines do
+        streams do
+          text 'C.3456789'
+          text ' carbon oxygen '
+        end
+        streams do
+          background '#aadd00'
+          foreground '#000000'
+          text 'fluorine'
+        end
+      end
+      lines do
+        streams do
+          text 'D.3456789'
+        end
+      end
+      lines do
+        streams do
+          text 'E.3456789 neon sodium'
+        end
+      end
+      lines do
+        streams do
+          text 'F.3456789 magnesium '
+        end
+        streams do
+          foreground '#00aaff'
+          text 'aluminium'
+        end
+      end
+      lines do
+        streams do
+          text 'G.3456789 silicon'
+        end
+      end
+      lines do
+        streams do
+          background '#550000'
+          foreground '#ff00ff'
+          text 'H.34'
+        end
+      end
+    end
+  end
+
+  focus_by_name 'main_interface'
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
+  end
+end
+
+VedeuGeometryApp.start(ARGV)

data/lib/vedeu.rb

@@ -16,8 +16,6 @@ require 'vedeu/support/log'
 #
 module Vedeu
 
-  DOCS_URL = 'http://www.rubydoc.info/github/gavinlaking/vedeu/master'
-
   extend Forwardable
   extend self
 
@@ -28,21 +26,6 @@ module Vedeu
     @_focusable ||= Vedeu::Focus
   end
 
-  # @return [Vedeu::Repository]
-  def self.geometries
-    @_geometries ||= Vedeu::Repository.new(Vedeu::Geometry)
-  end
-
-  # @return [Vedeu::Repository]
-  def self.groups
-    @_groups ||= Vedeu::Repository.new(Vedeu::Group)
-  end
-
-  # @return [Vedeu::Repository]
-  def self.interfaces
-    @_interfaces ||= Vedeu::Repository.new(Vedeu::Interface)
-  end
-
   # When Vedeu is included within one of your classes, you should have all
   # API methods at your disposal.
   #

data/lib/vedeu/api.rb

@@ -3,6 +3,7 @@ require 'vedeu/support/terminal'
 require 'vedeu/events/all'
 require 'vedeu/models/all'
 require 'vedeu/input/all'
+require 'vedeu/dsl/components/border'
 require 'vedeu/dsl/composition'
 require 'vedeu/dsl/shared/all'
 require 'vedeu/dsl/view'
@@ -18,18 +19,32 @@ module Vedeu
     extend Forwardable
     extend self
 
+    def_delegators Vedeu::Borders,       :borders
+    def_delegators Vedeu::Buffers,       :buffers
+    def_delegators Vedeu::Cursors,       :cursors
+    def_delegators Vedeu::Cursors,       :cursor
+    def_delegators Vedeu::Events,        :events
+    def_delegators Vedeu::Geometries,    :geometries
+    def_delegators Vedeu::Groups,        :groups
+    def_delegators Vedeu::InterfacesRepository, :interfaces
+
+    def_delegators Vedeu::Keymaps,       :keymaps
+    def_delegators Vedeu::Mapper,        :keypress
+    def_delegators Vedeu::Menus,         :menus
+
     def_delegators Vedeu::Event,         :bind, :trigger, :unbind
     def_delegators Vedeu::Configuration, :configure, :configuration
+    def_delegators Vedeu::DSL::Border,   :border
+    def_delegators Vedeu::DSL::Geometry, :geometry
+    def_delegators Vedeu::DSL::Keymap,   :keymap
     def_delegators Vedeu::DSL::Use,      :use
     def_delegators Vedeu::DSL::View,     :interface, :renders, :views
 
     def_delegators Vedeu::Focus,         :focus, :focus_by_name, :focussed?,
                                          :focus_next, :focus_previous
-    def_delegators Vedeu::Keymap,        :keymap
+
     def_delegators Vedeu::Log,           :log
-    def_delegators Vedeu::Mapper,        :keypress
     def_delegators Vedeu::Menu,          :menu
-    def_delegators Vedeu::Menus,         :menus
     def_delegators Vedeu::Terminal,      :height, :width, :resize
 
   end # API

data/lib/vedeu/buffers/all.rb

@@ -2,10 +2,4 @@ require 'vedeu/buffers/buffer'
 require 'vedeu/buffers/display_buffer'
 
 module Vedeu
-
-  # @return [Vedeu::Repository]
-  def self.buffers
-    @_buffers ||= Vedeu::Repository.new(Vedeu::Buffer)
-  end
-
 end # Vedeu

data/lib/vedeu/buffers/buffer.rb

@@ -16,8 +16,11 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_accessor :back, :front, :previous
-    attr_reader   :name, :repository
+    attr_accessor :back,
+      :front,
+      :previous
+
+    attr_reader :name
 
     # Return a new instance of Buffer.
     #

data/lib/vedeu/cursor/all.rb

@@ -4,17 +4,4 @@ require 'vedeu/cursor/move_cursor'
 require 'vedeu/cursor/toggle_cursor'
 
 module Vedeu
-
-  extend self
-
-  # @return [Vedeu::Repository]
-  def cursors
-    @_cursors ||= Vedeu::Repository.new(Vedeu::Cursor)
-  end
-
-  # @return [Vedeu::Cursor|NilClass]
-  def cursor
-    cursors.current
-  end
-
 end # Vedeu

data/lib/vedeu/cursor/cursor.rb

@@ -17,7 +17,7 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_reader :attributes, :name, :ox, :oy, :repository, :state, :x, :y
+    attr_reader :attributes, :name, :ox, :oy, :state, :x, :y
 
     # Provides a new instance of Cursor.
     #

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

@@ -1,3 +1,4 @@
+require 'vedeu/output/border'
 require 'vedeu/dsl/shared/all'
 
 module Vedeu
@@ -11,17 +12,42 @@ module Vedeu
     # drawn or not.
     #
     # @example
+    #   # Borders can be defined as part of a view definition...
     #   Vedeu.renders do
     #     view 'border_demo' do
     #       border do
     #         # ...
     #
+    #   # ...or standalone; referencing the target interface or view.
+    #   Vedeu.border 'some_interface' do
+    #     # ...
+    #
     class Border
 
       include Vedeu::DSL
       include Vedeu::DSL::Colour
       include Vedeu::DSL::Style
 
+      class << self
+
+        # Specify the border of an interface or view with a simple DSL.
+        #
+        # @example
+        #   Vedeu.border 'some_interface' do
+        #     # ...
+        #
+        # @param name [String] The name of the interface or view to which this
+        #   border belongs.
+        # @param block [Proc]
+        # @return [Vedeu::Border]
+        def border(name, &block)
+          fail InvalidSyntax, 'block not given' unless block_given?
+
+          Vedeu::Border.build({ enabled: true, name: name }, &block).store
+        end
+
+      end
+
       # Returns an instance of DSL::Border.
       #
       # @param model [Border]
@@ -86,15 +112,29 @@ module Vedeu
       #   Vedeu.renders do
       #     view 'border_demo' do
       #       border do
-      #         show_bottom false
-      #         # ...
+      #         bottom false
+      #         # ... or
+      #         hide_bottom!
+      #         # ... or
+      #         show_bottom!
       #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def show_bottom(boolean)
+      def bottom(boolean)
         model.attributes[:show_bottom] = !!boolean
       end
+      alias_method :show_bottom, :bottom
+
+      # @see #bottom
+      def hide_bottom!
+        bottom(false)
+      end
+
+      # @see #bottom
+      def show_bottom!
+        bottom(true)
+      end
 
       # Enable/disable the left border.
       #
@@ -102,15 +142,29 @@ module Vedeu
       #   Vedeu.renders do
       #     view 'border_demo' do
       #       border do
-      #         show_left false
-      #         # ...
+      #         left false
+      #         # ... or
+      #         hide_left!
+      #         # ... or
+      #         show_left!
       #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def show_left(boolean)
+      def left(boolean)
         model.attributes[:show_left] = !!boolean
       end
+      alias_method :show_left, :left
+
+      # @see #left
+      def hide_left!
+        left(false)
+      end
+
+      # @see #left
+      def show_left!
+        left(true)
+      end
 
       # Enable/disable the right border.
       #
@@ -118,15 +172,29 @@ module Vedeu
       #   Vedeu.renders do
       #     view 'border_demo' do
       #       border do
-      #         show_right false
-      #         # ...
+      #         right false
+      #         # ... or
+      #         hide_right!
+      #         # ... or
+      #         show_right!
       #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def show_right(boolean)
+      def right(boolean)
         model.attributes[:show_right] = !!boolean
       end
+      alias_method :show_right, :right
+
+      # @see #right
+      def hide_right!
+        right(false)
+      end
+
+      # @see #right
+      def show_right!
+        right(true)
+      end
 
       # Enable/disable the top border.
       #
@@ -134,15 +202,29 @@ module Vedeu
       #   Vedeu.renders do
       #     view 'border_demo' do
       #       border do
-      #         show_top false
-      #         # ...
+      #         top false
+      #         # ... or
+      #         hide_top!
+      #         # ... or
+      #         show_top!
       #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def show_top(boolean)
+      def top(boolean)
         model.attributes[:show_top] = !!boolean
       end
+      alias_method :show_top, :top
+
+      # @see #top
+      def hide_top!
+        top(false)
+      end
+
+      # @see #top
+      def show_top!
+        top(true)
+      end
 
       # Set the character to be used to draw the top left corner of the border.
       #