vedeu 0.4.53 → 0.4.54

data/lib/vedeu/exceptions.rb

@@ -36,7 +36,7 @@ module Vedeu
   # Raised to remind me (or client application developers) that the subclass
   # implements the functionality sought.
   #
-  # @see Vedeu::Translator
+  # @see Vedeu::ColourTranslator
   #
   # @api private
   class NotImplemented < StandardError

data/lib/vedeu/models/group.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/toggleable'
+
 module Vedeu
 
   # Interfaces can be associated with one another by being members of the same
@@ -7,6 +9,7 @@ module Vedeu
   class Group
 
     include Vedeu::Model
+    include Vedeu::Toggleable
 
     # @!attribute [rw] name
     # @return [String]
@@ -20,25 +23,41 @@ module Vedeu
     # @option attributes name [String] The name of the group.
     # @option attributes repository [Vedeu::Repository] The storage for all
     #   Group models.
-    # @return [Group]
+    # @return [Vedeu::Group]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 
       @members    = Array(@attributes[:members])
       @name       = @attributes[:name]
       @repository = @attributes[:repository]
+      @visible    = @attributes[:visible]
     end
 
     # Add a member to the group by name.
     #
     # @param member [String]
-    # @return [Group]
+    # @return [Vedeu::Group]
     def add(member)
       @members = members.add(member)
 
       Vedeu::Group.new(name: name, members: @members).store
     end
 
+    # Hide the named group of interfaces, or without a name, the group of the
+    # currently focussed interface.
+    #
+    # @example
+    #   Vedeu.hide_group(name)
+    #
+    # @return [Vedeu::Group]
+    def hide
+      super
+
+      @members.each { |member| Vedeu::Interface.hide_interface(member) }
+
+      self
+    end
+
     # Return the members as a Set.
     #
     # @return [Set]
@@ -49,7 +68,7 @@ module Vedeu
     # Remove a member from the group by name.
     #
     # @param member [String]
-    # @return [Group]
+    # @return [Vedeu::Group]
     def remove(member)
       @members = members.delete(member)
 
@@ -58,11 +77,26 @@ module Vedeu
 
     # Remove all members from the group.
     #
-    # @return [Group]
+    # @return [Vedeu::Group]
     def reset
       Vedeu::Group.new(defaults.merge!(name: name)).store
     end
 
+    # Show the named group of interfaces, or without a name, the group of the
+    # currently focussed interface.
+    #
+    # @example
+    #   Vedeu.show_group(name)
+    #
+    # @return [Vedeu::Group]
+    def show
+      super
+
+      @members.each { |member| Vedeu::Interface.show_interface(member) }
+
+      self
+    end
+
     private
 
     # Returns the default options/attributes for this class.
@@ -73,6 +107,7 @@ module Vedeu
         members:    [],
         name:       '',
         repository: Vedeu.groups,
+        visible:    true,
       }
     end
 

data/lib/vedeu/models/interface.rb

@@ -2,6 +2,7 @@ require 'vedeu/models/char'
 require 'vedeu/models/stream'
 require 'vedeu/models/line'
 require 'vedeu/buffers/display_buffer'
+require 'vedeu/support/toggleable'
 
 module Vedeu
 
@@ -15,6 +16,7 @@ module Vedeu
     include Vedeu::Model
     include Vedeu::Presentation
     include Vedeu::DisplayBuffer
+    include Vedeu::Toggleable
 
     collection Vedeu::Lines
     member     Vedeu::Line
@@ -43,11 +45,6 @@ module Vedeu
     # @return [Fixnum]
     attr_accessor :zindex
 
-    # @!attribute [rw] visible
-    # @return [Boolean] Whether the interface is visible.
-    attr_accessor :visible
-    alias_method :visible?, :visible
-
     # @!attribute [r] attributes
     # @return [Hash]
     attr_reader :attributes
@@ -83,6 +80,19 @@ module Vedeu
       @lines = lines.add(child)
     end
 
+    # Hide a named interface buffer, or without a name, the buffer of the
+    # currently focussed interface.
+    #
+    # @example
+    #   Vedeu.hide_interface(name)
+    #
+    # @return [void]
+    def hide
+      super
+
+      Vedeu.buffers.by_name(name).hide
+    end
+
     # Override Ruby's Object#inspect method to provide a more helpful output.
     #
     # @return [String]
@@ -133,6 +143,19 @@ module Vedeu
       output
     end
 
+    # Show the named interface buffer, or without a name, the buffer of the
+    # currently focussed interface.
+    #
+    # @example
+    #   Vedeu.show_interface(name)
+    #
+    # @return [void]
+    def show
+      super
+
+      Vedeu.buffers.by_name(name).show
+    end
+
     # @return [Interface]
     def store
       super
@@ -143,6 +166,19 @@ module Vedeu
       store_group
     end
 
+    # Toggle the named interface buffer, or without a name, the buffer of the
+    # currently focussed interface.
+    #
+    # @example
+    #   Vedeu.toggle_interface(name)
+    #
+    # @return [void]
+    def toggle
+      super
+
+      Vedeu.buffers.by_name(name).toggle
+    end
+
     private
 
     # The default values for a new instance of this class.

data/lib/vedeu/null/buffer.rb

@@ -45,6 +45,11 @@ module Vedeu
         nil
       end
 
+      # @return [NilClass]
+      def toggle
+        nil
+      end
+
     end # Buffer
 
   end # Null

data/lib/vedeu/null/interface.rb

@@ -30,6 +30,11 @@ module Vedeu
         }
       end
 
+      # @return [NilClass]
+      def hide
+        nil
+      end
+
       # @return [Boolean]
       def null?
         true
@@ -42,6 +47,11 @@ module Vedeu
         nil
       end
 
+      # @return [NilClass]
+      def show
+        nil
+      end
+
       # Pretend to store this model in the repository.
       #
       # @return [Vedeu::Null::Interface]
@@ -49,6 +59,11 @@ module Vedeu
         self
       end
 
+      # @return [NilClass]
+      def toggle
+        nil
+      end
+
       # The null interface should not be visible.
       #
       # @return [FalseClass]

data/lib/vedeu/output/all.rb

@@ -1,5 +1,5 @@
 require_relative 'esc'
-require_relative 'translator'
+require_relative 'colour_translator'
 require_relative 'background'
 require_relative 'foreground'
 require_relative 'presentation'

data/lib/vedeu/output/background.rb

@@ -4,7 +4,7 @@ module Vedeu
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
   #
   # @api private
-  class Background < Vedeu::Translator
+  class Background < Vedeu::ColourTranslator
 
     private
 

data/lib/vedeu/output/clear/named_interface.rb

@@ -29,8 +29,6 @@ module Vedeu
 
       # @return [void]
       def render
-        return [] unless interface.visible?
-
         output
       end
 

data/lib/vedeu/output/{translator.rb → colour_translator.rb}

@@ -21,7 +21,7 @@ module Vedeu
   # @todo More documentation required (create a fancy chart!)
   #
   # @api private
-  class Translator
+  class ColourTranslator
 
     # @!attribute [r] colour
     # @return [String]
@@ -43,10 +43,10 @@ module Vedeu
       end
     end
 
-    # Return a new instance of Vedeu::Translator.
+    # Return a new instance of Vedeu::ColourTranslator.
     #
     # @param colour [Fixnum|String|Symbol]
-    # @return [Translator]
+    # @return [Vedeu::ColourTranslator]
     def initialize(colour = '')
       @colour = colour || ''
     end
@@ -61,7 +61,7 @@ module Vedeu
     alias_method :==, :eql?
 
     # @return [String]
-    # @see Vedeu::Translator
+    # @see Vedeu::ColourTranslator
     def escape_sequence
       if no_colour?
         ''
@@ -260,6 +260,6 @@ module Vedeu
     alias_method :repository,      :not_implemented
     alias_method :rgb_prefix,      :not_implemented
 
-  end # Translator
+  end # ColourTranslator
 
 end # Vedeu

data/lib/vedeu/output/foreground.rb

@@ -4,7 +4,7 @@ module Vedeu
   # {Vedeu::Background}) of a terminal colour escape sequence.
   #
   # @api private
-  class Foreground < Vedeu::Translator
+  class Foreground < Vedeu::ColourTranslator
 
     private
 

data/lib/vedeu/output/render_border.rb

@@ -53,7 +53,6 @@ module Vedeu
 
     # @return [Array<Array<Vedeu::Char>>]
     def render
-      return [] unless interface.visible?
       return [] unless enabled?
 
       Vedeu.timer("Bordering: '#{name}'") do

data/lib/vedeu/repositories/model.rb

@@ -19,6 +19,10 @@ module Vedeu
     #
     module ClassMethods
 
+      # @!attribute [r]
+      # @return [Vedeu::Repository]
+      attr_reader :repository
+
       # Build models using a simple DSL when a block is given, otherwise returns
       # a new instance of the class including this module.
       #
@@ -34,6 +38,14 @@ module Vedeu
         model
       end
 
+      # Fetch an instance of a repository's model by name.
+      #
+      # @param name [String]
+      # @return [void]
+      def by_name(name)
+        @repository.by_name(name)
+      end
+
       # Provide a convenient way to define the child or children of a model.
       #
       # @param klass [Class] The member (singular) or collection (multiple)
@@ -45,15 +57,12 @@ module Vedeu
       alias_method :member,     :child
       alias_method :collection, :child
 
-      # @note
-      #   Not current used.
+      # Allow models to specify their repository using a class method.
       #
       # @param klass [void]
-      # @param as [void]
       # @return [void]
-      def repository(klass, as:)
-        self.repository = as
-        klass.register(as, self)
+      def repo(klass)
+        @repository = klass
       end
 
       private

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -19,4 +19,10 @@ module Vedeu
 
   end # Buffers
 
+  class Buffer
+
+    repo Vedeu::Buffers.repository
+
+  end
+
 end # Vedeu

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -41,4 +41,10 @@ module Vedeu
 
   end # Cursors
 
+  class Cursor
+
+    repo Vedeu::Cursors.repository
+
+  end
+
 end # Vedeu

data/lib/vedeu/repositories/repositories/groups.rb

@@ -32,4 +32,10 @@ module Vedeu
 
   end # Groups
 
+  class Group
+
+    repo Vedeu::Groups.repository
+
+  end
+
 end # Vedeu

data/lib/vedeu/repositories/repositories/interfaces.rb

@@ -30,4 +30,10 @@ module Vedeu
 
   end # Interfaces
 
+  class Interface
+
+    repo Vedeu::Interfaces.repository
+
+  end
+
 end # Vedeu

data/lib/vedeu/support/all.rb

@@ -1,6 +1,5 @@
 require_relative 'common'
-require_relative 'options'
 require_relative 'template'
 require_relative 'terminal'
 require_relative 'timer'
-require_relative 'visibility'
+require_relative 'toggleable'

data/lib/vedeu/support/template.rb

@@ -1,3 +1,5 @@
+require 'vedeu/templating/preprocessor'
+
 module Vedeu
 
   # Generic class to loading a template and parsing it via ERb.
@@ -43,6 +45,11 @@ module Vedeu
 
     private
 
+    # @return [String]
+    def preprocess
+      Vedeu::Templating::Preprocessor.process(load)
+    end
+
     # @return [String]
     def load
       File.read(path)