vedeu 0.4.49 → 0.4.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aba52b40e7308a950ef038f55ad681f6605aa57f
-  data.tar.gz: c1040133b462db4cc0fd796674b8c0c7f2965c81
+  metadata.gz: a09d46830938e1cc8b738499f0473e18c03cfb9c
+  data.tar.gz: 391122a3f279aded058f010e67eefeb382385dff
 SHA512:
-  metadata.gz: b0c936fd80c9b324ffe99a7e800ae7571510bb7c9714512c7db7e1da643f6b3b9a8d698f3f762aeaa50d376a1fd880d0e22130c6af596b4da4d7cd3531c53ff1
-  data.tar.gz: de9ca0380433479fc06ccbd95dde1836c65e9085abb76dbc6d5049a053e99e968dd6118591ac7293ddc48c2a9ca3aa7f6ade8df0aa3e10d8c170dca256992b43
+  metadata.gz: bebff5ce0ae54c6880aeb8f6f229661007521a4a029b585f1a6bc0a3b027e548ba93136a5ab60e0570cf0075711c0689e52b263bb8e602ad06bda0e4e726c1fe
+  data.tar.gz: 4dc322f36187484f76665de2eab79f50d2b0ea14b32ca6eba943d6d12c7c87f7593ad37b0a34b014c3188a9a648c21985b7491ad5a6ff69d78427041e195a9e2

data/lib/vedeu/all.rb

@@ -11,9 +11,7 @@ require 'vedeu/geometry/all'
 require 'vedeu/repositories/all'
 
 require 'vedeu/api'
-require 'vedeu/bindings/drb'
-require 'vedeu/bindings/menus'
-require 'vedeu/bindings/bindings'
+require 'vedeu/bindings/all'
 
 require 'vedeu/cli/generator/all'
 

data/lib/vedeu/api.rb

@@ -87,22 +87,40 @@ module Vedeu
     # @return [Vedeu::Cursors]
     def_delegators Vedeu::Cursors, :cursors
 
+    # @example
+    #   Vedeu.border
+    #
     # @!method border
     #   @see Vedeu::DSL::Border.border
     def_delegators Vedeu::DSL::Border, :border
 
+    # @example
+    #   Vedeu.geometry
+    #
     # @!method geometry
     #   @see Vedeu::DSL::Geometry.geometry
     def_delegators Vedeu::DSL::Geometry, :geometry
 
+    # @example
+    #   Vedeu.group
+    #
     # @!method group
     #   @see Vedeu::DSL::Group.group
     def_delegators Vedeu::DSL::Group, :group
 
+    # @example
+    #   Vedeu.keymap
+    #
     # @!method keymap
     #   @see Vedeu::DSL::Keymap.keymap
     def_delegators Vedeu::DSL::Keymap, :keymap
 
+    # @example
+    #   Vedeu.interface
+    #   Vedeu.renders
+    #   Vedeu.render
+    #   Vedeu.views
+    #
     # @!method interface
     #   @see Vedeu::DSL::View.interface
     # @!method render
@@ -113,6 +131,11 @@ module Vedeu
     #   @see Vedeu::DSL::View.views
     def_delegators Vedeu::DSL::View, :interface, :renders, :render, :views
 
+    # @example
+    #   Vedeu.bind
+    #   Vedeu.bound?
+    #   Vedeu.unbind
+    #
     # @!method bind
     #   @see Vedeu::Event.bind
     # @!method bound?
@@ -130,6 +153,13 @@ module Vedeu
     # @return [Vedeu::Events]
     def_delegators Vedeu::Events, :events
 
+    # @example
+    #   Vedeu.focus
+    #   Vedeu.focus_by_name
+    #   Vedeu.focussed?
+    #   Vedeu.focus_next
+    #   Vedeu.focus_previous
+    #
     # @!method focus
     #   @see Vedeu::Focus#focus
     # @!method focus_by_name
@@ -188,6 +218,11 @@ module Vedeu
     # @return [Vedeu::Keymaps]
     def_delegators Vedeu::Keymaps, :keymaps
 
+    # @example
+    #   Vedeu.log
+    #   Vedeu.log_stdout
+    #   Vedeu.log_stderr
+    #
     # @!method log
     #   @see Vedeu::Log.log
     # @!method log_stdout
@@ -196,10 +231,16 @@ module Vedeu
     #   @see Vedeu::Log.log_stderr
     def_delegators Vedeu::Log, :log, :log_stdout, :log_stderr
 
+    # @example
+    #   Vedeu.keypress
+    #
     # @!method keypress
     #   @see Vedeu::Mapper.keypress
     def_delegators Vedeu::Mapper, :keypress
 
+    # @example
+    #   Vedeu.menu
+    #
     # @!method menu
     #   @see Vedeu::Menu.menu
     def_delegators Vedeu::Menu, :menu
@@ -213,44 +254,114 @@ module Vedeu
     # @return [Vedeu::Menus]
     def_delegators Vedeu::Menus, :menus
 
+    # @example
+    #   Vedeu.renderer
+    #   Vedeu.renderers
+    #
     # @!method renderer
     #   @see Vedeu::Renderers#renderer
     # @!method renderers
     #   @see Vedeu::Renderers#renderers
     def_delegators Vedeu::Renderers, :renderer, :renderers
 
+    # Return the height of the terminal running the client application.
+    #
+    # @example
+    #   Vedeu.height
+    #
     # @!method height
     #   @see Vedeu::Terminal#height
+    def_delegators Vedeu::Terminal, :height
+
+    # Return the width of the terminal running the client application.
+    #
+    # @example
+    #   Vedeu.width
+    #
     # @!method width
     #   @see Vedeu::Terminal#width
+    def_delegators Vedeu::Terminal, :width
+
+    # Instruct the terminal to resize. This will happen automatically as the
+    # terminal recieves SIGWINCH signals.
+    #
+    # @example
+    #   Vedeu.resize
+    #
     # @!method resize
     #   @see Vedeu::Terminal#resize
-    def_delegators Vedeu::Terminal, :height, :width, :resize
+    def_delegators Vedeu::Terminal, :resize
 
+    # Measure the execution time of the code in the given block.
+    #
+    # @example
+    #   Vedeu.timer do
+    #     # ... some code here ...
+    #   end
+    #
     # @!method timer
     #   @see Vedeu::Timer.timer
     def_delegators Vedeu::Timer, :timer
 
+    # Trigger an event by name.
+    #
+    # @example
+    #   Vedeu.trigger(:name)
+    #
     # @!method trigger
     #   @see Vedeu::Trigger.trigger
     def_delegators Vedeu::Trigger, :trigger
 
+    # Exit the client application using Vedeu.
+    #
+    # @example
+    #   Vedeu.exit
+    #
     # @!method exit
     #   @see Vedeu::Application.stop
     def_delegators Vedeu::Application, :exit
 
+    # Clear the entire terminal.
+    #
+    # @example
+    #   Vedeu.clear
+    #
+    # @!method clear
+    #   @see Vedeu::Terminal.clear
+    def_delegators Vedeu::Terminal, :clear
+
+    # Clear the interface with the given name.
+    #
+    # @example
+    #   Vedeu.clear_by_name(name)
+    #
     # @!method clear_by_name
-    #   @see Vedeu::Clear.by_name
+    #   @see Vedeu::Clear::NamedInterface.render
     def_delegators Vedeu::Clear::NamedInterface, :clear_by_name
 
+    # Clears the group of interfaces belonging to the given name.
+    #
+    # @example
+    #   Vedeu.clear_by_group(name)
+    #
     # @!method clear_by_group
-    #   @see Vedeu::Clear.by_group
+    #   @see Vedeu::Clear::NamedGroup.render
     def_delegators Vedeu::Clear::NamedGroup, :clear_by_group
 
+    # Hide the cursor for the interface of the given name.
+    #
+    # @example
+    #   Vedeu.hide_cursor(name)
+    #
     # @!method hide_cursor
     #   @see Vedeu::Visibility.hide_cursor
     def_delegators Vedeu::Visibility, :hide_cursor
 
+    # Shows the cursor for the interface of the given name.
+    #
+    # @example
+    #   Vedeu.show_cursor(name)
+    #
     # @!method show_cursor
     #   @see Vedeu::Visibility.show_cursor
     def_delegators Vedeu::Visibility, :show_cursor

data/lib/vedeu/application/application_controller.rb

@@ -3,7 +3,8 @@ require_relative 'controller'
 module Vedeu
 
   # Provides methods which should be available to all client application
-  # controllers.
+  # controllers. The client application's ApplicationController will inherit
+  # from this class.
   #
   # @api private
   class ApplicationController

data/lib/vedeu/application/application_helper.rb

@@ -3,7 +3,8 @@ require_relative 'helper'
 module Vedeu
 
   # Provides methods which should be available to all client application
-  # helpers.
+  # helpers. The client application's ApplicationHelper will include this
+  # module.
   #
   # @api private
   module ApplicationHelper

data/lib/vedeu/application/application_view.rb

@@ -2,7 +2,8 @@ require_relative 'view'
 
 module Vedeu
 
-  # Provides the mechanism to render views for the client application.
+  # Provides the mechanism to render views for the client application. The
+  # client application's ApplicationView will inherit from this class.
   #
   # @api private
   class ApplicationView
@@ -42,10 +43,12 @@ module Vedeu
     #
     # @param value [String]
     # @return [String]
+    # :nocov:
     def template(value)
       @template = Vedeu::Configuration.base_path +
                   "/app/views/templates/#{value}.erb"
     end
+    # :nocov:
 
   end # ApplicationView
 

data/lib/vedeu/bootstrap.rb

@@ -31,7 +31,9 @@ module Vedeu
     #
     # @return [void]
     def start
-      Vedeu.configure { log('/tmp/vedeu_bootstrap.log') }
+      unless Vedeu::Configuration.log?
+        Vedeu.configure { log('/tmp/vedeu_bootstrap.log') }
+      end
 
       # config/configuration.rb is already loaded so don't load it twice
       Dir[File.join(Vedeu::Configuration.base_path, 'config/**/*')].each do |f|

data/lib/vedeu/cli/generator/application.rb

@@ -10,6 +10,7 @@ module Vedeu
     #   ```
     #
     # @api private
+    # :nocov:
     class Application
 
       include Vedeu::Generator::Helpers
@@ -33,6 +34,8 @@ module Vedeu
         make_directory_structure
 
         copy_gemfile
+        copy_license
+        copy_readme
         copy_application_bootstrapper
         copy_application_controller
         copy_application_helper
@@ -89,6 +92,16 @@ module Vedeu
         copy_file(source + '/Gemfile', "#{name}/Gemfile")
       end
 
+      # @return [void]
+      def copy_license
+        copy_file(source + '/LICENSE.txt', "#{name}/LICENSE.txt")
+      end
+
+      # @return [void]
+      def copy_readme
+        copy_file(source + '/README.md', "#{name}/README.md")
+      end
+
       # @return [void]
       def make_application_executable
         FileUtils.chmod(0755, "#{name}/bin/#{name}")
@@ -117,6 +130,7 @@ module Vedeu
       end
 
     end # Application
+    # :nocov:
 
   end # Generator
 

data/lib/vedeu/cli/generator/helpers.rb

@@ -8,6 +8,7 @@ module Vedeu
     # application.
     #
     # @api private
+    # :nocov:
     module Helpers
 
       include Vedeu::Common
@@ -80,6 +81,7 @@ module Vedeu
       end
 
     end # Helpers
+    # :nocov:
 
   end # Generator
 

data/lib/vedeu/cli/generator/templates/application/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'vedeu'
+# gem 'ruby-prof' # uncomment if using the `debug!` configuration option.

data/lib/vedeu/cli/generator/templates/application/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2014 Your Name Here
+
+Note: You may wish to change this license to suit your legal needs.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vedeu/cli/generator/templates/application/README.md

@@ -0,0 +1,18 @@
+# <%= object.name_as_class %>
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Dependencies
+
+* Installation
+
+* Configuration
+
+* Runtime instructions
+
+* How to contribute
+
+* Author information

data/lib/vedeu/cli/generator/templates/application/app/controllers/name.erb

@@ -13,6 +13,9 @@ module <%= object.app_name %>
 
     private
 
+    def args
+    end
+
     def object
       nil
     end

data/lib/vedeu/cli/generator/templates/application/app/views/name.erb

@@ -24,6 +24,9 @@ module <%= object.app_name %>
 
     private
 
+    def object
+    end
+
     def options
       {}
     end

data/lib/vedeu/cli/generator/templates/application/config/configuration.erb

@@ -3,7 +3,7 @@ Vedeu.configure do
 
   colour_mode 16_777_216
 
-  # debug!
+  # debug! # Add "gem 'ruby-prof'" to your Gemfile if uncommenting this line.
   # drb!
   # drb_host    'localhost'
   # drb_port    21420

data/lib/vedeu/cli/generator/view.rb

@@ -12,6 +12,7 @@ module Vedeu
     #   ```
     #
     # @api private
+    # :nocov:
     class View
 
       include Vedeu::Generator::Helpers
@@ -77,6 +78,7 @@ module Vedeu
       end
 
     end # View
+    # :nocov:
 
   end # Generator
 

data/lib/vedeu/configuration/configuration.rb

@@ -144,6 +144,13 @@ module Vedeu
         instance.options[:log]
       end
 
+      # Returns a boolean indicating whether the log has been configured.
+      #
+      # @return [Boolean]
+      def log?
+        log != nil
+      end
+
       # Returns whether the application will run through its main loop once or
       # not. Default is false; meaning the application will loop forever or
       # until terminated by the user.
@@ -248,7 +255,7 @@ module Vedeu
     # @return [Hash]
     def defaults
       {
-        base_path:     set_base_path,
+        base_path:     base_path,
         colour_mode:   detect_colour_mode,
         debug:         false,
         drb:           false,
@@ -281,7 +288,7 @@ module Vedeu
     end
 
     # @return [String]
-    def set_base_path
+    def base_path
       File.expand_path('.')
     end
 

data/lib/vedeu/output/clear/all.rb

@@ -4,6 +4,7 @@ module Vedeu
   #
   # @api private
   module Clear
+
   end # Clear
 
 end # Vedeu

data/lib/vedeu/output/viewport.rb

@@ -57,7 +57,7 @@ module Vedeu
 
         show.each_with_index do |line, iy|
           line.each_with_index do |column, ix|
-            column.position = Vedeu::Position[by + iy, bx + ix]
+            column.position = [by + iy, bx + ix]
             out << column
           end
         end

data/lib/vedeu/support/log.rb

@@ -86,14 +86,14 @@ module Vedeu
       # Write a message to the Vedeu log file.
       #
       # @example
-      #   Vedeu.log(message: 'A useful debugging message: Error!')
+      #   Vedeu.log(type: :debug, message: 'A useful debugging message: Error!')
       #
       # @param message [String] The message you wish to emit to the log file,
       #   useful for debugging.
       # @param force [Boolean] When evaluates to true will attempt to write to
       #   the log file regardless of the Configuration setting.
       # @param type [Symbol] Colour code messages in the log file depending
-      #   on their source.
+      #   on their source. See {message_types}
       #
       # @return [TrueClass]
       def log(message:, force: false, type: :info)
@@ -104,11 +104,15 @@ module Vedeu
         output
       end
 
+      # Write a message to STDOUT.
+      #
       # @return [TrueClass]
       def log_stdout(type: :info, message:)
         $stdout.puts [message_type(type), message_body(type, message)].join
       end
 
+      # Write a message to STDERR.
+      #
       # @return [TrueClass]
       def log_stderr(type: :info, message:)
         $stderr.puts [message_type(type), message_body(type, message)].join
@@ -125,18 +129,28 @@ module Vedeu
         end
       end
 
-      # @param message [String]
+      # Returns the message with timestamp.
+      #
+      #    [ 0.0987] [debug]  Something happened.
+      #
+      # @param message [String] The message type and message coloured and
+      #   combined.
       # @return [String]
       def formatted_message(message)
         [timestamp, message, "\n"].join
       end
 
+      # Fetches the filename from the configuration.
+      #
       # @return [String]
       def log_file
         Vedeu::Configuration.log
       end
       alias_method :enabled?, :log_file
 
+      # Displays the message body using the colour specified in the last element
+      # of {message_types}.
+      #
       # @param type [Symbol] The type of log message.
       # @param body [String] The log message itself.
       # @return [String]
@@ -146,6 +160,9 @@ module Vedeu
         end
       end
 
+      # Displays the message type using the colour specified in the first
+      # element of {message_types}.
+      #
       # @param type [Symbol] The type of log message.
       # @return [String]
       def message_type(type)
@@ -154,7 +171,16 @@ module Vedeu
         end
       end
 
-      # @return [Hash<Symbol => Symbol>]
+      # The defined message types for Vedeu with their respective colours.
+      # When used, produces a log entry of the format:
+      #
+      #     [type] message
+      #
+      # The 'type' will be shown as the first colour defined in the value
+      # array, whilst the 'message' will be shown using the last colour.
+      # Valid types are available by viewing the source for this method.
+      #
+      # @return [Hash<Symbol => Array<Symbol>>]
       def message_types
         {
           config: [:light_yellow,  :yellow],

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.49'
+  VERSION = '0.4.50'
 
 end

data/test/lib/vedeu/api_test.rb

@@ -17,6 +17,7 @@ module Vedeu
     it { Vedeu.must_respond_to(:keymap) }
     it { Vedeu.must_respond_to(:interface) }
     it { Vedeu.must_respond_to(:renders) }
+    it { Vedeu.must_respond_to(:render) }
     it { Vedeu.must_respond_to(:views) }
     it { Vedeu.must_respond_to(:bind) }
     it { Vedeu.must_respond_to(:bound?) }
@@ -45,6 +46,12 @@ module Vedeu
     it { Vedeu.must_respond_to(:resize) }
     it { Vedeu.must_respond_to(:timer) }
     it { Vedeu.must_respond_to(:trigger) }
+    it { Vedeu.must_respond_to(:exit) }
+    it { Vedeu.must_respond_to(:clear) }
+    it { Vedeu.must_respond_to(:clear_by_name) }
+    it { Vedeu.must_respond_to(:clear_by_group) }
+    it { Vedeu.must_respond_to(:hide_cursor) }
+    it { Vedeu.must_respond_to(:show_cursor) }
 
   end # API
 

data/test/lib/vedeu/configuration/configuration_test.rb

@@ -9,7 +9,7 @@ module Vedeu
     before { Configuration.reset! }
     after  { test_configuration }
 
-    describe '#base_path' do
+    describe '.base_path' do
       it { described.must_respond_to(:base_path) }
 
       it 'returns the value of the base_path option' do
@@ -17,7 +17,7 @@ module Vedeu
       end
     end
 
-    describe '#debug?' do
+    describe '.debug?' do
       it { described.must_respond_to(:debug) }
 
       it 'returns the value of the debug option' do
@@ -25,7 +25,7 @@ module Vedeu
       end
     end
 
-    describe '#drb?' do
+    describe '.drb?' do
       it { described.must_respond_to(:drb) }
 
       it 'returns the value of the drb option' do
@@ -33,7 +33,7 @@ module Vedeu
       end
     end
 
-    describe '#interactive?' do
+    describe '.interactive?' do
       it { described.must_respond_to(:interactive) }
 
       it 'returns the value of the interactive option' do
@@ -41,7 +41,39 @@ module Vedeu
       end
     end
 
-    describe '#once?' do
+    describe '.log' do
+      context 'when the log is not configured' do
+        it { described.log.must_equal(nil) }
+      end
+
+      context 'when the log is configured' do
+        before do
+          Vedeu.configure do
+            log '/tmp/vedeu.log'
+          end
+        end
+
+        it { described.log.must_equal('/tmp/vedeu.log') }
+      end
+    end
+
+    describe '.log?' do
+      context 'when the log is not configured' do
+        it { described.log?.must_equal(false) }
+      end
+
+      context 'when the log is configured' do
+        before do
+          Vedeu.configure do
+            log '/tmp/vedeu.log'
+          end
+        end
+
+        it { described.log?.must_equal(true) }
+      end
+    end
+
+    describe '.once?' do
       it { described.must_respond_to(:once) }
 
       it 'returns the value of the once option' do
@@ -49,25 +81,25 @@ module Vedeu
       end
     end
 
-    describe '#stdin' do
+    describe '.stdin' do
       it 'returns the value of the redefined STDIN' do
         Configuration.stdin.must_equal(nil)
       end
     end
 
-    describe '#stdout' do
+    describe '.stdout' do
       it 'returns the value of the redefined STDOUT' do
         Configuration.stdout.must_equal(nil)
       end
     end
 
-    describe '#stderr' do
+    describe '.stderr' do
       it 'returns the value of the redefined STDERR' do
         Configuration.stderr.must_equal(nil)
       end
     end
 
-    describe '#terminal_mode' do
+    describe '.terminal_mode' do
       it 'returns the value of the mode option' do
         Configuration.terminal_mode.must_equal(:raw)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.49
+  version: 0.4.50
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -318,6 +318,8 @@ files:
 - lib/vedeu/cli/generator/application.rb
 - lib/vedeu/cli/generator/helpers.rb
 - lib/vedeu/cli/generator/templates/application/Gemfile
+- lib/vedeu/cli/generator/templates/application/LICENSE.txt
+- lib/vedeu/cli/generator/templates/application/README.md
 - lib/vedeu/cli/generator/templates/application/app/controllers/application_controller.erb
 - lib/vedeu/cli/generator/templates/application/app/controllers/name.erb
 - lib/vedeu/cli/generator/templates/application/app/helpers/application_helper.erb