cypress-on-rails 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c6280b01cef6fe5088f9a3d1098acf69a116f6118e219992f961f7af7f1a6d
-  data.tar.gz: 8408f84cf6d400a87136243c34c49ed228ccde27f14e824aa88d053bf435ad78
+  metadata.gz: 3b8019daab6920154502f30e3a0bc5acb508d3e54cb7befe5274442b70724e02
+  data.tar.gz: 626901503a647087b14785b8d0df09c1033a01be4cf4f8456beeed376880f5a8
 SHA512:
-  metadata.gz: d72faf8adc3ed46442e0bcd91b5420d3dda942192ba014f4ce435284448e06a44de95f72c5d5a007357902eab0d64a7f4965da839c966243997a56ebcecab3e9
-  data.tar.gz: 25e8fad0237b6e3f0a891a4d202273257210e42a0056db6026a70a3cbc0c6851a3763e7c2e70016ab76ec3efc7586d786741e271cd0855d52741e6387d6064ed
+  metadata.gz: 7379070d5df5642e4d9c45dcd3b935784278b409dde546dd9d8e334d54c473f5b3daf1b0061edc9dcabf2b15d3e1b0a6cf4fb9e75ce7d3bf2bf527f0af29dd85
+  data.tar.gz: 65dde5afa09ef3a862a19928cd76ead9c5f2755c4c15d22c3b978882ae58393ffbbe8799c4e1e6641301fcd20bb82342220029679443249bf8f1671b91c25c83

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-## [1.10.0]
-[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.9.1...v1.10.0
+## [1.11.0]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.10.1...v1.11.0
+
+### Changed
+* improve app command logging on cypress 
+* Allow build and build_list commands to be executed against factory bot [PR 87](https://github.com/shakacode/cypress-on-rails/pull/87) by [Alexander-Blair]
+
+## [1.10.1]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.9.1...v1.10.1
 
 ### Changed
 * improve error message received from failed command

data/README.md

@@ -4,7 +4,9 @@
 
 ----
 
-This project is sponsored by the software consulting firm [ShakaCode](https://www.shakacode.com), creator of the [React on Rails Gem](https://github.com/shakacode/react_on_rails). We focus on React front-ends, often with Ruby on Rails or Gatsby. The best way to see what we do is to see the details of [our recent work](https://www.shakacode.com/recent-work). Feel free to engage in discussions around this gem at our [forum category for Cypress](https://forum.shakacode.com/c/cypress-on-rails/55).
+This project is sponsored by the software consulting firm [ShakaCode](https://www.shakacode.com), creator of the [React on Rails Gem](https://github.com/shakacode/react_on_rails). We focus on React (with TS or ReScript) front-ends, often with Ruby on Rails or Gatsby. See [our recent work](https://www.shakacode.com/recent-work) and [client engagement model](https://www.shakacode.com/blog/client-engagement-model/). Feel free to engage in discussions around this gem at our [Slack Channel](https://join.slack.com/t/reactrails/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE) or our [forum category for Cypress](https://forum.shakacode.com/c/cypress-on-rails/55). 
+
+Interested in joining a small team that loves open source? Check our [careers page](https://www.shakacode.com/career/).
 
 ----
 
@@ -164,6 +166,42 @@ describe('My First Test', function() {
 })
 ```
 
+In some cases, using static Cypress fixtures may not provide sufficient flexibility when mocking HTTP response bodies - it's possible to use `FactoryBot.build` to generate Ruby hashes that can then be used as mock JSON responses:
+```ruby
+FactoryBot.define do
+  factory :some_web_response, class: Hash do
+    initialize_with { attributes.deep_stringify_keys }
+
+    id { 123 }
+    name { 'Mr Blobby' }
+    occupation { 'Evil pink clown' }
+  end
+end
+
+FactoryBot.build(:some_web_response) => { 'id' => 123, 'name' => 'Mr Blobby', 'occupation' => 'Evil pink clown' }
+```
+
+This can then be combined with Cypress mocks:
+```js
+describe('My First Test', function() {
+  it('visit root', function() {
+    // This calls to the backend to generate the mocked response
+    cy.appFactories([
+      ['build', 'some_web_response', { name: 'Baby Blobby' }]
+    ]).then(([responseBody]) => {
+      cy.intercept('http://some-external-url.com/endpoint', {
+        body: responseBody
+      });
+
+      // Visit the application under test
+      cy.visit('/')
+    })
+
+    cy.contains("Hello World")
+  })
+})
+```
+
 ### Example of loading rails test fixtures
 ```ruby
 # spec/cypress/app_commands/activerecord_fixtures.rb

data/lib/cypress_on_rails/smart_factory_wrapper.rb

@@ -19,6 +19,14 @@ module CypressOnRails
       instance.create_list(*args)
     end
 
+    def self.build(*args)
+      instance.build(*args)
+    end
+
+    def self.build_list(*args)
+      instance.build_list(*args)
+    end
+
     # @return [Array]
     attr_accessor :factory
     attr_accessor :always_reload
@@ -51,6 +59,22 @@ module CypressOnRails
       factory.create_list(*args)
     end
 
+    def build(*options)
+      load_files
+      factory_name = options.shift
+      if options.last.is_a?(Hash)
+        args = options.pop
+      else
+        args = {}
+      end
+      factory.build(factory_name, *options.map(&:to_sym), args.symbolize_keys)
+    end
+
+    def build_list(*args)
+      load_files
+      factory.build_list(*args)
+    end
+
     private
 
     # @param [String,Array] arg
@@ -84,4 +108,4 @@ module CypressOnRails
       @always_reload || @latest_mtime.nil? || @latest_mtime < current_latest_mtime
     end
   end
-end
+end

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.10.1'.freeze
+  VERSION = '1.11.0'.freeze
 end

data/lib/generators/cypress_on_rails/templates/spec/cypress/support/on-rails.js

@@ -1,16 +1,18 @@
 // CypressOnRails: dont remove these command
 Cypress.Commands.add('appCommands', function (body) {
-  cy.log("APP: " + JSON.stringify(body))
+  Object.keys(body).forEach(key => body[key] === undefined ? delete body[key] : {});
+  const log = Cypress.log({ name: "APP", message: body, autoEnd: false })
   return cy.request({
     method: 'POST',
     url: "/__cypress__/command",
     body: JSON.stringify(body),
-    log: true,
+    log: false,
     failOnStatusCode: false
   }).then((response) => {
-    if (response.status != 201) {
+    log.end();
+    if (response.status !== 201) {
       expect(response.body.message).to.be.empty
-      expect(response.body.status).to.be.equal(201)
+      expect(response.status).to.be.equal(201)
     }
     return response.body
   });

data/spec/cypress_on_rails/smart_factory_wrapper_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe CypressOnRails::SmartFactoryWrapper do
   let(:mtime_hash) { {'file1.rb' => time_now, 'file2.rb' => time_now } }
   let(:files) { %w(file1.rb file2.rb) }
   let(:factory_double) do
-    class_double(FactoryBot, create: nil, create_list: nil, "definition_file_paths=": nil, reload: nil)
+    class_double(FactoryBot, create: nil, create_list: nil, build: nil, build_list: nil, "definition_file_paths=": nil, reload: nil)
   end
   let(:kernel_double) { class_double(Kernel, load: true) }
   let(:file_double) { FileSystemDummy.new(mtime_hash) }
@@ -67,6 +67,31 @@ RSpec.describe CypressOnRails::SmartFactoryWrapper do
     expect(factory_double).to have_received(:create_list).with(:note, 10)
   end
 
+  it 'delegates build to the factory' do
+    subject.build(:user)
+    expect(factory_double).to have_received(:build).with(:user, {})
+  end
+
+  it 'delegates build to the factory and symbolize keys' do
+    subject.build(:user, {'name' => "name"})
+    expect(factory_double).to have_received(:build).with(:user, {name: 'name'})
+  end
+
+  it 'delegates build to the factory and symbolize keys with trait' do
+    subject.build(:user, 'trait1', {'name' => "name"})
+    expect(factory_double).to have_received(:build).with(:user, :trait1, {name: 'name'})
+  end
+
+  it 'delegates build to the factory and symbolize keys with only trait' do
+    subject.build(:user, 'trait2')
+    expect(factory_double).to have_received(:build).with(:user, :trait2, {})
+  end
+
+  it 'delegates build_list to the factory' do
+    subject.build_list(:note, 10)
+    expect(factory_double).to have_received(:build_list).with(:note, 10)
+  end
+
   it 'wont load the files if they have not changed' do
     subject.create(:user)
     subject.create_list(:user, 2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - miceportal team
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -323,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Integrates cypress with rails or rack applications