urist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b8370d9d15bd2a284febc8530d2d7cba7c7f69e
+  data.tar.gz: f97e9d3dd1264f92c978fc45ca05678e5aa7194d
+SHA512:
+  metadata.gz: 6f58af7ef728c2c8e9a456ca84ca3fdf963b68117938ce726859f0e12ca61194ce5ba30cc7af3adfb424193fb63f13078021a413a7a7d000654b62632b0dc044
+  data.tar.gz: 7df39f3102906aa1574d4787e0402688c357274286629559b5e63609f3b7c6a4e186bc95d19fefe8c578dee81545c2300849d6624de19ae9167748ce159a576f

data/lib/urist.rb

@@ -0,0 +1,37 @@
+require 'urist/base'
+require 'urist/uber_waffel'
+require 'urist/runner'
+require 'urist/scenario'
+
+# == How to use: ==
+#
+# A. Fetch all the data you need:
+#   client   = Client.needed_now # instance of some class
+#   price    = 10000.65          # numbers
+#   products = client.products   # arrays
+#
+# B. Assemble them into hash:
+#   information = {:client => client, :price => price, :products => products}
+#
+# C. Create new runner and, well, run it:
+#   runner = Urist.new(:startup_scenario => NewAndLongScenario, :information => information)
+#   result = runner.go!
+#
+# D. Extract the decision and other parameters from result:
+#   decision    = result[:decision]
+#   description = result[:description]
+#   limit       = result[:limit]
+#
+# E. Capture all execution logs
+#   log = runner.logs # array with all results
+#
+# F. Summarize all executed scenarios
+#   scenarios = runner.scenarios # array with all executed scenarios
+#
+# G. You're done!
+
+module Urist
+  def self.new options={}
+    Base.new options
+  end
+end

data/lib/urist/base.rb

@@ -0,0 +1,24 @@
+module Urist
+  class Base
+    attr_accessor :runner
+
+    def initialize options={}
+      @runner = Runner.new options
+    end
+
+    # starts script execution
+    def go!
+      @runner.go!
+    end
+
+    # returns all performed scenarios
+    def scenarios
+      @runner.done_scenarios
+    end
+
+    #  returns all results from all performed scenarios
+    def logs
+      @runner.log
+    end
+  end
+end

data/lib/urist/runner.rb

@@ -0,0 +1,62 @@
+module Urist
+  class Runner
+    attr_accessor :information, :result, :log
+    attr_accessor :active_scenario, :done_scenarios
+
+    def initialize options={}
+      @information     = options[:information] || {}
+      @active_scenario = options[:startup_scenario]
+      @done_scenarios  = []
+      @log             = []
+
+      validate!
+    end
+
+    def go!
+      run_active_scenario while @active_scenario
+
+      return @result
+    end
+
+    private
+      def run_active_scenario
+        check_for_duplicate_scenario!
+        execute_active_scenario!
+        validate_result!
+        log_result!
+        assign_next_scenario!
+      end
+
+      def assign_next_scenario!
+        decision = @result[:decision]
+        @active_scenario = @active_scenario.links[decision]
+      end
+
+      def log_result!
+        @log << @result
+      end
+
+      def validate_result!
+        raise ArgumentError, "Incorrect 'result' in #{@active_scenario.inspect}. Result must be returned as Hash." unless @result.is_a? Hash
+        raise ArgumentError, "Incorrect 'result' in #{@active_scenario.inspect}. Result must include ':decision' key." unless @result.has_key? :decision
+      end
+
+      def execute_active_scenario!
+        @result = @active_scenario.new(:information => @information).logic
+      end
+
+      # raise an exception if detected that scripts start looping
+      def check_for_duplicate_scenario!
+        if @done_scenarios.include? @active_scenario
+          raise RuntimeError, "Current scenario has already been passed. Current #{@active_scenario.inspect}. Previous #{@done_scenarios.last}"
+        else
+          @done_scenarios << @active_scenario
+        end
+      end
+
+      def validate!
+        raise ArgumentError, ":information should be assigned. #{@information.inspect} given." if @information.nil?
+        raise ArgumentError, ":startup_scenario should be assigned. #{@active_scenario.inspect} given." if @active_scenario.nil?
+      end
+  end
+end

data/lib/urist/scenario.rb

@@ -0,0 +1,22 @@
+module Urist
+  class Scenario
+    attr_accessor :information
+
+    # more candies and sugar for scenarios
+    include UberWaffel
+    inheritable_attributes :links
+    @links = {}
+
+    def initialize options={}
+      @information = options[:information]
+
+      validate!
+    end
+
+    private
+      def validate!
+        raise ArgumentError, ":information should be assigned to #{self.class}. #{@information.inspect} given." if @information.nil?
+        raise ArgumentError, "@links should be a Hash in #{self.class}. #{self.class.links.inspect} given." unless self.class.links.is_a? Hash
+      end
+  end
+end

data/lib/urist/uber_waffel.rb

@@ -0,0 +1,30 @@
+module Urist
+  module UberWaffel
+    # adds some metaprogramming magic:
+    # - removes the need for :attr_accessor for @links in every scenario
+    #   since it's an inheritable attribute (with default value already set)
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def inheritable_attributes(*args)
+        @inheritable_attributes ||= [:inheritable_attributes]
+        @inheritable_attributes += args
+        args.each do |arg|
+          class_eval %(
+            class << self; attr_accessor :#{arg} end
+          )
+        end
+        @inheritable_attributes
+      end
+
+      def inherited(subclass)
+        @inheritable_attributes.each do |inheritable_attribute|
+          instance_var = "@#{inheritable_attribute}"
+          subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: urist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Kornienko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies: []
+description: Library for creating of scenarios of business logic
+email: send.this.to.moff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/urist.rb
+- lib/urist/base.rb
+- lib/urist/runner.rb
+- lib/urist/scenario.rb
+- lib/urist/uber_waffel.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Scenario logic library
+test_files: []