stuka 0.0.12 → 0.1.0

data/lib/stuka/internal/source_builders/action_builder.rb

@@ -1,32 +1,102 @@
 require 'stuka/internal/domain_builders/action_domain_builder'
 require 'stuka/internal/source_builders/source_builder'
+require 'stuka/monkeypatch/string_patch'
+require 'tempfile'
+require 'stuka/config/template_config'
 
 module Stuka
 
   class ActionBuilder < SourceBuilder
 
-    def self.build
+    def self.build(stream)
       
       adb = ActionDomainBuilder.new
       adb.build_domain
 
+      template_file_header = "#{templates_path}/source/action_header.tt"
       template_file = "#{templates_path}/source/action.tt"
-      renderer = ERB.new(File.read(template_file))
 
-      FileUtils.mkdir_p Stuka::StukaPaths::PROCESSES_SOURCE_PATH
+      FileUtils.mkdir_p Stuka::StukaPaths.actions_source_path
 
       adb.instances.each do |acc|
-        out_file = File.new("#{source_path}/#{acc.name}_action.rb", "w")
-        out_file.puts(renderer.result(acc.get_binding))
+        action_file_path = "#{source_path}/#{acc.namespace}"
+        FileUtils.mkdir_p action_file_path
+
+        if File.file?("#{action_file_path}/#{acc.name}.rb")
+          stream.puts "action file #{acc.namespace}::#{acc.name} already exists."
+          next
+        end
+
+        # generate action header
+        action_string = ERB.new(File.read(template_file_header)).result(acc.get_binding)
+
+        # generate namespace modules
+        modules = Stuka::TemplateConfig.action_module_namespaces
+        modules.each_with_index do |mod, index|
+          action_string += ("\t" * index)
+          action_string += "module #{mod}\n"
+        end
+
+        action_class = ERB.new(File.read(template_file)).result(acc.get_binding)
+
+        # generate action class with tabs
+        action_class.lines.each do |line|
+          action_string += ("\t" * modules.count)
+          action_string += line
+        end
+
+        # generate module ends
+        modules.each_with_index do |mod, index|
+          action_string += ("\t" * (modules.count - index - 1))
+          action_string += "end\n"
+        end
+
+        # generate end file
+        out_file = File.new("#{source_path}/#{acc.namespace}/#{acc.name}.rb", "w")
+        out_file.puts(action_string)
         out_file.close
+
       end
 
     end
 
     def self.source_path
-      Stuka::StukaPaths::PROCESSES_SOURCE_PATH
+      Stuka::StukaPaths.actions_source_path
+    end
+
+    private
+
+    def self.refresh_action_file(path, action, renderer)
+      temp_file = Tempfile.new('foo')
+      begin
+        File.open(path, 'r') do |file|
+          implementation = ""
+          is_in_implement_section = false
+          file.each_line do |line|
+            if is_in_implement_section
+              if line.strip.start_with? "## END_IMPLEMENTATION"
+                is_in_implement_section = false 
+                next
+              end
+              implementation += line
+            else
+              is_in_implement_section = true if line.strip.start_with? "## IMPLEMENTATION"
+            end
+          end
+          
+          action.implementation = implementation
+          temp_file.puts(renderer.result(action.get_binding))
+
+        end
+        
+        FileUtils.mv(temp_file.path, path)
+
+      ensure
+        temp_file.close
+        temp_file.unlink
+      end
     end
 
   end
 
-end
+end

data/lib/stuka/internal/source_builders/process_builder.rb

@@ -1,6 +1,7 @@
 require 'stuka/internal/domain_builders/process_domain_builder'
 require 'stuka/internal/validator'
 require 'stuka/internal/source_builders/source_builder'
+require 'stuka/monkeypatch/string_patch'
 
 module Stuka
 
@@ -13,24 +14,47 @@ module Stuka
       validator = Stuka::Validator.new
       raise validator.message unless validator.process_set_valid? pdb.instances
 
+      template_file_header = "#{templates_path}/source/process_header.tt"
       template_file = "#{templates_path}/source/process.tt"
-      renderer = ERB.new(File.read(template_file))
 
       FileUtils.mkdir_p source_path
 
-      #raise pdb.instances.to_s
-
       pdb.instances.each do |proc|
         raise validator.message unless validator.process_valid? proc
+
+        # generate action header
+        process_string = ERB.new(File.read(template_file_header)).result(proc.get_binding)
+
+        # generate namespace modules
+        modules = Stuka::TemplateConfig.process_module_namespaces
+        modules.each_with_index do |mod, index|
+          process_string += ("\t" * index)
+          process_string += "module #{mod}\n"
+        end
+
+        process_class = ERB.new(File.read(template_file)).result(proc.get_binding)
+
+        # generate action class with tabs
+        process_class.lines.each do |line|
+          process_string += ("\t" * modules.count)
+          process_string += line
+        end
+
+        # generate module ends
+        modules.each_with_index do |mod, index|
+          process_string += ("\t" * (modules.count - index - 1))
+          process_string += "end\n"
+        end
+
         out_file = File.new("#{source_path}/#{proc.name}.rb", "w")
-        out_file.puts(renderer.result(proc.get_binding))
+        out_file.puts(process_string)
         out_file.close
       end
     
     end
 
     def self.source_path
-      Stuka::StukaPaths::PROCESSES_SOURCE_PATH
+      Stuka::StukaPaths.processes_source_path
     end
 
   end

data/lib/stuka/monkeypatch/string_patch.rb

@@ -0,0 +1,12 @@
+unless "foo_bar".respond_to? :camelcase_notation
+
+  class String
+
+    def camelcase_notation
+      return self if self !~ /_/ && self =~ /[A-Z]+.*/
+      split('_').map{|e| e.capitalize}.join
+    end
+
+  end
+
+end

data/lib/stuka/templates/configs/stuka_config.tt

@@ -0,0 +1,11 @@
+module StukaConfig
+
+  ProcessDefinitionPath = "process_definition"
+  ProcessSourcePath = "lib/processes"
+  ActionSourcePath = "lib/actions"
+
+  ActionModuleNamespaces = ["Actions"]
+  ProcessModuleNamespaces = ["Processes"]
+  AddRequires = false
+
+end

data/lib/stuka/templates/samples/process_file.tt

@@ -0,0 +1,39 @@
+##
+#
+# process "some_process" do
+#   
+#   description "description of a process
+#   should be concise and long enaugh for
+#   new people to understand what the process does."
+# 
+#   start_action "sample::action1"
+# 
+#   action_ending "sample::action1",
+#     success: "sample::action2",
+#     failure: "process::failure"
+# 
+#   action_ending "sample::action2",
+#     success: "process::success",
+#     failure: "process::failure"
+# 
+# end
+# 
+# action "action1" do
+#   
+#   description "the namespace is the name of the folder
+#   under which this action will be placed in the filesystem.
+#   'process' is a reserved namespace used for sending messages to process"
+# 
+#   namespace "sample"
+# end
+# 
+# action "action2" do
+#   
+#   description <<-DESC
+#   all actions used in the process
+#   must be defined, if an action is missing the stuka:build task will not pass"
+#   DESC
+#
+#   namespace "sample"
+# end
+# 

data/lib/stuka/templates/source/action.tt

@@ -1,9 +1,9 @@
-module <%= @namespace.capitalize %>
-  class <%= @name.capitalize %>Action
+module <%= @namespace.camelcase_notation %>
+  class <%= @name.camelcase_notation %> < Stuka::External::BusinessAction
 
-    def initialize params, options = {}
-      @params = params
+    def run(params)
+      # knock yourself out
     end
 
   end
-end
+end

data/lib/stuka/templates/source/action_header.tt

@@ -0,0 +1,8 @@
+##<% @description.split("\n").each do |description_line| %><% require "stuka/config/template_config" %>
+# <%= description_line.strip %> <% end %>
+#
+#
+<% if TemplateConfig.add_require_statements %>
+require "stuka/external/business_action"
+<% end %>
+

data/lib/stuka/templates/source/process.tt

@@ -1,23 +1,16 @@
-require 'stuka/external/business_process'
+class <%= @name.camelcase_notation %> < Stuka::External::BusinessProcess
 
-class <%= @name.capitalize %> < Stuka::BusinessProcess
-
-  TRANSITION_MAP = {
-    <% @transitions.keys.each do |action| %>
-    "<%= action %>" => {
-      <% @transitions[action].keys.each do |action_transition| %>
-      <%= action_transition %>: "<%= @transitions[action][action_transition] %>",
+  Blocks = {
+    <% @blocks.each do |block| %>
+    "<%= block.block_name %>" => {
+      action: "<%= block.action_name %>",
+      <% block.block_endings.each do |block_ending, next_block| %><%= block_ending %>: "<%= next_block %>",
       <% end %>
-    },
-    <% end %>
+    },<% end %>
   }
 
-  def transition_map
-    TRANSITION_MAP
-  end
-
-  def start_action
-    "<%= @start_action %>"
+  def start_block
+    "<%= @start_block %>"
   end
 
-end
+end

data/lib/stuka/templates/source/process_header.tt

@@ -0,0 +1,8 @@
+##<% @description.split("\n").each do |description_line| %><% require "stuka/config/template_config" %>
+# <%= description_line.strip %> <% end %>
+#
+#
+<% if TemplateConfig.add_require_statements %>
+require "stuka/external/business_process"
+<% end %>
+

data/lib/stuka/templates/tasks/stuka.tt

@@ -1,28 +1,36 @@
-task :clean do
-  
-  puts "running clean"
-  require 'stuka/internal/process_cleaner'
-  Stuka::ProcessCleaner.clean
-  puts "clean finished"
+namespace :stuka do
 
-end
+  desc "deletes all process files"
+  task :clean do
+    
+    puts "running clean"
+    require 'stuka/internal/process_cleaner'
+    Stuka::ProcessCleaner.clean
+    puts "clean finished"
 
-task :build_processes do
+  end
 
-  puts "running build processes"
-  require 'stuka/internal/source_builders/process_builder'
-  Stuka::ProcessBuilder.build
-  puts "build processes finished"
+  desc "builds process files"
+  task :build_processes do
 
-end
+    puts "running build processes"
+    require 'stuka/internal/source_builders/process_builder'
+    Stuka::ProcessBuilder.build
+    puts "build processes finished"
 
-task :build_actions do
+  end
 
-  puts "running build actions"
-  require 'stuka/internal/source_builders/action_builder'
-  Stuka::ActionBuilder.build
-  puts "build actions finished"
+  desc "builds action files"
+  task :build_actions do
 
-end
+    puts "running build actions"
+    require 'stuka/internal/source_builders/action_builder'
+    Stuka::ActionBuilder.build($stdout)
+    puts "build actions finished"
 
-task :build => [:clean, :build_processes, :build_actions]
+  end
+
+  desc "cleans process files, builds/updates action files"
+  task :build => [:clean, :build_processes, :build_actions]
+
+end

data/lib/stuka/version.rb

@@ -1,3 +1,3 @@
 module Stuka
-  VERSION = "0.0.12"
+  VERSION = "0.1.0"
 end

data/lib/stuka.rb

@@ -1 +1,7 @@
 require_relative "stuka/version"
+
+require 'stuka/external/action_finder'
+require 'stuka/external/business_action'
+require 'stuka/external/business_process'
+require 'stuka/external/dispatcher'
+require 'stuka/external/unknown_action'

data/spec/aceptance/commands/process_command_spec.rb

@@ -12,10 +12,10 @@ describe "process file command" do
 
   it "sets up the project" do
     Dir.chdir "test_pro" do
-      expect { Stuka::StukaCli.start ["process", "test_process"] }.to output(%r|Process file 'test_process.rb' created|).to_stdout
+      expect { Stuka::StukaCli.start ["process", "test_process"] }.to output(%r|create  process_definition/business/test_process.rb|).to_stdout
       
-      definition_files = Dir["#{Stuka::StukaPaths::PROCESSES_DEFINITION_PATH}/**/*.rb"]
-      expect { definition_files.to include("#{Stuka::StukaPaths::PROCESSES_DEFINITION_PATH}/test_process.rb}") }
+      definition_files = Dir["#{Stuka::StukaPaths.processes_definition_path}/**/*.rb"]
+      expect { definition_files.to include("#{Stuka::StukaPaths.processes_definition_path}/test_process.rb}") }
     end
   end
 

data/spec/aceptance/external/action_aceptance_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 require "stuka/external/business_action"
-require_relative 'processes/cat/check_food'
+require_relative 'actions/cat/check_food'
 
 describe "CheckFood" do
 
   let(:process) { double(transition: nil, can_transition_to?: true) }
   let(:outstream)  { StringIO.new }
-  let(:action) { Cat::CheckFood.new(process) }
+  let(:action) { Actions::Cat::CheckFood.new(process) }
 
   after :each do
     outstream.close

data/spec/aceptance/external/actions/cat/check_food.rb

@@ -0,0 +1,16 @@
+require "stuka/external/business_action"
+
+module Actions
+  module Cat
+
+    class CheckFood < Stuka::External::BusinessAction
+
+      def run(params)
+        params[:outstream].puts "There is enaugh food"
+        has_food(params)
+      end
+
+    end
+
+  end
+end

data/spec/aceptance/external/actions/cat/fill_up_plate.rb

@@ -0,0 +1,16 @@
+require "stuka/external/business_action"
+
+module Actions
+  module Cat
+
+    class FillUpPlate < Stuka::External::BusinessAction
+
+      def run(params)
+        params[:outstream].puts "#{params[:name]}'s food plate filled up"
+        success(params)
+      end
+
+    end
+
+  end
+end

data/spec/aceptance/external/actions/cat/go_to_store.rb

@@ -0,0 +1,16 @@
+require "stuka/external/business_action"
+
+module Actions
+  module Cat
+
+    class GoToStore < Stuka::External::BusinessAction
+
+      def run(params)
+        params[:outstream].puts "went to store"
+        success(params)
+      end
+
+    end
+
+  end
+end

data/spec/aceptance/external/feed_cat_process_aceptance_spec.rb

@@ -6,21 +6,12 @@ describe "Feed cat process" do
 
   before :each do
     Stuka::StukaPaths::PROCESSES_SOURCE_PATH.replace "#{File.dirname(__FILE__)}/processes"
+    Stuka::StukaPaths::ACTIONS_SOURCE_PATH.replace "#{File.dirname(__FILE__)}/actions"
   end
 
   let(:process) do
 
-    FeedCatProcess.new({}) do |on|
-      
-      on.success { |params|
-        params[:outstream].puts "yay success"
-      }
-      
-      on.failure { |params|
-        params[:outstream].puts "nay failure"
-      }
-
-    end
+    FeedCatProcess.new({})
 
   end
 
@@ -32,11 +23,21 @@ describe "Feed cat process" do
 
   it "process starts executing actions when it ran" do
 
-    expect(process.current_state).to eq(Stuka::BusinessProcess::PROCESS_STATES[:inactive])
+    expect(process.current_state).to eq(Stuka::External::BusinessProcess::PROCESS_STATES[:inactive])
   
-    process.run({name: "George", outstream: outstream})
+    process.run({name: "George", outstream: outstream}) do |on|
+      
+      on.success { |params|
+        params[:outstream].puts "yay success"
+      }
+      
+      on.failure { |params|
+        params[:outstream].puts "nay failure"
+      }
+
+    end
 
-    expect(process.current_state).to eq(Stuka::BusinessProcess::PROCESS_STATES[:finished])
+    expect(process.current_state).to eq(Stuka::External::BusinessProcess::PROCESS_STATES[:finished])
 
     expect(outstream.string).to include "There is enaugh food\nGeorge's food plate filled up\nyay success\n"
 

data/spec/aceptance/external/processes/feed_cat_process.rb

@@ -1,28 +1,27 @@
 require "stuka/external/business_process"
 
-class FeedCatProcess < Stuka::BusinessProcess
+class FeedCatProcess < Stuka::External::BusinessProcess
 
-  TRANSITION_MAP = {
-    "cat::check_food" => {
-      has_food: "cat::fill_up_plate",
-      no_food: "cat::go_to_store"
+  Blocks = {
+    "check_food" => {
+      action: "cat::check_food",
+      has_food: "fill_up_plate",
+      no_food: "go_to_store"
     },
-    "cat::fill_up_plate" => {
+    "fill_up_plate" => {
+      action: "cat::fill_up_plate",
       success: "process::success",
       failure: "process::failure"
     },
-    "cat::go_to_store" => {
-      success: "cat::fill_up_plate",
+    "go_to_store" => {
+      action: "cat::go_to_store",
+      success: "fill_up_plate",
       failure: "process::failure"
     }
   }
 
-  def transition_map
-    TRANSITION_MAP
-  end
-
-  def start_action
-    "cat::check_food"
+  def start_block
+    "check_food"
   end
 
 end

data/spec/spec_helper.rb

@@ -19,9 +19,10 @@ RSpec.configure do |config|
 # with RSpec, but feel free to customize to your heart's content.
 
   config.before(:each) do
-    require "stuka/paths/stuka_paths"
+    require "stuka/config/stuka_paths"
     Stuka::StukaPaths::PROCESSES_DEFINITION_PATH.replace Stuka::StukaPaths::TEST_PROCESSES_DEFINITION_PATH
     Stuka::StukaPaths::PROCESSES_SOURCE_PATH.replace Stuka::StukaPaths::TEST_PROCESSES_SOURCE_PATH
+    Stuka::StukaPaths::ACTIONS_SOURCE_PATH.replace Stuka::StukaPaths::TEST_ACTIONS_SOURCE_PATH
   end
 
   original_stdout = $stdout

data/spec/unit/external/example_source/{world → actions/world}/gather_materials.rb

@@ -2,7 +2,7 @@ require "stuka/external/business_action"
 
 module World
 
-  class GatherMaterials < Stuka::BusinessAction
+  class GatherMaterials < Stuka::External::BusinessAction
 
     def run(params = {})
       success(params)

data/spec/unit/external/example_source/{world → actions/world}/scrap_world.rb

@@ -2,7 +2,7 @@ require "stuka/external/business_action"
 
 module World
 
-  class ScrapWorld < Stuka::BusinessAction
+  class ScrapWorld < Stuka::External::BusinessAction
 
     def run(params = {})
       success(params)

data/spec/unit/external/example_source/{world → actions/world}/seperate_light_from_darkness.rb

@@ -2,7 +2,7 @@ require "stuka/external/business_action"
 
 module World
 
-  class SeperateLightFromDarkness < Stuka::BusinessAction
+  class SeperateLightFromDarkness < Stuka::External::BusinessAction
 
     def run(params = {})
       failure(params)

data/spec/unit/external/example_source/processes/create_world.rb

@@ -0,0 +1,29 @@
+require "stuka/external/business_process"
+
+class CreateWorld < Stuka::External::BusinessProcess
+
+  Blocks = {
+    "gather_materials" => {
+      action: "world::gather_materials",
+      success: "seperate_light_from_dark",
+      failure: "scrap_world"
+    },
+
+    "seperate_light_from_dark" => {
+      action: "world::seperate_light_from_darkness",
+      success: "process::success",
+      failure: "scrap_world"
+    },
+
+    "scrap_world" => {
+      action: "world::scrap_world",
+      success: "process::failure",
+      failure: "process::failure"
+    }
+  }
+
+  def start_block
+    "gather_materials"
+  end
+
+end

data/spec/unit/external/example_source/processes/kill_monster.rb

@@ -0,0 +1,39 @@
+require "stuka/external/business_process"
+
+class KillMonster < Stuka::External::BusinessProcess
+
+  Blocks = {
+    "train_hard" => {
+      action: "monster::train_hard",
+      good_with_sword: "get_a_sharp_sword",
+      sharp_shooter: "get_a_new_gun",
+      failure: "train_fast_running"
+    },
+    "get_a_sharp_sword" => {
+      action: "monster::get_a_sharp_sword",
+      success: "process::success",
+      failure: "process::failure"
+    },
+    "get_a_new_gun" => {
+      action: "monster::get_a_new_gun",
+      success: "get_bullets",
+      failure: "process::failure"
+    },
+    "get_bullets" => {
+      action: "gun::get_bullets",
+      success: "process::success",
+      failure: "process::failure"
+    },
+    "train_fast_running" => {
+      action: "monster::train_fast_running",
+      success: "process::success",
+      failure: "process::failure"
+    }
+
+  }
+
+  def start_block
+    "train_hard"
+  end
+
+end