rspec-ui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36979e24385e4b719e3aba13f5de8c2fa69d4645
+  data.tar.gz: 856dc3c8ab3e863a1927d62ff0b30fad000f10c8
+SHA512:
+  metadata.gz: 75f36736d9924e418bb6898e6dbe42bbd39805bb107caf9ea3550fff0c1fc4b140b897175d10c0399d8e64fc8804aeea853bacba55bbc82ce8372928a8806a97
+  data.tar.gz: 41c27c530f9e001cb4f2aa773670c95c4794011831eb08dc5cda0a11e6dd4ccb48d9e829d8173b676b0536329b2081f49474a4db50d471127e573e0e5582cd57

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-ui.gemspec
+gemspec
+
+gem 'capybara', '~> 2.2.0', :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Teague
+
+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,43 @@
+# Rspec::Ui
+
+Gem that integrates with Rspec & UXSpec.com to help you build a suite of UI & UX
+features to test across multiple devices.
+
+Warning: very much ALPHA software, do not use yet!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-ui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-ui
+
+## Usage
+
+
+In your spec helper file:
+
+```ruby
+require "rspec/ui"
+
+UxSpec.configure do |config|
+  config.token = 'your_token_here'
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-ui/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/lib/rspec/ui/configuration.rb

@@ -0,0 +1,53 @@
+module RSpec
+  module Ui
+    # Fake class to document RSpec Rails configuration options. In practice,
+    # these are dynamically added to the normal RSpec configuration object.
+    class Configuration
+      # @!method infer_spec_type_from_file_location!
+      # Automatically tag specs in conventional directories with matching `type`
+      # metadata so that they have relevant helpers available to them. See
+      # `RSpec::Rails::DIRECTORY_MAPPINGS` for details on which metadata is
+      # applied to each directory.
+
+      # @!method render_views=(val)
+      #
+      # When set to `true`, controller specs will render the relevant view as
+      # well. Defaults to `false`.
+
+      # @!method render_views(val)
+      # Enables view rendering for controllers specs.
+
+      # @!method render_views?
+      # Reader for currently value of `render_views` setting.
+    end
+
+    # Mappings used by `infer_spec_type_from_file_location!`.
+    #
+    # @api private
+    DIRECTORY_MAPPINGS = {
+      :ui => %w[spec ui]
+    }
+
+    # @private
+    def self.initialize_configuration(config)
+
+      config.add_setting :always_run_ui_tests, :default => false
+
+      # Borrowed from rspec-rails
+      config.instance_exec do
+        def infer_spec_type_from_file_location!
+          DIRECTORY_MAPPINGS.each do |type, dir_parts|
+            escaped_path = Regexp.compile(dir_parts.join('[\\\/]') + '[\\\/]')
+            define_derived_metadata(:file_path => escaped_path) do |metadata|
+              metadata[:type] ||= type
+            end
+          end
+        end
+      end
+
+      config.include RSpec::Ui::UiExampleGroup, :type => :ui
+    end
+
+    initialize_configuration RSpec.configuration
+  end
+end

data/lib/rspec/ui/context.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Ui
+    module Context
+
+      def test_ui
+        #binding.pry
+      end
+
+    end
+  end
+end

data/lib/rspec/ui/dsl.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module Ui
+    module DSL
+      def test_ui
+       # binding.pry
+      end
+    end
+  end
+end

data/lib/rspec/ui/ngrok_hook.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+require 'locoyo'
+
+module RSpec
+  module Ui
+
+    class NgrokHook
+
+      ConfigFile = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'ngrok-config-testing'))
+      @@current_port = nil
+
+      def self.update_port(port)
+        return if @@current_port == port
+        shutdown
+
+        tunnel = Locoyo::Tunnel.new(
+          port:      port,
+          address:  '127.0.0.1',
+          protocol: 'http'
+        )
+        tunnel.run
+
+        sleep(3)
+        subdomain = tunnel.get_subdomain
+        update_browser_army(subdomain)
+
+        puts "View on http://uxspec.com/#{UxSpec.configuration.token}"
+        @@current_port = port
+      end
+
+      def self.shutdown
+        # TODO
+      end
+
+      def self.update_browser_army(subdomain)
+        HTTParty.patch("https://#{UxSpec.configuration.uxspec_uri}/#{UxSpec.configuration.token}.json", body: { project: { ngrok_id: subdomain, ngrok_port: @@current_port }}).body
+      end
+
+    end
+
+  end
+end

data/lib/rspec/ui/ui_example_group.rb

@@ -0,0 +1,75 @@
+require "pry"
+
+module RSpec
+  module Ui
+    # Container module for routing spec functionality.
+    module UiExampleGroup
+      extend ActiveSupport::Concern
+      # include RSpec::Rails::RailsExampleGroup
+
+      # Default host to be used in Rails route helpers if none is specified.
+      DEFAULT_HOST = "www.example.com"
+
+      included do
+        app = ::Rails.application
+        if app.respond_to?(:routes)
+          include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
+          include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
+
+          if respond_to?(:default_url_options)
+            default_url_options[:host] ||= ::RSpec::Ui::UiExampleGroup::DEFAULT_HOST
+          end
+        end
+      end
+
+      # Shim to check for presence of Capybara. Will delegate if present, raise
+      # if not. We assume here that in most cases `visit` will be the first
+      # Capybara method called in a spec.
+      def visit(*)
+        if defined?(super)
+          super
+        else
+          raise "Capybara not loaded, please add it to your Gemfile:\n\ngem \"capybara\""
+        end
+      end
+    end
+  end
+end
+
+
+unless RSpec.respond_to?(:ui)
+  opts = {
+    :ui_feature => true,
+    :type => :ui,
+    :skip => <<-EOT.squish
+      Feature specs require the Capybara (http://github.com/jnicklas/capybara)
+      gem, version 2.2.0 or later. We recommend version 2.4.0 or later to avoid
+      some deprecation warnings and have support for
+      `config.expose_dsl_globally = false`.
+    EOT
+  }
+
+  # Capybara's monkey patching causes us to have to jump through some hoops
+  top_level = self
+  main_feature = nil
+  if defined?(Capybara) && ::Capybara::VERSION.to_f < 2.4
+    # Capybara 2.2 and 2.3 do not use `alias_example_xyz`
+    opts[:skip] = <<-EOT.squish
+      Capybara < 2.4.0 does not support RSpec's namespace or
+      `config.expose_dsl_globally = false`. Upgrade to Capybara >= 2.4.0.
+    EOT
+    main_feature = top_level.method(:ui) if top_level.respond_to?(:ui)
+  end
+
+  RSpec.configure do |c|
+    main_feature = nil unless c.expose_dsl_globally?
+    c.alias_example_group_to :ui, opts
+    c.alias_example_to :scenario
+    c.alias_example_to :xscenario
+  end
+
+  # Due to load order issues and `config.expose_dsl_globally?` defaulting to
+  # `true` we need to put Capybara's monkey patch method back. Otherwise,
+  # app upgrades have a high likelyhood of having all feature specs skipped.
+  top_level.define_singleton_method(:ui, &main_feature) if main_feature
+end

data/lib/rspec/ui/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Ui
+    VERSION = "0.0.1"
+  end
+end

data/lib/rspec/ui.rb

@@ -0,0 +1,69 @@
+require "pry"
+require "rails"
+require "capybara"
+require "rspec/ui/version"
+require "rspec/ui/ngrok_hook"
+require 'rspec/ui/context'
+require 'rspec'
+
+class RackTestWithServer < Capybara::RackTest::Driver
+  def needs_server?;true;end
+end
+
+Capybara.register_driver :rack_test_with_server do |app|
+  RackTestWithServer.new(app)
+end
+
+Capybara.configure do |config|
+  config.default_driver = :rack_test_with_server
+end
+
+if Rails.env.test?
+  RSpec.configure do |config|
+    config.around(:example) do |ex|
+      Capybara.current_session.driver.header('X-Frame-Options', 'ALLOW-FROM https://uxspec.com')
+      RSpec::Ui::NgrokHook.update_port(Capybara.current_session.server.port)
+
+      # if VCR present, temporarily disable the localhost & uxspec addresses
+      ex.run
+      sleep(500)
+    end
+
+    # config.after(:suit) do |ex|
+    #   RSpec::Ui::NgrokHook.shutdown
+    # end
+  end
+end
+
+module UxSpec
+  #
+  # Allow external configuration of UXSpec Token & URI (for self hosting)
+  # potentially more in future.
+  #
+  # e.g.
+  #
+  #     UxSpec.configure do |config|
+  #       config.token = 'your_token_here'
+  #     end
+  #
+  # Reference: https://robots.thoughtbot.com/mygem-configure-block
+  #
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :token, :uxspec_uri
+
+    def initialize
+      @token      = nil
+      @uxspec_uri = 'uxspec.com'
+    end
+  end
+
+end

data/rspec-ui.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/ui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-ui"
+  spec.version       = Rspec::Ui::VERSION
+  spec.authors       = ["Chris Teague"]
+  spec.email         = ["chris@cteague.com.au"]
+  spec.summary       = %q{Build UI tests for manual validation across multiple devices.}
+  spec.description   = %q{Build UI tests for manual validation across multiple devices.}
+  spec.homepage      = "https://github.com/chris-teague/rspec-ui"
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-core', '~> 0'
+  spec.add_development_dependency 'capybara', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
+
+  spec.add_runtime_dependency 'locoyo', '~> 0'
+  spec.add_runtime_dependency 'httparty', '~> 0'
+  spec.add_runtime_dependency 'rspec', '~> 0'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Teague
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: locoyo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Build UI tests for manual validation across multiple devices.
+email:
+- chris@cteague.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/ui.rb
+- lib/rspec/ui/configuration.rb
+- lib/rspec/ui/context.rb
+- lib/rspec/ui/dsl.rb
+- lib/rspec/ui/ngrok_hook.rb
+- lib/rspec/ui/ui_example_group.rb
+- lib/rspec/ui/version.rb
+- rspec-ui.gemspec
+homepage: https://github.com/chris-teague/rspec-ui
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Build UI tests for manual validation across multiple devices.
+test_files: []