vedeu 0.6.26 → 0.6.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1887422f1850ce922c9ff7432e5f1d21c99082e
-  data.tar.gz: 81c7143285b7b0732f735e04443357587d5431b0
+  metadata.gz: f676ea7902c40adea7f5844815c2bd92cc0524ca
+  data.tar.gz: 55d28506df00da6be9d8db123c9f5cc3475b154a
 SHA512:
-  metadata.gz: 2d0f9447a963a1aaf8fa2cd3d3e1e22f3baaaaeb2627691789c4d6f2ba7620490c7abdfa503b3a218754a018b40ae7b4b49bfe8a494ddd76b4750ae88af7107c
-  data.tar.gz: 255837e17cb62a1b4cc45cb65742a5de5feaa4e7a94bb859ba06def48c13ed37cce6a74ecdf761367da17ef69b783aa9b58c1a8b3d1d369f46a498e0ba04dc3f
+  metadata.gz: 2ad1f1eb8361880265d53dcc03a62684ef9485c967c40022e012e08080135255da79b44365388e05f8947018f73bc4aa121ba5f0bb96885c1936d7dc7f56ca53
+  data.tar.gz: a49319ea6f19f09d106606a076b5db4a2985caacaa67572173a7495e156e8f4319feb8d1afd3580eb161328f7dddc9d30df171fe30703fd4e271359904db5789

data/.yardopts

@@ -3,11 +3,18 @@
 --embed-mixins
 -
 docs/api.md
+docs/border.md
+docs/buffer.md
 docs/configuration.md
+docs/cursor.md
 docs/dsl.md
 docs/events.md
+docs/geometry.md
 docs/getting_started.md
+docs/group.md
+docs/interfaces.md
 docs/object_graph.md
+docs/view.md
 docs/events/application.md
 docs/events/document.md
 docs/events/drb.md

data/README.md

@@ -45,13 +45,21 @@ to your project here.
 
 Vedeu is documented using Yard. I hope to produce more 'General Usage'
 documentation shortly. In the meantime, please browse the
-[RubyDoc](http://rubydoc.info/gems/vedeu).
-
+[RubyDoc](http://rubydoc.info/gems/vedeu). In no particular order,
+here is some documentation for the various aspects of Vedeu:
+
+- [Interfaces](http://rubydoc.info/gems/vedeu/file/docs/.md)
+- [Groups](http://rubydoc.info/gems/vedeu/file/docs/group.md)
+- [Views](http://rubydoc.info/gems/vedeu/file/docs/view.md)
+- [Buffers](http://rubydoc.info/gems/vedeu/file/docs/buffer.md)
+- [Geometry](http://rubydoc.info/gems/vedeu/file/docs/geometry.md)
+- [Borders](http://rubydoc.info/gems/vedeu/file/docs/border.md)
+- [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursor.md)
+- [Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
+- [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
 - [Getting Started](http://rubydoc.info/gems/vedeu/file/docs/getting_started.md)
 - [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
 - [The Vedeu API](http://rubydoc.info/gems/vedeu/file/docs/api.md)
-- [Vedeu Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
-- [Vedeu Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
 - [Object Graphs](http://rubydoc.info/gems/vedeu/file/docs/object_graph.md)
 
 ## Development / Contributing

data/docs/border.md

@@ -0,0 +1,23 @@
+# @title Vedeu Borders
+# Vedeu Borders
+
+The interfaces of Vedeu can each have their own border.
+
+- It has a name. This name associates it with an
+  {file:docs/interface.md Interface}.
+- Each of its corners, the horizontal, and the vertical character can
+  be defined as different characters.
+- It can have a foreground and a background and style, independent of
+  the interface to which it belongs.
+- Each of the sides of the border can be shown or hidden
+  independently.
+- The border itself can be enabled and disabled (shown/hidden) as
+  required.
+- The border can have a title, which is displayed on the top side.
+- It can also have a caption, which is displayed on the bottom side.
+- The sides of the border will use:
+  - The first (top) line of the geometry.
+  - The last (bottom) line of the geometry.
+  - The first character (left) of the geometry.
+  - The last character (right) of the geometry.
+- The border can be refreshed independently of the interface.

data/docs/buffer.md

@@ -0,0 +1,29 @@
+# @title Vedeu Buffers
+# Vedeu Buffers
+
+Each interface has an associated buffer, referenced by name. The
+buffer has three states; 'back', 'front' and 'previous'.
+
+- 'back': New view data is added to the 'back' buffer. It will be
+  shown next time an interface or view is refreshed; by being moved to
+  the 'front' buffer.
+- 'front': Current view data belongs on the 'front' buffer. It will be
+  shown every time the interface is refreshed unless new view data has
+  been added to the 'back' buffer (see 'back').
+- 'previous': Old view data resides on the 'previous' buffer. When new
+  view data has been added to the back buffer, upon the next refresh,
+  the current 'front' buffer data is moved to the 'previous' buffer,
+  and the new 'back' data is added to the 'front' buffer.
+
+Try to think of the above process as a conveyor belt of data. You will
+only see 'front' data in the terminal.
+
+    1) new -> 'back'
+    2) refresh happens
+    3) 'back' is copied to 'front'
+    4) 'front' is displayed, but also copied to 'previous'
+
+- Buffers can be refreshed independently. If the buffer for an
+  interface is currently hidden, it will still refresh, you just won't
+  see it. When the interface is visible again, you will see whatever
+  the latest buffer data is for that interface.

data/docs/cursor.md

@@ -0,0 +1,18 @@
+# @title Vedeu Cursors
+# Vedeu Cursors
+
+Each interface defined in Vedeu will have a separate cursor named,
+conveniently after the interface itself.
+
+- The cursor can moved left, right, up or down via events.
+- The cursor can be shown or hidden (independently of the interface).
+- The cursor may not be drawn on the border of the interface if a
+  border is defined and visible for any side of the interface.
+- The cursor may not be drawn outside of the geometry of the interface
+  if a border is not defined or is invisible for the interface.
+- The position of the cursor is remembered for each interface.
+- The cursor determines that which is shown in the interface via its
+  offset (this allows content to be larger than the interface size and
+  therefore 'scrolling').
+- The cursor can be refreshed independently of the interface meaning
+  the content of the interface can change position if needed.

data/docs/events/visibility.md

@@ -44,7 +44,7 @@ Hiding a group of interfaces.
     Vedeu.hide_group(name)
 
 ### :_hide_interface_
-Hiding an interface.
+Hide an interface by name.
 
     Vedeu.trigger(:_hide_interface_, name)
     Vedeu.hide_interface(name)
@@ -64,7 +64,7 @@ Showing a group of interfaces.
     Vedeu.show_group(name)
 
 ### :_show_interface_
-Showing an interface.
+Show an interface by name.
 
     Vedeu.trigger(:_show_interface_, name)
     Vedeu.show_interface(name)

data/docs/geometry.md

@@ -0,0 +1,28 @@
+# @title Vedeu Geometry
+# Vedeu Geometry
+
+Geometry defines the shape of an interface or view. It determines
+where an interface or view will display within the terminal space.
+Terminal geometry starts at position (1, 1), which is the top left
+of the terminal.
+
+- It has a name. This name associates it with an
+  {file:docs/interface.md Interface}.
+- It has dimensions- a width and a height.
+  - The 'width' is the number of characters wide, and is defined as
+    being ('xn' - 'x') or ('x' + 'width').
+  - The 'height' is the number of lines tall, and is defined as
+    being ('yn' - 'y') or ('y' + 'height').
+  - 'x' refers to the starting coordinate of the horizontal axis.
+  - 'y' refers to the starting coordinate of the vertical axis.
+  - 'xn' refers to the ending coordinate of the horizontal axis.
+  - 'yn' refers to the ending coordinate of the vertical axis.
+  - Using 'xn' and 'yn' is optional, as is 'width' and 'height'. In
+    their absence, Vedeu will extend the width from 'x' to the right
+    edge of the terminal, likewise the height from the 'y' to the
+    bottom edge of the terminal.
+- Geometry can be maximised- to use all the available terminal space.
+- It can also be unmaximised- to return to the pre-defined dimensions
+  as mentioned above.
+- Geometry like a {file:docs/cursorr.md} Cursor, via events can be
+  moved; left, right, up or down.

data/docs/group.md

@@ -0,0 +1,13 @@
+# @title Vedeu Groups
+# Vedeu Groups
+
+Vedeu allows you to create collections of interfaces, these are called
+Groups.
+
+- They have a name, which means you can control a collection of
+  interfaces by this name.
+- Interfaces which are part of a group are the members of that group.
+  - It is generally wise not to have interfaces which are members of
+    multiple groups.
+- They can be visible or invisible, this affects all of the members of
+  the group.

data/docs/interfaces.md

@@ -0,0 +1,21 @@
+# @title Vedeu Interfaces
+# Vedeu Interfaces
+
+Think of interfaces as being discrete sections of the terminal space.
+
+- It has a name, which all other aspects of Vedeu will be related.
+- It has a size, in terms of a width and height, determined by
+  {file:docs/geometry.md Geometry}.
+- It can have a {file:docs/border.md} Border.
+- It can be part of a {file:docs/group.md Group}.
+- An interface is empty unless it has an associated
+  {file:docs/view.md View}.
+- It can have a default background and foreground colour which you
+  can later override with the view.
+- It can also have a default style, which again, can be overriden if
+  you wish.
+- It can be visible or invisible, even independently of the group
+  you have assigned them to. By default, all interfaces are invisible
+  unless you specifically define them to be visible.
+- Interfaces can move or resize on the screen by controlling its
+  Geometry or if the terminal change dimensions.

data/docs/view.md

@@ -0,0 +1,17 @@
+# @title Vedeu Views
+# Vedeu Views
+
+Each interface defined in Vedeu will have an associated (by name, of
+course) view. This view will contain that which is visible within the
+interface and is determined by the position of the cursor associated
+with the interface.
+
+- A view is made up of lines, made up of characters.
+- Lines can have their own background, foreground and styles.
+- A line can also be made up of streams, a stream itself having its
+  own background, foreground and styles.
+- Lines and streams are made up of characters- again, each with their
+  own background, foreground and styles.
+
+Views can be requested to be drawn immediately on construction, or
+added to a {file:docs/buffer.md Buffer}.

data/examples/demo_groups.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vedeu'
+
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     bundle exec ./examples/demo_groups.rb
+#
+class DemoGroupsApp
+
+  Vedeu.bind(:_initialize_) {
+    Vedeu.trigger(:_show_group_, :fruit)
+    Vedeu.trigger(:_refresh_group_, :fruit)
+  }
+
+  Vedeu.configure do
+    log '/tmp/demo_groups.log'
+  end
+
+  Vedeu.interface :apple do
+    border!
+    foreground '#ffffff'
+    geometry do
+      width  10
+      height 4
+      x  3
+      y  3
+
+    end
+    group :fruit
+  end
+
+  Vedeu.interface :banana do
+    border!
+    foreground '#ffffff'
+    geometry do
+      width  10
+      height 4
+      x  15
+      y  3
+    end
+    group :fruit
+  end
+
+  Vedeu.interface :carrot do
+    border!
+    foreground '#ffffff'
+    geometry do
+      width  10
+      height 4
+      x  4
+      y  4
+    end
+    group :vegetable
+  end
+
+  Vedeu.interface :dill do
+    border!
+    foreground '#ffffff'
+    geometry do
+      width  10
+      height 4
+      x  16
+      y  4
+    end
+    group :vegetable
+  end
+
+  Vedeu.keymap '_global_' do
+    key('f') {
+      Vedeu.trigger(:_hide_group_, :vegetable)
+      Vedeu.trigger(:_show_group_, :fruit)
+    }
+    key('q') { Vedeu.exit }
+    key('v') {
+      Vedeu.trigger(:_hide_group_, :fruit)
+      Vedeu.trigger(:_show_group_, :vegetable)
+    }
+    key(:tab) { Vedeu.focus_next }
+    key(:shift_tab) { Vedeu.focus_previous }
+  end
+
+  Vedeu.views do
+    view(:apple) do
+      line 'apple'
+    end
+    view(:banana) do
+      line 'banana'
+    end
+    view(:carrot) do
+      line 'carrot'
+    end
+    view(:dill) do
+      line 'dill'
+    end
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # DemoGroupsApp
+
+DemoGroupsApp.start

data/lib/vedeu/bindings/visibility.rb

@@ -32,8 +32,10 @@ module Vedeu
       # @return [TrueClass]
       def setup_aliases!
         Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
-
         Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
+        Vedeu.bind_alias(:_hide_view_, :_hide_interface_)
+        Vedeu.bind_alias(:_show_view_, :_show_interface_)
+        Vedeu.bind_alias(:_toggle_view_, :_toggle_interface_)
       end
 
       private

data/lib/vedeu/dsl/line.rb

@@ -40,10 +40,11 @@ module Vedeu
       #
       #   Vedeu.renders do
       #     view :my_interface do
-      #       line 'some text...'
-      #       # ... some code
+      #       lines do
+      #         line 'some text...'
+      #         # ... some code
       #
-      #       line do
+      #         line 'some more text...'
       #         # ... some code
       #       end
       #     end
@@ -76,13 +77,15 @@ module Vedeu
       #
       #   Vedeu.renders do
       #     view :my_interface do
-      #       line do
-      #         streams do
-      #           # ... some code
-      #         end
+      #       lines do
+      #         line do
+      #           streams do
+      #             # ... some code
+      #           end
       #
-      #         stream do
-      #           # ... some code
+      #           stream do
+      #             # ... some code
+      #           end
       #         end
       #       end
       #     end

data/lib/vedeu/dsl/view.rb

@@ -244,7 +244,11 @@ module Vedeu
 
         model.add(model.member.build(attributes, &block))
       end
-      alias_method :line, :lines
+
+      # @return [Vedeu::Views::Line]
+      def line(value = '')
+        lines { line(value) }
+      end
 
     end # View
 

data/lib/vedeu/groups/group.rb

@@ -156,7 +156,7 @@ module Vedeu
           members:    Set.new,
           name:       '',
           repository: Vedeu.groups,
-          visible:    true,
+          visible:    false,
         }
       end
 

data/lib/vedeu/models/interface.rb

@@ -82,11 +82,12 @@ module Vedeu
 
       # Show the named interface.
       #
-      # Will hide the named interface. If the interface is currently
-      # visible, it will be cleared- rendered blank. To show the
-      # interface, the ':_show_interface_' event should be triggered.
-      # Triggering the ':_hide_group_' event to which this named
-      # interface belongs will also hide the interface.
+      # Will show the named interface. If the interface is currently
+      # visible, it will be refreshed- showing any new content
+      # available. To hide the interface, the ':_hide_interface_'
+      # event should be triggered.
+      # Triggering the ':_show_group_' event to which this named
+      # interface belongs will also show the interface.
       #
       # @example
       #   Vedeu.trigger(:_show_interface_, name)
@@ -115,7 +116,7 @@ module Vedeu
           parent:     nil,
           repository: Vedeu.interfaces,
           style:      :normal,
-          visible:    true,
+          visible:    false,
           zindex:     0,
         }
       end

data/lib/vedeu/models/page.rb

@@ -26,15 +26,8 @@ module Vedeu
           Vedeu::Models::Page.new([Vedeu::Models::Row.coerce(value)])
 
         elsif value.is_a?(Array)
-          values = value.map do |v|
-            if v.is_a?(Vedeu::Models::Row)
-              v
+          values = value.map { |v| Vedeu::Models::Row.coerce(v) }
 
-            else
-              Vedeu::Models::Row.coerce(v)
-
-            end
-          end
           Vedeu::Models::Page.new(values)
 
         else

data/lib/vedeu/output/clear/interface.rb

@@ -51,7 +51,7 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Views::Char>>]
       def render
-        Vedeu.render_output(output)
+        Vedeu.render_output(output) if interface.visible?
       end
 
       protected

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.26'.freeze
+  VERSION = '0.6.27'.freeze
 
 end

data/test/lib/vedeu/application/application_view_test.rb

@@ -35,11 +35,6 @@ module Vedeu
       end
     end
 
-    # describe 'accessors' do
-    #   it { instance.must_respond_to(:params) }
-    #   it { instance.must_respond_to(:params=) }
-    # end
-
     describe '.render' do
       subject { described.render(params) }
 

data/test/lib/vedeu/bindings/visibility_test.rb

@@ -25,6 +25,9 @@ module Vedeu
         it { Vedeu.bound?(:_hide_interface_).must_equal(true) }
         it { Vedeu.bound?(:_show_interface_).must_equal(true) }
         it { Vedeu.bound?(:_toggle_interface_).must_equal(true) }
+        it { Vedeu.bound?(:_hide_view_).must_equal(true) }
+        it { Vedeu.bound?(:_show_view_).must_equal(true) }
+        it { Vedeu.bound?(:_toggle_view_).must_equal(true) }
       end
 
       # describe ':_some_event_' do

data/test/lib/vedeu/buffers/refresh_test.rb

@@ -24,9 +24,25 @@ module Vedeu
         subject { described.by_name(_name) }
 
         context 'when Vedeu is not yet ready' do
+          let(:buffer) { mock(render: '') }
+
+          before do
+            Vedeu.stubs(:trigger).with(:_clear_view_content_, _name)
+            Vedeu.buffers.expects(:by_name).with(_name).returns(buffer)
+            Vedeu.stubs(:trigger).with(:_refresh_border_, _name)
+          end
+
           let(:ready) { false }
 
-          it { subject.must_equal([nil]) }
+          it {
+            Vedeu.expects(:trigger).with(:_clear_view_content_, _name)
+            subject
+          }
+
+          it {
+            Vedeu.expects(:trigger).with(:_refresh_border_, _name)
+            subject
+          }
         end
 
         context 'when Vedeu is ready' do

data/vedeu.gemspec

@@ -28,12 +28,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'mocha',              '1.1.0'
   spec.add_development_dependency 'pry',                '0.10.2'
   spec.add_development_dependency 'rubocop',            '0.34.2'
-  spec.add_development_dependency 'ruby-prof',          '0.15.8'
   spec.add_development_dependency 'simplecov',          '0.10.0'
   spec.add_development_dependency 'simplecov-console',  '0.2.0'
   spec.add_development_dependency 'yard',               '0.8.7.6'
 
   spec.add_dependency 'bundler',   '~> 1.10'
   spec.add_dependency 'rake',      '~> 10.4'
+  spec.add_dependency 'ruby-prof', '0.15.8'
+  spec.add_dependency 'thor',      '0.19.1'
   spec.add_dependency 'vedeu_cli', '0.0.7'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.26
+  version: 0.6.27
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-04 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -122,20 +122,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.34.2
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.15.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.15.8
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.8
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: vedeu_cli
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +263,10 @@ files:
 - bin/vedeu_test
 - config/rubocop_enabled.yml
 - docs/api.md
+- docs/border.md
+- docs/buffer.md
 - docs/configuration.md
+- docs/cursor.md
 - docs/dsl.md
 - docs/events.md
 - docs/events/application.md
@@ -262,8 +279,13 @@ files:
 - docs/events/system.md
 - docs/events/view.md
 - docs/events/visibility.md
+- docs/geometry.md
 - docs/getting_started.md
+- docs/group.md
+- docs/interfaces.md
 - docs/object_graph.md
+- docs/view.md
+- examples/demo_groups.rb
 - examples/hello_worlds.rb
 - lib/vedeu.rb
 - lib/vedeu/all.rb