activerecord-dbt 0.2.0 → 0.4.0

data/lib/active_record/dbt/seed/enum/base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Dbt
+    module Seed
+      module Enum
+        module Base
+          attr_reader :table_name, :enum_column_name
+
+          delegate :source_name, :export_directory_path, to: :@config
+          delegate :singularize, to: :table_name, prefix: true
+
+          def initialize(table_name, enum_column_name)
+            @table_name = table_name
+            @enum_column_name = enum_column_name
+            @config = ActiveRecord::Dbt::Config.instance
+          end
+
+          private
+
+          def basename
+            "#{export_directory_path}/seeds/#{source_name}/#{seed_name}"
+          end
+
+          def seed_name
+            "seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}"
+          end
+
+          def locales
+            @locales ||= I18n.available_locales
+          end
+
+          def application_record_klass
+            @application_record_klass ||= table_name_singularize.classify.constantize
+          rescue NameError => _e
+            raise DoesNotExistTableError, "#{table_name} table does not exist."
+          end
+
+          def enum_pluralized
+            enum_column_name.pluralize
+          end
+
+          class DoesNotExistTableError < StandardError; end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/dbt/seed/enum/csv.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module ActiveRecord
+  module Dbt
+    module Seed
+      module Enum
+        class Csv
+          include ActiveRecord::Dbt::Seed::Enum::Base
+
+          delegate :singularize, to: :table_name, prefix: true
+
+          def export_path
+            "#{basename}.csv"
+          end
+
+          def dump
+            CSV.generate(headers: true) do |csv|
+              rows.each { |row| csv << row }
+            end
+          end
+
+          private
+
+          def rows
+            [
+              header,
+              *enum_rows
+            ]
+          end
+
+          def header
+            [
+              "#{enum_column_name}_before_type_of_cast",
+              "#{enum_column_name}_key",
+              *locale_header
+            ]
+          end
+
+          def locale_header
+            locales.map { |locale| "#{enum_column_name}_#{locale}" }
+          end
+
+          def enum_rows
+            enums.map do |enum_key, enum_before_type_of_cast|
+              [
+                enum_before_type_of_cast,
+                enum_key,
+                *enum_values(enum_key)
+              ]
+            end
+          end
+
+          def enums
+            application_record_klass.defined_enums.fetch(enum_column_name)
+          rescue KeyError => _e
+            raise NotEnumColumnError, "#{table_name}.#{enum_column_name} column is not an enum." if enum_column?
+
+            raise DoesNotExistColumnError, "The #{enum_column_name} column in the #{table_name} table does not exist."
+          end
+
+          def enum_column?
+            application_record_klass.column_names.include?(enum_column_name)
+          end
+
+          def enum_values(enum_key)
+            locales.map { |locale| translated_enum_value(enum_key, locale) }
+          end
+
+          def translated_enum_value(enum_key, locale)
+            I18n.t(
+              "activerecord.enum.#{table_name_singularize}.#{enum_column_name}.#{enum_key}",
+              locale: locale,
+              default: nil
+            )
+          end
+
+          class DoesNotExistColumnError < StandardError; end
+          class NotEnumColumnError < StandardError; end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/dbt/seed/enum/yml.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Dbt
+    module Seed
+      module Enum
+        class Yml
+          include ActiveRecord::Dbt::Column::DataTestable::UniqueDataTestable
+          include ActiveRecord::Dbt::Column::DataTestable::NotNullDataTestable
+          include ActiveRecord::Dbt::DataType::Mapper
+          include ActiveRecord::Dbt::I18nWrapper::Translate
+          include ActiveRecord::Dbt::Seed::Enum::Base
+
+          delegate :source_config, to: :@config
+
+          alias column_name enum_column_name
+
+          def export_path
+            "#{basename}.yml"
+          end
+
+          def dump
+            YAML.dump(properties.deep_stringify_keys)
+          end
+
+          private
+
+          def properties
+            {
+              'version' => 2,
+              'seeds' => [
+                'name' => seed_name,
+                'description' => seed_description,
+                'config' => {
+                  'column_types' => column_types
+                }
+              ],
+              'columns' => columns
+            }
+          end
+
+          def seed_description
+            default_seed_description ||
+              "#{source_name} #{translated_table_name} #{translated_attribute_name} enum".strip
+          end
+
+          def default_seed_description
+            source_config.dig(:defaults, :seed_descriptions, :enum, :description)
+                         &.gsub(/{{\s*source_name\s*}}/, source_name)
+                         &.gsub(/{{\s*translated_table_name\s*}}/, translated_table_name)
+                         &.gsub(/{{\s*translated_attribute_name\s*}}/, translated_attribute_name)
+          end
+
+          def column_types
+            {
+              "#{enum_column_name}_before_type_of_cast" => data_type(before_type_of_cast_type),
+              "#{enum_column_name}_key" => data_type(:string),
+              **enum_column_types
+            }
+          end
+
+          def before_type_of_cast_type
+            application_record_klass.columns_hash[enum_column_name].type
+          end
+
+          def enum_column_types
+            locales.each_with_object({}) do |locale, hash|
+              hash["#{enum_column_name}_#{locale}"] = data_type(:string)
+            end
+          end
+
+          def columns
+            [
+              before_type_of_cast_column,
+              enum_key_column,
+              *enum_columns
+            ].compact
+          end
+
+          def before_type_of_cast_column
+            {
+              'name' => "#{enum_column_name}_before_type_of_cast",
+              'description' => translated_attribute_name,
+              'data_tests' => data_tests
+            }.compact
+          end
+
+          def enum_key_column
+            {
+              'name' => "#{enum_column_name}_key",
+              'description' => "#{translated_attribute_name}(key)",
+              'data_tests' => data_tests
+            }.compact
+          end
+
+          def enum_columns
+            locales.each_with_object([]) do |locale, array|
+              array.push(
+                {
+                  'name' => "#{enum_column_name}_#{locale}",
+                  'description' => "#{translated_attribute_name}(#{locale})",
+                  'data_tests' => data_tests
+                }.compact
+              )
+            end
+          end
+
+          def data_tests
+            [
+              unique_test,
+              not_null_test
+            ].compact.presence
+          end
+
+          # MEMO: I think all enums are unique.
+          def unique?
+            true
+          end
+
+          # MEMO: I think all enums are null.
+          def null?
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/dbt/source/yml.rb

@@ -6,14 +6,24 @@ module ActiveRecord
       class Yml
         attr_reader :tables
 
-        delegate :source_config, to: :@config
+        delegate :source_config, :export_directory_path, :source_name, to: :@config
 
         def initialize(tables)
           @tables = tables
           @config = ActiveRecord::Dbt::Config.instance
         end
 
-        def config
+        def export_path
+          "#{export_directory_path}/models/sources/#{source_name}/src_#{source_name}.yml"
+        end
+
+        def dump
+          YAML.dump(properties.deep_stringify_keys)
+        end
+
+        private
+
+        def properties
           {
             'version' => 2,
             'sources' => [
@@ -22,14 +32,12 @@ module ActiveRecord
           }
         end
 
-        private
-
         def source_properties
           source_config[:sources]
         end
 
         def tables_properties
-          tables.map(&:config)
+          tables.map(&:properties)
         end
       end
     end

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

@@ -3,12 +3,12 @@
 module ActiveRecord
   module Dbt
     module Table
-      class Test
-        include ActiveRecord::Dbt::DbtPackage::DbtUtils::Table::Testable::UniqueCombinationOfColumnsTestable
+      class DataTest
+        include ActiveRecord::Dbt::DbtPackage::DbtUtils::Table::DataTestable::UniqueCombinationOfColumnsDataTestable
 
         include ActiveRecord::Dbt::Table::Base
 
-        def config
+        def properties
           [
             *unique_combination_of_columns_test
           ].compact.presence

data/lib/active_record/dbt/table/yml.rb

@@ -4,22 +4,23 @@ module ActiveRecord
   module Dbt
     module Table
       class Yml
+        include ActiveRecord::Dbt::I18nWrapper::Translate
         include ActiveRecord::Dbt::Table::Base
 
-        attr_reader :table_test, :columns
+        attr_reader :table_data_test, :columns
 
         delegate :source_config, to: :@config
 
-        def initialize(table_name, table_test, columns)
+        def initialize(table_name, table_data_test, columns)
           super(table_name)
-          @table_test = table_test
+          @table_data_test = table_data_test
           @columns = columns
         end
 
-        def config
+        def properties
           {
             **table_properties,
-            'columns' => columns.map(&:config)
+            'columns' => columns.map(&:properties)
           }.compact
         end
 
@@ -30,7 +31,7 @@ module ActiveRecord
             'name' => table_name,
             'description' => description,
             **table_overrides.except(:columns),
-            'tests' => table_test.config
+            'data_tests' => table_data_test.properties
           }
         end
 
@@ -51,10 +52,6 @@ module ActiveRecord
             "Write a logical_name of the '#{table_name}' table."
         end
 
-        def translated_table_name
-          I18n.t("activerecord.models.#{table_name.singularize}", default: nil)
-        end
-
         def default_logical_name
           source_config.dig(:defaults, :table_descriptions, :logical_name)
                        &.gsub(/{{\s*table_name\s*}}/, table_name)

data/lib/active_record/dbt/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Dbt
-    VERSION = '0.2.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/generators/active_record/dbt/config/templates/source_config.yml.tt

@@ -11,7 +11,7 @@ table_overrides:
     meta: {<dictionary>}
     identifier: <table_name>
     loaded_at_field: <column_name>
-    tests:
+    data_tests:
       - <test>
     tags: [<string>]
     freshness:
@@ -31,7 +31,7 @@ table_overrides:
       <column_name>:
         meta: {<dictionary>}
         quote: true | false
-        tests:
+        data_tests:
           - <test>
         tags: [<string>]
 
@@ -40,6 +40,9 @@ defaults:
     logical_name: Write a logical_name of the '{{ table_name }}' table.
     columns:
       description: Write a description of the '{{ table_name }}.{{ column_name }}' column.
+  seed_descriptions:
+    enum:
+      description: "{{ source_name }} {{ translated_table_name }} {{ translated_attribute_name }} enum"
 
 table_descriptions:
   ar_internal_metadata:

data/lib/generators/active_record/dbt/enum/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate seed enum files for dbt from the specified TABLE_NAME and ENUM_COLUMN_NAME.
+
+Example:
+    bin/rails generate active_record:dbt:enum TABLE_NAME ENUM_COLUMN_NAME
+
+    This will create:
+        #{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.csv
+        #{export_directory_path}/seeds/#{source_name}/seed_#{source_name}__#{table_name_singularize}_enum_#{enum_pluralized}.yml

data/lib/generators/active_record/dbt/enum/enum_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Dbt
+    module Generators
+      class EnumGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+
+        argument :enum_column_name, type: :string, default: nil
+
+        def create_enum_seed_csv_file
+          create_file csv.export_path, csv.dump
+        end
+
+        def create_enum_seed_yml_file
+          create_file yml.export_path, yml.dump
+        end
+
+        private
+
+        def csv
+          @csv ||= ActiveRecord::Dbt::Seed::Enum::Csv.new(name, enum_column_name)
+        end
+
+        def yml
+          @yml ||= ActiveRecord::Dbt::Seed::Enum::Yml.new(name, enum_column_name)
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_record/dbt/initializer/templates/dbt.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'active_record/dbt'
+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.dwh_platform = 'bigquery'
-  c.data_sync_delayed = false
-  c.used_dbt_package_names = []
+  ActiveRecord::Dbt.configure do |c|
+    c.config_directory_path = 'lib/dbt'
+    c.export_directory_path = 'doc/dbt'
+    c.dwh_platform = 'bigquery'
+    c.data_sync_delayed = false
+    c.used_dbt_package_names = []
+  end
 end

data/lib/generators/active_record/dbt/source/USAGE

@@ -5,4 +5,4 @@ Example:
     bin/rails generate active_record:dbt:source
 
     This will create:
-        #{export_directory_path}/src_#{source_name}.yml
+        #{export_directory_path}/models/sources/#{source_name}/src_#{source_name}.yml

data/lib/generators/active_record/dbt/source/source_generator.rb

@@ -7,14 +7,13 @@ module ActiveRecord
         source_root File.expand_path('templates', __dir__)
 
         def create_source_yml_file
-          create_file "#{config.export_directory_path}/src_#{config.source_name}.yml",
-                      ActiveRecord::Dbt::Factory::SourceFactory.build
+          create_file yml.export_path, yml.dump
         end
 
         private
 
-        def config
-          @config ||= ActiveRecord::Dbt::Config.instance
+        def yml
+          @yml ||= ActiveRecord::Dbt::Factory::Source::YmlFactory.build
         end
       end
     end

data/lib/generators/active_record/dbt/staging_model/USAGE

@@ -5,5 +5,5 @@ Example:
     bin/rails generate active_record:dbt:staging_model TABLE_NAME
 
     This will create:
-        #{export_directory_path}/stg_#{source_name}__#{table_name}.sql
-        #{export_directory_path}/stg_#{source_name}__#{table_name}.yml
+        #{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.sql
+        #{export_directory_path}/models/staging/#{source_name}/stg_#{source_name}__#{table_name}.yml

data/lib/generators/active_record/dbt/staging_model/staging_model_generator.rb

@@ -11,7 +11,7 @@ module ActiveRecord
         end
 
         def create_staging_model_yml_file
-          create_file yml.export_path, yml.yml_dump
+          create_file yml.export_path, yml.dump
         end
 
         private
@@ -21,7 +21,7 @@ module ActiveRecord
         end
 
         def yml
-          @yml ||= ActiveRecord::Dbt::Factory::Model::StagingFactory.yml_build(name)
+          @yml ||= ActiveRecord::Dbt::Factory::Model::Staging::YmlFactory.build(name)
         end
 
         def source_paths

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-dbt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yamotech
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-03 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -64,44 +64,47 @@ files:
 - README.md
 - Rakefile
 - lib/active_record/dbt.rb
-- lib/active_record/dbt/column/column.rb
-- lib/active_record/dbt/column/test.rb
-- lib/active_record/dbt/column/testable/accepted_values_testable.rb
-- lib/active_record/dbt/column/testable/not_null_testable.rb
-- lib/active_record/dbt/column/testable/relationships_testable.rb
-- lib/active_record/dbt/column/testable/unique_testable.rb
+- lib/active_record/dbt/column/data_test.rb
+- lib/active_record/dbt/column/data_testable/accepted_values_data_testable.rb
+- lib/active_record/dbt/column/data_testable/not_null_data_testable.rb
+- lib/active_record/dbt/column/data_testable/relationships_data_testable.rb
+- lib/active_record/dbt/column/data_testable/unique_data_testable.rb
+- lib/active_record/dbt/column/yml.rb
 - lib/active_record/dbt/config.rb
 - lib/active_record/dbt/configuration/data_sync.rb
 - lib/active_record/dbt/configuration/dwh_platform.rb
+- lib/active_record/dbt/configuration/i18n_configuration.rb
 - lib/active_record/dbt/configuration/logger.rb
 - lib/active_record/dbt/configuration/parser.rb
+- lib/active_record/dbt/configuration/source.rb
 - lib/active_record/dbt/configuration/used_dbt_package.rb
-- lib/active_record/dbt/data_type/dwh_platform/apache_spark.rb
-- lib/active_record/dbt/data_type/dwh_platform/bigquery.rb
-- lib/active_record/dbt/data_type/dwh_platform/postgre_sql.rb
-- lib/active_record/dbt/data_type/dwh_platform/redshift.rb
-- lib/active_record/dbt/data_type/dwh_platform/snowflake.rb
 - lib/active_record/dbt/data_type/mapper.rb
-- lib/active_record/dbt/dbt_package/dbt_utils/table/testable/unique_combination_of_columns_testable.rb
-- lib/active_record/dbt/dbt_package/dbterd/column/testable/relationships_meta_relationship_type.rb
-- lib/active_record/dbt/factory/columns_factory.rb
-- lib/active_record/dbt/factory/model/staging_factory.rb
-- lib/active_record/dbt/factory/source_factory.rb
-- lib/active_record/dbt/factory/table_factory.rb
-- lib/active_record/dbt/factory/tables_factory.rb
+- lib/active_record/dbt/dbt_package/dbt_utils/table/data_testable/unique_combination_of_columns_data_testable.rb
+- lib/active_record/dbt/dbt_package/dbterd/column/data_testable/relationships_meta_relationship_type.rb
+- lib/active_record/dbt/factory/columns/yml_factory.rb
+- lib/active_record/dbt/factory/model/staging/yml_factory.rb
+- lib/active_record/dbt/factory/source/yml_factory.rb
+- lib/active_record/dbt/factory/table/yml_factory.rb
+- lib/active_record/dbt/factory/tables/yml_factory.rb
+- lib/active_record/dbt/i18n_wrapper/translate.rb
 - lib/active_record/dbt/model/staging/base.rb
 - lib/active_record/dbt/model/staging/sql.rb
 - lib/active_record/dbt/model/staging/yml.rb
 - lib/active_record/dbt/railtie.rb
 - lib/active_record/dbt/required_methods.rb
+- lib/active_record/dbt/seed/enum/base.rb
+- lib/active_record/dbt/seed/enum/csv.rb
+- lib/active_record/dbt/seed/enum/yml.rb
 - lib/active_record/dbt/source/yml.rb
 - lib/active_record/dbt/table/base.rb
-- lib/active_record/dbt/table/test.rb
+- lib/active_record/dbt/table/data_test.rb
 - lib/active_record/dbt/table/yml.rb
 - lib/active_record/dbt/version.rb
 - lib/generators/active_record/dbt/config/USAGE
 - lib/generators/active_record/dbt/config/config_generator.rb
 - lib/generators/active_record/dbt/config/templates/source_config.yml.tt
+- lib/generators/active_record/dbt/enum/USAGE
+- lib/generators/active_record/dbt/enum/enum_generator.rb
 - lib/generators/active_record/dbt/initializer/USAGE
 - lib/generators/active_record/dbt/initializer/initializer_generator.rb
 - lib/generators/active_record/dbt/initializer/templates/dbt.rb

data/lib/active_record/dbt/data_type/dwh_platform/apache_spark.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module Dbt
-    module DataType
-      module DwhPlatform
-        module ApacheSpark
-          # TODO: I have not tried it. I don't know if this is the correct data_type.
-          # [Data Types - Spark 3.5.1 Documentation](https://spark.apache.org/docs/latest/sql-ref-datatypes.html)
-          RUBY_TO_SPARK_TYPES = {
-            binary: 'binary',
-            boolean: 'boolean',
-            date: 'date',
-            datetime: 'timestamp',
-            decimal: 'decimal',
-            float: 'float',
-            integer: 'integer',
-            json: 'string',
-            string: 'string',
-            text: 'string',
-            time: 'string'
-          }.freeze
-        end
-      end
-    end
-  end
-end

data/lib/active_record/dbt/data_type/dwh_platform/bigquery.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module Dbt
-    module DataType
-      module DwhPlatform
-        module Bigquery
-          # [Data types  |  BigQuery  |  Google Cloud](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data_type_list)
-          RUBY_TO_BIGQUERY_TYPES = {
-            binary: 'bytes',
-            boolean: 'bool',
-            date: 'date',
-            datetime: 'datetime',
-            decimal: 'int64',
-            float: 'float64',
-            integer: 'int64',
-            json: 'json',
-            string: 'string',
-            text: 'string',
-            time: 'time'
-          }.freeze
-        end
-      end
-    end
-  end
-end