vedeu 0.6.21 → 0.6.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2bc250678c9728597c333d93e87cc728cbb4767
-  data.tar.gz: 5be52acf963d8b8db5fdc19a478293b836c7edb8
+  metadata.gz: 962d118b37be3f266143bd483c590ea61fcb045b
+  data.tar.gz: a10a95a4e722f747a4faa9b07653d1a74ba98ccb
 SHA512:
-  metadata.gz: b0210cec1fa8d31b42f9dcb8deb71697e09b2925120274524bcb185da446481dede13465795ef86ebb1b6b5d44d228d36667ac11733ba87d7a6702c9e87b14e8
-  data.tar.gz: 6e9b739f5ee331a20e1df15c4e97880313f9491067edc82d487c553757eafd134bc14861c9ecf5a384ed314d79253e62b3ec07dcb2db16e0dcbabb2235a62ed3
+  metadata.gz: 658eae376a443bde02be432fd0c91c46f972c59da102ea7f198198831b0dc2371776566cb74545829ba4b2a7c3a3f0e8196993be1faadaa3ec195f87db24cbf8
+  data.tar.gz: 3950ca1569a8e8ebf80fe8b14692fcf0796fa61d5eb9d9267ed7606a654ecde8519ac79c4f6d591166f988aad10e8fbee74bbb22ee29c2a3eff23353e28cd2db

data/.rubocop.yml

@@ -21,6 +21,7 @@ AllCops:
     - '**/Cheffile'
     - '**/Vagabondfile'
   Exclude:
+    - 'examples/**/*'
     - 'test/**/*'
     - 'vendor/**/*'
   # By default, the rails cops are not run. Override in project or home

data/bin/vedeu_drb_server

@@ -12,6 +12,7 @@ class VedeuTestApplication
     colour_mode 16_777_216
     log         '/tmp/vedeu_test_helper.log'
     debug!
+    profile!
     drb!
     drb_host    'localhost'
     drb_port    21_420

data/docs/configuration.md

@@ -57,6 +57,9 @@ reason, simply ask for it:
 ### log_only
 {include:Vedeu::Config::API#log_only}
 
+### profile / profile!
+{include:Vedeu::Config::API#profile}
+
 ### raw / raw!
 {include:Vedeu::Config::API#raw}
 

data/docs/events/refresh.md

@@ -29,3 +29,8 @@ Will cause all interfaces in the named group to refresh.
 Will cause the named view to refresh.
 
     Vedeu.trigger(:_refresh_view_, name)
+
+### :_refresh_view_content_
+Will cause only the content of the named view to refresh.
+
+    Vedeu.trigger(:_refresh_view_content_, name)

data/docs/events/visibility.md

@@ -23,6 +23,12 @@ Clears the named view/interface area.
     Vedeu.trigger(:_clear_view_, name)
     Vedeu.clear_by_name(name)
 
+### :_clear_view_content_
+Clears only the content of the named view/interface area.
+
+    Vedeu.trigger(:_clear_view_content_, name)
+    Vedeu.clear_content_by_name(name)
+
 ### :_hide_cursor_
 Hide the cursor of the named interface or when a name is not given,
 the interface currently in focus.

data/examples/hello_worlds.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vedeu'
+
+# An example application to demonstrate 'Hello World' and a minimum of
+# interactivity.  It uses the DSL-style of vedeu (not the full-flegded
+# MVC-approach).
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     bundle exec ./examples/hello_worlds.rb
+#
+class HelloWorldsApp
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.configure do
+    # Empty configure block is needed.
+  end
+
+  Vedeu.interface :hello do
+    # Define all of the interface in one place.
+    background '#000000'
+    foreground '#00ff00'
+    geometry do
+      centred!
+      height   5
+      width    24
+    end
+    # (You usually specify the views outside the interface block).
+    Vedeu.views do
+      view :hello do
+        lines do
+          line { centre 'Hello Worlds!', width: 24 }
+          line
+          line { centre "Press 'q' to exit,",     width: 24 }
+          line { centre " 'w' to switch worlds.", width: 24 }
+        end
+      end
+    end
+    keymap do
+      key('q') { Vedeu.exit }
+      key('w') { HelloWorldsApp.render_world }
+    end
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+  private
+
+  def self.render_world
+    # Immediately render this to screen.
+    Vedeu.render do
+      view :hello do
+        geometry do
+          centred!
+          height  5 + 2
+          width   24 + 2
+        end
+        border do
+          colour foreground: ["#00ff00", "#000033", "#cddc39", "#03a9f4"].sample
+          title ["atlantis", "oceania", "utopia", "midgard", "middle-earth"].sample
+        end
+        lines do
+          line { centre 'Hello Worlds!', width: 24 }
+          line
+          line { centre "Press 'q' to exit,",     width: 24 }
+          line { centre " 'w' to switch worlds.", width: 24 }
+        end
+      end
+    end
+  end
+
+end # HelloWorldsApp
+
+HelloWorldsApp.start(ARGV)

data/lib/vedeu/all.rb

@@ -1,10 +1,10 @@
-require 'vedeu/logging/all'
 require 'vedeu/version'
+
+require 'vedeu/logging/all'
 require 'vedeu/options'
 
 require 'vedeu/error'
 require 'vedeu/common'
-require 'vedeu/logging/all'
 require 'vedeu/runtime/all'
 
 require 'vedeu/configuration/api'

data/lib/vedeu/bindings/refresh.rb

@@ -17,6 +17,7 @@ module Vedeu
         refresh_cursor!
         refresh_group!
         refresh_view!
+        refresh_view_content!
       end
 
       private
@@ -49,6 +50,13 @@ module Vedeu
         end
       end
 
+      # See {file:docs/events/refresh.md#\_refresh_view_content_}
+      def refresh_view_content!
+        Vedeu.bind(:_refresh_view_content_) do |name|
+          Vedeu::Buffers::Refresh.refresh_content_by_name(name)
+        end
+      end
+
       # :nocov:
 
     end # Refresh

data/lib/vedeu/bindings/visibility.rb

@@ -17,6 +17,7 @@ module Vedeu
         clear!
         clear_group!
         clear_view!
+        clear_view_content!
         hide_cursor!
         hide_group!
         hide_interface!
@@ -54,6 +55,13 @@ module Vedeu
         Vedeu.bind(:_clear_view_) { |name| Vedeu.clear_by_name(name) }
       end
 
+      # See {file:docs/events/visibility.md#\_clear_view_content_}
+      def clear_view_content!
+        Vedeu.bind(:_clear_view_content_) do |name|
+          Vedeu.clear_content_by_name(name)
+        end
+      end
+
       # See {file:docs/events/visibility.md#\_hide_cursor_}
       def hide_cursor!
         Vedeu.bind(:_hide_cursor_) { |name| Vedeu.hide_cursor(name) }

data/lib/vedeu/borders/border.rb

@@ -172,7 +172,7 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Views::Char>>]
       def render
-        Vedeu::Borders::Render.with(self)
+        Vedeu::Borders::Render.render(self)
       end
 
       private

data/lib/vedeu/borders/render.rb

@@ -41,7 +41,7 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Views::Char>>]
       # @param (see #initialize)
-      def self.with(border)
+      def self.render(border)
         new(border).render
       end
 
@@ -55,15 +55,7 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Views::Char>>]
       def render
-        return [] unless enabled?
-
-        Vedeu.timer("Bordering: '#{name}'") do
-          out = [top, bottom]
-
-          height.times { |y| out << [left(y), right(y)] }
-
-          out.flatten
-        end
+        Vedeu::Output::Output.render(output) if enabled?
       end
 
       protected
@@ -74,6 +66,17 @@ module Vedeu
 
       private
 
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def output
+        Vedeu.timer("Bordering: '#{name}'") do
+          out = [top, bottom]
+
+          height.times { |y| out << [left(y), right(y)] }
+
+          out.flatten
+        end
+      end
+
       # @param value [String]
       # @param type [Symbol|NilClass]
       # @param iy [Fixnum]

data/lib/vedeu/buffers/buffer.rb

@@ -94,24 +94,7 @@ module Vedeu
         true
       end
 
-      # Hide this buffer.
-      #
-      # @example
-      #   Vedeu.trigger(:_hide_interface_, name)
-      #   Vedeu.hide_interface(name)
-      #
-      # Will hide the named interface. If the interface is currently
-      # visible, it will be cleared- rendered blank. To show the
-      # interface, the ':_show_interface_' event should be triggered.
-      # Triggering the ':_hide_group_' event to which this named
-      # interface belongs will also hide the interface.
-      #
-      # @return [Array<Array<Array<Vedeu::Views::Char>>>]
-      def hide
-        Vedeu.trigger(:_clear_view_, name)
-      end
-
-      # Return the content for this buffer.
+      # Retrieve the latest content from the buffer.
       #
       # - If we have new content (i.e. content on 'back') to be shown,
       #   we first clear the area occupied by the previous content,
@@ -126,46 +109,19 @@ module Vedeu
       #
       # @return [Array<Array<Array<Vedeu::Views::Char>>>]
       def render
-        Vedeu::Output::Output.render(buffer)
-      end
-
-      # Show this buffer.
-      #
-      # @example
-      #   Vedeu.trigger(:_show_interface_, name)
-      #   Vedeu.show_interface(name)
-      #
-      # Will show the named interface. If the interface is currently
-      # invisible, it will be shown- rendered with its latest content.
-      # To hide the interface, the ':_hide_interface_' event should be
-      # triggered. Triggering the ':_show_group_' event to which this
-      # named interface belongs will also show the interface.
-      #
-      # @return [Array<Array<Array<Vedeu::Views::Char>>>]
-      def show
-        Vedeu::Output::Output.render(buffer)
-      end
-
-      private
-
-      # Retrieve the latest content from the buffer.
-      #
-      # @return [Array<Array<Array<Vedeu::Views::Char>>>]
-      def buffer
         swap if back?
 
         if front?
-          [front.render]
+          front.render
 
         elsif previous?
-          [previous.render]
-
-        else
-          []
+          previous.render
 
         end
       end
 
+      private
+
       # Returns the default options/attributes for this class.
       #
       # @return [Hash<Symbol => NilClass, String>]

data/lib/vedeu/buffers/refresh.rb

@@ -4,32 +4,45 @@ module Vedeu
 
     # Refreshes the given named interface.
     #
-    # @example
-    #   Vedeu.trigger(:_refresh_view_, name)
-    #
     class Refresh
 
       include Vedeu::Common
 
+      # @example
+      #   Vedeu.trigger(:_refresh_view_, name)
+      #
       # @param (see #initialize)
       # @return (see #by_name)
       def self.by_name(name)
         new(name).by_name
       end
 
+      # @example
+      #   Vedeu.trigger(:_refresh_view_content_, name)
+      #
+      # @param (see #initialize)
+      # @return (see #by_name)
+      def self.refresh_content_by_name(name)
+        new(name, content_only: true).by_name
+      end
+
       # Return a new instance of Vedeu::Buffers::Refresh.
       #
       # @param name [String|Symbol] The name of the interface to be refreshed
       #   using the named buffer.
+      # @param options [Hash]
+      # @option options content_only [Boolean]
       # @return [Vedeu::Buffers::Refresh]
-      def initialize(name)
-        @name = name
+      def initialize(name, options = {})
+        @name    = name
+        @options = options
       end
 
       # @return [Array|Vedeu::Error::ModelNotFound]
       def by_name
-        Vedeu.timer("Refresh Buffer: '#{buffer_name}'") do
-          Vedeu.buffers.by_name(buffer_name).render
+        Vedeu.timer("Refresh Buffer: '#{name}'") do
+          Vedeu.buffers.by_name(name).render
+          Vedeu.borders.by_name(name).render unless content_only?
         end if Vedeu.ready?
       end
 
@@ -39,16 +52,21 @@ module Vedeu
       # @return [String|Symbol]
       attr_reader :name
 
-      private
+      # @return [Boolean]
+      def content_only?
+        options[:content_only] == true
+      end
 
-      # @raise [Vedeu::Error::MissingRequired] When the name is empty
-      #   or nil.
-      # @return [String|Symbol]
-      def buffer_name
-        return name if present?(name)
+      # @return [Hash<Symbol => Boolean>]
+      def options
+        defaults.merge!(@options)
+      end
 
-        fail Vedeu::Error::MissingRequired,
-             'Cannot refresh interface with an empty interface name.'
+      # @return [Hash<Symbol => Boolean>]
+      def defaults
+        {
+          content_only: false,
+        }
       end
 
     end # Refresh

data/lib/vedeu/configuration/api.rb

@@ -221,9 +221,8 @@ module Vedeu
       # setting is for debugging to be disabled. Using `debug!` or
       # setting `debug` to true will enable debugging.
       #
-      # @note
-      #   Be aware that running an application with debugging enabled
-      #   will affect performance.
+      # At this time, debugging only toggles between viewing a full
+      # backtrace (true) upon exception or only its top line (false).
       #
       #   Vedeu.configure do
       #     debug!
@@ -310,6 +309,36 @@ module Vedeu
         options[:log_only] = types
       end
 
+      # Sets boolean to enable/disable profiling. Vedeu's default
+      # setting is for profiling to be disabled. Using `profile!` or
+      # setting `profile` to true will enable profiling.
+      #
+      # Profile uses 'ruby-prof' to write a 'profile.html' file to
+      # the /tmp directory which contains a call trace of the running
+      # application. Upon exit, this file can be examined to ascertain
+      # certain behaviours of Vedeu.
+      #
+      # @note
+      #   Be aware that running an application with profiling enabled
+      #   will affect performance.
+      #
+      #   Vedeu.configure do
+      #     profile!
+      #     # ...
+      #   end
+      #
+      #   Vedeu.configure do
+      #     profile false
+      #     # ...
+      #   end
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      def profile!(value = true)
+        options[:profile] = value
+      end
+      alias_method :profile, :profile!
+
       # Sets the renderers for Vedeu. Each renderer added must have
       # the class method '.render' defined as this will be called when
       # rendering content.