vedeu 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d92eea450aa078936ad63e48458e87bffc1b94ef
-  data.tar.gz: 7b58b5c6c47151c7635971abc608b7951e1cfa77
+  metadata.gz: 2df80a2e1733e5183dbf7afef9ce4b5ba8a833b4
+  data.tar.gz: ebda4b179298868faf99b0aa9e074022d6a0c407
 SHA512:
-  metadata.gz: 9363fca14b44becccaa8b29c32185175270e1ae9769d9ec0410db5c71a48cfcb199e3797e79a7bca7b4771743225641aeb44462bfe1d9c7205f3e2e06d215382
-  data.tar.gz: da6d294f0a25f2b010972e6cdcee7ec8a3fe8b3cadf21cc28f34d6f602d1ff73e2a7c11aa03df2f3d2d0e2cf478af48812cca6f34e494eebff76fa2d7029c2cd
+  metadata.gz: 15805aa4cea7d6b7a41b11d6da45436488bbe2613380760f36ffd52d0db75d9e7954b18dec7524712cad114062d4ba74339bd54c6ec04d401f9cac757da73ba5
+  data.tar.gz: 2ca96c51ea3811ae78e6c7ea023fbd460c00e8ede0ca02ce6a0c2033c0e596a1059a8269f44634fd33c703573e2caa1925f17a3f0bb5f89f5433097c01392f15

data/docs/api.md

@@ -59,12 +59,17 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
 #### Interfaces
 
 - interface
+  - background
   - centred (or centred!)
   - cursor
   - colour
   - delay
+  - focus!
+  - foreground
   - group
   - height
+  - keys
+  - line
   - name
   - style
   - use

data/examples/focus_app.rb

@@ -0,0 +1,92 @@
+#!/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'
+
+# This example application shows how interface focus works.
+#
+# First, we set up the interfaces, noting that 'copper' should have focus when
+# the application starts. Also note that 'status' should not show a cursor.
+#
+# The focus order is: copper, aluminium, boron, dubnium, status.
+#
+# Use 'space' to change focus.
+class VedeuFocusApp
+  include Vedeu
+
+  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  interface 'aluminium' do
+    colour  foreground: '#ffffff', background: '#330000'
+    cursor  true
+    height  2
+    width   2
+    x       3
+    y       3
+  end
+
+  interface 'boron' do
+    colour  foreground: '#ffffff', background: '#003300'
+    cursor  true
+    height  2
+    width   2
+    x       6
+    y       3
+  end
+
+  interface 'copper' do
+    colour  foreground: '#ffffff', background: '#000033'
+    cursor  true
+    focus!
+    height  2
+    width   2
+    x       3
+    y       6
+  end
+
+  interface 'dubnium' do
+    colour  foreground: '#ffffff', background: '#333300'
+    cursor  true
+    height  2
+    width   2
+    x       6
+    y       6
+  end
+
+  interface 'status' do
+    colour  foreground: '#ffffff', background: '#000000'
+    cursor  false
+    height  2
+    width   10
+    x       9
+    y       3
+  end
+
+  render do
+    view('aluminium') { line 'Al' }
+    view('boron')     { line 'B' }
+    view('copper')    { line 'Cu' }
+    view('dubnium')   { line 'Db' }
+    view('status')    { line Vedeu::Focus.current }
+
+    # Tell Vedeu that each interface can use 'space'.
+    keys('aluminium', 'boron', 'copper', 'dubnium', 'status') do
+      key(' ') do
+        Vedeu::Focus.next_item
+
+        render { view('status') { line Vedeu::Focus.current } }
+      end
+    end
+  end
+
+  def self.start
+    Vedeu::Launcher.new(['--debug']).execute!
+  end
+end
+
+VedeuFocusApp.start

data/lib/vedeu/api/interface.rb

@@ -29,7 +29,7 @@ module Vedeu
       end
       alias_method :centred!, :centred
 
-      # Set the cursor visibility on an interface or view.
+      # Set the cursor visibility on an interface.
       #
       # @param value [Boolean] Any value other than nil or false will evaluate
       #   to true.
@@ -70,6 +70,15 @@ module Vedeu
         attributes[:delay] = value
       end
 
+      # Specify this interface as being in focus when the application starts.
+      # If multiple interfaces are defined, and this is included in each, then
+      # the last defined will be the interface in focus.
+      #
+      # @return [String] The name of the interface in focus.
+      def focus!
+        attributes[:focus] = true
+      end
+
       # 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.

data/lib/vedeu/output/compositor.rb

@@ -26,13 +26,20 @@ module Vedeu
     #
     # @return [Array]
     def render
-      Terminal.output(view)
+      Terminal.output(view, cursor)
     end
 
     private
 
     attr_reader :name
 
+    # Renders the cursor into the currently focussed interface. May be hidden.
+    #
+    # @return [String]
+    def cursor
+      Interface.new(Vedeu::Interfaces.find(Focus.current)).cursor.to_s
+    end
+
     # Renders the buffer unless empty, otherwise clears the area which the
     # interface occupies.
     #

data/lib/vedeu/output/render.rb

@@ -30,7 +30,7 @@ module Vedeu
     #
     # @return [String]
     def render
-      out = [ Clear.call(interface) ]
+      out = [clear]
 
       Vedeu.log("Rendering view: '#{interface.name}'")
 
@@ -38,7 +38,6 @@ module Vedeu
         out << interface.origin(index)
         out << line.join
       end
-      out << interface.cursor.to_s if interface.in_focus?
       out.join
     end
 
@@ -46,6 +45,10 @@ module Vedeu
 
     attr_reader :interface
 
+    def clear
+      Clear.call(interface)
+    end
+
   end # Render
 
 end # Vedeu

data/lib/vedeu/repositories/buffers.rb

@@ -6,7 +6,6 @@ module Vedeu
   # @api private
   module Buffers
 
-    include Common
     include Repository
     extend self
 

data/lib/vedeu/repositories/cursors.rb

@@ -6,7 +6,6 @@ module Vedeu
   # @api private
   module Cursors
 
-    include Common
     include Repository
     include Positional
     extend self

data/lib/vedeu/repositories/focus.rb

@@ -7,7 +7,6 @@ module Vedeu
   # @api private
   module Focus
 
-    include Common
     include Repository
     extend self
 
@@ -25,9 +24,15 @@ module Vedeu
     def add(attributes)
       validate_attributes!(attributes)
 
-      return storage << attributes[:name] unless registered?(attributes[:name])
+      return storage if registered?(attributes[:name])
 
-      storage
+      if attributes[:focus]
+        storage.unshift(attributes[:name])
+
+      else
+        storage.push(attributes[:name])
+
+      end
     end
 
     # Focus an interface by name.
@@ -40,11 +45,7 @@ module Vedeu
 
       storage.rotate!(storage.index(name))
 
-      Vedeu.log("Interface in focus: '#{current}'")
-
-      refresh
-
-      current
+      update
     end
 
     # Return the interface currently focussed.
@@ -72,12 +73,9 @@ module Vedeu
     def next_item
       storage.rotate!
 
-      Vedeu.log("Interface in focus: '#{current}'")
-
-      refresh
-
-      current
+      update
     end
+    alias_method :next, :next_item
 
     # Put the previous interface relative to the current interface in focus.
     #
@@ -85,12 +83,10 @@ module Vedeu
     def prev_item
       storage.rotate!(-1)
 
-      Vedeu.log("Interface in focus: '#{current}'")
-
-      refresh
-
-      current
+      update
     end
+    alias_method :prev,     :prev_item
+    alias_method :previous, :prev_item
 
     # Refresh the interface in focus.
     #
@@ -117,6 +113,20 @@ module Vedeu
 
     private
 
+    # Return the name of the interface in focus after triggering the refresh
+    # event for that interface. Returns false if the storage is empty.
+    #
+    # @return [String|FalseClass]
+    def update
+      return false if storage.empty?
+
+      Vedeu.log("Interface in focus: '#{current}'")
+
+      refresh
+
+      current
+    end
+
     # Returns an empty collection ready for the storing of interface names.
     #
     # @return [Array]

data/lib/vedeu/repositories/groups.rb

@@ -5,7 +5,6 @@ module Vedeu
   # @api private
   module Groups
 
-    include Common
     include Repository
     extend self
 

data/lib/vedeu/repositories/interfaces.rb

@@ -5,7 +5,6 @@ module Vedeu
   # @api private
   module Interfaces
 
-    include Common
     include Repository
     extend self
 

data/lib/vedeu/repositories/keymaps.rb

@@ -5,7 +5,6 @@ module Vedeu
   # @api private
   module Keymaps
 
-    include Common
     include Repository
     extend self
 

data/lib/vedeu/repositories/menus.rb

@@ -5,7 +5,6 @@ module Vedeu
   # @api private
   module Menus
 
-    include Common
     include Repository
     extend self
 

data/lib/vedeu/repositories/offsets.rb

@@ -6,7 +6,6 @@ module Vedeu
   # @api private
   module Offsets
 
-    include Common
     include Repository
     include Positional
     extend self

data/lib/vedeu/support/refresh.rb

@@ -5,7 +5,7 @@ module Vedeu
   # @api private
   module Refresh
 
-    include Vedeu::Common
+    include Common
     extend self
 
     # System event to refresh all registered interfaces.
@@ -22,7 +22,7 @@ module Vedeu
     #
     # @return [|NoInterfacesDefined]
     def by_focus
-      by_name(Vedeu::Focus.current)
+      by_name(Focus.current)
     end
 
     # Refresh an interface, or collection of interfaces belonging to a group.
@@ -31,7 +31,7 @@ module Vedeu
     # @return [Array|GroupNotFound] A collection of the names of interfaces
     #   refreshed, or an exception if the group was not found.
     def by_group(group_name)
-      Vedeu::Groups.find(group_name).each { |name| by_name(name) }
+      Groups.find(group_name).each { |name| by_name(name) }
     end
 
     # Refresh an interface by name.
@@ -39,7 +39,7 @@ module Vedeu
     # @param name [String] The name of the interface to be refreshed.
     # @return [Array|BufferNotFound]
     def by_name(name)
-      Vedeu::Compositor.render(name)
+      Compositor.render(name)
     end
 
     # Register a refresh event for an interface or group of interfaces by name.
@@ -61,7 +61,7 @@ module Vedeu
 
       return false if Events.registered?(event)
 
-      Events.add(event, { delay: delay }) { Vedeu::Refresh.send(type, name) }
+      Events.add(event, { delay: delay }) { Refresh.send(type, name) }
 
       true
     end

data/lib/vedeu/support/repository.rb

@@ -5,6 +5,8 @@ module Vedeu
   # @api private
   module Repository
 
+    include Common
+
     # Return the whole repository.
     #
     # @return [Hash]

data/test/lib/vedeu/api/interface_test.rb

@@ -165,6 +165,33 @@ module Vedeu
         end
       end
 
+      describe '#focus!' do
+        it 'returns true' do
+          API::Interface.new({ name: 'curium' }).focus!.must_equal(true)
+        end
+
+        it 'sets the interface as current' do
+          Vedeu.interface('curium') { focus! }
+
+          Focus.current.must_equal('curium')
+        end
+
+        it 'multiple calls will set the last to being current' do
+          Vedeu.interface('curium')     { focus! }
+          Vedeu.interface('iodine')     {}
+          Vedeu.interface('dysprosium') { focus! }
+
+          Focus.current.must_equal('dysprosium')
+        end
+
+        it 'no calls will leave the first interface defined as being current' do
+          Vedeu.interface('curium')     {}
+          Vedeu.interface('dysprosium') {}
+
+          Focus.current.must_equal('curium')
+        end
+      end
+
       describe '#group' do
         it 'sets the group attribute' do
           Vedeu.interface 'iron' do

data/test/lib/vedeu/output/compositor_test.rb

@@ -28,7 +28,8 @@ module Vedeu
           Compositor.render('xenon').must_equal([
             "\e[1;1H     \e[1;1H" \
             "\e[2;1H     \e[2;1H" \
-            "\e[3;1H     \e[3;1H" \
+            "\e[3;1H     \e[3;1H",
+
             "\e[1;1H\e[?25l"
           ])
         end
@@ -63,7 +64,8 @@ module Vedeu
             "\e[3;1H     \e[3;1H" \
             "\e[1;1Hargon" \
             "\e[2;1Hboron" \
-            "\e[3;1Hradon" \
+            "\e[3;1Hradon",
+
             "\e[1;1H\e[?25l"
           ])
         end

data/test/lib/vedeu/output/render_test.rb

@@ -39,7 +39,6 @@ module Vedeu
           "\e[1;1Hthis is the first" \
           "\e[2;1Hthis is the second and it is lon" \
           "\e[3;1Hthis is the third, it is even lo" \
-          "\e[1;1H\e[?25l"
         )
       end
 
@@ -56,8 +55,7 @@ module Vedeu
         Render.call(interface).must_equal(
           "\e[1;1H                                \e[1;1H" \
           "\e[2;1H                                \e[2;1H" \
-          "\e[3;1H                                \e[3;1H" \
-          "\e[1;1H\e[?25l"
+          "\e[3;1H                                \e[3;1H"
         )
       end
 
@@ -90,8 +88,7 @@ module Vedeu
           "\e[3;1H                                \e[3;1H" \
           "\e[1;1Hthis is the first" \
           "\e[2;1H" \
-          "\e[3;1Hthis is the third, it is even lo" \
-          "\e[1;1H\e[?25l"
+          "\e[3;1Hthis is the third, it is even lo"
         )
       end
 
@@ -136,7 +133,9 @@ module Vedeu
             [
               "\e[1;1H                                        \e[1;1H" \
               "\e[2;1H                                        \e[2;1H" \
-              "\e[1;1Ht\e[38;2;255;255;255m\e[48;2;0;0;0mh\e[38;2;255;255;255m\e[48;2;0;0;0me\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mg\e[38;2;255;255;255m\e[48;2;0;0;0mr\e[38;2;255;255;255m\e[48;2;0;0;0ma\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mi\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mg\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mr\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0me\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0me\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mn\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0ma\e[38;2;255;255;255m\e[48;2;0;0;0mn\e[38;2;255;255;255m\e[48;2;0;0;0md\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mt\e[38;2;255;255;255m\e[48;2;0;0;0mh\e[38;2;255;255;255m\e[48;2;0;0;0me\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0mk\e[38;2;255;255;255m\e[48;2;0;0;0my\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mi\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255mb\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255ml\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255mu\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255me\e[38;2;255;255;255m\e[48;2;0;0;0m.\e[38;2;255;255;255m\e[48;2;0;0;0m"
+              "\e[1;1Ht\e[38;2;255;255;255m\e[48;2;0;0;0mh\e[38;2;255;255;255m\e[48;2;0;0;0me\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mg\e[38;2;255;255;255m\e[48;2;0;0;0mr\e[38;2;255;255;255m\e[48;2;0;0;0ma\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mi\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mg\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mr\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0me\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0me\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;255;0mn\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0ma\e[38;2;255;255;255m\e[48;2;0;0;0mn\e[38;2;255;255;255m\e[48;2;0;0;0md\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mt\e[38;2;255;255;255m\e[48;2;0;0;0mh\e[38;2;255;255;255m\e[48;2;0;0;0me\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0mk\e[38;2;255;255;255m\e[48;2;0;0;0my\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0mi\e[38;2;255;255;255m\e[48;2;0;0;0ms\e[38;2;255;255;255m\e[48;2;0;0;0m \e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255mb\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255ml\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255mu\e[38;2;255;255;255m\e[48;2;0;0;0m\e[38;2;0;0;255me\e[38;2;255;255;255m\e[48;2;0;0;0m.\e[38;2;255;255;255m\e[48;2;0;0;0m",
+
+              "\e[1;1H\e[?25l"
             ]
           )
         end

data/test/lib/vedeu/repositories/focus_test.rb

@@ -8,7 +8,7 @@ module Vedeu
     after  { Focus.reset }
 
     describe '#add' do
-      it 'adds an interface to storage focussed' do
+      it 'adds an interface to storage' do
         Focus.add({ name: 'thallium' }).must_equal(['thallium'])
       end
 
@@ -18,6 +18,18 @@ module Vedeu
         Focus.registered.must_equal(['thallium'])
       end
 
+      it 'adds the interface to storage focussed' do
+        Focus.add({ name: 'thallium' })
+        Focus.add({ name: 'lead', focus: true })
+        Focus.registered.must_equal(['lead', 'thallium'])
+      end
+
+      it 'adds the interface to storage unfocussed' do
+        Focus.add({ name: 'thallium' })
+        Focus.add({ name: 'lead' })
+        Focus.registered.must_equal(['thallium', 'lead'])
+      end
+
       it 'raises an exception if the attributes does not have a :name key' do
         attributes = { no_name_key: '' }
 
@@ -70,6 +82,10 @@ module Vedeu
         Focus.add({ name: 'bismuth' })
         Focus.next_item.must_equal('lead')
       end
+
+      it 'returns false if storage is empty' do
+        Focus.next_item.must_equal(false)
+      end
     end
 
     describe '#prev_item' do
@@ -79,6 +95,10 @@ module Vedeu
         Focus.add({ name: 'bismuth' })
         Focus.prev_item.must_equal('bismuth')
       end
+
+      it 'returns false if storage is empty' do
+        Focus.prev_item.must_equal(false)
+      end
     end
 
     describe '#refresh' do

data/vedeu.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.2.5'
+  spec.version       = '0.2.6'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = %q{A terminal case of wonderland.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,6 +187,7 @@ files:
 - docs/events.md
 - docs/getting_started.md
 - examples/cursor_app/cursor_app.rb
+- examples/focus_app.rb
 - examples/hello_world.rb
 - examples/lines_app/lines_app.rb
 - lib/vedeu.rb