vedeu 0.6.13 → 0.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31c6be7113f82b029855008aaaf699fbd567ae33
-  data.tar.gz: 1bf5c6c64eb63d6332af2645be09bf0103fc19e8
+  metadata.gz: 7e1b859a5c5879bc2165e48baaf00b3a15448111
+  data.tar.gz: dd4db5330f731e8f171c38c3c3f22bd6331b5356
 SHA512:
-  metadata.gz: 24727ce127fde1301bddc57102f7814fde4fb73f020012cbe0bf5d1d13c7b4023a0457691f1815f6e4ee6f5d53160843a003b53ba9dc231b12b9df8b8ac34e87
-  data.tar.gz: 310d942055981700a8b3f7381291b0c1a29517c85531be676eee43ff877a6dba875f53b57a424d7863949c9f975b3dba66e766d811347e634fed7f074b8edae4
+  metadata.gz: 54b2f06a47ded5480ada1597206145f678390d23897656060724a263b37a68fdecc139a2f3393fb6ab6b97b47aca0d1e1cba762e62dc2df4b4c44a36ba25b59a
+  data.tar.gz: 29b42c9a6fb03431f8b4c45688edb6f30c7df68b434933406cc81e8eb69dc29614c8244762d622b59119034d5c8918ae1f8209d7e9640197182be2dd5e3e628e

data/docs/configuration.md

@@ -21,68 +21,54 @@ simply ask for it:
 
 ### colour_mode
 {include:Vedeu::Config::API#colour_mode}
-{include:Vedeu::Config::CLI#colour_mode}
 
 ### compression / compression!
 {include:Vedeu::Config::API#compression}
 
 ### cooked / cooked!
 {include:Vedeu::Config::API#cooked}
-{include:Vedeu::Config::CLI#cooked}
 
 ### debug / debug!
 {include:Vedeu::Config::API#debug}
-{include:Vedeu::Config::CLI#debug}
 
 ### drb / drb!
 {include:Vedeu::Config::API#drb}
-{include:Vedeu::Config::CLI#drb}
 
 ### drb_host
 {include:Vedeu::Config::API#drb_host}
-{include:Vedeu::Config::CLI#drb_host}
 
 ### drb_port
 {include:Vedeu::Config::API#drb_port}
-{include:Vedeu::Config::CLI#drb_port}
 
 ### drb_height
 {include:Vedeu::Config::API#drb_height}
-{include:Vedeu::Config::CLI#drb_height}
 
 ### drb_width
 {include:Vedeu::Config::API#drb_width}
-{include:Vedeu::Config::CLI#drb_width}
 
 ### interactive / interactive!
 {include:Vedeu::Config::API#interactive}
-{include:Vedeu::Config::CLI#interactive}
 
 ### log
 {include:Vedeu::Config::API#log}
-{include:Vedeu::Config::CLI#log}
 
 ### log_only
 {include:Vedeu::Config::API#log_only}
 
 ### raw / raw!
 {include:Vedeu::Config::API#raw}
-{include:Vedeu::Config::CLI#raw}
 
 ### renderer / renderers
 {include:Vedeu::Config::API#renderer}
 
 ### root
 {include:Vedeu::Config::API#root}
-{include:Vedeu::Config::CLI#root}
 
 ### run_once / run_once!
 {include:Vedeu::Config::API#run_once}
-{include:Vedeu::Config::CLI#run_once}
 
 ### standalone / standalone!
 {include:Vedeu::Config::API#standalone}
-{include:Vedeu::Config::CLI#standalone}
 
 ### stderr
 {include:Vedeu::Config::API#stderr}

data/lib/vedeu.rb

@@ -12,7 +12,6 @@ require 'forwardable'
 require 'io/console'
 require 'json'
 require 'logger'
-require 'optparse'
 require 'set'
 require 'singleton'
 require 'thread'

data/lib/vedeu/all.rb

@@ -6,7 +6,6 @@ require 'vedeu/common'
 require 'vedeu/logging/all'
 require 'vedeu/runtime/all'
 
-require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
 
@@ -17,6 +16,19 @@ require 'vedeu/input/keys'
 
 require 'vedeu/models/toggleable'
 
+require 'vedeu/output/presentation/presentation'
+require 'vedeu/output/direct'
+require 'vedeu/output/clear/named_group'
+require 'vedeu/output/clear/named_interface'
+require 'vedeu/output/compressor'
+require 'vedeu/output/text'
+require 'vedeu/output/output'
+require 'vedeu/output/viewport'
+require 'vedeu/output/wordwrap'
+require 'vedeu/output/refresh/refresh'
+require 'vedeu/output/refresh/refresh_group'
+require 'vedeu/output/renderers/all'
+
 require 'vedeu/esc/all'
 require 'vedeu/null/all'
 require 'vedeu/models/views/all'
@@ -35,19 +47,6 @@ require 'vedeu/input/all'
 require 'vedeu/menus/all'
 require 'vedeu/templating/all'
 
-require 'vedeu/output/presentation/presentation'
-require 'vedeu/output/direct'
-require 'vedeu/output/clear/named_group'
-require 'vedeu/output/clear/named_interface'
-require 'vedeu/output/compressor'
-require 'vedeu/output/text'
-require 'vedeu/output/output'
-require 'vedeu/output/viewport'
-require 'vedeu/output/wordwrap'
-require 'vedeu/output/refresh/refresh'
-require 'vedeu/output/refresh/refresh_group'
-require 'vedeu/output/renderers/all'
-
 require 'vedeu/api/all'
 require 'vedeu/bindings/all'
 require 'vedeu/plugins/all'

data/lib/vedeu/api/internal.rb

@@ -64,8 +64,8 @@ module Vedeu
       #   Vedeu.documents
       #
       # @!method documents
-      # @return [Vedeu::Editor::Documents]
-      def_delegators Vedeu::Editor::Documents, :documents
+      # @return [Vedeu::Editor::Repository]
+      def_delegators Vedeu::Editor::Repository, :documents
 
       # Manipulate the repository of events.
       #

data/lib/vedeu/bindings/focus.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   module Bindings
 
+    # Provides events to change the focus between interfaces/views.
+    #
     module Focus
 
       extend self

data/lib/vedeu/bindings/refresh.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   module Bindings
 
+    # Provides events to refresh the view.
+    #
     module Refresh
 
       extend self

data/lib/vedeu/bindings/system.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   module Bindings
 
+    # Provides events to manage Vedeu.
+    #
     module System
 
       extend self

data/lib/vedeu/configuration/api.rb

@@ -420,8 +420,6 @@ module Vedeu
       # @note
       # - Be aware that running an application without compression
       #   will affect performance.
-      # - Compression cannot yet be configured using a CLI option
-      #   flag.
       #
       # @param value [Boolean]
       # @return [Boolean]

data/lib/vedeu/configuration/configuration.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  # Namespace for the API configuration and CLI configuration classes.
+  # Namespace for configuration classes.
   #
   module Config
 
@@ -8,8 +8,7 @@ module Vedeu
 
     # Custom log for configuration.
     #
-    # @param from [String] Which configuration set the options
-    #   ('API' or 'CLI').
+    # @param from [String] Which configuration set the options.
     # @param options [Hash] The configuration options set.
     # @return [Hash] The options param.
     def log(from, options)
@@ -22,12 +21,12 @@ module Vedeu
   end
 
   # Allows the customisation of Vedeu's behaviour through the
-  # configuration API or command-line arguments.
+  # configuration API.
   #
   # Provides access to Vedeu's configuration, which was set with
   # sensible defaults (influenced by environment variables),
   # overridden by client application settings (via the configuration
-  # API), or any command-line arguments provided.
+  # API).
   #
   class Configuration
 
@@ -51,16 +50,13 @@ module Vedeu
       alias_method :compression?, :compression
 
       # Provides the mechanism to configure Vedeu. If the client
-      # application sets options, override the defaults with those,
-      # and when command-line arguments are provided at application
-      # invocation, override any options with the arguments provided.
+      # application sets options, override the defaults with those.
       #
       # @example
       #   Vedeu.configure do
       #     # ...
       #   end
       #
-      # @param args [Array]
       # @param opts [Hash]
       # @option opts stdin [File|IO]
       # @option opts stdout [File|IO]
@@ -69,8 +65,8 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax]
       #   When the required block is not given.
       # @return [Hash]
-      def configure(args = [], opts = {}, &block)
-        instance.configure(args, opts, &block)
+      def configure(opts = {}, &block)
+        instance.configure(opts, &block)
       end
 
       # Returns the configuration singleton.
@@ -265,18 +261,14 @@ module Vedeu
     end
 
     # Set up default configuration and then allow the client
-    # application to modify it via the configuration API. After this,
-    # process any command line arguments as potential configuration
-    # and apply that.
+    # application to modify it via the configuration API.
     #
-    # @param args [Array]
     # @param block [Proc]
     # @return [Hash]
-    def configure(args = [], opts = {}, &block)
+    def configure(opts = {}, &block)
       @options.merge!(opts)
 
       @options.merge!(Config::API.configure(&block)) if block_given?
-      @options.merge!(Config::CLI.configure(args)) if args.any?
 
       Vedeu::Renderers.renderer(*@options[:renderers])
 

data/lib/vedeu/dsl/dsl.rb

@@ -32,6 +32,7 @@ module Vedeu
     end
 
     # :nocov:
+
     # Attempts to find the missing method on the client object.
     #
     # @param method [Symbol] The name of the method sought.
@@ -45,6 +46,7 @@ module Vedeu
 
       client.send(method, *args, &block) if client
     end
+
     # :nocov:
 
   end # DSL

data/lib/vedeu/dsl/text.rb

@@ -23,6 +23,12 @@ module Vedeu
       #     right '...'
       #   end
       #
+      #   line do
+      #     stream do
+      #       text '...'
+      #     end
+      #   end
+      #
       #   left 'This will be left aligned.', width: 35
       #   # => 'This will be left aligned.         '
       #

data/lib/vedeu/editor/all.rb

@@ -16,4 +16,4 @@ require 'vedeu/editor/line'
 require 'vedeu/editor/lines'
 require 'vedeu/editor/cursor'
 require 'vedeu/editor/document'
-require 'vedeu/editor/documents'
+require 'vedeu/editor/repository'

data/lib/vedeu/editor/{documents.rb → repository.rb}

@@ -4,14 +4,14 @@ module Vedeu
 
     # Allows the storing of documents.
     #
-    class Documents < Vedeu::Repositories::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :documents, :repository)
 
       real Vedeu::Editor::Document
       null Vedeu::Editor::Document
 
-    end # Documents
+    end # Repository
 
   end # Editor
 

data/lib/vedeu/esc/actions.rb

@@ -1,7 +1,5 @@
 module Vedeu
 
-  # Provides escape sequence strings.
-  #
   module EscapeSequences
 
     # Provides action related escape sequences.

data/lib/vedeu/esc/borders.rb

@@ -1,7 +1,5 @@
 module Vedeu
 
-  # Provides escape sequence strings.
-  #
   module EscapeSequences
 
     # Provides border/box related escape sequences.

data/lib/vedeu/esc/colours.rb

@@ -1,7 +1,5 @@
 module Vedeu
 
-  # Provides escape sequence strings.
-  #
   module EscapeSequences
 
     # Provides colour related escape sequences.

data/lib/vedeu/input/mapper.rb

@@ -54,12 +54,12 @@ module Vedeu
       def keypress
         return false unless key
 
-        Vedeu.log(type: :input, message: "Key detected: #{key.inspect}")
-
         return true if key_defined? && keymap.use(key)
 
         return true if global_key? && keymap('_global_').use(key)
 
+        Vedeu.log(type: :input, message: "Key detected: #{key.inspect}")
+
         false
       end
 

data/lib/vedeu/menus/all.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Provides the mechanism to create menus within client
+  # applications.
+  #
   module Menus
 
   end # Menus

data/lib/vedeu/models/all.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Provides various models which Vedeu uses.
+  #
   module Models
 
   end # Models

data/lib/vedeu/models/views/all.rb

@@ -10,13 +10,9 @@ end # Vedeu
 
 require 'vedeu/models/views/char'
 require 'vedeu/models/views/html_char'
-require 'vedeu/models/views/collections/chars'
 require 'vedeu/models/views/stream'
-require 'vedeu/models/views/collections/streams'
 require 'vedeu/models/views/line'
-require 'vedeu/models/views/collections/lines'
 require 'vedeu/models/interface'
 require 'vedeu/models/interfaces'
-require 'vedeu/models/views/collections/view_collection'
 require 'vedeu/models/views/view'
 require 'vedeu/models/views/composition'

data/lib/vedeu/models/views/char.rb

@@ -2,6 +2,13 @@ module Vedeu
 
   module Views
 
+    # A collection of {Vedeu::Views::Char} instances.
+    #
+    # @api private
+    class Chars < Vedeu::Repositories::Collection
+
+    end # Chars
+
     # A Char represents a single character of the terminal. It is a container
     # for the a single character in a {Vedeu::Views::Stream}.
     #

data/lib/vedeu/models/views/line.rb

@@ -2,6 +2,13 @@ module Vedeu
 
   module Views
 
+    # A collection of {Vedeu::Views::Line} instances.
+    #
+    # @api private
+    class Lines < Vedeu::Repositories::Collection
+
+    end # Lines
+
     # Represents a single row of the terminal. It is a container for
     # {Vedeu::Views::Stream} objects. A line's width is determined by
     # the {Vedeu::Geometry::Geometry} it belongs to.

data/lib/vedeu/models/views/stream.rb

@@ -2,6 +2,13 @@ module Vedeu
 
   module Views
 
+    # A collection of {Vedeu::Views::Stream} instances.
+    #
+    # @api private
+    class Streams < Vedeu::Repositories::Collection
+
+    end # Streams
+
     # Represents a character or collection of characters as part of a
     # {Vedeu::Views::Line} which you wish to colour and style independently of
     # the other characters in that line.