automation_object 0.5.0 → 0.5.1

data/lib/automation_object/dsl/blue_print_adapter.rb

@@ -1,16 +0,0 @@
-require_relative 'blue_print_adapter/top'
-
-module AutomationObject
-  module Dsl
-    #BluePrint adapter for building DSL framework
-    #Follows similar pattern to BluePrint::HashAdapter composite
-    module BluePrintAdapter
-      # @param args [Hash] expects :blue_prints, :state
-      # @return [AutomationObject::Dsl::Models::Top]
-      def self.build(args={})
-        blue_print_adapter = Top.new(blue_prints: args.fetch(:blue_prints))
-        return blue_print_adapter.build
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/composite.rb

@@ -1,54 +0,0 @@
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #Base class for the DSL BluePrint adapter composite
-      #BluePrintAdapter uses the BluePrint composite to create the proxy/model composite in the DSL
-      class Composite
-        class << self;
-          attr_accessor :implemented_proxy
-        end
-
-        # @param args [Hash] arguments, expects :blue_prints
-        def initialize(args={})
-          @blue_prints = args.fetch :blue_prints
-        end
-
-        # Build and return the DSL composite
-        # @return [Object] composite for the given level
-        def build
-          proxy = self.class.implemented_proxy.new
-
-          self.class.has_many_relationships.each { |name, composite_class|
-            @blue_prints.send(name).each { |child_key, child_blue_prints|
-              child_composite = composite_class.new(blue_prints: child_blue_prints)
-              child_proxy = child_composite.build
-
-              type = name.to_s.gsub(/e?s$/, '').to_sym #Unpluralize
-              proxy.add(name: child_key, type: type, object: child_proxy)
-            }
-          }
-
-          return proxy
-        end
-
-        #Declare which proxy is being used by the given BluePrint::Adapter composite class
-        # @param proxy_class [Class] proxy class used by the given composite
-        def self.implements_proxy(proxy_class)
-          self.implemented_proxy = proxy_class
-        end
-
-        #Has many children relationship for the composite
-        # @param children_name [Symbol] name of the children, should be a BluePrint method
-        # @param args [Hash] additional arguments, expects interface
-        def self.has_many(children_name, args)
-          self.has_many_relationships[children_name] = args.fetch(:interface)
-        end
-
-        # @return [Hash] relationships for the composite
-        def self.has_many_relationships
-          @has_many_relationships ||= Hash.new
-        end
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/element.rb

@@ -1,14 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/element'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #Element BluePrint adapter composite
-      class Element < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::Element
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/element_array.rb

@@ -1,14 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/element_array'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #ElementArray BluePrint adapter composite
-      class ElementArray < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::ElementArray
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/element_hash.rb

@@ -1,14 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/element_hash'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #ElementHash BluePrint adapter composite
-      class ElementHash < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::ElementHash
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/modal.rb

@@ -1,23 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/modal'
-
-require_relative 'element'
-require_relative 'element_array'
-require_relative 'element_hash'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #Modal BluePrint adapter composite
-      class Modal < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::Modal
-
-        #Children for this composite
-        has_many :elements, interface: Element
-        has_many :element_arrays, interface: ElementArray
-        has_many :element_hashes, interface: ElementHash
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/screen.rb

@@ -1,26 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/screen'
-
-require_relative 'modal'
-require_relative 'element'
-require_relative 'element_array'
-require_relative 'element_hash'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #Screen BluePrint adapter composite
-      class Screen < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::Screen
-
-        #Children for this composite
-        has_many :modals, interface: Modal
-
-        has_many :elements, interface: Element
-        has_many :element_arrays, interface: ElementArray
-        has_many :element_hashes, interface: ElementHash
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/blue_print_adapter/top.rb

@@ -1,19 +0,0 @@
-require_relative 'composite'
-require_relative '../proxies/top'
-
-require_relative 'screen'
-
-module AutomationObject
-  module Dsl
-    module BluePrintAdapter
-      #Top BluePrint adapter composite
-      class Top < Composite
-        #Which proxy to create for this composite
-        implements_proxy AutomationObject::Dsl::Proxies::Top
-
-        #Children for this composite
-        has_many :screens, interface: Screen
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/models.rb

@@ -1,18 +0,0 @@
-module AutomationObject
-  module Dsl
-    module Models
-      class Top < OpenStruct;
-      end
-      class Screen < OpenStruct;
-      end
-      class Modal < OpenStruct;
-      end
-      class Element < OpenStruct;
-      end
-      class ElementHash < OpenStruct;
-      end
-      class ElementArray < OpenStruct;
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/element.rb

@@ -1,16 +0,0 @@
-require_relative '../../proxies/proxy'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #Element proxy for model
-    class Element < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = nil
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/element_array.rb

@@ -1,16 +0,0 @@
-require_relative '../../proxies/proxy'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #ElementArray proxy for model
-    class ElementArray < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = nil
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/element_hash.rb

@@ -1,16 +0,0 @@
-require_relative '../../proxies/proxy'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #ElementHash proxy for model
-    class ElementHash < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = nil
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/helpers/composite_helper.rb

@@ -1,74 +0,0 @@
-module AutomationObject::Dsl
-  module Proxies
-    #CompositeHelper for DSL Proxies
-    #Proxies will deal with the State and wrap around the models
-    module CompositeHelper
-      attr_accessor :state
-
-      # @param state [AutomationObject::State::Session]
-      def state=(state)
-        @state = state
-        self.children.each { |child|
-          @subject[child].state = @state
-        }
-      end
-
-      # @return [Array] hooks array or empty array
-      def hooks
-        @hooks ||= Array.new
-      end
-
-      # @return [Hash] composite hooks or empty hash
-      def composite_hooks
-        @composite_hooks ||= Hash.new
-      end
-
-      # @return [Array] children array or empty array
-      def children
-        @children ||= Array.new
-      end
-
-      # Use this to add children to the DSL composite
-      # @param args [Hash] arguments for adding a child to this composite
-      def add(args={})
-        name = args.fetch :name
-        @subject[name] = args.fetch :object
-        self.children.push(name)
-
-        type = args.fetch(:type)
-
-        case type
-          when :screen, :modal
-            #Just load
-            self.composite_hooks[name] = lambda { self.request_load(type, name) }
-          when :element, :element_array, :element_hash
-            #Set return to subject
-            self.composite_hooks[name] = lambda { @subject[name] = self.request_load(type, name) }
-        end
-
-        @subject[name].hooks.push(self.composite_hooks[name]) if self.composite_hooks.has_key?(name)
-        return @subject[name]
-      end
-
-      # Request the state to load an object
-      # @param type [Symbol] type of object (:screen, :modal, :element, :etc...)
-      # @param name [Symbol] name of the object
-      def request_load(type, name)
-        @state.load(type, name)
-      end
-
-      #Override to allow for hooks to be run when using the DSL API
-      def method_missing(method_symbol, *args, &block)
-        return super unless self.children.include?(method_symbol)
-
-        self.hooks.each { |hook| hook.call }
-
-        if self.composite_hooks.has_key?(method_symbol)
-          self.composite_hooks[method_symbol].call
-        end
-
-        super
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/modal.rb

@@ -1,17 +0,0 @@
-require_relative '../../proxies/proxy'
-require_relative '../models.rb'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #Modal proxy for model
-    class Modal < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = Models::Modal.new
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/screen.rb

@@ -1,17 +0,0 @@
-require_relative '../../proxies/proxy'
-require_relative '../models.rb'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #Screen proxy for model
-    class Screen < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = Models::Screen.new
-      end
-    end
-  end
-end

data/lib/automation_object/dsl/proxies/top.rb

@@ -1,17 +0,0 @@
-require_relative '../../proxies/proxy'
-require_relative '../models'
-
-require_relative 'helpers/composite_helper'
-
-module AutomationObject::Dsl
-  module Proxies
-    #Top proxy for model
-    class Top < AutomationObject::Proxies::Proxy
-      include CompositeHelper
-
-      def initialize
-        @subject = Models::Top.new
-      end
-    end
-  end
-end

data/lib/automation_object/proxies/proxy.rb

@@ -1,20 +0,0 @@
-module AutomationObject
-  module Proxies
-    #Base Proxy class for getting between another
-    class Proxy
-      instance_methods.each { |instance_method|
-        unless instance_method =~ /(^__|^send$|^object_id)/
-          undef_method instance_method
-        end
-      }
-
-      def initialize(subject)
-        @subject = subject
-      end
-
-      def method_missing(method_symbol, *args, &block)
-        return @subject.send(method_symbol, *args, &block)
-      end
-    end
-  end
-end

data/lib/automation_object/proxies/throttle_proxy.rb

@@ -1,57 +0,0 @@
-require_relative 'proxy'
-
-module AutomationObject
-  module Proxies
-    #Proxy class to throttle methods on the subject
-    class ThrottleProxy < Proxy
-      def initialize(subject)
-        super
-      end
-
-      def throttle_methods
-        @throttle_methods ||= Hash.new
-      end
-
-      def method_missing(method_symbol, *args, &block)
-        start_time = Time.new.to_f
-        execution_return = @subject.send(method_symbol, *args, &block)
-        self.throttle_speed(method_symbol, start_time)
-        return execution_return
-      end
-
-      def add_method_throttle(method_symbol, time)
-        unless method_symbol.is_a?(Symbol)
-          raise ArgumentError, 'Expecting method_symbol argument to be a Symbol'
-        end
-
-        unless time.is_a?(Numeric)
-          raise ArgumentError, 'Expecting time argument to be Numeric'
-        end
-
-        unless @subject.respond_to?(method_symbol)
-          raise ArgumentError, "Expecting object to respond_to? #{method_symbol}"
-        end
-
-        self.throttle_methods[method_symbol] = time
-      end
-
-      #Delete throttle that exists
-      # @param method_symbol [Symbol] method symbol to remove throttle from
-      def delete_method_throttle(method_symbol)
-        self.throttle_methods.delete(method_symbol)
-      end
-
-      #Method to sleep the difference between actual and throttle time
-      # @param method_symbol [Symbol] method that is to be throttled
-      # @param start_time [Float] start time as float
-      # @return [nil]
-      def throttle_speed(method_symbol, start_time)
-        return unless self.throttle_methods.has_key?(method_symbol)
-        total_time_taken = Time.new.to_f - start_time
-
-        sleep_time = self.throttle_methods[method_symbol] - total_time_taken
-        sleep(sleep_time) if sleep_time > 0
-      end
-    end
-  end
-end