capybara-selenium 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e13f900df3097a79309945f402301af811a14400
-  data.tar.gz: 354127460453b5f0c61bc32709c49d6d0219c2cf
+  metadata.gz: e7b1e32af7160025a7ba412bf91e82e7db92c5b0
+  data.tar.gz: 23460a046866acf85a8485c2f496c2038d0730dd
 SHA512:
-  metadata.gz: ecd1f78aee31e15e06142aebf6f08542e0e97ce8d7fdc0bf978f8523502da3e5de33e771d9285f00c94ae695664dc6cecb33a139152df3d387f2731939ea2b63
-  data.tar.gz: 97aca416c3e2e84f63c75e8202f10730b67580a897cacc08711a8fc5345203d6e64097060aa751f1d1a9888d172c2fc2523eb53d30d5adfbe5c95aa864cadee8
+  metadata.gz: a6a5849c6b568f26632895a671746f0db3a7b9666750ed8bccf2a4bba8c4b892e1d883f9ea8db6322ab4da9046b2070b2569b03b076db8ede9a15948677bac45
+  data.tar.gz: d681950100ef0fa127ab6bdf8939da450d051bb4bc25b27a0e190749d13c7da23e92901a44d954af8a476ab62a01fba9cd2bb82945d348ab8adeff53c412dd9c

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.2
+
+* Complete refactoring for easy modular extension
+* New application and selenium server configuration through configure methods

data/README.md

@@ -32,40 +32,53 @@ Supported applications:
 - [X] Modular sinatra apps (through config.ru)
 - [ ] Rails apps
 
+#### Option 1: Using a block in constructor call (Recommended)
+
 ```ruby
 # features/support/continous_integration.rb
-module ContinousIntegration
-  def app_server(opts = {})
-    {
-      host: ENV['CI_APP_SERVER_HOST'] || 'localhost',
-      port: ENV['CI_APP_SERVER_PORT'] || 8080,
-      type: :rack,
-      config_ru_path: ENV['CI_APP_SERVER_CONFIG_RU'] || config_ru_path
-    }.merge(opts)
+CapybaraSelenium::Configurator.new do
+  rack_app_server.configure do |config|
+    config.host = ENV['CI_APP_SERVER_HOST'] || 'localhost'
+    config.port = ENV['CI_APP_SERVER_PORT'] || 8080
+    config.config_ru_path  = File.expand_path(
+      File.join(__FILE__, '../web_app/config.ru'))
   end
 
-  def selenium_server(opts = {})
-    {
-      type: :remote,
-      url: ENV['CI_SELENIUM_SERVER_URL'] || 'http://127.0.0.1:4444/wd/hub',
-      capabilities: {
-        browser_name: :firefox
-      }
-    }.merge(opts)
+  remote_selenium_server.configure do |config|
+    config.server_url = ENV['CI_SELENIUM_SERVER_URL'] ||
+      'http://127.0.0.1:4444/wd/hub'
+    config.capabilities = { browser_name: browser_name }
   end
+end
+```
+
+#### Option 2: Using instance methods
 
+```ruby
+# features/support/continous_integration.rb
+module ContinousIntegration
   def driver_for(browser_name)
-    CapybaraSelenium::GlobalConfigurator.new(
-      app_server: app_server,
-      selenium_server: selenium_server.merge(
-        capabilities: {
-          browser_name: browser_name
-        })
-    ).driver
+    @configurator = CapybaraSelenium::Configurator.new
+    configure_rack_app_server
+    configure_selenium_server(browser_name)
+    @configurator.apply
+  end
+
+  def configure_rack_app_server
+    @configurator.rack_app_server.configure do |config|
+      config.host = ENV['CI_APP_SERVER_HOST'] || 'localhost'
+      config.port = ENV['CI_APP_SERVER_PORT'] || 8080
+      config.config_ru_path  = File.expand_path(
+        File.join(__FILE__, '../web_app/config.ru'))
+    end
   end
 
-  def config_ru_path
-    File.expand_path(File.join(__FILE__, '../dummy_app/config.ru'))
+  def configure_selenium_server(browser_name)
+    @configurator.remote_selenium_server.configure do |config|
+      config.server_url = ENV['CI_SELENIUM_SERVER_URL'] ||
+        'http://127.0.0.1:4444/wd/hub'
+      config.capabilities = { browser_name: browser_name }
+    end
   end
 end
 

data/capybara_selenium.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['david.saenz.tagarro@gmail.com']
   spec.summary       = %q{Dead-simple way to make Capybara and Selenium play together }
   spec.description   = %q{}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/dsaenztagarro/capybara-selenium'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/capybara_selenium.rb

@@ -1,6 +1,9 @@
-require 'capybara_selenium/version'
-require 'capybara_selenium/app_server'
-require 'capybara_selenium/selenium_server'
+require_relative 'capybara_selenium/version'
+require_relative 'capybara_selenium/server/configurator'
+require_relative 'capybara_selenium/app_server/configurator'
+require_relative 'capybara_selenium/app_server/configuration'
+require_relative 'capybara_selenium/selenium_server/configurator'
+require_relative 'capybara_selenium/selenium_server/configuration'
 
 require 'active_support/inflector'
 
@@ -8,32 +11,47 @@ require 'active_support/inflector'
 module CapybaraSelenium
   # Class for configuring capybara and selenium in order to instance the
   # desired driver.
-  class GlobalConfigurator
+  class Configurator
     include AppServer
     include SeleniumServer
+    attr_reader :driver
 
-    def initialize(opts = {})
-      check_options(opts)
-      @app_server = configurator_for :app_server, opts
-      @selenium_server = configurator_for :selenium_server, opts
+    def initialize(&block)
+      define_singleton_method(:dispatch, block) if block_given?
     end
 
-    def driver
+    def apply
       @app_server.apply
-      @selenium_server.apply
+      @driver = @selenium_server.apply
+    end
+
+    def method_missing(method, *args, &block)
+      if method =~ /(.*)_app_server/
+        @app_server ||= configurator :app_server, $1
+      elsif method =~ /(.*)_selenium_server/
+        @selenium_server ||= configurator :selenium_server, $1
+      else
+        raise
+      end
     end
 
     private
 
-    def check_options(opts)
-      fail 'App Server config missing' unless opts[:app_server]
-      fail 'Selenium Server config missing' unless opts[:selenium_server]
+    def configurator(server_type, configurator_type, &block)
+      klass = self.class
+      server_module = klass.classify(server_type)
+      configurator_klass = klass.classify(configurator_type)
+      "CapybaraSelenium::#{server_module}::#{configurator_klass}Configurator"
+        .constantize.new(configuration(server_module, configurator_klass))
+    end
+
+    def configuration(server_module, klass)
+      "CapybaraSelenium::#{server_module}::#{klass}Configuration"
+        .constantize.new
     end
 
-    def configurator_for(*args)
-      configurator_type = args.shift
-      opts = args.first[configurator_type]
-      send "#{configurator_type}_configurator", opts
+    def self.classify(type)
+      ActiveSupport::Inflector.classify(type)
     end
   end
 end

data/lib/capybara_selenium/app_server/configuration.rb

@@ -0,0 +1,11 @@
+module CapybaraSelenium
+  module AppServer
+    class BaseConfiguration
+      attr_accessor :host, :port
+    end
+
+    class RackConfiguration < BaseConfiguration
+      attr_accessor :config_ru_path
+    end
+  end
+end

data/lib/capybara_selenium/app_server/configurator.rb

@@ -0,0 +1,21 @@
+module CapybaraSelenium
+  module AppServer
+    class BaseConfigurator < Server::Configurator
+      def apply
+        Capybara.server_host = host
+        Capybara.server_port = port
+        Capybara.app_host = "http://#{host}:#{port}"
+      end
+    end
+
+    # Class responsible for applying to Capybara the configuration of a Rack
+    # Web Application
+    class RackConfigurator < BaseConfigurator
+      def apply
+        super
+        fail 'Invalid config.ru file path' unless File.exist? config_ru_path
+        Capybara.app = Rack::Builder.parse_file(config_ru_path).first
+      end
+    end
+  end
+end

data/lib/capybara_selenium/selenium_server/configuration.rb

@@ -0,0 +1,11 @@
+module CapybaraSelenium
+  module SeleniumServer
+    class BaseConfiguration
+      attr_accessor :capabilities
+    end
+
+    class RemoteConfiguration < BaseConfiguration
+      attr_accessor :server_url
+    end
+  end
+end

data/lib/capybara_selenium/selenium_server/configurator.rb

@@ -0,0 +1,36 @@
+module CapybaraSelenium
+  module SeleniumServer
+    class BaseConfigurator < Server::Configurator
+      private
+
+      def caps(key)
+        capabilities[key]
+      end
+    end
+
+    class RemoteConfigurator < BaseConfigurator
+      def apply
+        Capybara.current_driver = driver_name
+        Capybara.javascript_driver = driver_name
+        Capybara.register_driver(driver_name) do |app|
+          Capybara::Selenium::Driver.new(
+            app,
+            browser: :remote,
+            url: server_url,
+            desired_capabilities: desired_capabilities)
+        end
+      end
+
+      def driver_name
+        "#{caps(:browser_name)}_#{caps(:version)}_#{caps(:platform)}"
+      end
+
+      # @return [] The desired capabilities for the browser
+      def desired_capabilities
+        return @desired_capabilities if @desired_capabilities
+        @desired_capabilities = Selenium::WebDriver::Remote::Capabilities
+                                .send(caps(:browser_name))
+      end
+    end
+  end
+end

data/lib/capybara_selenium/server/configurator.rb

@@ -0,0 +1,34 @@
+module CapybaraSelenium
+  module Server
+    class Configurator
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def configure(&block)
+        @configuration = create_configuration
+        block.call @configuration
+      end
+
+      def method_missing(method)
+        if @configuration.respond_to? method
+          return @configuration.send(method)
+        else
+          raise
+        end
+      end
+
+      private
+
+      def create_configuration
+        *modules, klass = self.class.to_s.split('::')
+        "#{modules.join('::')}::#{type_of(klass)}Configuration"
+          .constantize.new
+      end
+
+      def type_of(klass)
+        /^(?<type>(.*))Configurator/.match(klass)[:type]
+      end
+    end
+  end
+end

data/lib/capybara_selenium/version.rb

@@ -1,3 +1,3 @@
 module CapybaraSelenium
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-selenium
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Saenz Tagarro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -174,16 +174,20 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - capybara_selenium.gemspec
 - lib/capybara_selenium.rb
-- lib/capybara_selenium/app_server.rb
-- lib/capybara_selenium/selenium_server.rb
+- lib/capybara_selenium/app_server/configuration.rb
+- lib/capybara_selenium/app_server/configurator.rb
+- lib/capybara_selenium/selenium_server/configuration.rb
+- lib/capybara_selenium/selenium_server/configurator.rb
+- lib/capybara_selenium/server/configurator.rb
 - lib/capybara_selenium/version.rb
-homepage: ''
+homepage: https://github.com/dsaenztagarro/capybara-selenium
 licenses:
 - MIT
 metadata: {}
@@ -203,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Dead-simple way to make Capybara and Selenium play together

data/lib/capybara_selenium/app_server.rb

@@ -1,42 +0,0 @@
-module CapybaraSelenium
-  # Responsible for generating an application server object that applies the
-  # configuration needed
-  module AppServer
-    # Base Class for applying to Capybara the configuration of an App Server
-    class BaseConfigurator
-      attr_accessor :server_host, :server_port, :app_type
-
-      def initialize(opts = {})
-        @server_host = opts[:host] || 'localhost'
-        @server_port = opts[:port] || 5000
-        @app_type = opts[:type] || :rack
-        @opts = opts
-      end
-
-      def apply
-        Capybara.server_host = @server_host
-        Capybara.server_port = @server_port
-        Capybara.app_host = "http://#{@server_host}:#{@server_port}"
-      end
-    end
-
-    # Class responsible for applying to Capybara the configuration of a Rack
-    # Web Application
-    class RackAppConfigurator < BaseConfigurator
-      def apply
-        super
-        path = @opts[:config_ru_path]
-        fail 'Invalid config.ru file path' unless File.exist? path
-        # require 'pry'
-        # binding.pry
-        Capybara.app = Rack::Builder.parse_file(path).first
-      end
-    end
-
-    def app_server_configurator(opts)
-      ('CapybaraSelenium::AppServer::' \
-       "#{ActiveSupport::Inflector.classify(opts[:type])}AppConfigurator")
-        .constantize.new(opts)
-    end
-  end
-end

data/lib/capybara_selenium/selenium_server.rb

@@ -1,71 +0,0 @@
-module CapybaraSelenium
-  # Module for applying to Capybara configuration for Selenium Server
-  module SeleniumServer
-    # Class for applying to Capybara configuration for Selenium Server
-    class BaseConfigurator
-      attr_accessor :browser_name
-
-      def initialize(opts = {})
-        @browser_name = opts[:capabilities][:browser_name] || 'firefox'
-        @capabilities = opts[:capabilities] || {}
-      end
-
-      private
-
-      # @return [] The desired capabilities for the browser
-      def desired_capabilities
-        return @desired_capabilities if @desired_capabilities
-        @desired_capabilities = Selenium::WebDriver::Remote::Capabilities
-                                .send(browser_name)
-        # @capabilities.keys.each do |key|
-        #   @desired_capabilities.send "#{key}=", @capabilities[key]
-        # end
-      end
-
-      def default_capabilities
-        {
-          version: 'ANY',
-          platform: 'ANY'
-        }
-      end
-
-      def method_missing(method)
-        capability = desired_capabilities[method]
-        return capability if capability
-        fail
-      end
-    end
-
-    # Applies Capybara specific configuration for selenium remote server
-    class SeleniumRemoteConfigurator < BaseConfigurator
-      attr_accessor :server_url
-
-      def initialize(opts)
-        super
-        @server_url = opts[:server_url] || 'http://127.0.0.1:4444/wd/hub'
-      end
-
-      def apply
-        Capybara.current_driver = driver_name
-        Capybara.javascript_driver = driver_name
-        Capybara.register_driver(driver_name) do |app|
-          Capybara::Selenium::Driver.new(
-            app,
-            browser: :remote,
-            url: server_url,
-            desired_capabilities: desired_capabilities)
-        end
-      end
-
-      def driver_name
-        "#{browser_name}_#{version}_#{platform}"
-      end
-    end
-
-    def selenium_server_configurator(opts)
-      ('CapybaraSelenium::SeleniumServer::' \
-       "Selenium#{ActiveSupport::Inflector.classify(opts[:type])}Configurator")
-        .constantize.new(opts)
-    end
-  end
-end