cypress-on-rails 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307be16313426be599e503b2612ab3f33c8d4b54
-  data.tar.gz: 81a10e2d6563f57cc3e2a5cb71d0547d2366b278
+  metadata.gz: 5043512be34402217f8e93420dafe69700bab374
+  data.tar.gz: 645216c886a702ea0713a890967965d8043fa480
 SHA512:
-  metadata.gz: baa22d4846debaec324dc1641410a27e523665fea8bcf70624d165955809ec03054acd81564cb3075f6ff6c4ed1b29014fe23746f6bfa0a6f5ab8a0167d2979e
-  data.tar.gz: 2fe3bb98ea96886a22d509a9881127cb10faa505b172734e41993063ebf5d6e9ee128a3bad2ee6884f3dc7e9585ef423ca0019ff5b3568f26805ed99801b0251
+  metadata.gz: 408182ff3eab4bb571cc2c7f969c564968d7f7e4bf96e7e179fd4bec4c6c27380d75586522c1dc59990b5dae0549481e67c1dcbff888148fa1d6fef1ca3c09eb
+  data.tar.gz: 39588bdf7da33febdd7184c290ecb062d9ee9402ab3a67f06f9ad4947cc236db3a63abaf9886514202cd36c05c8ad5971f0b0c1a83a5dbf712724ce63c961921

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.0 (2017-11-05)
+### Changed
+* remove the need for a seperate port for the setup calls. Requires rerunning `cypress:install` generator
+
 ## 0.1.5 (2017-11-01)
 
 ### Added

data/README.md

@@ -9,7 +9,7 @@ Proof-of-Concept gem for using [cypress.io](http://github.com/cypress-io/) in Ra
 
 Add this to your Gemfile:
 ```
-group :test do
+group :test, :development do
   gem 'cypress-on-rails'
 end
 ```
@@ -41,6 +41,7 @@ When writing End-to-End tests, you will probably want to prepare your database t
 ### Using embedded ruby
 You can embed ruby code in your test file. This code will then be executed in the context of your application. For example:
 
+```
 // spec/cypress/integrations/simple_spec.js
 describe('My First Test', function() {
   it('visit root', function() {
@@ -55,6 +56,7 @@ describe('My First Test', function() {
     cy.contains("Cypress Hill")
   })
 })
+```
 
 Use the (`) backtick string syntax to allow multiline strings.
 

data/bin/cypress

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require 'cypress'
-Cypress::Server.new(ARGV).run
+Cypress::Runner.new(ARGV).run

data/lib/cypress.rb

@@ -3,12 +3,11 @@ require 'active_support/dependencies/autoload'
 module Cypress
   extend ActiveSupport::Autoload
   
-  autoload :Server,          'cypress/server'
-  autoload :CallbackServer,  'cypress/callback_server'
   autoload :Runner,          'cypress/runner'
   autoload :ScenarioBank,    'cypress/scenario_bank'
   autoload :ScenarioContext, 'cypress/scenario_context'
   autoload :Configuration,   'cypress/configuration'
+  autoload :Middleware,      'cypress/middleware'
 
   def self.configuration
     @configuration ||= Configuration.new
@@ -17,6 +16,10 @@ module Cypress
   def self.configure(&block)
     yield configuration if block_given?
   end
+
+  def self.run_middleware?
+    Rails.env.test?
+  end
 end
 
 if defined?(Rails)

data/lib/cypress/configuration.rb

@@ -1,11 +1,17 @@
 module Cypress
   class Configuration
-    attr_accessor :test_framework, :db_resetter, :cache_classes
+    attr_accessor :test_framework, :db_resetter, :cache_classes, :server_port
 
-    def initialize
+    def initialize(args=[])
+      setup(args)
+    end
+
+    def setup(args)
+      @args           = args
       @test_framework = :rspec
       @db_resetter    = :database_cleaner
       @before         = proc {}
+      @cache_classes  = run_mode == 'run'
     end
 
     def include(mod)
@@ -20,14 +26,16 @@ module Cypress
       end
     end
 
-    def cache_classes
-      !! @cache_classes
+    def run_mode
+      if @args.first == 'run'
+        'run'
+      else
+        'open'
+      end
     end
 
-    def disable_class_caching
-      if @cache_classes.nil?
-        @cache_classes = false
-      end
+    def load_support
+      require "./spec/cypress/cypress_helper"
     end
   end
 end

data/lib/cypress/middleware.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+module Cypress
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env['REQUEST_PATH'].starts_with?('/__cypress__/')
+        path = env['REQUEST_PATH'].sub('/__cypress__/', '')
+        cmd  = path.split('/').first
+        if respond_to?("handle_#{cmd}", true)
+          send "handle_#{cmd}", Rack::Request.new(env)
+          [201, {}, ["success"]]
+        else
+          [404, {}, ["unknown command: #{cmd}"]]
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+      def configuration
+        Cypress.configuration
+      end
+
+      def new_context
+        ScenarioContext.new(configuration)
+      end
+
+      def handle_setup(req)
+        reset_rspec           if configuration.test_framework == :rspec
+        call_database_cleaner if configuration.db_resetter    == :database_cleaner
+        new_context.execute configuration.before
+      end
+
+      def reset_rspec
+        require 'rspec/rails'
+        RSpec::Mocks.teardown
+        RSpec::Mocks.setup
+      end
+
+      def call_database_cleaner
+        require 'database_cleaner'
+        DatabaseCleaner.strategy = :truncation
+        DatabaseCleaner.clean
+      end
+
+      def json_from_body(req)
+        JSON.parse(req.body.read)
+      end
+
+      def handle_scenario(req)
+        handle_setup(req)
+
+        @scenario_bank.load
+        if block = @scenario_bank[json_from_body(req)['scenario']]
+          new_context.execute block
+        end
+      end
+
+      def handle_eval(req)
+        new_context.execute json_from_body(req)['code']
+      end
+  end
+end

data/lib/cypress/railtie.rb

@@ -1,5 +1,13 @@
+require 'rails/railtie'
 module Cypress
   class Railtie < Rails::Railtie
+    initializer :setup_cypress_middleware do |app|
+      if Cypress.run_middleware?
+        Cypress.configuration.load_support
+        app.middleware.use Middleware
+      end
+    end
+
     generators do
       require_relative '../generators/install_generator'
     end

data/lib/cypress/runner.rb

@@ -1,12 +1,14 @@
 module Cypress
   class Runner
-    def initialize(owner, callback_url)
-      @owner        = owner
-      @callback_url = callback_url
+    def initialize(args)
+      @args          = args
+      @scenario_bank = ScenarioBank.new
     end
 
-    def run(server_port)
-      Open3.popen2(*cypress_cli(server_port)) do |sin, sout, status|
+    def run
+      configuration.setup(@args)
+      boot_rails
+      Open3.popen2(*cypress_cli) do |sin, sout, status|
         sout.each_line do |line|
           puts "CYPRESS: #{line}"
         end
@@ -14,10 +16,24 @@ module Cypress
     end
 
     private
-      def cypress_cli(server_port)
+      def configuration
+        Cypress.configuration
+      end
+
+      def boot_rails
+        require 'cypress/railtie'
+        configuration.load_support
+        require 'capybara/rails'
+
+        Capybara.current_driver   = :selenium # oh, the irony....
+        Capybara.server           = :puma
+        configuration.server_port = Capybara.current_session.server.port
+      end
+
+      def cypress_cli
         result  = ['yarn', 'run']
-        result += ['cypress', @owner.mode]
-        result += ['--env', "SERVER_PORT=#{server_port},CALLBACK=#{@callback_url}"]
+        result += ['cypress', configuration.run_mode]
+        result += ['--env', "SERVER_PORT=#{configuration.server_port}"]
         result += ['-c', 'videosFolder=spec/cypress/videos,fixturesFolder=spec/cypress/fixtures,integrationFolder=spec/cypress/integrations/,supportFile=spec/cypress/support/setup.js']
         result
       end

data/lib/cypress/version.rb

@@ -1,3 +1,3 @@
 module Cypress
-  VERSION = "0.1.5".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/generators/install_generator.rb

@@ -12,7 +12,7 @@ module Cypress
       ]
       gsub_file 'config/environments/test.rb', 'config.cache_classes = true', replace.join("\n")
 
-      create_file "spec/cypress/cypress_helper.rb", <<-FILE
+      create_file "spec/cypress/cypress_helper.rb", <<-EOF
 ENV['RAILS_ENV'] ||= 'test'
 require File.expand_path('../../../config/environment', __FILE__)
 
@@ -31,7 +31,7 @@ Cypress.configure do |c|
   # add a module to your run context
   # c.include MyModule
 end
-FILE
+EOF
 
     create_file "spec/cypress/integrations/simple_spec.js", <<-FILE
 describe('My First Test', function() {
@@ -55,17 +55,17 @@ FILE
 
     create_file "spec/cypress/support/setup.js", <<-FILE
 // cypress-on-rails: dont remove these command
-Cypress.Commands.add('setupRails', function () {
-  cy.request('POST', Cypress.env("CALLBACK") + "/setup")
-});
-
 Cypress.Commands.add('setupScenario', function(name) {
   Cypress.log({ message: name })
-  cy.request('POST', Cypress.env("CALLBACK")+"/scenario", JSON.stringify({ scenario: name }))
+  cy.request('POST', 'http://localhost:' + Cypress.env("SERVER_PORT") + "/__cypress__/scenario", JSON.stringify({ scenario: name }))
+});
+
+Cypress.Commands.add('setupRails', function () {
+  cy.request('POST', 'http://localhost:' + Cypress.env("SERVER_PORT") + "/__cypress__/setup")
 });
 
 Cypress.Commands.add('rails', function(code) {
-  cy.request('POST', Cypress.env("CALLBACK") + "/eval", JSON.stringify({ code: code }))
+  cy.request('POST', 'http://localhost:' + Cypress.env("SERVER_PORT") + '/__cypress__/eval', JSON.stringify({ code: code }))
 })
 // cypress-on-rails: end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - miceportal team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,13 +69,12 @@ files:
 - cypress-on-rails.gemspec
 - lib/cypress-on-rails.rb
 - lib/cypress.rb
-- lib/cypress/callback_server.rb
 - lib/cypress/configuration.rb
+- lib/cypress/middleware.rb
 - lib/cypress/railtie.rb
 - lib/cypress/runner.rb
 - lib/cypress/scenario_bank.rb
 - lib/cypress/scenario_context.rb
-- lib/cypress/server.rb
 - lib/cypress/version.rb
 - lib/generators/install_generator.rb
 homepage: http://github.com/konvenit/cypress-on-rails

data/lib/cypress/callback_server.rb

@@ -1,36 +0,0 @@
-require 'webrick'
-require 'json'
-
-module Cypress
-  class CallbackServer
-    attr_reader :port
-    def initialize(owner)
-      @port    = 9293
-      @webrick = WEBrick::HTTPServer.new(:Port => port)
-      @webrick.mount_proc '/setup' do |req, res|
-        owner.run_command :setup
-        res.body = ''
-      end
-      @webrick.mount_proc '/eval' do |req, res|
-        owner.run_command :eval, JSON.parse(req.body)
-        res.body = ''
-      end
-      @webrick.mount_proc '/scenario' do |req, res|
-        owner.run_command :scenario, JSON.parse(req.body)
-        res.body = ''
-      end
-    end
-
-    def start
-      @webrick.start
-    end
-
-    def shutdown
-      @webrick.shutdown
-    end
-
-    def callback_url
-      "http://localhost:9293"
-    end
-  end
-end

data/lib/cypress/server.rb

@@ -1,82 +0,0 @@
-module Cypress
-  class Server
-    def initialize(args)
-      @args            = args
-      @callback_server = CallbackServer.new(self)
-      @runner          = Runner.new self, @callback_server.callback_url
-      @scenario_bank   = ScenarioBank.new
-    end
-
-    def mode
-      if @args.first == 'run'
-        'run'
-      else
-        'open'
-      end
-    end
-
-    def run
-      server_port = boot_rails
-
-      @callback_thread = Thread.new { @callback_server.start }
-      @runner_thread   = Thread.new { @runner.run server_port }
-      @runner_thread.join
-
-      @callback_server.shutdown
-    end
-
-    def run_command(command, options={})
-      if respond_to?("run_command_#{command}", true)
-        send "run_command_#{command}", options
-      end
-    end
-
-    private
-      def configuration
-        Cypress.configuration
-      end
-
-      def boot_rails
-        configuration.disable_class_caching if mode == 'open'
-        require "./spec/cypress/cypress_helper"
-        require 'capybara/rails'
-
-        Capybara.current_driver = :selenium # oh, the irony....
-        Capybara.current_session.server.port
-      end
-
-      def run_command_setup(options={})
-        reset_rspec           if configuration.test_framework == :rspec
-        call_database_cleaner if configuration.db_resetter    == :database_cleaner
-        new_context.execute configuration.before
-      end
-
-      def reset_rspec
-        RSpec::Mocks.teardown
-        RSpec::Mocks.setup
-      end
-
-      def call_database_cleaner
-        require 'database_cleaner'
-        DatabaseCleaner.strategy = :truncation
-        DatabaseCleaner.clean
-      end
-
-      def run_command_scenario(options={})
-        run_command_setup
-
-        @scenario_bank.load
-        if block = @scenario_bank[options['scenario']]
-          new_context.execute block
-        end
-      end
-
-      def run_command_eval(options={})
-        new_context.execute options['code']
-      end
-
-      def new_context
-        ScenarioContext.new(configuration)
-      end
-  end
-end