cypress-on-rails 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177b927f449263bee75b6df1264121d3786b42b84f628774d132ab16e9bd2661
-  data.tar.gz: 1bf70138742d1a0c5cb4e0251196a4b1ac01757d657f8afdb5a66d59c8b08360
+  metadata.gz: 32a416c65647445473bce7bcf306bda04eafb673d8d4af20c795f13692f4da8e
+  data.tar.gz: ee456e7396cfa0d94cc9cd80d0a54dc6c89248254c3855b66578f8e214a0982d
 SHA512:
-  metadata.gz: c853ec1f0a8859a9ceb10bcc5574dcbc4a0cccf92410082bdeb571d5730cefa6ebec1f67ee7ffd0ca1f2f4d52a0c3c13207b72dbae138f80356ad8eaae8d7afa
-  data.tar.gz: b7bba0522ca422efc3de8fbed04d44cd9e4d4662a8fde0a504284f9a8fe304f2ab2e7256a737789fc855360d49c2f43b071021938019482c9dd166f4315481ed
+  metadata.gz: 4022aeb303bf3fa6514cd2b221869bb531e7e0be1b85de8f35ba20f6e5d2ff9fc8062ab2560a7d71d17ce0931719c3e57a33b23b25e3fa3ddb60a02de579c527
+  data.tar.gz: 18d9b6423eb5fafbf2bf756de4b9e72fc8a5dc8b0240a15a1598e97f16acac6e589ff591493158ced0779374a27a347525c75eb4b4d1b9b2dd16364276afd10d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.12.1]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.12.0...v1.12.1
+
+### Tasks
+* Documenting how to setup Factory Associations [PR 100](https://github.com/shakacode/cypress-on-rails/pull/100)
+
+### Fixed
+* keep track of factory manual reloads to prevent auto_reload from reloading again [PR 98](https://github.com/shakacode/cypress-on-rails/pull/98)
+
 ## [1.12.0]
 [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.11.0...v1.12.0
 

data/README.md

@@ -132,17 +132,6 @@ node_modules/.bin/cypress run
 
 You can run your [factory_bot](https://github.com/thoughtbot/factory_bot) directly as well
 
-```ruby
-# spec/cypress/app_commands/factory_bot.rb
-require 'cypress_on_rails/smart_factory_wrapper'
-
-CypressOnRails::SmartFactoryWrapper.configure(
-  always_reload: !Rails.configuration.cache_classes,
-  factory: FactoryBot,
-  files: Dir['./spec/factories/**/*.rb']
-)
-```
-
 ```js
 // spec/cypress/integrations/simple_spec.js
 describe('My First Test', function() {
@@ -166,6 +155,7 @@ describe('My First Test', function() {
   })
 })
 ```
+You can check the [association Docs](https://github.com/shakacode/cypress-on-rails/blob/master/docs/factory_bot_associations.md) on more ways to setup association with the correct data.
 
 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

data/docs/factory_bot_associations.md

@@ -0,0 +1,109 @@
+# Setting up associations with the correct data
+
+You cannot access associations directly from Cypress like you can do with ruby tests.
+So setting up associations has to be done differently from within Cypress.
+
+There are a few ways you can setup associations with the correct data using Cypress and FactoryBot.
+1. Setting the foreign keys
+2. Using transient attributes
+3. Using Nested Attributes
+4. Combination of the above depending on your situation
+
+Assuming you have the following models
+
+```rb
+class Post < ApplicationRecord
+  belongs_to :author
+  accepts_nested_attributes_for :author
+end
+
+class Author < ApplicationRecord
+  has_many :posts
+  accepts_nested_attributes_for :posts
+end
+```
+
+You can do the following:
+
+## 1. Setting the foreign keys
+
+factories.rb
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    title { 'Cypress on Rails is Awesome' }
+    author_id { create(:author).id }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'author', { name: 'James' }]]).then((records) => {
+  cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_id: records[0].id }]]
+});
+
+// example without overriding anything
+cy.appFactories([['create', 'author']]).then((records) => {
+  cy.appFactories([['create', 'post', { author_id: records[0].id }]]
+});
+```
+
+## 2. Using transient attributes
+
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    transient do
+      author_name { 'Taylor' }
+    end
+    title { 'Cypress on Rails is Awesome' }
+    author { create(:author, name: author_name ) }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_name: 'James' }]]
+
+// example without overriding
+cy.appFactories([['create', 'post']]
+```
+
+## 3. Using Nested Attributes
+
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    title { 'Cypress on Rails is Awesome' }
+    author_attributes { { name: 'Taylor' } }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_attributes: { name: 'James' } }]]
+
+// example without overriding
+cy.appFactories([['create', 'post']]
+
+// example of creating author with multiple posts
+cy.appFactories([['create', 'author', { name: 'James', posts_attributes: [{ name: 'Cypress is cool' }, {name: 'Rails is awesome' }] ]]
+```

data/lib/cypress_on_rails/smart_factory_wrapper.rb

@@ -80,6 +80,7 @@ module CypressOnRails
     end
 
     def reload
+      @latest_mtime = current_latest_mtime
       logger.info 'Loading Factories'
       factory.reload
       files.each do |file|
@@ -105,14 +106,16 @@ module CypressOnRails
       CypressOnRails.configuration.logger
     end
 
+    def current_latest_mtime
+      files.map{|file| @file_system.mtime(file) }.max
+    end
+
     def auto_reload
-      current_latest_mtime = files.map{|file| @file_system.mtime(file) }.max
-      return unless should_reload?(current_latest_mtime)
-      @latest_mtime = current_latest_mtime
+      return unless should_reload?
       reload
     end
 
-    def should_reload?(current_latest_mtime)
+    def should_reload?
       @always_reload || @latest_mtime.nil? || @latest_mtime < current_latest_mtime
     end
   end

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.12.0'.freeze
+  VERSION = '1.12.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - miceportal team
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-03 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -100,6 +100,7 @@ files:
 - Rakefile
 - cypress-on-rails.gemspec
 - docs/authentication.md
+- docs/factory_bot_associations.md
 - lib/cypress-on-rails.rb
 - lib/cypress/smart_factory_wrapper.rb
 - lib/cypress_dev.rb