capybara_spa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e7e747b02cc0869ce137660bebe934510e93def930cc59986e2613dc1c939a0
+  data.tar.gz: 2ec7a9c521540156b1a4ccb3164cdec6a87017cf807a7f3048eb3b9418e5302a
+SHA512:
+  metadata.gz: b34d5a3ab60ba7da2e80a12349f578beaeda9eeca8014dd8cfab6edc499af300a05405a7a74160a0abad828ddd61a0c1322bcd4501518246bf4ab8c7024abbd3
+  data.tar.gz: 84d47934871fa119e29c2bb24cd6892bc83ce9dc925ab3307e02d96cde55069b6de486184d6c40a050390ac322933ece9f288fa0a965dd7141a55c1398b00f35

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    capybara_spa (0.1.0)
+      capybara (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    byebug (10.0.2)
+    capybara (3.0.3)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      xpath (~> 3.0)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.2.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    ffi (1.9.23)
+    io-like (0.3.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.11.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    xpath (3.0.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  capybara_spa!
+  chromedriver-helper (~> 1.2)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  selenium-webdriver (~> 3.11)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zach Dennis
+
+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,39 @@
+# CapybaraSpa
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capybara_spa`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara_spa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara_spa
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zdennis/capybara_spa.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara_spa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara_spa.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara_spa/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara_spa"
+  spec.version       = CapybaraSpa::VERSION
+  spec.authors       = ["Zach Dennis"]
+  spec.email         = ["zach.dennis@gmail.com"]
+
+  spec.summary       = %q{A friendly library for Capybara to make running single page application servers easy}
+  spec.description   = %q{A friendly library for Capybara to make running single page application servers easy as pie for integration, e2e, and feature level specs.}
+  spec.homepage      = "https://github.com/mhs/capybara-spa"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capybara", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "chromedriver-helper", "~> 1.2"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+  spec.add_development_dependency "selenium-webdriver", "~> 3.11"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/capybara_spa.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'capybara_spa/capybara_dsl_ext')
+require File.join(File.dirname(__FILE__), 'capybara_spa/server/ng_static_server')
+
+module CapybaraSpa
+  class << self
+    #  * NG_APP_TAG: the HTML tag where the angular app is stored. Defaults to app-root.
+    attr_accessor :app_tag
+
+    #  * NG_LOG_FILE: where to log the output of angular-http-server. Defaults to /dev/null
+    attr_accessor :log_file
+  end
+
+  self.app_tag = ENV.fetch('NG_APP_TAG', 'app-root')
+  self.log_file = ENV.fetch('NG_LOG_FILE', '/dev/null')
+
+  module Server
+  end
+end

data/lib/capybara_spa/capybara_dsl_ext.rb

@@ -0,0 +1,33 @@
+require 'capybara/dsl'
+
+module Capybara
+  module DSL
+    def page
+      wait_until_angular_app_is_found unless @ignoring_angular
+      Capybara.current_session
+    end
+
+    def wait_until_angular_app_is_found
+      return if @angular_app_found
+
+      @angular_app_found = false
+
+      loop do
+        Capybara.current_session.visit('/')
+        app_tag = CapybaraSpa.app_tag
+        @angular_app_found = Capybara.current_session.evaluate_script <<-JAVASCRIPT
+          document.getElementsByTagName('#{app_tag}').length === 1
+        JAVASCRIPT
+        break if @angular_app_found
+        sleep 0.25
+      end
+    end
+
+    def ignoring_angular
+      @ignoring_angular = true
+      yield
+    ensure
+      @ignoring_angular = false
+    end
+  end
+end

data/lib/capybara_spa/server/ng_static_server.rb

@@ -0,0 +1,164 @@
+require 'logger'
+
+module CapybaraSpa
+  module Server
+    # CapybaraSpa::Server::NgStaticServer is a class that wraps running
+    # a static Angular app using angular-http-server. It can take the
+    # following environment variables:
+    #
+    #  * NG_BUILD_PATH: where the angular app has been built to. Defaults to nil.
+    #  * NG_HTTP_SERVER_BIN: where angular-http-server binary/script is located. Defaults to nil \
+    #      which will force lookup of it in PATH, then in node_modules/.
+    #  * NG_PID_FILE: where to write a PID file to. Defaults to /tmp/angular-process.pid
+    #  * NG_PORT: what port to run the Angular app on. Defaults to 5001.
+    #
+    class NgStaticServer
+      class NgAppNotFound < ::StandardError ; end
+      class NgHttpServerNotFound < ::StandardError ; end
+      class NgHttpServerNotExecutable < ::StandardError ; end
+      class NodeModulesDirectoryNotFound < ::StandardError ; end
+
+      attr_accessor :build_path, :http_server_bin_path, :log_file, :pid_file, :port
+      attr_accessor :pid
+
+      def initialize(build_path:, http_server_bin_path: nil, log_file: CapybaraSpa.log_file, pid_file: nil, port: nil)
+        @build_path = build_path || ENV.fetch('NG_BUILD_PATH', nil)
+        @http_server_bin_path = http_server_bin_path || ENV.fetch('NG_HTTP_SERVER_BIN') { find_http_server_bin_path }
+        @log_file = log_file
+        @pid_file = pid_file || ENV.fetch('NG_PID_FILE', '/tmp/angular-process.pid')
+        @port = port || ENV.fetch('NG_PORT', 5001)
+        @started = false
+      end
+
+      def started?
+        @started
+      end
+
+      def stopped?
+        !@started
+      end
+
+      def start
+        return false if started?
+
+        check_requirements!
+
+        @pid = fork do
+          STDOUT.reopen(@log_file)
+          run_server
+        end
+        File.write(pid_file, pid)
+
+        at_exit { stop }
+        @started = true
+      end
+
+      def stop
+        if File.exist?(pid_file)
+          pid = File.read(pid_file).to_i
+          puts "capybara-angular/angular-http-server:parent#at_exit sending SIGTERM to pid: #{pid}" if ENV['DEBUG']
+          begin
+            Process.kill 'SIGTERM', pid
+            Process.wait pid
+          rescue Errno::ECHILD => ex
+            # no-op, the child process does not exist
+          end
+
+          puts "capybara-angular/angular-http-server removing pid_file: #{pid_file}" if ENV['DEBUG']
+          FileUtils.rm pid_file
+          @started = false
+          true
+        else
+          puts "capybara-angular/angular-http-server did not find pid_file, no process to SIGHUP: #{pid_file}" if ENV['DEBUG']
+          false
+        end
+      end
+
+      private
+
+      def check_requirements!
+        check_executable_requirements!
+        check_ng_app_requirements!
+      end
+
+      def check_executable_requirements!
+        executable_name = File.basename(http_server_bin_path)
+
+        if File.exist?(http_server_bin_path)
+          if !File.executable?(http_server_bin_path)
+            raise NgHttpServerNotExecutable, 'File found, but not executable!'
+          end
+        else
+          error_message = <<-ERROR.gsub(/^\s*\|/, '')
+            |#{executable_name + ' not found!'} Make sure it's installed via npm:
+            |
+            |To the project:
+            |
+            |   npm install --save-dev #{executable_name}
+            |
+            |Or globally:
+            |
+            |   npm install -g #{executable_name}
+            |
+          ERROR
+          raise NgHttpServerNotFound, error_message
+        end
+      end
+
+      def check_ng_app_requirements!
+        unless Dir.exist?(build_path)
+          error_message = <<-ERROR.gsub(/^\s*\|/, '')
+            |#{File.expand_path(build_path)} directory not found! Make sure the angular app is being built:
+            |
+            |E.g. ng build --aot --environment integration-tests --target=development --output-path=public/app/
+            |
+          ERROR
+          raise NgAppNotFound, error_message
+        end
+      end
+
+      def find_http_server_bin_path
+        http_server_bin_path = `which angular-http-server`.chomp
+
+        # if no http-server found in default PATH then try to find it in node_modules
+        if http_server_bin_path.length == 0
+          http_server_bin_path = File.join(node_modules_path, '.bin', 'angular-http-server')
+        end
+
+        http_server_bin_path
+      end
+
+      def run_server
+        build_dir = File.dirname(build_path)
+        Dir.chdir(build_dir) do
+          cmd = "#{http_server_bin_path} -p #{port} --path #{File.basename(build_path)}"
+          puts "capybara-angular/angular-http-server is executing command: #{cmd}" # if ENV['DEBUG']
+          spawn_cmd(cmd)
+        end
+      end
+
+      def spawn_cmd(cmd)
+        puts "capybara-angular/angular-http-server is executing command: #{cmd}" if ENV['DEBUG']
+
+        # use spawn(cmd, arg1, ... ) version to avoid launching a shell that launches the
+        # http-server or ng process. We want this pid to be the actual process to kill when
+        # this program is done exiting.
+        pid = spawn *cmd.split(/\s+/)
+
+        puts "capybara-angular/angular-http-server:forked child with pid: #{pid}" if ENV['DEBUG']
+
+        at_exit do
+          puts "capybara-angular/angular-http-server:forked#at_exit is sending SIGTERM signal to pid: #{pid}" if ENV['DEBUG']
+          begin
+            Process.kill 'TERM', pid
+            Process.wait pid
+          rescue Errno::ESRCH
+            # no-op: the process is already dead
+          end
+        end
+
+        Process.waitall
+      end
+    end
+  end
+end

data/lib/capybara_spa/version.rb

@@ -0,0 +1,3 @@
+module CapybaraSpa
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: capybara_spa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Dennis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: A friendly library for Capybara to make running single page application
+  servers easy as pie for integration, e2e, and feature level specs.
+email:
+- zach.dennis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara_spa.gemspec
+- lib/capybara_spa.rb
+- lib/capybara_spa/capybara_dsl_ext.rb
+- lib/capybara_spa/server/ng_static_server.rb
+- lib/capybara_spa/version.rb
+homepage: https://github.com/mhs/capybara-spa
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.2
+signing_key: 
+specification_version: 4
+summary: A friendly library for Capybara to make running single page application servers
+  easy
+test_files: []