upgrow 0.0.4 → 0.0.5

data/test/upgrow/naming_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+require 'upgrow/naming'
+
+module Upgrow
+  class NamingTest < ActiveSupport::TestCase
+    test '.record_to_model removes the Record suffix' do
+      assert_equal 'Article', Naming.record_to_model('ArticleRecord')
+    end
+
+    test '.model_to_record adds the Record suffix' do
+      assert_equal 'ArticleRecord', Naming.model_to_record('Article')
+    end
+
+    test '.repository_to_record removes the Repository suffix and adds the Record suffix' do
+      assert_equal 'ArticleRecord',
+        Naming.repository_to_record('ArticleRepository')
+    end
+  end
+end

data/test/upgrow/record_test.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+require 'active_record'
+require 'upgrow/record'
+
+module Upgrow
+  class RecordTest < ActiveSupport::TestCase
+    class ArticleRecord < ActiveRecord::Base
+      include Record
+    end
+
+    class BaseRecord < ActiveRecord::Base
+      include Record
+      self.abstract_class = true
+    end
+
+    class UserRecord < BaseRecord; end
+
+    setup do
+      @original_table_name = ArticleRecord.table_name
+    end
+
+    teardown do
+      ArticleRecord.table_name = @original_table_name
+    end
+
+    test '.table_name is inferred from the class name without the Record suffix' do
+      assert_equal 'articles', ArticleRecord.table_name
+    end
+
+    test '.table_name can be set explicitly' do
+      ArticleRecord.table_name = 'my_table'
+      assert_equal 'my_table', ArticleRecord.table_name
+    end
+
+    test '.table_name ignores inherited abstract classes' do
+      assert_equal 'users', UserRecord.table_name
+    end
+
+    test '.has_many sets a default foreign key based on the class name without the Record suffix' do
+      ArticleRecord.has_many(:comments)
+      reflection = ArticleRecord.reflect_on_association(:comments)
+      assert_equal 'article_id', reflection.foreign_key
+    end
+
+    test '.has_many accepts a foreign key value' do
+      ArticleRecord.has_many(:cats, foreign_key: 'my_custom_id')
+      reflection = ArticleRecord.reflect_on_association(:cats)
+      assert_equal 'my_custom_id', reflection.foreign_key
+    end
+
+    test '.has_many sets the association class name based on its name and the Record suffix' do
+      ArticleRecord.has_many(:paragraphs)
+      reflection = ArticleRecord.reflect_on_association(:paragraphs)
+      assert_equal 'ParagraphRecord', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_many accepts a class name value' do
+      ArticleRecord.has_many(:birds, class_name: 'MyClass')
+      reflection = ArticleRecord.reflect_on_association(:birds)
+      assert_equal 'MyClass', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_many sets the foreign key based on the :as option' do
+      ArticleRecord.has_many(:words, as: 'writable')
+      reflection = ArticleRecord.reflect_on_association(:words)
+      assert_equal 'writable_id', reflection.foreign_key
+    end
+
+    test '.has_one sets a default foreign key based on the class name without the Record suffix' do
+      ArticleRecord.has_one(:excerpt)
+      reflection = ArticleRecord.reflect_on_association(:excerpt)
+      assert_equal 'article_id', reflection.foreign_key
+    end
+
+    test '.has_one accepts a foreign key value' do
+      ArticleRecord.has_one(:title, foreign_key: 'my_custom_id')
+      reflection = ArticleRecord.reflect_on_association(:title)
+      assert_equal 'my_custom_id', reflection.foreign_key
+    end
+
+    test '.has_one sets the association class name based on its name and the Record suffix' do
+      ArticleRecord.has_one(:signature)
+      reflection = ArticleRecord.reflect_on_association(:signature)
+      assert_equal 'SignatureRecord', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_one accepts a class name value' do
+      ArticleRecord.has_one(:image, class_name: 'MyClass')
+      reflection = ArticleRecord.reflect_on_association(:image)
+      assert_equal 'MyClass', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_one sets the foreign key based on the :as option' do
+      ArticleRecord.has_one(:pin, as: 'pinnable')
+      reflection = ArticleRecord.reflect_on_association(:pin)
+      assert_equal 'pinnable_id', reflection.foreign_key
+    end
+
+    test '.belongs_to sets a default foreign key based on the association name' do
+      ArticleRecord.belongs_to(:user)
+      reflection = ArticleRecord.reflect_on_association(:user)
+      assert_equal 'user_id', reflection.foreign_key
+    end
+
+    test '.belongs_to accepts a foreign key value' do
+      ArticleRecord.belongs_to(:book, foreign_key: 'custom_id')
+      reflection = ArticleRecord.reflect_on_association(:book)
+      assert_equal 'custom_id', reflection.foreign_key
+    end
+
+    test '.belongs_to sets the association class name based on its name and the Record suffix' do
+      ArticleRecord.belongs_to(:category)
+      reflection = ArticleRecord.reflect_on_association(:category)
+      assert_equal 'CategoryRecord', reflection.options.fetch(:class_name)
+    end
+
+    test '.belongs_to accepts a class name value' do
+      ArticleRecord.belongs_to(:section, class_name: 'MyClass')
+      reflection = ArticleRecord.reflect_on_association(:section)
+      assert_equal 'MyClass', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_and_belongs_to_many sets a default foreign key based on the class name without the Record suffix' do
+      ArticleRecord.has_and_belongs_to_many(:tags)
+      reflection = ArticleRecord.reflect_on_association(:tags)
+      assert_equal 'article_id', reflection.foreign_key
+    end
+
+    test '.has_and_belongs_to_many accepts a foreign key value' do
+      ArticleRecord.has_and_belongs_to_many(:stars, foreign_key: 'my_custom_id')
+      reflection = ArticleRecord.reflect_on_association(:stars)
+      assert_equal 'my_custom_id', reflection.foreign_key
+    end
+
+    test '.has_and_belongs_to_many sets a default association foreign key based on the class name without the Record suffix' do
+      ArticleRecord.has_and_belongs_to_many(:prizes)
+      reflection = ArticleRecord.reflect_on_association(:prizes)
+      assert_equal 'prize_id', reflection.association_foreign_key
+    end
+
+    test '.has_and_belongs_to_many sets a default association foreign key based on the given class name' do
+      ArticleRecord.has_and_belongs_to_many(:trees, class_name: 'MyClass')
+      reflection = ArticleRecord.reflect_on_association(:trees)
+      assert_equal 'my_class_id', reflection.association_foreign_key
+    end
+
+    test '.has_and_belongs_to_many sets a default association foreign key based on the given class name without the Record suffix' do
+      ArticleRecord.has_and_belongs_to_many(:dogs, class_name: 'MyClassRecord')
+      reflection = ArticleRecord.reflect_on_association(:dogs)
+      assert_equal 'my_class_id', reflection.association_foreign_key
+    end
+
+    test '.has_and_belongs_to_many accepts an association foreign key value' do
+      ArticleRecord.has_and_belongs_to_many(
+        :countries, association_foreign_key: 'my_custom_id'
+      )
+      reflection = ArticleRecord.reflect_on_association(:countries)
+      assert_equal 'my_custom_id', reflection.association_foreign_key
+    end
+
+    test '.has_and_belongs_to_many sets the association class name based on its name and the Record suffix' do
+      ArticleRecord.has_and_belongs_to_many(:flags)
+      reflection = ArticleRecord.reflect_on_association(:flags)
+      assert_equal 'FlagRecord', reflection.options.fetch(:class_name)
+    end
+
+    test '.has_and_belongs_to_many accepts a class name value' do
+      ArticleRecord.has_and_belongs_to_many(:horses, class_name: 'MyClass')
+      reflection = ArticleRecord.reflect_on_association(:horses)
+      assert_equal 'MyClass', reflection.options.fetch(:class_name)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upgrow
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -32,6 +32,34 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/generators/test_unit/input/input_generator.rb
+- lib/generators/test_unit/input/templates/input_test.rb.tt
+- lib/generators/test_unit/install/install_generator.rb
+- lib/generators/test_unit/record/record_generator.rb
+- lib/generators/test_unit/record/templates/record_test.rb.tt
+- lib/generators/test_unit/repository/repository_generator.rb
+- lib/generators/test_unit/repository/templates/repository_test.rb.tt
+- lib/generators/upgrow.rb
+- lib/generators/upgrow/action/USAGE
+- lib/generators/upgrow/action/action_generator.rb
+- lib/generators/upgrow/action/templates/action.rb.tt
+- lib/generators/upgrow/input/USAGE
+- lib/generators/upgrow/input/input_generator.rb
+- lib/generators/upgrow/input/templates/input.rb.tt
+- lib/generators/upgrow/install/USAGE
+- lib/generators/upgrow/install/install_generator.rb
+- lib/generators/upgrow/install/templates/app/actions/application_action.rb.tt
+- lib/generators/upgrow/install/templates/app/inputs/application_input.rb.tt
+- lib/generators/upgrow/install/templates/app/models/application_model.rb.tt
+- lib/generators/upgrow/install/templates/app/repositories/application_repository.rb.tt
+- lib/generators/upgrow/model/USAGE
+- lib/generators/upgrow/model/model_generator.rb
+- lib/generators/upgrow/model/templates/model.rb.tt
+- lib/generators/upgrow/record/record_generator.rb
+- lib/generators/upgrow/record/templates/record.rb.tt
+- lib/generators/upgrow/repository/USAGE
+- lib/generators/upgrow/repository/repository_generator.rb
+- lib/generators/upgrow/repository/templates/repository.rb.tt
 - lib/upgrow.rb
 - lib/upgrow/action.rb
 - lib/upgrow/actions.rb
@@ -46,6 +74,9 @@ files:
 - lib/upgrow/input.rb
 - lib/upgrow/model.rb
 - lib/upgrow/model_schema.rb
+- lib/upgrow/naming.rb
+- lib/upgrow/railtie.rb
+- lib/upgrow/record.rb
 - lib/upgrow/repository.rb
 - lib/upgrow/result.rb
 - lib/upgrow/schema.rb
@@ -122,6 +153,10 @@ files:
 - test/system/sign_out_test.rb
 - test/system/sign_up_test.rb
 - test/test_helper.rb
+- test/test_unit/generators/input_generator_test.rb
+- test/test_unit/generators/install_generator_test.rb
+- test/test_unit/generators/record_generator_test.rb
+- test/test_unit/generators/repository_generator_test.rb
 - test/upgrow/action_test.rb
 - test/upgrow/actions_test.rb
 - test/upgrow/active_record_conversion_test.rb
@@ -130,18 +165,27 @@ files:
 - test/upgrow/basic_model_test.rb
 - test/upgrow/basic_repository_test.rb
 - test/upgrow/documentation_test.rb
+- test/upgrow/generators/action_generator_test.rb
+- test/upgrow/generators/helper_test.rb
+- test/upgrow/generators/input_generator_test.rb
+- test/upgrow/generators/install_generator_test.rb
+- test/upgrow/generators/model_generator_test.rb
+- test/upgrow/generators/record_generator_test.rb
+- test/upgrow/generators/repository_generator_test.rb
 - test/upgrow/immutable_object_test.rb
 - test/upgrow/immutable_struct_test.rb
 - test/upgrow/input_test.rb
 - test/upgrow/model_schema_test.rb
 - test/upgrow/model_test.rb
+- test/upgrow/naming_test.rb
+- test/upgrow/record_test.rb
 - test/upgrow/result_test.rb
 - test/upgrow/schema_test.rb
 homepage: https://github.com/Shopify/upgrow
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/upgrow/tree/v0.0.4
+  source_code_uri: https://github.com/Shopify/upgrow/tree/v0.0.5
   allowed_push_host: https://rubygems.org
 post_install_message:
 rdoc_options: []
@@ -236,6 +280,10 @@ test_files:
 - test/system/sign_out_test.rb
 - test/system/sign_up_test.rb
 - test/test_helper.rb
+- test/test_unit/generators/input_generator_test.rb
+- test/test_unit/generators/install_generator_test.rb
+- test/test_unit/generators/record_generator_test.rb
+- test/test_unit/generators/repository_generator_test.rb
 - test/upgrow/action_test.rb
 - test/upgrow/actions_test.rb
 - test/upgrow/active_record_conversion_test.rb
@@ -244,10 +292,19 @@ test_files:
 - test/upgrow/basic_model_test.rb
 - test/upgrow/basic_repository_test.rb
 - test/upgrow/documentation_test.rb
+- test/upgrow/generators/action_generator_test.rb
+- test/upgrow/generators/helper_test.rb
+- test/upgrow/generators/input_generator_test.rb
+- test/upgrow/generators/install_generator_test.rb
+- test/upgrow/generators/model_generator_test.rb
+- test/upgrow/generators/record_generator_test.rb
+- test/upgrow/generators/repository_generator_test.rb
 - test/upgrow/immutable_object_test.rb
 - test/upgrow/immutable_struct_test.rb
 - test/upgrow/input_test.rb
 - test/upgrow/model_schema_test.rb
 - test/upgrow/model_test.rb
+- test/upgrow/naming_test.rb
+- test/upgrow/record_test.rb
 - test/upgrow/result_test.rb
 - test/upgrow/schema_test.rb