vedeu 0.6.29 → 0.6.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc3caf904e10f4af35074e6b869c3ad65f96af2
-  data.tar.gz: fe00ef8a86cc1e6e4615361e9d57e30ed2f316fc
+  metadata.gz: ea4a90f4f35a50a9277083e0f25eb794c4bde66f
+  data.tar.gz: f88025c5b2d624ff2cd1f66ec06e52465157ea22
 SHA512:
-  metadata.gz: f0c354b58c059144923e853c58d3a3b5d5ac31b194f51362cb876c9182fa2fde1003781963b1b3fc69e17e36e830af7f4c6ad6f053b67003289345eed811c9d3
-  data.tar.gz: 2c618148a9cf0f395c110ba0b4e9d1aa845966f1c9d2d1d771860bb27f808b24502e66550aac3c6fdf9e677bb3ed653a5d3d50c0b0259e73564d3192e5164a4f
+  metadata.gz: 346ade00d603a72378c0da55b48650c87335ededb334f576ebee3fb0c1249c66af74574aa90bd4ebe21e38eb651b7862b523ebe2e536a7734c057fa09c500718
+  data.tar.gz: cba34e4d351846db0e2d08de4f125a25674d8430badf95e4820db70ed8fa66b502476ad8e1499f758f19d50029bb9907253024ea15172b66d918784fe4d80a16

data/.yardopts

@@ -24,4 +24,5 @@ docs/events/menu.md
 docs/events/movement.md
 docs/events/refresh.md
 docs/events/system.md
+docs/events/view.md
 docs/events/visibility.md

data/Guardfile

@@ -1,11 +1,12 @@
-guard :rubocop do
-  watch(/.+\.rb$/)
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+if ENV['RUBOCOP']
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end
 
 guard :minitest, all_after_pass: true,
-                 focus_on_failed: true,
-                 env: { 'NO_SIMPLECOV' => true } do
+                 focus_on_failed: true do
   watch(%r{^test/(.*)_test\.rb})
   watch(%r{^lib/(.+)\.rb}) { |m| "test/lib/#{m[1]}_test.rb" }
   watch(%r{^test/test_helper\.rb}) { 'test' }

data/README.md

@@ -75,17 +75,63 @@ Pull requests are very welcome! Please try to follow these simple rules if
 * Make sure your patches are well tested.
 * Update the [Yard](http://yardoc.org/) documentation.
   (Use `yard stats --list-undoc` to locate undocumented code)
-* Update the [README](https://github.com/gavinlaking/vedeu/blob/master/README.md).
+* Update the
+  [README](https://github.com/gavinlaking/vedeu/blob/master/README.md),
+  if appropriate.
 * Please **do not change** the version number.
 
+Raising issues and finding bugs, updating documentation and improving
+ the code are all welcome contributions. I may also have left some TODO
+ items lying around, which you're quite welcome to and can find
+ with either Yard, or git:
+
+    yard list --query '@todo'
+
+    git grep --line-number '@todo'
+
+
 Any branch on the repository that is not `master` is probably experimental; do
  not rely on anything in these branches. Typically, `twerks` will be merged
  into `master` before a release, and branches prefixed with `spike/` are me
- playing with ideas.
+ playing with ideas- they aren't guaranteed to work at all.
 
-I may have left some TODO items lying around, which you can find with:
+Various environment variables are available to you to help with testing, all of
+ which can be used in combination, prefaced to `rake`:
+
+- Produce statistics on the slowest performing parts of the
+  application/tests. Useful when used multiple times. See
+  `test/test_helper.rb` for configuration.
+
+        PERFORMANCE=1 rake
+
+- Produce a 'SimpleCov' test coverage report in the `coverage/`
+  directory.
+
+        SIMPLECOV=1 rake
+
+- Produces a 'SimpleCov' test coverage report with output to the
+  console.
+
+        CONSOLE_COVERAGE=1 rake
+
+- Enable Ruby's warnings mode (this can usually be quote verbose, but
+  thankfully more so with gem dependencies rather than Vedeu itself).
+
+        WARNINGS=1 rake
+
+- Disable Ruby's garbage collection for this test run.
+
+        DISABLE_GC=1 rake
+
+- Use Rubocop to catch coding misdemeanours for this test run. (Or
+  use `rake rubocop`).
+
+        RUBOCOP=1 rake
+
+- Build the Yard documentation for the project. (Or use `rake yard`).
+
+        YARD=1 rake
 
-    yard list --query '@todo'
 
 ### General contribution help
 

data/Rakefile

@@ -8,7 +8,7 @@ Rake::TestTask.new(:test) do |task|
   task.libs.push 'test'
   task.pattern = 'test/**/*_test.rb'
   task.verbose = false
-  task.warning = false # set to true for Ruby warnings (ruby -w)
+  task.warning = true if ENV['WARNINGS']
 end
 
 YARD::Rake::YardocTask.new(:yard) do |task|
@@ -16,11 +16,19 @@ YARD::Rake::YardocTask.new(:yard) do |task|
     'lib/**/*.rb',
     '-',
     '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/keymaps.md',
     'docs/object_graph.md',
+    'docs/view.md',
     'docs/events/application.md',
     'docs/events/document.md',
     'docs/events/drb.md',
@@ -32,14 +40,18 @@ YARD::Rake::YardocTask.new(:yard) do |task|
     'docs/events/view.md',
     'docs/events/visibility.md',
   ]
-  task.options = ['--highlight']
+  task.options = ['highlight']
   task.stats_options = ['--list-undoc']
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.patterns = ['lib/**/*.rb']
-  task.formatters = ['progress']
+  task.formatters = ['simple']
   task.fail_on_error = false
 end
 
-task default: :test
+tasks_to_run = [:test]
+tasks_to_run << :rubocop if ENV['RUBOCOP']
+tasks_to_run << :yard if ENV['YARD']
+
+task default: tasks_to_run

data/docs/dsl.md

@@ -129,9 +129,9 @@ end
 
 ## Keymaps
 
-{include:Vedeu::Keymaps::DSL}
-{include:Vedeu::Keymaps::DSL.keymap}
-{include:Vedeu::Keymaps::DSL#name}
+{include:Vedeu::Input::DSL}
+{include:Vedeu::Input::DSL.keymap}
+{include:Vedeu::Input::DSL#name}
 
 ## Menus
 

data/lib/vedeu/all.rb

@@ -1,17 +1,16 @@
 require 'vedeu/version'
 
+require 'vedeu/common'
+require 'vedeu/configuration/api'
+require 'vedeu/configuration/configuration'
+require 'vedeu/repositories/all'
+require 'vedeu/events/all'
+require 'vedeu/esc/all'
 require 'vedeu/logging/all'
 require 'vedeu/options'
-
 require 'vedeu/error'
-require 'vedeu/common'
 require 'vedeu/runtime/all'
-
-require 'vedeu/configuration/api'
-require 'vedeu/configuration/configuration'
-
 require 'vedeu/terminal/all'
-require 'vedeu/repositories/all'
 
 require 'vedeu/models/toggleable'
 
@@ -37,7 +36,6 @@ require 'vedeu/colours/all'
 require 'vedeu/cursors/all'
 require 'vedeu/distributed/all'
 require 'vedeu/editor/all'
-require 'vedeu/events/all'
 require 'vedeu/geometry/all'
 require 'vedeu/groups/all'
 require 'vedeu/input/all'

data/lib/vedeu/bindings/all.rb

@@ -16,19 +16,49 @@ module Vedeu
   #
   module Bindings
 
+    extend self
+
+    # Setup events for running Vedeu. This method is called by Vedeu.
+    #
+    # @return [TrueClass]
+    def setup!
+      cleanup!
+      command!
+      drb_input!
+
+      true
+    end
+
+    private
+
+    # See {file:docs/events/system.md#\_cleanup_}
+    def cleanup!
+      Vedeu.bind(:_cleanup_) do
+        Vedeu.trigger(:_drb_stop_)
+        Vedeu.trigger(:cleanup)
+      end
+    end
+
+    # See {file:docs/events/system.md#\_command_}
+    def command!
+      Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
+    end
+
+    # See {file:docs/events/drb.md#\_drb_input_}
+    def drb_input!
+      Vedeu.bind(:_drb_input_) do |data, type|
+        Vedeu.log(type: :drb, message: "Sending input (#{type})".freeze)
+
+        case type
+        when :command  then Vedeu.trigger(:_command_, data)
+        when :keypress then Vedeu.trigger(:_keypress_, data)
+        else Vedeu.trigger(:_keypress_, data)
+        end
+      end
+    end
+
   end # Bindings
 
-end # Vedeu
+  Vedeu::Bindings.setup!
 
-require 'vedeu/bindings/application'
-require 'vedeu/bindings/cursors'
-require 'vedeu/bindings/document'
-require 'vedeu/bindings/drb'
-require 'vedeu/bindings/menus'
-require 'vedeu/bindings/movement'
-require 'vedeu/bindings/focus'
-require 'vedeu/bindings/refresh'
-require 'vedeu/bindings/system'
-require 'vedeu/bindings/view'
-require 'vedeu/bindings/visibility'
-require 'vedeu/bindings/bindings'
+end # Vedeu

data/lib/vedeu/borders/border.rb

@@ -129,13 +129,36 @@ module Vedeu
       #   character.
       # @return [Vedeu::Borders::Border]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end
 
+      # @return [Hash]
+      def attributes
+        {
+          bottom_left:  @bottom_left,
+          bottom_right: @bottom_right,
+          caption:      @caption,
+          client:       @client,
+          colour:       @colour,
+          enabled:      @enabled,
+          horizontal:   @horizontal,
+          name:         @name,
+          parent:       @parent,
+          repository:   @repository,
+          show_bottom:  @show_bottom,
+          show_left:    @show_,
+          show_right:   @show_,
+          show_top:     @show_,
+          style:        @style,
+          title:        @title,
+          top_left:     @top_left,
+          top_right:    @top_right,
+          vertical:     @vertical,
+        }
+      end
+
       # @return [Fixnum]
       def bx
         (enabled? && left?) ? x + 1 : x

data/lib/vedeu/borders/refresh.rb

@@ -362,4 +362,9 @@ module Vedeu
 
   end # Borders
 
+  # See {file:docs/events/refresh.md#\_refresh_border_}
+  Vedeu.bind(:_refresh_border_) do |name|
+    Vedeu::Borders::Refresh.by_name(name)
+  end
+
 end # Vedeu

data/lib/vedeu/buffers/refresh.rb

@@ -74,4 +74,14 @@ module Vedeu
 
   end # Buffers
 
+  # See {file:docs/events/refresh.md#\_refresh_view_}
+  Vedeu.bind(:_refresh_view_) do |name|
+    Vedeu::Buffers::Refresh.by_name(name)
+  end
+
+  # See {file:docs/events/refresh.md#\_refresh_view_content_}
+  Vedeu.bind(:_refresh_view_content_) do |name|
+    Vedeu::Buffers::Refresh.refresh_content_by_name(name)
+  end
+
 end # Vedeu

data/lib/vedeu/cursors/cursor.rb

@@ -313,4 +313,63 @@ module Vedeu
   def_delegators Vedeu::Cursors::Cursor, :hide_cursor, :show_cursor,
                  :toggle_cursor
 
+  # See {file:docs/events/visibility.md#\_hide_cursor_}
+  Vedeu.bind(:_hide_cursor_) { |name| Vedeu.hide_cursor(name) }
+  # Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
+
+  # See {file:docs/events/visibility.md#\_show_cursor_}
+  Vedeu.bind(:_show_cursor_) { |name| Vedeu.show_cursor(name) }
+  # Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
+
+  # See {file:docs/events/visibility.md#\_toggle_cursor_}
+  Vedeu.bind(:_toggle_cursor_) { |name| Vedeu.toggle_cursor(name) }
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_left_) do |name|
+    Vedeu.cursors.by_name(name).move_left
+
+    Vedeu.trigger(:_refresh_cursor_, name)
+  end
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_down_) do |name|
+    Vedeu.cursors.by_name(name).move_down
+
+    Vedeu.trigger(:_refresh_cursor_, name)
+  end
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_up_) do |name|
+    Vedeu.cursors.by_name(name).move_up
+
+    Vedeu.trigger(:_refresh_cursor_, name)
+  end
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_right_) do |name|
+    Vedeu.cursors.by_name(name).move_right
+
+    Vedeu.trigger(:_refresh_cursor_, name)
+  end
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_origin_) do |name|
+    Vedeu.cursors.by_name(name).move_origin
+  end
+  # Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_position_) do |name|
+    Vedeu.cursors.by_name(name).to_a
+  end
+
+  # See {file:docs/cursors.md}
+  Vedeu.bind(:_cursor_reposition_) do |name, y, x|
+    Vedeu.cursors.by_name(name).reposition(y, x)
+
+    Vedeu.trigger(:_clear_view_, name)
+    Vedeu.trigger(:_refresh_view_, name)
+    Vedeu.trigger(:_refresh_cursor_, name)
+  end
+
 end # Vedeu

data/lib/vedeu/cursors/refresh.rb

@@ -86,4 +86,9 @@ module Vedeu
 
   end # Cursors
 
+  # See {file:docs/events/refresh.md#\_refresh_cursor_}
+  Vedeu.bind(:_refresh_cursor_) do |name|
+    Vedeu::Cursors::Refresh.by_name(name)
+  end
+
 end # Vedeu

data/lib/vedeu/distributed/server.rb

@@ -249,4 +249,16 @@ module Vedeu
   def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
                  :drb_status, :drb_stop
 
+  # See {file:docs/events/drb.md#\_drb_restart_}
+  Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
+
+  # See {file:docs/events/drb.md#\_drb_start_}
+  Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
+
+  # See {file:docs/events/drb.md#\_drb_status_}
+  Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
+
+  # See {file:docs/events/drb.md#\_drb_stop_}
+  Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
+
 end # Vedeu

data/lib/vedeu/distributed/subprocess.rb

@@ -74,7 +74,7 @@ module Vedeu
 
       # @return [Fixnum] The number of files removed; 1.
       def file_unlink
-        File.unlink("/tmp/foo_#{timestamp}".freeze)
+        File.unlink(file_name)
       end
 
       # return [String]
@@ -84,10 +84,15 @@ module Vedeu
 
       # @return [File]
       def file_open
-        @file ||= File.new("/tmp/foo_#{timestamp}", 'w', 0755)
+        @file ||= File.new(file_name, 'w', 0755)
       end
       alias_method :file, :file_open
 
+      # @return [String]
+      def file_name
+        "/tmp/foo_#{timestamp}".freeze
+      end
+
       # return [Fixnum]
       def timestamp
         @timestamp ||= Time.now.to_i