vedeu 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79cbcf71bd0a9c214cd3764d10cfc21e8b6aeffa
-  data.tar.gz: 570893355905af7e58d89e64cc419ee361133dd3
+  metadata.gz: 395f38280fc3c3c2c08cd35934211d1bf5f2f088
+  data.tar.gz: 56e22bfd0a48a8afed5d95577db5d556207f394e
 SHA512:
-  metadata.gz: 0d143574721a8b5a0e07eb6fb081c3768fa3c994c28a72303b07f9c1abc3a384262fa8c7abe493dceb5c3069f060b0521c804d1c7cff6bf5864fb2cd9922ba22
-  data.tar.gz: 502eb3bba9db28fc1ca44b1f6cd7dd017c18fc3d1f0ce6783d23b56459d758d3dd9cd0d1fb6dc54448fc13342b001304123b4914b206e43617f437cfa5980967
+  metadata.gz: 358f6eb1e2c13a9e3c6ff57db89165c9799a5b5df066251cf1437443897d210435f08abed2f4a582d7d15b66cef4d0bd0bbfa4c382e1ccb4f631c23afe2542ee
+  data.tar.gz: 34dcb6740bdae17988a112977b1b795fb455a926e474e53e41be69b2d30f11396b02333648afe7508a400da5257257a64b2ee963ef79b1f077f1a6297c5be12f

data/lib/vedeu/api/api.rb

@@ -1,9 +1,19 @@
 module Vedeu
   module API
+    # @param name  [Symbol] The name of the event which will be triggered later
+    # @param delay [Fixnum|Float] Limits the execution of the triggered event to
+    #   the delay in seconds, effectively throttling the event. A delay of 1.0
+    #   will mean that even if the event is triggered multiple times a second
+    #   it will only execute once for that second. Triggers inside the delay are
+    #   discarded.
+    # @param block [Proc] The event to be executed when triggered. This block
+    #   could be a method call, or the triggering of another event, or sequence
+    #   of either/both.
     def event(name, delay = 0, &block)
       Vedeu.events.event(name, delay, &block)
     end
 
+    # @api private
     def events
       @events ||= API::Events.new do
         event(:_log_)         { |msg| Vedeu.log(msg)      }
@@ -15,32 +25,50 @@ module Vedeu
       end
     end
 
+    # @return [Fixnum] The total height of the current terminal.
     def height
       Terminal.height
     end
 
+    # @param name  [String] The name of the interface. Used to reference the
+    #   interface throughout your application's execution lifetime.
+    # @param block [Proc] A set of attributes which define the features of the
+    #   interface. TODO: More help.
     def interface(name, &block)
       API::Interface.define({ name: name }, &block)
     end
 
+    # @param key [String] A simulated keypress. Escape sequences are also
+    #   supported.
     def keypress(key)
       trigger(:key, key)
-      trigger(:_log_, (' ' * 42) + "key: #{key}")
+      trigger(:_log_, "Key: #{key}")
       trigger(:_mode_switch_) if key == :escape
     end
 
+    # @param message [String] The message you wish to emit to the log
+    #   file, useful for debugging.
     def log(message)
       API::Log.logger.debug(message)
     end
 
+    # @param name [Symbol] The name of the event you wish to trigger.
+    #   The event does not have to exist.
+    # @param args [Array] Any arguments the event needs to execute correctly.
     def trigger(name, *args)
       Vedeu.events.trigger(name, *args)
     end
 
+    # @param name [String] The name of the interface you wish to use. Typically
+    #   used when defining interfaces to share geometry. TODO: Example required.
     def use(name)
       Vedeu::Interface.new(Vedeu::Store.query(name))
     end
 
+    # @param name [String] The name of the interface you are targetting for this
+    #   view.
+    # @param block [Proc] The directives you wish to send to this interface.
+    #   TODO: Example required.
     def view(name, &block)
       {
         interfaces: [
@@ -49,10 +77,14 @@ module Vedeu
       }
     end
 
+    # @param block [Proc] Instructs Vedeu to treat all of the 'view' directives
+    #   therein as one instruction. Useful for redrawing multiple interfaces at
+    #   once. TODO: Example required.
     def views(&block)
       API::Composition.build(&block)
     end
 
+    # @return [Fixnum] The total width of the current terminal.
     def width
       Terminal.width
     end

data/lib/vedeu/api/interface.rb

@@ -54,6 +54,10 @@ module Vedeu
         attributes[:group] = value
       end
 
+      def name(value)
+        attributes[:name] = value
+      end
+
       def x(value)
         fail XOutOfBounds if x_out_of_bounds?(value)
 

data/lib/vedeu/api/log.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'time'
 
 module Vedeu
   module API

data/lib/vedeu/support/terminal.rb

@@ -70,10 +70,12 @@ module Vedeu
       [(height / 2), (width / 2)]
     end
 
+    # @return [Fixnum] The total width of the current terminal.
     def width
       size.last
     end
 
+    # @return [Fixnum] The total height of the current terminal.
     def height
       size.first
     end

data/test/lib/vedeu/api/interface_test.rb

@@ -56,6 +56,122 @@ module Vedeu
         it 'raises an exception when the value is out of bounds' do
           proc { interface.define { height 999 } }.must_raise(InvalidHeight)
         end
+
+        it 'allows the setting of colours' do
+          Interface.build do
+            colour foreground: '#aadd00', background: '#222222'
+          end.must_equal(
+            {
+              name: '',
+              group: '',
+              lines: [],
+              colour: {
+                foreground: "#aadd00",
+                background: "#222222"
+              },
+              style: "",
+              geometry: {},
+              cursor: true,
+              delay: 0.0
+            }
+          )
+        end
+
+        it 'allows the setting of styles' do
+          Interface.build do
+            style 'underline'
+          end.must_equal(
+            {
+              name: '',
+              group: '',
+              lines: [],
+              colour: {},
+              style: "underline",
+              geometry: {},
+              cursor: true,
+              delay: 0.0
+            }
+          )
+        end
+
+        it 'allows the use of other interfaces for attributes like geometry' do
+          IO.console.stub(:winsize, [25, 40]) do
+            Vedeu.interface 'my_interface' do
+              x      5
+              y      5
+              width  5
+              height 5
+            end
+            Interface.build do
+              name   'my_other_interface'
+              y      use('my_interface').south
+            end.must_equal({
+              name: "my_other_interface",
+              group: "",
+              lines: [],
+              colour: {},
+              style: "",
+              geometry: {
+                y: 11
+              },
+              cursor: true,
+              delay: 0.0
+            })
+          end
+        end
+
+        it 'allows the setting of a delay for events triggered for this ' \
+           'interface' do
+          Interface.build do
+            delay 1.0
+          end.must_equal(
+            {
+              name: '',
+              group: '',
+              lines: [],
+              colour: {},
+              style: "",
+              geometry: {},
+              cursor: true,
+              delay: 1.0
+            })
+        end
+
+        it 'allows the interface to be part of a group- useful for creating ' \
+           'separate views' do
+          Interface.build do
+            group 'my_group'
+          end.must_equal(
+            {
+              name: "",
+              group: "my_group",
+              lines: [],
+              colour: {},
+              style: "",
+              geometry: {},
+              cursor: true,
+              delay: 0.0
+            }
+          )
+        end
+
+        it 'allows the setting of the cursor for the interface to be shown ' \
+           'or hidden' do
+          Interface.build do
+            cursor false
+          end.must_equal(
+            {
+              name: "",
+              group: "",
+              lines: [],
+              colour: {},
+              style: "",
+              geometry: {},
+              cursor: false,
+              delay: 0.0
+            }
+          )
+        end
       end
 
       describe '#build' do

data/vedeu.gemspec

@@ -4,10 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.1.14'
+  spec.version       = '0.1.15'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = %q{A terminal case of wonderland.}
+  spec.description   = %q{A GUI framework for terminal/console applications.}
   spec.homepage      = 'https://github.com/gavinlaking/vedeu'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Gavin Laking
@@ -150,7 +150,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: 
+description: A GUI framework for terminal/console applications.
 email:
 - gavinlaking@gmail.com
 executables: