ahnnotate 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72eb34c9d755ad96bff225cb3a76df199af6a1620b2f07d4fb5abcd63c0cdd9
-  data.tar.gz: cb087f502791daa1ef953876a9079baae139d8b86332547a32f9c4b2602ea176
+  metadata.gz: c932b95899f0bc90dfe57b0481f976ed98aeb4981e61bce5e03d4efaf3cb8c07
+  data.tar.gz: fcacaac6f5719affb613cd96028d77321bcc156fed75514c7414c5ba04002290
 SHA512:
-  metadata.gz: b40e4182bf70ddc46900b7ed21c6ae00041d48d771dc714224e9211f1819fce2a508b021eb6c0d77bf1c96c0982109c80e6d05daacf470209838f211131330b6
-  data.tar.gz: 2b24c5e2a2b4294c2014686b1a56198f4f8dc084f0a7d7fe557b4178301612193c543009148e5593566f35b280d5434ad1e8d98d776a7f8b962ee4fdfa42e0af
+  metadata.gz: 5f44bb30bf66d538f3e2416b4013354b8512f651cef5c07f3950aeae71063666a02a9638ba3e7b8edf01a2ef841e127dcca7dd7384acee81e7d2a81415043ef5
+  data.tar.gz: b81a860aa49609ee8942e3e9b17ede7891b75e5cbcb2938e64d231b3e8fb411acfb8d96f50109651f6c9123489d13354319024661efa2d16735ccf9ac7799fb2

data/.github/workflows/ruby.yml

@@ -0,0 +1,64 @@
+name: Test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:11.5
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: ahnnotate_test
+        ports:
+        - 5432/tcp
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile:
+          - gemfiles/rails60.gemfile
+          - gemfiles/rails52.gemfile
+          - gemfiles/rails51.gemfile
+          - gemfiles/rails50.gemfile
+          - gemfiles/rails42.gemfile
+          - gemfiles/rails41.gemfile
+        include:
+          - gemfile: gemfiles/rails60.gemfile
+            ruby: 2.6.x
+          - gemfile: gemfiles/rails52.gemfile
+            ruby: 2.5.x
+          - gemfile: gemfiles/rails51.gemfile
+            ruby: 2.5.x
+          - gemfile: gemfiles/rails50.gemfile
+            ruby: 2.5.x
+          - gemfile: gemfiles/rails42.gemfile
+            ruby: 2.4.x
+          - gemfile: gemfiles/rails41.gemfile
+            ruby: 2.3.x
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install build dependencies
+      run: |
+        sudo apt-get install -y sqlite3 libsqlite3-dev libpq-dev
+    - name: Install dependencies
+      env:
+        BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      run: |
+        gem install bundler -v 1.17.3
+        bundle install --jobs 4 --retry 3
+    - name: Test
+      env:
+        BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        AHNNOTATE_POSTGRES_DATABASE_URL: postgres://postgres:postgres@localhost:${{ job.services.postgres.ports[5432] }}/ahnnotate_test
+      run: |
+        bundle exec rake

data/.gitignore

@@ -7,4 +7,4 @@
 /spec/reports/
 /tmp/
 /gemfiles/*.lock
-/Gemfile.lock
+/.env

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.5.3
   - 2.1.10
 gemfile:
+  - gemfiles/rails60.gemfile
   - gemfiles/rails52.gemfile
   - gemfiles/rails51.gemfile
   - gemfiles/rails50.gemfile

data/Appraisals

@@ -1,3 +1,8 @@
+appraise "rails60" do
+  gem "activerecord", "~> 6.0.0"
+  gem "sqlite3", ">= 1.4"
+end
+
 appraise "rails52" do
   gem "activerecord", "~> 5.2.2"
 end
@@ -8,14 +13,19 @@ end
 
 appraise "rails50" do
   gem "activerecord", "~> 5.0.7"
+  gem "sqlite3", "< 1.4"
 end
 
 appraise "rails42" do
   gem "activerecord", "~> 4.2.11"
+  gem "pg", "~> 0.15"
+  gem "sqlite3", "< 1.4"
 end
 
 appraise "rails41" do
   gem "activerecord", "~> 4.1.16"
+  gem "pg", "~> 0.15"
+  gem "sqlite3", "< 1.4"
 end
 
 # vim: syntax=ruby

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    ahnnotate (0.5.0)
+      activerecord (>= 4.0.0)
+      parser
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    dotenv (2.7.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pg (1.1.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ahnnotate!
+  appraisal
+  bundler (~> 1.17)
+  dotenv
+  minitest (~> 5.0)
+  pg
+  pry
+  rake (~> 10.0)
+  sqlite3
+
+BUNDLED WITH
+   1.17.3

data/ahnnotate.gemspec

@@ -30,8 +30,8 @@ DESC
   spec.add_development_dependency "pg"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "dotenv"
 
-  spec.add_runtime_dependency "activerecord", ">= 4.0.0", "< 6"
+  spec.add_runtime_dependency "activerecord", ">= 4.0.0"
   spec.add_runtime_dependency "parser"
-  spec.add_runtime_dependency "proc_party"
 end

data/gemfiles/rails41.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.1.16"
+gem "pg", "~> 0.15"
+gem "sqlite3", "< 1.4"
 
 gemspec path: "../"

data/gemfiles/rails42.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.11"
+gem "pg", "~> 0.15"
+gem "sqlite3", "< 1.4"
 
 gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 5.0.7"
+gem "sqlite3", "< 1.4"
 
 gemspec path: "../"

data/gemfiles/rails60.gemfile

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

data/lib/ahnnotate/abilities.rb

@@ -0,0 +1,20 @@
+module Ahnnotate
+  class Abilities
+    def initialize(connection)
+      @connection = connection
+      @adapter_name = connection.adapter_name.downcase
+    end
+
+    def foreign_key?
+      if @adapter_name == "sqlite"
+        return false
+      end
+
+      if !@connection.respond_to?(:foreign_keys)
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/ahnnotate/column.rb

@@ -1,16 +1,35 @@
 module Ahnnotate
   class Column
     attr_reader :name
-    attr_reader :type
 
-    def initialize(name:, type:, nullable:, primary_key:, default:)
+    def self.sql_type_map
+      @sql_type_map ||=
+        begin
+          map = Hash.new { |_self, k| k }
+          map["character varying"] = "varchar"
+          map["character"] = "char"
+          map["datetime"] = "timestamp"
+          map["double precision"] = "double"
+          map["time with time zone"] = "time"
+          map["time without time zone"] = "timetz"
+          map["timestamp with time zone"] = "timestamptz"
+          map["timestamp without time zone"] = "timestamp"
+          map
+        end
+    end
+
+    def initialize(name:, sql_type:, nullable:, primary_key:, default:)
       @name = name
-      @type = type
+      @sql_type = sql_type.to_s.downcase.gsub(/\(.*?\)/, "")
       @nullable = nullable
       @primary_key = primary_key
       @default = default
     end
 
+    def type
+      self.class.sql_type_map[@sql_type]
+    end
+
     def details
       if @details
         return @details

data/lib/ahnnotate/facet/models/module_node.rb

@@ -15,7 +15,7 @@ module Ahnnotate
         # Named to fit the ModelSchema interface. This is basically `Class#name`
         attr_accessor :name
         # Named to fit the ModelSchema interface. This is the "outer class"
-        attr_accessor :parent
+        attr_accessor :module_parent
         # Named to fit the ModelSchema interface. This is the class that the
         # current class inherits from. This is computed, whereas
         # `claimed_superclass` is what is parsed from the source
@@ -31,13 +31,13 @@ module Ahnnotate
         attr_accessor :path
 
         def initialize(name,
-          parent: nil,
+          module_parent: nil,
           is_a_kind_of_activerecord_base: false,
           claimed_superclass: nil,
           explicit_table_name: nil,
           abstract_class: nil)
           self.name = name
-          self.parent = parent
+          self.module_parent = parent
           self.is_a_kind_of_activerecord_base = is_a_kind_of_activerecord_base
           self.claimed_superclass = claimed_superclass
           self.explicit_table_name = explicit_table_name
@@ -80,11 +80,17 @@ module Ahnnotate
           superclass.base_class
         end
 
+        # Named to fit the ModelSchema interface. It was originally implemented
+        # in ActiveRecord::Inheritance in Rails 6.0.
+        def base_class?
+          base_class == self
+        end
+
         # Named to fit the ModelSchema interface. It was originally implemented
         # in ActiveSupport::Introspection
-        def parents
-          if parent
-            [parent, *parent.parent]
+        def module_parents
+          if module_parent
+            [module_parent, *module_parent.module_parent]
           else
             []
           end
@@ -132,7 +138,26 @@ module Ahnnotate
           end
         end
 
+        module ActiveRecord4And5Compatibility
+          # Named to fit the ModelSchema interface. It was originally implemented
+          # in ActiveSupport::CoreExt::Module::Introspection in Rails 6.0.
+          def parent
+            module_parent
+          end
+
+          # def parent=(parent_)
+          #   self.module_parent = parent_
+          # end
+
+          # Named to fit the ModelSchema interface. It was originally implemented
+          # in ActiveSupport::CoreExt::Module::Introspection in Rails 6.0.
+          def parents
+            module_parents
+          end
+        end
+
         include ActiveRecord4Compatibility
+        include ActiveRecord4And5Compatibility
       end
     end
   end

data/lib/ahnnotate/facet/models/processor.rb

@@ -67,7 +67,7 @@ module Ahnnotate
 
           classlike = ModuleNode.new(class_name.to_s)
           classlike.claimed_superclass = superclass_name.to_s
-          classlike.parent = parent
+          classlike.module_parent = parent
 
           classlike
         end

data/lib/ahnnotate/facet/models/resolve_active_record_models.rb

@@ -2,7 +2,9 @@ module Ahnnotate
   module Facet
     module Models
       class ResolveActiveRecordModels
-        include ProcParty
+        def to_proc
+          method(:call).to_proc
+        end
 
         def call(object_space)
           tree = {}

data/lib/ahnnotate/facet/models/resolve_class_relationships.rb

@@ -2,7 +2,9 @@ module Ahnnotate
   module Facet
     module Models
       class ResolveClassRelationships
-        include ProcParty
+        def to_proc
+          method(:call).to_proc
+        end
 
         def call(extracted_classes)
           object_space =
@@ -19,7 +21,7 @@ module Ahnnotate
           object_space["::ActiveRecord::Base"] =
             ModuleNode.new(
               "ActiveRecord::Base",
-              parent: object_space[""],
+              module_parent: object_space[""],
               abstract_class: nil
             )
           object_space["::ActiveRecord::Base"].is_active_record_base = true

data/lib/ahnnotate/foreign_key.rb

@@ -0,0 +1,22 @@
+module Ahnnotate
+  class ForeignKey
+    attr_accessor :name
+    attr_accessor :from_column
+    attr_accessor :to_table
+    attr_accessor :to_column
+
+    def initialize(**args)
+      args.each do |key, value|
+        public_send("#{key}=", value)
+      end
+    end
+
+    def from
+      from_column
+    end
+
+    def to
+      "#{to_table}##{to_column}"
+    end
+  end
+end

data/lib/ahnnotate/rspec.rb

@@ -0,0 +1,62 @@
+require "ahnnotate"
+
+# This RSpec matcher only works for Rails. Here's a quick usage example:
+#
+#   require "rails_helper"
+#   require "ahnnotate/rspec"
+#
+#   RSpec.describe Ahnnotate do
+#     it { is_expected.to be_up_to_date }
+#   end
+class AhnnotateUpToDateMatcher
+  attr_reader :actual
+  attr_reader :expected
+
+  def diffable?
+    true
+  end
+
+  def matches?(_)
+    options = Ahnnotate::Options.new(fix: false)
+    config = Ahnnotate::Config.load(root: Rails.root)
+    main = Ahnnotate::Function::Main.new(Rails.root, options, config)
+
+    main.call
+
+    writes = main.vfs.instance_variable_get(:@driver).changes
+
+    format = proc do |vfs_hash|
+      vfs_hash
+        .map { |path, contents| "~~~ #{path} ~~~\n#{contents}" }
+        .join("\n")
+    end
+
+    expected = writes.map { |path, _content| [path, File.read(path)] }.to_h
+    @expected = format.call(expected)
+    @actual = format.call(writes)
+
+    @actual == @expected
+  end
+
+  def description
+    "be up to date (you may need to run `rails db:test:prepare`)"
+  end
+
+  def failure_message
+    "expected Ahnnotate to be up to date"
+  end
+
+  def failure_message_when_negated
+    "expected Ahnnotate not to be up to date"
+  end
+end
+
+module AhnnotateBeUpToDate
+  def be_up_to_date
+    AhnnotateUpToDateMatcher.new
+  end
+end
+
+RSpec.configure do |c|
+  c.include AhnnotateBeUpToDate
+end

data/lib/ahnnotate/table.rb

@@ -3,6 +3,7 @@ module Ahnnotate
     attr_accessor :name
     attr_accessor :columns
     attr_accessor :indexes
+    attr_accessor :foreign_keys
 
     def initialize(**args)
       args.each do |key, value|
@@ -32,6 +33,13 @@ module Ahnnotate
         output.puts comment
       end
 
+      if foreign_keys.any?
+        output.puts "#{comment} Foreign keys:"
+        output.puts comment
+        output.puts tabularizer.call(foreign_keys, [:from, :to, :name])
+        output.puts comment
+      end
+
       output.string
     end
 

data/lib/ahnnotate/tables.rb

@@ -4,6 +4,7 @@ module Ahnnotate
 
     def initialize(connection = ActiveRecord::Base.connection)
       @connection = connection
+      @abilities = Abilities.new(connection)
     end
 
     def to_h
@@ -28,7 +29,7 @@ module Ahnnotate
 
           Column.new(
             name: c.name,
-            type: c.type.to_s,
+            sql_type: c.sql_type,
             nullable: c.null,
             primary_key: is_primary_key,
             default: c.default
@@ -49,10 +50,25 @@ module Ahnnotate
           )
         end
 
+        foreign_keys =
+          if @abilities.foreign_key?
+            @connection.foreign_keys(table_name).map do |fk|
+              ForeignKey.new(
+                name: fk.name,
+                from_column: fk.column,
+                to_table: fk.to_table,
+                to_column: fk.primary_key
+              )
+            end
+          else
+            []
+          end
+
         yield Table.new(
           name: table_name,
           columns: columns,
-          indexes: indexes
+          indexes: indexes,
+          foreign_keys: foreign_keys,
         )
       end
     end

data/lib/ahnnotate/version.rb

@@ -1,3 +1,3 @@
 module Ahnnotate
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/ahnnotate/vfs_driver/read_only_filesystem.rb

@@ -1,7 +1,16 @@
 module Ahnnotate
   module VfsDriver
     class ReadOnlyFilesystem < Filesystem
-      def []=(_path, _content)
+      attr_reader :changes
+
+      def initialize(root:)
+        super
+        @changes = {}
+      end
+
+      def []=(path, content)
+        @changes[path] = content
+        nil
       end
     end
   end

data/lib/ahnnotate.rb

@@ -1,13 +1,13 @@
 require "yaml"
 require "active_record"
 require "parser/current"
-require "proc_party"
 require "stringio"
 
 require "ahnnotate/refinement/dig"
 require "ahnnotate/refinement/pathname_glob"
 require "ahnnotate/refinement/yield_self"
 
+require "ahnnotate/abilities"
 require "ahnnotate/active_record_version"
 require "ahnnotate/column"
 require "ahnnotate/command"
@@ -29,6 +29,7 @@ require "ahnnotate/facet/models/processor"
 require "ahnnotate/facet/models/resolve_active_record_models"
 require "ahnnotate/facet/models/resolve_class_relationships"
 require "ahnnotate/facet/models/standin"
+require "ahnnotate/foreign_key"
 require "ahnnotate/index"
 require "ahnnotate/options"
 require "ahnnotate/table"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahnnotate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Zach Ahn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,41 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: proc_party
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,7 +153,7 @@ dependencies:
 description: 'Ahnnotate comments on your ActiveRecord models with their respective
   schemas!
 
-'
+  '
 email:
 - engineering@zachahn.com
 executables:
@@ -167,10 +161,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -185,7 +181,9 @@ files:
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - lib/ahnnotate.rb
+- lib/ahnnotate/abilities.rb
 - lib/ahnnotate/active_record_version.rb
 - lib/ahnnotate/cli.rb
 - lib/ahnnotate/column.rb
@@ -199,6 +197,7 @@ files:
 - lib/ahnnotate/facet/models/resolve_active_record_models.rb
 - lib/ahnnotate/facet/models/resolve_class_relationships.rb
 - lib/ahnnotate/facet/models/standin.rb
+- lib/ahnnotate/foreign_key.rb
 - lib/ahnnotate/function/format.rb
 - lib/ahnnotate/function/main.rb
 - lib/ahnnotate/function/niam.rb
@@ -211,6 +210,7 @@ files:
 - lib/ahnnotate/refinement/dig.rb
 - lib/ahnnotate/refinement/pathname_glob.rb
 - lib/ahnnotate/refinement/yield_self.rb
+- lib/ahnnotate/rspec.rb
 - lib/ahnnotate/table.rb
 - lib/ahnnotate/tables.rb
 - lib/ahnnotate/version.rb
@@ -237,8 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ahnnotate comments on your ActiveRecord models with their respective schemas!