vedeu 0.4.29 → 0.4.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5054f0cadfac0fb38b0b9c4c800c3cd0f7aa08b7
-  data.tar.gz: a94e10fb79245068619c7cb78d4d6aaf5639e647
+  metadata.gz: cbab7c48189a1680b2d50a4f9733a5853e608fcd
+  data.tar.gz: b8bc0dd0380007c146707d34ea96fab02b930c0a
 SHA512:
-  metadata.gz: c8f6d315b3bcd9f768ff40508b00be0e2360e65c42c1402fbc133ba0e5dedb1f7ebe9a1201500cb25be4483b407d07a57b7b03fc45dd8d07f28949fa34885c7d
-  data.tar.gz: 467d9b7608d6ff0e057b33f3c86579c7204c905f61f237fd753d940e26f86fcb56ada657a1f1639c6a4cf5c8b0c76e843eff8f143293729faf59bfe3dca58fea
+  metadata.gz: a0bc17406bfc0e9991486212b93312a5b5ef3b4d0277b39936fbbff3dbaf8c101d4678bbb1a34a2f95f89c54db5b9d4ccc5edd2d8ed5797e9b878b42d6107fba
+  data.tar.gz: 2575e61017ed69db73d68c38722d872e3f4a35da3c8be81c597ceba3bfc52fe73f32e16f30c27756932a2387a1190a876b0c2e08a7e1fe7fd3aebc4855f85500

data/Dockerfile

@@ -1,40 +1,59 @@
-FROM stackbrew/ubuntu:trusty
+FROM ubuntu:15.04
 MAINTAINER Gavin Laking <gavinlaking@gmail.com>
 
-ENV DEBIAN_FRONTEND noninteractive
-
-RUN sudo apt-get update;\
-    sudo apt-get install -y --force-yes \
-                         software-properties-common \
-                         build-essential \
-                         openssl \
-                         ca-certificates \
-                         git-core \
-                         autoconf \
-                         gawk \
-                         libreadline6-dev \
-                         libyaml-dev \
-                         libgdbm-dev \
-                         libncurses5-dev \
-                         automake \
-                         libtool \
-                         bison \
-                         pkg-config \
-                         curl \
-                         libxslt-dev \
-                         libxml2-dev \
-                         make; \
-    sudo apt-get clean -y; \
-    sudo apt-get autoremove -y;
-
-RUN sudo add-apt-repository "deb http://ppa.launchpad.net/brightbox/ruby-ng/ubuntu  $(lsb_release -sc) main";\
-    sudo apt-get update; \
-    sudo apt-get install ruby2.1 ruby2.1-dev -y --force-yes; \
-    sudo apt-get clean -y; \
-    sudo apt-get autoremove -y;
-
-RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:verbose: true\ngem: --no-ri --no-rdoc" > ~/.gemrc; \
-    /bin/bash -l -c "gem install bundler" ;
-
-RUN git clone https://github.com/gavinlaking/vedeu.git
-RUN cd vedeu; bundle install; rake
+# Build dependencies
+RUN apt-get update
+RUN apt-get install -y --force-yes \
+        software-properties-common \
+        build-essential \
+        openssl \
+        ca-certificates \
+        git-core \
+        autoconf \
+        gawk \
+        libreadline-dev \
+        libyaml-dev \
+        libgdbm-dev \
+        libncurses5-dev \
+        automake \
+        libtool \
+        bison \
+        pkg-config \
+        curl \
+        wget \
+        libxslt-dev \
+        libxml2-dev \
+        libffi-dev \
+        libssl-dev \
+        zlib1g-dev \
+        make
+RUN apt-get clean -y
+RUN apt-get autoremove -y
+
+# Chruby
+RUN wget -O chruby-0.3.9.tar.gz https://github.com/postmodern/chruby/archive/v0.3.9.tar.gz
+RUN tar -xzvf chruby-0.3.9.tar.gz
+RUN cd chruby-0.3.9/ && make install
+
+# Ruby Install
+RUN wget -O ruby-install-0.5.0.tar.gz https://github.com/postmodern/ruby-install/archive/v0.5.0.tar.gz
+RUN tar -xzvf ruby-install-0.5.0.tar.gz
+RUN cd ruby-install-0.5.0/ && make install
+
+# Install Ruby 2.2.2
+RUN ruby-install ruby 2.2.2
+
+# Setup Chruby
+RUN echo '[ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ] || return' >> /etc/profile.d/chruby.sh
+RUN echo 'source /usr/local/share/chruby/chruby.sh' >> /etc/profile.d/chruby.sh
+RUN echo 'source /usr/local/share/chruby/auto.sh' >> $HOME/.bashrc
+RUN echo 'chruby ruby-2.2.2' >> $HOME/.bash_profile
+
+# Setup .gemrc
+RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:verbose: true\ngem: --no-ri --no-rdoc" > $HOME/.gemrc
+
+# Setup PATH
+ENV PATH /opt/rubies/ruby-2.2.2/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+# Get ruby version
+RUN ruby -v

data/README.md

@@ -11,8 +11,9 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based
 
 ## Requirements
 
-Vedeu has been built primarily on MacOSX 10.9/10.10 (Mavericks/Yosemite) with
- Ruby v2.1.
+Vedeu was been built primarily with Ruby v2.1.
+
+When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't have any problems with either of these operating systems.
 
 Note: You may have trouble running Vedeu with Windows installations. (Pull
  requests welcome!)
@@ -31,118 +32,16 @@ And then execute:
 
 ## Example
 
-Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the
- source of Playa and Vedeu to get a feel for how it all works. The
- [RubyDoc](http://rubydoc.info/gems/vedeu) may also help!
-
-
-## Usage
-
-Expect proper documentation soon!
-
-### Getting Started
-
-The basic mechanics of a Vedeu app are outlined below:
-
-```ruby
-require 'vedeu'
-
-class MyApp
-  include Vedeu
-
-  interface 'main' do
-    # ...
-  end
-
-  bind :some_event do
-    # ...
-  end
-
-  bind :other_event do |hash_args, array_args, args|
-    # ...
-  end
-
-  keys do
-    key('a') { Vedeu.trigger(':apple') }
-    key('b') { Vedeu.trigger(':banana') }
-  end
-end
-```
-
-### Building Interfaces & Views
-
-Views with Vedeu are made up of simple building blocks. These blocks can be
- arranged in a multitude of ways which I hope is more than sufficient for your
- design needs.
-
-- A view (`Composition`) is made up of one or more interfaces.
-- An interface is an area on the screen where you can take input or direct
-  output. You will define it's colour and style, its dimensions, including
-  position and give it a name. You can then direct the output of a command, or
-  event, to this interface and Vedeu will ensure the content is placed there.
-- Interfaces (`Interface`) are made up of lines (`Line`), their length being the
-  width of the interface and their number being the height of the interface.
-- An interface with `width: 12, height: 5` will have five lines, each made of 12
-  characters- providing 60 cells. Colours and styles are handled by terminal
-  escape sequences and therefore do not consume a cell.
-- Lines are made up of zero, one or multiple streams (`Stream`) which are
-  basically subsets of the line.
-- An interface, line or stream can have a colour (`colour`) attribute.
-- An interface, line or stream can have a style (`style`) attribute.
-- Interfaces have a position (`y`, `x`) on the screen, and a size.
-  (`width`, `height`)
-- Interfaces can be placed relative to each other based on their attributes.
-    - An interface has a `top`, `right`, `bottom`, `left`.
-    - An interface also has a `north` and `west` (`top` and `left` minus 1
-      respectively).
-    - An interface also has a `south` and `east` (`bottom` and `right` plus 1
-      respectively).
-- Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
-- Styles are named. See the table below for supported styles.
-
-
-### On Defining Interfaces
-
-```ruby
-interface 'main' do
-  geometry do
-    y      1
-    x      1
-    width  10 # see notes below
-    height 10
-  end
-  colour foreground: '#ffffff', background: '#000000'
-end
-```
-
-Referring to the above example, interfaces have a name, and various default
- attributes.
-
-- `y`          sets the starting row point. (See Geometry)
-- `x`          sets the starting column point.
-
-- `width`      sets the character width of the interface
-- `height`     sets the character height of the interface
-
-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.
-- `background` sets the default background colour.
-
-
-### Events
+Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the source of Playa and Vedeu to get a feel for how it all works.
 
-More information about events can be found in the
- [RubyDoc](http://rubydoc.info/gems/vedeu).
+If you have produced software which uses Vedeu, please let me know, I'll link
+to your project here.
 
 
-### Geometry
+## Documentation & Usage
 
-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.
+Vedeu is largely documented using Yard. I hope to produce more 'General Usage'
+documentation shortly. In the meantime, please browse the [RubyDoc](http://rubydoc.info/gems/vedeu).
 
 
 ## Development / Contributing
@@ -156,6 +55,7 @@ Pull requests are very welcome! Please try to follow these simple rules if
 * Please create a topic branch for every separate change you make.
 * 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).
 * Please **do not change** the version number.
 

data/docs/getting_started.md

@@ -1,5 +1,14 @@
 ## Getting Started with Vedeu
 
+- Set your configuration.
+- Define your interfaces.
+  - Define the border.
+  - Define the geometry.
+  - Define the keymap.
+- Define the global keymap, this will be used irrespective of the interface
+  currently in focus.
+
+
 ### Predefined Keys
 
 Vedeu automatically defines four keys for your client application:

data/lib/vedeu/all.rb

@@ -1,6 +1,7 @@
 
 # load order is important
 
+require 'vedeu/version'
 require 'vedeu/debug'
 require 'vedeu/traps'
 
@@ -19,7 +20,6 @@ require 'vedeu/configuration/all'
 require 'vedeu/cursor/all'
 require 'vedeu/distributed/all'
 
-require 'vedeu/dsl/shared/all'
 require 'vedeu/dsl/all'
 
 require 'vedeu/events/all'

data/lib/vedeu/api.rb

@@ -1,14 +1,11 @@
 require 'vedeu/support/common'
 require 'vedeu/support/terminal'
+require 'vedeu/support/timer'
 require 'vedeu/output/renderers/all'
 require 'vedeu/events/all'
 require 'vedeu/models/all'
 require 'vedeu/input/all'
-require 'vedeu/dsl/components/all'
-require 'vedeu/dsl/composition'
-require 'vedeu/dsl/shared/all'
-require 'vedeu/dsl/group'
-require 'vedeu/dsl/view'
+require 'vedeu/dsl/all'
 
 module Vedeu
 
@@ -157,6 +154,10 @@ module Vedeu
     #   @see Vedeu::Terminal#resize
     def_delegators Vedeu::Terminal, :height, :width, :resize
 
+    # @!method timer
+    #   @see Vedeu::Timer.timer
+    def_delegators Vedeu::Timer, :timer
+
     # @!method trigger
     #   @see Vedeu::Trigger.trigger
     def_delegators Vedeu::Trigger, :trigger

data/lib/vedeu/buffers/display_buffer.rb

@@ -25,7 +25,7 @@ module Vedeu
     # @raise [InvalidSyntax] The name is not defined.
     # @return [Vedeu::Interface]
     def store_deferred
-      unless defined_value?(name)
+      unless present?(name)
         fail InvalidSyntax, 'Cannot store an interface without a name.'
       end
 

data/lib/vedeu/configuration/api.rb

@@ -409,7 +409,7 @@ module Vedeu
 
         return false if value.is_a?(String) && value.size != 1
 
-        (value.is_a?(String) || value.is_a?(Symbol)) && defined_value?(value)
+        (value.is_a?(String) || value.is_a?(Symbol)) && present?(value)
       end
 
       # Raises an exception on behalf of the calling method to report that the

data/lib/vedeu/cursor/move.rb

@@ -195,7 +195,7 @@ module Vedeu
       @coordinate ||= Vedeu::Coordinate.new(name)
     end
 
-    # @return (see Vedeu::Cursors#by_name)
+    # @see Vedeu::Cursors#by_name
     def cursor
       @cursor ||= Vedeu.cursors.by_name(name)
     end
@@ -205,7 +205,7 @@ module Vedeu
       cursor.attributes.merge!(x: x_position, y: y_position, ox: ox, oy: oy)
     end
 
-    # @return (see Vedeu::Geometries#by_name)
+    # @see Vedeu::Geometries#by_name
     def geometry
       @geometry ||= Vedeu.geometries.by_name(name)
     end

data/lib/vedeu/debug.rb

@@ -22,7 +22,7 @@ module Vedeu
 
     RubyProf.start
 
-    yield
+    work = yield
 
     result = RubyProf.stop
     result.eliminate_methods!([
@@ -61,6 +61,8 @@ module Vedeu
       # - Uses the other printers to create several reports in one profiling run
       # RubyProf::MultiPrinter
     end
+
+    work
   end
   # :nocov:
 

data/lib/vedeu/dsl/all.rb

@@ -1,12 +1,18 @@
-require 'vedeu/dsl/components/all'
-require 'vedeu/dsl/shared/all'
-
-require_relative 'composition'
-require_relative 'group'
-require_relative 'interface'
-require_relative 'line'
-require_relative 'stream'
-require_relative 'view'
+require 'vedeu/support/common'
+
+require 'vedeu/dsl/use'
+require 'vedeu/dsl/presentation'
+require 'vedeu/dsl/border'
+require 'vedeu/dsl/composition'
+require 'vedeu/dsl/geometry'
+require 'vedeu/dsl/group'
+require 'vedeu/dsl/keymap'
+require 'vedeu/dsl/text'
+require 'vedeu/dsl/interface'
+require 'vedeu/dsl/line'
+require 'vedeu/dsl/menu'
+require 'vedeu/dsl/stream'
+require 'vedeu/dsl/view'
 
 module Vedeu
 

data/lib/vedeu/dsl/{components/border.rb → border.rb}

@@ -1,6 +1,3 @@
-require 'vedeu/dsl/shared/presentation'
-require 'vedeu/dsl/shared/use'
-
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/composition.rb

@@ -3,6 +3,39 @@ module Vedeu
   module DSL
 
     # DSL for creating collections of interfaces.
+    #
+    # Views with Vedeu are made up of simple building blocks. These blocks can
+    # be arranged in a multitude of ways which I hope is more than sufficient
+    # for your design needs.
+
+    # - A view (`Composition`) is made up of one or more interfaces.
+    # - An interface is an area on the screen where you can take input or direct
+    #   output. You will define it's colour and style, its dimensions, including
+    #   position and give it a name. You can then direct the output of a
+    #   command, or event, to this interface and Vedeu will ensure the content
+    #   is placed there.
+    # - Interfaces (`Interface`) are made up of lines (`Line`), their length
+    #   being the width of the interface and their number being the height of
+    #   the interface.
+    # - An interface with `width: 12, height: 5` will have five lines, each made
+    #   of 12 characters- providing 60 cells. Colours and styles are handled by
+    #   terminal escape sequences and therefore do not consume a cell.
+    # - Lines are made up of zero, one or multiple streams (`Stream`) which are
+    #   basically subsets of the line.
+    # - An interface, line or stream can have a colour (`colour`) attribute.
+    # - An interface, line or stream can have a style (`style`) attribute.
+    # - Interfaces have a position (`y`, `x`) on the screen, and a size.
+    #   (`width`, `height`)
+    # - Interfaces can be placed relative to each other based on their
+    #   attributes.
+    #     - An interface has a `top`, `right`, `bottom`, `left`.
+    #     - An interface also has a `north` and `west` (`top` and `left` minus 1
+    #       respectively).
+    #     - An interface also has a `south` and `east` (`bottom` and `right`
+    #       plus 1 respectively).
+    # - Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
+    # - Styles are named. See the table below for supported styles.
+    #
     class Composition
 
       include Vedeu::DSL

data/lib/vedeu/dsl/{components/geometry.rb → geometry.rb}

@@ -3,6 +3,24 @@ module Vedeu
   module DSL
 
     # Provide DSL methods for configuring the geometry of an interface.
+    #
+    # Geometry for Vedeu, as the same for ANSI terminals, has the origin at
+    # top-left, y = 1, x = 1. The 'y' coordinate is deliberately first.
+    #
+    # @example
+    #   This crude ASCII diagram represents a Geometry within Vedeu, each of the
+    #   labels is a value you can access or define.
+    #
+    #        x    north    xn           # north:  y - 1
+    #      y +--------------+           # top:    y
+    #        |     top      |           # west:   x - 1
+    #        |              |           # left:   x
+    #   west | left   right | east      # right:  xn
+    #        |              |           # east:   xn + 1
+    #        |    bottom    |           # bottom: yn
+    #     yn +--------------+           # south:  yn + 1
+    #             south
+    #
     class Geometry
 
       include Vedeu::DSL

data/lib/vedeu/dsl/interface.rb

@@ -106,7 +106,7 @@ module Vedeu
       #
       # @return [String] The name of the interface in focus.
       def focus!
-        Vedeu::Focus.add(model.name, true) if defined_value?(model.name)
+        Vedeu::Focus.add(model.name, true) if present?(model.name)
       end
 
       # Define the geometry for an interface.
@@ -144,7 +144,7 @@ module Vedeu
       #   should belong.
       # @return [Vedeu::Group]
       def group(name)
-        return false unless defined_value?(name)
+        return false unless present?(name)
 
         model.group = name
 

data/lib/vedeu/dsl/{components/keymap.rb → keymap.rb}

@@ -1,5 +1,3 @@
-require 'vedeu/support/common'
-
 module Vedeu
 
   module DSL
@@ -89,12 +87,12 @@ module Vedeu
       def key(*value_or_values, &block)
         fail InvalidSyntax, 'No action defined for `key`.' unless block_given?
 
-        unless defined_value?(value_or_values)
+        unless present?(value_or_values)
           fail InvalidSyntax, 'No keypress(es) defined for `key`.'
         end
 
         value_or_values.each do |value|
-          unless defined_value?(value)
+          unless present?(value)
             fail InvalidSyntax, 'An invalid value for `key` was encountered.'
           end
 

data/lib/vedeu/events/event.rb

@@ -96,6 +96,7 @@ module Vedeu
         Vedeu.log(type: :event, message: "Unbinding: '#{name.inspect}'")
 
         Vedeu.events.remove(name)
+
         true
       end
       alias_method :unevent, :unbind
@@ -165,10 +166,6 @@ module Vedeu
     # @return [String]
     attr_accessor :executed_at
 
-    # @!attribute [rw] now
-    # @return [String]
-    attr_accessor :now
-
     private
 
     # Execute the code stored in the event closure.
@@ -176,11 +173,9 @@ module Vedeu
     # @param args [void]
     # @return [void]
     def execute(*args)
-      reset_deadline
-
-      set_executed
-
-      reset_time
+      @deadline    = 0    # reset deadline
+      @executed_at = @now # set execution time to now
+      @now         = 0    # reset now
 
       Vedeu.log(type: :event, message: "Triggering: '#{name.inspect}'")
 
@@ -193,7 +188,7 @@ module Vedeu
     #
     # @return [Boolean]
     def throttling?
-      set_time
+      @now = Time.now.to_f
 
       options[:delay] > 0
     end
@@ -202,7 +197,7 @@ module Vedeu
     #
     # @return [Boolean]
     def throttle_expired?
-      return true if elapsed_time > delay
+      return true if (@now - @executed_at) > delay
 
       Vedeu.log(type: :event, message: "Throttling: '#{name.inspect}'")
 
@@ -212,12 +207,14 @@ module Vedeu
     # Returns a boolean indicating whether debouncing is required for this
     # event. Setting the debounce option to any value greater than 0 will
     # enable debouncing.
+    # Sets the deadline for when this event can be executed to a point in the
+    # future determined by the amount of debounce time left.
     #
     # @return [Boolean]
     def debouncing?
-      set_time
+      @now = Time.now.to_f
 
-      set_deadline unless deadline?
+      @deadline = @now + debounce unless deadline?
 
       options[:debounce] > 0
     end
@@ -226,35 +223,13 @@ module Vedeu
     #
     # @return [Boolean]
     def debounce_expired?
-      return true if set_executed > deadline
+      return true if (@executed_at = @now) > @deadline
 
       Vedeu.log(type: :event, message: "Debouncing: '#{name.inspect}'")
 
       false
     end
 
-    # Returns the time in seconds since the last triggering of this event.
-    #
-    # @return [Float]
-    def elapsed_time
-      now - @executed_at
-    end
-
-    # @return [Float]
-    def set_executed
-      @executed_at = now
-    end
-
-    # @return [Float]
-    def set_time
-      @now = Time.now.to_f
-    end
-
-    # @return [Fixnum]
-    def reset_time
-      @now = 0
-    end
-
     # Returns a boolean indicating if this event has a deadline.
     #
     # @return [Boolean]
@@ -262,23 +237,6 @@ module Vedeu
       @deadline > 0
     end
 
-    # Resets the deadline of this event.
-    #
-    # @return [Fixnum]
-    def reset_deadline
-      @deadline = 0
-    end
-
-    # Sets the deadline for when this event can be executed to a point in the
-    # future determined by the amount of debounce time left.
-    #
-    # @return [NilClass]
-    def set_deadline
-      @deadline = now + debounce
-
-      nil
-    end
-
     # Return the amount of time in seconds to debounce the event by.
     #
     # @return [Fixnum|Float]

data/lib/vedeu/geometry/area.rb

@@ -27,12 +27,11 @@ module Vedeu
     # @param yn [Fixnum]
     # @param y_yn [Fixnum]
     # @param y_default [Fixnum]
-    # @param y_options [Hash<Symbol => Boolean>]
     # @param x [Fixnum]
     # @param xn [Fixnum]
     # @param x_xn [Fixnum]
     # @param x_default [Fixnum]
-    # @param x_options [Hash<Symbol => Boolean>]
+    # @param options [Hash<Symbol => Boolean>]
     # @return [Vedeu::Area]
     def self.from_attributes(y:, yn:, y_yn:, y_default:,
                              x:, xn:, x_xn:, x_default:, options:)