dumped_railers 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440f4c535538d4dc81d6b117d26c27a9639146776b11fa5358ee90bbd8528b8b
-  data.tar.gz: ea53e8c0ca3a4220432bfcf40895e79a5bff18b616965b2627db7f78b73b39b0
+  metadata.gz: e4a93dbe684079409978553480483dbd5d2727f1f694470a8b62e89e0715fbe8
+  data.tar.gz: 266714eaca3eb9311effa69a5a6a1d4d784c758f04ea50574d24a44fcbe6a210
 SHA512:
-  metadata.gz: 847f16c2456ddd871963feee72a95e57bffac72a63c7c67f714b93dfb7c95698f0ee44f368b0f2166a1a1bd1cc4bd9a4bc3d084fd0fc556c055d233bcc9f67f9
-  data.tar.gz: 11e9d92b573fa02f1602af0035d5834648d6893b0b04c6ad64729c6b19504b99ba3ce1bdea7ee9c04a02e2833164a5c1e10e809badd8eacb09f06c35f4eb9c43
+  metadata.gz: f858057d3a62e389a01580a42fc926491a6c55e1f351a27a1d631fffba06727ccfecf6109848e1d547897218924398f1dc1176d9733205d8164cb7332987dae3
+  data.tar.gz: 4ee34e3d764eb00f8b244fdacce154f94cae38a6839c71bd7b640907fea235c84d8eaf83b1519fc6872fe305383d031253a55b5f91b79d39b5c96facb821c4f8

data/CHANGELOG.md

@@ -22,4 +22,7 @@
 - Cope with relations that has different name with the actual class name
   (e.g. associations defined using `:class_name` and `:foreign_key` options)
 
-
+## [0.1.4]
+### Changed
+- Update documents not to eagerload DumpedRailers to prevent accidental data breakage / leakage.
+  To activate, it is preferable to require explicitly where necessary.

data/README.md

@@ -22,7 +22,10 @@ This feature can particularily help you in the following senarios:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dumped_railers'
+# if you use this gem in production, `require: false` would be recommended
+# to prevent accidental database leakage/breakage.
+
+gem 'dumped_railers', require: false
 ```
 
 And then execute:
@@ -37,7 +40,13 @@ Or install it yourself as:
 
 ### Getting Started
 
-* if you want to dump (let's say) User, Item, and Tag models, just run the following.
+* Require dumped_railers where necessary (e.g. in your rake tasks, or script files)
+
+```ruby
+require 'dumped_railers'
+```
+
+* if you want to dump records from (let's say) User, Item, and Tag, just run the following.
 
 ```ruby
 DumpedRailers.dump!(User, Item, Tag, base_dir: 'tmp/fixtures/')
@@ -146,9 +155,13 @@ class Egg < ActiveRecord::Base
 end
 ```
 
-* When exception raised, checking your log might give you a good hint (desperately staring at the backtrace won't give much information)
+* For the same reason, self-associated model cannot be imported currently. (might be updated in the future version)
+
+* When an exception was raised, checking your log might give you a good hint (desperately staring at the backtrace won't give much information)
   consider displaying `tail -f logs/development.log` while executing your script.
 
+* DumpedRailers is tested against various association types, as long as target models and underlying tables have 1-on-1 mapping (straightforward ActiveRecord pattern). Currently we haven't test this against STI, CTI, as such. Applying this gem to such models might lead to some unexpected results.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/dumped_railers/version.rb

@@ -1,3 +1,3 @@
 module DumpedRailers
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dumped_railers
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Koji Onishi
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.0
 signing_key: 
 specification_version: 4
 summary: A flexible fixture importer/exporter, that can transport ActiveRecord data