controll 0.2.0

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "controll"
+  gem.homepage = "http://github.com/kristianmandrup/controll"
+  gem.license = "MIT"
+  gem.summary = %Q{Utils for handling complex Controller/Business logic}
+  gem.description = %Q{FlowHandler, Executor, Notifier and more, all tied together tool pack}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "controll #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/controll.gemspec

@@ -0,0 +1,184 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "controll"
+  s.version = "0.2.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.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "controll.gemspec",
+    "lib/controll.rb",
+    "lib/controll/assistant.rb",
+    "lib/controll/command.rb",
+    "lib/controll/commander.rb",
+    "lib/controll/errors.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/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/notify.rb",
+    "lib/controll/notify/base.rb",
+    "lib/controll/notify/flash.rb",
+    "lib/controll/notify/typed.rb",
+    "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/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/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/typed_spec.rb",
+    "spec/functional_test_helper.rb",
+    "spec/helper.rb",
+    "spec/rspec_controller_class.rb",
+    "spec/rspec_functional_helper.rb",
+    "spec/rspec_helper.rb",
+    "spec/spec_helper.rb",
+    "spec/test_helper.rb",
+    "spec/unit/functional_test_helper_test.rb",
+    "spec/unit/macros_test.rb",
+    "spec/unit/mixin_test.rb",
+    "spec/unit/rspec_functional_helper.rb",
+    "spec/unit/rspec_helper_test.rb",
+    "spec/unit/test_helper_test.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/controll"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Utils for handling complex Controller/Business logic"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<liquid>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.5"])
+    else
+      s.add_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_dependency(%q<liquid>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<hashie>, ["~> 1.2"])
+    s.add_dependency(%q<liquid>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0.5"])
+  end
+end
+

data/lib/controll.rb

@@ -0,0 +1,14 @@
+module Controll
+end
+
+require 'hashie'
+require 'imperator-ext'
+require 'controll/errors'
+require 'controll/executor'
+require 'controll/notify'
+require 'controll/flow_handler'
+require 'controll/helper'
+require 'controll/command'
+require 'controll/commander'
+require 'controll/assistant'
+

data/lib/controll/assistant.rb

@@ -0,0 +1,19 @@
+module Controll
+  class Assistant
+    attr_reader :controller, :options
+
+    def initialize controller, options = {}
+      @controller = controller
+      @options = options
+    end
+  end
+end
+
+module Controll
+  class DelegateAssistant < Assistant
+    def method_missing(meth, *args, &block)
+      controller.send(meth, *args, &block)
+    end        
+  end
+end
+

data/lib/controll/command.rb

@@ -0,0 +1,24 @@
+module Controll
+  class Command < ::Imperator::Command
+    module Delegation
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :session, :params, :notify, :error, :do_redirect, :do_render, to: :initiator
+
+        alias_method :redirect, :do_redirect
+        alias_method :render, :do_render
+      end
+    end
+
+    include Delegation    
+  end
+
+  if defined?(::Mongoid)
+    module Mongoid
+      class Command < ::Imperator::Mongoid::Command
+        include Controll::Command::Delegation
+      end
+    end
+  end
+end

data/lib/controll/commander.rb

@@ -0,0 +1,24 @@
+module Controll
+  # used to register commands for a controller
+  class Commander
+    # makes #command_method available
+    extend Imperator::Command::MethodFactory
+
+    attr_reader :controller, :options
+
+    def initialize controller, options = {}
+      @controller = controller
+      @options = options
+    end
+
+    def command name, *args
+      send "#{name}_command", *args
+    end
+
+    def command! name, *args
+      command(name, *args).perform
+    end
+    alias_method :use_command, :command!
+    alias_method :perform_command, :command!
+  end
+end

data/lib/controll/errors.rb

@@ -0,0 +1 @@
+class Controll::InvalidEvent < StandardError; end

data/lib/controll/executor.rb

@@ -0,0 +1,6 @@
+module Controll
+  module Executor
+    autoload :Base,         'controll/executor/base'
+    autoload :Notificator,  'controll/executor/notificator'
+  end
+end

data/lib/controll/executor/base.rb

@@ -0,0 +1,16 @@
+module Controll
+  module Executor
+    class Base
+      attr_accessor :initiator, :options
+
+      def initialize initiator, options = {}
+        @initiator = initiator
+        @options = options
+      end
+
+      def method_missing(meth, *args, &block)
+        initiator.send(meth, *args, &block)
+      end
+    end
+  end
+end

data/lib/controll/executor/notificator.rb

@@ -0,0 +1,12 @@
+require 'controll/executor/base'
+
+module Controll::Executor
+  class Notificator < Base
+
+    # return last notification or :success as result
+    # Hashie::Mash.new(name: name, type: type, options: options)
+    def result
+      main_event
+    end
+  end
+end

data/lib/controll/flow_handler.rb

@@ -0,0 +1,11 @@
+require 'controll/flow_handler/errors'
+
+module Controll
+  module FlowHandler
+    autoload :Base,         'controll/flow_handler/base'
+    autoload :Control,      'controll/flow_handler/control'
+    autoload :Redirect,     'controll/flow_handler/redirect'
+    autoload :Render,       'controll/flow_handler/render'    
+    autoload :EventHelper,  'controll/flow_handler/event_helper'    
+  end
+end

data/lib/controll/flow_handler/base.rb

@@ -0,0 +1,19 @@
+module Controll::FlowHandler
+  class Base
+    attr_reader :path
+
+    def initialize path
+      @path = path.to_s
+    end
+
+    def perform controller
+      raise NotImplementedError, 'You must implement the #perform method'
+    end
+
+    class << self
+      def action event
+        raise NotImplementedError, 'You must implement the #action class method'
+      end
+    end
+  end
+end

data/lib/controll/flow_handler/control.rb

@@ -0,0 +1,85 @@
+module Controll::FlowHandler
+  class Control
+    class ActionEventError < StandardError; end
+
+    attr_reader :controller, :action_handlers
+
+    def initialize controller, action_handlers = []
+      @controller = controller
+      @action_handlers = action_handlers unless action_handlers.blank?
+    end
+
+    def execute
+      use_action_handlers
+      use_alternatives
+      use_fallback if !executed?
+      self
+    end
+
+    def action_handlers
+      @action_handlers ||= [:redirect, :render]
+    end
+
+    def executed? 
+      @executed
+    end
+
+    protected
+
+    delegate :command!, to: :controller
+
+    # can be used to set up control logic that fall outside what can be done
+    # with the basic action_handlers but can not be considered fall-back.
+    def use_alternatives
+    end
+
+    def use_fallback  
+    end    
+
+    def event
+      raise NotImplementedError, 'You must define an #event method that at least returns an event (Symbol). You can use an Executor for this.'
+    end
+
+    def fallback_action
+      do_redirect root_url
+    end
+
+    NoEventsDefinedError    = Controll::FlowHandler::Render::NoEventsDefinedError
+    NoRedirectionFoundError = Controll::FlowHandler::Redirect::NoRedirectionFoundError    
+
+    def use_action_handlers
+      errors = []
+      action_handlers.each do |action_handler|
+        begin          
+          action_handler_clazz = handler_class(action_handler)
+          next unless action_handler_clazz
+          action = action_handler_clazz.action(event)
+          execute_with action
+          return if executed?
+        rescue NoEventsDefinedError => e
+          errors << e
+        rescue NoRedirectionFoundError => e
+          errors << e
+        end
+      end
+      raise ActionEventError, "#{errors.join ','}" unless errors.empty?
+    end
+
+    def handler_class action_handler
+      clazz = "#{self.class}::#{action_handler.to_s.camelize}"
+      clazz.constantize
+    rescue NameError
+      nil
+    end
+
+    def execute_with action
+      return if !action
+      action.perform(controller)
+      executed!      
+    end
+
+    def executed!
+      @executed = true
+    end
+  end
+end