vedeu 0.6.10 → 0.6.11

data/lib/vedeu/repositories/collection.rb

@@ -1,107 +1,111 @@
 module Vedeu
 
-  # Convert an Array into an object which has some meaning in the
-  # context it is being used.
-  #
-  class Collection
+  module Repositories
 
-    include Enumerable
+    # Convert an Array into an object which has some meaning in the
+    # context it is being used.
+    #
+    class Collection
+
+      include Enumerable
 
-    # @!attribute [r] collection
-    # @return [Array|Vedeu::Collection]
-    attr_reader :collection
-    alias_method :all, :collection
+      # @!attribute [r] collection
+      # @return [Array|Vedeu::Repositories::Collection]
+      attr_reader :collection
+      alias_method :all, :collection
 
-    # @!attribute [rw] parent
-    # @return [Fixnum]
-    attr_accessor :parent
+      # @!attribute [rw] parent
+      # @return [Fixnum]
+      attr_accessor :parent
 
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
 
-    # @param collection [Array|Vedeu::Collection]
-    # @param parent [void]
-    # @param name [String|NilClass]
-    # @return [Vedeu::Collection]
-    def self.coerce(collection = [], parent = nil, name = nil)
-      if collection.is_a?(Vedeu::Collection)
-        collection
+      # @param collection [Array|Vedeu::Repositories::Collection]
+      # @param parent [void]
+      # @param name [String|NilClass]
+      # @return [Vedeu::Repositories::Collection]
+      def self.coerce(collection = [], parent = nil, name = nil)
+        if collection.is_a?(Vedeu::Repositories::Collection)
+          collection
 
-      else
-        new(Array(collection), parent, name)
+        else
+          new(Array(collection), parent, name)
 
+        end
       end
-    end
 
-    # Returns a new instance of Vedeu::Collection.
-    #
-    # @param collection [void]
-    # @param parent [void]
-    # @param name [String|NilClass]
-    # @return [Vedeu::Collection]
-    def initialize(collection = [], parent = nil, name = nil)
-      @collection = collection
-      @parent     = parent
-      @name       = name
-    end
-
-    # Fetch an entry from the collection via index.
-    #
-    # @param value [Fixnum]
-    # @return [void]
-    def [](value)
-      collection[value]
-    end
+      # Returns a new instance of Vedeu::Repositories::Collection.
+      #
+      # @param collection [void]
+      # @param parent [void]
+      # @param name [String|NilClass]
+      # @return [Vedeu::Repositories::Collection]
+      def initialize(collection = [], parent = nil, name = nil)
+        @collection = collection
+        @parent     = parent
+        @name       = name
+      end
 
-    # Adds an entry to the collection.
-    #
-    # @param other [Vedeu::Collection]
-    # @return [Vedeu::Collection]
-    def add(*other)
-      self.class.new(@collection += other, parent, name)
-    end
-    alias_method :<<, :add
-
-    # Provides iteration over the collection.
-    #
-    # @param block [Proc]
-    # @return [Enumerator]
-    def each(&block)
-      collection.each(&block)
-    end
+      # Fetch an entry from the collection via index.
+      #
+      # @param value [Fixnum]
+      # @return [void]
+      def [](value)
+        collection[value]
+      end
 
-    # Returns a boolean indicating whether the collection is empty.
-    #
-    # @return [Boolean]
-    def empty?
-      collection.empty?
-    end
+      # Adds an entry to the collection.
+      #
+      # @param other [Vedeu::Repositories::Collection]
+      # @return [Vedeu::Repositories::Collection]
+      def add(*other)
+        self.class.new(@collection += other, parent, name)
+      end
+      alias_method :<<, :add
+
+      # Provides iteration over the collection.
+      #
+      # @param block [Proc]
+      # @return [Enumerator]
+      def each(&block)
+        collection.each(&block)
+      end
 
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Collection]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && collection == other.collection
-    end
-    alias_method :==, :eql?
-
-    # Returns the size of the collection.
-    #
-    # @return [Fixnum]
-    def size
-      collection.size
-    end
+      # Returns a boolean indicating whether the collection is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        collection.empty?
+      end
 
-    # Returns the collection as a String.
-    #
-    # @return [String]
-    def to_s
-      collection.map(&:to_s).join
-    end
-    alias_method :to_str, :to_s
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Repositories::Collection]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && collection == other.collection
+      end
+      alias_method :==, :eql?
+
+      # Returns the size of the collection.
+      #
+      # @return [Fixnum]
+      def size
+        collection.size
+      end
+
+      # Returns the collection as a String.
+      #
+      # @return [String]
+      def to_s
+        collection.map(&:to_s).join
+      end
+      alias_method :to_str, :to_s
+
+    end # Collection
 
-  end # Collection
+  end # Repositories
 
 end # Vedeu

data/lib/vedeu/repositories/model.rb

@@ -1,126 +1,137 @@
 module Vedeu
 
-  # When included into a class, provides the mechanism to store the
-  # class in a repository for later retrieval.
-  #
-  module Model
+  module Repositories
 
-    include Vedeu::Common
-
-    # @!attribute [rw] repository
-    # @return [Vedeu::Repository]
-    attr_accessor :repository
-
-    # When {Vedeu::Model} is included in a class, the methods within
-    # this module are included as class methods on that class.
+    # When included into a class, provides the mechanism to store the
+    # class in a repository for later retrieval.
     #
-    module ClassMethods
+    module Model
 
-      # @!attribute [r] repository
-      # @return [Vedeu::Repository]
-      attr_reader :repository
+      include Vedeu::Common
 
-      # Build models using a simple DSL when a block is given,
-      # otherwise returns a new instance of the class including this
-      # module.
-      #
-      # @param attributes [Hash] A collection of attributes specific
-      #   to the model.
-      # @param block [Proc] The block passed to the build method.
-      # @return [Object] An instance of the model.
-      def build(attributes = {}, &block)
-        attributes = defaults.merge!(attributes)
-
-        model = new(attributes)
-        model.deputy(attributes[:client]).instance_eval(&block) if block_given?
-        model
-      end
+      # @!attribute [rw] repository
+      # @return [Vedeu::Repositories::Repository]
+      attr_accessor :repository
 
-      # Fetch an instance of a repository's model by name.
+      # When {Vedeu::Repositories::Model} is included in a class, the
+      # methods within this module are included as class methods on
+      # that class.
       #
-      # @param name [String]
+      module ClassMethods
+
+        # @!attribute [r] repository
+        # @return [Vedeu::Repositories::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.
+        #
+        # @param attributes [Hash] A collection of attributes specific
+        #   to the model.
+        # @param block [Proc] The block passed to the build method.
+        # @return [Object] An instance of the model.
+        def build(attributes = {}, &block)
+          attributes = defaults.merge!(attributes)
+
+          model = new(attributes)
+
+          if block_given?
+            model.deputy(attributes[:client]).instance_eval(&block)
+          end
+
+          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) if repository
+        end
+
+        # Provide a convenient way to define the child or children of
+        # a model.
+        #
+        # @param klass [Class] The member (singular) or collection
+        #   (multiple) class name for the respective model.
+        # @return [void]
+        def child(klass)
+          send(:define_method, __callee__) { klass }
+        end
+        alias_method :member,     :child
+        alias_method :collection, :child
+
+        # Allow models to specify their repository using a class
+        # method.
+        #
+        # @param klass [void]
+        # @return [void]
+        def repo(klass)
+          @repository = klass
+        end
+
+        private
+
+        # The default values for a new instance of this class.
+        #
+        # @return [Hash<Symbol => NilClass, String>]
+        def defaults
+          {
+            client:    nil,
+            name:      '',
+          }
+        end
+
+      end # ClassMethods
+
+      # When this module is included in a class, provide ClassMethods
+      # as class methods for the class.
+      #
+      # @param klass [Class]
       # @return [void]
-      def by_name(name)
-        repository.by_name(name) if repository
+      def self.included(klass)
+        klass.send(:extend, ClassMethods)
       end
 
-      # Provide a convenient way to define the child or children of a
-      # model.
+      # Returns a DSL instance responsible for defining the DSL
+      # methods of this model.
       #
-      # @param klass [Class] The member (singular) or collection
-      #   (multiple) class name for the respective model.
-      # @return [void]
-      def child(klass)
-        send(:define_method, __callee__) { klass }
+      # @param client [Object|NilClass] The client binding represents
+      #   the client application object that is currently invoking a
+      #   DSL method. It is required so that we can send messages to
+      #   the client application object should we need to.
+      # @return [void] The DSL instance for this model.
+      def deputy(client = nil)
+        Object.const_get(dsl_class).new(self, client)
       end
-      alias_method :member,     :child
-      alias_method :collection, :child
 
-      # Allow models to specify their repository using a class method.
-      #
-      # @param klass [void]
-      # @return [void]
-      def repo(klass)
-        @repository = klass
+      # @todo Perhaps some validation could be added here?
+      # @return [void] The model instance stored in the repository.
+      def store
+        repository.store(self) # if valid?
       end
 
       private
 
-      # The default values for a new instance of this class.
+      # Returns the DSL class name responsible for this model.
       #
-      # @return [Hash<Symbol => NilClass, String>]
-      def defaults
-        {
-          client:    nil,
-          name:      '',
-        }
+      # @return [String]
+      def dsl_class
+        case demodulize(self.class.name)
+        when 'Border'   then 'Vedeu::Borders::DSL'
+        when 'Buffer'   then 'Vedeu::Buffers::DSL'
+        when 'Geometry' then 'Vedeu::Geometry::DSL'
+        when 'Menu'     then 'Vedeu::Menus::DSL'
+        # when 'ModelTestClass' then 'Vedeu::Repositories::ModelTestClass::DSL'
+        else
+          'Vedeu::DSL::' + demodulize(self.class.name)
+        end
       end
 
-    end # ClassMethods
-
-    # When this module is included in a class, provide ClassMethods as
-    # class methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
-    def self.included(klass)
-      klass.send(:extend, ClassMethods)
-    end
-
-    # Returns a DSL instance responsible for defining the DSL methods
-    # of this model.
-    #
-    # @param client [Object|NilClass] The client binding represents
-    #   the client application object that is currently invoking a DSL
-    #   method. It is required so that we can send messages to the
-    #   client application object should we need to.
-    # @return [void] The DSL instance for this model.
-    def deputy(client = nil)
-      Object.const_get(dsl_class).new(self, client)
-    end
-
-    # @todo Perhaps some validation could be added here?
-    # @return [void] The model instance stored in the repository.
-    def store
-      repository.store(self) # if valid?
-    end
-
-    private
-
-    # Returns the DSL class name responsible for this model.
-    #
-    # @return [String]
-    def dsl_class
-      case demodulize(self.class.name)
-      when 'Border'   then 'Vedeu::Borders::DSL'
-      when 'Buffer'   then 'Vedeu::Buffers::DSL'
-      when 'Geometry' then 'Vedeu::Geometry::DSL'
-      when 'Menu'     then 'Vedeu::Menus::DSL'
-      else
-        'Vedeu::DSL::' + demodulize(self.class.name)
-      end
-    end
+    end # Model
 
-  end # Model
+  end # Repositories
 
 end # Vedeu

data/lib/vedeu/repositories/registerable.rb

@@ -1,72 +1,76 @@
 module Vedeu
 
-  # Repositories contain registerables, this module provides
-  # convenience methods for them.
-  #
-  module Registerable
+  module Repositories
 
-    # These class methods are mixed into the repository.
-    module ClassMethods
+    # Repositories contain registerables, this module provides
+    # convenience methods for them.
+    #
+    module Registerable
 
-      # The null model is used when the repository cannot be found.
-      #
-      # @param klass [Class]
-      # @return [Symbol]
-      def null(klass)
-        define_method(:null_model) { klass }
-      end
+      # These class methods are mixed into the repository.
+      module ClassMethods
 
-      # The real model is the usual model to use for a given
-      # repository.
-      #
-      # @param klass [Class]
-      # @return [Symbol]
-      def real(klass)
-        define_method(:model) { instance_variable_set('@model', klass) }
-      end
+        # The null model is used when the repository cannot be found.
+        #
+        # @param klass [Class]
+        # @return [Symbol]
+        def null(klass)
+          define_method(:null_model) { klass }
+        end
 
-      # Register a repository for storing models.
-      #
-      # @param model [Class]
-      # @param storage [Class|Hash]
-      # @return [Vedeu::Repository]
-      def register(model = nil, storage = {})
-        new(model, storage).tap do |klass|
-          Vedeu::Repositories.register(klass.repository)
+        # The real model is the usual model to use for a given
+        # repository.
+        #
+        # @param klass [Class]
+        # @return [Symbol]
+        def real(klass)
+          define_method(:model) { instance_variable_set('@model', klass) }
         end
-      end
 
-      # Returns the repositories registered.
-      #
-      # @note
-      #   If the repository is 'Geometries', for example, then @models
-      #   will be either an empty Geometries repository or the
-      #   collection of stored models.
-      #
-      # @return [void]
-      def repository
-        @models ||= reset!
-      end
+        # Register a repository for storing models.
+        #
+        # @param model [Class]
+        # @param storage [Class|Hash]
+        # @return [Vedeu::Repositories::Repository]
+        def register(model = nil, storage = {})
+          new(model, storage).tap do |klass|
+            Vedeu::Repositories.register(klass.repository)
+          end
+        end
 
-      # Remove all stored models from the repository.
+        # Returns the repositories registered.
+        #
+        # @note
+        #   If the repository is 'Geometries', for example, then
+        #   @models will be either an empty Geometries repository or
+        #   the collection of stored models.
+        #
+        # @return [void]
+        def repository
+          @models ||= reset!
+        end
+
+        # Remove all stored models from the repository.
+        #
+        # @return [void]
+        def reset!
+          @models = register
+        end
+        alias_method :reset, :reset!
+
+      end # ClassMethods
+
+      # When this module is included in a class, provide ClassMethods
+      # as class methods for the class.
       #
+      # @param klass [Class]
       # @return [void]
-      def reset!
-        @models = register
+      def self.included(klass)
+        klass.send(:extend, ClassMethods)
       end
-      alias_method :reset, :reset!
 
-    end # ClassMethods
-
-    # When this module is included in a class, provide ClassMethods as
-    # class methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
-    def self.included(klass)
-      klass.send(:extend, ClassMethods)
-    end
+    end # Registerable
 
-  end # Registerable
+  end # Repositories
 
 end # Vedeu