annotaterb 4.0.0.beta.1

data/lib/annotate_rb/route_annotator/header_generator.rb

@@ -0,0 +1,113 @@
+module AnnotateRb
+  module RouteAnnotator
+    class HeaderGenerator
+      PREFIX = '== Route Map'.freeze
+      PREFIX_MD = '## Route Map'.freeze
+      HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
+
+      class << self
+        def generate(options = {})
+          new(options, routes_map(options)).generate
+        end
+
+        private :new
+
+        private
+
+        def routes_map(options)
+          result = `rails routes`.chomp("\n").split(/\n/, -1)
+
+          # In old versions of Rake, the first line of output was the cwd.  Not so
+          # much in newer ones.  We ditch that line if it exists, and if not, we
+          # keep the line around.
+          result.shift if result.first =~ %r{^\(in \/}
+
+          ignore_routes = options[:ignore_routes]
+          regexp_for_ignoring_routes = ignore_routes ? /#{ignore_routes}/ : nil
+
+          # Skip routes which match given regex
+          # Note: it matches the complete line (route_name, path, controller/action)
+          if regexp_for_ignoring_routes
+            result.reject { |line| line =~ regexp_for_ignoring_routes }
+          else
+            result
+          end
+        end
+      end
+
+      def initialize(options, routes_map)
+        @options = options
+        @routes_map = routes_map
+      end
+
+      def generate
+        magic_comments_map, contents_without_magic_comments = Helper.extract_magic_comments_from_array(routes_map)
+
+        out = []
+
+        magic_comments_map.each do |magic_comment|
+          out << magic_comment
+        end
+        out << '' if magic_comments_map.any?
+
+        out << comment(options[:wrapper_open]) if options[:wrapper_open]
+
+        out << comment(markdown? ? PREFIX_MD : PREFIX) + timestamp_if_required
+        out << comment
+        return out if contents_without_magic_comments.size.zero?
+
+        maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..-1].map { |line| line.split.map(&:size) }
+
+        if markdown?
+          max = maxs.map(&:max).compact.max
+
+          out << comment(content(HEADER_ROW, maxs))
+          out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs))
+        else
+          out << comment(content(contents_without_magic_comments[0], maxs))
+        end
+
+        out += contents_without_magic_comments[1..-1].map { |line| comment(content(markdown? ? line.split(' ') : line, maxs)) }
+        out << comment(options[:wrapper_close]) if options[:wrapper_close]
+
+        out
+      end
+
+      private
+
+      attr_reader :options, :routes_map
+
+      def comment(row = '')
+        if row == ''
+          '#'
+        else
+          "# #{row}"
+        end
+      end
+
+      def content(line, maxs)
+        return line.rstrip unless markdown?
+
+        line.each_with_index.map { |elem, index| format_line_element(elem, maxs, index) }.join(' | ')
+      end
+
+      def format_line_element(elem, maxs, index)
+        min_length = maxs.map { |arr| arr[index] }.max || 0
+        format("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
+      end
+
+      def markdown?
+        options[:format_markdown]
+      end
+
+      def timestamp_if_required(time = Time.now)
+        if options[:timestamp]
+          time_formatted = time.strftime('%Y-%m-%d %H:%M')
+          " (Updated #{time_formatted})"
+        else
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/route_annotator/helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module RouteAnnotator
+    module Helper
+      MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+
+      class << self
+        def routes_file_exist?
+          File.exist?(routes_file)
+        end
+
+        def routes_file
+          @routes_rb ||= File.join('config', 'routes.rb')
+        end
+
+        def strip_on_removal(content, header_position)
+          if header_position == :before
+            content.shift while content.first == ''
+          elsif header_position == :after
+            content.pop while content.last == ''
+          end
+
+          # Make sure we end on a trailing newline.
+          content << '' unless content.last == ''
+
+          # TODO: If the user buried it in the middle, we should probably see about
+          # TODO: preserving a single line of space between the content above and
+          # TODO: below...
+          content
+        end
+
+        def rewrite_contents(existing_text, new_text)
+          if existing_text == new_text
+            false
+          else
+            File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+            true
+          end
+        end
+
+        # @param [Array<String>] content
+        # @return [Array<String>] all found magic comments
+        # @return [Array<String>] content without magic comments
+        def extract_magic_comments_from_array(content_array)
+          magic_comments = []
+          new_content = []
+
+          content_array.each do |row|
+            if row =~ MAGIC_COMMENT_MATCHER
+              magic_comments << row.strip
+            else
+              new_content << row
+            end
+          end
+
+          [magic_comments, new_content]
+        end
+
+        # TODO: write the method doc using ruby rdoc formats
+        # This method returns an array of 'real_content' and 'header_position'.
+        # 'header_position' will either be :before, :after, or
+        # a number.  If the number is > 0, the
+        # annotation was found somewhere in the
+        # middle of the file.  If the number is
+        # zero, no annotation was found.
+        def strip_annotations(content)
+          real_content = []
+          mode = :content
+          header_position = 0
+
+          content.split(/\n/, -1).each_with_index do |line, line_number|
+            if mode == :header && line !~ /\s*#/
+              mode = :content
+              real_content << line unless line.blank?
+            elsif mode == :content
+              if line =~ /^\s*#\s*== Route.*$/
+                header_position = line_number + 1 # index start's at 0
+                mode = :header
+              else
+                real_content << line
+              end
+            end
+          end
+
+          real_content_and_header_position(real_content, header_position)
+        end
+
+        def real_content_and_header_position(real_content, header_position)
+          # By default assume the annotation was found in the middle of the file
+
+          # ... unless we have evidence it was at the beginning ...
+          return real_content, :before if header_position == 1
+
+          # ... or that it was at the end.
+          return real_content, :after if header_position >= real_content.count
+
+          # and the default
+          return real_content, header_position
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/route_annotator/removal_processor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This module provides methods for annotating config/routes.rb.
+module AnnotateRb
+  module RouteAnnotator
+    # This class is abstract class of classes adding and removing annotation to config/routes.rb.
+    class RemovalProcessor < BaseProcessor
+      # @return [String]
+      def execute
+        if routes_file_exist?
+          if update
+            "Annotations were removed from #{routes_file}."
+          else
+            "#{routes_file} was not changed (Annotation did not exist)."
+          end
+        else
+          "#{routes_file} could not be found."
+        end
+      end
+
+      private
+
+      def generate_new_content_array(content, header_position)
+        if header_position == :before
+          content.shift while content.first == ''
+        elsif header_position == :after
+          content.pop while content.last == ''
+        end
+
+        # Make sure we end on a trailing newline.
+        content << '' unless content.last == ''
+
+        # TODO: If the user buried it in the middle, we should probably see about
+        # TODO: preserving a single line of space between the content above and
+        # TODO: below...
+        content
+      end
+    end
+  end
+end

data/lib/annotate_rb/route_annotator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module RouteAnnotator
+    autoload :Annotator, 'annotate_rb/route_annotator/annotator'
+    autoload :Helper, 'annotate_rb/route_annotator/helper'
+    autoload :HeaderGenerator, 'annotate_rb/route_annotator/header_generator'
+    autoload :BaseProcessor, 'annotate_rb/route_annotator/base_processor'
+    autoload :AnnotationProcessor, 'annotate_rb/route_annotator/annotation_processor'
+    autoload :RemovalProcessor, 'annotate_rb/route_annotator/removal_processor'
+  end
+end

data/lib/annotate_rb/runner.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  class Runner
+    class << self
+      def run(args)
+        new.run(args)
+      end
+    end
+
+    def initialize
+
+    end
+
+    def run(args)
+      _original_args = args.dup
+
+      config_file_options = ConfigLoader.load_config
+      parsed_options = Parser.parse(args)
+
+      options = config_file_options.merge(parsed_options)
+
+      @options = Options.from(options, {})
+      AnnotateRb::RakeBootstrapper.call(@options)
+
+      if @options[:command]
+        @options[:command].call(@options)
+      else
+        # TODO
+        raise "Didn't specify a command"
+      end
+    end
+  end
+end

data/lib/annotate_rb/tasks/annotate_models_migrate.rake

@@ -0,0 +1,30 @@
+# These tasks are added to the project if you install annotate as a Rails plugin.
+# (They are not used to build annotate itself.)
+
+# Append annotations to Rake tasks for ActiveRecord, so annotate automatically gets
+# run after doing db:migrate.
+
+# Migration tasks are tasks that we'll "hook" into
+migration_tasks = %w(db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback)
+if defined?(Rails::Application) && Rails.version.split('.').first.to_i >= 6
+  require 'active_record'
+
+  databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
+
+  # If there's multiple databases, this appends database specific rake tasks to `migration_tasks`
+  ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |database_name|
+    migration_tasks.concat(%w(db:migrate db:migrate:up db:migrate:down).map { |task| "#{task}:#{database_name}" })
+  end
+end
+
+migration_tasks.each do |task|
+  next unless Rake::Task.task_defined?(task)
+
+  Rake::Task[task].enhance do # This block is ran after `task` completes
+    task_name = Rake.application.top_level_tasks.last # The name of the task that was run, e.g. "db:migrate"
+
+    Rake::Task[task_name].enhance do
+      ::AnnotateRb::Runner.run(['models'])
+    end
+  end
+end

data/lib/annotate_rb.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+# Helper.fallback depends on this being required because it adds #present? to nil
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/class/subclasses'
+require 'active_support/core_ext/string/inflections'
+
+require 'rake'
+
+require 'annotate_rb/active_record_patch'
+
+require_relative 'annotate_rb/core'
+require_relative 'annotate_rb/commands'
+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'
+require_relative 'annotate_rb/config_finder'
+require_relative 'annotate_rb/config_loader'
+
+module AnnotateRb
+
+end

data/lib/generators/annotate_rb/USAGE

@@ -0,0 +1,4 @@
+Add a .rake file that automatically annotates models when you do a db:migrate
+in development mode:
+
+    rails generate annotaterb:install

data/lib/generators/annotate_rb/install_generator.rb

@@ -0,0 +1,15 @@
+require 'annotate_rb'
+
+module AnnotateRb
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy annotaterb rakefiles for automatic annotation of models'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_tasks
+        # Copies the rake task into Rails project's lib/tasks directory
+        template 'auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake'
+      end
+    end
+  end
+end

data/lib/generators/annotate_rb/templates/auto_annotate_models.rake

@@ -0,0 +1,7 @@
+# This rake task was added by annotate_rb gem.
+
+if Rails.env.development?
+  require 'annotate_rb'
+
+  AnnotateRb::Core.load_rake_tasks
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: annotaterb
+version: !ruby/object:Gem::Version
+  version: 4.0.0.beta.1
+platform: ruby
+authors:
+- Andrew W. Lee
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-26 00:00:00.000000000 Z
+dependencies: []
+description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
+  on the database schema.
+email:
+- git@drewlee.com
+executables:
+- annotaterb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- VERSION
+- exe/annotaterb
+- lib/annotate_rb.rb
+- lib/annotate_rb/active_record_patch.rb
+- lib/annotate_rb/commands.rb
+- lib/annotate_rb/commands/annotate_models.rb
+- lib/annotate_rb/commands/annotate_routes.rb
+- lib/annotate_rb/commands/print_help.rb
+- lib/annotate_rb/commands/print_version.rb
+- lib/annotate_rb/config_finder.rb
+- 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_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/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_name_resolver.rb
+- lib/annotate_rb/model_annotator/file_patterns.rb
+- lib/annotate_rb/model_annotator/helper.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/pattern_getter.rb
+- lib/annotate_rb/model_annotator/schema_info.rb
+- lib/annotate_rb/options.rb
+- lib/annotate_rb/parser.rb
+- lib/annotate_rb/rake_bootstrapper.rb
+- lib/annotate_rb/route_annotator.rb
+- lib/annotate_rb/route_annotator/annotation_processor.rb
+- lib/annotate_rb/route_annotator/annotator.rb
+- lib/annotate_rb/route_annotator/base_processor.rb
+- lib/annotate_rb/route_annotator/header_generator.rb
+- lib/annotate_rb/route_annotator/helper.rb
+- 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
+homepage: https://github.com/drwl/annotaterb
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/drwl/annotaterb
+  source_code_uri: https://github.com/drwl/annotaterb
+  changelog_uri: https://github.com/drwl/annotaterb/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/drwl/annotaterb/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: A gem for generating annotations for Rails projects.
+test_files: []