who_am_i 0.0.1

data/gemfiles/rails50.gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: ..
+  specs:
+    who_am_i (0.0.0)
+      activerecord (>= 3.2, < 5.2)
+      parser
+      proc_party
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.4)
+      activesupport (= 5.0.4)
+    activerecord (5.0.4)
+      activemodel (= 5.0.4)
+      activesupport (= 5.0.4)
+      arel (~> 7.0)
+    activesupport (5.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    ast (2.3.0)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    foreigner (1.7.4)
+      activerecord (>= 3.0.0)
+    i18n (0.8.6)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.8.2)
+    minitest (5.10.2)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    proc_party (0.2.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
+    sqlite3 (1.3.13)
+    the_bath_of_zahn (0.0.2)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.0.4)
+  appraisal
+  bundler (~> 1.15)
+  foreigner
+  m (~> 1.5)
+  minitest (~> 5.10)
+  pry-byebug
+  rake (~> 10.0)
+  rubocop
+  sqlite3
+  the_bath_of_zahn
+  who_am_i!
+
+BUNDLED WITH
+   1.15.4

data/gemfiles/rails51.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "= 5.1.2"
+gem "minitest", "~> 5.10"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: ..
+  specs:
+    who_am_i (0.0.0)
+      activerecord (>= 3.2, < 5.2)
+      parser
+      proc_party
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.2)
+      activesupport (= 5.1.2)
+    activerecord (5.1.2)
+      activemodel (= 5.1.2)
+      activesupport (= 5.1.2)
+      arel (~> 8.0)
+    activesupport (5.1.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (8.0.0)
+    ast (2.3.0)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    foreigner (1.7.4)
+      activerecord (>= 3.0.0)
+    i18n (0.8.6)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.8.2)
+    minitest (5.10.2)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    proc_party (0.2.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
+    sqlite3 (1.3.13)
+    the_bath_of_zahn (0.0.2)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.1.2)
+  appraisal
+  bundler (~> 1.15)
+  foreigner
+  m (~> 1.5)
+  minitest (~> 5.10)
+  pry-byebug
+  rake (~> 10.0)
+  rubocop
+  sqlite3
+  the_bath_of_zahn
+  who_am_i!
+
+BUNDLED WITH
+   1.15.4

data/lib/who_am_i/comment.rb

@@ -0,0 +1,56 @@
+module WhoAmI
+  class Comment
+    def initialize(table_name:)
+      @model_info = TableInfo.new(table_name)
+    end
+
+    def output
+      output_header + output_schema + output_indices
+    end
+
+    private
+
+    def output_header
+      "# == Schema Info\n" \
+      "#\n" \
+      "# Table name: #{@model_info.table_name}\n" \
+      "#\n"
+    end
+
+    def output_schema
+      if @model_info.columns.none?
+        return ""
+      end
+
+      tt = TextTable.new(join: "    ", prefix: "#   ")
+
+      @model_info.columns.each do |column_info|
+        tt.push([
+          column_info.name,
+          column_info.type,
+          column_info.attributes.join(", "),
+        ])
+      end
+
+      tt.to_s + "#\n"
+    end
+
+    def output_indices
+      if @model_info.indices.none?
+        return ""
+      end
+
+      tt = TextTable.new(join: "    ", prefix: "#   ")
+
+      @model_info.indices.each do |index|
+        tt.push([index.name, "(#{index.columns.join(", ")})"])
+      end
+
+      header =
+        "# Indices:\n" \
+        "#\n"
+
+      header + tt.to_s + "#\n"
+    end
+  end
+end

data/lib/who_am_i/error.rb

@@ -0,0 +1,4 @@
+module WhoAmI
+  class Error < StandardError
+  end
+end

data/lib/who_am_i/extracted_class.rb

@@ -0,0 +1,50 @@
+module WhoAmI
+  class ExtractedClass
+    attr_writer :name
+    attr_accessor :outerclass
+    attr_accessor :activerecord
+    attr_writer :claimed_superclass
+    attr_accessor :table_name
+    attr_accessor :model_filepath
+    attr_accessor :abstract_class
+    attr_accessor :resolved_superclass
+    attr_accessor :computed_header
+    attr_accessor :computed_content
+
+    def initialize(name,
+      outerclass: nil,
+      activerecord: false,
+      claimed_superclass: nil,
+      table_name: nil,
+      abstract_class: nil)
+      self.name = name
+      self.outerclass = outerclass
+      self.activerecord = activerecord
+      self.claimed_superclass = claimed_superclass
+      self.table_name = table_name
+      self.abstract_class = abstract_class
+    end
+
+    def activerecord?
+      !!@activerecord
+    end
+
+    def abstract_class?
+      !!@abstract_class
+    end
+
+    def claimed_superclass
+      @claimed_superclass.to_s
+    end
+
+    def class_name
+      if @name
+        "#{outerclass.class_name}::#{@name}"
+      else
+        ""
+      end
+    end
+
+    alias_method :to_s, :class_name
+  end
+end

data/lib/who_am_i/function/annotate_models.rb

@@ -0,0 +1,35 @@
+module WhoAmI
+  module Function
+    class AnnotateModels
+      using Refinement::YieldSelf
+      include ProcParty
+
+      def initialize(config, tables)
+        @config = config
+        @tables = tables
+      end
+
+      def call
+        paths
+          .flat_map(&Ls.new)
+          .flat_map(&ParseModel.new)
+          .tap(&ExtractModelData.new)
+          .yield_self(&ResolveTables.new)
+          .reject(&:abstract_class?)
+          .each(&ComputeComment.new)
+          .each(&ComputeContent.new)
+          .each(&WriteModel.new)
+      end
+
+      private
+
+      def paths
+        if @config.nil?
+          []
+        else
+          @config[:paths]
+        end
+      end
+    end
+  end
+end

data/lib/who_am_i/function/compute_comment.rb

@@ -0,0 +1,13 @@
+module WhoAmI
+  module Function
+    class ComputeComment
+      include ProcParty
+
+      def call(extracted_class)
+        commenter =
+          WhoAmI::Comment.new(table_name: extracted_class.table_name)
+        extracted_class.computed_header = commenter.output
+      end
+    end
+  end
+end

data/lib/who_am_i/function/compute_content.rb

@@ -0,0 +1,15 @@
+module WhoAmI
+  module Function
+    class ComputeContent
+      include ProcParty
+
+      PATTERN = %r{\A(?:(?:^#.*?$)\n)*\n*(.*)}m
+
+      def call(extracted_class)
+        original_content = File.read(extracted_class.model_filepath)
+        content = PATTERN.match(original_content)
+        extracted_class.computed_content = content
+      end
+    end
+  end
+end

data/lib/who_am_i/function/extract_model_data.rb

@@ -0,0 +1,14 @@
+module WhoAmI
+  module Function
+    class ExtractModelData
+      using Refinement::YieldSelf
+      include ProcParty
+
+      def call(extracted_classes)
+        extracted_classes
+          .yield_self(&ResolveClassRelationships.new)
+          .yield_self(&ResolveActiveRecord.new)
+      end
+    end
+  end
+end

data/lib/who_am_i/function/get_tables.rb

@@ -0,0 +1,11 @@
+module WhoAmI
+  module Function
+    class GetTables
+      include ProcParty
+
+      def call
+        ActiveRecord::Base.connection.tables
+      end
+    end
+  end
+end

data/lib/who_am_i/function/load_config.rb

@@ -0,0 +1,45 @@
+module WhoAmI
+  module Function
+    class LoadConfig
+      include ProcParty
+
+      def initialize(root)
+        @root = root
+      end
+
+      def call
+        hash = YAML.load_file(config_path)
+        deep_symbolize_hash(hash)
+      end
+
+      private
+
+      def config_path
+        @config_path ||=
+          if File.exist?(dotfile_path)
+            dotfile_path
+          elsif File.exist?(initializer_path)
+            initializer_path
+          else
+            raise WhoAmI::Error, "Configuration not found"
+          end
+      end
+
+      def dotfile_path
+        File.join(@root, ".who_am_i.yml")
+      end
+
+      def initializer_path
+        File.join(@root, "config", "initializers", "who_am_i.yml")
+      end
+
+      def deep_symbolize_hash(obj)
+        if obj.is_a?(Hash)
+          obj.map { |k, v| [k.to_sym, deep_symbolize_hash(v)] }.to_h
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/who_am_i/function/ls.rb

@@ -0,0 +1,13 @@
+module WhoAmI
+  module Function
+    class Ls
+      include ProcParty
+
+      def call(path)
+        glob = File.expand_path(path)
+
+        Dir[glob].select { |path| File.file?(path) }
+      end
+    end
+  end
+end

data/lib/who_am_i/function/main.rb

@@ -0,0 +1,16 @@
+module WhoAmI
+  module Function
+    class Main
+      def initialize(root)
+        @root = root
+      end
+
+      def call
+        config = LoadConfig.new(@root).call
+        tables = GetTables.new.call
+
+        AnnotateModels.new(config[:enabled][:models], tables).call
+      end
+    end
+  end
+end

data/lib/who_am_i/function/parse_model.rb

@@ -0,0 +1,14 @@
+module WhoAmI
+  module Function
+    class ParseModel
+      include ProcParty
+
+      def call(path)
+        walker = WhoAmI::Walker.new
+        extracted_classes = walker.read(path)
+
+        extracted_classes
+      end
+    end
+  end
+end

data/lib/who_am_i/function/remove_annotation.rb

@@ -0,0 +1,27 @@
+module WhoAmI
+  module Function
+    class RemoveAnnotation
+      def call(file_contents:)
+        if file_contents !~ /\A# == Schema Info/
+          return file_contents
+        end
+
+        keep_the_rest = false
+
+        kept_lines =
+          file_contents.lines.keep_if do |line|
+            if keep_the_rest
+              next true
+            elsif line[0] == "#"
+              next false
+            else
+              keep_the_rest = true
+              next false
+            end
+          end
+
+        kept_lines.join("")
+      end
+    end
+  end
+end

data/lib/who_am_i/function/resolve_active_record.rb

@@ -0,0 +1,40 @@
+module WhoAmI
+  module Function
+    class ResolveActiveRecord
+      include ProcParty
+
+      def call(object_space)
+        tree = {}
+        object_space.each do |_class_name, extracted_class|
+          superclass = extracted_class.resolved_superclass
+
+          tree[superclass] ||= Set.new
+          tree[superclass].add(extracted_class)
+        end
+
+        activerecord_family =
+          gather_family(object_space["::ActiveRecord::Base"], tree)
+
+        activerecord_family.each do |individual|
+          individual.activerecord = true
+        end
+
+        object_space.values - [object_space[""], object_space["::ActiveRecord::Base"]]
+      end
+
+      private
+
+      def gather_family(node, tree)
+        gather_family_helper(node, tree).flatten
+      end
+
+      def gather_family_helper(node, tree)
+        if tree[node].nil?
+          return node
+        end
+
+        [node] + tree[node].map { |child| gather_family_helper(child, tree) }
+      end
+    end
+  end
+end

data/lib/who_am_i/function/resolve_class_relationships.rb

@@ -0,0 +1,63 @@
+module WhoAmI
+  module Function
+    class ResolveClassRelationships
+      include ProcParty
+
+      def call(extracted_classes)
+        object_space =
+          extracted_classes
+            .map(&method(:self_and_outer_class))
+            .flatten
+            .compact
+            .uniq
+            .map { |x| [x.class_name, x] }
+            .to_h
+
+        object_space[""] ||= ExtractedClass.new(nil)
+
+        object_space["::ActiveRecord::Base"] =
+          ExtractedClass.new(
+            "ActiveRecord::Base",
+            outerclass: object_space[""]
+          )
+
+        object_space.each do |class_name, extracted_class|
+          possible_namespace_levels = class_name.split("::")[1..-2] || []
+
+          if extracted_class.claimed_superclass == "" || extracted_class.claimed_superclass == nil
+            next
+          end
+
+          (possible_namespace_levels.size + 1).times do
+            class_uri_parts =
+              possible_namespace_levels + [extracted_class.claimed_superclass]
+
+            class_uri = "::#{class_uri_parts.join("::")}"
+
+            if object_space[class_uri]
+              extracted_class.resolved_superclass = object_space[class_uri]
+              break
+            end
+
+            possible_namespace_levels.pop
+          end
+        end
+
+        object_space
+      end
+
+      private
+
+      def self_and_outer_class(extracted_class)
+        if extracted_class.nil?
+          return nil
+        end
+
+        [
+          extracted_class,
+          self_and_outer_class(extracted_class.outerclass)
+        ]
+      end
+    end
+  end
+end

data/lib/who_am_i/function/resolve_tables.rb

@@ -0,0 +1,25 @@
+module WhoAmI
+  module Function
+    class ResolveTables
+      include ProcParty
+
+      def call(extracted_classes)
+        extracted_classes.each do |extracted_class|
+          if !extracted_class.table_name.nil?
+            next
+          end
+
+          extracted_class.table_name =
+            if Kernel.const_defined?(extracted_class.class_name)
+              Kernel.const_get(extracted_class.class_name).table_name
+            else
+              extracted_class.class_name
+                .underscore
+                .pluralize
+                .sub(%r{\A/}, "")
+            end
+        end
+      end
+    end
+  end
+end

data/lib/who_am_i/function/write_model.rb

@@ -0,0 +1,16 @@
+module WhoAmI
+  module Function
+    class WriteModel
+      include ProcParty
+
+      def call(extracted_class)
+        content =
+          "#{extracted_class.computed_header}" \
+          "\n" \
+          "#{extracted_class.computed_content}" 
+
+        File.write(extracted_class.model_filepath, content)
+      end
+    end
+  end
+end

data/lib/who_am_i/rake.rb

@@ -0,0 +1,12 @@
+namespace :who_am_i do
+  desc "Annotate models"
+  task :main do
+    require "who_am_i"
+
+    main = WhoAmI::Function::Main.new(File.expand_path("."))
+    main.call
+  end
+end
+
+desc "Annotate"
+task who_am_i: "who_am_i:main"

data/lib/who_am_i/refinement/yield_self.rb

@@ -0,0 +1,17 @@
+module WhoAmI
+  module Refinement
+    module YieldSelf
+      refine Object do
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0")
+          def yield_self
+            if block_given?
+              yield(self)
+            else
+              enum_for(:yield_self)
+            end
+          end
+        end
+      end
+    end
+  end
+end