fixture_farm 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bb437d76da7783d3bcec79d5eb456dfc6279aaf147e4299323c072cb5823ba3
-  data.tar.gz: 3dbadf4de6166743fb4eeb23c1389479dcdbd6341d0aaed7757478ada4be3042
+  metadata.gz: 9120ab7f693c781ea48772f5b4f9d277165771afc073f6ed466c88a5fdea2455
+  data.tar.gz: 50b502cab64010626ea929ecf3702b51c4211b98db14a013adb1194c687073a5
 SHA512:
-  metadata.gz: 31a03a177602b04b48a047ab1cd0d8820784ebc4fc9524e0577eeac5c165579db49891f739ee15e593b57f631388ada0d47d9d1236e31d5a8da2abbdda9797db
-  data.tar.gz: d385f242b1d5670f0e1ffc70985f40c5297dcd97f5e25c870f205e06f598faaf8c9e6bb0f45bbccb82cf9d4f1e2614558718dc10d618fb6584ecde162226155d
+  metadata.gz: 17eadbd5c25eb70dd41dec53f0727890bb7674ddb25bb349eca51e646e8a81f822b8736fe9e6e5ffb9e5cd7b19f7677b92e574c694dc35814d79f0441c22d6bb
+  data.tar.gz: 4403bf7831042e7abce331e3076242cf97c9916ddef4457c08322e956f0a79f9606ed1fd9f348876988741ab277461e15484577698a74d4732d2d0acd8a3a13f

data/README.md

@@ -7,6 +7,31 @@ This gem lets you do two things:
 
 Generated fixture that `belongs_to` a record from an existing fixture, will reference that fixture by name.
 
+### Limitations
+
+- doesn't update fixtures
+- doesn't delete fixtures
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixture_farm', group: %i[development test]
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install fixture_farm
+```
+
 ## Usage
 
 ### Record as you browse
@@ -14,7 +39,13 @@ Generated fixture that `belongs_to` a record from an existing fixture, will refe
 To record as you browse in development add this to `ApplicationController`:
 
 ```ruby
-include FixtureFarm::ControllerHook if Rails.env.development?
+include FixtureFarm::ControllerHook if defined?(FixtureFarm)
+```
+
+And in `ApplicationJob` if needed:
+
+```ruby
+include FixtureFarm::ActiveJobHook if defined?(FixtureFarm)
 ```
 
 Then start/stop recording using tasks:
@@ -59,24 +90,5 @@ test 'some stuff does the right thing' do
 end
 ```
 
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'fixture_farm', group: %i[development test]
-```
-
-And then execute:
-
-```bash
-bundle install
-```
-
-Or install it yourself as:
-
-```bash
-gem install fixture_farm
-```
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/fixture_farm/active_job_hook.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'fixture_farm/hook'
+
+module FixtureFarm
+  module ActiveJobHook
+    extend ActiveSupport::Concern
+    include Hook
+
+    included do
+      around_perform :record_new_fixtures, if: :record_new_fixtures?
+    end
+  end
+end

data/lib/fixture_farm/active_record_extension.rb

@@ -5,15 +5,29 @@ module FixtureFarm
     def fixture_name
       require 'active_record/fixtures'
 
-      return nil unless fixture_file_path
+      return nil unless File.exist?(fixtures_file_path)
 
-      fixtures = YAML.load_file(fixture_file_path)
+      fixtures = YAML.load_file(fixtures_file_path, permitted_classes: [ActiveSupport::HashWithIndifferentAccess])
       fixtures.keys.find do |key|
         ActiveRecord::FixtureSet.identify(key) == id
       end
     end
 
-    def fixture_file_path
+    def fixtures_file_path
+      existing_fixtures_file_path || candidate_fixtures_file_path
+    end
+
+    def candidate_fixtures_file_path
+      klass = self.class
+      loop do
+        path = Rails.root.join('test', 'fixtures', "#{klass.to_s.underscore.pluralize}.yml")
+        return path if klass >= ActiveRecord::Base || !klass.columns.map(&:name).include?(klass.inheritance_column)
+
+        klass = klass.superclass
+      end
+    end
+
+    def existing_fixtures_file_path
       klass = self.class
 
       while klass < ActiveRecord::Base

data/lib/fixture_farm/controller_hook.rb

@@ -1,29 +1,14 @@
 # frozen_string_literal: true
 
-require "fixture_farm/fixture_recorder"
+require "fixture_farm/hook"
 
 module FixtureFarm
   module ControllerHook
     extend ActiveSupport::Concern
+    include Hook
 
     included do
       around_action :record_new_fixtures, if: :record_new_fixtures?
     end
-
-    private
-
-    def record_new_fixtures(&block)
-      fixture_recorder = FixtureRecorder.resume_recording_session
-
-      fixture_recorder.record_new_fixtures do
-        block.call
-      end
-    ensure
-      fixture_recorder.update_recording_session
-    end
-
-    def record_new_fixtures?
-      FixtureRecorder.recording_session_in_progress?
-    end
   end
 end

data/lib/fixture_farm/fixture_recorder.rb

@@ -13,7 +13,7 @@ module FixtureFarm
     def self.resume_recording_session
       start_recording_session! unless recording_session_in_progress?
 
-      recording_session = JSON.load_file(STORE_PATH)
+      recording_session = JSON.load_file(STORE_PATH, permitted_classes: [ActiveSupport::HashWithIndifferentAccess])
 
       new_models = recording_session['new_models'].map do |(class_name, id)|
         class_name.constantize.find(id)
@@ -113,30 +113,49 @@ module FixtureFarm
           end
 
           if belongs_to_association
-            associated_model_instance = model_instance.public_send(belongs_to_association.name)
+            associated_model_instance = find_assiciated_model_instance(model_instance, belongs_to_association)
 
             associated_fixture_name = named_new_fixtures.find do |_, fixture_model|
               fixture_model.id == associated_model_instance.id
             end&.first || associated_model_instance.fixture_name
 
             [belongs_to_association.name.to_s, associated_fixture_name]
-          else
+          elsif model_instance.column_for_attribute(k).type
             [k, serialize_attributes(v)]
           end
-        end.to_h
+        end.compact.to_h
 
-        fixture_file_path = model_instance.fixture_file_path || Rails.root.join('test', 'fixtures', "#{model_instance.class.table_name}.yml")
+        yaml_attributes.delete('created_at') if yaml_attributes['created_at'] == '<%= Time.zone.now %>'
+        yaml_attributes.delete('updated_at') if yaml_attributes['updated_at'] == '<%= Time.zone.now %>'
 
-        fixtures = File.exist?(fixture_file_path) ? YAML.load_file(fixture_file_path) : {}
+        fixtures_file_path = model_instance.fixtures_file_path
+
+        fixtures = File.exist?(fixtures_file_path) ? YAML.load_file(fixtures_file_path, permitted_classes: [ActiveSupport::HashWithIndifferentAccess]) : {}
         fixtures[new_fixture_name] = yaml_attributes
 
-        File.open(fixture_file_path, 'w') do |file|
+        FileUtils.mkdir_p(fixtures_file_path.dirname)
+
+        File.open(fixtures_file_path, 'w') do |file|
           yaml = YAML.dump(fixtures).gsub(/\n(?=[^\s])/, "\n\n").delete_prefix("---\n\n")
           file.write(yaml)
         end
       end
     end
 
+    # Clear default_scope before finding associated model record.
+    # This, in particular, turns off ActsAsTenant, that otherwise
+    # might return no record if the tenant has changed by this point.
+    def find_assiciated_model_instance(model_instance, association)
+      associated_model_class = if association.polymorphic?
+                                 model_instance.public_send(association.foreign_type).safe_constantize
+                               else
+                                 association.klass
+                               end
+
+      id = model_instance.public_send(association.foreign_key)
+      associated_model_class.unscoped.find(id)
+    end
+
     def serialize_attributes(value)
       case value
       when ActiveSupport::TimeWithZone, Date

data/lib/fixture_farm/hook.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "fixture_farm/fixture_recorder"
+
+module FixtureFarm
+  module Hook
+    def record_new_fixtures(&block)
+      fixture_recorder = FixtureRecorder.resume_recording_session
+      fixture_recorder.record_new_fixtures { block.call }
+    ensure
+      fixture_recorder.update_recording_session
+    end
+
+    private
+
+    def record_new_fixtures?
+      FixtureRecorder.recording_session_in_progress?
+    end
+  end
+end

data/lib/fixture_farm/version.rb

@@ -1,3 +1,3 @@
 module FixtureFarm
-  VERSION = '0.1.2'
+  VERSION = '0.1.5'
 end

data/lib/fixture_farm.rb

@@ -5,10 +5,11 @@ require 'fixture_farm/version'
 module FixtureFarm
   autoload :ActiveRecordExtension, 'fixture_farm/active_record_extension'
   autoload :ControllerHook, 'fixture_farm/controller_hook'
+  autoload :ActiveJobHook, 'fixture_farm/active_job_hook'
   autoload :TestHelper, 'fixture_farm/test_helper'
   autoload :FixtureRecorder, 'fixture_farm/fixture_recorder'
 end
 
-ActiveSupport.on_load(:active_record) do |base|
-  base.include FixtureFarm::ActiveRecordExtension
+ActiveSupport.on_load(:active_record) do
+  include FixtureFarm::ActiveRecordExtension
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fixture_farm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - artemave
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '6.2'
 description: 
 email:
 - mr@artem.rocks
@@ -45,9 +39,11 @@ files:
 - bin/fixture_farm
 - bin/fixture_farm.rb
 - lib/fixture_farm.rb
+- lib/fixture_farm/active_job_hook.rb
 - lib/fixture_farm/active_record_extension.rb
 - lib/fixture_farm/controller_hook.rb
 - lib/fixture_farm/fixture_recorder.rb
+- lib/fixture_farm/hook.rb
 - lib/fixture_farm/test_helper.rb
 - lib/fixture_farm/version.rb
 homepage: https://github.com/featurist/fixture_farm