vedeu 0.4.13 → 0.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93ac36141b3bc793dee0aad2e80544c90132360e
-  data.tar.gz: af98449688a4e8f2e4ef81eb9b8a6e758bbf50e0
+  metadata.gz: b7c54da4b2eda5de86cde144c882a63a2699475f
+  data.tar.gz: d3477590f4f488e40117aa284a57702e039df523
 SHA512:
-  metadata.gz: 80135e46d4f03091adb7d3a1031c7267910dbb057651eecacceb517535f048ec947e6dac580e3a7a27b571aa1b868acf8c364492009f43d4dfd5bcfe9b478c43
-  data.tar.gz: 92ad673e9af506d15c3fb029933ceb89f03c926a45f33fd19f39a26685d3a4fb9caa95b763fca84570e1f4e7b007b09bac7e1d75157d1c61792538725ea940b7
+  metadata.gz: a5868261a9d78a1fee37410fdc2eda682a90c4f631384fff07be495f83993869b5e6be62b246656c9ef6b6ea97389646d190295095c993c39f3fde1071322e5c
+  data.tar.gz: 7faf1541d7b987ace4a81d94714be0c5bec7a97e750e7dac8bf8cb0c8016fccc6a3e3ac99dd9a7df357629e659069473c6c463ef07e0e8a6a53762242b5b1a6c

data/.rubocop.yml

@@ -25,6 +25,7 @@ AllCops:
     - '**/Cheffile'
     - '**/Vagabondfile'
   Exclude:
+    - 'test/**/*'
     - 'vendor/**/*'
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
@@ -642,7 +643,7 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   CountComments: false  # count full line comments?
-  Max: 15
+  Max: 70
 
 Metrics/ParameterLists:
   Max: 5

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.2.1
 cache: bundler
 script: 'bundle exec rake'
+sudo: false
 

data/Guardfile

@@ -6,12 +6,13 @@
 #   end
 # end
 
-guard :minitest, all_after_pass: true, focus_on_failed: true, env: { 'no_simplecov' => true } do
+guard :minitest, all_after_pass: true,
+                 focus_on_failed: true,
+                 env: { 'no_simplecov' => true } do
   watch(%r{^test/(.*)_test\.rb})
-  watch(%r{^lib/(.+)\.rb}) do |m|
-    "test/lib/#{m[1]}_test.rb"
-  end
-  watch(%r{^test/test_helper\.rb})       { 'test' }
+  watch(%r{^lib/(.+)\.rb}) { |m| "test/lib/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb}) { 'test' }
+  watch(%r{^lib/(.+)all\.rb})      { 'test' }
 end
 
 guard :bundler do

data/README.md

@@ -9,7 +9,8 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based applicat
 
 ## Requirements
 
-Vedeu has been built on MacOSX 10.9/10.10 (Mavericks/Yosemite) with Ruby v2.1.
+Vedeu has been built primarily on MacOSX 10.9/10.10 (Mavericks/Yosemite) with
+ Ruby v2.1.
 
 Note: You may have trouble running Vedeu with Windows installations. (Pull requests welcome!)
 
@@ -107,7 +108,7 @@ Referring to the above example, interfaces have a name, and various default attr
 
 Note: not setting a width or height will set the values to the terminal's reported width and height.
 
-- `foreground` sets the default foreground colour. (See Colours)
+- `foreground` sets the default foreground colour.
 - `background` sets the default background colour.
 
 
@@ -121,34 +122,6 @@ More information about events can be found in the [RubyDoc](http://rubydoc.info/
 Geometry for Vedeu, as the same for ANSI terminals, is set top-left, which is cell/point 1, 1. Interfaces themselves have internal geometry which is handled automatically. Unless you are doing something special, you will probably only set it on a per-interface basis.
 
 
-### Colours
-
-Vedeu uses HTML/CSS style notation (i.e. '#aadd00'), they can be used at the stream level, the line level or for the whole interface. Terminals generally support either 8, 16 or 256 colours, with few supporting full 24-bit colour. Vedeu attempts to detect the colour depth using the `$TERM` environment variable.
-
-To set your `$TERM` variable to allow 256 colour support:
-
-```bash
-echo "export TERM=xterm-256color" >> ~/.bashrc
-```
-
-or, if you wish not to tamper with `$TERM`:
-
-```bash
-echo "export VEDEU_TERM=xterm-256color" >> ~/.bashrc
-```
-
-If you know your terminal supports full 24-bit colour, set the `$VEDEU_TERM` environment variable:
-
-```bash
-echo "export VEDEU_TERM=xterm-truecolor" >> ~/.bashrc
-```
-
-
-### Styles
-
-Vedeu has a range of symbol styles which are compatible with most terminals which are ANSI compatible. Like colours, they can be defined in either interfaces, for specific lines or within streams. Styles are applied as encountered.
-
-
 ## Debugging & Environment Variables
 
 Vedeu has two types of debugging; `VEDEU_DEBUG` and `VEDEU_TRACE`. Both of these can be configured at run-time using the arguments you pass to your application. They can also be enabled/disabled globally by setting environment variables (see below). These messages are written to `~/.vedeu/vedeu.log`.

data/Rakefile

@@ -7,7 +7,7 @@ require 'yard'
 require 'rubocop/rake_task'
 
 Cucumber::Rake::Task.new(:cucumber) do |t|
-  t.cucumber_opts = "features --format progress"
+  t.cucumber_opts = 'features --format progress'
 end
 
 Rake::TestTask.new(:test) do |t|
@@ -23,13 +23,13 @@ YARD::Rake::YardocTask.new(:yard) do |t|
     '-',
     'docs/api.md',
     'docs/getting_started.md',
-    'docs/views.md'
+    'docs/views.md',
   ]
 end
 
 Inch::Rake::Suggest.new(:inch) do |suggest|
-  suggest.args << "--pedantic"
-  suggest.args << "--all"
+  suggest.args << '--pedantic'
+  suggest.args << '--all'
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
@@ -38,4 +38,4 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = false
 end
 
-task :default => :test
+task default: :test

data/bin/vedeu_drb_client

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
-client = Vedeu::Distributed::Client.new("druby://localhost:21420")
+client = Vedeu::Distributed::Client.new('druby://localhost:21420')
 client.input('l')
 sleep 1
 client.shutdown

data/bin/vedeu_drb_server

@@ -1,113 +1,115 @@
 #!/usr/bin/env ruby
 
-lib_dir = "/Users/gavinlaking/Source/vedeu/lib/vedeu/distributed/../../../lib"
+lib_dir = '/Users/gavinlaking/Source/vedeu/lib/vedeu/distributed/../../../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# A simple test application for Vedeu.
+#
 class VedeuTestApplication
-  # include Vedeu
-
-Vedeu.configure do
-  colour_mode 16_777_216
-  log         '/tmp/vedeu_test_helper.log'
-  debug!
-  drb!
-  drb_host    'localhost'
-  drb_port    21420
-  drb_width   80
-  drb_height  25
-
-  # cooked!
-  # raw!
-
-  # run_once!
-
-  # interactive!
-  # standalone!
-
-  # trace!
-
-  # System keys can be redefined
-  # exit_key        'q'
-  # focus_next_key  :tab
-  # focus_prev_key  :shift_tab
-  # mode_switch_key :escape
-
-  # Not used yet
-  # stdin  File.open("/dev/tty", "r")
-  # stdout File.open("/dev/tty", "w")
-  # stderr File.open("/tmp/vedeu_error.log", "w+")
-end
 
-Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
-
-Vedeu.border 'test_interface' do
-  # Define colour and style of border
-  colour foreground: '#ffff00', background: '#0000ff'
-  style  'normal'
-
-  # Define visibility of border
-  show_bottom!
-  show_left!
-  show_right!
-  show_top!
-
-  # Define characters used to draw border
-  bottom_right '+'
-  bottom_left  '+'
-  horizontal   '-'
-  top_right    '+'
-  top_left     '+'
-  vertical     '|'
-end
+  Vedeu.configure do
+    colour_mode 16_777_216
+    log         '/tmp/vedeu_test_helper.log'
+    debug!
+    drb!
+    drb_host    'localhost'
+    drb_port    21_420
+    drb_width   80
+    drb_height  25
 
-Vedeu.geometry 'test_interface' do
-  # centred!
-  height 6
-  width  26
-  x      4
-  y      4
-end
+    # cooked!
+    # raw!
 
-Vedeu.interface 'test_interface' do
-  colour foreground: '#ff0000', background: '#000000'
-  cursor!
-end
+    # run_once!
 
-Vedeu.keymap 'test_interface' 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
+    # interactive!
+    # standalone!
 
-Vedeu.menu 'test_interface' do
-  # ...
-end
+    # trace!
+
+    # System keys can be redefined
+    # exit_key        'q'
+    # focus_next_key  :tab
+    # focus_prev_key  :shift_tab
+    # mode_switch_key :escape
+
+    # Not used yet
+    # stdin  File.open("/dev/tty", "r")
+    # stdout File.open("/dev/tty", "w")
+    # stderr File.open("/tmp/vedeu_error.log", "w+")
+  end
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.border 'test_interface' do
+    # Define colour and style of border
+    colour foreground: '#ffff00', background: '#0000ff'
+    style  'normal'
+
+    # Define visibility of border
+    show_bottom!
+    show_left!
+    show_right!
+    show_top!
+
+    # Define characters used to draw border
+    bottom_right '+'
+    bottom_left  '+'
+    horizontal   '-'
+    top_right    '+'
+    top_left     '+'
+    vertical     '|'
+  end
 
-Vedeu.renders do
-  view 'test_interface' do
-    lines do
-      line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
-      line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'
-      line 'a3b3c3d3e3f3g3h3i3j3k3l3m3n3o3p3q3r3s3t3u3v3w3x3y3z3'
-      line 'a4b4c4d4e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z4'
-      line 'a5b5c5d5e5f5g5h5i5j5k5l5m5n5o5p5q5r5s5t5u5v5w5x5y5z5'
-      line 'a6b6c6d6e6f6g6h6i6j6k6l6m6n6o6p6q6r6s6t6u6v6w6x6y6z6'
-      line 'a7b7c7d7e7f7g7h7i7j7k7l7m7n7o7p7q7r7s7t7u7v7w7x7y7z7'
-      line 'a8b8c8d8e8f8g8h8i8j8k8l8m8n8o8p8q8r8s8t8u8v8w8x8y8z8'
+  Vedeu.geometry 'test_interface' do
+    # centred!
+    height 6
+    width  26
+    x      4
+    y      4
+  end
+
+  Vedeu.interface 'test_interface' do
+    colour foreground: '#ff0000', background: '#000000'
+    cursor!
+  end
+
+  Vedeu.keymap 'test_interface' 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
+
+  Vedeu.menu 'test_interface' do
+    # ...
+  end
+
+  Vedeu.renders do
+    view 'test_interface' do
+      lines do
+        line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
+        line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'
+        line 'a3b3c3d3e3f3g3h3i3j3k3l3m3n3o3p3q3r3s3t3u3v3w3x3y3z3'
+        line 'a4b4c4d4e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z4'
+        line 'a5b5c5d5e5f5g5h5i5j5k5l5m5n5o5p5q5r5s5t5u5v5w5x5y5z5'
+        line 'a6b6c6d6e6f6g6h6i6j6k6l6m6n6o6p6q6r6s6t6u6v6w6x6y6z6'
+        line 'a7b7c7d7e7f7g7h7i7j7k7l7m7n7o7p7q7r7s7t7u7v7w7x7y7z7'
+        line 'a8b8c8d8e8f8g8h8i8j8k8l8m8n8o8p8q8r8s8t8u8v8w8x8y8z8'
+      end
     end
   end
-end
 
-  def self.start(argv   = ARGV,
-                 stdin  = STDIN,
+  def self.start(argv = ARGV,
+                 stdin = STDIN,
                  stdout = STDOUT,
                  stderr = STDERR,
                  kernel = Kernel)
     Vedeu::Launcher.execute!(argv, stdin, stdout, stderr, kernel)
   end
+
 end
 
 VedeuTestApplication.start(ARGV)

data/bin/vedeu_test

@@ -5,10 +5,14 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# A simple test application for Vedeu.
+#
 class VedeuTestApp
+
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
+
 end
 
 VedeuTestApp.start(ARGV)

data/config/rubocop_enabled.yml

@@ -47,7 +47,7 @@ Style/ArrayJoin:
 Style/AsciiComments:
   Description: 'Use only ascii symbols in comments.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
-  Enabled: true
+  Enabled: false
 
 Style/AsciiIdentifiers:
   Description: 'Use only ascii symbols in identifiers.'
@@ -74,18 +74,13 @@ Style/BlockComments:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-block-comments'
   Enabled: true
 
+Style/BlockDelimiters:
+  Enabled: false
+
 Style/BlockEndNewline:
   Description: 'Put end statement of multiline block on its own line.'
   Enabled: true
 
-Style/Blocks:
-  Description: >-
-                Avoid using {...} for multi-line blocks (multiline chaining is
-                always ugly).
-                Prefer {...} over do...end for single-line blocks.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
-  Enabled: true
-
 Style/BracesAroundHashParameters:
   Description: 'Enforce braces style around hash parameters.'
   Enabled: true
@@ -759,7 +754,7 @@ Metrics/BlockNesting:
 
 Metrics/ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'
-  Enabled: true
+  Enabled: false
 
 Metrics/CyclomaticComplexity:
   Description: >-

data/examples/borders_app.rb

@@ -8,10 +8,10 @@ require 'vedeu'
 # An example application to demonstrate borders.
 #
 class VedeuBordersApp
+
   include Vedeu
 
   configure do
-    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_borders_app.log'
   end
@@ -309,6 +309,7 @@ class VedeuBordersApp
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
+
 end
 
 VedeuBordersApp.start(ARGV)

data/examples/colours_app.rb

@@ -8,30 +8,35 @@ require 'vedeu'
 # An example application to demonstrate colours.
 #
 class VedeuColoursApp
+
   include Vedeu
 
   configure do
-    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_colours_app.log'
   end
 
   bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-  interface 'colours' do
+  interface 'colours_256' do
     geometry do
       centred!
-      height 8
-      width  8
+      height 16
+      width  80
     end
-    colour foreground: '#000000', background: '#000000'
   end
 
   renders do
-    view('colours') do
-      border!
+    view('colours_256') do
       lines do
-
+        0.upto(16) do |row|
+          line do
+            0.upto(15) do |column|
+              code = (row * 15) + column
+              right "#{code}", width: 5, background: code, foreground: '#ffffff'
+            end
+          end
+        end
       end
     end
   end

data/examples/configuration_app.rb

@@ -16,10 +16,10 @@ require 'vedeu'
 #
 # Use 'space' to refresh, 'q' to exit.
 class VedeuConfigurationApp
+
   include Vedeu
 
   configure do
-    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_configuration_app.log'
   end
@@ -35,7 +35,7 @@ class VedeuConfigurationApp
   renders do
     view 'config' do
       lines do
-        line Configuration.log.inspect + " " + Process.pid.to_s
+        line Configuration.log.inspect + ' ' + Process.pid.to_s
       end
     end
   end
@@ -47,6 +47,7 @@ class VedeuConfigurationApp
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
+
 end
 
 VedeuConfigurationApp.start(ARGV)

data/examples/cursor_app.rb

@@ -9,10 +9,10 @@ require 'vedeu'
 # the viewport of the interface in focus.
 #
 class VedeuCursorApp
+
   include Vedeu
 
   configure do
-    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_cursor_app.log'
   end
@@ -25,8 +25,8 @@ class VedeuCursorApp
 
     geometry do
       centred true
-      height  10
-      width   10
+      height  20
+      width   20
     end
   end
 
@@ -45,7 +45,7 @@ class VedeuCursorApp
       end
       lines do
         streams do
-          text 'A.3456789 '
+          text 'A.3 '
         end
         streams do
           background '#550000'
@@ -58,33 +58,37 @@ class VedeuCursorApp
       end
       lines do
         streams do
-          text 'B.3456789 lithium beryllium boron nitrogen'
+          text 'B.34 '
+          text 'lithium ', colour: { foreground: '#63d48e' }
+          text 'beryllium '
+          text 'boron', colour: { background: '#770033' }
+          text ' nitrogen'
         end
       end
       lines do
         streams do
-          text 'C.3456789'
+          text 'C.345'
           text ' carbon oxygen '
         end
         streams do
           background '#aadd00'
-          foreground '#000000'
+          foreground '#00ddaa'
           text 'fluorine'
         end
       end
       lines do
         streams do
-          text 'D.3456789'
+          text 'D.3456'
         end
       end
       lines do
         streams do
-          text 'E.3456789 neon sodium'
+          text 'E.34567 neon sodium', colour: { foreground: '#ffffff' }
         end
       end
       lines do
         streams do
-          text 'F.3456789 magnesium '
+          text 'F.345678 magnesium '
         end
         streams do
           foreground '#00aaff'
@@ -100,7 +104,7 @@ class VedeuCursorApp
         streams do
           background '#550000'
           foreground '#ff00ff'
-          text 'H.34'
+          text 'H.34567890'
         end
       end
     end
@@ -111,6 +115,7 @@ class VedeuCursorApp
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
+
 end
 
 VedeuCursorApp.start(ARGV)