More work (#6)

Author: drwl

Gemfile

@@ -2,22 +2,13 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activerecord', require: false
-gem 'rake', require: false
-
-group :development do
-  platforms :mri, :mingw do
-    gem 'yard', require: false
-  end
-end
+gem 'rake'
+gem 'rspec'
 
 group :development, :test do
   gem 'byebug'
   gem 'guard-rspec', require: false
-  gem 'rspec', require: false
 
-  gem 'rubocop', '~> 1.12.0', require: false
-  gem 'rubocop-rake', require: false
-  gem 'rubocop-rspec', '~> 2.2.0', require: false
   gem 'terminal-notifier-guard', require: false
 
   gem 'overcommit'
@@ -29,6 +20,6 @@ group :development, :test do
 end
 
 group :test do
-  gem 'files', require: false
+  gem 'files', require: false, path: "vendor/files"
   gem 'git', require: false
 end

annotaterb.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "https://github.com/drwl/annotaterb/blob/master/CHANGELOG.md"
   spec.metadata["bug_tracker_uri"] = "https://github.com/drwl/annotaterb/issues"
 
-  spec.files         = Dir["VERSION", "CHANGELOG.md", "LICENSE.txt", "README.md", "lib/**/*", "bin/**/*"]
+  spec.files         = Dir["VERSION", "CHANGELOG.md", "LICENSE.txt", "README.md", "lib/**/*"]
   spec.bindir        = "exe"
   spec.executables   = Dir["exe/*"].map { |exe| File.basename(exe) }
   spec.require_paths = ["lib"]

bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "annotate_rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

bin/annotate renamed to exe/annotate

@@ -19,14 +19,25 @@ require 'annotate/parser'
 
 Annotate.bootstrap_rake
 
+# Annotate::Parser.parse takes in ARGV
+# - Parses it and writes stuff to ENV
+# - Returns some in a hash as seen below, this script will exit if `:exit` is defined
 options_result = Annotate::Parser.parse(ARGV)
 
 exit if options_result[:exit]
 
+# Not sure what this does yet
 options = Annotate.setup_options(
+  # .setup_options takes in starting options. It looks like :is_rake is used later down the road so we want to capture
+  # if it was done via rake task or not.
+  #
+  # Looks like it's set in lib/tasks/annotate*.rake files
   is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?
 )
+
+# Eager load Models when we're annotating models
 Annotate.eager_load(options) if Annotate::Helpers.include_models?
 
+# options_result[:target_action] has possible values of: [:do_annotations, :remove_annotations]
 AnnotateModels.send(options_result[:target_action], options) if Annotate::Helpers.include_models?
 AnnotateRoutes.send(options_result[:target_action], options) if Annotate::Helpers.include_routes?

exe/annotaterb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'annotate_rb'
+
+cli = AnnotateRb::CLI.new
+exit_status = cli.run
+
+exit exit_status

lib/annotate.rb

@@ -71,9 +71,15 @@ def self.setup_options(options = {})
     options
   end
 
+  # Can be used by consumers, per README:
+  #
+  # To automatically annotate every time you run `db:migrate`,
+  # either run `rails g annotate:install`
+  # or add `Annotate.load_tasks` to your `Rakefile`.
   def self.load_tasks
     return if @tasks_loaded
 
+    # Loads rake tasks, not sure why yet
     Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
       load rake
     end
@@ -86,17 +92,8 @@ def self.eager_load(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").sort.each do |file|
-            require_dependency file.sub(matcher, '\1')
-          end
-        end
-      else
-        klass = Rails::Application.send(:subclasses).first
-        klass.eager_load!
-      end
+      klass = Rails::Application.send(:subclasses).first
+      klass.eager_load!
     else
       options[:model_dir].each do |dir|
         FileList["#{dir}/**/*.rb"].each do |fname|
@@ -131,6 +128,11 @@ def self.bootstrap_rake
     end
 
     load_tasks
+
+    # This line loads the defaults option values for Annotate
+    # Then "writes" them to ENV if a value for them doesn't already exist
+    #
+    # Calls: .set_defaults
     Rake::Task[:set_annotation_options].invoke
   end