e621_export_downloader 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21a24836744a301b7a69e15bbd3b55ffce5dae10d651182f7243539f8c84fa51
-  data.tar.gz: ddaad209b463b39855e05761f368454be981940d4092f5c759be90c237012fff
+  metadata.gz: f2a75639fe81247f91a36b903b70b6845ea89a1d5e12bab6d4fed6b55a3d22f4
+  data.tar.gz: 211d90dffba5ffcf495babdc9d0382c54143a64cfca483637d4d70c283b9934e
 SHA512:
-  metadata.gz: fe1b7227c38ac328ebbd51b32f6ae24b4631d4ffadb5e83c3e3ec3768bcea5ece054ed9e497c2952b2e4d4cbb802727aafc48553bfba5d58795db85eddc33832
-  data.tar.gz: b12433e7f2403687773793db0a0c61abf4665b20b1909576c15828ae6c57d94447abdca44b4a1f2aa86c96ff66a5c33b1eaa9c37633d4de8dc376409d5cd09a7
+  metadata.gz: f254e3bfaac75803d596b6668c1466610111be7d3ed716c4678263883ca0c174d837f395305adf9a72a6eb2be6f5ffcd9a57ca8d8208268c8229c753b16c0111
+  data.tar.gz: e4ec86ff5d0adb542907aaf7c750342b16743f2e171278e3eab02a842dfb36f46afaab0687d00d57df81a0c0581065e6d9a2553b459e0ef85dccbf61d8bc24b1

data/README.md

@@ -134,6 +134,66 @@ e621-export-downloader --cache     # enable caching
 e621-export-downloader --no-cache  # disable caching (default)
 ```
 
+## Rails Integration
+
+Run the install generator to copy the migration and create the initializer:
+
+```bash
+bin/rails g e621_export_downloader:install
+bin/rails db:migrate
+```
+
+Two options are available:
+
+| Option | Default | Description |
+|---|---|---|
+| `--schema NAME` | `e621` | Schema or prefix name for the tables |
+| `--table-format FORMAT` | `schema` | `schema` — tables in a PostgreSQL schema (`e621.artists`); `prefix` — tables in the default schema with a name prefix (`e621_artists`) |
+
+```bash
+# custom schema name
+bin/rails g e621_export_downloader:install --schema my_e621
+
+# prefix style instead of a dedicated schema
+bin/rails g e621_export_downloader:install --table-format prefix
+
+# combine both
+bin/rails g e621_export_downloader:install --schema my_e621 --table-format prefix
+```
+
+This generates:
+- `db/migrate/<timestamp>_create_e621_tables.rb` — creates all e621 tables (and the schema when using `--table-format schema`)
+- `config/initializers/e621_models.rb` — requires the ActiveRecord models
+
+The following ActiveRecord models are then available:
+
+| Model                     | Table                       |
+|---------------------------|-----------------------------|
+| `E621::Artist`            | `e621.artists`              |
+| `E621::BulkUpdateRequest` | `e621.bulk_update_requests` |
+| `E621::Pool`              | `e621.pools`                |
+| `E621::Post`              | `e621.posts`                |
+| `E621::PostReplacement`   | `e621.post_replacements`    |
+| `E621::PostVersion`       | `e621.post_versions`        |
+| `E621::Tag`               | `e621.tags`                 |
+| `E621::TagAlias`          | `e621.tag_aliases`          |
+| `E621::TagImplication`    | `e621.tag_implications`     |
+| `E621::WikiPage`          | `e621.wiki_pages`           |
+
+Each model provides `upsert_from_export` and `upsert_all_from_export` for persisting parsed export records:
+
+```ruby
+client = E621ExportDownloader::Client.new
+
+client.get("posts").read do |post|
+  E621::Post.upsert_from_export(post)
+end
+
+# or in batch
+posts = client.get("posts").read_all
+E621::Post.upsert_all_from_export(posts)
+```
+
 ## ActiveJob Integration
 
 `E621ExportDownloader::Serializers::ActiveJob` allows `E621ExportDownloader::Types` values to be passed as ActiveJob arguments.

data/Rakefile

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 require("bundler/gem_tasks")
+require("rake/testtask")
 require("rubocop/rake_task")
 
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
 RuboCop::RakeTask.new
 
 task(default: :rubocop)

data/db/migrate/create_e621_tables.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+class CreateE621Tables < ActiveRecord::Migration[7.1]
+  def change
+    reversible do |r|
+      r.up { execute("CREATE SCHEMA e621") }
+      r.down { execute("DROP SCHEMA e621 CASCADE") }
+    end
+
+    create_table(:e621_artists, id: :bigint, default: nil, force: :cascade) do |t|
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false)
+      t.string(:group_name)
+      t.boolean(:is_active, null: false)
+      t.boolean(:is_locked, null: false)
+      t.bigint(:linked_user_id)
+      t.string(:name, null: false)
+      t.text(:other_names, array: true, null: false, default: [])
+      t.datetime(:updated_at, null: false)
+      t.text(:urls, array: true, null: false, default: [])
+    end
+
+    add_index(:e621_artists, :name, unique: true)
+    add_index(:e621_artists, :creator_id)
+
+    create_table(:e621_bulk_update_requests, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.datetime(:created_at, null: false)
+      t.bigint(:forum_topic_id)
+      t.text(:script, null: false)
+      t.string(:status, null: false)
+      t.string(:title)
+      t.datetime(:updated_at, null: false)
+      t.bigint(:user_id, null: false)
+    end
+
+    add_index(:e621_bulk_update_requests, :user_id)
+    add_index(:e621_bulk_update_requests, :status)
+
+    create_table(:e621_pools, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:category, null: false)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false)
+      t.text(:description, null: false)
+      t.boolean(:is_active, null: false)
+      t.string(:name, null: false)
+      t.bigint(:post_ids, array: true, null: false, default: [])
+      t.datetime(:updated_at)
+    end
+
+    add_index(:e621_pools, :creator_id)
+    add_index(:e621_pools, :name)
+
+    create_table(:e621_posts, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.bigint(:change_seq, null: false)
+      t.integer(:comment_count, null: false)
+      t.datetime(:created_at, null: false)
+      t.text(:description, null: false)
+      t.integer(:down_score, null: false)
+      t.float(:duration)
+      t.integer(:fav_count, null: false)
+      t.string(:file_ext, null: false)
+      t.bigint(:file_size, null: false)
+      t.integer(:image_height, null: false)
+      t.integer(:image_width, null: false)
+      t.boolean(:is_deleted, null: false)
+      t.boolean(:is_flagged, null: false)
+      t.boolean(:is_note_locked, null: false)
+      t.boolean(:is_pending, null: false)
+      t.boolean(:is_rating_locked, null: false)
+      t.boolean(:is_status_locked, null: false)
+      t.text(:locked_tags, null: false)
+      t.string(:md5)
+      t.bigint(:parent_id)
+      t.string(:rating, null: false)
+      t.integer(:score, null: false)
+      t.text(:sources, array: true, null: false, default: [])
+      t.text(:tags, array: true, null: false, default: [])
+      t.integer(:up_score, null: false)
+      t.datetime(:updated_at)
+      t.bigint(:uploader_id)
+    end
+
+    add_index(:e621_posts, :md5, unique: true, where: "md5 IS NOT NULL")
+    add_index(:e621_posts, :uploader_id)
+    add_index(:e621_posts, :rating)
+    add_index(:e621_posts, :is_deleted)
+
+    create_table(:e621_post_replacements, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false)
+      t.string(:file_ext, null: false)
+      t.string(:file_name, null: false)
+      t.bigint(:file_size, null: false)
+      t.integer(:image_height, null: false)
+      t.integer(:image_width, null: false)
+      t.string(:md5, null: false)
+      t.bigint(:post_id, null: false)
+      t.text(:reason, null: false)
+      t.text(:source)
+      t.string(:status, null: false)
+      t.datetime(:updated_at, null: false)
+    end
+
+    add_index(:e621_post_replacements, :post_id)
+    add_index(:e621_post_replacements, :creator_id)
+    add_index(:e621_post_replacements, :status)
+
+    create_table(:e621_post_versions, id: :bigint, default: nil, force: :cascade) do |t|
+      t.text(:added_locked_tags, array: true, null: false, default: [])
+      t.text(:added_tags, array: true, null: false, default: [])
+      t.text(:description)
+      t.boolean(:description_changed, null: false)
+      t.text(:locked_tags)
+      t.boolean(:parent_changed, null: false)
+      t.bigint(:parent_id)
+      t.string(:rating)
+      t.boolean(:rating_changed, null: false)
+      t.text(:reason)
+      t.text(:removed_locked_tags, array: true, null: false, default: [])
+      t.text(:removed_tags, array: true, null: false, default: [])
+      t.text(:source)
+      t.boolean(:source_changed, null: false)
+      t.text(:tags)
+      t.datetime(:updated_at, null: false)
+      t.bigint(:updater_id, null: false)
+      t.integer(:version, null: false)
+    end
+
+    add_index(:e621_post_versions, :updater_id)
+    add_index(:e621_post_versions, :updated_at)
+
+    create_table(:e621_tag_aliases, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:antecedent_name, null: false)
+      t.string(:consequent_name, null: false)
+      t.datetime(:created_at)
+      t.string(:status, null: false)
+    end
+
+    add_index(:e621_tag_aliases, :antecedent_name)
+    add_index(:e621_tag_aliases, :consequent_name)
+    add_index(:e621_tag_aliases, :status)
+
+    create_table(:e621_tag_implications, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:antecedent_name, null: false)
+      t.string(:consequent_name, null: false)
+      t.datetime(:created_at)
+      t.string(:status, null: false)
+    end
+
+    add_index(:e621_tag_implications, :antecedent_name)
+    add_index(:e621_tag_implications, :consequent_name)
+    add_index(:e621_tag_implications, :status)
+
+    create_table(:e621_tags, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:category, null: false)
+      t.string(:name, null: false)
+      t.integer(:post_count, null: false)
+    end
+
+    add_index(:e621_tags, :name, unique: true)
+    add_index(:e621_tags, :category)
+
+    create_table(:e621_wiki_pages, id: :bigint, default: nil, force: :cascade) do |t|
+      t.text(:body, null: false)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id)
+      t.boolean(:is_locked, null: false)
+      t.string(:title, null: false)
+      t.datetime(:updated_at)
+      t.bigint(:uploader_id)
+    end
+
+    add_index(:e621_wiki_pages, :title, unique: true)
+    add_index(:e621_wiki_pages, :creator_id)
+  end
+end

data/lib/e621/artist.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class Artist < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.artists"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::Artist).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::Artist]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:             record.id,
+        created_at:     record.created_at,
+        creator_id:     record.creator_id,
+        group_name:     record.group_name,
+        is_active:      record.is_active,
+        is_locked:      record.is_locked,
+        linked_user_id: record.linked_user_id,
+        name:           record.name,
+        other_names:    record.other_names,
+        updated_at:     record.updated_at,
+        urls:           record.urls,
+      }
+    end)
+  end
+end

data/lib/e621/bulk_update_request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class BulkUpdateRequest < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.bulk_update_requests"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::BulkUpdateRequest).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::BulkUpdateRequest]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:             record.id,
+        approver_id:    record.approver_id,
+        created_at:     record.created_at,
+        forum_topic_id: record.forum_topic_id,
+        script:         record.script,
+        status:         record.status,
+        title:          record.title,
+        updated_at:     record.updated_at,
+        user_id:        record.user_id,
+      }
+    end)
+  end
+end

data/lib/e621/pool.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class Pool < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.pools"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::Pool).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::Pool]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:          record.id,
+        category:    record.category,
+        created_at:  record.created_at,
+        creator_id:  record.creator_id,
+        description: record.description,
+        is_active:   record.is_active,
+        name:        record.name,
+        post_ids:    record.post_ids,
+        updated_at:  record.updated_at,
+      }
+    end)
+  end
+end

data/lib/e621/post.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class Post < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.posts"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::Post).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::Post]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:               record.id,
+        approver_id:      record.approver_id,
+        change_seq:       record.change_seq,
+        comment_count:    record.comment_count,
+        created_at:       record.created_at,
+        description:      record.description,
+        down_score:       record.down_score,
+        duration:         record.duration,
+        fav_count:        record.fav_count,
+        file_ext:         record.file_ext,
+        file_size:        record.file_size,
+        image_height:     record.image_height,
+        image_width:      record.image_width,
+        is_deleted:       record.is_deleted,
+        is_flagged:       record.is_flagged,
+        is_note_locked:   record.is_note_locked,
+        is_pending:       record.is_pending,
+        is_rating_locked: record.is_rating_locked,
+        is_status_locked: record.is_status_locked,
+        locked_tags:      record.locked_tags,
+        md5:              record.md5,
+        parent_id:        record.parent_id,
+        rating:           record.rating,
+        score:            record.score,
+        sources:          record.sources,
+        tags:             record.tags,
+        up_score:         record.up_score,
+        updated_at:       record.updated_at,
+        uploader_id:      record.uploader_id,
+      }
+    end)
+  end
+end

data/lib/e621/post_replacement.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class PostReplacement < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.post_replacements"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::PostReplacement).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::PostReplacement]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:           record.id,
+        approver_id:  record.approver_id,
+        created_at:   record.created_at,
+        creator_id:   record.creator_id,
+        file_ext:     record.file_ext,
+        file_name:    record.file_name,
+        file_size:    record.file_size,
+        image_height: record.image_height,
+        image_width:  record.image_width,
+        md5:          record.md5,
+        post_id:      record.post_id,
+        reason:       record.reason,
+        source:       record.source,
+        status:       record.status,
+        updated_at:   record.updated_at,
+      }
+    end)
+  end
+end

data/lib/e621/post_version.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class PostVersion < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.post_versions"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::PostVersion).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::PostVersion]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:                  record.id,
+        added_locked_tags:   record.added_locked_tags,
+        added_tags:          record.added_tags,
+        description:         record.description,
+        description_changed: record.description_changed,
+        locked_tags:         record.locked_tags,
+        parent_changed:      record.parent_changed,
+        parent_id:           record.parent_id,
+        rating:              record.rating,
+        rating_changed:      record.rating_changed,
+        reason:              record.reason,
+        removed_locked_tags: record.removed_locked_tags,
+        removed_tags:        record.removed_tags,
+        source:              record.source,
+        source_changed:      record.source_changed,
+        tags:                record.tags,
+        updated_at:          record.updated_at,
+        updater_id:          record.updater_id,
+        version:             record.version,
+      }
+    end)
+  end
+end

data/lib/e621/tag.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class Tag < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.tags"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::Tag).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::Tag]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:         record.id,
+        category:   record.category,
+        name:       record.name,
+        post_count: record.post_count,
+      }
+    end)
+  end
+end

data/lib/e621/tag_alias.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class TagAlias < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.tag_aliases"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::TagAlias).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::TagAlias]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:              record.id,
+        antecedent_name: record.antecedent_name,
+        consequent_name: record.consequent_name,
+        created_at:      record.created_at,
+        status:          record.status,
+      }
+    end)
+  end
+end

data/lib/e621/tag_implication.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class TagImplication < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.tag_implications"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::TagImplication).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::TagImplication]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:              record.id,
+        antecedent_name: record.antecedent_name,
+        consequent_name: record.consequent_name,
+        created_at:      record.created_at,
+        status:          record.status,
+      }
+    end)
+  end
+end

data/lib/e621/wiki_page.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: true
+
+require("active_record")
+
+module E621
+  class WikiPage < ActiveRecord::Base
+    extend(T::Sig)
+
+    self.table_name = "e621.wiki_pages"
+    self.record_timestamps = false
+
+    sig { params(record: E621ExportDownloader::Models::WikiPage).returns(T.untyped) }
+    def self.upsert_from_export(record)
+      upsert(attributes_from_export(record))
+    end
+
+    sig { params(records: T::Array[E621ExportDownloader::Models::WikiPage]).returns(T.untyped) }
+    def self.upsert_all_from_export(records)
+      upsert_all(records.map { |r| attributes_from_export(r) })
+    end
+
+    private_class_method(def self.attributes_from_export(record)
+      {
+        id:          record.id,
+        body:        record.body,
+        created_at:  record.created_at,
+        creator_id:  record.creator_id,
+        is_locked:   record.is_locked,
+        title:       record.title,
+        updated_at:  record.updated_at,
+        uploader_id: record.uploader_id,
+      }
+    end)
+  end
+end

data/lib/e621_export_downloader/models/post.rb

@@ -114,7 +114,7 @@ module E621ExportDownloader
         @is_note_locked = T.let(record["is_note_locked"] == "t", T::Boolean)
         @is_pending = T.let(record["is_pending"] == "t", T::Boolean)
         @is_rating_locked = T.let(record["is_rating_locked"] == "t", T::Boolean)
-        @is_status_locked = T.let(record["is_rating_locked"] == "t", T::Boolean)
+        @is_status_locked = T.let(record["is_status_locked"] == "t", T::Boolean)
         @locked_tags = T.let(T.must(record["locked_tags"]), String)
         @md5 = T.let(T.must(record["md5"]).empty? ? nil : record["md5"], T.nilable(String))
         @parent_id = T.let(T.must(record["parent_id"]).empty? ? nil : record["parent_id"].to_i, T.nilable(Integer))

data/lib/e621_export_downloader/models/wiki_page.rb

@@ -28,7 +28,7 @@ module E621ExportDownloader
       attr_reader(:updated_at)
 
       sig { returns(T.nilable(Integer)) }
-      attr_reader(:uploader_id)
+      attr_reader(:updater_id)
 
       sig { params(record: T::Hash[String, String]).void }
       def initialize(record)
@@ -40,20 +40,20 @@ module E621ExportDownloader
         @is_locked = T.let(record["is_locked"] == "t", T::Boolean)
         @title = T.let(T.must(record["title"]), String)
         @updated_at = T.let(T.must(record["updated_at"]).empty? ? nil : DateTime.parse(record["updated_at"]), T.nilable(DateTime))
-        @uploader_id = T.let(T.must(record["uploader_id"]).empty? ? nil : record["uploader_id"].to_i, T.nilable(Integer))
+        @updater_id = T.let(T.must(record["updater_id"]).empty? ? nil : record["updater_id"].to_i, T.nilable(Integer))
       end
 
       sig { params(_args: T.untyped).returns(String) }
       def to_json(*_args)
         {
-          body:        @body,
-          created_at:  @created_at,
-          creator_id:  @creator_id,
-          id:          @id,
-          is_locked:   @is_locked,
-          title:       @title,
-          updated_at:  @updated_at,
-          uploader_id: @uploader_id,
+          body:       @body,
+          created_at: @created_at,
+          creator_id: @creator_id,
+          id:         @id,
+          is_locked:  @is_locked,
+          title:      @title,
+          updated_at: @updated_at,
+          updater_id: @updater_id,
         }.to_json
       end
     end

data/lib/e621_export_downloader/models.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative("../e621/artist")
+require_relative("../e621/bulk_update_request")
+require_relative("../e621/pool")
+require_relative("../e621/post")
+require_relative("../e621/post_replacement")
+require_relative("../e621/post_version")
+require_relative("../e621/tag")
+require_relative("../e621/tag_alias")
+require_relative("../e621/tag_implication")
+require_relative("../e621/wiki_page")

data/lib/e621_export_downloader/railtie.rb

@@ -2,6 +2,10 @@
 
 module E621ExportDownloader
   class Railtie < Rails::Railtie
+    rake_tasks do
+      load(File.expand_path("../tasks/e621_export_downloader.rake", __dir__))
+    end
+
     initializer("e621_export_downloader.register_active_job_serializer") do
       ActiveSupport.on_load(:active_job) do
         require("e621_export_downloader/serializers/active_job")

data/lib/e621_export_downloader/version.rb

@@ -4,7 +4,7 @@
 # loaded by bundler
 module E621ExportDownloader
   module Constants
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
     WEBSITE = "https://github.com/DonovanDMC/E621ExportDownloader.rb"
   end
 end

data/lib/e621_export_downloader.rb

@@ -8,6 +8,9 @@ loader.inflector.inflect({ "api_export_data" => "APIExportData" })
 loader.ignore("#{__dir__}/e621_export_downloader/version.rb")
 loader.ignore("#{__dir__}/e621_export_downloader/railtie.rb")
 loader.ignore("#{__dir__}/e621_export_downloader/serializers/active_job.rb")
+loader.ignore("#{__dir__}/e621_export_downloader/models.rb")
+loader.ignore("#{__dir__}/e621")
+loader.ignore("#{__dir__}/generators")
 loader.setup
 
 require("e621_export_downloader/railtie") if defined?(Rails::Railtie)

data/lib/generators/e621_export_downloader/install_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require("rails/generators")
+require("rails/generators/active_record")
+
+module E621ExportDownloader
+  #
+  # Rails generator used for setting up E621ExportDownloader tables in a Rails application.
+  # Run it with +bin/rails g e621_export_downloader:install+ in your console.
+  #
+  class InstallGenerator < Rails::Generators::Base
+    include(ActiveRecord::Generators::Migration)
+
+    TEMPLATES = File.join(File.dirname(__FILE__), "templates")
+    source_paths << TEMPLATES
+
+    class_option(:schema, type: :string, default: "e621",
+                 desc: "Schema or prefix name for the e621 tables")
+    class_option(:table_format, type: :string, default: "schema",
+                 desc: "Table reference format: 'schema' uses a PostgreSQL schema (e621.artists), 'prefix' uses a name prefix (e621_artists)")
+
+    def validate_options
+      return if %w[schema prefix].include?(options[:table_format])
+      abort("--table-format must be 'schema' or 'prefix', got '#{options[:table_format]}'")
+    end
+
+    def create_migration_file
+      migration_template("migrations/create_e621_tables.rb.erb", File.join(db_migrate_path, "create_e621_tables.rb"))
+    end
+
+    def create_initializer
+      template("initializers/e621_models.rb.erb", "config/initializers/e621_models.rb")
+    end
+
+    private
+
+    def schema
+      options[:schema]
+    end
+
+    def use_schema?
+      options[:table_format] == "schema"
+    end
+
+    def table_ref(name)
+      use_schema? ? "\"#{schema}.#{name}\"" : ":#{schema}_#{name}"
+    end
+
+    def table_name_for(name)
+      use_schema? ? "#{schema}.#{name}" : "#{schema}_#{name}"
+    end
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::STRING.to_f}]"
+    end
+  end
+end

data/lib/generators/e621_export_downloader/templates/initializers/e621_models.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# E621::Artist            - <%= table_name_for("artists") %>
+# E621::BulkUpdateRequest - <%= table_name_for("bulk_update_requests") %>
+# E621::Pool              - <%= table_name_for("pools") %>
+# E621::Post              - <%= table_name_for("posts") %>
+# E621::PostReplacement   - <%= table_name_for("post_replacements") %>
+# E621::PostVersion       - <%= table_name_for("post_versions") %>
+# E621::Tag               - <%= table_name_for("tags") %>
+# E621::TagAlias          - <%= table_name_for("tag_aliases") %>
+# E621::TagImplication    - <%= table_name_for("tag_implications") %>
+# E621::WikiPage          - <%= table_name_for("wiki_pages") %>
+require("e621_export_downloader/models")

data/lib/generators/e621_export_downloader/templates/migrations/create_e621_tables.rb.erb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+class CreateE621Tables < ActiveRecord::Migration<%= migration_version %>
+  def change
+<% if use_schema? -%>
+    reversible do |r|
+      r.up { execute("CREATE SCHEMA <%= schema %>") }
+      r.down { execute("DROP SCHEMA <%= schema %> CASCADE") }
+    end
+
+<% end -%>
+    create_table(<%= table_ref("artists") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false, index: true)
+      t.string(:group_name)
+      t.boolean(:is_active, null: false)
+      t.boolean(:is_locked, null: false)
+      t.bigint(:linked_user_id)
+      t.string(:name, null: false, index: { unique: true })
+      t.text(:other_names, array: true, null: false, default: [])
+      t.datetime(:updated_at, null: false)
+      t.text(:urls, array: true, null: false, default: [])
+    end
+
+    create_table(<%= table_ref("bulk_update_requests") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.datetime(:created_at, null: false)
+      t.bigint(:forum_topic_id)
+      t.text(:script, null: false)
+      t.string(:status, null: false, index: true)
+      t.string(:title)
+      t.datetime(:updated_at, null: false)
+      t.bigint(:user_id, null: false, index: true)
+    end
+
+    create_table(<%= table_ref("pools") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:category, null: false)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false, index: true)
+      t.text(:description, null: false)
+      t.boolean(:is_active, null: false)
+      t.string(:name, null: false, index: true)
+      t.bigint(:post_ids, array: true, null: false, default: [])
+      t.datetime(:updated_at)
+    end
+
+    create_table(<%= table_ref("posts") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.bigint(:change_seq, null: false)
+      t.integer(:comment_count, null: false)
+      t.datetime(:created_at, null: false)
+      t.text(:description, null: false)
+      t.integer(:down_score, null: false)
+      t.float(:duration)
+      t.integer(:fav_count, null: false)
+      t.string(:file_ext, null: false)
+      t.bigint(:file_size, null: false)
+      t.integer(:image_height, null: false)
+      t.integer(:image_width, null: false)
+      t.boolean(:is_deleted, null: false, index: true)
+      t.boolean(:is_flagged, null: false)
+      t.boolean(:is_note_locked, null: false)
+      t.boolean(:is_pending, null: false)
+      t.boolean(:is_rating_locked, null: false)
+      t.boolean(:is_status_locked, null: false)
+      t.text(:locked_tags, null: false)
+      t.string(:md5, index: { unique: true }, null: false)
+      t.bigint(:parent_id)
+      t.string(:rating, null: false, index: true)
+      t.integer(:score, null: false)
+      t.text(:sources, array: true, null: false, default: [])
+      t.text(:tags, array: true, null: false, default: [])
+      t.integer(:up_score, null: false)
+      t.datetime(:updated_at)
+      t.bigint(:uploader_id, index: true)
+    end
+
+    create_table(<%= table_ref("post_replacements") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.bigint(:approver_id)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, null: false, index: true)
+      t.string(:file_ext, null: false)
+      t.string(:file_name, null: false)
+      t.bigint(:file_size, null: false)
+      t.integer(:image_height, null: false)
+      t.integer(:image_width, null: false)
+      t.string(:md5, null: false)
+      t.bigint(:post_id, null: false, index: true)
+      t.text(:reason, null: false)
+      t.text(:source)
+      t.string(:status, null: false, index: true)
+      t.datetime(:updated_at, null: false)
+    end
+
+    create_table(<%= table_ref("post_versions") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.text(:added_locked_tags, array: true, null: false, default: [])
+      t.text(:added_tags, array: true, null: false, default: [])
+      t.text(:description)
+      t.boolean(:description_changed, null: false)
+      t.text(:locked_tags)
+      t.boolean(:parent_changed, null: false)
+      t.bigint(:parent_id)
+      t.string(:rating)
+      t.boolean(:rating_changed, null: false)
+      t.text(:reason)
+      t.text(:removed_locked_tags, array: true, null: false, default: [])
+      t.text(:removed_tags, array: true, null: false, default: [])
+      t.text(:source)
+      t.boolean(:source_changed, null: false)
+      t.text(:tags)
+      t.datetime(:updated_at, null: false, index: true)
+      t.bigint(:updater_id, null: false, index: true)
+      t.integer(:version, null: false)
+    end
+
+    create_table(<%= table_ref("tag_aliases") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:antecedent_name, null: false, index: true)
+      t.string(:consequent_name, null: false, index: true)
+      t.datetime(:created_at)
+      t.string(:status, null: false, index: true)
+    end
+
+    create_table(<%= table_ref("tag_implications") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:antecedent_name, null: false, index: true)
+      t.string(:consequent_name, null: false, index: true)
+      t.datetime(:created_at)
+      t.string(:status, null: false, index: true)
+    end
+
+    create_table(<%= table_ref("tags") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.string(:category, null: false, index: true)
+      t.string(:name, null: false, index: { unique: true })
+      t.integer(:post_count, null: false)
+    end
+
+    create_table(<%= table_ref("wiki_pages") %>, id: :bigint, default: nil, force: :cascade) do |t|
+      t.text(:body, null: false)
+      t.datetime(:created_at, null: false)
+      t.bigint(:creator_id, index: true)
+      t.boolean(:is_locked, null: false)
+      t.string(:title, null: false, index: { unique: true })
+      t.datetime(:updated_at)
+      t.bigint(:uploader_id)
+    end
+  end
+end

data/sorbet/config

@@ -1,5 +1,9 @@
 --dir
 .
+--ignore=db/
+--ignore=lib/generators/
+--ignore=lib/tasks/
+--ignore=test/
 --ignore=tmp/
 --ignore=vendor/
 --parser=prism

data/sorbet/rbi/shims/active_record.rbi

@@ -0,0 +1,17 @@
+# typed: true
+
+module ActiveRecord
+  class Base
+    sig { params(value: T.untyped).void }
+    def self.table_name=(value); end
+
+    sig { params(value: T.untyped).void }
+    def self.record_timestamps=(value); end
+
+    sig { params(attributes: T::Hash[Symbol, T.untyped], kwargs: T.untyped).returns(T.untyped) }
+    def self.upsert(attributes, **kwargs); end
+
+    sig { params(attributes: T::Array[T::Hash[Symbol, T.untyped]], kwargs: T.untyped).returns(T.untyped) }
+    def self.upsert_all(attributes, **kwargs); end
+  end
+end

data/test/generators/install_generator_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require("minitest/autorun")
+require("rails/generators/testing/behavior")
+require("rails/generators/testing/assertions")
+require("generators/e621_export_downloader/install_generator")
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests(E621ExportDownloader::InstallGenerator)
+  destination(File.expand_path("../tmp", __dir__))
+  setup(:prepare_destination)
+
+  test("creates migration with schema format by default") do
+    run_generator
+    assert_migration("db/migrate/create_e621_tables.rb") do |content|
+      assert_match(/CREATE SCHEMA e621/, content)
+      assert_match(/create_table\("e621\.artists"/, content)
+    end
+  end
+
+  test("creates initializer") do
+    run_generator
+    assert_file("config/initializers/e621_models.rb") do |content|
+      assert_match(%r{require\("e621_export_downloader/models"\)}, content)
+      assert_match(/E621::Artist\s+-\s+e621\.artists/, content)
+    end
+  end
+
+  test("--schema changes the schema name") do
+    run_generator(%w[--schema mydb])
+    assert_migration("db/migrate/create_e621_tables.rb") do |content|
+      assert_match(/CREATE SCHEMA mydb/, content)
+      assert_match(/create_table\("mydb\.artists"/, content)
+    end
+    assert_file("config/initializers/e621_models.rb") do |content|
+      assert_match(/E621::Artist\s+-\s+mydb\.artists/, content)
+    end
+  end
+
+  test("--table-format prefix omits schema creation and uses prefixed table names") do
+    run_generator(%w[--table-format prefix])
+    assert_migration("db/migrate/create_e621_tables.rb") do |content|
+      assert_no_match(/CREATE SCHEMA/, content)
+      assert_match(/create_table\(:e621_artists/, content)
+    end
+    assert_file("config/initializers/e621_models.rb") do |content|
+      assert_match(/E621::Artist\s+-\s+e621_artists/, content)
+    end
+  end
+
+  test("--schema and --table-format prefix combine") do
+    run_generator(%w[--schema mydb --table-format prefix])
+    assert_migration("db/migrate/create_e621_tables.rb") do |content|
+      assert_no_match(/CREATE SCHEMA/, content)
+      assert_match(/create_table\(:mydb_artists/, content)
+    end
+    assert_file("config/initializers/e621_models.rb") do |content|
+      assert_match(/E621::Artist\s+-\s+mydb_artists/, content)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: e621_export_downloader
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Donovan_DMC
@@ -78,7 +78,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- db/migrate/create_e621_tables.rb
 - exe/e621-export-downloader
+- lib/e621/artist.rb
+- lib/e621/bulk_update_request.rb
+- lib/e621/pool.rb
+- lib/e621/post.rb
+- lib/e621/post_replacement.rb
+- lib/e621/post_version.rb
+- lib/e621/tag.rb
+- lib/e621/tag_alias.rb
+- lib/e621/tag_implication.rb
+- lib/e621/wiki_page.rb
 - lib/e621_export_downloader.rb
 - lib/e621_export_downloader/api_export_data.rb
 - lib/e621_export_downloader/client.rb
@@ -88,6 +99,7 @@ files:
 - lib/e621_export_downloader/constants.rb
 - lib/e621_export_downloader/export.rb
 - lib/e621_export_downloader/export_helper.rb
+- lib/e621_export_downloader/models.rb
 - lib/e621_export_downloader/models/artist.rb
 - lib/e621_export_downloader/models/bulk_update_request.rb
 - lib/e621_export_downloader/models/pool.rb
@@ -102,6 +114,9 @@ files:
 - lib/e621_export_downloader/serializers/active_job.rb
 - lib/e621_export_downloader/types.rb
 - lib/e621_export_downloader/version.rb
+- lib/generators/e621_export_downloader/install_generator.rb
+- lib/generators/e621_export_downloader/templates/initializers/e621_models.rb.erb
+- lib/generators/e621_export_downloader/templates/migrations/create_e621_tables.rb.erb
 - sorbet/config
 - sorbet/rbi/annotations/.gitattributes
 - sorbet/rbi/annotations/faraday.rbi
@@ -200,10 +215,12 @@ files:
 - sorbet/rbi/gems/websocket-driver@0.8.0.rbi
 - sorbet/rbi/gems/websocket-extensions@0.1.5.rbi
 - sorbet/rbi/gems/zeitwerk@2.7.5.rbi
+- sorbet/rbi/shims/active_record.rbi
 - sorbet/rbi/shims/faraday.rbi
 - sorbet/rbi/todo.rbi
 - sorbet/tapioca/config.yml
 - sorbet/tapioca/require.rb
+- test/generators/install_generator_test.rb
 homepage: https://github.com/DonovanDMC/E621ExportDownloader.rb
 licenses:
 - MIT