stuka 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 738c5a4d28001bffdd43fcbdba89ce68a44528d7
-  data.tar.gz: a76a4a54f9b98695afced640b51046e5c0b6e081
+  metadata.gz: 534bd888be61a7665ca241765836aaf7d2d7acf2
+  data.tar.gz: 76ab2e3e41b43fd8d9ae8b7e0be584777b31124b
 SHA512:
-  metadata.gz: f3467f86ec952c25d98f6e367dfd3d0df4410bfaf07036674690f82eafee07b5a20f266ab81a0d5cbcf8b724475780108054f0ddb3a17388197ba8950add9dbb
-  data.tar.gz: 45d73c21e3345718d21e9b7fb0a42a9b281213aaca07bb090484f36a606481c25ebcbc1f8fe368b805329266548be28106c6fd55cca9e43d809b982f2743e247
+  metadata.gz: 3f0bc41ffabaedd6dcdc1bd7dece3b413756fc0c182d8ac6544398a3bde64daacabf1b15c7bc14bd30d50192a8ff08b85c6e8f28c942b8cd3c073f449a81ceaa
+  data.tar.gz: 645e85427de5fff7f65ff95310e1fe0164d0e1309a921c867faefcc8e59aaab60dd0bd629a98252e5b5b3c6e8466edd4d5428eaa5b6d446212ffbcc93de10f6e

data/lib/stuka/commands/public_commands/setup_command.rb

@@ -6,6 +6,7 @@ module Stuka
   class SetupCommand < Command
 
     def execute
+      Stuka::SetupConfig.new.setup
       Stuka::SetupDirectories.new.setup
       Stuka::SetupGemfile.new.setup
       Stuka::SetupRakefile.new.setup

data/lib/stuka/commands/subcommands/create/create_project.rb

@@ -20,6 +20,7 @@ module Stuka
 
     def setup(name)
       Dir.chdir(name) do
+        SetupConfig.new.setup
         SetupDirectories.new.setup
         SetupGemfile.new.setup
         SetupRakefile.new.setup

data/lib/stuka/commands/subcommands/setup/setup_config.rb

@@ -0,0 +1,21 @@
+require_relative "../../command"
+
+module Stuka
+
+  class SetupConfig < Command
+
+    def setup
+      config_exists = File.file?("#{Dir.pwd}/stuka_config.rb")
+
+      if config_exists
+        say("\tConfig already setup")
+        return
+      end
+
+      template('templates/configs/stuka_config.tt', "stuka_config.rb")
+      say("\tconfig file (stuka_config.rb) setup")
+    end
+
+  end
+
+end

data/lib/stuka/commands/subcommands/setup/setup_directories.rb

@@ -1,4 +1,5 @@
 require_relative "../../command"
+require 'stuka/config/stuka_paths'
 require 'fileutils'
 
 module Stuka
@@ -6,16 +7,16 @@ module Stuka
   class SetupDirectories < Command
 
     def setup
-      processes_dir_exists = File.directory?("#{Dir.pwd}/process_definition/processes")
+      processes_dir_exists = File.directory?("#{Dir.pwd}/#{StukaPaths.relative_processes_source_path}")
 
       if processes_dir_exists
-        say("Stuka dsl source directories are already setup")
+        say("\tStuka dsl source directories are already setup")
         return
       end
 
-      FileUtils.mkdir_p "process_definition"
-
-      say("Source directories setup")
+      FileUtils.mkdir_p "processes_definition"
+      template('templates/samples/process_file.tt', "processes_definition/process_file.rb")
+      say("\tSource directories setup")
    
     end
 

data/lib/stuka/commands/subcommands/setup/setup_gemfile.rb

@@ -8,12 +8,12 @@ module Stuka
       gemfile_exists = File.file?("#{Dir.pwd}/Gemfile")
 
       if gemfile_exists
-        say("Gemfile already setup")
+        say("\tGemfile already setup")
         return
       end
 
       template('templates/configs/gemfile.tt', "Gemfile")
-      say("Gemfile setup, run bundle or bundle install --path vendor/bundle")
+      say("\tGemfile setup, run bundle or bundle install --path vendor/bundle")
     end
 
   end

data/lib/stuka/commands/subcommands/setup/setup_rakefile.rb

@@ -12,7 +12,7 @@ module Stuka
         return
       end
 
-      template('templates/tasks/stuka.tt', "lib/stuka.rake")
+      template('templates/tasks/stuka.tt', "lib/tasks/stuka.rake")
     end
 
   end

data/lib/stuka/config/stuka_paths.rb

@@ -0,0 +1,109 @@
+module Stuka
+
+  module StukaPaths
+
+    RescuableExceptions = [LoadError, NameError]
+
+    def self.processes_definition_path
+
+      config_definition_path = get_config_item("PROCESS_DEFINITION_PATH")
+
+      if config_definition_path
+        return "#{Dir.pwd}/#{config_definition_path}"
+      else
+        PROCESSES_DEFINITION_PATH
+      end
+
+    end
+
+    def self.processes_source_path
+
+      config_source_path = get_config_item("PROCESS_SOURCE_PATH")
+
+      if config_source_path
+        return "#{Dir.pwd}/#{config_source_path}"
+      else
+        PROCESSES_SOURCE_PATH
+      end
+
+    end
+
+    def self.actions_source_path
+
+      config_source_path = get_config_item("ACTIONS_SOURCE_PATH")
+
+      if config_source_path
+        return "#{Dir.pwd}/#{config_source_path}"
+      else
+        ACTIONS_SOURCE_PATH
+      end
+
+    end
+
+    def self.relative_processes_definition_path
+
+      config_item = get_config_item("ProcessDefinitionPath")
+
+      if config_item
+        return config_item
+      else
+        RELATIVE_PROCESSES_DEFINITION_PATH
+      end
+
+    end
+
+    def self.relative_processes_source_path
+
+      config_item = get_config_item("ProcessSourcePath")
+
+      if config_item
+        return config_item
+      else
+        RELATIVE_PROCESSES_SOURCE_PATH
+      end
+
+    end
+
+    def self.relative_actions_source_path
+
+      config_item = get_config_item("ActionSourcePath")
+
+      if config_item
+        return config_item
+      else
+        RELATIVE_ACTIONS_SOURCE_PATH
+      end
+
+    end
+
+    def self.get_config_item(name)
+      begin
+        require_relative "#{Dir.pwd}/stuka_config"
+        return StukaConfig.const_get(name)
+      rescue *RescuableExceptions
+        return false
+      end
+    end
+
+    #defaults
+
+    PROCESSES_DEFINITION_PATH = "#{Dir.pwd}/processes_definition"
+    
+    PROCESSES_SOURCE_PATH = "#{Dir.pwd}/lib/processes"
+    ACTIONS_SOURCE_PATH = "#{Dir.pwd}/lib/actions"
+
+    RELATIVE_PROCESSES_DEFINITION_PATH = "processes_definition"
+    
+    RELATIVE_PROCESSES_SOURCE_PATH = "lib/processes"
+    RELATIVE_ACTIONS_SOURCE_PATH = "lib/actions"
+
+    TEST_PROCESSES_DEFINITION_PATH = "#{File.expand_path(File.dirname(__FILE__))}/../../../spec/unit/internal/processes_dsl_test"
+    TEST_PROCESSES_INCORRECT_DEFINITION_PATH = "#{File.expand_path(File.dirname(__FILE__))}/../../../spec/unit/internal/processes_dsl_test_incorrect"
+
+    TEST_PROCESSES_SOURCE_PATH = "#{File.expand_path(File.dirname(__FILE__))}/../../../spec/unit/internal/processes_source_test"
+    TEST_ACTIONS_SOURCE_PATH = "#{File.expand_path(File.dirname(__FILE__))}/../../../spec/unit/internal/actions_source_test"
+    TEMPLATES_PATH = "#{File.expand_path(File.dirname(__FILE__))}/../templates"
+
+  end
+
+end

data/lib/stuka/config/template_config.rb

@@ -0,0 +1,59 @@
+module Stuka
+
+  module TemplateConfig
+
+    RescuableExceptions = [LoadError, NameError]
+
+    def self.action_module_namespaces
+
+      config_item = get_config_item("ActionModuleNamespaces")
+
+      if config_item
+        return config_item
+      else
+        ACTION_MODULE_NAMESPACES
+      end
+
+    end
+
+    def self.add_require_statements
+
+      add_requires = get_config_item("AddRequires")
+
+      unless add_requires.nil?
+        return add_requires
+      else
+        ADD_REQUIRE_STATEMENTS
+      end
+    
+    end
+
+    def self.process_module_namespaces
+
+      config_item = get_config_item("ProcessModuleNamespaces")
+
+      if config_item
+        return config_item
+      else
+        PROCESS_MODULE_NAMESPACES
+      end
+    
+    end
+
+    def self.get_config_item(name)
+      begin
+        require_relative "#{Dir.pwd}/stuka_config"
+        return StukaConfig.const_get(name)
+      rescue *RescuableExceptions
+        return false
+      end
+    end
+
+    # defaults
+    ACTION_MODULE_NAMESPACES = ["Actions"]
+    PROCESS_MODULE_NAMESPACES = ["Processes"]
+    ADD_REQUIRE_STATEMENTS = true
+
+  end
+
+end

data/lib/stuka/external/action_finder.rb

@@ -1,20 +1,22 @@
 require 'stuka/external/unknown_action'
+require 'stuka/config/stuka_paths'
+require 'stuka/monkeypatch/string_patch'
 
-module Stuka
+module Stuka::External
 
   class ActionFinder
 
     def find_action action, process
       namespace, name = action.split "::"
-      class_namespace = namespace.split('_').collect!{ |w| w.capitalize }.join
-      class_name = name.split('_').collect!{ |w| w.capitalize }.join
+      class_namespace = namespace.camelcase_notation
+      class_name = name.camelcase_notation
       begin
-        clazz = Object.const_get("#{class_namespace}::#{class_name}")
+        clazz = Object.const_get("Actions#{class_namespace}::#{class_name}")
       rescue NameError
-        file_path = "#{Stuka::StukaPaths::PROCESSES_SOURCE_PATH}/#{namespace}/#{name}"
-        raise Stuka::UnknownAction.new(action) unless File.file?("#{file_path}.rb")
+        file_path = "#{Stuka::StukaPaths.actions_source_path}/#{namespace}/#{name}"
+        raise Stuka::External::UnknownAction.new(action) unless File.file?("#{file_path}.rb")
         require_relative file_path
-        clazz = Object.const_get("#{class_namespace}::#{class_name}")
+        clazz = Object.const_get("Actions::#{class_namespace}::#{class_name}")
       end
       clazz.new(process)
     end

data/lib/stuka/external/business_action.rb

@@ -1,4 +1,4 @@
-module Stuka
+module Stuka::External
 
   class BusinessAction
 
@@ -8,9 +8,12 @@ module Stuka
       @process = process
     end
 
-    def method_missing(name, args, &block)
-      super unless @process.can_transition_to? name
-      @process.transition args, name
+    def method_missing(name, args = {}, &block)
+      if @process.can_transition_to?(name)
+        @process.transition args, name
+      else
+        super
+      end
     end
 
   end

data/lib/stuka/external/business_process.rb

@@ -4,31 +4,30 @@ require 'stuka/external/action_finder'
 
 Dir["#{File.dirname(__FILE__)}/process_states/*.rb"].each { |file| require_relative file }
 
-module Stuka
+module Stuka::External
 
   class BusinessProcess
 
     PROCESS_STATES = {
-      inactive: InactiveState.new,
-      starting: StartingState.new,
-      started: StartedState.new,
-      finished: FinishedState.new
+      inactive: ProcessStates::InactiveState.new,
+      started: ProcessStates::StartedState.new,
+      finished: ProcessStates::FinishedState.new
     }
 
     include Observable
 
-    attr_reader :options, :process_id, :start_action, :current_action, :current_state, :process_params, :action_params, :transition_helper, :dispatcher, :action_finder
+    attr_reader :options, :process_id, :start_block, :current_block, :current_action, :current_state, :process_params, :action_params, :dispatcher, :action_finder
 
     def initialize(process_id: nil, options: {}, dispatcher: Dispatcher.new, action_finder: ActionFinder.new)
-      @options = options
       @process_id = process_id
+      @options = options
       @dispatcher = dispatcher
       @action_finder = action_finder
       change_state :inactive
-      yield(@dispatcher) if block_given?
     end
 
     def run(params = {})
+      yield(@dispatcher) if block_given?
       set_process_params params
       transition(params, nil)
     end
@@ -40,14 +39,18 @@ module Stuka
     end
 
     def can_transition_to?(transition)
-      transition_map.has_key?(current_action) && transition_map[current_action].has_key?(transition)
+      blocks.has_key?(current_block) && blocks[current_block].has_key?(transition)
+    end
+
+    def blocks
+      self.class::Blocks
     end
 
     private
 
-    def next_action(transition)
+    def next_block(transition)
       raise "transition not defined" unless can_transition_to?(transition)
-      return transition_map[current_action][transition]
+      return blocks[current_block][transition]
     end
 
     def method_missing(name, args)
@@ -59,8 +62,9 @@ module Stuka
       end
     end
 
-    def set_current_action(new_action)
-      @current_action = new_action
+    def set_current_block(new_block)
+      @current_block = new_block
+      @current_action = blocks[new_block][:action]
     end
 
     def change_state(new_state)

data/lib/stuka/external/dispatcher.rb

@@ -1,4 +1,4 @@
-module Stuka
+module Stuka::External
 
   class Dispatcher
 

data/lib/stuka/external/process_states/finished_state.rb

@@ -1,4 +1,4 @@
-module Stuka
+module Stuka::External::ProcessStates
 
   class FinishedState
 

data/lib/stuka/external/process_states/inactive_state.rb

@@ -1,12 +1,12 @@
-module Stuka
+module Stuka::External::ProcessStates
 
   class InactiveState
 
     def handle_transition(context, transition = nil)
       context.instance_eval do
         change_state(:started)
-        set_current_action(start_action)
-        start_action_instance = action_finder.find_action(start_action, self)
+        set_current_block(start_block)
+        start_action_instance = action_finder.find_action(current_action, self)
         start_action_instance.run(action_params)
       end
     end

data/lib/stuka/external/process_states/started_state.rb

@@ -1,16 +1,17 @@
-module Stuka
+module Stuka::External::ProcessStates
 
   class StartedState
 
     def handle_transition(context, transition)
       context.instance_eval do
-        action_desc = next_action(transition)
-        if action_desc.start_with?("process::")
-          process_message = action_desc.split("::")[1]
+        new_block = next_block(transition)
+        if new_block.start_with?("process::")
+          process_message = new_block.split("::")[1]
           send(process_message.to_sym, action_params)
         else
-          set_current_action(action_desc)
-          action_instance = action_finder.find_action(action_desc, context)
+          set_current_block(new_block)
+          action_name = blocks[new_block][:action]
+          action_instance = action_finder.find_action(action_name, context)
           action_instance.run(action_params)
         end
       end

data/lib/stuka/external/unknown_action.rb

@@ -1,4 +1,4 @@
-module Stuka
+module Stuka::External
 
   class UnknownAction < StandardError
     def initialize(action_name)

data/lib/stuka/internal/domain/action.rb

@@ -4,17 +4,23 @@ module Stuka
 
   class Action < Domain
 
+    # needed durring generation
+    attr_accessor :implementation
+
     # must not be nil
-    ATTRS = ["name", "description", "namespace"]
+    ATTRS = ["name", "description", "namespace", "endings"]
 
     # must not be empty
-    REQUIRED_ATTRS = ["name", "namespace"]
+    REQUIRED_ATTRS = ["name", "namespace", "endings"]
 
-    def initialize(name, description = nil, namespace = nil)
+    def initialize(name, namespace = nil, description = nil, endings = [])
       super()
+      raise "'process' namespace is reserved" if namespace == "process"
       @name = name
       @description = description
       @namespace = namespace
+      @endings = endings.map(&:to_sym)
+      @implementation = ""
     end
 
     # redefined
@@ -27,6 +33,13 @@ module Stuka
       end
     end
 
+    def endings(endings_array = nil)
+      if endings_array
+        @endings = endings_array.map(&:to_sym)
+      else
+        @endings
+      end
+    end
   end
 
 end

data/lib/stuka/internal/domain/process.rb

@@ -4,27 +4,50 @@ module Stuka
 
   class Process < Domain
 
-    attr_reader :transitions
+    attr_reader :blocks
 
     # must not be nil
-    ATTRS = ["name", "description", "start_action"]
+    ATTRS = ["name", "description", "start_block"]
 
     # must not be empty
-    REQUIRED_ATTRS = ["name", "start_action"]
+    REQUIRED_ATTRS = ["name", "start_block"]
 
-    def initialize(name, description = nil, arguments = nil, start_action = nil)
+    def initialize(name, description = nil, arguments = nil, start_block = nil)
       super()
       @arguments = []
       @name = name
       @description = description
       @arguments = arguments
-      @start_action = start_action
-      @transitions = {}
+      @start_block = start_block
+      @blocks = []
     end
 
-    def action_transition(action_name, transition_hash)
-      new_transition = { action_name => transition_hash }
-      transitions.merge!(new_transition)
+    ProcessBlock = Struct.new(:block_name, :action_name, :block_endings) do
+
+      def action(action_name = nil)
+        if action_name
+          self.action_name = action_name
+        else
+          self.action_name
+        end
+      end
+
+      def endings(endings_hash)
+        if endings_hash
+          self.block_endings = endings_hash
+        else
+          self.block_endings
+        end
+      end
+
+    end
+
+    def block(block_name, &block)
+      raise "block method requires a block" unless block_given?
+      process_block = ProcessBlock.new
+      process_block.block_name = block_name
+      process_block.instance_eval(&block)
+      @blocks << process_block
     end
 
   end

data/lib/stuka/internal/domain_builders/action_domain_builder.rb

@@ -6,7 +6,11 @@ module Stuka
   class ActionDomainBuilder < DomainBuilder
 
     def action(name, &block)
-      act = Action.new(name)
+      namespace, action_name = [nil, name]
+      if name.include?("::")
+        namespace, action_name = name.split("::")
+      end
+      act = Action.new(action_name, namespace)
       act.instance_eval(&block)
       @instances << act
       act

data/lib/stuka/internal/domain_builders/domain_builder.rb

@@ -17,7 +17,7 @@ module Stuka
     end
 
     def domain_files
-      Dir["#{Stuka::StukaPaths::PROCESSES_DEFINITION_PATH}/**/*.rb"]
+      Dir["#{Stuka::StukaPaths.processes_definition_path}/**/*.rb"]
     end
 
     def build_domain

data/lib/stuka/internal/process_cleaner.rb

@@ -1,19 +1,15 @@
-require 'stuka/paths/stuka_paths'
+require 'stuka/config/stuka_paths'
 
 module Stuka
 
   class ProcessCleaner
 
     def self.gather_process_files
-      Dir["#{Stuka::StukaPaths::PROCESSES_SOURCE_PATH}/*.rb"]
-    end
-
-    def self.gather_action_files
-      Dir["#{Dir.pwd}/processes/actions/*_action.rb"]
+      Dir["#{Stuka::StukaPaths.processes_source_path}/*.rb"]
     end
 
     def self.clean
-      files = gather_process_files + gather_action_files
+      files = gather_process_files
       files.each do |path|
         File.delete(path)
       end