annot8 1.0.0

data/lib/annotate/tasks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'rake'
+
+# Make tasks visible for Rails also when used as gem.
+Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '**/*.rake')].each { |rake| load rake }
+Dir[File.join(File.dirname(__FILE__), '..', '..', 'tasks', '**/*.rake')].each { |rake| load rake }

data/lib/annotate/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Annotate
+  def self.version
+    '1.0.0'
+  end
+end

data/lib/annotate.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'annotate/version'
+require 'annotate/annotate_models'
+require 'annotate/annotate_routes'
+require 'annotate/constants'
+require 'annotate/helpers'
+
+begin
+  # ActiveSupport 3.x...
+  require 'active_support/hash_with_indifferent_access'
+  require 'active_support/core_ext/object/blank'
+rescue StandardError
+  # ActiveSupport 2.x...
+  require 'active_support/core_ext/hash/indifferent_access'
+  require 'active_support/core_ext/blank'
+end
+
+# Defines the Annotate module
+module Annotate # rubocop:disable Metrics/ModuleLength
+  ##
+  # Set default values that can be overridden via environment variables.
+  #
+  def self.set_defaults(options = {})
+    return if @has_set_defaults
+
+    @has_set_defaults = true
+
+    options = ActiveSupport::HashWithIndifferentAccess.new(options)
+
+    Constants::ALL_ANNOTATE_OPTIONS.flatten.each do |key|
+      if options.key?(key)
+        default_value = if options[key].is_a?(Array)
+                          options[key].join(',')
+                        else
+                          options[key]
+                        end
+      end
+
+      default_value = ENV[key.to_s] unless ENV[key.to_s].blank?
+      ENV[key.to_s] = default_value.nil? ? nil : default_value.to_s
+    end
+  end
+
+  ##
+  # TODO: what is the difference between this and set_defaults?
+  #
+  def self.setup_options(options = {})
+    Constants::POSITION_OPTIONS.each do |key|
+      options[key] = Annotate::Helpers.fallback(ENV.fetch(key.to_s, nil), ENV.fetch('position', nil), 'before')
+    end
+    Constants::FLAG_OPTIONS.each do |key|
+      options[key] = Annotate::Helpers.true?(ENV.fetch(key.to_s, nil))
+    end
+    Constants::OTHER_OPTIONS.each do |key|
+      options[key] = ENV[key.to_s].blank? ? nil : ENV.fetch(key.to_s, nil)
+    end
+    Constants::PATH_OPTIONS.each do |key|
+      options[key] = ENV[key.to_s].blank? ? [] : ENV[key.to_s].split(',')
+    end
+
+    options[:additional_file_patterns] ||= []
+    if options[:additional_file_patterns].is_a?(String)
+      options[:additional_file_patterns] =
+        options[:additional_file_patterns].split(',')
+    end
+    options[:model_dir] = ['app/models'] if options[:model_dir].empty?
+
+    options[:wrapper_open] ||= options[:wrapper]
+    options[:wrapper_close] ||= options[:wrapper]
+
+    # These were added in 2.7.0 but so this is to revert to old behavior by default
+    options[:exclude_scaffolds] = Annotate::Helpers.true?(ENV.fetch('exclude_scaffolds', 'true'))
+    options[:exclude_controllers] = Annotate::Helpers.true?(ENV.fetch('exclude_controllers', 'true'))
+    options[:exclude_helpers] = Annotate::Helpers.true?(ENV.fetch('exclude_helpers', 'true'))
+
+    options
+  end
+
+  def self.load_tasks
+    return if @tasks_loaded
+
+    Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
+      load rake
+    end
+
+    @tasks_loaded = true
+  end
+
+  def self.eager_load(options)
+    load_requires(options)
+    require 'annotate/active_record_patch'
+
+    if defined?(Rails::Application)
+      if Rails.version.split('.').first.to_i < 3
+        Rails.configuration.eager_load_paths.each do |load_path|
+          matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
+          Dir.glob("#{load_path}/**/*.rb").each do |file|
+            require_dependency file.sub(matcher, '\1')
+          end
+        end
+      else
+        klass = Rails::Application.send(:subclasses).first
+        klass.eager_load!
+      end
+    else
+      options[:model_dir].each do |dir|
+        FileList["#{dir}/**/*.rb"].each do |fname|
+          require File.expand_path(fname)
+        end
+      end
+    end
+  end
+
+  def self.bootstrap_rake
+    begin
+      require 'rake/dsl_definition'
+    rescue StandardError => e
+      # We might just be on an old version of Rake...
+      warn e.message
+      exit e.status_code
+    end
+    require 'rake'
+
+    load './Rakefile' if File.exist?('./Rakefile')
+    begin
+      Rake::Task[:environment].invoke
+    rescue StandardError
+      nil
+    end
+    unless defined?(Rails)
+      # Not in a Rails project, so time to load up the parts of
+      # ActiveSupport we need.
+      require 'active_support'
+      require 'active_support/core_ext/class/subclasses'
+      require 'active_support/core_ext/string/inflections'
+    end
+
+    load_tasks
+    Rake::Task[:set_annotation_options].invoke
+  end
+
+  class << self
+    private
+
+    def load_requires(options)
+      options[:require].count > 0 &&
+        options[:require].each { |path| require path }
+    end
+  end
+end

data/lib/generators/annotate/USAGE

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

data/lib/generators/annotate/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'annotate'
+
+module Annotate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy annotate_models rakefiles for automatic annotation'
+      source_root File.expand_path('templates', __dir__)
+
+      # copy rake tasks
+      def copy_tasks
+        template 'auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+  require 'annotate'
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin' => 'false',
+      'additional_file_patterns' => [],
+      'routes' => 'false',
+      'models' => 'true',
+      'position_in_routes' => 'before',
+      'position_in_class' => 'before',
+      'position_in_test' => 'before',
+      'position_in_fixture' => 'before',
+      'position_in_factory' => 'before',
+      'position_in_serializer' => 'before',
+      'show_check_constraints' => 'false',
+      'show_foreign_keys' => 'true',
+      'show_complete_foreign_keys' => 'false',
+      'show_indexes' => 'true',
+      'simple_indexes' => 'false',
+      'model_dir' => 'app/models',
+      'root_dir' => '',
+      'include_version' => 'false',
+      'require' => '',
+      'exclude_tests' => 'false',
+      'exclude_fixtures' => 'false',
+      'exclude_factories' => 'false',
+      'exclude_serializers' => 'false',
+      'exclude_scaffolds' => 'true',
+      'exclude_controllers' => 'true',
+      'exclude_helpers' => 'true',
+      'exclude_sti_subclasses' => 'false',
+      'ignore_model_sub_dir' => 'false',
+      'ignore_columns' => nil,
+      'ignore_routes' => nil,
+      'ignore_unknown_models' => 'false',
+      'hide_limit_column_types' => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(",") %>',
+      'hide_default_column_types' => '<%= AnnotateModels::NO_DEFAULT_COL_TYPES.join(",") %>',
+      'skip_on_db_migrate' => 'false',
+      'format_bare' => 'true',
+      'format_rdoc' => 'false',
+      'format_yard' => 'false',
+      'format_markdown' => 'false',
+      'sort' => 'false',
+      'force' => 'false',
+      'frozen' => 'false',
+      'classified_sort' => 'true',
+      'trace' => 'false',
+      'wrapper_open' => nil,
+      'wrapper_close' => nil,
+      'with_comment' => 'true',
+      'with_comment_column' => 'false'
+    )
+  end
+
+  Annotate.load_tasks
+end

data/lib/tasks/annotate_models.rake

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+annotate_lib = File.expand_path(File.dirname(__FILE__, 2))
+
+unless ENV['is_cli']
+  task :set_annotation_options
+  task annotate_models: :set_annotation_options
+end
+
+desc 'Add schema information (as comments) to model and fixture files'
+task annotate_models: :environment do
+  require "#{annotate_lib}/annotate/annotate_models"
+  require "#{annotate_lib}/annotate/active_record_patch"
+
+  options = { is_rake: true }
+  ENV['position'] = options[:position] = Annotate::Helpers.fallback(ENV.fetch('position', nil), 'before')
+  options[:additional_file_patterns] = ENV['additional_file_patterns'] ? ENV['additional_file_patterns'].split(',') : []
+  options[:position_in_class] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_class', nil), ENV.fetch('position', nil))
+  options[:position_in_fixture] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_fixture', nil), ENV.fetch('position', nil))
+  options[:position_in_factory] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_factory', nil), ENV.fetch('position', nil))
+  options[:position_in_test] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_test', nil), ENV.fetch('position', nil))
+  options[:position_in_serializer] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_serializer', nil), ENV.fetch('position', nil))
+  options[:show_check_constraints] = Annotate::Helpers.true?(ENV.fetch('show_check_constraints', nil))
+  options[:show_foreign_keys] = Annotate::Helpers.true?(ENV.fetch('show_foreign_keys', nil))
+  options[:show_complete_foreign_keys] = Annotate::Helpers.true?(ENV.fetch('show_complete_foreign_keys', nil))
+  options[:show_indexes] = Annotate::Helpers.true?(ENV.fetch('show_indexes', nil))
+  options[:simple_indexes] = Annotate::Helpers.true?(ENV.fetch('simple_indexes', nil))
+  options[:model_dir] = ENV['model_dir'] ? ENV['model_dir'].split(',') : ['app/models']
+  options[:root_dir] = ENV.fetch('root_dir', nil)
+  options[:include_version] = Annotate::Helpers.true?(ENV.fetch('include_version', nil))
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:exclude_tests] = Annotate::Helpers.true?(ENV.fetch('exclude_tests', nil))
+  options[:exclude_factories] = Annotate::Helpers.true?(ENV.fetch('exclude_factories', nil))
+  options[:exclude_fixtures] = Annotate::Helpers.true?(ENV.fetch('exclude_fixtures', nil))
+  options[:exclude_serializers] = Annotate::Helpers.true?(ENV.fetch('exclude_serializers', nil))
+  options[:exclude_scaffolds] = Annotate::Helpers.true?(ENV.fetch('exclude_scaffolds', nil))
+  options[:exclude_controllers] = Annotate::Helpers.true?(ENV.fetch('exclude_controllers', 'true'))
+  options[:exclude_helpers] = Annotate::Helpers.true?(ENV.fetch('exclude_helpers', 'true'))
+  options[:exclude_sti_subclasses] = Annotate::Helpers.true?(ENV.fetch('exclude_sti_subclasses', nil))
+  options[:ignore_model_sub_dir] = Annotate::Helpers.true?(ENV.fetch('ignore_model_sub_dir', nil))
+  options[:format_bare] = Annotate::Helpers.true?(ENV.fetch('format_bare', nil))
+  options[:format_rdoc] = Annotate::Helpers.true?(ENV.fetch('format_rdoc', nil))
+  options[:format_yard] = Annotate::Helpers.true?(ENV.fetch('format_yard', nil))
+  options[:format_markdown] = Annotate::Helpers.true?(ENV.fetch('format_markdown', nil))
+  options[:sort] = Annotate::Helpers.true?(ENV.fetch('sort', nil))
+  options[:force] = Annotate::Helpers.true?(ENV.fetch('force', nil))
+  options[:frozen] = Annotate::Helpers.true?(ENV.fetch('frozen', nil))
+  options[:classified_sort] = Annotate::Helpers.true?(ENV.fetch('classified_sort', nil))
+  options[:trace] = Annotate::Helpers.true?(ENV.fetch('trace', nil))
+  options[:wrapper_open] = Annotate::Helpers.fallback(ENV.fetch('wrapper_open', nil), ENV.fetch('wrapper', nil))
+  options[:wrapper_close] = Annotate::Helpers.fallback(ENV.fetch('wrapper_close', nil), ENV.fetch('wrapper', nil))
+  options[:ignore_columns] = ENV.fetch('ignore_columns', nil)
+  options[:ignore_routes] = ENV.fetch('ignore_routes', nil)
+  options[:hide_limit_column_types] = Annotate::Helpers.fallback(ENV.fetch('hide_limit_column_types', nil), '')
+  options[:hide_default_column_types] = Annotate::Helpers.fallback(ENV.fetch('hide_default_column_types', nil), '')
+  options[:with_comment] = Annotate::Helpers.true?(ENV.fetch('with_comment', nil))
+  options[:with_comment_column] = Annotate::Helpers.true?(ENV.fetch('with_comment_column', nil))
+  options[:ignore_unknown_models] = Annotate::Helpers.true?(ENV.fetch('ignore_unknown_models', 'false'))
+
+  AnnotateModels.do_annotations(options)
+end
+
+desc 'Remove schema information from model and fixture files'
+task remove_annotation: :environment do
+  require "#{annotate_lib}/annotate/annotate_models"
+  require "#{annotate_lib}/annotate/active_record_patch"
+
+  options = { is_rake: true }
+  options[:model_dir] = ENV.fetch('model_dir', nil)
+  options[:root_dir] = ENV.fetch('root_dir', nil)
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:trace] = Annotate::Helpers.true?(ENV.fetch('trace', nil))
+  AnnotateModels.remove_annotations(options)
+end

data/lib/tasks/annotate_models_migrate.rake

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# 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 = %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
+
+  ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |spec_name|
+    migration_tasks.concat(%w[db:migrate db:migrate:up db:migrate:down].map { |task| "#{task}:#{spec_name}" })
+  end
+end
+
+migration_tasks.each do |task|
+  next unless Rake::Task.task_defined?(task)
+
+  Rake::Task[task].enhance do
+    Rake::Task[Rake.application.top_level_tasks.last].enhance do
+      annotation_options_task = if Rake::Task.task_defined?('app:set_annotation_options')
+                                  'app:set_annotation_options'
+                                else
+                                  'set_annotation_options'
+                                end
+      Rake::Task[annotation_options_task].invoke
+      Annotate::Migration.update_annotations
+    end
+  end
+end
+
+module Annotate
+  class Migration
+    @@working = false
+
+    def self.update_annotations
+      return if @@working || Annotate::Helpers.skip_on_migration?
+
+      @@working = true
+
+      update_models if Annotate::Helpers.include_models?
+      update_routes if Annotate::Helpers.include_routes?
+    end
+
+    def self.update_models
+      if Rake::Task.task_defined?('annotate_models')
+        Rake::Task['annotate_models'].invoke
+      elsif Rake::Task.task_defined?('app:annotate_models')
+        Rake::Task['app:annotate_models'].invoke
+      end
+    end
+
+    def self.update_routes
+      if Rake::Task.task_defined?('annotate_routes')
+        Rake::Task['annotate_routes'].invoke
+      elsif Rake::Task.task_defined?('app:annotate_routes')
+        Rake::Task['app:annotate_routes'].invoke
+      end
+    end
+  end
+end

data/lib/tasks/annotate_routes.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+annotate_lib = File.expand_path(File.dirname(__FILE__, 2))
+
+unless ENV['is_cli']
+  task :set_annotation_options
+  task annotate_routes: :set_annotation_options
+end
+
+desc 'Adds the route map to routes.rb'
+task annotate_routes: :environment do
+  require "#{annotate_lib}/annotate/annotate_routes"
+
+  options = {}
+  ENV['position'] = options[:position] = Annotate::Helpers.fallback(ENV.fetch('position', nil), 'before')
+  options[:position_in_routes] =
+    Annotate::Helpers.fallback(ENV.fetch('position_in_routes', nil), ENV.fetch('position', nil))
+  options[:ignore_routes] = Annotate::Helpers.fallback(ENV.fetch('ignore_routes', nil), nil)
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:frozen] = Annotate::Helpers.true?(ENV.fetch('frozen', nil))
+  options[:wrapper_open] = Annotate::Helpers.fallback(ENV.fetch('wrapper_open', nil), ENV.fetch('wrapper', nil))
+  options[:wrapper_close] = Annotate::Helpers.fallback(ENV.fetch('wrapper_close', nil), ENV.fetch('wrapper', nil))
+  AnnotateRoutes.do_annotations(options)
+end
+
+desc 'Removes the route map from routes.rb'
+task remove_routes: :environment do
+  annotate_lib = File.expand_path(File.dirname(__FILE__, 2))
+  require "#{annotate_lib}/annotate/annotate_routes"
+
+  options = {}
+  options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  AnnotateRoutes.remove_annotations(options)
+end

data/potato.md

@@ -0,0 +1,41 @@
+Colons can be used to align columns.
+
+| Tables        | Are           | Cool  |
+| ------------- |:-------------:| -----:|
+| col 3 is      | right-aligned | $1600 |
+| col 2 is      | centered      |   $12 |
+| zebra stripes | are neat      |    $1 |
+
+There must be at least 3 dashes separating each header cell.
+The outer pipes (|) are optional, and you don't need to make the
+raw Markdown line up prettily. You can also use inline Markdown.
+
+Markdown | Less | Pretty
+--- | --- | ---
+*Still* | `renders` | **nicely**
+1 | 2 | 3
+
+
+ ## Route Map
+
+  Prefix    | Verb       | URI Pattern     | Controller#Action    
+  --------- | ---------- | --------------- | --------------------
+  myaction1 | GET        | /url1(.:format) | mycontroller1#action
+  myaction2 | POST       | /url2(.:format) | mycontroller2#action
+  myaction3 | DELETE-GET | /url3(.:format) | mycontroller3#action \n")
+
+
+
+ Table name: `users`
+
+ ### Columns
+
+ Name                    | Type               | Attributes
+ ----------------------- | ------------------ | ---------------------------
+ **`id`**                | `integer`          | `not null, primary key`
+ **`foreign_thing_id`**  | `integer`          | `not null`
+
+ ### Foreign Keys
+
+ * `fk_rails_...` (_ON DELETE => on_delete_value ON UPDATE => on_update_value_):
+     * **`foreign_thing_id => foreign_things.id`**

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: annot8
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Chaffee
+- Cuong Tran
+- Marcos Piccinini
+- Turadg Aleahmad
+- Jon Frisby
+- Benjamin Dunkley
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
+  on the database schema. This fork of the "annotate" gemis built for Rails 8 and
+  Ruby 3.2.2+
+email:
+- ben@chemica.co.uk
+executables:
+- annotate
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- README.md
+files:
+- AUTHORS.md
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- RELEASE.md
+- annot8.gemspec
+- bin/annotate
+- lib/annotate.rb
+- lib/annotate/active_record_patch.rb
+- lib/annotate/annotate_models.rb
+- lib/annotate/annotate_models/file_patterns.rb
+- lib/annotate/annotate_routes.rb
+- lib/annotate/annotate_routes/header_generator.rb
+- lib/annotate/annotate_routes/helpers.rb
+- lib/annotate/constants.rb
+- lib/annotate/helpers.rb
+- lib/annotate/parser.rb
+- lib/annotate/tasks.rb
+- lib/annotate/version.rb
+- lib/generators/annotate/USAGE
+- lib/generators/annotate/install_generator.rb
+- lib/generators/annotate/templates/auto_annotate_models.rake
+- lib/tasks/annotate_models.rake
+- lib/tasks/annotate_models_migrate.rake
+- lib/tasks/annotate_routes.rake
+- potato.md
+homepage: https://github.com/chemica/annotate_models
+licenses:
+- Ruby
+metadata:
+  bug_tracker_uri: https://github.com/chemica/annotate_models/issues/
+  source_code_uri: https://github.com/chemica/annotate_models.git
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Annotates Rails Models, routes, fixtures, and others based on the database
+  schema.
+test_files: []