cypress-on-rails 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdfc04b2cd587e4d0e67879f830117416b679968
+  data.tar.gz: '0784e1cd91281ed2f668ee5ea9dc3b89560a4ef3'
+SHA512:
+  metadata.gz: 6c186111c70d54b2610ff0b18fee74f6fc14c90376c0bb1bb0cc0fd2af998595035b5c7201d85a0e35f3045cf67f9cf8f3374a1988b8637d108a254ad4da852a
+  data.tar.gz: 1e4c83231e310fada2ad93aa480ae5b1571f55077ce5b57edd90e4bac749fe204efaacf3b21b689b19d6f9f4038a447f1107e1cd394c75474950d07aa727d33f

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    cypress-on-rails (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      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.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cypress-on-rails!
+  rspec
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -0,0 +1 @@
+# cypress-on-rails

data/bin/cypress

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

data/cypress-on-rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "cypress/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cypress-on-rails"
+  s.version     = Cypress::VERSION
+  s.author      = "miceportal team"
+  s.email       = "info@miceportal.de"
+  s.homepage    = "http://github.com/konvenit/cypress-on-rails"
+  s.summary     = "Integrates cypress with rails"
+  s.description = "Integrates cypress with rails"
+  s.rubyforge_project = s.name
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'activesupport'
+  s.add_dependency 'selenium-webdriver' # to be replaced
+  s.add_development_dependency 'rspec'
+end

data/lib/cypress-on-rails.rb

@@ -0,0 +1 @@
+require_relative './cypress'

data/lib/cypress.rb

@@ -0,0 +1,19 @@
+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 :Configuration,  'cypress/configuration'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield configuration if block_given?
+  end
+end

data/lib/cypress/callback_server.rb

@@ -0,0 +1,25 @@
+module Cypress
+  class CallbackServer
+    attr_reader :port
+    def initialize(owner)
+      @port    = 9293
+      @webrick = WEBrick::HTTPServer.new(:Port => port)
+      @webrick.mount_proc '/' do |req, res|
+        owner.run_command 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/configuration.rb

@@ -0,0 +1,29 @@
+module Cypress
+  class Configuration
+    attr_accessor :test_framework, :db_resetter, :cache_classes
+
+    def initialize
+      @test_framework = :rspec
+      @db_resetter    = :database_cleaner
+      @before         = proc {}
+    end
+
+    def before(&block)
+      if block_given?
+        @before = block
+      else
+        @before
+      end
+    end
+
+    def cache_classes
+      !! @cache_classes
+    end
+
+    def disable_class_caching
+      if @cache_classes.nil?
+        @cache_classes = false
+      end
+    end
+  end
+end

data/lib/cypress/runner.rb

@@ -0,0 +1,25 @@
+module Cypress
+  class Runner
+    def initialize(owner, callback_url)
+      @owner        = owner
+      @callback_url = callback_url
+    end
+
+    def run(server_port)
+      Open3.popen2(*cypress_cli(server_port)) do |sin, sout, status|
+        sout.each_line do |line|
+          puts "CYPRESS: #{line}"
+        end
+      end
+    end
+
+    private
+      def cypress_cli(server_port)
+        result  = ['yarn', 'run']
+        result += ['cypress', @owner.mode]
+        result += ['--env', "SERVER_PORT=#{server_port},CALLBACK=#{@callback_url}"]
+        result += ['-c', 'videosFolder=spec/cypress/videos,fixturesFolder=spec/cypress/fixtures,integrationFolder=spec/cypress/integrations/,supportFile=spec/cypress/support/setup.js']
+        result
+      end
+  end
+end

data/lib/cypress/scenario_bank.rb

@@ -0,0 +1,28 @@
+module Cypress
+  class ScenarioBank
+    def initialize
+      @scenarios = {}
+    end
+
+    def boot
+      if Cypress.configuration.test_framework == :rspec
+        require 'rspec/rails'
+        extend RSpec::Mocks::ExampleMethods
+      end
+    end
+
+    def load
+      Dir['./spec/cypress/scenarios/**/*.rb'].each do |f|
+        instance_eval(File.read(f), f)
+      end
+    end
+
+    def scenario(name, &block)
+      @scenarios[name] = block
+    end
+
+    def [](name)
+      @scenarios[name.to_sym]
+    end
+  end
+end

data/lib/cypress/server.rb

@@ -0,0 +1,75 @@
+require 'webrick'
+require 'json'
+
+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
+      load_cypress_helper
+      server_port = boot_rails
+      @scenario_bank.boot
+
+      @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)
+      @scenario_bank.load
+
+      if command['scenario'] and (block = @scenario_bank[command['scenario']])
+        reset_rspec           if configuration.test_framework == :rspec
+        call_database_cleaner if configuration.db_resetter    == :database_cleaner
+        configuration.before.call
+
+        block.call
+      end
+    end
+
+    private
+      def configuration
+        Cypress.configuration
+      end
+
+      def boot_rails
+        ENV['RAILS_ENV'] ||= 'test'
+        require './config/environment'
+        require 'capybara/rails'
+
+        Capybara.current_driver = :selenium # oh, the irony....
+        Capybara.current_session.server.port
+      end
+
+      def load_cypress_helper
+        require "./spec/cypress/cypress_helper"
+        configuration.disable_class_caching if mode == 'open'
+      end
+
+      def reset_rspec
+        RSpec::Mocks.teardown
+        RSpec::Mocks.setup
+      end
+
+      def call_database_cleaner
+        require 'database_cleaner'
+        DatabaseCleaner.strategy = :truncation
+        DatabaseCleaner.clean
+      end
+  end
+end

data/lib/cypress/version.rb

@@ -0,0 +1,3 @@
+module Cypress
+  VERSION = "0.1".freeze
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,52 @@
+module Cypress
+  class InstallGenerator < Rails::Generators::Base
+    def install
+      empty_directory "spec/cypress"
+      empty_directory "spec/cypress/integrations"
+      empty_directory "spec/cypress/scenarios"
+      empty_directory "spec/cypress/support"
+
+      create_file "spec/cypress/cypress_helper.rb", <<-FILE
+Cypress.configure do |c|
+  # change this to nil, if you are not using RSpec Mocks
+  c.test_framework = :rspec
+
+  # change this to nil, if you are not using DatabaseCleaner
+  c.db_resetter = :database_cleaner
+
+  c.before do
+    # this is called when you call cy.setupScenario
+    # use it to reset your application state
+  end
+end
+FILE
+
+    create_file "spec/cypress/integrations/simple_spec.js", <<-FILE
+describe('My First Test', function() {
+  it('visit root', function() {
+    // This calls to the backend to prepare the application state
+    // see the scenarios directory
+    cy.setupScenario('basic')
+
+    // The application unter test is available at SERVER_PORT
+    cy.visit('http://localhost:'+Cypress.env("SERVER_PORT"))
+  })
+})
+FILE
+
+    create_file "spec/cypress/scenarios/basic.rb", <<-FILE
+scenario :basic do
+  # You can setup your Rails state here
+  # MyModel.create name: 'something'
+end
+FILE
+
+    create_file "spec/cypress/integrations/simple_spec.js", <<-FILE
+// dont remove this command
+Cypress.Commands.add('setupScenario', function(name) {
+  Cypress.log({ message: name })
+  cy.request('POST', Cypress.env("CALLBACK"), JSON.stringify({ scenario: name }))
+});
+FILE
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cypress-on-rails
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- miceportal team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: selenium-webdriver
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integrates cypress with rails
+email: info@miceportal.de
+executables:
+- cypress
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/cypress
+- cypress-on-rails.gemspec
+- lib/cypress-on-rails.rb
+- lib/cypress.rb
+- lib/cypress/callback_server.rb
+- lib/cypress/configuration.rb
+- lib/cypress/runner.rb
+- lib/cypress/scenario_bank.rb
+- lib/cypress/server.rb
+- lib/cypress/version.rb
+- lib/generators/install_generator.rb
+homepage: http://github.com/konvenit/cypress-on-rails
+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: cypress-on-rails
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Integrates cypress with rails
+test_files: []