vedeu 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50414317727dc7045eeb48bcc676bf11fd67a06b
-  data.tar.gz: c4d967105b00a59ddda739d06373b9a63653e3f9
+  metadata.gz: 12b0fae6d703370299d64a60380bda994664cf33
+  data.tar.gz: fb74af1f981c87f9bc09df39f5b111c24e4b42b3
 SHA512:
-  metadata.gz: 02424b6a19fb5f4d88ea39e7502cf47f2b56a2401c84504f6da103fd358109665060a4420f24700bd24580c7656c8b2646ceb759ff4d4ab82c2f03bccca19366
-  data.tar.gz: c5eac73a0ad542d6178a6fb8a3998b1a4d6404770d2b320c06e2e173cc53768a2ef710f8dd75e700058be4f4a427df604a9b659293389e63749bf522fca4f624
+  metadata.gz: 861586738502f76491398375e341d13e6ac35d90d0a04d229760e654ef00fbf3a00d64dea83915fc6c6d9d7d941abf8b013b14eeb6b9e7ccf84c7f0e72c7610e
+  data.tar.gz: cab8c0a2fe8d6fa5612e44199986d24c22b60719568a83aba280ec3a02951049141b507c5fabd9d12c1051e0dda432f3231386741cde6d470da5474e86763d7d

data/.yardopts

@@ -3,5 +3,4 @@
 --embed-mixin ClassMethods
 -
 docs/api.md
-docs/events.md
 docs/getting_started.md

data/README.md

@@ -9,9 +9,9 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based applicat
 
 ## Requirements
 
-Vedeu has been built on MacOSX 10.9 (Mavericks) with Ruby v2.1.2.
+Vedeu has been built on MacOSX 10.9/10.10 (Mavericks/Yosemite) with Ruby v2.1.
 
-Note: You may have trouble running Vedeu with Windows installations.
+Note: You may have trouble running Vedeu with Windows installations. (Pull requests welcome!)
 
 
 ## Installation
@@ -113,7 +113,7 @@ Note: not setting a width or height will set the values to the terminal's report
 
 ### Events
 
-More information about events can be found here: [Vedeu Events](http://www.rubydoc.info/github/gavinlaking/vedeu/file/docs/events.md)
+More information about events can be found in the [RubyDoc](http://rubydoc.info/github/gavinlaking/vedeu/master/frames).
 
 
 ### Geometry

data/lib/vedeu/bindings.rb

@@ -96,26 +96,28 @@ module Vedeu
     # events. Please see those events for their behaviour.
     Vedeu.bind(:_resize_, { delay: 0.25 }) { Vedeu.resize }
 
-    # Hide the cursor of the interface currently in focus.
-    Vedeu.bind(:_cursor_hide_) do
-      ToggleCursor.hide(Vedeu.cursor)
-    end
+    # Hide the cursor of the named interface or interface currently in focus.
+    Vedeu.bind(:_cursor_hide_) do |name|
+      named = if name
+        Vedeu.cursors.by_name(name)
 
-    # Show the cursor of the interface currently in focus.
-    Vedeu.bind(:_cursor_show_) do
-      ToggleCursor.show(Vedeu.cursor)
-    end
+      else
+        Vedeu.cursor
 
-    # Hide the cursor of the named interface.
-    Vedeu.bind(:_cursor_hide_by_name_) do |name|
-      named = Vedeu.cursors.by_name(name)
+      end
 
       ToggleCursor.hide(named)
     end
 
-    # Show the cursor of the named interface.
-    Vedeu.bind(:_cursor_show_by_name_) do |name|
-      named = Vedeu.cursors.by_name(name)
+    # Show the cursor of the named interface or interface currently in focus.
+    Vedeu.bind(:_cursor_show_) do |name|
+      named = if name
+        Vedeu.cursors.by_name(name)
+
+      else
+        Vedeu.cursor
+
+      end
 
       ToggleCursor.show(named)
     end

data/lib/vedeu/events/event.rb

@@ -6,6 +6,32 @@ module Vedeu
 
   # Contains all the logic of an event. Handles debouncing and throttling.
   #
+  # Vedeu provides an event mechanism to facilitate the functionality of your
+  # application. The events are either Vedeu defined, ie. system events or user
+  # defined, ie. user events. User events allow you to orchestrate behaviour
+  # within your application, ie. the user presses a specific key, you trigger an
+  # event to make something happen. Eg. pressing 'p' instructs the player to
+  # play.
+  #
+  # Events described here assume that you have either included Vedeu in your
+  # class:
+  #
+  # class SomeClassInYourApplication
+  #   include Vedeu
+  #
+  #   bind :event_name do |arg1, arg2|
+  #     # Things that should happen when the event is triggered; these can be
+  #     # method calls or the triggering of another event or events.
+  #   end
+  #
+  # or, you are prepared to use the `Vedeu` prefix:
+  #
+  # class SomeClassInYourApplication
+  #   Vedeu.bind(:event_name) do
+  #     # Not all events you define will have arguments; like methods.
+  #     :do_stuff
+  #   end
+  #
   # @api private
   #
   class Event
@@ -31,7 +57,7 @@ module Vedeu
       #
       # @example
       #   Vedeu.bind :my_event do |some, args|
-      #     ... some code here ...
+      #     # ... some code here ...
       #
       #     Vedeu.trigger(:my_other_event)
       #   end
@@ -43,7 +69,7 @@ module Vedeu
       #   .X...i...i...i...i...X...i...i...i...i...X...i...i...i...i...i...i...i
       #
       #   Vedeu.bind(:my_delayed_event, { delay: 0.5 })
-      #     ... some code here ...
+      #     # ... some code here ...
       #   end
       #
       #   T = Triggered, X = Executed, i = Ignored.
@@ -53,7 +79,7 @@ module Vedeu
       #   .i...i...i...i...i...i...i...X...i...i...i...i...i...i...X...i...i...i
       #
       #   Vedeu.bind(:my_debounced_event, { debounce: 0.7 })
-      #     ... some code here ...
+      #     # ... some code here ...
       #   end
       #
       # @return [TrueClass]

data/lib/vedeu/main_loop.rb

@@ -2,6 +2,10 @@ module Vedeu
 
   # Provides the main loop for a Vedeu application.
   #
+  # Each time Vedeu starts one cycle in the application loop, it triggers the
+  # `:tick` event. A completion of that cycle will trigger `:tock`. This can be
+  # used by the client application for timing amongst other things.
+  #
   class MainLoop
 
     trap('SIGTERM') { stop! }
@@ -17,7 +21,7 @@ module Vedeu
       @loop    = true
 
       while(@loop) do
-        Vedeu.trigger(:_tick_)
+        Vedeu.trigger(:tick)
 
         yield
 
@@ -45,7 +49,7 @@ module Vedeu
         fail VedeuInterrupt
 
       else
-        Vedeu.trigger(:_tock_)
+        Vedeu.trigger(:tock)
 
       end
     end

data/test/lib/vedeu/bindings_test.rb

@@ -17,8 +17,6 @@ module Vedeu
     context 'the cursor specific events are defined' do
       it { Vedeu.events.registered?(:_cursor_hide_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_show_).must_equal(true) }
-      it { Vedeu.events.registered?(:_cursor_hide_by_name_).must_equal(true) }
-      it { Vedeu.events.registered?(:_cursor_show_by_name_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_down_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_left_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_right_).must_equal(true) }

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.4.0'
+  spec.version       = '0.4.1'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = %q{A terminal case of wonderland.}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gavin Laking
@@ -275,7 +275,6 @@ files:
 - bin/vedeu_test
 - config/cucumber.yml
 - docs/api.md
-- docs/events.md
 - docs/getting_started.md
 - docs/views.md
 - examples/borders_app.rb

data/docs/events.md

@@ -1,63 +0,0 @@
-## Vedeu Events
-
-Vedeu provides an event mechanism to facilitate the functionality of your application. The events are either Vedeu defined, ie. system events or user defined, ie. user events.
-
-Events described in this document assume that you have included Vedeu in your class:
-
-```ruby
-class SomeClassInYourApplication
-  include Vedeu
-
-  # ...
-```
-
-
-##### Notes:
-
-System events can be handled or triggered by your application also, but overriding or adding additional events to the Vedeu system event namespace may cause unpredictable results. It is recommended to only to hook into events like :cleanup, :_initialize_ and :key if you need to do something respective to those events.
-
-... TODO ... What about events in Vedeu::Menu?
-
-... TODO ... More information about system events.
-
-
-### User Events
-
-User events allow you to orchestrate behaviour within your application, ie. the user presses a specific key, you trigger an event to make something happen. Eg. pressing 'p' instructs the player to play.
-
-## Pre-defined User Events
-
-Vedeu pre-defines a few user events, which client applications can listen for, or trigger themselves.
-
-### `:_tick_`
-
-Each time Vedeu completes one cycle in the application loop
-(Application#run_many), it triggers the `:_tick_` event. This can be used by the
-client application for timing amongst other things.
-
-#### How to define user events
-
-```ruby
-bind :event_name do |arg1, arg2|
-  # ...
-
-  # Things that should happen when the event is triggered; these can be method
-  # calls or the triggering of another event or events.
-
-  # ...
-end
-```
-
-... TODO ... How to define.
-
-
-#### How to trigger user events
-
-... TODO ... How to trigger.
-
-
-#### More information.
-
-... TODO ... More information about user events.
-
-