ghost_pictures 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d0ceb13a2bce8e0cdb0a360f8c60f650535275
+  data.tar.gz: 8eb2ef6ee14e5d80f8c161760089ba904d3cab92
+SHA512:
+  metadata.gz: 9d793096c0223e6dbaa3ad94d772c278fae841af9b5ac55fa19f832ca2ff13c7df2c617c39ecafddb3cf9a8a49ebaebfcf1302c2cc08c31bf5e068ee9fd809f8
+  data.tar.gz: a2799ad1d6921fa5d561949833e5e6c9e542b165ef5cc95ccad5bc4bfa972f9821c481df81cab4cd3b68df4fb939b2c2ffc3ca91e99ed6e6fced07817b3b067a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: required
+language: ruby
+rvm:
+  - 2.4.2
+  - ruby-head
+addons:
+  chrome: stable
+before_install:
+  - gem install bundler -v 1.15.4
+  - wget https://chromedriver.storage.googleapis.com/2.33/chromedriver_linux64.zip
+  - unzip -d ~/ chromedriver_linux64.zip
+  - sudo mv -f ~/chromedriver /usr/local/share/
+  - sudo chmod +x /usr/local/share/chromedriver
+  - sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ghost_pictures.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# GhostPictures
+
+[![Gem Version](https://badge.fury.io/rb/ghost_pictures.svg)](https://badge.fury.io/rb/ghost_pictures)
+[![Build Status](https://travis-ci.org/sinsoku/ghost_pictures.svg?branch=master)](https://travis-ci.org/sinsoku/ghost_pictures)
+
+GhostPictures provides the feature to wait for Ajax requests with [Capybara](https://github.com/teamcapybara/capybara).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ghost_pictures', group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ghost_pictures
+
+## Setup
+
+### Rails
+
+```rb
+# config/environments/test.rb
+config.middleware.use GhostPictures::Capture
+```
+
+## Examples
+
+### Wait for a Ajax request
+
+```rb
+GhostPictures.wait_for { click_link "get data via Ajax" }
+```
+
+### Wait for matching requests
+
+```rb
+# Wait for a request with "/users"
+GhostPictures.wait_for("/users") { click_link }
+
+# Wait for a POST request with "/users"
+GhostPictures.wait_for("/users", method: :post) { click_link }
+
+# Wait for two requests
+GhostPictures.wait_for(nil, count: 2) do
+  2.times { click_link }
+end
+```
+
+## 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/sinsoku/ghost_pictures.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ghost_pictures'
+
+# 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/ghost_pictures.gemspec

@@ -0,0 +1,31 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghost_pictures/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ghost_pictures'
+  spec.version       = GhostPictures::VERSION
+  spec.authors       = ['sinsoku']
+  spec.email         = ['sinsoku.listy@gmail.com']
+
+  spec.summary       = 'GhostPictures provides the feature to wait for Ajax requests with Capybara.'
+  spec.description   = 'GhostPictures provides the feature to wait for Ajax requests with Capybara.'
+  spec.homepage      = 'https://github.com/sinsoku/ghost_pictures'
+
+  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_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'selenium-webdriver'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/ghost_pictures.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require 'ghost_pictures/api'
+require 'ghost_pictures/capture'
+require 'ghost_pictures/record'
+require 'ghost_pictures/rspec_helpers'
+require 'ghost_pictures/version'
+
+module GhostPictures
+  extend API
+end

data/lib/ghost_pictures/api.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GhostPictures
+  module API
+    MSG = 'Pass the operation include Ajax requests as block argument'
+
+    def wait_for(path = nil, method: nil, count: 1)
+      raise(ArgumentError, MSG) unless block_given?
+
+      Record.reset!
+      yield
+      Timeout.timeout(Capybara.default_max_wait_time) do
+        loop { break if Record.select_if(method, path).size >= count }
+      end
+    end
+
+    # @see https://robots.thoughtbot.com/automatically-wait-for-ajax-with-capybara
+    def wait_for_jquery_ajax
+      Timeout.timeout(Capybara.default_max_wait_time) do
+        loop until finished_all_ajax_requests?
+      end
+    end
+
+    private
+
+    def finished_all_ajax_requests?
+      page.evaluate_script('jQuery.active').zero?
+    end
+  end
+end

data/lib/ghost_pictures/capture.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GhostPictures
+  Request = Struct.new(:id, :method, :path)
+
+  class Capture
+    def initialize(app)
+      @id = 0
+      @app = app
+    end
+
+    def call(env)
+      req = build_request(env)
+      Record.start(req)
+      @app.call(env)
+    ensure
+      Record.finish(req)
+    end
+
+    private
+
+    def build_request(env)
+      @id += 1
+      Request.new(@id, env['REQUEST_METHOD'].downcase.to_sym, env['PATH_INFO'])
+    end
+  end
+end

data/lib/ghost_pictures/record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module GhostPictures
+  module Record
+    class << self
+      def reset!
+        @started = []
+        @finished = []
+      end
+
+      def start(request)
+        started << request
+      end
+
+      def finish(request)
+        finished << request
+      end
+
+      def select_if(method, path)
+        finished_requests.select do |req|
+          (method.nil? || req.method == method) &&
+            (path.nil? || req.path == path)
+        end
+      end
+
+      def running?
+        !running_requests.empty?
+      end
+
+      private
+
+      def finished_requests
+        started & finished
+      end
+
+      def running_requests
+        started - finished
+      end
+
+      def started
+        @started ||= []
+      end
+
+      def finished
+        @finished ||= []
+      end
+    end
+  end
+end

data/lib/ghost_pictures/rspec_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GhostPictures
+  module RSpecHelpers
+    def wait_for_ajax(*args, &block)
+      GhostPictures.wait_for(*args, &block)
+    end
+
+    def wait_for_jquery_ajax
+      GhostPictures.wait_for_jquery_ajax
+    end
+  end
+end

data/lib/ghost_pictures/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GhostPictures
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ghost_pictures
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- sinsoku
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: selenium-webdriver
+  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: rubocop
+  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'
+description: GhostPictures provides the feature to wait for Ajax requests with Capybara.
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ghost_pictures.gemspec
+- lib/ghost_pictures.rb
+- lib/ghost_pictures/api.rb
+- lib/ghost_pictures/capture.rb
+- lib/ghost_pictures/record.rb
+- lib/ghost_pictures/rspec_helpers.rb
+- lib/ghost_pictures/version.rb
+homepage: https://github.com/sinsoku/ghost_pictures
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: GhostPictures provides the feature to wait for Ajax requests with Capybara.
+test_files: []