vedeu 0.4.32 → 0.4.33

data/lib/vedeu/support/log.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the creation of a lock-less log device.
+  #
+  # @api private
   class MonoLogger < Logger
 
     # Create a trappable Logger instance.
@@ -76,6 +78,7 @@ module Vedeu
 
   # Provides the ability to log anything to the Vedeu log file.
   #
+  # @api public
   class Log
 
     class << self

data/lib/vedeu/support/options.rb

@@ -3,6 +3,8 @@ module Vedeu
   # Converts an options Hash into a class containing methods for each of the
   # keys, which when called returns the value associated. When the value is
   # either true or false, an additional predicate method is created.
+  #
+  # @api private
   class Options
 
     # @!attribute [r] _defined

data/lib/vedeu/support/template.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Generic class to loading a template and parsing it via ERb.
+  #
+  # @api private
   class Template
 
     # @param (see Vedeu::Template#new)

data/lib/vedeu/support/terminal.rb

@@ -5,6 +5,7 @@ module Vedeu
   # This module is the direct interface between Vedeu and your terminal/
   # console, via Ruby's IO core library.
   #
+  # @api public
   module Terminal
 
     extend self

data/lib/vedeu/support/timer.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Measure the duration. Used for debugging.
+  #
+  # @api public
   class Timer
 
     class << self
@@ -21,7 +23,6 @@ module Vedeu
       @started = Time.now.to_f
     end
 
-    # @param block [Proc]
     # @return [void]
     def measure
       work = yield

data/lib/vedeu/support/visibility.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Change the visibility of the given model.
+  #
+  # @api private
   class Visibility
 
     # @param name [String]

data/lib/vedeu/templating/directive.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Templating
 
     # Converts a directive found in a template into a Vedeu::Stream object.
+    #
+    # @api private
     class Directive
 
       include Vedeu::Templating::Helpers
@@ -14,6 +16,7 @@ module Vedeu
       end
 
       # @param code [String]
+      # @return [Vedeu::Templating::Directive]
       def initialize(code)
         @code = code
       end

data/lib/vedeu/templating/helpers.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Templating
 
     # Provide helpers to be used with your Vedeu templates.
+    #
+    # @api private
     module Helpers
 
       # @example

data/lib/vedeu/templating/preprocessor.rb

@@ -14,14 +14,18 @@ module Vedeu
     #
     # Pre-processes a template, to convert all lines and lines with directives
     # into Vedeu::Streams.
+    #
+    # @api private
     class Preprocessor
 
       # @param lines [Array<String>]
+      # @return [Array<Vedeu::Stream>]
       def self.process(lines)
         new(lines).process
       end
 
       # @param lines [Array<String>]
+      # @return [Vedeu::Templating::Preprocessor]
       def initialize(lines)
         @lines = lines
       end

data/lib/vedeu/traps.rb

@@ -2,6 +2,7 @@ module Vedeu
 
   # Vedeu can respond to various signals which are handled here.
   #
+  # @api private
   module Traps
 
     Signal.trap('INT') { exit! }

data/lib/vedeu/version.rb

@@ -1,5 +1,6 @@
 module Vedeu
 
-  VERSION = '0.4.32'
+  # The current version of Vedeu.
+  VERSION = '0.4.33'
 
 end

data/test/lib/vedeu/dsl/border_test.rb

@@ -201,6 +201,25 @@ module Vedeu
         it { subject.must_equal('B') }
       end
 
+      describe '#use' do
+        before do
+          Vedeu.border 'some_border' do
+            title 'Some border'
+          end
+          Vedeu.border 'other_border' do
+            title use('some_border').title
+          end
+        end
+        after { Vedeu.borders.reset }
+
+        subject { instance.use('other_border').title }
+
+        it 'allows the use of another models attributes' do
+          subject
+          Vedeu.borders.by_name('other_border').title.must_equal('Some border')
+        end
+      end
+
       describe '#vertical' do
         let(:char) { 'V' }
 

data/test/lib/vedeu/dsl/geometry_test.rb

@@ -87,6 +87,25 @@ module Vedeu
         it { subject.must_equal(6) }
       end
 
+      describe '#use' do
+        before do
+          Vedeu.geometry 'some_geometry' do
+            x 5
+          end
+          Vedeu.geometry 'other_geometry' do
+            x use('some_geometry').x
+          end
+        end
+        after { Vedeu.geometries.reset }
+
+        subject { instance.use('other_geometry').x }
+
+        it 'allows the use of another models attributes' do
+          subject
+          Vedeu.geometries.by_name('other_geometry').x.must_equal(5)
+        end
+      end
+
       describe '#width' do
         subject { instance.width(25) }
 

data/test/lib/vedeu/dsl/interface_test.rb

@@ -303,6 +303,25 @@ module Vedeu
         it { subject.visible.must_equal(false) }
       end
 
+      describe '#use' do
+        before do
+          Vedeu.interface 'some_interface' do
+            delay 0.75
+          end
+          Vedeu.interface 'other_interface' do
+            delay use('some_interface').delay
+          end
+        end
+        after { Vedeu.interfaces.reset }
+
+        subject { instance.use('other_interface').delay }
+
+        it 'allows the use of another models attributes' do
+          subject
+          Vedeu.interfaces.by_name('other_interface').delay.must_equal(0.75)
+        end
+      end
+
       describe '#visible' do
         it { instance.visible(false).must_equal(false) }
         it { instance.visible(true).must_equal(true) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.32
+  version: 0.4.33
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler