vedeu 0.4.13 → 0.4.14

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

@@ -0,0 +1,36 @@
+module Vedeu
+
+  # Allows the storing of view buffers.
+  #
+  class Buffers < Repository
+
+    # @return [Vedeu::Buffers]
+    def self.buffers
+      @buffers ||= reset!
+    end
+
+    # @return [Vedeu::Buffers]
+    def self.repository
+      Vedeu.buffers
+    end
+
+    # @return [Vedeu::Buffers]
+    def self.reset!
+      @buffers = Vedeu::Buffers.register_repository(Vedeu::Buffer)
+    end
+
+    # @param name [String] The name of buffer to clear.
+    # @return [void]
+    def clear(name)
+      find!(name).clear
+    end
+
+    # @param name [String] The name of buffer to render.
+    # @return [void]
+    def render(name)
+      find!(name).render
+    end
+
+  end # Buffers
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/colours.rb

@@ -0,0 +1,63 @@
+module Vedeu
+
+  # Allows the storing of HTML/CSS colours and their respective escape
+  # sequences.
+  #
+  class Colours
+
+    # @!attribute [r] storage
+    # @return [Hash<String => String>]
+    attr_reader :storage
+
+    # Returns a new instance of Vedeu::Colours.
+    #
+    # @return [Vedeu::Colours]
+    def initialize
+      @storage = {}
+    end
+
+    # Registers a colour with respective escape sequence.
+    #
+    # @return [String]
+    def register(colour, escape_sequence)
+      storage.store(colour, escape_sequence)
+    end
+
+    # Returns a boolean indicating whether the colour has been registered.
+    #
+    # @return [Boolean]
+    def registered?(colour)
+      storage.key?(colour)
+    end
+
+    # Removes all stored colours.
+    #
+    # @return [Hash]
+    def reset!
+      storage.clear
+    end
+
+    # Retrieves a registered colour.
+    #
+    # @return [String]
+    def retrieve(colour)
+      storage.fetch(colour, '')
+    end
+
+    # Retrieves a registered colour, or registers the colour with its respective
+    # escape sequence.
+    #
+    # @return [String]
+    def retrieve_or_register(colour, escape_sequence)
+      if registered?(colour)
+        retrieve(colour)
+
+      else
+        register(colour, escape_sequence)
+
+      end
+    end
+
+  end # Colours
+
+end # Vedeu

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

@@ -0,0 +1,29 @@
+module Vedeu
+
+  # Allows the storing of each interface's cursor.
+  #
+  class Cursors < Repository
+
+    # @return [Vedeu::Cursors]
+    def self.cursors
+      @cursors ||= reset!
+    end
+
+    # @return [Vedeu::Cursor]
+    def self.cursor
+      cursors.current
+    end
+
+    # @return [Vedeu::Cursors]
+    def self.repository
+      Vedeu.cursors
+    end
+
+    # @return [Vedeu::Cursors]
+    def self.reset!
+      @cursors = Vedeu::Cursors.register_repository(Vedeu::Cursor)
+    end
+
+  end # Cursors
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  # Allows the storing of events.
+  #
+  class EventsRepository < Repository
+
+    # @return [Vedeu::EventsRepository]
+    def self.events
+      @events ||= reset!
+    end
+
+    # @return [Vedeu::EventsRepository]
+    def self.repository
+      Vedeu.events
+    end
+
+    # @return [Vedeu::EventsRepository]
+    def self.reset!
+      @events = Vedeu::EventsRepository.new(Vedeu::Events)
+    end
+
+  end # EventsRepository
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/foreground_colours.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # Store foreground colour escape sequences by HTML/CSS code.
+  #
+  class ForegroundColours < Colours
+
+    # @return [Vedeu::ForegroundColours]
+    def self.foreground_colours
+      @foreground_colours ||= new
+    end
+
+  end # ForegroundColours
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -0,0 +1,37 @@
+module Vedeu
+
+  # Allows the storing of interface/view geometry independent of the interface
+  # instance.
+  #
+  class Geometries < Repository
+
+    # @return [Vedeu::Geometries]
+    def self.geometries
+      @geometries ||= reset!
+    end
+
+    # @return [Vedeu::Geometries]
+    def self.repository
+      Vedeu.geometries
+    end
+
+    # @return [Vedeu::Geometries]
+    def self.reset!
+      @geometries = Vedeu::Geometries.new(Vedeu::Geometry)
+    end
+
+    # @param name [String] The name of the stored geometry.
+    # @return [Vedeu::Geometry|Vedeu::NullGeometry]
+    def by_name(name)
+      if registered?(name)
+        find(name)
+
+      else
+        Vedeu::NullGeometry.new
+
+      end
+    end
+
+  end # Geometries
+
+end # Vedeu

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

@@ -0,0 +1,24 @@
+module Vedeu
+
+  # Allows the storing of view groups.
+  #
+  class Groups < Repository
+
+    # @return [Vedeu::Groups]
+    def self.groups
+      @groups ||= reset!
+    end
+
+    # @return [Vedeu::Groups]
+    def self.repository
+      Vedeu.groups
+    end
+
+    # @return [Vedeu::Groups]
+    def self.reset!
+      @groups = Vedeu::Groups.new(Vedeu::Group)
+    end
+
+  end # Groups
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/interfaces_repository.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  # Allows the storing of interfaces and views.
+  #
+  class InterfacesRepository < Repository
+
+    # @return [Vedeu::InterfacesRepository]
+    def self.interfaces
+      @interfaces ||= reset!
+    end
+
+    # @return [Vedeu::InterfacesRepository]
+    def self.repository
+      Vedeu.interfaces
+    end
+
+    # @return [Vedeu::InterfacesRepository]
+    def self.reset!
+      @interfaces = Vedeu::InterfacesRepository.new(Vedeu::Interface)
+    end
+
+  end # InterfacesRepository
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  # Allows the storing of keymaps.
+  #
+  class Keymaps < Repository
+
+    # @return [Vedeu::Keymaps]
+    def self.keymaps
+      @keymaps ||= reset!
+    end
+
+    # @return [Vedeu::Keymaps]
+    def self.repository
+      Vedeu.keymaps
+    end
+
+    # @return [Vedeu::Keymaps]
+    def self.reset!
+      @keymaps = Vedeu::Keymaps.new(Vedeu::Keymap)
+    end
+
+  end # Keymaps
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/menus.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  # Allows the storing of menus by name.
+  #
+  class Menus < Repository
+
+    # @return [Vedeu::Menus]
+    def self.menus
+      @menus ||= reset!
+    end
+
+    # @return [Vedeu::Menus]
+    def self.repository
+      Vedeu.menus
+    end
+
+    # @return [Vedeu::Menus]
+    def self.reset!
+      @menus = Vedeu::Menus.new(Vedeu::Menu)
+    end
+
+  end # Menus
+
+end # Vedeu

data/lib/vedeu/repositories/repository.rb

@@ -1,5 +1,5 @@
-require 'vedeu/exceptions'
 require 'vedeu/models/all'
+require 'vedeu/storage/store'
 require 'vedeu/support/common'
 
 module Vedeu
@@ -14,7 +14,7 @@ module Vedeu
   class Repository
 
     include Vedeu::Common
-    include Enumerable
+    include Vedeu::Store
 
     # @!attribute [r] model
     # @return [void]
@@ -24,21 +24,24 @@ module Vedeu
     # @return [void]
     attr_reader :storage
 
+    def self.register_repository(model = nil, storage = {})
+      new(model, storage).tap do |klass|
+        Vedeu::Repositories.register(klass.repository)
+      end
+    end
+
     # Returns a new instance of Vedeu::Repository.
     #
     # @param model [Class]
     # @param storage [Class|Hash]
     # @return [Vedeu::Repository]
     def initialize(model = nil, storage = {})
-      @model   = model
-      @storage = storage
+      @model      = model
+      @storage    = storage
     end
 
-    # Return the whole repository.
-    #
-    # @return [Array|Hash|Set]
-    def all
-      storage
+    def repository
+      self.class # .name
     end
 
     # Return the model for the interface currently in focus.
@@ -48,27 +51,22 @@ module Vedeu
       find_or_create(Vedeu.focus) if Vedeu.focus
     end
 
-    # @return [Enumerator]
-    def each(&block)
-      storage.each(&block)
-    end
-
-    # Return a boolean indicating whether the storage is empty.
+    # Find the model by name.
     #
-    # @return [Boolean]
-    def empty?
-      storage.empty?
+    # @param name [String]
+    # @return [Hash<String => Object>|NilClass]
+    def find(name)
+      storage[name]
     end
 
-    # Find the model attributes by name.
+    # Find the model attributes by name, raises an exception if the model cannot
+    # be found.
     #
     # @param name [String]
     # @raise [ModelNotFound] When the model cannot be found with this name.
     # @return [Hash<String => Object>]
-    def find(name)
-      storage.fetch(name) do
-        fail ModelNotFound, "Cannot find model by name: '#{name}'"
-      end
+    def find!(name)
+      find(name) || fail(ModelNotFound, "Cannot find model by name: '#{name}'")
     end
 
     # Find a model by name, registers the model by name if not found.
@@ -80,7 +78,8 @@ module Vedeu
         find(name)
 
       else
-        Vedeu.log(type: :store, message: "Model (#{model}) not found, registering: '#{name}'")
+        Vedeu.log(type: :store,
+                  message: "Model (#{model}) not found, registering: '#{name}'")
 
         model.new(name).store
       end
@@ -131,13 +130,6 @@ module Vedeu
     alias_method :delete,     :remove
     alias_method :deregister, :remove
 
-    # Reset the repository.
-    #
-    # @return [Array|Hash|Set]
-    def reset
-      @storage = in_memory
-    end
-
     # Stores the model instance by name in the repository of the model.
     #
     # @param model [void] A model instance.
@@ -145,9 +137,9 @@ module Vedeu
     # @return [void] The model instance which was stored.
     def store(model)
       fail MissingRequired, "Cannot store model '#{model.class}' without a " \
-                            "name attribute." unless defined_value?(model.name)
+                            'name attribute.' unless defined_value?(model.name)
 
-      Vedeu.log(type: log_type(model), message: "#{model.class.name}: '#{model.name}'")
+      log_store(model)
 
       storage[model.name] = model
     end
@@ -158,13 +150,7 @@ module Vedeu
     # @param name [String]
     # @return [|NilClass]
     def use(name)
-      if registered?(name)
-        find(name)
-
-      else
-        nil
-
-      end
+      find(name) if registered?(name)
     end
 
     private
@@ -175,14 +161,10 @@ module Vedeu
     end
 
     # @return [String]
-    def log_type(model)
-      if registered?(model.name)
-        :update
+    def log_store(model)
+      type = registered?(model.name) ? :update : :create
 
-      else
-        :create
-
-      end
+      Vedeu.log(type: type, message: "#{model.class.name}: '#{model.name}'")
     end
 
   end # Repository

data/lib/vedeu/storage/all.rb

@@ -0,0 +1,6 @@
+require 'vedeu/storage/store'
+
+require 'vedeu/storage/associative_store'
+require 'vedeu/storage/conveyor_store'
+require 'vedeu/storage/fifo_store'
+

data/lib/vedeu/storage/associative_store.rb

@@ -0,0 +1,47 @@
+module Vedeu
+
+  # Name/Value storage.
+  #
+  #   name: [value]
+  #
+  class AssociativeStore
+
+    include Vedeu::Store
+
+    # @param storage [Hash]
+    # @return [Vedeu::AssociativeStore]
+    def initialize(storage = {})
+      @storage = storage
+    end
+
+    # @param name [String]
+    def load(name)
+      return nil if empty?
+
+      storage[name]
+    end
+
+    # @param data [Object]
+    # @param name [String|Symbol]
+    def save(data, name = nil)
+      if name
+        storage[name] = data
+
+      elsif data.respond_to?(:name)
+        storage[data.name] = data
+
+      end
+
+      storage
+    end
+
+    private
+
+    # @return [Hash]
+    def in_memory
+      {}
+    end
+
+  end # AssociativeStore
+
+end # Vedeu

data/lib/vedeu/storage/conveyor_store.rb

@@ -0,0 +1,69 @@
+module Vedeu
+
+  # Conveyor belt like storage. The belt can move forward (`load_next`) or
+  # backwards (`load_previous`), or a named entry can be retrieved.
+  #
+  class ConveyorStore
+
+    include Vedeu::Store
+
+    # @param storage [Array]
+    # @return [Vedeu::ConveyorStore]
+    def initialize(storage = [])
+      @storage = storage
+    end
+
+    # @return [Object]
+    def load
+      storage.first
+    end
+    alias_method :current, :load
+
+    # @param name [String]
+    # @return [Object]
+    def load_named(name)
+      return nil if empty?
+
+      return nil unless storage.include?(name)
+
+      storage.rotate!(storage.index(name))
+
+      load
+    end
+
+    # @return [Object]
+    def load_next
+      storage.rotate!
+
+      load
+    end
+
+    # @return [Object]
+    def load_previous
+      storage.rotate!(-1)
+
+      load
+    end
+
+    # @param data [Object]
+    # @param front [Boolean]
+    def save(data, front = false)
+      if front
+        storage.push(data)
+
+      else
+        storage.unshift(data)
+
+      end
+    end
+
+    private
+
+    # @return [Array]
+    def in_memory
+      []
+    end
+
+  end # ConveyorStore
+
+end # Vedeu

data/lib/vedeu/storage/fifo_store.rb

@@ -0,0 +1,37 @@
+module Vedeu
+
+  # First-in first-out storage.
+  #
+  #   in -> [3] -> [2] -> [1] -> out
+  #
+  class FifoStore
+
+    include Vedeu::Store
+
+    # @param storage [Array]
+    # @return [Vedeu::FifoStore]
+    def initialize(storage = [])
+      @storage = storage
+    end
+
+    # @return [Object]
+    def load
+      storage.pop
+    end
+
+    # @param data [Object]
+    # @return [Array<Object>]
+    def save(data)
+      storage.unshift(data)
+    end
+
+    private
+
+    # @return [Array]
+    def in_memory
+      []
+    end
+
+  end # FifoStore
+
+end # Vedeu

data/lib/vedeu/storage/store.rb

@@ -0,0 +1,58 @@
+module Vedeu
+
+  # Provides generic repository related behaviour.
+  #
+  module Store
+
+    include Enumerable
+
+    # @param block [Proc]
+    # @return [Enumerator]
+    def each(&block)
+      storage.each(&block)
+    end
+
+    # Returns a boolean indicating whether the named model is registered.
+    #
+    # @param name [String]
+    # @return [Boolean]
+    def exists?(name)
+      return false if empty? || name.nil? || name.empty?
+
+      storage.include?(name)
+    end
+    alias_method :registered?, :exists?
+
+    # Return a boolean indicating whether the storage is empty.
+    #
+    # @return [Boolean]
+    def empty?
+      storage.empty?
+    end
+
+    # Remove all currently stored data.
+    #
+    # @return [Array|Hash|Set]
+    def reset
+      @storage = in_memory
+    end
+
+    # Return the number of entries stored.
+    #
+    # @return [Fixnum]
+    def size
+      storage.size
+    end
+
+    # Return whole repository; provides raw access to the storage for this
+    # repository.
+    #
+    # @return [Array|Hash|Set]
+    def storage
+      @storage ||= in_memory
+    end
+    alias_method :all, :storage
+
+  end # Store
+
+end # Vedeu

data/lib/vedeu/support/all.rb

@@ -1,10 +1,5 @@
-require 'vedeu/support/coercions'
-require 'vedeu/support/common'
-require 'vedeu/support/sentence'
-require 'vedeu/support/template'
-require 'vedeu/support/terminal'
-require 'vedeu/support/trace'
-require 'vedeu/support/visible'
-
-module Vedeu
-end # Vedeu
+require_relative 'common'
+require_relative 'template'
+require_relative 'terminal'
+require_relative 'trace'
+require_relative 'visibility'