vedeu 0.4.58 → 0.4.59

data/README.md

@@ -41,6 +41,8 @@ to your project here.
 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).
 
+- [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
+
 
 ## Development / Contributing
 

data/docs/dsl.md

@@ -72,77 +72,89 @@ geometry 'main' do
 end
 ```
 
-### Borders
+## Borders
 
-Borders are defined by name for each of the client application's interfaces or
- views. They can be enabled or disabled (which controls whether they are
- rendered or not), they have their own colours and styles, and each aspect of
- the border can be controlled. The RubyDoc contains information for
- configuring borders.
+{include:Vedeu::DSL::Border}
 
-### Geometry
+### Setting a title for the border
 
-Geometry allows the configuration of the position and size of an interface.
+{include:Vedeu::DSL::Border#title}
 
-Here is an example of declarations for a `geometry` block:
+### Customising the appearance of the border
 
-```ruby
-interface 'main' do
-  geometry do
-    height 5 # Sets the height of the view to 5
-    width 20 # Sets the width of the view to 20
-    x 3 # Start drawing 3 spaces from left
-    y 10 # Start drawing 10 spaces from top
-    xn 30 # Stop drawing 30 spaces from the left
-    yn 20 # Stop drawing 20 spaces from top
-  end
-end
-```
+{include:Vedeu::DSL::Border#bottom_left}
+{include:Vedeu::DSL::Border#bottom_right}
+{include:Vedeu::DSL::Border#horizontal}
+{include:Vedeu::DSL::Border#top_left}
+{include:Vedeu::DSL::Border#top_right}
+{include:Vedeu::DSL::Border#vertical}
 
-If a declaration is omitted for `height` or `width` the full remaining space
-available in the terminal will be used. `x` and `y` both default to 0.
+### Enabling/disabling the border
 
-You can also make a geometry declaration dependent on another view:
+{include:Vedeu::DSL::Border#enable!}
+{include:Vedeu::DSL::Border#disable!}
 
-```ruby
-interface 'other_panel' do
-  # other code ...
-end
+### Enabling/disabling an aspect of the border
 
-interface 'main' do
-  geometry do
-    height 10
-    y { use('other_panel').south }
-  end
-end
-```
+{include:Vedeu::DSL::Border#bottom}
+{include:Vedeu::DSL::Border#left}
+{include:Vedeu::DSL::Border#right}
+{include:Vedeu::DSL::Border#top}
+
+## Geometry
+
+{include:Vedeu::DSL::Geometry}
+
+### Setting the interface dimensions
+
+{include:Vedeu::DSL::Geometry#centred}
+{include:Vedeu::DSL::Geometry#height}
+{include:Vedeu::DSL::Geometry#width}
+{include:Vedeu::DSL::Geometry#columns}
+{include:Vedeu::DSL::Geometry#rows}
+{include:Vedeu::DSL::Geometry#x}
+{include:Vedeu::DSL::Geometry#xn}
+{include:Vedeu::DSL::Geometry#y}
+{include:Vedeu::DSL::Geometry#yn}
+
+## Groups
+
+{include:Vedeu::DSL::Group}
+
+### Add interfaces to groups
+
+{include:Vedeu::DSL::Group.group}
+
+## Keymaps
+
+{include:Vedeu::DSL::Keymap}
+{include:Vedeu::DSL::Keymap.keymap}
+{include:Vedeu::DSL::Keymap#name}
+
+## Menus
 
-This view will begin just below "other\_panel".
+{include:Vedeu::DSL::Menu}
+{include:Vedeu::DSL::Menu#item}
+{include:Vedeu::DSL::Menu#items}
+{include:Vedeu::DSL::Menu#name}
 
-### Groups
+## Views
 
-Interfaces can be configured to be part of a named group. Once an interface is a
- member of group, the group can be affected by other controls. For example,
- assuming the client application is a simple Git client, it may have a group
- called 'commit'. The 'commit' group will contain the interfaces 'diff' (to show
- the changes), 'staged' (to show which files are staged) and 'unstaged'. A
- refresh of the 'commit' group would cause all interfaces belonging to the group
- to refresh. Similarly, showing or hiding the group would of course, show or
- hide the interfaces of that group.
+{include:Vedeu::DSL::View.interface}
 
-### Keymaps
+### Immediate rendering
 
-You can define keymaps by name which matches a defined interface. When that
- interface is in focus, keys pressed as part of this definition will affect
- that interface. This allows you to form context driven behaviour for your
- application.
+{include:Vedeu::DSL::View.render}
 
+### Deferred rendering
 
-### Menus
+{include:Vedeu::DSL::View.view}
 
-`@todo` Documentation coming soon!
+### Specifying view content
 
-### Views
+{include:Vedeu::DSL::Line}
+{include:Vedeu::DSL::Line#line}
+{include:Vedeu::DSL::Line#streams}
 
-@todo Documentation coming soon!
+`@todo` More documentation coming soon.
 

data/lib/vedeu/all.rb

@@ -7,12 +7,28 @@ require 'vedeu/debug'
 require 'vedeu/traps'
 require 'vedeu/common'
 require 'vedeu/terminal_mode'
+
+require 'vedeu/configuration/cli'
+require 'vedeu/configuration/api'
+require 'vedeu/configuration/configuration'
+
 require 'vedeu/terminal'
 require 'vedeu/timer'
 require 'vedeu/main_loop'
 require 'vedeu/application'
+
+require 'vedeu/models/toggleable'
+
+require 'vedeu/repositories/collection'
+require 'vedeu/input/keys'
+require 'vedeu/events/event_collection'
 require 'vedeu/repositories'
 
+require 'vedeu/repositories/model'
+require 'vedeu/repositories/store'
+require 'vedeu/repositories/registerable'
+require 'vedeu/repositories/repository'
+
 require 'vedeu/null'
 require 'vedeu/null/border'
 require 'vedeu/null/buffer'
@@ -20,11 +36,6 @@ require 'vedeu/null/generic'
 require 'vedeu/null/geometry'
 require 'vedeu/null/interface'
 
-require 'vedeu/repositories/collection'
-require 'vedeu/repositories/store'
-require 'vedeu/repositories/registerable'
-require 'vedeu/repositories/repository'
-
 require 'vedeu/geometry/area'
 require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/dimension'
@@ -44,32 +55,48 @@ require 'vedeu/colours/background'
 require 'vedeu/colours/foreground'
 require 'vedeu/colours/colour'
 
-require 'vedeu/buffers/buffers'
 require 'vedeu/buffers/buffer'
+require 'vedeu/buffers/buffers'
+
 require 'vedeu/buffers/display_buffer'
 
-require 'vedeu/cursor/cursors'
 require 'vedeu/cursor/cursor'
+require 'vedeu/cursor/cursors'
 require 'vedeu/cursor/move'
 require 'vedeu/cursor/refresh_cursor'
 require 'vedeu/cursor/reposition'
 
+require 'vedeu/output/renderers/renderer_options'
+require 'vedeu/output/renderers/escape_sequence'
+require 'vedeu/output/renderers/file'
+require 'vedeu/output/renderers/html'
+require 'vedeu/output/renderers/json'
+require 'vedeu/output/renderers/null'
+require 'vedeu/output/renderers/terminal'
+require 'vedeu/output/renderers/text'
 require 'vedeu/output/renderers'
 
-require 'vedeu/events/event_collection'
+require 'vedeu/events/trigger'
 require 'vedeu/events/events'
 require 'vedeu/events/event'
-require 'vedeu/events/trigger'
 
 require 'vedeu/models/cell'
 require 'vedeu/models/char'
+require 'vedeu/models/chars'
 require 'vedeu/models/escape'
 require 'vedeu/models/stream'
+require 'vedeu/models/streams'
+require 'vedeu/models/lines'
+require 'vedeu/models/line'
+require 'vedeu/models/interface'
 require 'vedeu/models/interfaces'
+require 'vedeu/models/interface_collection'
 require 'vedeu/models/composition'
 require 'vedeu/models/focus'
-require 'vedeu/models/groups'
 require 'vedeu/models/group'
+require 'vedeu/models/groups'
+
+require 'vedeu/models/menu'
 require 'vedeu/models/menus'
 
 require 'vedeu/templating/helpers'
@@ -84,12 +111,12 @@ require 'vedeu/application/application_controller'
 require 'vedeu/application/application_helper'
 require 'vedeu/application/application_view'
 
+require 'vedeu/cli/generator/helpers'
+require 'vedeu/cli/generator/application'
+require 'vedeu/cli/generator/view'
 require 'vedeu/cli/generator/all'
-require 'vedeu/cli/main'
 
-require 'vedeu/configuration/cli'
-require 'vedeu/configuration/api'
-require 'vedeu/configuration/configuration'
+require 'vedeu/cli/main'
 
 require 'vedeu/distributed/uri'
 require 'vedeu/distributed/server'
@@ -115,15 +142,16 @@ require 'vedeu/dsl/view'
 require 'vedeu/input/mapper'
 require 'vedeu/input/key'
 require 'vedeu/input/input'
-require 'vedeu/input/keymaps'
 require 'vedeu/input/keymap'
+require 'vedeu/input/keymaps'
 
 require 'vedeu/output/clear/named_group'
 require 'vedeu/output/clear/named_interface'
 require 'vedeu/output/esc'
 require 'vedeu/output/presentation'
-require 'vedeu/output/borders'
+require 'vedeu/output/render_border'
 require 'vedeu/output/border'
+require 'vedeu/output/borders'
 require 'vedeu/output/compressor'
 require 'vedeu/output/style'
 require 'vedeu/output/text'

data/lib/vedeu/api.rb

@@ -16,8 +16,6 @@ module Vedeu
   #   # with other methods
   #   Vedeu.method_name.other_method
   #
-  # @api public
-  #
   module API
 
     extend Forwardable

data/lib/vedeu/bindings/drb.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # System events relating to the DRb server implementation.
     #
-    # @api public
     # :nocov:
     module DRB
 

data/lib/vedeu/bindings/menus.rb

@@ -5,7 +5,6 @@ module Vedeu
     # Each of the Bindings::Menus events require a target menu name as an
     # argument.
     #
-    # @api public
     # :nocov:
     module Menus
 

data/lib/vedeu/bindings/movement.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # System events relating to movement of cursors or interfaces.
     #
-    # @api public
     # :nocov:
     module Movement
 

data/lib/vedeu/bindings/system.rb

@@ -10,7 +10,6 @@ module Vedeu
     #   advise leaving them alone. A safe rule: if the name starts with an
     #   underscore, it's probably used by Vedeu internally.
     #
-    # @api public
     # :nocov:
     module System
 

data/lib/vedeu/bindings/visibility.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # System events relating to the visibility of cursors or interfaces.
     #
-    # @api public
     # :nocov:
     module Visibility
 

data/lib/vedeu/bootstrap.rb

@@ -18,7 +18,7 @@ module Vedeu
     # @param argv [Array<String>]
     # @param entry_point [void]
     # @return [Vedeu::Bootstrap]
-    def initialize(argv, entry_point)
+    def initialize(argv, entry_point = nil)
       @argv        = argv
       @entry_point = entry_point
     end
@@ -48,7 +48,7 @@ module Vedeu
         'app/models/keymaps/**/*',
       ].each { |path| load(File.join(Vedeu::Configuration.base_path, path)) }
 
-      entry_point
+      entry_point || eval(Vedeu::Configuration.root)
 
       Vedeu::Launcher.execute!(argv)
     end

data/lib/vedeu/buffers/buffers.rb

@@ -1,11 +1,7 @@
-require 'vedeu/null/buffer'
-require 'vedeu/buffers/buffer'
-
 module Vedeu
 
   # Allows the storing of view buffers.
   #
-  # @api public
   class Buffers < Vedeu::Repository
 
     class << self

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

@@ -1,7 +1,3 @@
-require 'vedeu/cli/generator/helpers'
-require 'vedeu/cli/generator/application'
-require 'vedeu/cli/generator/view'
-
 module Vedeu
 
   # Provides helper classes for the various rake tasks.

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

@@ -1,5 +1,3 @@
-require 'vedeu/common'
-
 module Vedeu
 
   module Generator

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

@@ -1,5 +1,6 @@
 require_relative 'config/configuration'
-require_relative 'app/controllers/some_controller'
+# Uncomment this, if you are manually setting the entry point below
+# require_relative 'app/controllers/some_controller'
 
 module <%= object.name_as_class %>
 
@@ -8,11 +9,13 @@ module <%= object.name_as_class %>
     # Change this to be the controller you would like to start the
     # application from.
     #
-    def self.entry_point
-      <%= object.name_as_class %>::SomeController.new
-    end
+    # def self.entry_point
+    #   <%= object.name_as_class %>::SomeController.new
+    # end
 
-    Vedeu::Bootstrap.start(ARGV, entry_point)
+    # Vedeu::Bootstrap.start(ARGV, entry_point)
+
+    Vedeu::Bootstrap.start(ARGV)
 
   end
 

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

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 module Vedeu
 
   module Generator
@@ -37,6 +35,10 @@ module Vedeu
         make_interface_file
         make_template_file
         make_view_class_file
+
+        output("Please update the 'root' setting in 'config/configuration.rb'" \
+               " to '#{app_name}::#{name_as_class}Controller.new' if you " \
+               'would like to start Vedeu at this controller.')
       end
 
       private

data/lib/vedeu/cli/main.rb

@@ -2,12 +2,10 @@ module Vedeu
 
   # Provide a command line interface to Vedeu.
   #
-  # @api public
   module CLI
 
     # The main command line interface commands.
     #
-    # @api public
     class Main < Thor
 
       desc 'new <name>', 'Create a skeleton Vedeu client application.'

data/lib/vedeu/colours/backgrounds.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Store background colour escape sequences by HTML/CSS code.
   #
-  # @api public
   class Backgrounds < Colours
 
     # @return [Vedeu::Backgrounds]