annotaterb 4.0.0.beta.1 → 4.1.0

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class ModelWrapper
+      # Should be the wrapper for an ActiveRecord model that serves as the source of truth of the model
+      # of the model that we're annotating
+
+      def initialize(klass, options = {})
+        @klass = klass
+        @options = options
+      end
+
+      # Gets the columns of the ActiveRecord model, processes them, and then returns them.
+      def columns
+        @columns ||= begin
+                       cols = raw_columns
+                       cols += translated_columns
+
+                       ignore_columns = @options[:ignore_columns]
+                       if ignore_columns
+                         cols = cols.reject do |col|
+                           col.name.match(/#{ignore_columns}/)
+                         end
+                       end
+
+                       cols = cols.sort_by(&:name) if @options[:sort]
+                       cols = classified_sort(cols) if @options[:classified_sort]
+
+                       cols
+                     end
+      end
+
+      def connection
+        @klass.connection
+      end
+
+      # Returns the unmodified model columns
+      def raw_columns
+        @raw_columns ||= @klass.columns
+      end
+
+      def primary_key
+        @klass.primary_key
+      end
+
+      def table_exists?
+        @klass.table_exists?
+      end
+
+      def column_defaults
+        @klass.column_defaults
+      end
+
+      # Add columns managed by the globalize gem if this gem is being used.
+      # TODO: Audit if this is still needed, it seems like Globalize gem is no longer maintained
+      def translated_columns
+        return [] unless @klass.respond_to?(:translation_class)
+
+        ignored_cols = ignored_translation_table_columns
+
+        @klass.translation_class.columns.reject do |col|
+          ignored_cols.include? col.name.to_sym
+        end
+      end
+
+      def table_name
+        @klass.table_name
+      end
+
+      def model_name
+        @klass.name.underscore
+      end
+
+      # Calculates the max width of the schema for the model by looking at the columns, schema comments, with respect
+      # to the options.
+      def max_schema_info_width
+        cols = columns
+
+        if with_comments?
+          max_size = cols.map do |column|
+            column.name.size + (column.comment ? Helper.width(column.comment) : 0)
+          end.max || 0
+          max_size += 2
+        else
+          max_size = cols.map(&:name).map(&:size).max
+        end
+        max_size += @options[:format_rdoc] ? 5 : 1
+
+        max_size
+      end
+
+      def retrieve_indexes_from_table
+        table_name = @klass.table_name
+        return [] unless table_name
+
+        indexes = @klass.connection.indexes(table_name)
+        return indexes if indexes.any? || !@klass.table_name_prefix
+
+        # Try to search the table without prefix
+        table_name_without_prefix = table_name.to_s.sub(@klass.table_name_prefix, '')
+        @klass.connection.indexes(table_name_without_prefix)
+      end
+
+      def with_comments?
+        @options[:with_comment] &&
+          raw_columns.first.respond_to?(:comment) &&
+          raw_columns.map(&:comment).any? { |comment| !comment.nil? }
+      end
+
+      def classified_sort(cols)
+        rest_cols = []
+        timestamps = []
+        associations = []
+        id = nil
+
+        cols.each do |c|
+          if c.name.eql?('id')
+            id = c
+          elsif c.name.eql?('created_at') || c.name.eql?('updated_at')
+            timestamps << c
+          elsif c.name[-3, 3].eql?('_id')
+            associations << c
+          else
+            rest_cols << c
+          end
+        end
+        [rest_cols, timestamps, associations].each { |a| a.sort_by!(&:name) }
+
+        ([id] << rest_cols << timestamps << associations).flatten.compact
+      end
+
+      # These are the columns that the globalize gem needs to work but
+      # are not necessary for the models to be displayed as annotations.
+      def ignored_translation_table_columns
+        # Construct the foreign column name in the translations table
+        # eg. Model: Car, foreign column name: car_id
+        foreign_column_name = [
+          @klass.translation_class.to_s
+               .gsub('::Translation', '').gsub('::', '_')
+               .downcase,
+          '_id'
+        ].join.to_sym
+
+        [
+          :id,
+          :created_at,
+          :updated_at,
+          :locale,
+          foreign_column_name
+        ]
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/related_files_list_builder.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    # Given a model file and options, this class will return a list of related files (e.g. fixture, controllers, etc)
+    # to also annotate
+    class RelatedFilesListBuilder
+      RELATED_TYPES = %w(test fixture factory serializer scaffold controller helper).freeze
+
+      def initialize(file, model_name, table_name, options)
+        @file = file
+        @model_name = model_name
+        @table_name = table_name
+        @options = options
+      end
+
+      def build
+        @list = []
+
+        add_related_test_files if !@options[:exclude_tests]
+        add_related_fixture_files if !@options[:exclude_fixtures]
+        add_related_factory_files if !@options[:exclude_factories]
+        add_related_serializer_files if !@options[:exclude_serializers]
+        add_related_scaffold_files if !@options[:exclude_scaffolds]
+        add_related_controller_files if !@options[:exclude_controllers]
+        add_related_helper_files if !@options[:exclude_helpers]
+        add_related_admin_files if !@options[:active_admin]
+        add_additional_file_patterns if !@options[:additional_file_patterns].present?
+
+        @list
+      end
+
+      private
+
+      def related_files_for_pattern(pattern_type)
+        patterns = PatternGetter.call(@options, pattern_type)
+
+        _related_files = patterns
+                          .map { |f| FileNameResolver.call(f, @model_name, @table_name) }
+                          .map { |f| Dir.glob(f) }
+                          .flatten
+
+        _related_files
+      end
+
+      def add_related_test_files
+        position_key = :position_in_test
+        pattern_type = 'test'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_fixture_files
+        position_key = :position_in_fixture
+        pattern_type = 'fixture'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_factory_files
+        position_key = :position_in_factory
+        pattern_type = 'factory'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_serializer_files
+        position_key = :position_in_serializer
+        pattern_type = 'serializer'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_scaffold_files
+        position_key = :position_in_scaffold # Key does not exist
+        pattern_type = 'scaffold'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_controller_files
+        position_key = :position_in_controller # Key does not exist
+        pattern_type = 'controller'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_helper_files
+        position_key = :position_in_helper # Key does not exist
+        pattern_type = 'helper'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_admin_files
+        position_key = :position_in_admin # Key does not exist
+        pattern_type = 'admin'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_additional_file_patterns
+        position_key = :position_in_additional_file_patterns # Key does not exist
+        pattern_type = 'additional_file_patterns'
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator.rb

@@ -6,7 +6,6 @@ module AnnotateRb
     autoload :Helper, 'annotate_rb/model_annotator/helper'
     autoload :FilePatterns, 'annotate_rb/model_annotator/file_patterns'
     autoload :Constants, 'annotate_rb/model_annotator/constants'
-    autoload :SchemaInfo, 'annotate_rb/model_annotator/schema_info'
     autoload :PatternGetter, 'annotate_rb/model_annotator/pattern_getter'
     autoload :BadModelFileError, 'annotate_rb/model_annotator/bad_model_file_error'
     autoload :FileNameResolver, 'annotate_rb/model_annotator/file_name_resolver'
@@ -16,5 +15,16 @@ module AnnotateRb
     autoload :ModelFilesGetter, 'annotate_rb/model_annotator/model_files_getter'
     autoload :FileAnnotator, 'annotate_rb/model_annotator/file_annotator'
     autoload :ModelFileAnnotator, 'annotate_rb/model_annotator/model_file_annotator'
+    autoload :ModelWrapper, 'annotate_rb/model_annotator/model_wrapper'
+    autoload :AnnotationGenerator, 'annotate_rb/model_annotator/annotation_generator'
+    autoload :ColumnAttributesBuilder, 'annotate_rb/model_annotator/column_attributes_builder'
+    autoload :ColumnTypeBuilder, 'annotate_rb/model_annotator/column_type_builder'
+    autoload :ColumnWrapper, 'annotate_rb/model_annotator/column_wrapper'
+    autoload :ColumnAnnotationBuilder, 'annotate_rb/model_annotator/column_annotation_builder'
+    autoload :IndexAnnotationBuilder, 'annotate_rb/model_annotator/index_annotation_builder'
+    autoload :ForeignKeyAnnotationBuilder, 'annotate_rb/model_annotator/foreign_key_annotation_builder'
+    autoload :RelatedFilesListBuilder, 'annotate_rb/model_annotator/related_files_list_builder'
+    autoload :AnnotationDecider, 'annotate_rb/model_annotator/annotation_decider'
+    autoload :FileAnnotatorInstruction, 'annotate_rb/model_annotator/file_annotator_instruction'
   end
 end

data/lib/annotate_rb/options.rb

@@ -26,14 +26,14 @@ module AnnotateRb
 
     FLAG_OPTIONS = {
       classified_sort: true, # ModelAnnotator
-      exclude_controllers: true, # Unused
-      exclude_factories: false, # Unused
-      exclude_fixtures: false, # Unused
-      exclude_helpers: true, # Unused
-      exclude_scaffolds: true, # Unused
-      exclude_serializers: false, # Unused
+      exclude_controllers: true, # ModelAnnotator
+      exclude_factories: false, # ModelAnnotator
+      exclude_fixtures: false, # ModelAnnotator
+      exclude_helpers: true, # ModelAnnotator
+      exclude_scaffolds: true, # ModelAnnotator
+      exclude_serializers: false, # ModelAnnotator
       exclude_sti_subclasses: false, # ModelAnnotator
-      exclude_tests: false, # Unused
+      exclude_tests: false, # ModelAnnotator
       force: false, # ModelAnnotator, but should be used by both
       format_bare: true, # Unused
       format_markdown: false, # ModelAnnotator, RouteAnnotator
@@ -59,10 +59,10 @@ module AnnotateRb
       debug: false, # Core
 
       # ModelAnnotator
-      hide_default_column_types: '<%= ::AnnotateRb::ModelAnnotator::SchemaInfo::NO_DEFAULT_COL_TYPES.join(",") %>',
+      hide_default_column_types: '',
 
       # ModelAnnotator
-      hide_limit_column_types: '<%= ::AnnotateRb::ModelAnnotator::SchemaInfo::NO_LIMIT_COL_TYPES.join(",") %>',
+      hide_limit_column_types: '',
 
       ignore_columns: nil, # ModelAnnotator
       ignore_routes: nil, # RouteAnnotator
@@ -95,7 +95,14 @@ module AnnotateRb
 
     FLAG_OPTION_KEYS = [
       :classified_sort,
+      :exclude_controllers,
+      :exclude_factories,
+      :exclude_fixtures,
+      :exclude_helpers,
+      :exclude_scaffolds,
+      :exclude_serializers,
       :exclude_sti_subclasses,
+      :exclude_tests,
       :force,
       :format_markdown,
       :format_rdoc,

data/lib/annotate_rb/parser.rb

@@ -78,7 +78,7 @@ module AnnotateRb
         # TODO: Should raise or alert user that multiple commands were selected but only 1 command will be ran
         @options[:command] = map[@commands.first]
       else # None
-        @options[:command] = nil
+        @options[:command] = map[:help]
       end
     end
 
@@ -156,13 +156,6 @@ module AnnotateRb
       option_parser.separator(' ' * 4 + 'Usage: annotaterb models [options]')
       option_parser.separator('')
 
-      # option_parser.on('-m',
-      #                  '--models',
-      #                  "Annotate ActiveRecord models") do
-      #   @options[:models] = true
-      #   @options[:command] = Commands::AnnotateModels.new
-      # end
-
       option_parser.on('-a',
                        '--active-admin',
                        'Annotate active_admin models') do
@@ -232,13 +225,6 @@ module AnnotateRb
       option_parser.separator(' ' * 4 + 'Usage: annotaterb routes [options]')
       option_parser.separator('')
 
-      # option_parser.on('-r',
-      #                  '--routes',
-      #                  "Annotate routes.rb with the output of 'rails routes'") do
-      #   @options[:routes] = true
-      #   @options[:command] = Commands::AnnotateRoutes.new
-      # end
-
       option_parser.on('--ignore-routes REGEX',
                        "don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`") do |regex|
         @options[:ignore_routes] = regex

data/lib/annotate_rb.rb

@@ -18,7 +18,6 @@ require_relative 'annotate_rb/parser'
 require_relative 'annotate_rb/runner'
 require_relative 'annotate_rb/route_annotator'
 require_relative 'annotate_rb/model_annotator'
-require_relative 'annotate_rb/env'
 require_relative 'annotate_rb/options'
 require_relative 'annotate_rb/eager_loader'
 require_relative 'annotate_rb/rake_bootstrapper'

data/lib/generators/annotate_rb/install/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generates a default configuration file and adds a rake task into
+    your Rails app's lib/tasks directory, that automatically
+    annotates models when you do a db:migrate in development mode.
+
+Example:
+    `rails generate annotate_rb:install`

data/lib/generators/annotate_rb/install/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'annotate_rb'
+
+module AnnotateRb
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_task
+        copy_file "annotate_rb.rake", "lib/tasks/annotate_rb.rake"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -35,22 +35,31 @@ files:
 - lib/annotate_rb/config_loader.rb
 - lib/annotate_rb/core.rb
 - lib/annotate_rb/eager_loader.rb
-- lib/annotate_rb/env.rb
 - lib/annotate_rb/model_annotator.rb
+- lib/annotate_rb/model_annotator/annotation_decider.rb
+- lib/annotate_rb/model_annotator/annotation_generator.rb
 - lib/annotate_rb/model_annotator/annotation_pattern_generator.rb
 - lib/annotate_rb/model_annotator/annotator.rb
 - lib/annotate_rb/model_annotator/bad_model_file_error.rb
+- lib/annotate_rb/model_annotator/column_annotation_builder.rb
+- lib/annotate_rb/model_annotator/column_attributes_builder.rb
+- lib/annotate_rb/model_annotator/column_type_builder.rb
+- lib/annotate_rb/model_annotator/column_wrapper.rb
 - lib/annotate_rb/model_annotator/constants.rb
 - lib/annotate_rb/model_annotator/file_annotation_remover.rb
 - lib/annotate_rb/model_annotator/file_annotator.rb
+- lib/annotate_rb/model_annotator/file_annotator_instruction.rb
 - lib/annotate_rb/model_annotator/file_name_resolver.rb
 - lib/annotate_rb/model_annotator/file_patterns.rb
+- lib/annotate_rb/model_annotator/foreign_key_annotation_builder.rb
 - lib/annotate_rb/model_annotator/helper.rb
+- lib/annotate_rb/model_annotator/index_annotation_builder.rb
 - lib/annotate_rb/model_annotator/model_class_getter.rb
 - lib/annotate_rb/model_annotator/model_file_annotator.rb
 - lib/annotate_rb/model_annotator/model_files_getter.rb
+- lib/annotate_rb/model_annotator/model_wrapper.rb
 - lib/annotate_rb/model_annotator/pattern_getter.rb
-- lib/annotate_rb/model_annotator/schema_info.rb
+- lib/annotate_rb/model_annotator/related_files_list_builder.rb
 - lib/annotate_rb/options.rb
 - lib/annotate_rb/parser.rb
 - lib/annotate_rb/rake_bootstrapper.rb
@@ -63,9 +72,9 @@ files:
 - lib/annotate_rb/route_annotator/removal_processor.rb
 - lib/annotate_rb/runner.rb
 - lib/annotate_rb/tasks/annotate_models_migrate.rake
-- lib/generators/annotate_rb/USAGE
-- lib/generators/annotate_rb/install_generator.rb
-- lib/generators/annotate_rb/templates/auto_annotate_models.rake
+- lib/generators/annotate_rb/install/USAGE
+- lib/generators/annotate_rb/install/install_generator.rb
+- lib/generators/annotate_rb/install/templates/annotate_rb.rake
 homepage: https://github.com/drwl/annotaterb
 licenses:
 - BSD-2-Clause
@@ -85,9 +94,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.33
 signing_key:

data/lib/annotate_rb/env.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  class Env
-    class << self
-      def read(key)
-        key = key.to_s unless key.is_a?(String)
-
-        ENV[key]
-      end
-
-      def write(key, value)
-        key = key.to_s unless key.is_a?(String)
-
-        ENV[key] = value.to_s
-      end
-
-      def fetch(key, default_value)
-        key = key.to_s unless key.is_a?(String)
-        val = read(key)
-
-        if val.nil?
-          default_value
-        else
-          val
-        end
-      end
-    end
-  end
-end