vedeu 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d097569d9ae161024a467480aee254bf3ea16db
-  data.tar.gz: a1f6e430f3a22d102ede5020716dc16a932126ce
+  metadata.gz: fd2666b59001c06c50ffd12741aff8bbf24eb926
+  data.tar.gz: c0198ab59c679313bc8faa58cb65438a8874e88f
 SHA512:
-  metadata.gz: ae5f70b23729b9eb744efac5ed4fcc8182ad9c4738b29b914cfb892a4d15ef83fcb5d04960955f3e8c01979990bf043aa229df1b6e89522260a1e82ccab23645
-  data.tar.gz: af4164804508dd1dc6cc58c2faf5f2e6248de9d31b62bab1d7fb6c70c0f8fbff09848071a08598280fadfcdc471d58550f45ed051fa6f859dd8da7e2da2b8bf2
+  metadata.gz: 6f561391d510a520f2846143e0def865aed71b737b42d9d1c76d310a1f12f96d619b4a8fe0b4cca4192c865b06b4eaf7911dc2321db2a0801d1b96ad8b1141fb
+  data.tar.gz: b1456ac646748bbd04cf397dc20286e9ff1408b9a098fed2cbb4722511e516ad8a212dd95c475b68ba900a374549ede282a4d3481af0b58b55b02eb1300ed38b

data/lib/vedeu.rb

@@ -1,10 +1,12 @@
 module Vedeu
 
-  EntityNotFound = Class.new(StandardError)
-  GroupNotFound  = Class.new(StandardError)
-  ModeSwitch     = Class.new(StandardError)
-  NotImplemented = Class.new(StandardError)
-  OutOfRange     = Class.new(StandardError)
+  EntityNotFound      = Class.new(StandardError)
+  GroupNotFound       = Class.new(StandardError)
+  InterfaceNotFound   = Class.new(StandardError)
+  ModeSwitch          = Class.new(StandardError)
+  NoInterfacesDefined = Class.new(StandardError)
+  NotImplemented      = Class.new(StandardError)
+  OutOfRange          = Class.new(StandardError)
 
   def self.included(receiver)
     receiver.send(:include, API)
@@ -18,6 +20,7 @@ require 'forwardable'
 require 'io/console'
 require 'logger'
 require 'optparse'
+require 'set'
 
 require 'vedeu/configuration'
 

data/lib/vedeu/api/interface.rb

@@ -3,6 +3,7 @@ module Vedeu
     class Interface < Vedeu::Interface
       include Helpers
 
+      # @see Vedeu::API#interface
       # @param attributes [Hash]
       # @param block [Proc]
       # @return []
@@ -10,6 +11,7 @@ module Vedeu
         new(attributes).define(&block)
       end
 
+      # @see Vedeu::API#interface
       # @param block [Proc]
       #
       # @example

data/lib/vedeu/models/attributes/colour_translator.rb

@@ -1,6 +1,18 @@
 module Vedeu
   class ColourTranslator
 
+    # Convert a CSS/HTML colour string into a terminal escape sequence.
+    #
+    # If provided with an empty value or a string it cannot convert, it will
+    # return an empty string.
+    #
+    # When provided with a named colour, uses the terminal's value for that
+    # colour. If a theme is being used with the terminal, which overrides the
+    # defaults, then the theme's colour will be used. The recognised names are:
+    # :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :default.
+    #
+    # TODO: add more documentation
+    #
     # @param colour [String]
     # @return [String]
     def self.escape_sequence(colour = '')
@@ -14,6 +26,7 @@ module Vedeu
     end
 
     # @return [String]
+    # @see Vedeu::ColourTranslator.escape_sequence
     def escape_sequence
       if no_colour?
         ''

data/lib/vedeu/models/colour.rb

@@ -9,16 +9,23 @@ module Vedeu
       @attributes = defaults.merge!(attributes)
     end
 
+    # Converts the `:foreground` attribute into a terminal escape sequence.
+    #
     # @return [String]
     def foreground
       @foreground ||= Foreground.escape_sequence(attributes[:foreground])
     end
 
+    # Converts the `:background` attribute into a terminal escape sequence.
+    #
     # @return [String]
     def background
       @background ||= Background.escape_sequence(attributes[:background])
     end
 
+    # Returns both or either of the converted attributes into a single escape
+    # sequence.
+    #
     # @return [String]
     def to_s
       foreground + background

data/lib/vedeu/models/composition.rb

@@ -3,6 +3,9 @@ module Vedeu
 
     attr_reader :attributes
 
+    # Builds a new composition, which is a collection of interfaces, ready to be
+    # rendered to the screen.
+    #
     # @param attributes [Hash]
     # @param block [Proc]
     # @return [Hash]
@@ -23,6 +26,9 @@ module Vedeu
       end
     end
 
+    # Returns a collection of interface attributes associated with this
+    # composition.
+    #
     # @return [Array]
     def interfaces
       @interfaces ||= if attributes[:interfaces].nil? || attributes[:interfaces].empty?
@@ -42,6 +48,9 @@ module Vedeu
       end
     end
 
+    # Returns the complete escape sequence which this composition renders to.
+    # This is used by `Terminal.output` to draw the view.
+    #
     # @return [String]
     def to_s
       interfaces.map(&:to_s).join

data/lib/vedeu/models/geometry.rb

@@ -13,6 +13,8 @@ module Vedeu
       @width   = @attributes[:width]
     end
 
+    # Returns the row/line position for the interface.
+    #
     # @return [Fixnum]
     def y
       if attributes[:y].is_a?(Proc)
@@ -24,6 +26,8 @@ module Vedeu
       end
     end
 
+    # Returns the column position for the interface.
+    #
     # @return [Fixnum]
     def x
       if attributes[:x].is_a?(Proc)
@@ -35,6 +39,16 @@ module Vedeu
       end
     end
 
+    # Returns a dynamic value calculated from the current terminal width,
+    # combined with the desired column start point.
+    #
+    # If the interface is `centred` then if the terminal resizes, this value
+    # should attempt to accommodate that.
+    #
+    # For uncentred interfaces, when the terminal resizes, then this will help
+    # Vedeu render the view to ensure no row/line overruns or that the content
+    # is not off-screen.
+    #
     # @return [Fixnum]
     def viewport_width
       if (x + width) > Terminal.width
@@ -46,6 +60,15 @@ module Vedeu
       end
     end
 
+    # Returns a dynamic value calculated from the current terminal height,
+    # combined with the desired row start point.
+    #
+    # If the interface is `centred` then if the terminal resizes, this value
+    # should attempt to accommodate that.
+    #
+    # For uncentred interfaces, when the terminal resizes, then this will help
+    # Vedeu render the view to ensure the content is not off-screen.
+    #
     # @return [Fixnum]
     def viewport_height
       if (y + height) > Terminal.height

data/lib/vedeu/support/buffer.rb

@@ -26,12 +26,14 @@ module Vedeu
       return render
     end
 
+    # @return [Buffer]
     def render
       Terminal.output(front.to_s)
 
       self
     end
 
+    # @return [Buffer]
     def clear
       Terminal.output(interface.clear)
 

data/lib/vedeu/support/buffers.rb

@@ -10,6 +10,8 @@ module Vedeu
 
       groups.add(attributes[:group], attributes[:name], attributes[:delay])
 
+      focus.add(attributes[:name])
+
       store_interface(Interface.new(attributes))
     end
 
@@ -62,6 +64,8 @@ module Vedeu
       groups.find(group_name).map { |name| refresh(name) }
     end
 
+    # @param name [String]
+    # @return []
     def refresh(name)
       update(name, retrieve_interface(name).refresh)
     end
@@ -72,6 +76,10 @@ module Vedeu
       buffers.store(name, buffer)
     end
 
+    def focus
+      @_focus ||= Focus.new
+    end
+
     def groups
       @_groups ||= Groups.new
     end

data/lib/vedeu/support/event.rb

@@ -12,7 +12,7 @@ module Vedeu
       @now          = 0
     end
 
-    # @params args [Array]
+    # @param args [Array]
     # @return []
     def trigger(*args)
       return execute(*args) unless debouncing? || throttling?

data/lib/vedeu/support/events.rb

@@ -45,6 +45,9 @@ module Vedeu
       handlers[name][:events].each { |event| event.trigger(*args) }
     end
 
+    # Remove all registered events. Used for testing purposes.
+    #
+    # @return []
     def reset
       @handlers = Hash.new { |hash, key| hash[key] = { events: [] } }
     end

data/lib/vedeu/support/focus.rb

@@ -1,6 +1,4 @@
 module Vedeu
-  NoInterfacesDefined = Class.new(StandardError)
-  InterfaceNotFound   = Class.new(StandardError)
 
   # Maintains which interface is current in focus.
   class Focus
@@ -11,6 +9,8 @@ module Vedeu
       self
     end
 
+    # @param name [String]
+    # @return []
     def add(name)
       if registered?(name)
         storage
@@ -21,6 +21,8 @@ module Vedeu
       end
     end
 
+    # @param name [String]
+    # @return []
     def by_name(name)
       fail InterfaceNotFound unless storage.include?(name)
 
@@ -29,24 +31,28 @@ module Vedeu
       current
     end
 
+    # @return []
     def current
       fail NoInterfacesDefined if storage.empty?
 
       storage.first
     end
 
+    # @return []
     def next_item
       storage.rotate!
 
       current
     end
 
+    # @return []
     def prev_item
       storage.rotate!(-1)
 
       current
     end
 
+    # @return []
     def register_events
       Vedeu.event(:_focus_next_)    { next_item }
       Vedeu.event(:_focus_prev_)    { prev_item }

data/vedeu.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.1.16'
+  spec.version       = '0.1.17'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = %q{A terminal case of wonderland.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler