bizflow 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16e6dec37607b0ed02eb68da35726f246f6330ef
+  data.tar.gz: b0e87ddc7260ceac3b11ff2195945d0b21184241
+SHA512:
+  metadata.gz: 91b8a225ca5c15582d20d66ae6c0d3344ec4a3463eae5d81b4beb78757c062c9187390047e46231ac0cb77241d02b1c062c3e1ce9ced9cc175957ff7b11372d0
+  data.tar.gz: 1a368432550ed7edae2dbba31230e8b10d4f734ef78579a028bdefd915f6bcb1367486e9d5a34674ab11f986f2c512f5a30c18ba6585cfde5f337fb6b8e60133

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.db
+mkmf.log
+/vendor
+text/.~lock.Master.odt#
+text/.~lock.zbornik.doc#
+text/.~lock.prezentacija.odp#

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bizflow.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 DSljukic
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Bizflow
+
+Bizflow is software for managing business processes.
+Its features are:
+ - DSL for process modeling
+ - Compiling DSL scripts into process models
+ - Creating and managing process instances
+ - Reviewing status of process instances
+
+## Installation
+
+Install sqlite3:
+
+    $ sudo apt-get install sqlite3 libsqlite3-dev
+
+Add this line to your application's Gemfile:
+
+    gem 'bizflow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bizflow
+
+## Usage
+
+Setup config file and place for DSL scripts:
+
+    $ bundle exec bizflow install
+
+Setup internal database:
+  
+    $ bundle exec bizflow setup
+
+Compile:
+
+    $ bundle exec bizflow build
+
+DSL sample:
+
+```ruby
+
+process "make_breakfast" do
+
+  description "creates breakfast"
+  
+  start "check_supplies"
+
+  input_action "check_supplies" do
+    
+    description "checks if there are enaugh eggs, bacon and bread"
+    question "Are there enaugh supplies?"
+
+    next_actions(
+      not_enaugh_supplies: "get_supplies",
+      enaugh_supplies: "make_breakfast"
+    )
+
+  end
+
+  task_action "get_supplies" do
+
+    description "get enaugh eggs, bacon and bread"
+    task "get_bacon", roles: ["storage", "kitchen"], description: "optional description", auto_assign: true
+    task "get_eggs", roles: ["storage", "kitchen"]
+    task "get_bread", roles: ["storage"]
+
+    next_action "make_breakfast"
+
+  end
+
+  task_action "make_breakfast" do
+
+    description "sets stove, fry eggs, roast bacon"
+    task "make_breakfast", roles: ["kitchen"]
+
+    next_action "serve_breakfast"
+    
+  end
+
+  task_action "serve_breakfast" do
+
+    task "prepare_table", roles: ["servers"]
+    task "slice_bread", roles: ["kitchen"]
+
+    next_action "process:finish"
+
+  end
+
+
+end
+
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bizflow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/bizflow

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+require "bizflow/command/command_helper"
+
+config = {}
+
+if(!["help", "install"].include? command)
+  begin
+    require "#{Dir.pwd}/bizflow_config"
+    config = BizflowConfig::Config
+  rescue LoadError
+    puts "run bizflow install before continuing"
+    abort
+  end
+end
+
+if Bizflow::CommandHelper::CommandHash.keys.include?(command.to_sym)
+  Bizflow::CommandHelper::CommandHash[command.to_sym].run(config, args: args)
+else
+  puts "command '#{command}' not recognized"
+end

data/bizflow.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bizflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bizflow"
+  spec.version       = Bizflow::VERSION
+  spec.authors       = ["DSljukic"]
+  spec.email         = ["uraniumsheep@gmail.com"]
+  spec.summary       = %q{DSL for business processes.}
+  spec.description   = %q{DSL for buisness processes.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3.10'
+  spec.add_runtime_dependency 'sequel'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "database_cleaner"
+end

data/lib/bizflow/business_model/handler.rb

@@ -0,0 +1,13 @@
+module Bizflow
+  module BusinessModel
+    
+    class Handler < SimpleWrapper
+
+      def handle
+        raise NotImplementedError
+      end
+
+    end
+
+  end
+end

data/lib/bizflow/business_model/head.rb

@@ -0,0 +1,34 @@
+require_relative 'simple_wrapper'
+require_relative 'handler'
+require_relative 'task_action'
+require_relative 'input_action'
+require_relative 'process'
+
+module Bizflow
+  module BusinessModel
+
+    class Head < SimpleWrapper
+
+      ActionHash = {
+        task: Bizflow::BusinessModel::TaskAction,
+        input: Bizflow::BusinessModel::InputAction
+      }
+
+      def jump(next_id = nil)
+
+        if next_id.nil?
+          Bizflow::BusinessModel::Process.wrap(process).finish
+          return
+        end
+
+        update(action_id: next_id)
+        raise "Head does not point to an action" unless action
+        bus_action = ActionHash[action.type.to_sym].new(action)
+        bus_action.resolve
+        
+      end
+
+    end
+
+  end
+end

data/lib/bizflow/business_model/input_action.rb

@@ -0,0 +1,47 @@
+require_relative 'simple_wrapper'
+require 'bizflow/lib/callbackable'
+
+module Bizflow
+  module BusinessModel
+
+    class InputAction < SimpleWrapper
+
+      include Bizflow::Lib::Callbackable
+
+      def resolve
+        
+      end
+
+      def submit_input(input, &block)
+
+        raise "must have an input" if(input.nil? || input.empty?)
+        setup_callbacks(&block)
+
+        if(heads.nil? || heads.empty?)
+          callback(:not_active,
+            data: self,
+            message: "Action is not active, there are no process heads pointing to this action. No inputs can be submited to inactive actions.")
+          return
+        end        
+
+        na = next_actions.select { |item| item.ending == input }
+
+        if(na.nil? || na.empty?)
+          callback(:bad_input,
+            data: self,
+            message: "Input is not valid. Valid inputs for #{name} are #{next_actions.map(&:ending).join(", ")}")
+          return
+        end
+
+        next_action = na.first
+        bhs = Bizflow::BusinessModel::Head.wraps(heads)
+        bhs.each { |h| h.jump(next_action.next_id) }
+
+        callback(:success, data: self, message: "Input submitted to the process successfully.")
+
+      end
+
+    end
+
+  end
+end

data/lib/bizflow/business_model/process.rb

@@ -0,0 +1,46 @@
+require_relative 'simple_wrapper'
+require_relative 'head'
+require 'bizflow/lib/callbackable'
+require 'bizflow/lib/process_builder'
+
+module Bizflow
+  module BusinessModel
+
+    class Process < SimpleWrapper
+
+      include Bizflow::Lib::Callbackable
+
+      def start(runner_id, &block)
+
+        setup_callbacks(&block)
+        
+        if runned_at != nil
+          callback(:already_started, data: self, message: "process has already been started") and return 
+        end
+        
+        ph = Bizflow::BusinessModel::Head.wrap(head)
+        ph.jump(start_action_id)
+        update(runner_id: runner_id, runned_at: Time.now)
+        
+        callback(:success, data: self, message: "process started successfully")
+
+      end
+
+      def finish
+        update(finished_at: Time.now)
+      end
+
+      def self.create_process(blueprint_id, creator_id)
+        Bizflow::Lib::ProcessBuilder.new.build(blueprint_id, creator_id)
+      end
+
+      private
+
+      def start_action
+        Bizflow::DataModel::Action[start_action_id]
+      end
+
+    end
+
+  end
+end

data/lib/bizflow/business_model/simple_wrapper.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+
+module Bizflow
+  module BusinessModel
+    
+    class SimpleWrapper < SimpleDelegator
+
+      def self.wrap(item)
+        new item
+      end
+
+      def self.wraps(items)
+        res = items.map do |item|
+          new item
+        end
+
+        res
+      end
+    end
+
+  end
+end

data/lib/bizflow/business_model/task.rb

@@ -0,0 +1,41 @@
+require_relative 'simple_wrapper'
+require 'bizflow/lib/callbackable'
+
+module Bizflow
+  module BusinessModel
+
+    class Task < SimpleWrapper
+
+      include Bizflow::Lib::Callbackable
+
+      def assign(user_id, &block)
+        setup_callbacks(&block)
+
+        if(finished_at != nil)
+          callback(:already_finished, data: self, message: "Task has already been finished.")
+          return
+        end
+
+        update(assignee_id: user_id)
+
+        callback(:success, data: self, message: "Task assigned successfully.")
+      end
+
+      def finish(user_id, &block)
+        setup_callbacks(&block)
+
+        if(finished_at != nil)
+          callback(:already_finished, data: self, message: "Task has already been finished.")
+          return
+        end
+
+        update(finished_at: Time.now)
+        Bizflow::BusinessModel::TaskAction.wrap(action).task_finished
+
+        callback(:success, data: self, message: "Task has been finished successfully.")
+      end
+
+    end
+    
+  end
+end

data/lib/bizflow/business_model/task_action.rb

@@ -0,0 +1,36 @@
+require_relative 'simple_wrapper'
+
+module Bizflow
+  module BusinessModel
+
+    class TaskAction < SimpleWrapper
+
+      def resolve
+        action_blueprint.task_blueprints.each do |tbp|
+          add_task(name: tbp.name, task_blueprint: tbp)
+        end
+      end
+
+      def finish
+        bhs = Bizflow::BusinessModel::Head.wraps(heads)
+        bp = Bizflow::BusinessModel::Process.wrap(process)
+        next_action_id = next_action ? next_action.id : nil
+        bhs.each { |h| h.jump(next_action_id) }
+      end
+
+      def next_action
+        nexts.first
+      end
+
+      def active
+        tasks_dataset.where(finished_at: nil).all
+      end
+
+      def task_finished
+        finish if active.empty?
+      end
+
+    end
+
+  end
+end

data/lib/bizflow/command/build_command.rb

@@ -0,0 +1,33 @@
+require "sqlite3"
+require 'sequel'
+
+module Bizflow
+  class BuildCommand
+
+    def self.run(config, args = [])
+
+      puts "Building processes..."
+
+      require 'bizflow/lib/semantic_builder'
+
+      source_path = args[0] || config[:source_path]
+      raise "dsl source path not specified" if source_path.nil?
+      source_path = "#{Dir.pwd}/#{source_path}"
+      domain_repo = Bizflow::Lib::SemanticBuilder.new(source_path).build
+
+      raise "bizflow database path not specified" if config[:db_path].nil?
+      db_path = "#{Dir.pwd}/#{config[:db_path]}"
+      db = Sequel.sqlite(db_path)
+
+      Dir["#{File.dirname(__FILE__)}/../model/*.rb"].each { |path| require_relative path }
+
+      require 'bizflow/lib/blueprint_builder'
+
+      Bizflow::Lib::BlueprintBuilder.new.build(domain_repo)
+
+      puts "Processes built"
+
+    end
+
+  end
+end

data/lib/bizflow/command/clean_command.rb

@@ -0,0 +1,9 @@
+module Bizflow
+  class CleanCommand
+
+    def self.run(config, args)
+      puts "All cleaned... not realy"
+    end
+
+  end
+end

data/lib/bizflow/command/command_helper.rb

@@ -0,0 +1,19 @@
+require "bizflow/command/build_command"
+require "bizflow/command/help_command"
+require "bizflow/command/clean_command"
+require "bizflow/command/install_command"
+require "bizflow/command/setup_command"
+
+module Bizflow
+  class CommandHelper
+
+    CommandHash = {
+      :help => Bizflow::HelpCommand,
+      :build => Bizflow::BuildCommand,
+      :clean => Bizflow::CleanCommand,
+      :install => Bizflow::InstallComand,
+      :setup => Bizflow::SetupCommand
+    }
+
+  end
+end

data/lib/bizflow/command/help_command.rb

@@ -0,0 +1,11 @@
+module Bizflow
+  class HelpCommand
+
+    def self.run(config, args)
+      puts "run one of these commands like this:"
+      puts "bizflow COMMAND_NAME [ARGS]"
+      puts "commands:\n#{Bizflow::CommandHelper::CommandHash.keys.join("\n")}"
+    end
+
+  end
+end

data/lib/bizflow/command/install_command.rb

@@ -0,0 +1,16 @@
+require 'bizflow/config_generator'
+require 'fileutils'
+
+module Bizflow
+  class InstallComand
+
+    def self.run(config, args)
+      cg = Bizflow::ConfigGenerator.new()
+      cg.generate
+      puts "bizflow_config created in root path"
+
+      FileUtils::mkdir_p "#{Dir.pwd}/bizflow_processes"
+    end
+
+  end
+end

data/lib/bizflow/command/setup_command.rb

@@ -0,0 +1,29 @@
+require "sqlite3"
+require 'sequel'
+require 'fileutils'
+require 'pathname'
+
+module Bizflow
+  class SetupCommand
+
+    def self.run(config, args)
+
+      Sequel.extension :migration, :core_extensions
+
+      # Create a database
+      puts "Creating and migrating database for processes..."
+
+      db_path = config[:db_path] || "bizflow_db/bf.db"
+      db_path = "#{Dir.pwd}/#{db_path}"
+
+      pn = Pathname.new(db_path)
+      FileUtils::mkdir_p pn.dirname.to_s
+
+      db = Sequel.sqlite(db_path)
+
+      Sequel::Migrator.run(db, File.expand_path("#{File.expand_path(File.dirname(__FILE__))}/../migrations"), :use_transactions=>true)
+      puts "Database setup"
+    end
+
+  end
+end

data/lib/bizflow/config_generator.rb

@@ -0,0 +1,16 @@
+require 'erb'
+
+module Bizflow
+  class ConfigGenerator
+
+    RbTemplatesPath = "#{File.dirname(__FILE__)}/templates/rb"
+
+    def generate
+      process_source = ERB.new(File.read("#{RbTemplatesPath}/config.tt"), nil, '-').result()
+      out_file = File.new("#{Dir.pwd}/bizflow_config.rb", "w")
+      out_file.puts(process_source)
+      out_file.close
+    end
+
+  end
+end

data/lib/bizflow/data_model/action.rb

@@ -0,0 +1,22 @@
+require 'sequel'
+
+module Bizflow
+
+  module DataModel
+
+    class Action < Sequel::Model
+
+      one_to_many :tasks
+      one_to_many :heads
+      one_to_many :handlers
+      many_to_one :process
+      many_to_one :action_blueprint
+
+      one_to_many :next_actions
+      many_to_many :nexts, class: :'Bizflow::DataModel::Action', :join_table => :next_actions
+
+    end
+
+  end
+
+end

data/lib/bizflow/data_model/action_blueprint.rb

@@ -0,0 +1,22 @@
+require 'sequel'
+
+module Bizflow
+
+  module DataModel
+
+    class ActionBlueprint < Sequel::Model
+
+      many_to_one :process_blueprint
+      one_to_many :handler_blueprints
+      one_to_many :task_blueprints
+      one_to_many :actions
+
+      one_to_many :next_action_blueprints
+      many_to_many :next_blueprints, :join_table => :next_action_blueprints
+
+    end
+
+  end
+
+end
+

data/lib/bizflow/data_model/handler.rb

@@ -0,0 +1,16 @@
+require 'sequel'
+
+module Bizflow
+
+  module DataModel
+
+    class Handler < Sequel::Model
+
+      many_to_one :action
+
+    end
+
+  end
+
+end
+