vedeu 0.4.59 → 0.4.60

data/test/lib/vedeu/output/esc_test.rb

@@ -8,93 +8,6 @@ module Vedeu
 
     before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
 
-    describe 'foreground colour methods' do
-      it { described.black.must_equal("\e[30m") }
-      it { described.red.must_equal("\e[31m") }
-      it { described.green.must_equal("\e[32m") }
-      it { described.yellow.must_equal("\e[33m") }
-      it { described.blue.must_equal("\e[34m") }
-      it { described.magenta.must_equal("\e[35m") }
-      it { described.cyan.must_equal("\e[36m") }
-      it { described.light_grey.must_equal("\e[37m") }
-      it { described.default.must_equal("\e[39m") }
-      it { described.dark_grey.must_equal("\e[90m") }
-      it { described.light_red.must_equal("\e[91m") }
-      it { described.light_green.must_equal("\e[92m") }
-      it { described.light_yellow.must_equal("\e[93m") }
-      it { described.light_blue.must_equal("\e[94m") }
-      it { described.light_magenta.must_equal("\e[95m") }
-      it { described.light_cyan.must_equal("\e[96m") }
-      it { described.white.must_equal("\e[97m") }
-
-      it 'returns an escape sequence for the foreground colour and resets ' \
-         'after calling the block' do
-        described.cyan do
-          'ununpentium'
-        end.must_equal("\e[36mununpentium\e[39m")
-      end
-    end
-
-    describe '.codes' do
-      it { described.codes.must_be_instance_of(Hash) }
-      it { described.must_respond_to(:foreground_codes) }
-    end
-
-    describe '.background_codes' do
-      it { described.background_codes.must_be_instance_of(Hash) }
-    end
-
-    describe 'background colour methods' do
-      it { described.on_black.must_equal("\e[40m") }
-      it { described.on_red.must_equal("\e[41m") }
-      it { described.on_green.must_equal("\e[42m") }
-      it { described.on_yellow.must_equal("\e[43m") }
-      it { described.on_blue.must_equal("\e[44m") }
-      it { described.on_magenta.must_equal("\e[45m") }
-      it { described.on_cyan.must_equal("\e[46m") }
-      it { described.on_light_grey.must_equal("\e[47m") }
-      it { described.on_default.must_equal("\e[49m") }
-      it { described.on_dark_grey.must_equal("\e[100m") }
-      it { described.on_light_red.must_equal("\e[101m") }
-      it { described.on_light_green.must_equal("\e[102m") }
-      it { described.on_light_yellow.must_equal("\e[103m") }
-      it { described.on_light_blue.must_equal("\e[104m") }
-      it { described.on_light_magenta.must_equal("\e[105m") }
-      it { described.on_light_cyan.must_equal("\e[106m") }
-      it { described.on_white.must_equal("\e[107m") }
-
-      it 'returns an escape sequence for the background colour and resets ' \
-         'after calling the block' do
-        described.on_red do
-          'livermorium'
-        end.must_equal("\e[41mlivermorium\e[49m")
-      end
-    end
-
-    describe 'action methods' do
-      it { described.hide_cursor.must_equal("\e[?25l") }
-      it { described.show_cursor.must_equal("\e[?25h") }
-      it { described.cursor_position.must_equal("\e[6n") }
-      it { described.bg_reset.must_equal("\e[49m") }
-      it { described.blink.must_equal("\e[5m") }
-      it { described.blink_off.must_equal("\e[25m") }
-      it { described.bold.must_equal("\e[1m") }
-      it { described.bold_off.must_equal("\e[22m") }
-      it { described.border_on.must_equal("\e(0") }
-      it { described.border_off.must_equal("\e(B") }
-      it { described.dim.must_equal("\e[2m") }
-      it { described.fg_reset.must_equal("\e[39m") }
-      it { described.negative.must_equal("\e[7m") }
-      it { described.positive.must_equal("\e[27m") }
-      it { described.reset.must_equal("\e[0m") }
-      it { described.underline.must_equal("\e[4m") }
-      it { described.underline_off.must_equal("\e[24m") }
-    end
-
-    describe '.actions' do
-      it { described.actions.must_be_instance_of(Hash) }
-    end
-
     describe '.escape' do
       let(:stream) { "\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l" }
 

data/test/lib/vedeu/plugins/plugin_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module Vedeu
+
+	describe Plugin do
+
+    let(:described) { Vedeu::Plugin }
+    let(:instance)  { described.new(_name, _gem) }
+    let(:_name)     {}
+    let(:_gem)      {}
+
+    describe '#initialize' do
+      it { instance.must_be_instance_of(described) }
+      it { instance.instance_variable_get('@name').must_equal(_name) }
+      it { instance.instance_variable_get('@gem').must_equal(_gem) }
+      it {
+        instance.instance_variable_get('@gem_name').
+          must_equal("vedeu-#{_name}")
+      }
+      it { instance.instance_variable_get('@enabled').must_equal(false) }
+    end
+
+    describe '#load!' do
+      subject { instance.load! }
+
+      # @todo
+      # it { skip }
+    end
+
+	end # Plugin
+
+end # Vedeu

data/test/lib/vedeu/plugins_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module Vedeu
+
+	describe Plugins do
+
+    let(:described) { Vedeu::Plugins }
+    let(:instance)  { described.new }
+
+    describe '#initialize' do
+      it { instance.must_be_instance_of(described) }
+    end
+
+    describe '#load' do
+      subject { instance.load }
+
+      # @todo
+      # it { skip }
+    end
+
+    describe '#register' do
+      let(:_name) {}
+      let(:plugin) { false }
+
+      subject { instance.register(_name, plugin) }
+
+      # @todo
+      # it { skip }
+    end
+
+    describe '#find' do
+      subject { instance.find }
+
+      # @todo
+      # it { skip }
+    end
+
+    describe '#names' do
+      subject { instance.names }
+
+      # @todo
+      # it { skip }
+    end
+
+	end # Plugins
+
+end # Vedeu

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.59
+  version: 0.4.60
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -235,12 +235,10 @@ files:
 - config/rubocop_disabled.yml
 - config/rubocop_enabled.yml
 - docs/api.md
-- docs/applications.md
 - docs/dsl.md
 - docs/events.md
 - docs/getting_started.md
 - docs/object_graph.md
-- docs/views.md
 - examples/borders_app.rb
 - examples/colour_support.sh
 - examples/colours_app.rb
@@ -310,6 +308,7 @@ files:
 - lib/vedeu/colours/colour.rb
 - lib/vedeu/colours/colour_translator.rb
 - lib/vedeu/colours/colours.rb
+- lib/vedeu/colours/escape_sequences.rb
 - lib/vedeu/colours/foreground.rb
 - lib/vedeu/colours/foregrounds.rb
 - lib/vedeu/common.rb
@@ -398,6 +397,7 @@ files:
 - lib/vedeu/null/generic.rb
 - lib/vedeu/null/geometry.rb
 - lib/vedeu/null/interface.rb
+- lib/vedeu/null/menu.rb
 - lib/vedeu/output/border.rb
 - lib/vedeu/output/borders.rb
 - lib/vedeu/output/clear/named_group.rb
@@ -426,6 +426,8 @@ files:
 - lib/vedeu/output/virtual_buffer.rb
 - lib/vedeu/output/virtual_terminal.rb
 - lib/vedeu/output/wordwrap.rb
+- lib/vedeu/plugins.rb
+- lib/vedeu/plugins/plugin.rb
 - lib/vedeu/repositories.rb
 - lib/vedeu/repositories/collection.rb
 - lib/vedeu/repositories/model.rb
@@ -467,6 +469,7 @@ files:
 - test/lib/vedeu/colours/colour_test.rb
 - test/lib/vedeu/colours/colour_translator_test.rb
 - test/lib/vedeu/colours/colours_test.rb
+- test/lib/vedeu/colours/escape_sequences_test.rb
 - test/lib/vedeu/colours/foreground_test.rb
 - test/lib/vedeu/colours/foregrounds_test.rb
 - test/lib/vedeu/common_test.rb
@@ -543,6 +546,7 @@ files:
 - test/lib/vedeu/null/generic_test.rb
 - test/lib/vedeu/null/geometry_test.rb
 - test/lib/vedeu/null/interface_test.rb
+- test/lib/vedeu/null/menu_test.rb
 - test/lib/vedeu/output/border_test.rb
 - test/lib/vedeu/output/borders_test.rb
 - test/lib/vedeu/output/clear/named_group_test.rb
@@ -570,6 +574,8 @@ files:
 - test/lib/vedeu/output/virtual_buffer_test.rb
 - test/lib/vedeu/output/virtual_terminal_test.rb
 - test/lib/vedeu/output/wordwrap_test.rb
+- test/lib/vedeu/plugins/plugin_test.rb
+- test/lib/vedeu/plugins_test.rb
 - test/lib/vedeu/repositories/all_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
 - test/lib/vedeu/repositories/model_test.rb
@@ -643,6 +649,7 @@ test_files:
 - test/lib/vedeu/colours/colour_test.rb
 - test/lib/vedeu/colours/colour_translator_test.rb
 - test/lib/vedeu/colours/colours_test.rb
+- test/lib/vedeu/colours/escape_sequences_test.rb
 - test/lib/vedeu/colours/foreground_test.rb
 - test/lib/vedeu/colours/foregrounds_test.rb
 - test/lib/vedeu/common_test.rb
@@ -719,6 +726,7 @@ test_files:
 - test/lib/vedeu/null/generic_test.rb
 - test/lib/vedeu/null/geometry_test.rb
 - test/lib/vedeu/null/interface_test.rb
+- test/lib/vedeu/null/menu_test.rb
 - test/lib/vedeu/output/border_test.rb
 - test/lib/vedeu/output/borders_test.rb
 - test/lib/vedeu/output/clear/named_group_test.rb
@@ -746,6 +754,8 @@ test_files:
 - test/lib/vedeu/output/virtual_buffer_test.rb
 - test/lib/vedeu/output/virtual_terminal_test.rb
 - test/lib/vedeu/output/wordwrap_test.rb
+- test/lib/vedeu/plugins/plugin_test.rb
+- test/lib/vedeu/plugins_test.rb
 - test/lib/vedeu/repositories/all_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
 - test/lib/vedeu/repositories/model_test.rb

data/docs/applications.md

@@ -1,167 +0,0 @@
-# @title Vedeu Applications
-
-Vedeu has basic tools to generate client application scaffolding, in a similar
-way to Ruby on Rails. Although not nearly as advanced as the Rails equivalent,
-hopefully these generators will get you off the ground.
-
-### Installing Vedeu
-
-To install Vedeu, simply:
-
-    gem install 'vedeu'
-
-To use Vedeu's application scaffolding, see below:
-
-### Generating a new application
-
-```bash
-|
-|- app_name/
-|   |
-    |- app/
-    |   |- controllers/
-    |   |   |- application_controller.rb
-    |   |
-    |   |- helpers/
-    |   |   |- application_helper.rb
-    |   |
-    |   |- models/
-    |   |   |- keymaps/
-    |   |       |- _global_.rb
-    |   |
-    |   |- views/
-    |       |- interfaces/
-    |       |- templates/
-    |
-    |- bin/
-    |   |- app_name
-    |
-    |- config/
-    |   |- add_name
-    |   |- configuration.rb
-    |
-    |- lib/
-    |- test/
-    |- vendor/
-    |- application.rb
-    |- Gemfile
-```
-
-To create the application structure as shown above:
-
-```bash
-vedeu new app_name
-```
-
-Let's talk about each directory and its purpose.
-
-#### app/controllers
-
-The controllers directory is the place to store the events and behaviour logic
-of your application. It will manage the choosing of views and models based on
-previous choices. Think of them as the orchestrators of your application.
-
-In web applications, the controller typically handles the routed request and
-interacts with the models and sets up the views. In Vedeu, it does much the
-same, minus the requests.
-
-#### app/helpers
-
-Ruby on Rails has a concept of helpers which are not very object-oriented, but
-allow you to share functionality/behaviour across multiple views. Vedeu uses
-this concept as it will be familiar to many Rails developers and might be
-helpful to beginners.
-
-#### app/models
-
-Much like `lib`, this directory is for your application logic code. Some people
-prefer to use `app/models`, others like to use `lib`. Some even use both!
-
-#### app/models/keymaps
-
-This will contain the global keymap (which affects all of your application)
-plus any specific interface keymaps which only affect a certain interface when
-in focus.
-
-#### app/views
-
-This will contain classes which produce the views needed by Vedeu to make your
-application come alive!
-
-#### app/views/interfaces
-
-This will contain the information Vedeu needs to draw the various interfaces
-and views of your application.
-
-#### app/views/templates
-
-This will house the templates your application will use to display views. You
-can populate templates with generic view information and supplement it with
-variable data from your application.
-
-#### bin
-
-This will contain executable Ruby scripts (or Bash, or shell language of your
-choice) which will launch your application or provide command-line behaviours.
-
-#### config
-
-This will contain any configuration your application needs to run, plus the
-configuration for Vedeu. This configuration affects the way Vedeu works with
-your application.
-
-#### lib
-
-This is for code your application may use to support code you have in
-`app/models`.
-
-#### test
-
-This is for the tests you might write to help ensure your application executes
-in the way you expect.
-
-#### vendor
-
-This is for third-party code which your application might want to ship with.
-Usually you will include various Ruby gems to provide functionality, but you
-might want to do something special.
-
-
-### Generating a new view
-
-Vedeu also provides a generator to create the files needed for a view. To run
-this, use the following from within the root of the application directory:
-
-```bash
-vedeu view view_name
-```
-
-Let's talk about the files it will create and populate:
-
-```bash
-|
-|- app_name/
-|   |
-    |- app/
-    |   |- controllers/
-    |   |   |- view_name_controller.rb
-    |   |
-    |   |- helpers/
-    |   |   |- view_name_helper.rb
-    |   |
-    |   |- models/
-    |   |   |- keymaps/
-    |   |       |- view_name.rb
-    |   |
-    |   |- views/
-    |       |- interfaces/
-    |       |   |- view_name.rb
-    |       |
-    |       |- templates/
-    |       |   |- view_name.erb
-    |       |
-    |       |- view_name.rb
-    |...
-```
-
-####

data/docs/views.md

@@ -1,158 +0,0 @@
-# @title Views with Vedeu
-
-There are two ways to construct views with Vedeu. You would like to draw the
- view to the screen immediately (immediate render) or you want to save a view to
- be drawn when you trigger a refresh event later (deferred view).
-
-** LINK Both of these approaches require that you have defined an interface (or
- 'visible area') first. You can find out how to define an interface with Vedeu
- here. The examples in 'Immediate Render' and 'Deferred View' use these
- interface definitions: (Note: if you use these examples, ensure your terminal
- is at least 70 characters in width and 5 lines in height.)
-
-```ruby
-  Vedeu.interface 'main' do
-    geometry do
-      centred!
-      height 4
-      width  50
-    end
-  end
-
-  Vedeu.interface 'title' do
-    geometry do
-      height 1
-      width  50
-      x      use('main').left
-      y      use('main').north
-    end
-  end
-```
-
-Both of these approaches use a concept of Buffers in Vedeu. There are three
- buffers for any defined interface. These are imaginatively called: 'back',
- 'front' and 'previous'.
-
-The 'back' buffer is the content for an interface which will be shown next time
- a refresh event is fired globally or for that interface. So, 'back' becomes
- 'front'.
-
-The 'front' buffer is the content for an interface which is currently showing.
-When a refresh event is fired, again, globally or for that interface
- specifically, the content of this 'front' buffer is first copied to the
- 'previous' buffer, and then the current 'back' buffer overwrites this 'front'
- buffer.
-
-The 'previous' buffer contains what was shown on the 'front' before the current
- 'front'.
-
-You can only write to either the 'front' (you want the content to be drawn
- immediately (immediate render)) or the 'back' (you would like the content to be
- drawn on the next refresh (deferred view)).
-
-### Immediate Render
-
-The immediate render DSL for Vedeu is accessed via `Vedeu.renders`. When this
- approach is used, the content defined is written directly to the 'front'
- buffer(s) for the interface(s) concerned. Take a glance at the example below:
-
-```ruby
-  Vedeu.renders do
-    view 'title' do
-      line do
-        stream do
-          left 'Title goes here', width: 35
-        end
-        stream do
-          right Time.now.strftime('%H:%m'), width: 7
-        end
-      end
-    end
-    view 'main' do
-      lines do
-        line 'This is content for the main interface.'
-        line ''
-        line 'Pretty easy eh?'
-      end
-    end
-  end
-```
-
-### Deferred View
-
-The deferred view DSL for Vedeu is accessed via `Vedeu.views`. This approach
- writes the content defined to the 'back' buffer(s) for the interface(s)
- concerned. It will become the front when your application triggers the refresh
- event for the interface(s).
-
-As you can see by comparing the examples above to these below, the immediate
- render simply wraps what is already here in the deferred view. Again, more
- specific information is available in the Rubydoc.
-
-```ruby
-  Vedeu.views do
-    view 'title' do
-      line do
-        stream do
-          left 'Title goes here', width: 35
-        end
-        stream do
-          right Time.now.strftime('%H:%m'), width: 7
-        end
-      end
-    end
-    view 'main' do
-      lines do
-        line 'This is content for the main interface.'
-        line ''
-        line 'Pretty easy eh?'
-      end
-    end
-  end
-```
-
-### Notes on Geometry
-
-... TODO
-
-### Notes on Refresh
-
-... TODO
-
-### Notes on Building Views
-
-The basic view DSL methods look like this:
-
-renders/views
-  |-- view
-        |-- lines
-        |     |-- line
-        |           |-- streams
-        |           |     |-- stream
-        |           |           |-- char
-        |           |
-        |           |-- stream
-        |                 |-- char
-        |
-        |-- line
-              |-- streams
-              |     |-- stream
-              |           |-- char
-              |
-              |-- stream
-                    |-- char
-
-renders/views
-  |-- view
-        |-- lines/line
-              |-- streams/stream
-                    |-- char
-
-#### Authors Notes
-
-The Rubydoc documentation has more specific information about the DSL methods
- demonstrated above: [RubyDoc](http://rubydoc.info/gems/vedeu).
-
-I've tried to write the DSL in a way which makes it read nice; believing that
- this will make it easier to use. I hope this is the case for you.
-