activerecord-dbt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: affd8c9f9864d11cbaf5c35a759ea603c72784b9eae777987debad89fd8cd509
-  data.tar.gz: 6b8ca507c1e413143f3d0a7330451767190b3acb731e70c8b2beb87bff9df64b
+  metadata.gz: 723d33af77e2e665a7baa13aeebdc892ebca6fad469622494591752e59ff3a4f
+  data.tar.gz: f3ced61ce633c40e8464fd5280f200b062d073f96809fae300de2592c15a10bd
 SHA512:
-  metadata.gz: 2798392f8cdcb454a64957a005d7d16e3eeec7e1648234ba5c598cbacb6b683198493337619c9e0a9f17f67a231f6a3fc6f34658651671de3776c7caf28093c9
-  data.tar.gz: d417dfdd69d8a0c41baee03a41a0880ecba05abbbb61c86b80ed1ef48021bcdda16a4e2b43dd414a29d7f56ad9cf92a0e3afe0a693b5ae4aa3a38e0bbeb9f03d
+  metadata.gz: 38293faab98d461a080d9699401ac8c5fb8f59c8f1f19cda3a8ed082fd0ebc8041aaf13a9a1ecf57e484fd3f66c976404cc1c3697f7b97d8c4ae9106f942f165
+  data.tar.gz: f966416f03dc58ba525488afac7f13df368607f1b57b3b6c6cf206a5ed56cf7757a52d20fab68f9463f9ab754f72eb622667b42e588abb02aa3a255d4e6c4c32

data/README.md

@@ -84,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
 
 ```
@@ -110,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
 
@@ -158,7 +160,7 @@ table_overrides:
         period: day
     columns:
       created_at:
-        tests:
+        data_tests:
           - not_null:
               where: 'id != 1'
 
@@ -251,7 +253,7 @@ table_overrides:
         period: day
     columns:
       created_at:
-        tests:
+        data_tests:
           - not_null:
               where: 'id != 1'
 
@@ -282,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:
 
@@ -290,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:
 
@@ -298,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
@@ -318,7 +328,7 @@ sources:
     - name: key
       description: Key
       data_type: string
-      tests:
+      data_tests:
       - unique
       - not_null
     - name: value
@@ -327,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.
@@ -340,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.
@@ -357,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:
@@ -367,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
@@ -380,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')
@@ -402,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
@@ -421,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
@@ -430,7 +440,7 @@ sources:
     - name: post_id
       description: post_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'posts')
@@ -443,7 +453,7 @@ sources:
     - name: tag_id
       description: tag_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'tags')
@@ -459,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:
@@ -476,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
@@ -504,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')
@@ -520,7 +530,7 @@ sources:
     - name: followed_id
       description: followed_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'users')
@@ -530,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: |-
@@ -546,7 +556,7 @@ sources:
     - name: version
       description: The version number of the migration.
       data_type: string
-      tests:
+      data_tests:
       - unique
       - not_null
   - name: tags
@@ -555,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
@@ -585,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')
@@ -601,7 +611,7 @@ sources:
     - name: tag_id
       description: tag_id
       data_type: int64
-      tests:
+      data_tests:
       - not_null
       - relationships:
           to: source('dummy', 'tags')
@@ -611,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
@@ -632,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
@@ -748,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:
 
@@ -757,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:
 
@@ -828,7 +838,7 @@ 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:
 
@@ -836,6 +846,14 @@ Example:
 >
 > 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
@@ -846,7 +864,7 @@ models:
   - name: profile_id
     description: profile_id
     data_type: int64
-    tests:
+    data_tests:
     - unique
     - not_null
     - relationships:
@@ -857,7 +875,7 @@ models:
   - name: user_id
     description: user_id
     data_type: int64
-    tests:
+    data_tests:
     - unique
     - not_null
     - relationships:
@@ -868,22 +886,22 @@ 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
 
 ```
@@ -933,8 +951,8 @@ Generate seed enum files for dbt from the specified `TABLE_NAME` and `ENUM_COLUM
 
 File | Description
 --------- | ---------
-`#{export_directory_path}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv` | Seed enum file for dbt.
-`#{export_directory_path}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml` | Seed enum documentation file for dbt.
+`#{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:
 
@@ -942,7 +960,7 @@ Example:
 $ bin/rails generate active_record:dbt:enum posts status
 ```
 
-##### Generate `#{export_directory_path}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv`
+##### Generate `#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv`
 
 Example:
 
@@ -954,7 +972,7 @@ status_before_type_of_cast,status_key,status_en,status_ja
 
 ```
 
-##### Generate `#{export_directory_path}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml`
+##### Generate `#{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml`
 
 Example:
 
@@ -962,6 +980,14 @@ Example:
 >
 > 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
@@ -977,22 +1003,22 @@ seeds:
 columns:
 - name: status_before_type_of_cast
   description: Status
-  tests:
+  data_tests:
   - unique
   - not_null
 - name: status_key
   description: Status(key)
-  tests:
+  data_tests:
   - unique
   - not_null
 - name: status_en
   description: Status(en)
-  tests:
+  data_tests:
   - unique
   - not_null
 - name: status_ja
   description: Status(ja)
-  tests:
+  data_tests:
   - unique
   - not_null
 

data/lib/active_record/dbt/column/{test.rb → data_test.rb}

@@ -3,11 +3,11 @@
 module ActiveRecord
   module Dbt
     module Column
-      class Test
-        include ActiveRecord::Dbt::Column::Testable::AcceptedValuesTestable
-        include ActiveRecord::Dbt::Column::Testable::NotNullTestable
-        include ActiveRecord::Dbt::Column::Testable::RelationshipsTestable
-        include ActiveRecord::Dbt::Column::Testable::UniqueTestable
+      class DataTest
+        include ActiveRecord::Dbt::Column::DataTestable::AcceptedValuesDataTestable
+        include ActiveRecord::Dbt::Column::DataTestable::NotNullDataTestable
+        include ActiveRecord::Dbt::Column::DataTestable::RelationshipsDataTestable
+        include ActiveRecord::Dbt::Column::DataTestable::UniqueDataTestable
 
         attr_reader :table_name, :column, :primary_keys, :foreign_keys
 
@@ -22,15 +22,15 @@ module ActiveRecord
           @config = ActiveRecord::Dbt::Config.instance
         end
 
-        def config
-          (tests.keys | tests_overrides_hash.keys).map do |key|
-            tests_overrides_hash[key] || tests[key]
+        def properties
+          (data_tests.keys | data_tests_overrides_hash.keys).map do |key|
+            data_tests_overrides_hash[key] || data_tests[key]
           end.presence
         end
 
         private
 
-        def tests
+        def data_tests
           {
             'unique_test' => unique_test,
             'not_null_test' => not_null_test,
@@ -39,10 +39,10 @@ module ActiveRecord
           }.compact
         end
 
-        def tests_overrides_hash
-          @tests_overrides_hash ||=
-            tests_overrides.index_by do |tests_override|
-              "#{extract_key(tests_override)}_test"
+        def data_tests_overrides_hash
+          @data_tests_overrides_hash ||=
+            data_tests_overrides.index_by do |data_tests_override|
+              "#{extract_key(data_tests_override)}_test"
             end
         end
 
@@ -50,9 +50,9 @@ module ActiveRecord
           item.is_a?(Hash) ? item.keys.first : item
         end
 
-        def tests_overrides
-          @tests_overrides ||=
-            source_config.dig(:table_overrides, table_name, :columns, column_name, :tests) ||
+        def data_tests_overrides
+          @data_tests_overrides ||=
+            source_config.dig(:table_overrides, table_name, :columns, column_name, :data_tests) ||
             []
         end
       end

data/lib/active_record/dbt/column/{testable/accepted_values_testable.rb → data_testable/accepted_values_data_testable.rb}

@@ -3,8 +3,8 @@
 module ActiveRecord
   module Dbt
     module Column
-      module Testable
-        module AcceptedValuesTestable
+      module DataTestable
+        module AcceptedValuesDataTestable
           extend ActiveRecord::Dbt::RequiredMethods
 
           define_required_methods :@config, :column, :table_name, :column_name

data/lib/active_record/dbt/column/{testable/not_null_testable.rb → data_testable/not_null_data_testable.rb}

@@ -3,8 +3,8 @@
 module ActiveRecord
   module Dbt
     module Column
-      module Testable
-        module NotNullTestable
+      module DataTestable
+        module NotNullDataTestable
           extend ActiveRecord::Dbt::RequiredMethods
 
           define_required_methods :column

data/lib/active_record/dbt/column/{testable/relationships_testable.rb → data_testable/relationships_data_testable.rb}

@@ -3,9 +3,9 @@
 module ActiveRecord
   module Dbt
     module Column
-      module Testable
-        module RelationshipsTestable
-          include ActiveRecord::Dbt::DbtPackage::Dbterd::Column::Testable::RelationshipsMetaRelationshipType
+      module DataTestable
+        module RelationshipsDataTestable
+          include ActiveRecord::Dbt::DbtPackage::Dbterd::Column::DataTestable::RelationshipsMetaRelationshipType
 
           extend ActiveRecord::Dbt::RequiredMethods
 

data/lib/active_record/dbt/column/{testable/unique_testable.rb → data_testable/unique_data_testable.rb}

@@ -3,8 +3,8 @@
 module ActiveRecord
   module Dbt
     module Column
-      module Testable
-        module UniqueTestable
+      module DataTestable
+        module UniqueDataTestable
           extend ActiveRecord::Dbt::RequiredMethods
 
           define_required_methods :table_name, :column_name, :primary_keys