activerecord-dbt 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7948bb8cc4c14d07c3fca2855b20957a2871c54dd67149fb178029fa93f6f09
-  data.tar.gz: c8146bfcd3ffa762f16889a79750807ab1e72986e49f34069ac043fe8c89d5f0
+  metadata.gz: 723d33af77e2e665a7baa13aeebdc892ebca6fad469622494591752e59ff3a4f
+  data.tar.gz: f3ced61ce633c40e8464fd5280f200b062d073f96809fae300de2592c15a10bd
 SHA512:
-  metadata.gz: a2d3ce1aa15cafbd0bb6f282d5faa64f6319d669a38a8dde20b04af3cccf12a21e16fa22cf6f7b87b245dd094bad296de2dd22bd027db047b2ed845cc7de2b8a
-  data.tar.gz: 6097b5f0b25324679e012d4a16833afba17514f2ebb82eabe778ae510bc8f283c280dd3d6916b2a3220092c63c7827c56b4b0660f14caa6f1b210a496dff7cdc
+  metadata.gz: 38293faab98d461a080d9699401ac8c5fb8f59c8f1f19cda3a8ed082fd0ebc8041aaf13a9a1ecf57e484fd3f66c976404cc1c3697f7b97d8c4ae9106f942f165
+  data.tar.gz: f966416f03dc58ba525488afac7f13df368607f1b57b3b6c6cf206a5ed56cf7757a52d20fab68f9463f9ab754f72eb622667b42e588abb02aa3a255d4e6c4c32

data/README.md

@@ -58,6 +58,7 @@ dwh_platform | Specify the data warehouse platform to which dbt connects. The de
 data_sync_delayed | Indicates whether there is a data delay. If set to `true`, `severity: warn` is applied to the `relationships` test. The default is `false`.
 logger | The destination for log output. The default is `Logger.new('./log/active_record_dbt.log')`.
 used_dbt_package_names | An array of `dbt` package names to use.
+locale | I18n locale. The default is `I18n.locale`.
 
 List of platforms that can currently be set with `dwh_platform`.
 
@@ -83,16 +84,18 @@ Adjust the settings according to your environment.
 ```ruby
 # frozen_string_literal: true
 
-require 'active_record/dbt'
-
-ActiveRecord::Dbt.configure do |c|
-  c.config_directory_path = 'lib/dbt'
-  c.export_directory_path = 'doc/dbt'
-  c.data_sync_delayed = false
-  c.used_dbt_package_names = [
-    'dbt-labs/dbt_utils',
-    'datnguye/dbterd'
-  ]
+if Rails.env.development?
+  require 'active_record/dbt'
+
+  ActiveRecord::Dbt.configure do |c|
+    c.config_directory_path = 'lib/dbt'
+    c.export_directory_path = 'doc/dbt'
+    c.data_sync_delayed = false
+    c.used_dbt_package_names = [
+      'dbt-labs/dbt_utils',
+      'datnguye/dbterd'
+    ]
+  end
 end
 
 ```
@@ -109,8 +112,8 @@ This will create the following files.
 
 File | Description
 --------- | ---------
-`#{config_directory_path}/source_config.yml` | Used to generate `#{export_directory_path}/src_#{source_name}.yml`.
-`#{config_directory_path}/staging_model.sql.tt` | Used to generate `#{export_directory_path}/stg_#{source_name}__#{table_name}.sql`.
+`#{config_directory_path}/source_config.yml` | Used to generate `#{export_directory_path}/models/sources/#{source_name}/src_#{source_name}.yml`.
+`#{config_directory_path}/staging_model.sql.tt` | Used to generate `#{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.sql`.
 
 ### Generate dbt Source File
 
@@ -157,7 +160,7 @@ table_overrides:
         period: day
     columns:
       created_at:
-        tests:
+        data_tests:
           - not_null:
               where: 'id != 1'
 
@@ -165,10 +168,10 @@ table_overrides:
 
 ##### defaults
 
-Set default values for the `name` and `description` of `tables`.
+Set the default value for the `description`(`logical_name`, `description`) of `tables`.
 
-In `logical_name` and `description` of `table_descriptions`, you can refer to the table name with `{{ table_name }}`.
-In the `description` of `columns`, you can refer to the table name with `{{ table_name }}` and the column name with `{{ column_name }}`.
+In the `logical_name` and `description` of `table_descriptions`, you can refer to the table name with `{{ table_name }}`.
+In the `description` of `table_descriptions.columns`, you can refer to the table name with `{{ table_name }}` and the column name with `{{ column_name }}`.
 
 Example:
 
@@ -250,7 +253,7 @@ table_overrides:
         period: day
     columns:
       created_at:
-        tests:
+        data_tests:
           - not_null:
               where: 'id != 1'
 
@@ -281,7 +284,7 @@ table_descriptions:
 
 ```
 
-#### Generate `#{export_directory_path}/src_#{source_name}.yml`
+#### Generate `#{export_directory_path}/models/sources/#{source_name}/src_#{source_name}.yml`
 
 Generate a source file for dbt:
 
@@ -289,7 +292,7 @@ Generate a source file for dbt:
 $ bin/rails generate active_record:dbt:source
 ```
 
-Generate `#{export_directory_path}/src_#{source_name}.yml`.
+Generate `#{export_directory_path}/models/sources/#{source_name}/src_#{source_name}.yml`.
 
 ##### Example:
 
@@ -297,6 +300,14 @@ Generate `#{export_directory_path}/src_#{source_name}.yml`.
 >
 > The output will be as shown below. It is recommended to indent the YAML file with a tool of your choice.
 
+> [!WARNING]
+>
+> If you are using a version of dbt lower than v1.8, replace `tests:` with `data_tests:` in the generated file.
+>
+> [Add data tests to your DAG | dbt Developer Hub](https://docs.getdbt.com/docs/build/data-tests#new-data_tests-syntax)
+>
+>> Data tests were historically called "tests" in dbt as the only form of testing available. With the introduction of unit tests in v1.8, the key was renamed from `tests:` to `data_tests:`.
+
 ```yaml
 ---
 version: 2
@@ -317,7 +328,7 @@ sources:
     - name: key
       description: Key
       data_type: string
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: value
@@ -326,12 +337,12 @@ sources:
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: companies
     description: Write a logical_name of the 'companies' table.
@@ -339,13 +350,13 @@ sources:
     - name: id
       description: id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: name
       description: Write a description of the 'companies.name' column.
       data_type: string
-      tests:
+      data_tests:
       - not_null
     - name: establishment_date
       description: Write a description of the 'companies.establishment_date' column.
@@ -356,7 +367,7 @@ sources:
     - name: published
       description: Write a description of the 'companies.published' column.
       data_type: bool
-      tests:
+      data_tests:
       - not_null
       - accepted_values:
           values:
@@ -366,12 +377,12 @@ sources:
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: posts
     description: Post
@@ -379,13 +390,13 @@ sources:
     - name: id
       description: ID
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: user_id
       description: User
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'users')
@@ -401,17 +412,17 @@ sources:
     - name: created_at
       description: Post Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Post Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: status
       description: Write a description of the 'posts.status' column.
       data_type: int64
-      tests:
+      data_tests:
       - accepted_values:
           values:
           - 0
@@ -420,7 +431,7 @@ sources:
           quote: false
   - name: posts_tags
     description: Write a logical_name of the 'posts_tags' table.
-    tests:
+    data_tests:
     - dbt_utils.unique_combination_of_columns:
         combination_of_columns:
         - post_id
@@ -429,7 +440,7 @@ sources:
     - name: post_id
       description: post_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'posts')
@@ -442,7 +453,7 @@ sources:
     - name: tag_id
       description: tag_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'tags')
@@ -458,13 +469,13 @@ sources:
     - name: id
       description: id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: user_id
       description: user_id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
       - relationships:
@@ -475,26 +486,26 @@ sources:
     - name: first_name
       description: Write a description of the 'profiles.first_name' column.
       data_type: string
-      tests:
+      data_tests:
       - not_null
     - name: last_name
       description: Write a description of the 'profiles.last_name' column.
       data_type: string
-      tests:
+      data_tests:
       - not_null
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: relationships
     description: Write a logical_name of the 'relationships' table.
-    tests:
+    data_tests:
     - dbt_utils.unique_combination_of_columns:
         combination_of_columns:
         - follower_id
@@ -503,13 +514,13 @@ sources:
     - name: id
       description: id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: follower_id
       description: follower_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'users')
@@ -519,7 +530,7 @@ sources:
     - name: followed_id
       description: followed_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'users')
@@ -529,12 +540,12 @@ sources:
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: schema_migrations
     description: |-
@@ -545,7 +556,7 @@ sources:
     - name: version
       description: The version number of the migration.
       data_type: string
-      tests:
+      data_tests:
       - unique
       - not_null
   - name: tags
@@ -554,28 +565,28 @@ sources:
     - name: id
       description: id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: name
       description: Write a description of the 'tags.name' column.
       data_type: string
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: user_tags
     description: Write a logical_name of the 'user_tags' table.
-    tests:
+    data_tests:
     - dbt_utils.unique_combination_of_columns:
         combination_of_columns:
         - user_id
@@ -584,13 +595,13 @@ sources:
     - name: id
       description: id
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: user_id
       description: user_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'users')
@@ -600,7 +611,7 @@ sources:
     - name: tag_id
       description: tag_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'tags')
@@ -610,12 +621,12 @@ sources:
     - name: created_at
       description: Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: updated_at
       description: Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
   - name: users
     description: User
@@ -631,24 +642,24 @@ sources:
     - name: id
       description: ID
       data_type: int64
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: created_at
       description: User Created At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null:
           where: id != 1
     - name: updated_at
       description: User Updated At
       data_type: datetime
-      tests:
+      data_tests:
       - not_null
     - name: company_id
       description: company_id
       data_type: int64
-      tests:
+      data_tests:
       - relationships:
           to: source('dummy', 'companies')
           field: id
@@ -747,8 +758,8 @@ Generate staging model files for dbt that reference the specified `TABLE_NAME`.
 
 File | Description
 --------- | ---------
-`#{export_directory_path}/stg_#{source_name}__#{table_name}.sql` | Staging model file for dbt.
-`#{export_directory_path}/stg_#{source_name}__#{table_name}.yml` | Staging model documentation file for dbt.
+`#{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.sql` | Staging model file for dbt.
+`#{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.yml` | Staging model documentation file for dbt.
 
 Example:
 
@@ -756,7 +767,7 @@ Example:
 $ bin/rails generate active_record:dbt:staging_model profiles
 ```
 
-##### Generate `#{export_directory_path}/stg_#{source_name}__#{table_name}.sql`
+##### Generate `#{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.sql`
 
 Example:
 
@@ -827,10 +838,22 @@ from final
 
 ```
 
-##### Generate `#{export_directory_path}/stg_#{source_name}__#{table_name}.yml`
+##### Generate `#{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.yml`
 
 Example:
 
+> [!NOTE]
+>
+> The output will be as shown below. It is recommended to indent the YAML file with a tool of your choice.
+
+> [!WARNING]
+>
+> If you are using a version of dbt lower than v1.8, replace `tests:` with `data_tests:` in the generated file.
+>
+> [Add data tests to your DAG | dbt Developer Hub](https://docs.getdbt.com/docs/build/data-tests#new-data_tests-syntax)
+>
+>> Data tests were historically called "tests" in dbt as the only form of testing available. With the introduction of unit tests in v1.8, the key was renamed from `tests:` to `data_tests:`.
+
 ```yaml
 ---
 version: 2
@@ -841,7 +864,7 @@ models:
   - name: profile_id
     description: profile_id
     data_type: int64
-    tests:
+    data_tests:
     - unique
     - not_null
     - relationships:
@@ -852,7 +875,7 @@ models:
   - name: user_id
     description: user_id
     data_type: int64
-    tests:
+    data_tests:
     - unique
     - not_null
     - relationships:
@@ -863,26 +886,144 @@ models:
   - name: first_name
     description: Write a description of the 'profiles.first_name' column.
     data_type: string
-    tests:
+    data_tests:
     - not_null
   - name: last_name
     description: Write a description of the 'profiles.last_name' column.
     data_type: string
-    tests:
+    data_tests:
     - not_null
   - name: created_at
     description: Created At
     data_type: datetime
-    tests:
+    data_tests:
     - not_null
   - name: updated_at
     description: Updated At
     data_type: datetime
-    tests:
+    data_tests:
     - not_null
 
 ```
 
+### Generated dbt Seed Files
+
+#### dbt Seed Configuration
+
+In the `#{config_directory_path}/source_config.yml` file, describe the properties you want to set for the seed enum.
+You can configure `defaults` in this file.
+
+##### defaults
+
+Set the default value for the `description` of the `seeds` enum.
+
+In the `description` of `seed_descriptions.enum`, you can refer to the source name with `{{ source_name }}`, the translated table name with `{{ translated_table_name }}`, and the translated column name with `{{ translated_attribute_name }}`.
+
+Example:
+
+```yml
+defaults:
+  seed_descriptions:
+    enum:
+      description: "{{ source_name }} {{ translated_table_name }} {{ translated_attribute_name }} enum"
+
+```
+
+If nothing is set, it defaults to the following:
+
+```yml
+defaults:
+  seed_descriptions:
+    enum:
+      description: "{{ source_name }} {{ translated_table_name }} {{ translated_attribute_name }} enum"
+
+```
+
+#### Generate dbt Seed Enum Files
+
+Generate seed enum files for dbt:
+
+```bash
+$ bin/rails generate active_record:dbt:enum TABLE_NAME ENUM_COLUMN_NAME
+```
+
+Generate seed enum files for dbt from the specified `TABLE_NAME` and `ENUM_COLUMN_NAME`.
+
+File | Description
+--------- | ---------
+`#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv` | Seed enum file for dbt.
+`#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml` | Seed enum documentation file for dbt.
+
+Example:
+
+```bash
+$ bin/rails generate active_record:dbt:enum posts status
+```
+
+##### Generate `#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv`
+
+Example:
+
+```csv
+status_before_type_of_cast,status_key,status_en,status_ja
+0,draft,Draft,下書き
+1,published,Published,公開
+2,deleted,Deleted,削除
+
+```
+
+##### Generate `#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml`
+
+Example:
+
+> [!NOTE]
+>
+> The output will be as shown below. It is recommended to indent the YAML file with a tool of your choice.
+
+> [!WARNING]
+>
+> If you are using a version of dbt lower than v1.8, replace `tests:` with `data_tests:` in the generated file.
+>
+> [Add data tests to your DAG | dbt Developer Hub](https://docs.getdbt.com/docs/build/data-tests#new-data_tests-syntax)
+>
+>> Data tests were historically called "tests" in dbt as the only form of testing available. With the introduction of unit tests in v1.8, the key was renamed from `tests:` to `data_tests:`.
+
+```yaml
+---
+version: 2
+seeds:
+- name: seed_dummy__post_enum_statuses
+  description: dummy Post Status enum
+  config:
+    column_types:
+      status_before_type_of_cast: int64
+      status_key: string
+      status_en: string
+      status_ja: string
+columns:
+- name: status_before_type_of_cast
+  description: Status
+  data_tests:
+  - unique
+  - not_null
+- name: status_key
+  description: Status(key)
+  data_tests:
+  - unique
+  - not_null
+- name: status_en
+  description: Status(en)
+  data_tests:
+  - unique
+  - not_null
+- name: status_ja
+  description: Status(ja)
+  data_tests:
+  - unique
+  - not_null
+
+```
+
 ## Contributing
 
 Contribution directions go here.