rails-code-generator 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1787e88d10c2e47cbe9fdafa9ec47b61cb8dde03907191fcc5344f186f69cf9c
-  data.tar.gz: 8bdfd7f36fd83cffdf6c57d7ecf35f345f7bac31434528a50b4935338b8ae2cb
+  metadata.gz: a58785634e9cb4a0e9ea51de9e3feed6953434eda056000455672489d3220b4f
+  data.tar.gz: d52276ce775667bb11a6802d5ee12a389587c0a29e2e42020503b276f242f90d
 SHA512:
-  metadata.gz: a0181136e1aa0097fe93fdcc0c54931dd0b058f2a8e264184e6b877c9714d2cec6650231756daebfffe2a2a912b62aaeabc508782f550972e57856d906b15c02
-  data.tar.gz: f1036a08400cfe4b7d522dd9fd4bf600d5f783b120c04306e0b75b7ddeea8482652ee72f49afaaf60033491f508ae5a0e9bb7bb1570fd76bdc0bbdb1b9546afa
+  metadata.gz: 97f6426558b8e1ddc60c35af5c931a1e12e628abdb7ca73cbd8641818242958e7179a9e8809e0d65c7d82e90d36e16a1a8654c5379c225cffaddc9f4a3561bfd
+  data.tar.gz: 88383886534fdc4954d7bf5b1a7291460324da0d1efec697879df8a7653d9ead08320b538e332471cbe9ac745c8cd294e71a3981459a98e40af4ae8db8b6c262

data/lib/generators/rails_code_generator/resources/resources_generator.rb

@@ -35,6 +35,10 @@ module RailsCodeGenerator
       template "shared/normalizer.rb", File.join("app/normalizers", "#{table_name}_normalizer.rb")
     end
 
+    def create_factory
+      template "shared/factory.rb", File.join("spec/factories", "#{singular_name}.rb")
+    end
+
     def create_request_specs
       template "shared/index_spec.rb", File.join("spec/requests", table_name, "index_spec.rb")
       template "shared/show_spec.rb", File.join("spec/requests", table_name, "show_spec.rb")

data/lib/generators/rails_code_generator/resources/templates/bulk/create_spec.rb.tt

@@ -5,12 +5,13 @@ require "rails_helper"
 RSpec.describe "[POST] /<%= route_path %>", type: :request do
   Given(:path) { "/<%= route_path %>" }
   Given(:user) { create :user }
+<%= request_spec_association_givens %>
 
   context "with valid params" do
     Given(:params) {
       {
         <%= table_name %>: {
-          # TODO: add attributes
+<%= request_params_attributes_list %>
         },
       }.to_json
     }

data/lib/generators/rails_code_generator/resources/templates/bulk/update_spec.rb.tt

@@ -6,12 +6,13 @@ RSpec.describe "[PATCH] /<%= route_path %>/:id", type: :request do
   Given(:path)          { "/<%= route_path %>/" + <%= singular_name %>.id.to_s }
   Given(:<%= singular_name %>) { create :<%= singular_name %> }
   Given(:user)          { create :user }
+<%= request_spec_association_givens %>
 
   context "with authenticated user & valid params" do
     Given(:params) {
       {
         <%= table_name %>: {
-          name: "Changed <%= singular_name %> name",
+<%= request_params_attributes_list %>
         },
       }.to_json
     }
@@ -21,6 +22,5 @@ RSpec.describe "[PATCH] /<%= route_path %>/:id", type: :request do
     Then { expect(response).to be_successful }
     And  { expect(response_body[:data]).not_to be_empty }
     And  { expect(response_body[:errors]).to be_empty }
-    And  { expect(response_body.dig(:data, :name)).to eq "Changed <%= singular_name %> name" }
   end
 end

data/lib/generators/rails_code_generator/resources/templates/shared/factory.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :<%= singular_name %> do
+<%= factory_definition_body %>
+  end
+end

data/lib/generators/rails_code_generator/resources/templates/shared/normalizer.rb.tt

@@ -2,6 +2,6 @@
 
 class <%= resource_normalizer_class %> < BaseResponseNormalizer
   attributes(
-<%= normalizer_attributes_list %>
+<%= normalizer_attributes_list(include_id: true) %>
   )
 end

data/lib/generators/rails_code_generator/resources/templates/single/create_spec.rb.tt

@@ -5,12 +5,13 @@ require "rails_helper"
 RSpec.describe "[POST] /<%= route_path %>", type: :request do
   Given(:path) { "/<%= route_path %>" }
   Given(:user) { create :user }
+<%= request_spec_association_givens %>
 
   context "with valid params" do
     Given(:params) {
       {
         <%= singular_name %>: {
-          # TODO: add attributes
+<%= request_params_attributes_list %>
         },
       }.to_json
     }

data/lib/generators/rails_code_generator/resources/templates/single/update_spec.rb.tt

@@ -6,12 +6,13 @@ RSpec.describe "[PATCH] /<%= route_path %>/:id", type: :request do
   Given(:path)          { "/<%= route_path %>/#{<%= singular_name %>.id}" }
   Given(:<%= singular_name %>) { create :<%= singular_name %> }
   Given(:user)          { create :user }
+<%= request_spec_association_givens %>
 
   context "with authenticated user & valid params" do
     Given(:params) {
       {
         <%= singular_name %>: {
-          name: "Changed <%= singular_name %> name",
+<%= request_params_attributes_list %>
         },
       }.to_json
     }
@@ -21,6 +22,5 @@ RSpec.describe "[PATCH] /<%= route_path %>/:id", type: :request do
     Then { expect(response).to be_successful }
     And  { expect(response_body[:data]).not_to be_empty }
     And  { expect(response_body[:errors]).to be_empty }
-    And  { expect(response_body.dig(:data, :name)).to eq "Changed <%= singular_name %> name" }
   end
 end

data/lib/rails/code/generator/model_attributes.rb

@@ -5,6 +5,7 @@ module Rails
     module Generator
       module ModelAttributes
         EXCLUDED_COLUMNS = %w[id created_at updated_at].freeze
+        AUTH_USER_ASSOCIATION = "user"
 
         DRY_TYPE_MAP = {
           "string" => :string,
@@ -24,6 +25,24 @@ module Rails
           "uuid" => :string,
         }.freeze
 
+        FAKER_EXPRESSION_MAP = {
+          "string" => "Faker::Lorem.word",
+          "text" => "Faker::Lorem.paragraph",
+          "citext" => "Faker::Lorem.word",
+          "integer" => "Faker::Number.number(digits: 5)",
+          "bigint" => "Faker::Number.number(digits: 5)",
+          "float" => "Faker::Number.decimal(l_digits: 2).to_f",
+          "decimal" => "Faker::Number.decimal(l_digits: 2)",
+          "boolean" => "Faker::Boolean.boolean",
+          "date" => "Faker::Date.forward(days: 30)",
+          "datetime" => "Faker::Time.forward(days: 30)",
+          "timestamp" => "Faker::Time.forward(days: 30)",
+          "timestamptz" => "Faker::Time.forward(days: 30)",
+          "json" => "{}",
+          "jsonb" => "{}",
+          "uuid" => "Faker::Internet.uuid",
+        }.freeze
+
         def model_attributes
           @model_attributes ||= fetch_model_attributes
         end
@@ -34,8 +53,9 @@ module Rails
           format_symbol_list(names)
         end
 
-        def normalizer_attributes_list
+        def normalizer_attributes_list(include_id: false)
           names = model_attribute_names
+          names = [:id, *names] if include_id
           return "    # TODO: add attributes" if names.empty?
 
           format_symbol_list(names, indent: 4)
@@ -47,12 +67,60 @@ module Rails
           model_attributes.map { |attribute| validator_line_for(attribute) }.join("\n")
         end
 
+        def request_params_attributes_list(indent: 10)
+          padding = " " * indent
+          return "#{padding}# TODO: add attributes" if model_attributes.empty?
+
+          model_attributes.map { |attribute| "#{padding}#{attribute[:name]}: #{param_expression_for(attribute)}," }.join("\n")
+        end
+
+        def request_spec_association_givens
+          associations_for_givens.map { |association|
+            "  Given(:#{association[:name]}) { create :#{association[:factory]} }"
+          }.join("\n")
+        end
+
+        def factory_definition_body
+          lines = factory_association_lines + factory_attribute_lines
+          return "    # TODO: add attributes" if lines.empty?
+
+          lines.join("\n")
+        end
+
         private
 
         def model_attribute_names
           model_attributes.map { |attribute| attribute[:name].to_sym }
         end
 
+        def model_associations
+          model_attributes.filter_map { |attribute| attribute[:association] }
+                          .uniq { |association| association[:name] }
+        end
+
+        def associations_for_givens
+          model_associations.reject { |association| association[:name] == AUTH_USER_ASSOCIATION }
+        end
+
+        def factory_association_lines
+          model_associations.map { |association|
+            "    association  :#{association[:name]}, factory: :#{association[:factory]}"
+          }
+        end
+
+        def factory_attribute_lines
+          attributes = model_attributes.reject { |attribute| attribute[:association] }
+          return [] if attributes.empty?
+
+          width = attributes.map { |attribute| attribute[:name].length }.max
+
+          attributes.map { |attribute|
+            name = attribute[:name].ljust(width)
+            expression = FAKER_EXPRESSION_MAP.fetch(attribute[:type], "Faker::Lorem.word")
+            "    #{name} { #{expression} }"
+          }
+        end
+
         def format_symbol_list(names, indent: 6)
           padding = " " * indent
           names.map { |name| "#{padding}:#{name}," }.join("\n")
@@ -69,21 +137,81 @@ module Rails
           end
         end
 
+        def param_expression_for(attribute)
+          association = attribute[:association]
+          return "#{association[:name]}.id" if association
+
+          FAKER_EXPRESSION_MAP.fetch(attribute[:type], "Faker::Lorem.word")
+        end
+
         def fetch_model_attributes
           klass = class_name.constantize
           return [] unless klass.respond_to?(:columns)
 
+          associations_by_fk, polymorphic_fks = belongs_to_association_maps(klass)
+
           klass.columns.filter_map do |column|
             next if EXCLUDED_COLUMNS.include?(column.name)
 
+            type = column.type.to_s
+
             {
               name: column.name,
-              dry_type: DRY_TYPE_MAP[column.type.to_s],
-            }
+              type: type,
+              dry_type: DRY_TYPE_MAP[type],
+              association: association_for_column(column.name, associations_by_fk, polymorphic_fks),
+            }.compact
           end
         rescue StandardError
           []
         end
+
+        def belongs_to_association_maps(klass)
+          return [{}, []] unless klass.respond_to?(:reflect_on_all_associations)
+
+          associations_by_fk = {}
+          polymorphic_fks = []
+
+          klass.reflect_on_all_associations(:belongs_to).each do |reflection|
+            foreign_key = reflection.foreign_key.to_s
+
+            if reflection.options[:polymorphic]
+              polymorphic_fks << foreign_key
+              next
+            end
+
+            associations_by_fk[foreign_key] = {
+              name: reflection.name.to_s,
+              factory: factory_name_for(reflection),
+            }
+          rescue StandardError
+            next
+          end
+
+          [associations_by_fk, polymorphic_fks]
+        rescue StandardError
+          [{}, []]
+        end
+
+        def factory_name_for(reflection)
+          reflection.klass.model_name.singular
+        rescue StandardError
+          reflection.name.to_s
+        end
+
+        def association_for_column(column_name, associations_by_fk, polymorphic_fks)
+          return if polymorphic_fks.include?(column_name)
+          return associations_by_fk[column_name] if associations_by_fk.key?(column_name)
+          return unless column_name.end_with?("_id")
+
+          association_name = column_name.delete_suffix("_id")
+          return if association_name.empty?
+
+          {
+            name: association_name,
+            factory: association_name,
+          }
+        end
       end
     end
   end

data/lib/rails/code/generator/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module Code
     module Generator
-      VERSION = "0.1.1"
+      VERSION = "0.1.3"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-code-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Sweat
@@ -48,6 +48,7 @@ files:
 - lib/generators/rails_code_generator/resources/templates/bulk/update.rb.tt
 - lib/generators/rails_code_generator/resources/templates/bulk/update_spec.rb.tt
 - lib/generators/rails_code_generator/resources/templates/bulk/update_validator.rb.tt
+- lib/generators/rails_code_generator/resources/templates/shared/factory.rb.tt
 - lib/generators/rails_code_generator/resources/templates/shared/index_spec.rb.tt
 - lib/generators/rails_code_generator/resources/templates/shared/normalizer.rb.tt
 - lib/generators/rails_code_generator/resources/templates/shared/show_spec.rb.tt