crabfarm 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc45d8d0e358193e3729c8ca8d38715680470c78
-  data.tar.gz: 30c698146ec3b2d4032cddf4d4b3011af4edaa75
+  metadata.gz: b162bd44fc267ef4526bef924629cec5757e252a
+  data.tar.gz: 75dd81f5efd9266a0ee97d426965e6c44e1f63c2
 SHA512:
-  metadata.gz: 85c7b65ee73ea096635260495077002c74d4891ecab632814de81a474eed2cfc9b9eebbfe4f60a200d927a60e7cbbf00e9910b6988fc9cc73abbee8368bb7163
-  data.tar.gz: 9607b619d00a96ae83a20238492d47897976498bf48e63400e5845765e5585c2bf872d31b2d9803479ee4900ca23433ee6b58c391c05d8441298566716d2e1f4
+  metadata.gz: de642539e7d2b4f0fe156490090222c5cd64c68763f0d6d9c68fb2b896f5c667c30e05b05d545dff9bbfb53c3de700c22e1eddc84c813f499b98dcdcee82930f
+  data.tar.gz: 1fef6418933fc2f6d697214408a294fc0350ab65439a6480ae1dc8deb2df8d9f26b0c1a1dee59cf8415f68aa28e04b7de3aa76ccb7fea29b43b4c7c18fad5094

data/lib/crabfarm/adapters/{capybara_adapter.rb → browser/capybara.rb}

@@ -1,5 +1,5 @@
-module Crabfarm::Adapters
-  class CapybaraAdapter
+module Crabfarm
+  class CapybaraBrowserDsl
     def self.wrap(_bucket)
       raise "Capybara adapter is incompleted"
     end

data/lib/crabfarm/adapters/{surfer_adapter.rb → browser/surfer.rb}

@@ -1,5 +1,7 @@
-module Crabfarm::Adapters
-  class SurferAdapter
+require 'crabfarm/dsl/surfer'
+
+module Crabfarm
+  class SurferBrowserDsl
     def self.wrap(_bucket)
       Crabfarm::Dsl::Surfer::SurfContext.new _bucket
     end

data/lib/crabfarm/adapters/{watir_adapter.rb → browser/watir.rb}

@@ -1,5 +1,7 @@
-module Crabfarm::Adapters
-  class WatirAdapter
+require 'watir-webdriver'
+
+module Crabfarm
+  class WatirBrowserDsl
     def self.wrap(_bucket)
       Watir::Browser.new _bucket.original
     end

data/lib/crabfarm/adapters/output/hash.rb

@@ -0,0 +1,11 @@
+module Crabfarm
+  class HashOutputBuilder
+    def self.prepare
+      Hash.new
+    end
+
+    def self.serialize(_output)
+      _output
+    end
+  end
+end

data/lib/crabfarm/adapters/output/jbuilder.rb

@@ -0,0 +1,13 @@
+require 'jbuilder'
+
+module Crabfarm
+  class JbuilderOutputBuilder
+    def self.prepare
+      Jbuilder.new
+    end
+
+    def self.serialize(_output)
+      _output.attributes!
+    end
+  end
+end

data/lib/crabfarm/adapters/output/ostruct.rb

@@ -0,0 +1,14 @@
+require 'ostruct'
+
+module Crabfarm
+  class OStructOutputBuilder
+    def self.prepare
+      # TODO: maybe wrap open struct in a class that automatically generate other openstruct when nested properties are accessed
+      OpenStruct.new
+    end
+
+    def self.serialize(_output)
+      _output.to_h
+    end
+  end
+end

data/lib/crabfarm/base_parser.rb

@@ -1,26 +1,36 @@
 module Crabfarm
-  class BaseParser
+  class BaseParser < Delegator
 
     attr_reader :browser, :params
 
     def self.browser_dsl(_dsl)
-      @dsl = _dsl
+      @browser_dsl = _dsl
     end
 
     def initialize(_module, _driver, _params)
-      dsl_class = Adapters.load_from_dsl_name(class_dsl || _module.settings.default_dsl)
+      dsl_class = Strategies.load(:browser_dsl, class_browser_dsl || _module.settings.browser_dsl)
       @browser = dsl_class.wrap _driver
       @params = _params
+
+      super @browser
     end
 
     def parse
       raise NotImplementedError.new
     end
 
+    def __getobj__
+      @browser
+    end
+
+    def __setobj__(obj)
+      @browser = obj
+    end
+
   private
 
-    def class_dsl
-      self.class.instance_variable_get :@dsl
+    def class_browser_dsl
+      self.class.instance_variable_get :@browser_dsl
     end
   end
 end

data/lib/crabfarm/base_state.rb

@@ -1,14 +1,21 @@
+require 'thwait'
+require 'crabfarm/forked_state'
+
 module Crabfarm
   class BaseState
     extend Forwardable
 
-    attr_reader :params
+    attr_reader :params, :output
 
     def_delegators :@pool, :driver
     def_delegators :@store, :get, :fetch
 
     def self.browser_dsl(_dsl)
-      @class_dsl = _dsl
+      @class_browser_dsl = _dsl
+    end
+
+    def self.output_builder(_builder)
+      @class_output_builder = _builder
     end
 
     def initialize(_module, _pool, _store, _params)
@@ -16,8 +23,9 @@ module Crabfarm
       @pool = _pool
       @store = _store
       @params = _params
-      @output = Jbuilder.new
-      @dsl = Adapters.load_from_dsl_name(class_dsl || @module.settings.default_dsl)
+
+      @dsl = Strategies.load(:browser_dsl, class_browser_dsl || @module.settings.browser_dsl)
+      @builder = Strategies.load(:output_builder, class_output_builder || @module.settings.output_builder)
     end
 
     def browser(_name=nil)
@@ -25,17 +33,46 @@ module Crabfarm
     end
 
     def output
-      @output ||= Jbuilder.new
+      @output ||= @builder.prepare
+    end
+
+    def output_as_json
+      @builder.serialize @output
     end
 
     def crawl
       raise NotImplementedError.new
     end
 
+    def fork_each(_enumerator, &_block)
+      session_id = 0
+      mutex = Mutex.new
+      ths = _enumerator.map do |value|
+        session_id += 1
+        start_forked_state("th_session_#{session_id}", value, _block, mutex)
+      end
+      ThreadsWait.all_waits(*ths)
+    end
+
   private
 
-    def class_dsl
-      self.class.instance_variable_get :@class_dsl
+    def class_browser_dsl
+      self.class.instance_variable_get :@class_browser_dsl
+    end
+
+    def class_output_builder
+      self.class.instance_variable_get :@class_output_builder
+    end
+
+    def start_forked_state(_name, _value, _block, _mutex)
+      Thread.new {
+        sub_state = ForkedState.new self, _name, _mutex
+        begin
+          sub_state.instance_exec _value, &_block
+        ensure
+          sub_state.driver.reset
+        end
+      }
     end
   end
 end

data/lib/crabfarm/configuration.rb

@@ -5,7 +5,8 @@ module Crabfarm
     class Option < Struct.new(:name, :type, :text); end
 
     OPTIONS = [
-      [:default_dsl, :string, 'Default dsl used by parsers and states'],
+      [:browser_dsl, :string, 'Default browser dsl used by parsers and states'],
+      [:output_builder, :string, 'Default json output builder used by states'],
       [:driver_factory, :mixed, 'Driver factory, disabled if phantom_mode is used'],
       [:log_path, :string, 'Path where logs should be stored'],
 
@@ -39,7 +40,8 @@ module Crabfarm
 
     def initialize
       @values = {
-        default_dsl: :surfer,
+        browser_dsl: :surfer,
+        output_builder: :hash,
         driver_factory: nil,
         log_path: 'logs',
 

data/lib/crabfarm/engines/safe_state_loop.rb

@@ -77,8 +77,7 @@ module Crabfarm
         while @running
           if @working
             begin
-              last_state = @context.run_state @next_state_name, @next_state_params
-              @doc = last_state.output.attributes!
+              @doc = @context.run_state(@next_state_name, @next_state_params).output_as_json
               @error = nil
             rescue Exception => e
               @doc = nil

data/lib/crabfarm/forked_state.rb

@@ -0,0 +1,27 @@
+module Crabfarm
+  class ForkedState
+    extend Forwardable
+
+    def_delegators :@state, :params, :get, :fetch
+
+    def initialize(_state, _name, _mutex)
+      @state = _state
+      @name = _name
+      @mutex = _mutex
+    end
+
+    def driver
+      @driver ||= @state.driver(@name)
+    end
+
+    def browser
+      @browser ||= @state.browser(@name)
+    end
+
+    def lock_output
+      @mutex.synchronize {
+        yield @state.output
+      }
+    end
+  end
+end

data/lib/crabfarm/modes/console.rb

@@ -33,8 +33,8 @@ module Crabfarm
           end
 
           begin
-            state = @context.run_state _name, _params
-            puts JSON.pretty_generate(state.output.attributes!).color(:green)
+            doc = @context.run_state(_name, _params).output_as_json
+            puts JSON.pretty_generate(doc).color(:green)
           rescue EntityNotFoundError => e
             puts "#{e.to_s}".color(:red)
           rescue => e

data/lib/crabfarm/strategies.rb

@@ -0,0 +1,28 @@
+module Crabfarm
+  module Strategies
+
+    class Loader
+      def initialize(_klass, _pkg=nil)
+        @klass = _klass
+        @pkg = _pkg
+      end
+
+      def load
+        require @pkg if @pkg
+        if @klass.is_a? String then Object.const_get @klass else @klass end
+      end
+    end
+
+    @@register = {}
+
+    def self.register(_cat, _name, _klass, _pkg=nil)
+      @@register[_cat.to_s + _name.to_s] = Loader.new(_klass, _pkg)
+    end
+
+    def self.load(_cat, _name)
+      full_name = _cat.to_s + _name.to_s
+      raise ConfigurationError.new "Invalid #{_cat} name #{_name}" unless @@register.has_key? full_name
+      @@register[full_name].load
+    end
+  end
+end

data/lib/crabfarm/templates/Crabfile.erb

@@ -1,2 +1,2 @@
-set_default_dsl :surfer
+set_browser_dsl :surfer
 set_driver :phantomjs

data/lib/crabfarm/templates/boot.rb.erb

@@ -3,7 +3,8 @@ require 'bundler'
 # Load gems listed in the Gemfile.
 
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
-Bundler.require :default
+Bundler.setup
+require 'crabfarm'
 
 # Run code loader
 

data/lib/crabfarm/version.rb

@@ -1,3 +1,3 @@
 module Crabfarm
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/crabfarm.rb

@@ -1,5 +1,5 @@
 require "forwardable"
-require "jbuilder"
+require "active_support/inflector"
 require "selenium-webdriver"
 
 require "crabfarm/version"
@@ -15,10 +15,19 @@ require "crabfarm/state_store"
 require "crabfarm/context"
 require "crabfarm/base_state"
 require "crabfarm/base_parser"
-require 'crabfarm/dsl/surfer'
-require "crabfarm/adapters"
+require "crabfarm/strategies"
 require "crabfarm/loader"
 
 module Crabfarm
-  # Your code goes here...
+  module Strategies
+    # bundled browser dsl adapters
+    register :browser_dsl, :surfer, 'Crabfarm::SurferBrowserDsl', 'crabfarm/adapters/browser/surfer'
+    register :browser_dsl, :watir, 'Crabfarm::WatirBrowserDsl', 'crabfarm/adapters/browser/watir'
+    register :browser_dsl, :capybara, 'Crabfarm::CapybaraBrowserDsl', 'crabfarm/adapters/browser/capybara'
+
+    # bundled state output builders
+    register :output_builder, :hash, 'Crabfarm::HashOutputBuilder', 'crabfarm/adapters/output/hash'
+    register :output_builder, :ostruct, 'Crabfarm::OStructOutputBuilder', 'crabfarm/adapters/output/ostruct'
+    register :output_builder, :jbuilder, 'Crabfarm::JbuilderOutputBuilder', 'crabfarm/adapters/output/jbuilder'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crabfarm
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -290,10 +290,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/crabfarm/adapters/capybara_adapter.rb
-- lib/crabfarm/adapters/surfer_adapter.rb
-- lib/crabfarm/adapters/watir_adapter.rb
-- lib/crabfarm/adapters.rb
+- lib/crabfarm/adapters/browser/capybara.rb
+- lib/crabfarm/adapters/browser/surfer.rb
+- lib/crabfarm/adapters/browser/watir.rb
+- lib/crabfarm/adapters/output/hash.rb
+- lib/crabfarm/adapters/output/jbuilder.rb
+- lib/crabfarm/adapters/output/ostruct.rb
 - lib/crabfarm/base_parser.rb
 - lib/crabfarm/base_state.rb
 - lib/crabfarm/cli.rb
@@ -307,6 +309,7 @@ files:
 - lib/crabfarm/dsl/surfer.rb
 - lib/crabfarm/engines/safe_state_loop.rb
 - lib/crabfarm/errors.rb
+- lib/crabfarm/forked_state.rb
 - lib/crabfarm/loader.rb
 - lib/crabfarm/modes/console.rb
 - lib/crabfarm/modes/generator.rb
@@ -316,6 +319,7 @@ files:
 - lib/crabfarm/phantom_runner.rb
 - lib/crabfarm/rspec.rb
 - lib/crabfarm/state_store.rb
+- lib/crabfarm/strategies.rb
 - lib/crabfarm/support/custom_puma.rb
 - lib/crabfarm/support/gli.rb
 - lib/crabfarm/templates/boot.rb.erb

data/lib/crabfarm/adapters.rb

@@ -1,23 +0,0 @@
-require 'crabfarm/adapters/capybara_adapter'
-require 'crabfarm/adapters/surfer_adapter'
-require 'crabfarm/adapters/watir_adapter'
-
-module Crabfarm
-  module Adapters
-    @@adapters = {}
-
-    def self.register_dsl(_name, _adapter)
-      @@adapters[_name.to_sym] = _adapter
-    end
-
-    def self.load_from_dsl_name _name
-      raise ConfigurationError.new "Invalid dsl name #{_name}" unless @@adapters.has_key? _name.to_sym
-      @@adapters[_name.to_sym]
-    end
-
-    # bundled adapters
-    register_dsl :watir, WatirAdapter
-    register_dsl :capybara, CapybaraAdapter
-    register_dsl :surfer, SurferAdapter
-  end
-end