vedeu 0.4.61 → 0.4.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ceb6ac3ef4df98a7535ceeb37ae65a39d5a6645
-  data.tar.gz: 21bc34bf6d44e123fe9895603bef26832738b892
+  metadata.gz: 30927938a72729c5f3bae9a255a5c8b7602360f9
+  data.tar.gz: eeb3240c0d98fd5450ddf9f4a9cdf5f5e81ac1b3
 SHA512:
-  metadata.gz: 879388bbd80aff90f21b262568bda67262c509efaccda7570968bf3080a1951c2be6452fb46ef4f5fb7e36ab63e15c4e56c440effd6bea59775dfcf0e020c13d
-  data.tar.gz: 4b2e7aefea725739b77497a3133ae74efa074add21b67ee0c4591c1d646b9764fe15e13a74b8f697f620883ae0ab0168023b3d0612ada31c740192828bf64297
+  metadata.gz: 645204564d7353b20bd33141221af4a2fa1bca84da5990a4a0280041b304985ce5391809239fd3e08235deab9f87933ea38ead859e4653a494a2e70d49be64c4
+  data.tar.gz: 04ae7389a57c38d513a7f7a8f2af5d1910d8f5fe4881668453a6d2b7eb426450d997c0c7b2c6e938cd50d6c446f8c08f0f6b0bd168b4ea14e1fbc9c302f1b67d

data/lib/vedeu/all.rb

@@ -7,6 +7,7 @@ require 'vedeu/debug'
 require 'vedeu/traps'
 require 'vedeu/common'
 require 'vedeu/terminal_mode'
+require 'vedeu/router'
 
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
@@ -172,6 +173,7 @@ require 'vedeu/output/wordwrap'
 
 require 'vedeu/api'
 
+require 'vedeu/bindings/application'
 require 'vedeu/bindings/drb'
 require 'vedeu/bindings/menus'
 require 'vedeu/bindings/movement'

data/lib/vedeu/application/controller.rb

@@ -5,26 +5,58 @@ module Vedeu
   module Controller
 
     # When included, provide these methods as class methods.
+    #
     module ClassMethods
 
-      # Specifying the controller name in your controller provides a Vedeu event
-      # which will trigger the loading of the controller.
+      attr_accessor :controller_name
+
+      # Specifying the controller name in your controller provides Vedeu with
+      # the means to route requests to different parts of your application.
       #
       # @example
       #   class YourController
+      #
+      #     controller :your_controller
+      #     # or...
       #     controller_name :your_controller
-      #     # ...
+      #
+      #     # ... some code
+      #
+      #   end
+      #
+      # @param controller_name [Symbol] The name of the controller.
+      # @return [void]
+      def controller(controller_name = nil)
+        @controller_name = controller_name
+
+        Vedeu::Router.add_controller(controller_name, ancestors.first.to_s)
+      end
+      alias_method :controller_name, :controller
+
+      # Specifying the action names in your controller provides Vedeu with the
+      # means to route requests to different parts of your application.
+      #
+      # @example
+      #   class YourController
+      #
+      #     controller :your_controller
+      #
+      #     action :show
+      #     # or...
+      #     action_name :show
+      #
+      #     # ... some code
+      #
       #   end
       #
-      #   Vedeu.trigger(:show_your_controller) # this event is now available to
-      #                                        # trigger.
+      #   Vedeu.trigger(:_action_, :your_controller, :show, { some: :args })
       #
-      # @param name [Symbol] The name of the controller.
+      # @param action_name [Symbol] THe name of the action.
       # @return [void]
-      # @todo This event binding should be: `Vedeu.bind(:show_view, name)`.
-      def controller_name(name)
-        Vedeu.bind("show_#{name}".to_sym) { new }
+      def action(action_name = nil)
+        Vedeu::Router.add_action(@controller_name, action_name)
       end
+      alias_method :action_name, :action
 
     end # ClassMethods
 

data/lib/vedeu/bindings.rb

@@ -9,10 +9,13 @@ module Vedeu
   #
   module Bindings
 
+    extend self
+
     # Setup events for running Vedeu. This method is called by Vedeu.
     #
     # @return [void]
-    def self.setup!
+    def setup!
+      Vedeu::Bindings::Application.setup!
       Vedeu::Bindings::Visibility.setup!
       Vedeu::Bindings::Movement.setup!
       Vedeu::Bindings::Menus.setup!

data/lib/vedeu/bindings/application.rb

@@ -0,0 +1,36 @@
+module Vedeu
+
+  module Bindings
+
+    # System events relating to movement of cursors or interfaces.
+    #
+    # :nocov:
+    module Application
+
+      extend self
+
+      # Setup events relating to client applications. This method is called by
+      # Vedeu.
+      #
+      # @return [void]
+      def setup!
+        action!
+      end
+
+      private
+
+      # @example
+      #   Vedeu.trigger(:_action_, :your_controller, :some_action, { id: 7 })
+      #
+      # @return [void]
+      def action!
+        Vedeu.bind(:_action_) do |controller, action, **args|
+          Vedeu::Router.goto(controller, action, **args)
+        end
+      end
+
+    end # Application
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bootstrap.rb

@@ -82,7 +82,7 @@ module Vedeu
 
     # @return [void]
     def client_initialize!
-      entry_point || eval(Vedeu::Configuration.root)
+      entry_point || root
     end
 
     # Load each of the loadable files.
@@ -113,6 +113,11 @@ module Vedeu
       end unless Vedeu::Configuration.log?
     end
 
+    # @return [Class]
+    def root
+      Object.const_get(Vedeu::Configuration.root) if Vedeu::Configuration.root
+    end
+
   end # Bootstrap
 
 end # Vedeu

data/lib/vedeu/cli/generator/templates/application/app/controllers/name.erb

@@ -5,17 +5,23 @@ module <%= object.app_name %>
 
   class <%= object.name_as_class %>Controller < <%= object.app_name -%>::ApplicationController
 
-    controller_name :<%= object.name %>
+    controller :<%= object.name %>
+    action :list
+    action :show
+    # add more actions and implement or remove existing actions
 
     def initialize
-      <%= object.app_name %>::<%= object.name_as_class %>View.render(*args)
     end
 
-    private
+    def list
+    end
 
-    def args
+    def show(*args)
+      <%= object.app_name %>::<%= object.name_as_class %>View.render(*args)
     end
 
+    private
+
     def object
       nil
     end

data/lib/vedeu/colours/colour.rb

@@ -40,19 +40,16 @@ module Vedeu
     # @return [Vedeu::Foreground]
     attr_reader :foreground
 
-    # @param value [Vedeu::Colour|Fixnum|Hash|String]
+    # @param value [Vedeu::Colour|Hash<Symbol => void>]
     # @return [Object]
     def self.coerce(value)
-      return value if value.is_a?(self)
-      return new unless value.is_a?(Hash)
+      return value if value.is_a?(Vedeu::Colour)
+      return new   unless value.is_a?(Hash)
 
-      if value[:colour] && value[:colour].is_a?(self)
-        value[:colour]
+      if value.key?(:colour)
+        coerce(value[:colour])
 
-      elsif value[:colour] && value[:colour].is_a?(Hash)
-        new(value[:colour])
-
-      elsif value[:background] || value[:foreground]
+      elsif value.key?(:background) || value.key?(:foreground)
         new(value)
 
       else

data/lib/vedeu/repositories/model.rb

@@ -40,7 +40,7 @@ module Vedeu
       # @param name [String]
       # @return [void]
       def by_name(name)
-        @repository.by_name(name)
+        repository.by_name(name) if repository
       end
 
       # Provide a convenient way to define the child or children of a model.

data/lib/vedeu/router.rb

@@ -0,0 +1,117 @@
+module Vedeu
+
+  # Stores all client application controllers with their respective actions.
+  #
+  module Router
+
+    include Vedeu::Common
+
+    extend self
+
+    # @param controller_name [Symbol]
+    # @param klass [String]
+    # @return [void]
+    def add_controller(controller_name, klass)
+      unless present?(controller_name)
+        fail Vedeu::MissingRequired,
+             'Cannot store controller without a name attribute.'
+      end
+
+      if registered?(controller_name)
+        storage[controller_name].merge!(klass: klass)
+
+      else
+        storage.store(controller_name, klass: klass, actions: [])
+
+      end
+
+      storage
+    end
+
+    # @param controller_name [Symbol]
+    # @param action_name [Symbol]
+    # @return [void]
+    def add_action(controller_name, action_name)
+      if present?(controller_name) && present?(action_name)
+        if registered?(controller_name)
+          storage[controller_name][:actions] << action_name
+
+        else
+          add_controller(controller_name, '')
+          add_action(controller_name, action_name)
+
+        end
+
+        storage
+
+      else
+        fail Vedeu::MissingRequired,
+             'Cannot store action without a controller or name attribute.'
+
+      end
+    end
+
+    # @param controller_name [Symbol]
+    # @param action_name [Symbol]
+    # @param args [void]
+    # @return [void]
+    def goto(controller_name, action_name, **args)
+      unless registered?(controller_name)
+        fail Vedeu::ModelNotFound, "#{controller_name} is not registered."
+      end
+
+      controller_with(controller_name).send(action_name, args)
+    end
+
+    # @param controller_name [Symbol]
+    # @return [Boolean]
+    def registered?(controller_name)
+      storage.key?(controller_name)
+    end
+
+    # @return [Hash<void>]
+    def reset!
+      @storage = in_memory
+    end
+    alias_method :reset, :reset!
+
+    private
+
+    # @param controller_name [Symbol]
+    # @return [void]
+    def controller_with(controller_name)
+      Object.const_get(klass_for(controller_name)).new
+    end
+
+    # @param controller_name [Symbol]
+    # @return [String]
+    def klass_for(controller_name)
+      if registered?(controller_name) && klass_defined?(controller_name)
+        storage[controller_name][:klass]
+
+      else
+        fail Vedeu::MissingRequired,
+             "Cannot route to #{controller_name} as no class defined."
+
+      end
+    end
+
+    # @param controller_name [Symbol]
+    # @return [Boolean]
+    def klass_defined?(controller_name)
+      present?(storage[controller_name][:klass])
+    end
+
+    # @return [Hash<Symbol => Hash<Symbol => String|Array<Symbol>>>]
+    def storage
+      @storage ||= in_memory
+    end
+
+    # @return [Hash<void>]
+    def in_memory
+      {}
+    end
+
+  end # Router
+
+end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.61'
+  VERSION = '0.4.62'
 
 end

data/test/lib/vedeu/application/application_controller_test.rb

@@ -7,7 +7,7 @@ module Vedeu
     let(:described) { Vedeu::ApplicationController }
     let(:instance)  { described.new }
 
-    # @todo
+    # @todo Add more tests.
 
   end # ApplicationController
 

data/test/lib/vedeu/application/application_helper_test.rb

@@ -13,7 +13,7 @@ module Vedeu
     let(:described) { Vedeu::ApplicationHelper }
     let(:instance)  { Vedeu::ApplicationHelperTestClass.new }
 
-    # @todo
+    # @todo Add more tests.
 
   end # Application
 

data/test/lib/vedeu/application/controller_test.rb

@@ -2,27 +2,51 @@ require 'test_helper'
 
 module Vedeu
 
-  class ControllerTestClass
+  class ControllerTestKlass
 
     include Vedeu::Controller
 
+    controller :some_controller
+    action :some_action
+
   end # ControllerTestClass
 
   describe Controller do
 
-    let(:described) { Vedeu::ControllerTestClass }
-    let(:instance)  { described.new }
+    let(:described) { Vedeu::Controller }
+
+    let(:described_model) { Vedeu::ControllerTestKlass }
+    let(:instance_model)  { described.new }
+
+    describe 'ClassMethods' do
+      let(:described) { Vedeu::Controller::ClassMethods }
+
+      it { described_model.must_respond_to(:controller_name) }
+      it { described_model.must_respond_to(:action_name) }
+      it { described_model.must_respond_to(:controller) }
+      it { described_model.must_respond_to(:action) }
+
+      describe '.controller' do
+        subject { described_model.controller(:some_controller) }
+
+        it {
+          Vedeu::Router.expects(:add_controller).
+            with(:some_controller, 'Vedeu::ControllerTestKlass')
+          subject
+        }
+      end
 
-    context 'ClassMethods' do
-      let(:_name) { :vedeu_controller_test }
+      describe '.action' do
+        subject { described_model.action(:some_action) }
 
-      subject { ControllerTestClass.controller_name(_name) }
+        it {
+          Vedeu::Router.expects(:add_action).
+            with(:some_controller, :some_action)
+          subject
+        }
+      end
 
-      it {
-        Vedeu.expects(:bind).with(:show_vedeu_controller_test)
-        subject
-      }
-    end
+    end # ClassMethods
 
   end # Controller