ahnnotate 0.2.0

data/lib/ahnnotate/tables.rb

@@ -0,0 +1,55 @@
+module Ahnnotate
+  class Tables
+    include Enumerable
+
+    def initialize(connection = ActiveRecord::Base.connection)
+      @connection = connection
+    end
+
+    def to_h
+      map { |table| [table.name, table] }.to_h
+    end
+
+    def each
+      if !block_given?
+        enum_for(:each)
+      end
+
+      @connection.tables.each do |table_name|
+        primary_key = ActiveRecord::Base.get_primary_key(table_name)
+
+        columns = @connection.columns(table_name).map do |c|
+          is_primary_key =
+            if primary_key.is_a?(Array)
+              primary_key.include?(c.name)
+            else
+              primary_key == c.name
+            end
+
+          Column.new(
+            name: c.name,
+            type: c.type.to_s,
+            nullable: c.null,
+            primary_key: is_primary_key,
+            default: c.default
+          )
+        end
+
+        indexes = @connection.indexes(table_name).map do |i|
+          Index.new(
+            name: i.name,
+            columns: i.columns,
+            unique: i.unique,
+            comment: i.comment
+          )
+        end
+
+        yield Table.new(
+          name: table_name,
+          columns: columns,
+          indexes: indexes
+        )
+      end
+    end
+  end
+end

data/lib/ahnnotate/version.rb

@@ -0,0 +1,3 @@
+module Ahnnotate
+  VERSION = "0.2.0"
+end

data/lib/ahnnotate/vfs.rb

@@ -0,0 +1,69 @@
+module Ahnnotate
+  class Vfs
+    include Enumerable
+
+    def initialize(driver)
+      @driver = driver
+    end
+
+    def []=(path, content)
+      if content.nil?
+        return
+      end
+
+      if @driver.dir?(path)
+        raise Error::VfsWriteError, "can't write to directory"
+      end
+
+      if !accessible_path?(path)
+        raise Error::VfsOutsideOfRoot, "path seems to be outside of root"
+      end
+
+      @driver[path] = content
+    end
+
+    def [](path)
+      if @driver.dir?(path)
+        raise Error::VfsReadError, "can't read a directory"
+      end
+
+      if !accessible_path?(path)
+        raise Error::VfsOutsideOfRoot, "path seems to be outside of root"
+      end
+
+      @driver[path]
+    end
+
+    def each
+      if !block_given?
+        return enum_for(:each)
+      end
+
+      @driver.each(&Proc.new)
+    end
+
+    def each_in(paths)
+      if !block_given?
+        return enum_for(:each_in, paths)
+      end
+
+      paths =
+        if paths.is_a?(Array)
+          paths
+        else
+          [paths]
+        end
+
+      @driver.each_in(paths, &Proc.new)
+    end
+
+    private
+
+    def accessible_path?(path)
+      random_safe_prefix = "/#{SecureRandom.hex}"
+      expanded_path = File.expand_path(path, random_safe_prefix)
+
+      /\A#{random_safe_prefix}\b/ === expanded_path
+    end
+  end
+end

data/lib/ahnnotate/vfs_driver/filesystem.rb

@@ -0,0 +1,68 @@
+module Ahnnotate
+  module VfsDriver
+    class Filesystem
+      def initialize(root:)
+        @root = root
+      end
+
+      def each
+        paths =
+          root
+            .glob("**/*")
+            .select(&:file?)
+            .map { |path| path.relative_path_from(root).to_s }
+
+        root.glob("**/*").select(&:file?).each do |abspath|
+          relpath = abspath.relative_path_from(root).to_s
+
+          yield relpath, File.read(abspath)
+        end
+      end
+
+      def each_in(subset_paths)
+        subset_paths = subset_paths.map { |path| root.join(path) }
+
+        subset_paths.each do |subset_path|
+          subset_path.glob("**/*").select(&:file?).map do |abspath|
+            relpath = abspath.relative_path_from(root).to_s
+
+            yield relpath, File.read(abspath)
+          end
+        end
+      end
+
+      def [](path)
+        path = root.join(path)
+
+        if path.exist?
+          File.read(path)
+        end
+      end
+
+      def []=(path, content)
+        path = root.join(path)
+        holding_directory = path.dirname
+
+        if holding_directory.file?
+          raise "File is not a directory"
+        end
+
+        if !holding_directory.exist?
+          holding_directory.mkpath
+        end
+
+        File.write(path, content)
+      end
+
+      def dir?(path)
+        root.join(path).directory?
+      end
+
+      private
+
+      def root
+        Pathname.new(@root)
+      end
+    end
+  end
+end

data/lib/ahnnotate/vfs_driver/hash.rb

@@ -0,0 +1,59 @@
+module Ahnnotate
+  module VfsDriver
+    class Hash
+      def initialize(files, subdirectories = nil)
+        @files = files
+        @subdirectories = nil
+      end
+
+      def each
+        @files.each do |path, content|
+          yield path, content
+        end
+      end
+
+      def each_in(subset_paths)
+        subset_patterns = subset_paths.map { |path| /\A#{path}\b/ }
+
+        @files.each do |path, content|
+          if subset_patterns.none? { |pattern| pattern === path }
+            next
+          end
+
+          yield path, content
+        end
+      end
+
+      def [](path)
+        @files[path]
+      end
+
+      def []=(path, content)
+        if content.nil?
+          return
+        end
+
+        @files[path] = content
+      end
+
+      def subset(in: nil)
+        subdirectories = binding.local_variable_get(:in)
+
+        self.class.new(the_subset, subdirectories)
+      end
+
+      def dir?(path)
+        path_with_trailing_slash =
+          if path[-1] == "/"
+            path
+          else
+            path + "/"
+          end
+
+        @files.any? do |filepath, _|
+          filepath.start_with?(path_with_trailing_slash)
+        end
+      end
+    end
+  end
+end

data/lib/ahnnotate/vfs_driver/read_only_filesystem.rb

@@ -0,0 +1,8 @@
+module Ahnnotate
+  module VfsDriver
+    class ReadOnlyFilesystem < Filesystem
+      def []=(_path, _content)
+      end
+    end
+  end
+end

data/lib/ahnnotate.rb

@@ -0,0 +1,32 @@
+require "active_record"
+require "parser/current"
+require "proc_party"
+require "stringio"
+
+require "ahnnotate/column"
+require "ahnnotate/config"
+require "ahnnotate/error"
+require "ahnnotate/vfs"
+require "ahnnotate/vfs_driver/filesystem"
+require "ahnnotate/vfs_driver/hash"
+require "ahnnotate/vfs_driver/read_only_filesystem"
+require "ahnnotate/function/format"
+require "ahnnotate/function/main"
+require "ahnnotate/function/run"
+require "ahnnotate/function/tabularize"
+require "ahnnotate/facet/models"
+require "ahnnotate/facet/models/main"
+require "ahnnotate/facet/models/module_node"
+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/index"
+require "ahnnotate/options"
+require "ahnnotate/table"
+require "ahnnotate/tables"
+require "ahnnotate/version"
+
+if defined?(Rails)
+  require "ahnnotate/railtie"
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: ahnnotate
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zach Ahn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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
+  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: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: Heavily inspired by the `annotate` gem
+email:
+- engineering@zachahn.com
+executables:
+- ahnnotate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ahnnotate.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- exe/ahnnotate
+- lib/ahnnotate.rb
+- lib/ahnnotate/cli.rb
+- lib/ahnnotate/column.rb
+- lib/ahnnotate/config.rb
+- lib/ahnnotate/error.rb
+- lib/ahnnotate/facet/models.rb
+- lib/ahnnotate/facet/models/main.rb
+- lib/ahnnotate/facet/models/module_node.rb
+- lib/ahnnotate/facet/models/processor.rb
+- 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/function/format.rb
+- lib/ahnnotate/function/main.rb
+- lib/ahnnotate/function/run.rb
+- lib/ahnnotate/function/tabularize.rb
+- lib/ahnnotate/index.rb
+- lib/ahnnotate/options.rb
+- lib/ahnnotate/rails.rake
+- lib/ahnnotate/railtie.rb
+- lib/ahnnotate/table.rb
+- lib/ahnnotate/tables.rb
+- lib/ahnnotate/version.rb
+- lib/ahnnotate/vfs.rb
+- lib/ahnnotate/vfs_driver/filesystem.rb
+- lib/ahnnotate/vfs_driver/hash.rb
+- lib/ahnnotate/vfs_driver/read_only_filesystem.rb
+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.7.6
+signing_key: 
+specification_version: 4
+summary: '"Annotate" your models'
+test_files: []