controll 0.2.0 → 0.3.0

data/controll.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "controll"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-08-16"
-  s.description = "FlowHandler, Executor, Notifier and more, all tied together tool pack"
+  s.date = "2012-09-17"
+  s.description = "Flow, Executor, Notifier and more, all tied together tool pack"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -28,109 +28,146 @@ Gem::Specification.new do |s|
     "controll.gemspec",
     "lib/controll.rb",
     "lib/controll/assistant.rb",
+    "lib/controll/assistant/param_assistant.rb",
+    "lib/controll/assistant/session_assistant.rb",
     "lib/controll/command.rb",
     "lib/controll/commander.rb",
+    "lib/controll/enabler.rb",
+    "lib/controll/enabler/macros.rb",
+    "lib/controll/enabler/maps.rb",
+    "lib/controll/enabler/notify.rb",
+    "lib/controll/enabler/path_handler.rb",
+    "lib/controll/enabler/path_resolver.rb",
+    "lib/controll/engine.rb",
     "lib/controll/errors.rb",
+    "lib/controll/event.rb",
+    "lib/controll/event/helper.rb",
+    "lib/controll/event/matcher.rb",
+    "lib/controll/events.rb",
     "lib/controll/executor.rb",
     "lib/controll/executor/base.rb",
-    "lib/controll/executor/notificator.rb",
-    "lib/controll/flow_handler.rb",
-    "lib/controll/flow_handler/base.rb",
-    "lib/controll/flow_handler/control.rb",
-    "lib/controll/flow_handler/errors.rb",
-    "lib/controll/flow_handler/event_helper.rb",
-    "lib/controll/flow_handler/redirect.rb",
-    "lib/controll/flow_handler/redirect/action.rb",
-    "lib/controll/flow_handler/redirect/mapper.rb",
-    "lib/controll/flow_handler/render.rb",
+    "lib/controll/executor/controlled.rb",
+    "lib/controll/executor/delegator.rb",
+    "lib/controll/flow.rb",
+    "lib/controll/flow/action.rb",
+    "lib/controll/flow/action/base.rb",
+    "lib/controll/flow/action/fallback.rb",
+    "lib/controll/flow/action/path_action.rb",
+    "lib/controll/flow/action_mapper.rb",
+    "lib/controll/flow/action_mapper/base.rb",
+    "lib/controll/flow/action_mapper/complex.rb",
+    "lib/controll/flow/action_mapper/simple.rb",
+    "lib/controll/flow/errors.rb",
+    "lib/controll/flow/event_mapper.rb",
+    "lib/controll/flow/event_mapper/path_finder.rb",
+    "lib/controll/flow/event_mapper/util.rb",
+    "lib/controll/flow/master.rb",
+    "lib/controll/flow/master/executor.rb",
+    "lib/controll/flow/master/macros.rb",
+    "lib/controll/focused/enabler.rb",
     "lib/controll/helper.rb",
-    "lib/controll/helper/event_matcher.rb",
     "lib/controll/helper/hash_access.rb",
-    "lib/controll/helper/notify.rb",
     "lib/controll/helper/params.rb",
-    "lib/controll/helper/path_resolver.rb",
     "lib/controll/helper/session.rb",
+    "lib/controll/macros.rb",
     "lib/controll/notify.rb",
     "lib/controll/notify/base.rb",
     "lib/controll/notify/flash.rb",
+    "lib/controll/notify/macros.rb",
+    "lib/controll/notify/message.rb",
+    "lib/controll/notify/message/handler.rb",
+    "lib/controll/notify/message/resolver.rb",
+    "lib/controll/notify/message/translator.rb",
     "lib/controll/notify/typed.rb",
+    "lib/generators/controll/assistant_generator.rb",
+    "lib/generators/controll/executor_generator.rb",
+    "lib/generators/controll/flow_handler_generator.rb",
+    "lib/generators/controll/notifier_generator.rb",
+    "lib/generators/controll/setup_generator.rb",
+    "lib/generators/controll/templates/assistant.tt",
+    "lib/generators/controll/templates/commander.tt",
+    "lib/generators/controll/templates/executor.tt",
+    "lib/generators/controll/templates/flow_handler.tt",
+    "lib/generators/controll/templates/notifier.tt",
     "spec/acceptance/app_test.rb",
-    "spec/app/.gitignore",
-    "spec/app/Gemfile",
-    "spec/app/Gemfile.lock",
-    "spec/app/README.rdoc",
-    "spec/app/Rakefile",
-    "spec/app/app/controllers/application_controller.rb",
-    "spec/app/app/controllers/posts_controller.rb",
-    "spec/app/app/models/.gitkeep",
-    "spec/app/app/models/post.rb",
-    "spec/app/app/views/layouts/application.html.erb",
-    "spec/app/app/views/posts/_form.html.erb",
-    "spec/app/app/views/posts/edit.html.erb",
-    "spec/app/app/views/posts/index.html.erb",
-    "spec/app/app/views/posts/new.html.erb",
-    "spec/app/app/views/posts/show.html.erb",
-    "spec/app/config.ru",
-    "spec/app/config/application.rb",
-    "spec/app/config/boot.rb",
-    "spec/app/config/environment.rb",
-    "spec/app/config/environments/development.rb",
-    "spec/app/config/environments/test.rb",
-    "spec/app/config/initializers/backtrace_silencers.rb",
-    "spec/app/config/initializers/inflections.rb",
-    "spec/app/config/initializers/mime_types.rb",
-    "spec/app/config/initializers/secret_token.rb",
-    "spec/app/config/initializers/session_store.rb",
-    "spec/app/config/locales/en.yml",
-    "spec/app/config/routes.rb",
-    "spec/app/db/seeds.rb",
-    "spec/app/lib/assets/.gitkeep",
-    "spec/app/lib/tasks/.gitkeep",
-    "spec/app/log/.gitkeep",
-    "spec/app/public/404.html",
-    "spec/app/public/422.html",
-    "spec/app/public/500.html",
-    "spec/app/public/favicon.ico",
-    "spec/app/public/index.html",
-    "spec/app/public/javascripts/application.js",
-    "spec/app/public/robots.txt",
-    "spec/app/public/stylesheets/application.css",
-    "spec/app/script/rails",
-    "spec/app/spec/controllers/posts_controller_spec.rb",
-    "spec/app/spec/isolated_spec_helper.rb",
-    "spec/app/spec/spec_helper.rb",
-    "spec/app/spec/unit/controllers/posts_controller_isolated_spec.rb",
-    "spec/app/spec/unit/controllers/posts_controller_spec.rb",
-    "spec/app/test/functional/.gitkeep",
-    "spec/app/test/functional/posts_controller_test.rb",
-    "spec/app/test/isolated_test_helper.rb",
-    "spec/app/test/test_helper.rb",
-    "spec/app/test/unit/.gitkeep",
-    "spec/app/test/unit/controllers/posts_controller_isolated_test.rb",
-    "spec/app/test/unit/controllers/posts_controller_test.rb",
-    "spec/app/vendor/assets/javascripts/.gitkeep",
-    "spec/app/vendor/assets/stylesheets/.gitkeep",
-    "spec/app/vendor/plugins/.gitkeep",
-    "spec/controll/asssistant_spec.rb",
+    "spec/controll/assistant/param_assistant_spec.rb",
+    "spec/controll/assistant/session_assistant_spec.rb",
+    "spec/controll/assistant_spec.rb",
     "spec/controll/command_spec.rb",
     "spec/controll/commander_spec.rb",
-    "spec/controll/executor/notificator_spec.rb",
-    "spec/controll/flow_handler/control_spec.rb",
-    "spec/controll/flow_handler/redirect/action_spec.rb",
-    "spec/controll/flow_handler/redirect/mapper_spec.rb",
-    "spec/controll/flow_handler/redirect_spec.rb",
-    "spec/controll/flow_handler/render_spec.rb",
-    "spec/controll/helper/event_matcher_spec.rb",
+    "spec/controll/enabler/macros_spec.rb",
+    "spec/controll/enabler/maps_spec.rb",
+    "spec/controll/enabler/notify_spec.rb",
+    "spec/controll/enabler/path_handler_spec.rb",
+    "spec/controll/enabler/path_resolver_spec.rb",
+    "spec/controll/enabler_spec.rb",
+    "spec/controll/event/helper_spec.rb",
+    "spec/controll/event/matcher_spec.rb",
+    "spec/controll/event_spec.rb",
+    "spec/controll/events_spec.rb",
+    "spec/controll/executor/controlled_spec.rb",
+    "spec/controll/executor/delegator_spec.rb",
+    "spec/controll/flow/action_mapper/complex_spec.rb",
+    "spec/controll/flow/action_mapper/fallback_spec.rb",
+    "spec/controll/flow/action_mapper/simple_spec.rb",
+    "spec/controll/flow/event_mapper/path_finder_spec.rb",
+    "spec/controll/flow/event_mapper/util_spec.rb",
+    "spec/controll/flow/master/executor_spec.rb",
+    "spec/controll/flow/master/macros_spec.rb",
+    "spec/controll/flow/master_spec.rb",
     "spec/controll/helper/hash_access_spec.rb",
-    "spec/controll/helper/notify_spec.rb",
     "spec/controll/helper/params_spec.rb",
-    "spec/controll/helper/path_resolver_spec.rb",
     "spec/controll/helper/session_spec.rb",
-    "spec/controll/helper_spec.rb",
     "spec/controll/notify/base_spec.rb",
     "spec/controll/notify/flash_spec.rb",
-    "spec/controll/notify/message_handler.rb",
+    "spec/controll/notify/message/handler_spec.rb",
+    "spec/controll/notify/message/resolver_spec.rb",
+    "spec/controll/notify/message/translator_spec.rb",
+    "spec/controll/notify/message_spec.rb",
+    "spec/controll/notify/services_notifier.rb",
     "spec/controll/notify/typed_spec.rb",
+    "spec/controll_app/.gitignore",
+    "spec/controll_app/Gemfile",
+    "spec/controll_app/Gemfile.lock",
+    "spec/controll_app/README.rdoc",
+    "spec/controll_app/Rakefile",
+    "spec/controll_app/app/controll/commanders/services_commander.rb",
+    "spec/controll_app/app/controll/executors/services_executor.rb",
+    "spec/controll_app/app/controll/flows/create_services.rb",
+    "spec/controll_app/app/controll/notifiers/services_notifier.rb",
+    "spec/controll_app/app/controllers/application_controller.rb",
+    "spec/controll_app/app/controllers/services_controller.rb",
+    "spec/controll_app/app/models/.gitkeep",
+    "spec/controll_app/app/models/post.rb",
+    "spec/controll_app/app/views/layouts/application.html.erb",
+    "spec/controll_app/app/views/posts/_form.html.erb",
+    "spec/controll_app/app/views/posts/edit.html.erb",
+    "spec/controll_app/app/views/posts/index.html.erb",
+    "spec/controll_app/app/views/posts/new.html.erb",
+    "spec/controll_app/app/views/posts/show.html.erb",
+    "spec/controll_app/config.ru",
+    "spec/controll_app/config/application.rb",
+    "spec/controll_app/config/boot.rb",
+    "spec/controll_app/config/environment.rb",
+    "spec/controll_app/config/environments/development.rb",
+    "spec/controll_app/config/environments/test.rb",
+    "spec/controll_app/config/initializers/backtrace_silencers.rb",
+    "spec/controll_app/config/initializers/inflections.rb",
+    "spec/controll_app/config/initializers/mime_types.rb",
+    "spec/controll_app/config/initializers/secret_token.rb",
+    "spec/controll_app/config/initializers/session_store.rb",
+    "spec/controll_app/config/locales/en.yml",
+    "spec/controll_app/config/routes.rb",
+    "spec/controll_app/db/seeds.rb",
+    "spec/controll_app/log/.gitkeep",
+    "spec/controll_app/public/404.html",
+    "spec/controll_app/public/422.html",
+    "spec/controll_app/public/500.html",
+    "spec/controll_app/public/favicon.ico",
+    "spec/controll_app/public/index.html",
+    "spec/controll_app/public/javascripts/application.js",
+    "spec/controll_app/public/robots.txt",
+    "spec/controll_app/public/stylesheets/application.css",
     "spec/functional_test_helper.rb",
     "spec/helper.rb",
     "spec/rspec_controller_class.rb",

data/lib/controll/assistant/param_assistant.rb

@@ -0,0 +1,23 @@
+module Controll
+  class ParamAssistant < Assistant
+    include Controll::Helper::Params
+
+    controller_methods :params
+
+    module Helper
+      extend ActiveSupport::Concern
+
+      def param name
+        param_assistant.send(name)
+      end
+
+      module ClassMethods
+        def param_assistant clazz
+          define_method :param_assistant do
+            @param_assistant ||= clazz.new self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/controll/assistant/session_assistant.rb

@@ -0,0 +1,23 @@
+module Controll
+  class SessionAssistant < Assistant
+    include Controll::Helper::Session
+
+    controller_methods :session
+
+    module Helper
+      extend ActiveSupport::Concern
+
+      def sess name
+        session_assistant.send(name)
+      end
+
+      module ClassMethods
+        def session_assistant clazz
+          define_method :session_assistant do
+            @session_assistant ||= clazz.new self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/controll/assistant.rb

@@ -1,4 +1,7 @@
 module Controll
+  autoload :SessionAssistant, 'controll/assistant/session_assistant'
+  autoload :ParamAssistant,   'controll/assistant/param_assistant'
+
   class Assistant
     attr_reader :controller, :options
 
@@ -6,14 +9,13 @@ module Controll
       @controller = controller
       @options = options
     end
-  end
-end
 
-module Controll
-  class DelegateAssistant < Assistant
-    def method_missing(meth, *args, &block)
-      controller.send(meth, *args, &block)
-    end        
+    def self.controller_methods *names
+      delegate *names, to: :controller
+    end
   end
 end
 
+module Assistants
+  Assistant = Controll::Assistant
+end

data/lib/controll/commander.rb

@@ -4,10 +4,10 @@ module Controll
     # makes #command_method available
     extend Imperator::Command::MethodFactory
 
-    attr_reader :controller, :options
+    attr_reader :initiator, :options
 
-    def initialize controller, options = {}
-      @controller = controller
+    def initialize initiator, options = {}
+      @initiator = initiator
       @options = options
     end
 
@@ -20,5 +20,18 @@ module Controll
     end
     alias_method :use_command, :command!
     alias_method :perform_command, :command!
+
+    alias_method :controller, :initiator
+
+    class << self
+      def initiator_methods *names
+        delegate names, to: :initiator
+      end    
+      alias_method :controller_methods, :initiator_methods
+    end
   end
+end
+
+module Commanders
+  Commander = Controll::Commander
 end

data/lib/controll/enabler/macros.rb

@@ -0,0 +1,75 @@
+module Controll
+  module Enabler
+    module Macros
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # on Controller: 
+        #  - fx Admin::ServicesController -> :services
+        # On Focused Controller action: 
+        #  - fx Admin::ServicesController::Update -> :update_services
+        def controll *artifacts
+          def name_of clazz
+            clazz = clazz.to_s
+            if clazz =~ /Controller$/
+              clazz.sub(/Controller$/, '').split('::').last.underscore
+            else
+              parts = clazz.sub(/Controller/, '').split('::')
+              (parts.pop << parts.last).underscore
+            end
+          end
+
+          options = artifacts.extract_options!
+          name = name_of self.class
+          artifacts.each do |artifact|
+            send(artifact, name, options)
+          end
+        end
+
+        # TODO: refactor - all use exactly the same pattern - can be generated!
+        def commander name, options = {}
+          define_method :commander do
+            instance_variable_get("@commander") || begin
+              clazz = "Commanders::#{name.to_s.camelize}".constantize        
+              instance_variable_set "@commander", clazz.new(self, options)
+            end
+          end
+        end
+
+        def notifier name, options = {}
+          define_method :notifier do
+            instance_variable_get("@notifier") || begin
+              clazz = "Notifiers::#{name.to_s.camelize}".constantize        
+              instance_variable_set "@notifier", clazz.new(self, options)
+            end
+          end
+        end
+
+        def flow name, options = {}
+          define_method :flow do
+            unless instance_variable_get("@flow")
+              clazz = "Flows::#{name.to_s.camelize}".constantize        
+              instance_variable_set "@flow", clazz.new(self, options)
+            end
+          end
+        end
+
+        def assistant name, options = {}
+          define_method :assistant do
+            unless instance_variable_get("@assistant")
+              clazz = "Assistants::#{name.to_s.camelize}".constantize        
+              instance_variable_set "@assistant", clazz.new(self, options)
+            end
+          end
+        end
+
+        def assistant_methods *names
+          options = names.extract_options!
+          assistant = options[:to] || :assistant
+          delegate names, to: assistant
+        end        
+      end
+    end
+  end
+end

data/lib/controll/enabler/maps.rb

@@ -0,0 +1,15 @@
+module Controll::Enabler
+  module Maps
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def redirect_map map = {}
+        @redirect_map ||= map
+      end
+
+      def render_map map = {}
+        @render_map ||= map
+      end
+    end
+  end
+end

data/lib/controll/enabler/notify.rb

@@ -0,0 +1,43 @@
+module Controll
+  module Enabler
+    module Notify
+      extend ActiveSupport::Concern
+
+      included do
+        Controll::Event.valid_types.each do |type|
+          meth = "create_#{type}"
+          define_method meth do |*args|
+            return create_event type, type if args.empty?
+            create_event args.first, type, args[1..-1]
+          end
+          alias_method type, meth 
+        end
+      end
+
+      include Controll::Event::Helper
+
+      def notify event, *args
+        events << normalize(event, *args)
+        self # enable method chaining on controller
+      end
+
+      # event stack
+      def events
+        @events ||= Controll::Events.new
+      end
+
+      def main_event
+        events.last || create_success
+      end
+
+      protected      
+      
+      def process_events notifier = nil
+        notifier ||= self.notifier
+        events.each do |event|
+          notifier.send(event.type).notify event.name, event.options
+        end
+      end
+    end
+  end
+end

data/lib/controll/enabler/path_handler.rb

@@ -0,0 +1,49 @@
+module Controll::Enabler
+  class PathHandler
+    attr_reader :controller, :type, :options, :path
+
+    def initialize controller, type
+      @controller, @type = [controller, type]
+    end
+
+    def self.renderer controller, map
+      self.new controller, map, :render
+    end
+
+    def self.redirecter controller, map
+      self.new controller, map, :redirect
+    end
+
+    def execute *args
+      extract! *args
+      process_notifications
+      path ? handle_path : fallback
+    end
+
+    protected
+
+    def map
+      @map ||= controller.class.send("#{type}_map") 
+    end
+
+    alias_method :control_action, :type
+
+    def handle_path
+      controller.send control_action, path, options
+    end
+
+    def fallback
+      controller.do_fallback action
+    end
+
+    def extract! *args
+      @options = args.extract_options!
+      action = args.first
+      @path = path_resolver(map).resolve action
+    end
+
+    def path_resolver map
+      @path_resolver ||= PathResolver.new controller, map
+    end    
+  end
+end

data/lib/controll/enabler/path_resolver.rb

@@ -0,0 +1,47 @@
+module Controll::Enabler
+  class PathResolver
+    attr_reader :caller, :event_map
+
+    ActionMapper  = Controll::Flow::ActionMapper
+    Action        = Controll::Flow::Action
+
+    def initialize caller, event_map
+      @caller     = caller
+      @event_map = event_map
+    end
+
+    def resolve action = nil
+      @path ||= handle action
+    end
+
+    protected
+
+    alias_method :controller, :caller
+
+    delegate :notify, :main_event, to: :caller
+
+    def handle action
+      case action
+      when Action::Fallback
+        nil
+      when Action::PathAction
+        action.resolved_path
+      when Symbol, Controll::Event
+        resolve_event action
+      else
+        resolve_event
+      end      
+    rescue Controll::Flow::PathActionError
+      nil            
+    end
+
+    def resolve_event event = nil
+      notify event if event
+      mapper.map_event
+    end
+
+    def mapper
+      @mapper ||= Controll::Flow::EventMapper::Util.new main_event, event_map
+    end      
+  end
+end

data/lib/controll/enabler.rb

@@ -0,0 +1,49 @@
+module Controll
+  module Enabler
+    autoload :Macros,         'controll/enabler/macros'
+    autoload :Notify,         'controll/enabler/notify'
+    autoload :PathResolver,   'controll/enabler/path_resolver'
+    autoload :PathHandler,    'controll/enabler/path_handler'
+    autoload :Maps,           'controll/enabler/maps'
+
+    extend ActiveSupport::Concern
+
+    included do      
+      include Controll::Helper::Params
+      include Controll::Helper::Session
+
+      include Notify
+      include Macros
+      include Maps
+
+      delegate :command, :command!, :use_command, to: :commander
+    end
+
+    # override this for custom Controller specific fallback action
+    def do_fallback action
+      do_redirect fallback_path
+    end    
+
+    def do_redirect *args
+      redirecter.execute *args
+    end
+
+    def do_render *args
+      renderer.execute *args
+    end    
+
+    protected
+
+    def fallback_path
+      root_url
+    end
+
+    def renderer
+      @renderer||= PathHandler.new self, :render
+    end
+
+    def redirecter
+      @redirecter ||= PathHandler.new self, :redirect
+    end
+  end
+end

data/lib/controll/engine.rb

@@ -0,0 +1,9 @@
+module Controll
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'setup controll' do
+        config.autoload_paths += Dir[Rails.root.join('app', 'controll')]
+      end
+    end
+  end
+end

data/lib/controll/errors.rb

@@ -1 +1,4 @@
-class Controll::InvalidEvent < StandardError; end
+module Controll
+  class NotEnabled   < StandardError; end
+  class InvalidEvent < StandardError; end
+end

data/lib/controll/event/helper.rb

@@ -0,0 +1,20 @@
+module Controll
+  module Event::Helper
+    def normalize event, *args
+      case event
+      when Controll::Event
+        event
+      when Symbol, String
+        create_event event.to_sym, *args
+      when Hash, Hashie::Mash
+        create_event event.delete(:name), event
+      else
+        raise Controll::Event::InvalidError, "Event: #{event} could not be normalized, must be a Hash, String or Symbol"
+      end
+    end
+
+    def create_event name, *args
+      Controll::Event.new name, *args
+    end
+  end
+end