vedeu 0.6.8 → 0.6.9

data/lib/vedeu/models/group.rb

@@ -1,163 +1,175 @@
 module Vedeu
 
-  # Interfaces can be associated with one another by being members of the same
-  # Group. A Group is a collection of interface names.
-  #
-  class Group
-
-    include Vedeu::Model
-    include Vedeu::Toggleable
-
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
-
-    # Return a new instance of Vedeu::Group.
-    #
-    # @note
-    #   A group being visible or not may not necessarily mean the members are of
-    #   the same state.
-    #
-    # @param attributes [Hash]
-    # @option attributes members [Set] A collection of names of interfaces
-    #   belonging to this group.
-    # @option attributes name [String] The name of the group.
-    # @option attributes repository [Vedeu::Repository] The storage for all
-    #   Group models.
-    # @option attributes visible [Boolean] Whether the group is visible or not.
-    # @return [Vedeu::Group]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Add a member to the group by name.
-    #
-    # @param member [String]
-    # @return [Vedeu::Group]
-    def add(member)
-      attrs = attributes.merge!(members: members.add(member))
-
-      Vedeu::Group.new(attrs).store
-    end
-
-    # Returns the attributes of the group.
-    #
-    # @return [Hash<Symbol => void>]
-    def attributes
-      {
-        name:       name,
-        members:    members,
-        repository: repository,
-        visible:    visible,
-      }
-    end
-
-    # Return the members of the group sorted by the zindex of the members.
-    #
-    # @return [Array<String>]
-    def by_zindex
-      interfaces.sort { |a, b| a.zindex <=> b.zindex }.map(&:name)
-    end
-
-    # Hide the named group of interfaces, or without a name, the group of the
-    # currently focussed interface. Useful for hiding part of that which is
-    # currently displaying in the terminal.
-    #
-    # @note
-    #   The action of showing a group will effectively clear the terminal and
-    #   show the new group, therefore hiding the group may not be necessary.
-    #
-    # @example
-    #   Vedeu.trigger(:_hide_group_, name)
-    #   Vedeu.hide_group(name)
-    #
-    # @return [Vedeu::Group]
-    def hide
-      super
-
-      @members.each { |member| Vedeu::Interface.hide_interface(member) }
-
-      self
-    end
-
-    # Return the members of the group.
-    #
-    # @return [Set]
-    def members
-      @_members ||= Set.new(@members)
-    end
-
-    # Remove a member from the group by name.
-    #
-    # @param member [String]
-    # @return [Vedeu::Group]
-    def remove(member)
-      attrs = attributes.merge!(members: members.delete(member))
-
-      Vedeu::Group.new(attrs).store
-    end
-
-    # Remove all members from the group.
-    #
-    # @return [Vedeu::Group]
-    def reset
-      attrs = defaults.merge!(name: name)
-
-      Vedeu::Group.new(attrs).store
-    end
-
-    # Show the named group of interfaces, or without a name, the group of the
-    # currently focussed interface.
-    #
-    # @example
-    #   Vedeu.trigger(:_show_group_, name)
-    #   Vedeu.show_group(name)
-    #
-    # @return [Vedeu::Group]
-    def show
-      super
-
-      @members.each { |member| Vedeu::Interface.show_interface(member) }
-
-      self
-    end
-
-    # Toggle the visibility of the group with the given name.
-    #
-    # @example
-    #   Vedeu.trigger(:_toggle_group, name)
-    #   Vedeu.toggle_group(name)
-    #
-    # @return [Vedeu::Group]
-    def toggle
-      super
-
-      self
-    end
-
-    private
-
-    # Returns the default options/attributes for this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        members:    Set.new,
-        name:       '',
-        repository: Vedeu.groups,
-        visible:    true,
-      }
-    end
-
-    # Return the interfaces for all members of the group.
-    #
-    # @return [Array<Vedeu::Interface]
-    def interfaces
-      members.map { |name| Vedeu.interfaces.by_name(name) }
-    end
-
-  end # Group
+  module Models
+
+    # Interfaces can be associated with one another by being members
+    # of the same Group. A Group is a collection of interface names.
+    #
+    class Group
+
+      include Vedeu::Model
+      include Vedeu::Toggleable
+
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
+
+      # Return a new instance of Vedeu::Models::Group.
+      #
+      # @note
+      #   A group being visible or not may not necessarily mean the
+      #   members are of the same state.
+      #
+      # @param attributes [Hash]
+      # @option attributes members [Set] A collection of names of
+      #   interfaces belonging to this group.
+      # @option attributes name [String] The name of the group.
+      # @option attributes repository [Vedeu::Repository] The storage
+      #   for all Group models.
+      # @option attributes visible [Boolean] Whether the group is
+      #   visible or not.
+      # @return [Vedeu::Models::Group]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # Add a member to the group by name.
+      #
+      # @param member [String]
+      # @return [Vedeu::Models::Group]
+      def add(member)
+        attrs = attributes.merge!(members: members.add(member))
+
+        Vedeu::Models::Group.new(attrs).store
+      end
+
+      # Returns the attributes of the group.
+      #
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          name:       name,
+          members:    members,
+          repository: repository,
+          visible:    visible,
+        }
+      end
+
+      # Return the members of the group sorted by the zindex of the
+      # members.
+      #
+      # @return [Array<String>]
+      def by_zindex
+        interfaces.sort { |a, b| a.zindex <=> b.zindex }.map(&:name)
+      end
+
+      # Hide the named group of interfaces, or without a name, the group of the
+      # currently focussed interface. Useful for hiding part of that which is
+      # currently displaying in the terminal.
+      #
+      # @note
+      #   The action of showing a group will effectively clear the terminal and
+      #   show the new group, therefore hiding the group may not be necessary.
+      #
+      # @example
+      #   Vedeu.trigger(:_hide_group_, name)
+      #   Vedeu.hide_group(name)
+      #
+      # @return [Vedeu::Models::Group]
+      def hide
+        super
+
+        @members.each do |member|
+          Vedeu::Models::Interface.hide_interface(member)
+        end
+
+        self
+      end
+
+      # Return the members of the group.
+      #
+      # @return [Set]
+      def members
+        @_members ||= Set.new(@members)
+      end
+
+      # Remove a member from the group by name.
+      #
+      # @param member [String]
+      # @return [Vedeu::Models::Group]
+      def remove(member)
+        attrs = attributes.merge!(members: members.delete(member))
+
+        Vedeu::Models::Group.new(attrs).store
+      end
+
+      # Remove all members from the group.
+      #
+      # @return [Vedeu::Models::Group]
+      def reset
+        attrs = defaults.merge!(name: name)
+
+        Vedeu::Models::Group.new(attrs).store
+      end
+
+      # Show the named group of interfaces, or without a name, the group of the
+      # currently focussed interface.
+      #
+      # @example
+      #   Vedeu.trigger(:_show_group_, name)
+      #   Vedeu.show_group(name)
+      #
+      # @return [Vedeu::Models::Group]
+      def show
+        super
+
+        @members.each do |member|
+          Vedeu::Models::Interface.show_interface(member)
+        end
+
+        self
+      end
+
+      # Toggle the visibility of the group with the given name.
+      #
+      # @example
+      #   Vedeu.trigger(:_toggle_group, name)
+      #   Vedeu.toggle_group(name)
+      #
+      # @return [Vedeu::Models::Group]
+      def toggle
+        super
+
+        self
+      end
+
+      private
+
+      # Returns the default options/attributes for this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          members:    Set.new,
+          name:       '',
+          repository: Vedeu.groups,
+          visible:    true,
+        }
+      end
+
+      # Return the interfaces for all members of the group.
+      #
+      # @return [Array<Vedeu::Models::Interface]
+      def interfaces
+        members.map { |name| Vedeu.interfaces.by_name(name) }
+      end
+
+    end # Group
+
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/groups.rb

@@ -1,20 +1,24 @@
 module Vedeu
 
-  # Allows the storing of view groups.
-  #
-  class Groups < Vedeu::Repository
+  module Models
 
-    singleton_class.send(:alias_method, :groups, :repository)
+    # Allows the storing of view groups.
+    #
+    class Groups < Vedeu::Repository
 
-    null Vedeu::Group
-    real Vedeu::Group
+      singleton_class.send(:alias_method, :groups, :repository)
 
-  end # Groups
+      null Vedeu::Models::Group
+      real Vedeu::Models::Group
 
-  class Group
+    end # Groups
 
-    repo Vedeu::Groups.repository
+    class Group
 
-  end # Group
+      repo Vedeu::Models::Groups.repository
+
+    end # Group
+
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/interface.rb

@@ -1,125 +1,131 @@
 module Vedeu
 
-  # An Interface represents a portion of the terminal defined by
-  # {Vedeu::Geometry::Geometry}.
-  #
-  class Interface
+  module Models
 
-    include Vedeu::Model
-    include Vedeu::Presentation
-    include Vedeu::Toggleable
-
-    # @!attribute [r] attributes
-    # @return [Hash]
-    attr_reader :attributes
-
-    # @!attribute [rw] client
-    # @return [Fixnum|Float]
-    attr_accessor :client
-
-    # @!attribute [rw] delay
-    # @return [Fixnum|Float]
-    attr_accessor :delay
-
-    # @!attribute [rw] group
-    # @return [Symbol|String]
-    attr_accessor :group
-
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
-
-    # @!attribute [rw] parent
-    # @return [Vedeu::Views::Composition]
-    attr_accessor :parent
-
-    # @!attribute [rw] zindex
-    # @return [Fixnum]
-    attr_accessor :zindex
-
-    # Return a new instance of Vedeu::Interface.
-    #
-    # @param attributes [Hash]
-    # @option attributes client [Vedeu::Client]
-    # @option attributes colour [Vedeu::Colours::Colour]
-    # @option attributes delay [Float]
-    # @option attributes group [String]
-    # @option attributes name [String]
-    # @option attributes parent [Vedeu::Views::Composition]
-    # @option attributes repository [Vedeu::Interfaces]
-    # @option attributes style [Vedeu::Style]
-    # @option attributes visible [Boolean]
-    # @option attributes zindex [Fixnum]
-    # @return [Vedeu::Interface]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Hide a named interface buffer, or without a name, the buffer of the
-    # currently focussed interface.
-    #
-    # @example
-    #   Vedeu.hide_interface(name)
+    # An Interface represents a portion of the terminal defined by
+    # {Vedeu::Geometry::Geometry}.
     #
-    # @return [void]
-    def hide
-      super
+    class Interface
+
+      include Vedeu::Model
+      include Vedeu::Presentation
+      include Vedeu::Toggleable
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # @!attribute [rw] client
+      # @return [Fixnum|Float]
+      attr_accessor :client
+
+      # @!attribute [rw] delay
+      # @return [Fixnum|Float]
+      attr_accessor :delay
+
+      # @!attribute [rw] group
+      # @return [Symbol|String]
+      attr_accessor :group
+
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
+
+      # @!attribute [rw] parent
+      # @return [Vedeu::Views::Composition]
+      attr_accessor :parent
+
+      # @!attribute [rw] zindex
+      # @return [Fixnum]
+      attr_accessor :zindex
+
+      # Return a new instance of Vedeu::Models::Interface.
+      #
+      # @param attributes [Hash]
+      # @option attributes client [Vedeu::Client]
+      # @option attributes colour [Vedeu::Colours::Colour]
+      # @option attributes delay [Float]
+      # @option attributes group [String]
+      # @option attributes name [String]
+      # @option attributes parent [Vedeu::Views::Composition]
+      # @option attributes repository [Vedeu::Models::Interfaces]
+      # @option attributes style [Vedeu::Presentation::Style]
+      # @option attributes visible [Boolean]
+      # @option attributes zindex [Fixnum]
+      # @return [Vedeu::Models::Interface]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
 
-      Vedeu.buffers.by_name(name).hide
-    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
 
-    # 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
+      # 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
 
-      Vedeu.buffers.by_name(name).show
-    end
+      # Toggle the visibility of the interface with the given name.
+      #
+      # @example
+      #   Vedeu.toggle_interface(name)
+      #
+      # @return [void]
+      def toggle
+        if visible?
+          hide
 
-    # Toggle the visibility of the interface with the given name.
-    #
-    # @example
-    #   Vedeu.toggle_interface(name)
-    #
-    # @return [void]
-    def toggle
-      if visible?
-        hide
+        else
+          show
 
-      else
-        show
+        end
+      end
 
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client:     nil,
+          colour:     Vedeu::Colours::Colour.coerce(background: :default,
+                                                    foreground: :default),
+          delay:      0.0,
+          group:      '',
+          name:       '',
+          parent:     nil,
+          repository: Vedeu.interfaces,
+          style:      :normal,
+          visible:    true,
+          zindex:     0,
+        }
       end
-    end
 
-    private
+    end # Interface
 
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        client:     nil,
-        colour:     Vedeu::Colours::Colour.coerce(background: :default,
-                                                  foreground: :default),
-        delay:      0.0,
-        group:      '',
-        name:       '',
-        parent:     nil,
-        repository: Vedeu.interfaces,
-        style:      :normal,
-        visible:    true,
-        zindex:     0,
-      }
-    end
-
-  end # Interface
+  end # Models
 
 end # Vedeu