vedeu 0.6.40 → 0.6.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 143043509ebfddd83c874d02592cc32490dcd663
-  data.tar.gz: 05f8618fb7ab1f6a88ac7221794967bd58307022
+  metadata.gz: 7db3488d578544ebd7396a2c9729aa8d197c29d0
+  data.tar.gz: ae67cc4985f4acb9989b6ca86ba0d6b2035b06ba
 SHA512:
-  metadata.gz: 95e3e2d995ff6aa700a07e17dd8f462ad412b8df1d17c6a74f0a773e1ca0ef6dabe4100e526bf9c9e9860d3cc440968717c1667c0ded6fe3939857bcdd1d5860
-  data.tar.gz: 45022ead54702e4ce916c0e057cd78d2987c507cd41223a11f2988a254faf200a851739f96b77e4deb81c01b0a5023b30e77afadd6ba7dc259abd9c5c4f98875
+  metadata.gz: dd84a463c30f4169ad8ec50134fdd16d638d2d5557c4b18d05dab2016a0d190735764ad86cade780e6a10596dcc288e162e5dd759c33ac4aa2501d94341a2dfa
+  data.tar.gz: 298aea3fceff6d65d62af1821f5feebe71bbabec593e17f63be2852abd930b5f9f250e4152eee043a4dc05b7c7cb8b92b6d1d2cdd47b769d353feab15b410bde

data/.rubocop.yml

@@ -21,6 +21,7 @@ AllCops:
     - '**/Cheffile'
     - '**/Vagabondfile'
   Exclude:
+    - 'benchmarks/**/*'
     - 'examples/**/*'
     - 'test/**/*'
     - 'vendor/**/*'

data/.yardopts

@@ -5,8 +5,12 @@
 docs/api.md
 docs/borders.md
 docs/buffer.md
+docs/cell.md
+docs/chars.md
+docs/colours_styles.md
 docs/configuration.md
 docs/cursors.md
+docs/debugging.md
 docs/dsl.md
 docs/events.md
 docs/geometry.md
@@ -15,8 +19,11 @@ docs/group.md
 docs/input.md
 docs/interfaces.md
 docs/keymaps.md
+docs/lines.md
 docs/object_graph.md
 docs/output.md
+docs/streams.md
+docs/template.md
 docs/view.md
 docs/events/application.md
 docs/events/document.md

data/README.md

@@ -20,6 +20,16 @@ have any problems with either of these operating systems.
 **Note**: You may have trouble running Vedeu with Windows installations. (Pull
  requests welcome!)
 
+## Dependencies
+
+Vedeu relies on the following gems, these will be automatically
+ installed when you install Vedeu (as documented below).
+
+- bundler
+- rake
+- ruby-prof
+- thor
+- vedeu_cli
 
 ## Installation
 

data/benchmarks/array_vs_range.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+# To test the suitability of using a range to determine a valid
+# coordinate instead of the current array method as used in
+# Vedeu::Terminal::Buffer#within_terminal_boundary?
+#
+# vedeu/benchmarks:spike/benchmarking$ ./array_vs_range.rb
+# Calculating -------------------------------------
+#                array   202.400k i/100ms
+#                range   130.641k i/100ms
+# -------------------------------------------------
+#                array      8.171M (± 0.1%) i/s -     40.885M
+#                range      2.471M (± 0.4%) i/s -     12.411M
+#
+# Comparison:
+#                array:  8170584.0 i/s
+#                range:  2470528.5 i/s - 3.31x slower
+#
+
+require "bundler/setup"
+require "benchmark/ips"
+
+YN   = 60
+XN   = 140
+GRID = Array.new(YN) { |y| Array.new(XN) { |x| :"grid_#{y}_#{x}" } }
+Y    = rand(YN)
+X    = rand(XN)
+
+def fast
+  GRID[Y] && GRID[Y][X]
+end
+
+def slow
+  (0..YN).cover?(Y) && (0..XN).cover?(X)
+end
+
+Benchmark.ips do |x|
+  x.report("array") { fast }
+  x.report("range") { slow }
+  x.compare!
+end

data/docs/api.md

@@ -28,6 +28,13 @@ methods are used in a variety of ways, sometimes in combination:
     # with other methods
     Vedeu.method_name.other_method
 
+Nearly all of the API methods have associated
+{file:docs/events.md Vedeu Events} which you can bind to or trigger to
+achieve the same effect. It is favoured that you trigger events
+instead of calling API methods as this gives you a bit more visibility
+when debugging, and flexibility when running your application.
+However, how you build your application is up to you! (Of course!)
+
 ## Configuration
 
 See {file:docs/configuration.md}

data/docs/colours_styles.md

@@ -5,4 +5,8 @@
 
 ## Vedeu Background Colours
 
+More coming soon.
+
 ## Vedeu Foreground Colours
+
+More coming soon.

data/docs/debugging.md

@@ -0,0 +1,19 @@
+# @title Debugging Vedeu
+# Debugging Vedeu
+
+If you are encountering a problem whilst running your client
+application, using Vedeu, and have the 'pry' gem installed or
+available, you can drop the following snippet into the offending area,
+and hopefully be dropped into a Pry debuggging session:
+
+    Vedeu::Terminal.cooked_mode!
+    Vedeu::Terminal.open do
+      show_cursor = Vedeu::EscapeSequences::Esc.string('show_cursor')
+      Vedeu::Terminal.output(show_cursor)
+
+      require 'pry'
+      binding.pry
+
+    end
+    Vedeu::Terminal.raw_mode!
+

data/docs/template.md

@@ -1,3 +1,4 @@
 # @title Vedeu View Templates
 # Vedeu View Templates
 
+More coming soon.

data/examples/284_slow_rendering.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vedeu'
+
+class EditorApp
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.configure do
+    debug!
+    log '/tmp/284_slow_rendering.log'
+    # renderers Vedeu::Renderers::File.new(filename: '/tmp/284_slow.out')
+    fake!
+  end
+
+  Vedeu.interface :editor_view do
+    border do
+      title 'Editor'
+    end
+    editable!
+    geometry do
+      align(:bottom, :left, Vedeu.width - 21, 10)
+    end
+  end
+
+  Vedeu.interface :members_view do
+    border do
+      title 'Members'
+    end
+    editable!
+    geometry do
+      align(:top, :right, 20, Vedeu.height)
+    end
+  end
+
+  Vedeu.interface :help_view do
+    geometry do
+      height use(:editor_view).height
+      width  use(:editor_view).width
+      x      use(:editor_view).left
+      y      use(:editor_view).south
+    end
+  end
+
+  # When pressing Return/Enter in the editor view, the :_command_
+  # event will be triggered with any typed content you have provided.
+  #
+  # The :_command_ event in turn triggers the :command event. Bind to
+  # :command to retrieve the content entered, and then process
+  # yourself in whatever way appropriate.
+  #
+  #     Vedeu.bind(:command) do |data|
+  #        # ... do something with 'data'
+  #     end
+  #
+  Vedeu.keymap :editor_view do
+    key(:enter) { Vedeu.trigger(:_editor_execute_, :editor_view) }
+    key(:insert) do
+      Vedeu.log(type:    :debug,
+                message: "Commands: #{Vedeu.all_commands.inspect}")
+      Vedeu.log(type:    :debug,
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
+    end
+  end
+
+  Vedeu.keymap '_global_' do
+    key('q') { Vedeu.exit }
+  end
+
+  Vedeu.render do
+    view(:editor_view) do
+    end
+  end
+
+  Vedeu.render do
+    view(:help_view) do
+      lines do
+        line 'Type into the editor dialog above,'
+        line 'and press Return. This will trigger the'
+        line ':command event with the contents of '
+        line 'the view.'
+
+        # @todo Not implemented yet:
+        #
+        # text 'Type into the editor dialog above, and press Return. This will ' \
+        #      'trigger the :_command_ event with the contents of the view.',
+        #      name: :help_view, mode: :wrap
+      end
+    end
+
+    view(:member_view) do
+      lines do
+        line ''
+      end
+    end
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # EditorApp
+
+EditorApp.start

data/lib/vedeu/borders/dsl.rb

@@ -347,6 +347,7 @@ module Vedeu
 
   # @!method border
   #   @see Vedeu::Borders::DSL.border
-  def_delegators Vedeu::Borders::DSL, :border
+  def_delegators Vedeu::Borders::DSL,
+                 :border
 
 end # Vedeu

data/lib/vedeu/borders/repository.rb

@@ -23,7 +23,8 @@ module Vedeu
   #
   # @!method borders
   # @return [Vedeu::Borders::Repository]
-  def_delegators Vedeu::Borders::Repository, :borders
+  def_delegators Vedeu::Borders::Repository,
+                 :borders
 
   # :nocov:
 

data/lib/vedeu/buffers/repository.rb

@@ -28,6 +28,7 @@ module Vedeu
   #
   # @!method buffers
   # @return [Vedeu::Buffers::Repository]
-  def_delegators Vedeu::Buffers::Repository, :buffers
+  def_delegators Vedeu::Buffers::Repository,
+                 :buffers
 
 end # Vedeu

data/lib/vedeu/colours/backgrounds.rb

@@ -23,6 +23,7 @@ module Vedeu
 
   # @!method background_colours
   # @return [Vedeu::Colours::Backgrounds]
-  def_delegators Vedeu::Colours::Backgrounds, :background_colours
+  def_delegators Vedeu::Colours::Backgrounds,
+                 :background_colours
 
 end # Vedeu

data/lib/vedeu/colours/foregrounds.rb

@@ -23,6 +23,7 @@ module Vedeu
 
   # @!method foreground_colours
   # @return [Vedeu::Colours::Foregrounds]
-  def_delegators Vedeu::Colours::Foregrounds, :foreground_colours
+  def_delegators Vedeu::Colours::Foregrounds,
+                 :foreground_colours
 
 end # Vedeu

data/lib/vedeu/configuration/configuration.rb

@@ -353,6 +353,8 @@ module Vedeu
   #   @see Vedeu::Configuration.configure
   # @!method configuration
   #   @see Vedeu::Configuration.configuration
-  def_delegators Vedeu::Configuration, :configure, :configuration
+  def_delegators Vedeu::Configuration,
+                 :configure,
+                 :configuration
 
 end # Vedeu

data/lib/vedeu/cursors/cursor.rb

@@ -316,7 +316,9 @@ module Vedeu
   #   @see Vedeu::Toggleable::ClassMethods#show
   # @!method toggle_cursor
   #   @see Vedeu::Toggleable::ClassMethods#toggle
-  def_delegators Vedeu::Cursors::Cursor, :hide_cursor, :show_cursor,
+  def_delegators Vedeu::Cursors::Cursor,
+                 :hide_cursor,
+                 :show_cursor,
                  :toggle_cursor
 
   # :nocov:

data/lib/vedeu/cursors/repository.rb

@@ -37,7 +37,8 @@ module Vedeu
 
   # @!method cursor
   #   @see Vedeu::Cursors::Repository.cursor
-  def_delegators Vedeu::Cursors::Repository, :cursor
+  def_delegators Vedeu::Cursors::Repository,
+                 :cursor
 
   # Manipulate the repository of cursors.
   #
@@ -46,6 +47,7 @@ module Vedeu
   #
   # @!method cursors
   # @return [Vedeu::Cursors::Repository]
-  def_delegators Vedeu::Cursors::Repository, :cursors
+  def_delegators Vedeu::Cursors::Repository,
+                 :cursors
 
 end # Vedeu

data/lib/vedeu/distributed/server.rb

@@ -246,8 +246,11 @@ module Vedeu
   #   @see Vedeu::Distributed::Server#status
   # @!method drb_stop
   #   @see Vedeu::Distributed::Server#stop
-  def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
-                 :drb_status, :drb_stop
+  def_delegators Vedeu::Distributed::Server,
+                 :drb_restart,
+                 :drb_start,
+                 :drb_status,
+                 :drb_stop
 
   # :nocov:
 

data/lib/vedeu/dsl/view.rb

@@ -253,6 +253,9 @@ module Vedeu
   #   @see Vedeu::DSL::View.renders
   # @!method views
   #   @see Vedeu::DSL::View.views
-  def_delegators Vedeu::DSL::View, :renders, :render, :views
+  def_delegators Vedeu::DSL::View,
+                 :renders,
+                 :render,
+                 :views
 
 end # Vedeu

data/lib/vedeu/editor/document.rb

@@ -64,6 +64,7 @@ module Vedeu
           @lines = lines.delete_character(y, x - 1)
 
           left
+
         end
       end
 
@@ -76,6 +77,8 @@ module Vedeu
         up
 
         eol
+
+        refresh
       end
 
       # Returns the document as a string with line breaks if there is
@@ -105,6 +108,8 @@ module Vedeu
         @lines = lines.insert_character(character, y, x)
 
         right
+
+        refresh
       end
 
       # Insert an empty line.
@@ -116,6 +121,8 @@ module Vedeu
         down
 
         bol
+
+        refresh
       end
 
       # Returns the current line from the collection of lines.
@@ -166,9 +173,7 @@ module Vedeu
       def left
         return self if x - 1 < 0
 
-        cursor.left
-
-        refresh
+        cursor.left.refresh
       end
 
       # Move the virtual cursor right.
@@ -177,9 +182,7 @@ module Vedeu
       def right
         return self if x + 1 > line.size
 
-        cursor.right
-
-        refresh
+        cursor.right.refresh
       end
 
       # Move the virtual cursor up.
@@ -188,7 +191,7 @@ module Vedeu
       def up
         return self if y - 1 < 0
 
-        cursor.up
+        cursor.up.refresh
 
         if x > line(y).size
           eol
@@ -205,7 +208,7 @@ module Vedeu
       def down
         return self if y + 1 >= lines.size
 
-        cursor.down
+        cursor.down.refresh
 
         if x > line(y).size
           eol
@@ -220,9 +223,7 @@ module Vedeu
       #
       # @return [Vedeu::Editor::Document]
       def bol
-        cursor.bol
-
-        refresh
+        cursor.bol.refresh
       end
 
       # Move the virtual cursor to the end of the line.
@@ -231,7 +232,7 @@ module Vedeu
       def eol
         cursor.x = line.size
 
-        refresh
+        cursor.refresh
       end
 
       private