annotated 0.0.1

data/lib/annotated.rb

@@ -0,0 +1,147 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "annotated/version"
+require "annotated/annotate_models"
+require "annotated/annotate_routes"
+require "annotated/constants"
+require "annotated/helpers"
+
+begin
+  # ActiveSupport 3.x...
+  require "active_support/hash_with_indifferent_access"
+  require "active_support/core_ext/object/blank"
+rescue
+  # ActiveSupport 2.x...
+  require "active_support/core_ext/hash/indifferent_access"
+  require "active_support/core_ext/blank"
+end
+
+module Annotated
+  ##
+  # 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] = Annotated::Helpers.fallback(ENV[key.to_s], ENV["position"], "before")
+    end
+    Constants::FLAG_OPTIONS.each do |key|
+      options[key] = Annotated::Helpers.true?(ENV[key.to_s])
+    end
+    Constants::OTHER_OPTIONS.each do |key|
+      options[key] = (!ENV[key.to_s].blank?) ? ENV[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] ||= []
+    options[:additional_file_patterns] = options[:additional_file_patterns].split(",") if options[:additional_file_patterns].is_a?(String)
+    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] = Annotated::Helpers.true?(ENV.fetch("exclude_scaffolds", "true"))
+    options[:exclude_controllers] = Annotated::Helpers.true?(ENV.fetch("exclude_controllers", "true"))
+    options[:exclude_helpers] = Annotated::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 "annotated/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").sort.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 => 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
+      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
+
+# Annotate = Annotated unless defined?(Annotate)

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,15 @@
+require "annotate"
+
+module Annotated
+  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,61 @@
+# 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.
+    Annotated.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
+
+  Annotated.load_tasks
+end

data/lib/tasks/annotate_models.rake

@@ -0,0 +1,72 @@
+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}/annotated/annotate_models"
+  require "#{annotate_lib}/annotated/active_record_patch"
+
+  options = {is_rake: true}
+  ENV["position"] = options[:position] = Annotated::Helpers.fallback(ENV["position"], "before")
+  options[:additional_file_patterns] = ENV["additional_file_patterns"] ? ENV["additional_file_patterns"].split(",") : []
+  options[:position_in_class] = Annotated::Helpers.fallback(ENV["position_in_class"], ENV["position"])
+  options[:position_in_fixture] = Annotated::Helpers.fallback(ENV["position_in_fixture"], ENV["position"])
+  options[:position_in_factory] = Annotated::Helpers.fallback(ENV["position_in_factory"], ENV["position"])
+  options[:position_in_test] = Annotated::Helpers.fallback(ENV["position_in_test"], ENV["position"])
+  options[:position_in_serializer] = Annotated::Helpers.fallback(ENV["position_in_serializer"], ENV["position"])
+  options[:show_check_constraints] = Annotated::Helpers.true?(ENV["show_check_constraints"])
+  options[:show_foreign_keys] = Annotated::Helpers.true?(ENV["show_foreign_keys"])
+  options[:show_complete_foreign_keys] = Annotated::Helpers.true?(ENV["show_complete_foreign_keys"])
+  options[:show_indexes] = Annotated::Helpers.true?(ENV["show_indexes"])
+  options[:simple_indexes] = Annotated::Helpers.true?(ENV["simple_indexes"])
+  options[:model_dir] = ENV["model_dir"] ? ENV["model_dir"].split(",") : ["app/models"]
+  options[:root_dir] = ENV["root_dir"]
+  options[:include_version] = Annotated::Helpers.true?(ENV["include_version"])
+  options[:require] = ENV["require"] ? ENV["require"].split(",") : []
+  options[:exclude_tests] = Annotated::Helpers.true?(ENV["exclude_tests"])
+  options[:exclude_factories] = Annotated::Helpers.true?(ENV["exclude_factories"])
+  options[:exclude_fixtures] = Annotated::Helpers.true?(ENV["exclude_fixtures"])
+  options[:exclude_serializers] = Annotated::Helpers.true?(ENV["exclude_serializers"])
+  options[:exclude_scaffolds] = Annotated::Helpers.true?(ENV["exclude_scaffolds"])
+  options[:exclude_controllers] = Annotated::Helpers.true?(ENV.fetch("exclude_controllers", "true"))
+  options[:exclude_helpers] = Annotated::Helpers.true?(ENV.fetch("exclude_helpers", "true"))
+  options[:exclude_sti_subclasses] = Annotated::Helpers.true?(ENV["exclude_sti_subclasses"])
+  options[:ignore_model_sub_dir] = Annotated::Helpers.true?(ENV["ignore_model_sub_dir"])
+  options[:format_bare] = Annotated::Helpers.true?(ENV["format_bare"])
+  options[:format_rdoc] = Annotated::Helpers.true?(ENV["format_rdoc"])
+  options[:format_yard] = Annotated::Helpers.true?(ENV["format_yard"])
+  options[:format_markdown] = Annotated::Helpers.true?(ENV["format_markdown"])
+  options[:sort] = Annotated::Helpers.true?(ENV["sort"])
+  options[:force] = Annotated::Helpers.true?(ENV["force"])
+  options[:frozen] = Annotated::Helpers.true?(ENV["frozen"])
+  options[:classified_sort] = Annotated::Helpers.true?(ENV["classified_sort"])
+  options[:trace] = Annotated::Helpers.true?(ENV["trace"])
+  options[:wrapper_open] = Annotated::Helpers.fallback(ENV["wrapper_open"], ENV["wrapper"])
+  options[:wrapper_close] = Annotated::Helpers.fallback(ENV["wrapper_close"], ENV["wrapper"])
+  options[:ignore_columns] = ENV.fetch("ignore_columns", nil)
+  options[:ignore_routes] = ENV.fetch("ignore_routes", nil)
+  options[:hide_limit_column_types] = Annotated::Helpers.fallback(ENV["hide_limit_column_types"], "")
+  options[:hide_default_column_types] = Annotated::Helpers.fallback(ENV["hide_default_column_types"], "")
+  options[:with_comment] = Annotated::Helpers.true?(ENV["with_comment"])
+  options[:with_comment_column] = Annotated::Helpers.true?(ENV["with_comment_column"])
+  options[:ignore_unknown_models] = Annotated::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}/annotated/annotate_models"
+  require "#{annotate_lib}/annotated/active_record_patch"
+
+  options = {is_rake: true}
+  options[:model_dir] = ENV["model_dir"]
+  options[:root_dir] = ENV["root_dir"]
+  options[:require] = ENV["require"] ? ENV["require"].split(",") : []
+  options[:trace] = Annotated::Helpers.true?(ENV["trace"])
+  AnnotateModels.remove_annotations(options)
+end

data/lib/tasks/annotate_models_migrate.rake

@@ -0,0 +1,63 @@
+# 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
+      Annotated::Migration.update_annotations
+    end
+  end
+end
+
+module Annotated
+  class Migration
+    @@working = false
+
+    def self.update_annotations
+      unless @@working || Annotated::Helpers.skip_on_migration?
+        @@working = true
+
+        update_models if Annotated::Helpers.include_models?
+        update_routes if Annotated::Helpers.include_routes?
+      end
+    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,31 @@
+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] = Annotated::Helpers.fallback(ENV["position"], "before")
+  options[:position_in_routes] = Annotated::Helpers.fallback(ENV["position_in_routes"], ENV["position"])
+  options[:ignore_routes] = Annotated::Helpers.fallback(ENV["ignore_routes"], nil)
+  options[:require] = ENV["require"] ? ENV["require"].split(",") : []
+  options[:frozen] = Annotated::Helpers.true?(ENV["frozen"])
+  options[:wrapper_open] = Annotated::Helpers.fallback(ENV["wrapper_open"], ENV["wrapper"])
+  options[:wrapper_close] = Annotated::Helpers.fallback(ENV["wrapper_close"], ENV["wrapper"])
+  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,101 @@
+--- !ruby/object:Gem::Specification
+name: annotated
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Froelich
+- Alex Chaffee
+- Cuong Tran
+- Marcos Piccinini
+- Turadg Aleahmad
+- Jon Frisby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
+  on the database schema.
+email:
+- sfroelich01@gmail.com
+- alex@stinky.com
+- cuong.tran@gmail.com
+- x@nofxx.com
+- turadg@aleahmad.net
+- jon@cloudability.com
+executables:
+- annotated
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS.md
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- RELEASE.md
+- annotated.gemspec
+- bin/annotated
+- lib/annotated.rb
+- lib/annotated/active_record_patch.rb
+- lib/annotated/annotate_models.rb
+- lib/annotated/annotate_models/file_patterns.rb
+- lib/annotated/annotate_routes.rb
+- lib/annotated/annotate_routes/header_generator.rb
+- lib/annotated/annotate_routes/helpers.rb
+- lib/annotated/constants.rb
+- lib/annotated/helpers.rb
+- lib/annotated/parser.rb
+- lib/annotated/tasks.rb
+- lib/annotated/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/thedumbtechguy/annotated
+licenses:
+- Ruby
+metadata:
+  homepage_uri: https://github.com/thedumbtechguy/annotated
+  bug_tracker_uri: https://github.com/thedumbtechguy/annotated/issues
+  documentation_uri: https://github.com/thedumbtechguy/annotated
+  source_code_uri: https://github.com/thedumbtechguy/annotated
+  changelog_uri: https://github.com/thedumbtechguy/annotated/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Annotates Rails Models, routes, fixtures, and others based on the database
+  schema.
+test_files: []