cypress-on-rails 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f9cbd99f7da9dce7af96793994e292e74e5c5a1
-  data.tar.gz: f16a4b910fbc00b5878a71817968c5e01a2a24be
+  metadata.gz: 307be16313426be599e503b2612ab3f33c8d4b54
+  data.tar.gz: 81a10e2d6563f57cc3e2a5cb71d0547d2366b278
 SHA512:
-  metadata.gz: 6b2d320c20555076caa3740d6e08eac654c8d60e83ef5754d1d1b9d284fb271747f51652bc0c302cac50a30f5fcf12d2ea50929d5a81d79f08ac721d3767d943
-  data.tar.gz: 24bcaf7c815bcc5abd4bd05bb726ea566eacf7b8d4d26f4f2025a6aef26bb1b6865a618becabaeab6eccf34e9e7aedcb5b718fce3bc4ed36b3f94f0da7187433
+  metadata.gz: baa22d4846debaec324dc1641410a27e523665fea8bcf70624d165955809ec03054acd81564cb3075f6ff6c4ed1b29014fe23746f6bfa0a6f5ab8a0167d2979e
+  data.tar.gz: 2fe3bb98ea96886a22d509a9881127cb10faa505b172734e41993063ebf5d6e9ee128a3bad2ee6884f3dc7e9585ef423ca0019ff5b3568f26805ed99801b0251

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.5 (2017-11-01)
+
+### Added
+* `cy.rails` command for executing raw ruby on the backend
+* `cy.setupRails` command for resetting application state
+* `cypress:install` generator now adds a `beforeEach` call to `cy.setupRails`
+* `cypress:install` generator configures the `cache_classes` setting in `config/environments/test.rb`
+* configuration option to include further modules in your runcontext
+
+## 0.1.2 (2017-10-31)
+* First release.

data/README.md

@@ -1 +1,107 @@
-# cypress-on-rails
+# cypress-on-rails
+
+Proof-of-Concept gem for using [cypress.io](http://github.com/cypress-io/) in Rails applications. It provides the following features:
+* run ruby code in your application context before executing a test
+* database cleaning before test run (using database_cleaner)
+* ability to use RSpec Mocks for your Rails code
+
+## Getting started
+
+Add this to your Gemfile:
+```
+group :test do
+  gem 'cypress-on-rails'
+end
+```
+
+The generate the boilerplate code using:
+```
+rails g cypress:install
+```
+
+Finally add the `cypress` package using yarn:
+```
+yarn add --dev cypress
+```
+
+If you are not using RSpec and/or database_cleaner look at `spec/cypress/cypress_helper.rb`.
+
+## Usage
+
+This gem provides the `cypress` command. When called without any arguments ie. `bundle exec cypress`, it will start the cypress.io UI. While running the UI you can edit both your application and test code and see the effects on the next test run. When run as `bundle exec cypress run` it runs headless for CI testing.
+
+The generator adds the following files/directory to your application:
+* `spec/cypress/cypress_helper.rb` contains your configuration
+* `spec/cypress/integrations/` contains your tests
+* `spec/cypress/scenarios/` contains your scenario definitions
+* `spec/cypress/support/setup.js` contains support code
+
+When writing End-to-End tests, you will probably want to prepare your database to a known state. Maybe using a gem like factory_girl. This gem implements two methods to achieve this goal:
+
+### 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() {
+    // This calls to the backend to prepare the application state
+    cy.rails(`
+      Profile.create name: "Cypress Hill"
+    `)
+
+    // The application unter test is available at SERVER_PORT
+    cy.visit('http://localhost:'+Cypress.env("SERVER_PORT"))
+
+    cy.contains("Cypress Hill")
+  })
+})
+
+Use the (`) backtick string syntax to allow multiline strings.
+
+### Using scenarios
+
+Scenarios are named `before` blocks that you can reference in your test.
+
+You define a scenario in the `spec/cypress/scenarios` directory:
+```
+# spec/cypress/scenarios/basic.rb
+scenario :basic do
+  Profile.create name: "Cypress Hill"
+end
+```
+
+Then reference the scenario in your test:
+```
+// spec/cypress/integrations/simple_spec.js
+describe('My First Test', function() {
+  it('visit root', function() {
+    // This calls to the backend to prepare the application state
+    cy.setupScenario('basic')
+
+    // The application unter test is available at SERVER_PORT
+    cy.visit('http://localhost:'+Cypress.env("SERVER_PORT"))
+
+    cy.contains("Cypress Hill")
+  })
+})
+```
+
+The `setupScenario` call does the following things:
+* clears the database using database_cleaner (can be disabled)
+* calls the optional `before` block from `spec/cypress/cypress_helper.rb`
+* calls the scenario block associated with the name given
+
+In the scenario you also have access to RSpec mocking functions. So you could do something like:
+```
+scenario :basic do
+  allow(ExternalService).to receive(:retrieve).and_return("result")
+end
+```
+
+An example application is available at https://github.com/konvenit/cypress-on-rails-example
+
+# Limitations
+This code is very much at the proof-of-concept stage. The following limitations are known:
+* It requires yarn for the javascript dependency management
+* Only tested on Rails 5.1
+* Only works with RSpec and database_cleaner

data/lib/cypress.rb

@@ -3,11 +3,12 @@ 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'
+  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'
 
   def self.configuration
     @configuration ||= Configuration.new

data/lib/cypress/callback_server.rb

@@ -1,11 +1,22 @@
+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 '/' do |req, res|
-        owner.run_command JSON.parse(req.body)
+      @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

data/lib/cypress/configuration.rb

@@ -8,6 +8,10 @@ module Cypress
       @before         = proc {}
     end
 
+    def include(mod)
+      ScenarioContext.send :include, mod
+    end
+
     def before(&block)
       if block_given?
         @before = block

data/lib/cypress/scenario_bank.rb

@@ -4,13 +4,6 @@ module Cypress
       @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)

data/lib/cypress/scenario_context.rb

@@ -0,0 +1,23 @@
+module Cypress
+  class ScenarioContext
+    def initialize(configuration)
+      if configuration.test_framework == :rspec
+        setup_rspec
+      end
+    end
+
+    def execute(block_or_code)
+      if block_or_code.is_a? Proc
+        instance_eval &block_or_code
+      else
+        instance_eval block_or_code
+      end
+    end
+
+    private
+      def setup_rspec
+        require 'rspec/rails'
+        extend RSpec::Mocks::ExampleMethods
+      end
+  end
+end

data/lib/cypress/server.rb

@@ -1,6 +1,3 @@
-require 'webrick'
-require 'json'
-
 module Cypress
   class Server
     def initialize(args)
@@ -19,9 +16,7 @@ module Cypress
     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 }
@@ -30,15 +25,9 @@ module Cypress
       @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
+    def run_command(command, options={})
+      if respond_to?("run_command_#{command}", true)
+        send "run_command_#{command}", options
       end
     end
 
@@ -48,17 +37,18 @@ module Cypress
       end
 
       def boot_rails
-        ENV['RAILS_ENV'] ||= 'test'
-        require './config/environment'
+        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 load_cypress_helper
-        require "./spec/cypress/cypress_helper"
-        configuration.disable_class_caching if mode == 'open'
+      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
@@ -71,5 +61,22 @@ module Cypress
         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

data/lib/cypress/version.rb

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

data/lib/generators/install_generator.rb

@@ -6,7 +6,16 @@ module Cypress
       empty_directory "spec/cypress/scenarios"
       empty_directory "spec/cypress/support"
 
+      replace = [
+        "# when running the cypress UI, allow reloading of classes",
+        "config.cache_classes = (defined?(Cypress) ? Cypress.configuration.cache_classes : true)"
+      ]
+      gsub_file 'config/environments/test.rb', 'config.cache_classes = true', replace.join("\n")
+
       create_file "spec/cypress/cypress_helper.rb", <<-FILE
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../../config/environment', __FILE__)
+
 Cypress.configure do |c|
   # change this to nil, if you are not using RSpec Mocks
   c.test_framework = :rspec
@@ -18,6 +27,9 @@ Cypress.configure do |c|
     # this is called when you call cy.setupScenario
     # use it to reset your application state
   end
+
+  # add a module to your run context
+  # c.include MyModule
 end
 FILE
 
@@ -42,11 +54,23 @@ end
 FILE
 
     create_file "spec/cypress/support/setup.js", <<-FILE
-// dont remove this command
+// 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"), JSON.stringify({ scenario: name }))
+  cy.request('POST', Cypress.env("CALLBACK")+"/scenario", JSON.stringify({ scenario: name }))
 });
+
+Cypress.Commands.add('rails', function(code) {
+  cy.request('POST', Cypress.env("CALLBACK") + "/eval", JSON.stringify({ code: code }))
+})
+// cypress-on-rails: end
+
+// The next setup is optional, but if you remove it you will have to manually reset the database
+beforeEach(() => { cy.setupRails() });
 FILE
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - miceportal team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -73,6 +74,7 @@ files:
 - 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