rails_json_seeder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2c58b24d9cc7bffbf180174e4f534366784e8518bb2e2e3b1d30a4413b0213
-  data.tar.gz: 8fd0377aa419a5a56e5032d81ecfefa0112ae4185affe90c65fa3b6df7806c48
+  metadata.gz: 92ad673104e2356514757c6ca7b6c7e7c301a93ed17499a48ea7eacf67142270
+  data.tar.gz: 1500a9b9f478b034504f9eeea268744b22db60e5efa15f7b9618065b6d7dbe3a
 SHA512:
-  metadata.gz: 0af397096de31b2cf74cbae4441808abe978152804ce7b863c71af5d9f1c01d6dff005b591e81b4b17acee6b82274454fe8f930ae30e72900076e374a37f287c
-  data.tar.gz: 9e9a654af9924762d9b21373ea19544e6a80ccf373b03295d99e2f3539d8688bf6fafcc19653b12b7541326b0b80c52e0cfe808d3a64b73412e864c9ebfe3298
+  metadata.gz: 04d440f3ed93818fed9adcffebcbf1eb160e972aac6bbe93d51bf8cc9c8ade722a94b978eb54b04983074ee97de83292c01b0880128e2372c10740c78ccfd5c4
+  data.tar.gz: f080a0df2f5cf50030608fee152d7bc1b4003b9c41c33bd46f0533f891a8395dcf9cf6a01a80522a875e3b9c0c73865c03a485a654273ee6854fc67483434838

data/.rubocop.yml

@@ -18,3 +18,5 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Max: 150
 
+Metrics/BlockLength:
+  Max: 40

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+
+
+### How to start development
+#### clone repo
+```
+$ git clone git@github.com:yamamoto7/rails_json_seeder.git
+$ cd rails_json_seeder
+```
+
+#### add or edit code
+```
+├─ lib/
+   ├─ rails_json_seeder.rb # entry point
+   └─ rails_json_seeder/
+      └─ seeder.rb # core functions
+```
+
+#### try features
+```
+$ cd test/dummy/
+$ rails db:seed
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_json_seeder (0.1.1)
+    rails_json_seeder (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -95,6 +95,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.5)
+    mini_portile2 (2.8.8)
     minitest (5.20.0)
     net-imap (0.4.1)
       date
@@ -106,7 +107,8 @@ GEM
     net-smtp (0.4.0)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.15.4-arm64-darwin)
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.4)
@@ -199,6 +201,8 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
+  x86_64-linux
 
 DEPENDENCIES
   factory_bot_rails

data/README.md

@@ -1,154 +1,48 @@
 # RailsJsonSeeder
+[English ver](https://github.com/yamamoto7/rails_json_seeder/blob/main/README_EN.md)
 
-RailsJsonSeeder is a gem to easily read JSON seed data for Rails applications and reflect it in the database.
+[![Gem Version](https://badge.fury.io/rb/rails_json_seeder.svg)](https://badge.fury.io/rb/rails_json_seeder) [![Open Source Helpers badge](https://codetriage.com/yamamoto7/rails_json_seeder/badges/users.svg)](https://codetriage.com/yamamoto7/rails_json_seeder)  
 
-## Installation
+![rails_json_seeder](https://github.com/yamamoto7/rails_json_seeder/assets/37437497/4923637f-baf9-4e98-97e9-8d2d40539ab7)
 
-Install the gem and add to the application's Gemfile by executing:
-```
-$ gem install rails_json_seeder
-```
-
-## Quickstart
-### Setup
-First, call RailsJsonSeeder in the seed.rb file as follows:
-```
-RailsJsonSeeder.load_seeds('db/seed_config.yml')
-```
+Json形式で定義されたシードデータを簡単に取り込むことができるgemです
 
-### Creating a configuration file
-`seed_config`
+## クイックスタート
+### Install
+Gemfileに本gemを追加してください。
 ```
-seed_file_base_path: 'db/seed_json/' # default value is db/
-files:
-  'users.json':
-    model: User
-  'categories.json':
-    model: Category
-  'books.json':
-    model: Book
-    dependencies:
-      - class: Category
-  'user_books.json':
-    model: UserBook
-    dependencies:
-      - class: User
-      - class: Book
+gem 'rails_json_seeder'
 ```
 
-### Creating JSON files
-`user_books.json`
-```
-[
-  {
-    "first_name": "John",
-    "last_name": "Doe"
-  },
-  {
-    "first_name": "Bob",
-    "last_name": "Brown"
-  }
-]
-```
-`categories.json`
-```
-[
-  {
-    "label": "Science Fiction"
-  },
-  {
-    "label": "History"
-  }
-]
-```
-`books.json`
+追加後以下のコマンドを実行してください。
 ```
-[
-  {
-    "title": "The Time Traveler's Tale",
-    "description": "An intriguing story of a man who discovers a machine that can transport him through time.",
-    "category": {
-      "label": "Science Fiction"
-    }
-  },
-  {
-    "title": "Stars Beyond Reach",
-    "description": "Set in a distant future, a tale of interstellar exploration and the challenges faced by humanity in the vastness of space.",
-    "category": {
-      "label": "Science Fiction"
-    }
-  },
-  {
-    "title": "Rise and Fall of Empires",
-    "description": "An exhaustive study of the world's greatest empires, their dominance, and eventual decline.",
-    "category": {
-      "label": "History"
-    }
-  }
-]
-```
-`user_books.json`
-```
-[
-  {
-    "book": {
-      "title": "The Time Traveler's Tale"
-    },
-    "user": {
-      "first_name": "John",
-      "last_name": "Doe"
-    }
-  },
-  {
-    "book": {
-      "title": "Rise and Fall of Empires"
-    },
-    "user": {
-      "first_name": "Bob",
-      "last_name": "Brown"
-    }
-  }
-]
+$ bundle install
 ```
 
+### SeedデータでRailsJsonSeederを利用する例
 
-## Contributions
-🌱 Early Days of Our Project: We'd like to candidly express that RailsJsonSeeder is in its infancy. As with many open-source software (OSS) projects in their early stages, there may be areas that are not yet polished or might require further refinements.
+1. [seed.rbの例](https://github.com/yamamoto7/rails_json_seeder/blob/main/test/dummy/db/seeds.rb)
+2. [設定ファイルの例](https://github.com/yamamoto7/rails_json_seeder/blob/main/test/dummy/db/seed_config_sample_1.yml)
+3. [jsonファイルの例](https://github.com/yamamoto7/rails_json_seeder/tree/main/test/dummy/db/seed_json_sample_1)
 
-🤝 Your Contribution Matters: Despite our project's budding phase, or perhaps because of it, every contribution holds significant value. Whether you're a veteran open-source contributor or a newcomer, your insights, feedback, and contributions can make a real difference.
+## 貢献
+🌱 プロジェクトの状態: 率直に申し上げますが、RailsJsonSeederはまだ初期段階にあります。初期段階にある多くのオープンソースソフトウェア (OSS) プロジェクトと同様、まだ洗練されていない部分や、さらなる改良が必要な部分があるかもしれません。
 
-### How Can You Help?
-1. Identifying Bugs: If you notice any bugs or inconsistencies, please open an issue. Your detailed observations can help us rectify and improve.
-2. Suggesting Enhancements: Have ideas on how we can do better? Propose enhancements or new features. We're all ears!
-3. Code Contributions: Directly contribute to the codebase following the previously mentioned contribution steps. If you're uncertain about something, feel free to ask.
-4. Documentation & Examples: Found a typo? Think a section of our documentation could be clearer? Your feedback can make our documentation more user-friendly.
-5. Spreading the Word: The more people know about our project, the better. Share our project, write about it, or even give us a shoutout.
+🤝 あなたの貢献が重要です： 私たちのプロジェクトは萌芽的な段階ですが、あるいは萌芽的だからこそ、すべての貢献は重要な価値を持ちます。ベテランのオープンソース貢献者であろうと、新参者であろうと、あなたの洞察力、フィードバック、そして貢献は、真の変化をもたらすことができます。
 
-### An Invitation to All:
-This is a space of collaboration, learning, and growth. We're committed to fostering a welcoming and inclusive environment for everyone. If you ever have questions, feedback, or suggestions, please don't hesitate to reach out.
+### どのように貢献できますか？
+1. バグの特定: バグや矛盾にお気づきの場合は、issue を開いてください。あなたの詳細な観察は、私たちが修正し、改善するのに役立ちます。
+2. 機能強化の提案： より良いものを作るためのアイデアをお持ちですか？機能強化や新機能をご提案ください。お待ちしております！
+3. コードへの貢献： 前述の貢献ステップに従って、コードベースに直接貢献してください。不明な点があれば、遠慮なく質問してください。
+4. ドキュメントとサンプル： タイプミスを見つけましたか？私たちのドキュメントのセクションがより明確になると思いますか？あなたのフィードバックやPull Requestは、私たちのドキュメントをよりユーザーフレンドリーにすることができます。
+5. 初心者の方へ: PRの送り方がわからないですか？実装の相談がしたいですか？issueにて気軽にご質問ください。（※本OSSは日本語に対応しています）
 
-Together, let's make RailsJsonSeeder a valuable tool for the Rails community!
+準備ができたら、こちらから開発手順をご確認ください。
 
-### How to start development
-#### clone repo
-```
-$ git clone git@github.com:yamamoto7/rails_json_seeder.git
-$ cd rails_json_seeder
-```
+### すべての人への招待状：
+ここはコラボレーション、学習、成長の場です。私たちはすべての人を歓迎し、包括的な環境を育むことを約束します。質問、フィードバック、提案があれば、遠慮なく声をかけてください。
 
-#### add or edit code
-```
-├─ lib/
-   ├─ rails_json_seeder.rb # entry point
-   └─ rails_json_seeder/
-      └─ seeder.rb # core functions
-```
-
-#### try features
-```
-$ cd test/dummy/
-$ rails db:seed
-```
+一緒にRailsJsonSeederをRailsコミュニティにとって価値あるツールにしていきましょう！
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README_EN.md

@@ -0,0 +1,47 @@
+# RailsJsonSeeder
+[![Gem Version](https://badge.fury.io/rb/rails_json_seeder.svg)](https://badge.fury.io/rb/rails_json_seeder) [![Open Source Helpers badge](https://codetriage.com/yamamoto7/rails_json_seeder/badges/users.svg)](https://codetriage.com/yamamoto7/rails_json_seeder)  
+
+![rails_json_seeder](https://github.com/yamamoto7/rails_json_seeder/assets/37437497/4923637f-baf9-4e98-97e9-8d2d40539ab7)
+
+RailsJsonSeeder is a gem to easily read JSON seed data for Rails applications and reflect it in the database.
+
+## Installation
+Add this gem to your Gemfile.
+
+```
+gem 'rails_json_seeder'
+```
+
+After adding this gem, please execute the following commands.
+```
+$ bundle install
+```
+
+### Example of using RailsJsonSeeder with Seed data
+
+1. [Example of seed.rb](https://github.com/yamamoto7/rails_json_seeder/blob/main/test/dummy/db/seeds.rb)
+2. [Example of configuration file](https://github.com/yamamoto7/rails_json_seeder/blob/main/test/dummy/db/seed_config_sample_1.yml)
+3. [Example of json file](https://github.com/yamamoto7/rails_json_seeder/tree/main/test/dummy/db/seed_json_sample_1)
+
+## Contributions
+🌱 Early Days of Our Project: We'd like to candidly express that RailsJsonSeeder is in its infancy. As with many open-source software (OSS) projects in their early stages, there may be areas that are not yet polished or might require further refinements.
+
+🤝 Your Contribution Matters: Despite our project's budding phase, or perhaps because of it, every contribution holds significant value. Whether you're a veteran open-source contributor or a newcomer, your insights, feedback, and contributions can make a real difference.
+
+### How Can You Help?
+1. Identifying Bugs: If you notice any bugs or inconsistencies, please open an issue. Your detailed observations can help us rectify and improve.
+2. Suggesting Enhancements: Have ideas on how we can do better? Propose enhancements or new features. We're all ears!
+3. Code Contributions: Directly contribute to the codebase following the previously mentioned contribution steps. If you're uncertain about something, feel free to ask.
+4. Documentation & Examples: Found a typo? Think a section of our documentation could be clearer? Your feedback can make our documentation more user-friendly.
+5. Newbies: Not sure how to send a PR? Want to discuss implementation? Please feel free to ask questions on the [issue](https://github.com/yamamoto7/rails_json_seeder/issues).
+
+When you are ready, please click [here](https://github.com/yamamoto7/rails_json_seeder/blob/main/CONTRIBUTING.md) to review the development process.
+
+### An Invitation to All:
+This is a space of collaboration, learning, and growth. We're committed to fostering a welcoming and inclusive environment for everyone. If you ever have questions, feedback, or suggestions, please don't hesitate to reach out.
+
+Together, let's make RailsJsonSeeder a valuable tool for the Rails community!
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/rails_json_seeder/seeder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'rails'
 require 'active_support/core_ext/hash/keys'
@@ -36,7 +38,7 @@ module RailsJsonSeeder
       end
     end
 
-    def process_file(path, item)
+    def process_file(path, item) # rubocop:disable Metrics/AbcSize
       klass = resolve_constant(item[:model])
 
       dependencies = item[:dependencies] || {}
@@ -73,6 +75,9 @@ module RailsJsonSeeder
         dependency_class = resolve_constant(dependency[:class])
         foreign_key = dependency[:id] || "#{dependency_class.name.underscore}_id"
         original_field_name = dependency[:alias] || dependency_class.name.underscore
+
+        next unless record[original_field_name]
+
         dependent_record = dependency_class.find_by!(record[original_field_name])
         record[foreign_key] = dependent_record.id
         record.delete(original_field_name)

data/lib/rails_json_seeder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsJsonSeeder
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_seeder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - kenta.yamamoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies: []
 description: RailsJsonSeeder provides an intuitive way to seed Rails applications
   using JSON formatted seed files. With support for defining model dependencies, this
@@ -24,10 +24,12 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README_EN.md
 - Rakefile
 - lib/rails_json_seeder.rb
 - lib/rails_json_seeder/seeder.rb
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A gem for easy seeding of Rails projects from JSON files.