who_am_i 0.0.1

data/lib/who_am_i/table_column_info.rb

@@ -0,0 +1,50 @@
+module WhoAmI
+  class TableColumnInfo
+    def initialize(basic_model_class:, column:)
+      @basic_model_class = basic_model_class
+      @column = column
+    end
+
+    def name
+      @column.name
+    end
+
+    def type
+      @column.type.to_s
+    end
+
+    def attributes
+      @attributes ||=
+        begin
+          attrs = [
+            not_null? && "not null",
+            primary_key? && "primary key",
+            default,
+          ]
+
+          attrs.select { |attr| attr }
+        end
+    end
+
+    def primary_key?
+      case @basic_model_class.primary_key
+      when Array
+        @basic_model_class.primary_key.include?(name)
+      when String
+        @basic_model_class.primary_key == name
+      else
+        false
+      end
+    end
+
+    def not_null?
+      !@column.null
+    end
+
+    def default
+      if @column.default
+        "default (#{@column.default})"
+      end
+    end
+  end
+end

data/lib/who_am_i/table_info.rb

@@ -0,0 +1,31 @@
+module WhoAmI
+  class TableInfo
+    def initialize(table_name)
+      @table_name = table_name
+    end
+
+    attr_reader :table_name
+
+    def columns
+      @columns ||=
+        basic_model_class.columns.map do |column|
+          TableColumnInfo.new(basic_model_class: basic_model_class, column: column)
+        end
+    end
+
+    def indices
+      @indices ||=
+        basic_model_class.connection.indexes(@table_name)
+    end
+
+    private
+
+    def basic_model_class
+      @basic_model_class ||=
+        begin
+          table = @table_name
+          Class.new(ActiveRecord::Base) { self.table_name = table }
+        end
+    end
+  end
+end

data/lib/who_am_i/text_table.rb

@@ -0,0 +1,49 @@
+module WhoAmI
+  class TextTable
+    include Enumerable
+
+    def initialize(join:, prefix: "", suffix: "")
+      @join = join
+      @prefix = prefix
+      @suffix = suffix
+      @rows = []
+      @column_lengths = []
+    end
+
+    def push(row)
+      @rows.push(row)
+
+      row.each.with_index do |field, index|
+        @column_lengths[index] =
+          if @column_lengths[index].nil?
+            field.length
+          else
+            [@column_lengths[index], field.length].max
+          end
+      end
+
+      true
+    end
+
+    def each
+      if !block_given?
+        return enum_for(:each)
+      end
+
+      @rows.each do |row|
+        output_fields =
+          row.map.with_index do |field, index|
+            field.to_s.ljust(@column_lengths[index], " ")
+          end
+
+        output_row = @prefix + output_fields.join(@join) + @suffix
+
+        yield output_row
+      end
+    end
+
+    def to_s
+      map(&:rstrip).join("\n") + "\n"
+    end
+  end
+end

data/lib/who_am_i/version.rb

@@ -0,0 +1,3 @@
+module WhoAmI
+  VERSION = "0.0.1".freeze
+end

data/lib/who_am_i/walker.rb

@@ -0,0 +1,113 @@
+module WhoAmI
+  class Walker < AST::Processor
+    def initialize
+      @current_class = ExtractedClass.new(nil)
+      @classes = [@current_class]
+    end
+
+    def read(file)
+      content = File.read(file)
+      sexp = Parser::CurrentRuby.parse(content)
+
+      classes(sexp).each do |klass|
+        klass.model_filepath = file
+      end
+    end
+
+    def classes(sexp)
+      @current_class = ExtractedClass.new(nil)
+      @classes = [@current_class]
+
+      process(sexp)
+
+      @classes.reject { |klass| klass.class_name == "" }
+    end
+
+    def on_class(node)
+      @current_class = classlike_create(node, outerclass: @current_class)
+      @classes.push(@current_class)
+
+      process_children(node)
+
+      @current_class = @current_class.outerclass
+    end
+
+    alias on_module on_class
+
+    def on_send(node)
+      receiver, method_name, assigned_node = *node
+
+      if receiver == s(:self) && method_name == :table_name=
+        table_name = assigned_node.children.last
+        @current_class.table_name = table_name
+      end
+
+      if receiver == s(:self) && method_name == :abstract_class=
+        abstract_class =
+          if assigned_node.type == :true
+            true
+          else
+            false
+          end
+        @current_class.abstract_class = abstract_class
+      end
+    end
+
+    def handler_missing(node)
+      process_children(node)
+    end
+
+    # ignore instance method definitions since method definition bodies can't
+    # contain class declarations
+    def on_def(_)
+    end
+
+    # ignore class method definitions since method definition bodies can't
+    # contain class declarations
+    def on_defs(_)
+    end
+
+    private
+
+    def classlike_create(node, outerclass:)
+      class_node, superclass_node, _body_node = *node
+
+      if node.type == :module
+        superclass_node = nil
+      end
+
+      class_name = resolve_class_name(class_node)
+      superclass_name = resolve_class_name(superclass_node)
+
+      classlike = ExtractedClass.new(class_name.to_s)
+      classlike.claimed_superclass = superclass_name.to_s
+      classlike.outerclass = outerclass
+
+      classlike
+    end
+
+    def resolve_class_name(node)
+      outer, name = *node
+
+      if outer.nil?
+        name
+      else
+        "#{resolve_class_name(outer)}::#{name}"
+      end
+    end
+
+    def process_children(node)
+      node.children.each do |child|
+        if child.is_a?(AST::Node)
+          process(child)
+        end
+      end
+
+      node
+    end
+
+    def s(type, *children)
+      AST::Node.new(type, children)
+    end
+  end
+end

data/lib/who_am_i.rb

@@ -0,0 +1,29 @@
+require "parser/current"
+require "proc_party"
+require "set"
+
+require "who_am_i/refinement/yield_self"
+
+require "who_am_i/extracted_class"
+require "who_am_i/comment"
+require "who_am_i/table_info"
+require "who_am_i/table_column_info"
+require "who_am_i/version"
+require "who_am_i/walker"
+require "who_am_i/text_table"
+require "who_am_i/error"
+
+require "who_am_i/function/remove_annotation"
+require "who_am_i/function/main"
+require "who_am_i/function/load_config"
+require "who_am_i/function/get_tables"
+require "who_am_i/function/annotate_models"
+require "who_am_i/function/ls"
+require "who_am_i/function/parse_model"
+require "who_am_i/function/extract_model_data"
+require "who_am_i/function/resolve_class_relationships"
+require "who_am_i/function/resolve_active_record"
+require "who_am_i/function/resolve_tables"
+require "who_am_i/function/compute_comment"
+require "who_am_i/function/compute_content"
+require "who_am_i/function/write_model"

data/who_am_i.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "who_am_i/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "who_am_i"
+  spec.version = WhoAmI::VERSION
+  spec.authors = ["Zach Ahn"]
+  spec.email = ["engineering@zachahn.com"]
+
+  spec.summary = "Table schema reminders in the model"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "the_bath_of_zahn"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "m", "~> 1.5"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "foreigner"
+
+  spec.add_runtime_dependency "activerecord", ">= 3.2", "< 5.2"
+  spec.add_runtime_dependency "parser"
+  spec.add_runtime_dependency "proc_party"
+end

metadata

@@ -0,0 +1,285 @@
+--- !ruby/object:Gem::Specification
+name: who_am_i
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Ahn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: the_bath_of_zahn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: foreigner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: proc_party
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- engineering@zachahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/appraisal
+- bin/console
+- bin/m
+- bin/rake
+- bin/rubocop
+- bin/setup
+- gemfiles/rails32.gemfile
+- gemfiles/rails32.gemfile.lock
+- gemfiles/rails40.gemfile
+- gemfiles/rails40.gemfile.lock
+- gemfiles/rails41.gemfile
+- gemfiles/rails41.gemfile.lock
+- gemfiles/rails42.gemfile
+- gemfiles/rails42.gemfile.lock
+- gemfiles/rails50.gemfile
+- gemfiles/rails50.gemfile.lock
+- gemfiles/rails51.gemfile
+- gemfiles/rails51.gemfile.lock
+- lib/who_am_i.rb
+- lib/who_am_i/comment.rb
+- lib/who_am_i/error.rb
+- lib/who_am_i/extracted_class.rb
+- lib/who_am_i/function/annotate_models.rb
+- lib/who_am_i/function/compute_comment.rb
+- lib/who_am_i/function/compute_content.rb
+- lib/who_am_i/function/extract_model_data.rb
+- lib/who_am_i/function/get_tables.rb
+- lib/who_am_i/function/load_config.rb
+- lib/who_am_i/function/ls.rb
+- lib/who_am_i/function/main.rb
+- lib/who_am_i/function/parse_model.rb
+- lib/who_am_i/function/remove_annotation.rb
+- lib/who_am_i/function/resolve_active_record.rb
+- lib/who_am_i/function/resolve_class_relationships.rb
+- lib/who_am_i/function/resolve_tables.rb
+- lib/who_am_i/function/write_model.rb
+- lib/who_am_i/rake.rb
+- lib/who_am_i/refinement/yield_self.rb
+- lib/who_am_i/table_column_info.rb
+- lib/who_am_i/table_info.rb
+- lib/who_am_i/text_table.rb
+- lib/who_am_i/version.rb
+- lib/who_am_i/walker.rb
+- who_am_i.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Table schema reminders in the model
+test_files: []