vedeu 0.8.0 → 0.8.1

data/examples/views/lines_line_streams_stream_stream.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -26,18 +28,13 @@ class DSLApp
     end
   end
 
-  Vedeu.keymap '_global_' do
-    key('q') { Vedeu.exit }
-  end
-
-  # vedeu/dsl/stream.rb:16:in `stream': wrong number of arguments (1 for 0)
   Vedeu.render do
     view(:main_interface) do
       lines do
         line do
           streams do
-            stream 'v->ls->l->streams->stream 1'
-            stream 'v->ls->l->streams->stream 2'
+            stream 'v->ls->l->ss->stream 1', { foreground: '#ffff00' }
+            stream 'v->ls->l->ss->stream 2', { foreground: '#00ffff' }
           end
         end
       end
@@ -48,6 +45,6 @@ class DSLApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end # EditorApp
+end # DSLApp
 
 DSLApp.start

data/examples/views/lines_streams.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -26,16 +28,12 @@ class DSLApp
     end
   end
 
-  Vedeu.keymap '_global_' do
-    key('q') { Vedeu.exit }
-  end
-
   Vedeu.render do
     view(:test1_interface) do
       lines do
         streams do
-          text 'view->lines->streams->text 1'
-          text 'view->lines->streams->text 2'
+          text 'v->ls->ss->text 1', { foreground: '#00ff00' }
+          text 'v->ls->ss->text 2', { foreground: '#0000ff' }
         end
       end
     end
@@ -45,6 +43,6 @@ class DSLApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end # EditorApp
+end # DSLApp
 
 DSLApp.start

data/examples/views/lines_streams_stream.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -26,17 +28,12 @@ class DSLApp
     end
   end
 
-  Vedeu.keymap '_global_' do
-    key('q') { Vedeu.exit }
-  end
-
-  # vedeu/dsl/stream.rb:16:in `stream': wrong number of arguments (1 for 0)
   Vedeu.render do
     view(:test1_interface) do
       lines do
         streams do
-          stream 'view->lines->streams->stream 1'
-          stream 'view->lines->streams->stream 2'
+          stream 'v->ls->ss->stream 1', { foreground: '#00ff00' }
+          stream 'v->ls->ss->stream 2', { foreground: '#ff0000' }
         end
       end
     end
@@ -46,6 +43,6 @@ class DSLApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end # EditorApp
+end # DSLApp
 
 DSLApp.start

data/lib/vedeu.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ruby standard libraries
 require 'base64'
 require 'date'
@@ -25,6 +27,20 @@ module Vedeu
   extend Forwardable
   extend self
 
+  # @param gem_name [String]
+  # @raise [Vedeu::Error::Fatal] When the required gem is not
+  #   available.
+  # @return [Boolean]
+  def requires_gem!(gem_name)
+    require gem_name if Gem::Specification.find_by_name(gem_name)
+
+    true
+
+  rescue Gem::LoadError
+    raise Vedeu::Error::Fatal,
+          "Vedeu requires '#{gem_name}' for this functionality."
+  end
+
 end # Vedeu
 
 require 'vedeu/all'

data/lib/vedeu/all.rb

@@ -1,23 +1,24 @@
+# frozen_string_literal: true
+
+require 'vedeu/version'
+
 require 'vedeu/boolean'
 require 'vedeu/common'
 require 'vedeu/error'
-require 'vedeu/version'
+
+require 'vedeu/configuration/all'
+require 'vedeu/esc/all'
+require 'vedeu/logging/all'
 
 require 'vedeu/coercers/all'
 require 'vedeu/repositories/all'
-
-require 'vedeu/esc/all'
 require 'vedeu/colours/all'
-require 'vedeu/configuration/all'
 require 'vedeu/events/all'
 
-require 'vedeu/logging/all'
-require 'vedeu/runtime/all'
 require 'vedeu/terminal/all'
 require 'vedeu/presentation/all'
-require 'vedeu/output/all'
 require 'vedeu/renderers/all'
-require 'vedeu/esc/all'
+require 'vedeu/output/all'
 require 'vedeu/null/all'
 require 'vedeu/views/all'
 require 'vedeu/cells/all'
@@ -37,3 +38,5 @@ require 'vedeu/interfaces/all'
 require 'vedeu/menus/all'
 require 'vedeu/templating/all'
 require 'vedeu/plugins/all'
+
+require 'vedeu/runtime/all'

data/lib/vedeu/application/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides methods which should be available to all client

data/lib/vedeu/application/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides methods which should be available to all client

data/lib/vedeu/application/application_view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides the mechanism to render views for the client application.
@@ -33,7 +35,7 @@ module Vedeu
     def render
       fail Vedeu::Error::NotImplemented,
            'The subclass of Vedeu::ApplicationView must implement the #render' \
-           'method.'.freeze
+           'method.'
     end
 
     protected
@@ -51,7 +53,7 @@ module Vedeu
     # @return [String]
     def template(value)
       @template = Vedeu::Configuration.base_path +
-                  "/app/views/templates/#{value}.erb".freeze
+                  "/app/views/templates/#{value}.erb"
     end
 
   end # ApplicationView

data/lib/vedeu/application/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides methods to be used by {Vedeu::ApplicationController}.

data/lib/vedeu/application/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides methods to be used by {Vedeu::ApplicationHelper}.

data/lib/vedeu/application/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides methods to be used by {Vedeu::ApplicationView}.

data/lib/vedeu/boolean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Represent a boolean object.

data/lib/vedeu/borders/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Borders are defined by name for each of the client application's
@@ -39,4 +41,3 @@ require 'vedeu/borders/border'
 require 'vedeu/borders/dsl'
 require 'vedeu/borders/refresh'
 require 'vedeu/borders/repository'
-require 'vedeu/borders/set_attribute'

data/lib/vedeu/borders/border.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Borders
@@ -296,13 +298,13 @@ module Vedeu
           bottom_horizontal: nil,
           bottom_left:       nil,
           bottom_right:      nil,
-          caption:           ''.freeze,
+          caption:           '',
           client:            nil,
           colour:            nil,
           enabled:           false,
           horizontal:        Vedeu::EscapeSequences::Borders.horizontal,
           left_vertical:     nil,
-          name:              ''.freeze,
+          name:              '',
           parent:            nil,
           repository:        Vedeu.borders,
           right_vertical:    nil,
@@ -311,7 +313,7 @@ module Vedeu
           show_right:        true,
           show_top:          true,
           style:             nil,
-          title:             ''.freeze,
+          title:             '',
           top_horizontal:    nil,
           top_left:          nil,
           top_right:         nil,

data/lib/vedeu/borders/caption.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Borders

data/lib/vedeu/borders/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Borders
@@ -11,14 +13,22 @@ module Vedeu
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Use
 
-      # Set the character to be used to draw the bottom left corner of
-      # the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     bottom_left '+'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/border.md}
+      # @param name [String|Symbol] The name of the interface or view
+      #   to which this border belongs.
+      # @param block [Proc]
+      # @macro raise_requires_block
+      # @raise [Vedeu::Error::MissingRequired] When the name is not
+      #   given.
+      # @return [Vedeu::Borders::Border]
+      def self.border(name, &block)
+        fail Vedeu::Error::MissingRequired unless name
+        fail Vedeu::Error::RequiresBlock unless block_given?
+
+        Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
+      end
+
+      # {include:file:docs/dsl/by_method/bottom_left.md}
       # @param char [String] Character to be used as the bottom left
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -31,14 +41,7 @@ module Vedeu
       end
       alias_method :bottom_left=, :bottom_left
 
-      # Set the character to be used to draw the bottom right corner
-      # of the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     bottom_right '+'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/bottom_right.md}
       # @param char [String] Character to be used as the bottom right
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -51,13 +54,7 @@ module Vedeu
       end
       alias_method :bottom_right=, :bottom_right
 
-      # Disable the border:
-      #
-      #   Vedeu.border :border_demo do
-      #     disable!
-      #     # ... some other code (will be ignored)
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/disable.md}
       # @return [Boolean]
       def disable!
         model.enabled = false
@@ -69,16 +66,9 @@ module Vedeu
 
         model.enabled
       end
+      alias_method :disabled!, :disable!
 
-      # Enable the border:
-      # (Borders are enabled by default when defined for an
-      # interface).
-      #
-      #   Vedeu.border :border_demo do
-      #     enable!
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/enable.md}
       # @return [Boolean]
       def enable!
         model.enabled = true
@@ -90,15 +80,9 @@ module Vedeu
 
         model.enabled
       end
+      alias_method :enabled!, :enable!
 
-      # Set the character to be used to draw the top horizontal part
-      # of the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     top_horizontal '-'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/top_horizontal.md}
       # @param char [String] Character to be used as the top
       #   horizontal border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -112,14 +96,7 @@ module Vedeu
       end
       alias_method :top_horizontal=, :top_horizontal
 
-      # Set the character to be used to draw the bottom horizontal
-      # part of the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     bottom_horizontal '-'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/bottom_horizontal.md}
       # @param char [String] Character to be used as the bottom
       #   horizontal border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -133,14 +110,7 @@ module Vedeu
       end
       alias_method :bottom_horizontal=, :bottom_horizontal
 
-      # Set the character to be used to draw a horizontal part of the
-      # border.
-      #
-      #   Vedeu.border :border_demo do
-      #     horizontal '-'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/horizontal.md}
       # @param char [String] Character to be used as the horizontal
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -153,16 +123,7 @@ module Vedeu
       end
       alias_method :horizontal=, :horizontal
 
-      # Enable/disable the bottom border.
-      #
-      #   Vedeu.border :border_demo do
-      #     bottom true  # or...
-      #     bottom false # or...
-      #     hide_bottom! # or...
-      #     show_bottom!
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/bottom.md}
       # @param value [Boolean] All values evaluate as true except nil
       # and false.
       # @return [Boolean]
@@ -188,16 +149,7 @@ module Vedeu
         bottom(true)
       end
 
-      # Enable/disable the left border.
-      #
-      #   Vedeu.border :border_demo do
-      #     left true  # or...
-      #     left false # or...
-      #     hide_left! # or...
-      #     show_left!
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/left.md}
       # @param value [Boolean] All values evaluate as true except nil
       #   and false.
       # @return [Boolean]
@@ -223,16 +175,7 @@ module Vedeu
         left(true)
       end
 
-      # Enable/disable the right border.
-      #
-      #   Vedeu.border :border_demo do
-      #     right true  # or...
-      #     right false # or...
-      #     hide_right! # or...
-      #     show_right!
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/right.md}
       # @param value [Boolean] All values evaluate as true except nil
       #   and false.
       # @return [Boolean]
@@ -258,18 +201,7 @@ module Vedeu
         right(true)
       end
 
-      # If you have you are showing a top border, you could add a
-      # title.
-      #
-      #   Vedeu.border :border_demo do
-      #     title 'My Cool Title'
-      #     # ... some code
-      #   end
-      #
-      # produces, depending on other customisations:
-      #
-      #   +- My Cool Title --------------------------------+
-      #
+      # {include:file:docs/dsl/by_method/title.md}
       # @param value [String] The title.
       # @return [String]
       def title(value)
@@ -278,18 +210,7 @@ module Vedeu
       end
       alias_method :title=, :title
 
-      # If you have you are showing a bottom border, you could add a
-      # caption.
-      #
-      #   Vedeu.border :border_demo do
-      #     caption 'My Cool Caption'
-      #     # ... some code
-      #   end
-      #
-      # produces, depending on other customisations:
-      #
-      #   +------------------------------ My Cool Caption -+
-      #
+      # {include:file:docs/dsl/by_method/caption.md}
       # @param value [String] The caption.
       # @return [String]
       def caption(value)
@@ -298,16 +219,7 @@ module Vedeu
       end
       alias_method :caption=, :caption
 
-      # Enable/disable the top border.
-      #
-      #   Vedeu.border :border_demo do
-      #     top true  # or...
-      #     top false # or...
-      #     hide_top! # or...
-      #     show_top!
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/top.md}
       # @param value [Boolean] All values evaluate as true except nil
       #   and false.
       # @return [Boolean]
@@ -333,14 +245,7 @@ module Vedeu
         top(true)
       end
 
-      # Set the character to be used to draw the top left corner of
-      # the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     top_left '+'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/top_left.md}
       # @param char [String] Character to be used as the top left
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -353,14 +258,7 @@ module Vedeu
       end
       alias_method :top_left=, :top_left
 
-      # Set the character to be used to draw the top right corner of
-      # the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     top_right '+'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/top_right.md}
       # @param char [String] Character to be used as the top right
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -373,14 +271,7 @@ module Vedeu
       end
       alias_method :top_right=, :top_right
 
-      # Set the character to be used to draw the left vertical part of
-      # the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     left_vertical '|'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/left_vertical.md}
       # @param char [String] Character to be used as the left vertical
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -394,14 +285,7 @@ module Vedeu
       end
       alias_method :left_vertical=, :left_vertical
 
-      # Set the character to be used to draw the right vertical part
-      # of the border.
-      #
-      #   Vedeu.border :border_demo do
-      #     right_vertical '|'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/right_vertical.md}
       # @param char [String] Character to be used as the right
       #   vertical border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|
@@ -415,14 +299,7 @@ module Vedeu
       end
       alias_method :right_vertical=, :right_vertical
 
-      # Set the character to be used to draw a vertical part of the
-      # border.
-      #
-      #   Vedeu.border :border_demo do
-      #     vertical '|'
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/vertical.md}
       # @param char [String] Character to be used as the vertical
       #   border character.
       # @param options [Hash<Symbol => Hash<Symbol => String>|String|