seed_builder 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ecee50238e268d48a12368a6120f6e5aacdce21672621a19b6bbdf82215585e
-  data.tar.gz: '059a0424d354435ef544dc6627541d9ac64de3b25aad0191050a378dbdb81b27'
+  metadata.gz: 85c0a52e743506b14e76f91dbf1b0e8a524d6edb934df69490303200b37513ee
+  data.tar.gz: 5a4f1a7083612b45fbc663c15b8ea48a1efbbaaef8a08149619a6fe4a804f499
 SHA512:
-  metadata.gz: 6d79169514a3b938ad45c8e57e68bb14f6de8e69cae56ac49cbc495fb64b314ea601d2798aebb42233b5b6f36d51d3b6666f9e7cec5746d69eb3a6d140089469
-  data.tar.gz: e9eb0af111a273efd24f7b883de27ff055ef8c19124475c4492fc7da553aa417135c06fab0506189afa48d327f6e6448b8fbbb00d166ae095479c88dee81d52c
+  metadata.gz: 893889ebedc9e81076d5234ab0bb46eba553704055aaa96c8e63aab6d70753eaf53425b04cf0a00f55149d865829c84a7d4a50d102ff02ed9389f1f6440597dc
+  data.tar.gz: e61fb9c54039470ce71bcdbdc9d460d30751b458cc44ce85eb4de359b4d020c19c05cc55ab90991e142c056d45a596a3f39d07297623fdb3f30fae992f9ba09c

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.2.0
+
+- Automatically configure loader for Rails seeds
+- Add `use_seed_loader` config option to control loader usage
+
+# 1.1.0
+
+- Fix `seeds_path` to be relative to Rails root
+- Improve test coverage for generator
+
 # 1.0.1
 
 - Fix boolean config options to properly handle `nil` and `false` values

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seed_builder (1.0.1)
+    seed_builder (1.2.0)
       activerecord (>= 6, < 8.1)
       rails (>= 6, < 8.1)
 

data/README.md

@@ -57,7 +57,7 @@ SeedBuilder.config.load_default_seeds = false
 Absolute path will be resolved by using `Rails.root`.
 
 ```ruby
-SeedBuilder.config.seeds_relative_path = "db/seeds"
+SeedBuilder.config.seeds_path = "db/seeds"
 ```
 
 ### Turn off test script generation
@@ -66,6 +66,12 @@ SeedBuilder.config.seeds_relative_path = "db/seeds"
 SeedBuilder.config.generate_spec = false
 ```
 
+### Turn off loader usage for ActiveRecord
+
+```ruby
+SeedBuilder.config.use_seed_loader = false
+```
+
 ## Specification checklist
 
 - [x] User can generate seed file under `db/seeds` directory with common format

data/lib/generators/templates/seed.rb.tt

@@ -6,7 +6,7 @@ end
 <%- if SeedBuilder.config.generate_spec? %>
 
 # TESTING:
-# - bin/rspec <%= SeedBuilder.config.seeds_relative_path %>/<%= migration_number %>_<%= migration_file_name %>.rb
+# - bin/rspec <%= SeedBuilder.config.seeds_path %>/<%= migration_number %>_<%= migration_file_name %>.rb
 if Rails.env.test? && Object.const_defined?(:RSpec)
   require "rails_helper"
 

data/lib/rails_config.rb

@@ -1,3 +1,3 @@
-if Object.const_defined?(:ActiveRecord)
+if Object.const_defined?(:ActiveRecord) && SeedBuilder.config.use_seed_loader?
   ActiveRecord::Tasks::DatabaseTasks.seed_loader = SeedBuilder::Loader.new
 end

data/lib/seed_builder/config.rb

@@ -7,16 +7,16 @@ module SeedBuilder
 
     attr_writer :seeds_path
     def seeds_path
-      @seeds_path ||= Rails.root.join(seeds_relative_path)
+      @seeds_path ||= "db/seeds"
     end
 
-    def seeds_path_glob
-      "#{seeds_path}/*.rb"
+    attr_writer :seeds_full_path
+    def seeds_full_path
+      @seeds_full_path ||= Rails.root.join(seeds_path)
     end
 
-    attr_writer :seeds_relative_path
-    def seeds_relative_path
-      @seeds_relative_path ||= "db/seeds"
+    def seeds_path_glob
+      "#{seeds_full_path}/*.rb"
     end
 
     attr_writer :load_default_seeds
@@ -33,5 +33,10 @@ module SeedBuilder
     def generate_spec?
       @generate_spec.nil? ? true : @generate_spec
     end
+
+    attr_writer :use_seed_loader
+    def use_seed_loader?
+      @use_seed_loader.nil? ? true : @use_seed_loader
+    end
   end
 end

data/lib/seed_builder.rb

@@ -2,7 +2,7 @@ require "seed_builder/config"
 require "seed_builder/loader"
 
 module SeedBuilder
-  VERSION = "1.0.1".freeze
+  VERSION = "1.2.0".freeze
 
   module_function
 
@@ -14,3 +14,5 @@ module SeedBuilder
     yield config
   end
 end
+
+require "rails_config"

data/spec/generator_spec.rb

@@ -7,12 +7,18 @@ describe SeedGenerator, type: :generator do
 
   subject(:generator) { described_class.start params }
   let(:destination_root) { File.expand_path("../../tmp/rspec", __FILE__) }
+  let(:seeds_path) { rails_root.join("db/seeds") }
 
-  let(:params) { ["create_users"] }
+  let(:seed_name) { "create_users" }
+  let(:params) { [seed_name] }
+
+  let(:created_files) { Dir["#{seeds_path}/*_#{seed_name}.rb"] }
+  let(:file_contents) { File.readlines(created_files.first).map(&:strip).reject(&:blank?) }
 
   before do
     mkdir_p destination_root
 
+    allow(SeedBuilder.config).to receive(:seeds_path).and_return(seeds_path)
     allow(Rails).to receive(:root).and_return(rails_root(destination_root))
   end
 
@@ -22,7 +28,23 @@ describe SeedGenerator, type: :generator do
 
   it "creates a migration file" do
     generator
-    seed_files = Dir[rails_root.join("db/seeds/*_create_users.rb")]
-    expect(seed_files).not_to be_empty
+
+    expect(created_files).not_to be_empty
+    expect(file_contents).to include("class CreateUsers")
+    expect(file_contents).not_to include("RSpec.describe CreateUsers")
+  end
+
+  context "when generate_spec is false" do
+    before do
+      allow(SeedBuilder.config).to receive(:generate_spec?).and_return(false)
+    end
+
+    it "does not create a spec file" do
+      generator
+
+      expect(created_files).not_to be_empty
+      expect(file_contents).to include("class CreateUsers")
+      expect(file_contents).not_to include("RSpec.describe CreateUsers")
+    end
   end
 end

data/spec/seed_builder/config_spec.rb

@@ -8,7 +8,7 @@ describe SeedBuilder::Config do
   end
 
   it "has default seeds path" do
-    expect(config.seeds_relative_path).to eq "db/seeds"
+    expect(config.seeds_path).to eq "db/seeds"
   end
 
   it "has default load_seeds" do
@@ -23,8 +23,8 @@ describe SeedBuilder::Config do
     expect(config.generate_spec?).to be true
   end
 
-  it "has default seeds_path" do
-    expect(config.seeds_path).to eq Rails.root.join("db/seeds")
+  it "has default seeds_full_path" do
+    expect(config.seeds_full_path).to eq Rails.root.join("db/seeds")
   end
 
   it "has default seeds_path_glob" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seed_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-08 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails