solargraph-rails 0.2.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10a5f0ba2496f8b79f4e008ae3ca68f4cb193c31fdbdf95d18b65fc3850e703e
+  data.tar.gz: e21cff4b322b4b8547b9b06709f30fbd883108983570dfb3d44c50e83f335ecf
+SHA512:
+  metadata.gz: 6be898e5f949bb5e683dd5057bd85ae88ebdf19a8d5662b3d107c444ec54b24c71f6026c0877bcf0e1c59e6f7aa2ae21713c6067e0f1c9d2f8f3bb93e60813b6
+  data.tar.gz: a26cbfc730799c6308773ee01a900356227d624d3b0090992ae21a915f01f42964fba3a53ba6fd29ee19c49bad4ef4f45a81592de999b3f48cd82c23519df954

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development, :test do
+  gem 'byebug'
+end
+# Specify your gem's dependencies in solargraph_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Fritz Meissner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Solargraph::Rails - Help solargraph with Rails
+
+## Work in progress - here be dragons
+There are significant rough edges to this gem still. Don't use it if you're not willing to do things like build gems from source and install them locally. See `Installation` below for more info.
+
+## Models
+Given a typical Rails model like this:
+
+```ruby
+# == Schema Information
+#
+# Table name: my_books
+#
+#  id         :integer          not null, primary key
+#  author     :string
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+class MyBook < ApplicationRecord
+  def my_method
+    "hello"
+  end
+
+  ...
+
+end
+```
+
+The various Ruby intellisense tools are ok at knowing that there is a `MyBook` constant, and some (including Solargraph) are even aware that objects like `MyBook.new` have a method `.my_method`. But what about those magical dynamic attributes that ActiveRecord creates when Rails starts up? You can see these listed at the top of the file under `# == Schema Information`, the comments helpfully added by the Annotate gem.
+
+Since these attributes are only created at runtime, static analysis alone can't identify them. Your editor has no idea that these attributes exist, but they're amongst the most common things that you will work with in any Rails app.
+
+That's where this plugin for Solargraph comes in: it parses the schema comments left by Annotate and uses those to give Solargraph some extra hints.
+
+With this you get autocompletion on ActiveRecord attributes:
+
+ ![Autocompletion of dynamic attributes like created_at](assets/solar_rails_autocomplete.gif)
+ 
+... and go to definition commands take you to the schema comment for that column:
+
+
+ ![Go to definition of dynamic attributes like created_at](assets/solar_rails_goto.gif)
+
+... and peek commands show you documentation about the attribute:
+
+ ![Peek at documentation of attributes like created_at, author, etc.](assets/peek.png)
+
+### Reload workspace after migrations
+Solargraph won't know about attributes that you add during a session. Restart your LSP workspace to get the new attributes.
+
+For my setup with Emacs, that means running `M-x lsp-workspace-restart`, YMMV in other editors.
+
+## Associations
+This is coming soon.
+
+## Known issues
+This project is being used to write production code by the maintainer, but it is still WIP. Check out the issues tab and contribute if you are interested.
+
+## Installation
+
+###  Install `solargraph` v0.40+ and `solargraph_rails` locally
+
+SG v0.40 and solargraph_rails are unreleased at time of writing. You'll need to install both locally:
+
+1. Clone solargraph and update version.rb to 0.40.0
+2. Run `gem build` in the root of your clone to create `solargraph-0.40.0.gem`
+3. Clone solargraph_rails 
+4. Run `gem build` in the root of your clone to create `solargraph_rails-0.1.1.gem`
+5. From the root of your Rails app, install solargraph locally: `gem install --local /path/to/solargraph-0.40.0.gem`
+6. From the root of your Rails app, install solargraph_rails locally: `gem install --local /path/to/solargraph_rails-0.1.1.gem`
+
+###  Install gems outside of bundler
+This is the path described above. typically gems like these are not installed via the Gemfile, because most projects have more than one contributor and other contributors might have different setups for their editors in mind. Instead you need to use `gem install`.
+
+####  Alternative: using bundler
+If you do want to use bundler, add `gem "solargraph", path: "/path/to/my_solargraph"` and `gem "solargraph_rails", path: "/path/to/my_solargraph_rails"` instead of steps 5 & 6 above.
+
+### Add `solargraph_rails` to your `.solargraph.yml`
+
+```
+plugins:
+  - solargraph_rails
+```
+
+### Add annotate
+Add schema comments your model files using [Annotate](https://github.com/ctran/annotate_models/). At the moment Solargraph::Rails assumes your schema comments are at the top of the source file.
+
+## Development
+
+Fork the project, start hacking, put up a PR :).
+
+When you make changes, you probably need to shut down solargraph and restart it (maybe that requires you to shut down your whole editor?). You can speed up the feedback loop by running
+
+`api_map = Solargraph::ApiMap.load(Rails.root)`
+
+in the console of the Rails project where solargraph_rails is installed. This may require restarting the rails console each time, and possibly killing Spring.
+
+Once you have an instance of `Solargraph::ApiMap`, you can interrogate it with Solargraph code like:
+
+`pins = api_map.get_methods('MyBook')`
+
+More examples here: https://solargraph.org/guides/code-examples
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph_rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solargraph-rails"
+
+# 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__)

data/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

data/lib/solargraph-rails.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'solargraph'
+require 'solargraph/rails/version'
+require_relative 'solargraph/rails/pin_creator'
+require_relative 'solargraph/rails/ruby_parser'
+require_relative 'solargraph/rails/files_loader'
+
+module Solargraph
+  module Rails
+    class DynamicAttributes < Solargraph::Convention::Base
+      def global yard_map
+        Solargraph::Environ.new(pins: parse_models)
+      end
+
+      private
+
+      def parse_models
+        pins = []
+
+        FilesLoader.new(
+          Dir[File.join(Dir.pwd, 'app', 'models', '**', '*.rb')]
+        ).each { |file, contents| pins.push *PinCreator.new(file, contents).create_pins }
+
+        pins
+      end
+    end
+  end
+end
+
+
+Solargraph::Convention.register Solargraph::Rails::DynamicAttributes

data/lib/solargraph/rails/files_loader.rb

@@ -0,0 +1,16 @@
+module Solargraph
+  module Rails
+    class FilesLoader
+      def initialize(file_names)
+        @file_names = file_names
+      end
+
+      def each(&blk)
+        @file_names.each do |file_name|
+          Solargraph::Logging.logger.info "loading from #{file_name}"
+          blk.call(file_name, File.read(file_name))
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/rails/pin_creator.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Rails
+    class PinCreator
+      attr_reader :contents, :path
+
+      def initialize(path, contents)
+        @path = path
+        @contents = contents
+      end
+
+      def create_pins
+        model_attrs = []
+        model_name = nil
+        module_names = []
+        parser = RubyParser.new(file_contents: contents)
+
+        parser.on_comment do |comment|
+          Solargraph::Logging.logger.info "found comment #{comment}"
+          col_name, col_type = col_with_type(comment)
+          if type_translation.keys.include?(col_type)
+            loc = Solargraph::Location.new(
+              path,
+              Solargraph::Range.from_to(
+                parser.current_line_number,
+                0,
+                parser.current_line_number,
+                parser.current_line_length - 1
+              )
+            )
+            model_attrs << { name: col_name, type: col_type, location: loc }
+          else
+            Solargraph::Logging.logger.info 'could not find annotation in comment'
+          end
+        end
+
+        parser.on_module do |mod_name|
+          Solargraph::Logging.logger.info "found module #{mod_name}"
+          module_names << mod_name
+        end
+
+        parser.on_class do |klass, superklass|
+          Solargraph::Logging.logger.info "found class: #{klass} < #{superklass}"
+          if ['ActiveRecord::Base', 'ApplicationRecord'].include?(superklass)
+            model_name = klass
+          else
+            Solargraph::Logging.logger.info "Unable to find ActiveRecord model from #{klass} #{superklass}"
+            model_attrs = [] # don't include anything from this file
+          end
+        end
+
+        parser.parse
+
+        Solargraph::Logging.logger.info "Adding #{model_attrs.count} attributes as pins"
+        model_attrs.map do |attr|
+          Solargraph::Pin::Method.new(
+            name: attr[:name],
+            comments: "@return [#{type_translation[attr[:type]]}]",
+            location: attr[:location],
+            closure: Solargraph::Pin::Namespace.new(name: module_names.join('::') + "::#{model_name}"),
+            scope: :instance,
+            attribute: true
+          )
+        end
+      end
+
+      def col_with_type(line)
+        line
+          .gsub(/[\(\),:\d]/, '')
+          .split
+          .first(2)
+      end
+
+      def type_translation
+        {
+          'decimal' => 'BigDecimal',
+          'integer' => 'Integer',
+          'date' => 'Date',
+          'datetime' => 'ActiveSupport::TimeWithZone',
+          'string' => 'String',
+          'boolean' => 'Boolean',
+          'text' => 'String'
+        }
+      end
+    end
+  end
+end

data/lib/solargraph/rails/ruby_parser.rb

@@ -0,0 +1,70 @@
+module Solargraph
+  module Rails
+    class RubyParser
+      attr_reader :current_line_number, :current_line_length
+
+      def initialize(file_contents: '')
+        @lines = file_contents.lines
+        @comment_handlers = []
+        @class_handlers = []
+        @module_handlers = []
+      end
+
+      def on_comment(&blk)
+        @comment_handlers << blk
+      end
+
+      def on_class(&blk)
+        @class_handlers << blk
+      end
+
+      def on_module(&blk)
+        @module_handlers << blk
+      end
+
+      def parse
+        @lines
+          .map(&:rstrip)
+          .each_with_index do |line, i|
+          @current_line_number = i
+          @current_line_length = line.length
+
+          if is_comment?(line)
+            comment_content = line.gsub(/#\s*/, '')
+            @comment_handlers.each { |handler| handler.call(comment_content) }
+          end
+
+          if is_class?(line)
+            line.scan(/(?:(?<!<\s)(?:(\b\w+\b)\:\:))/).flatten.each do |inline_module_name|
+              @module_handlers.each { | handler| handler.call(inline_module_name) }
+            end
+            line.match(/class\s+(?:\w*?(?:\:\:))*([A-Z]\w*)/)
+            klass_name = $1
+            line.match(/(?:<\s+)((?:[A-Z]\w*(?:\:\:)?)*)/)
+            superklass_name = $1
+            @class_handlers.each { |handler| handler.call(klass_name, superklass_name) }
+          end
+
+          if is_module?(line)
+            module_name = line.match(/^\s*module\s*?([A-Z]\w+)/)[1]
+            @module_handlers.each { |handler| handler.call(module_name) }
+          end
+        end
+      end
+
+      private
+
+      def is_comment?(line)
+        line =~ (/^\s*#/)
+      end
+
+      def is_class?(line)
+        line =~ /^[^#]?.*?class\s+?[A-Z]/
+      end
+
+      def is_module?(line)
+        line =~ (/^\s*module\s*?([A-Z]\w+)/)
+      end
+    end
+  end
+end

data/lib/solargraph/rails/version.rb

@@ -0,0 +1,5 @@
+module Solargraph
+  module Rails
+    VERSION = '0.2.0.pre'
+  end
+end

data/solargraph-rails.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "solargraph/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "solargraph-rails"
+  spec.version       = Solargraph::Rails::VERSION
+  spec.authors       = ["Fritz Meissner"]
+  spec.email         = ["fritz.meissner@gmail.com"]
+
+  spec.summary       = %q{Solargraph plugin that adds Rails-specific code through a Convention}
+  spec.description   = %q{Add reflection on ActiveModel dynamic attributes that will be created at runtime}
+  spec.homepage      = 'https://github.com/iftheshoefritz/solargraph-rails'
+  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", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "solargraph", "~> 0.40.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: solargraph-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre
+platform: ruby
+authors:
+- Fritz Meissner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+description: Add reflection on ActiveModel dynamic attributes that will be created
+  at runtime
+email:
+- fritz.meissner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/peek.png
+- assets/solar_rails_autocomplete.gif
+- assets/solar_rails_goto.gif
+- bin/console
+- bin/setup
+- lib/solargraph-rails.rb
+- lib/solargraph/rails/files_loader.rb
+- lib/solargraph/rails/pin_creator.rb
+- lib/solargraph/rails/ruby_parser.rb
+- lib/solargraph/rails/version.rb
+- solargraph-rails.gemspec
+homepage: https://github.com/iftheshoefritz/solargraph-rails
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Solargraph plugin that adds Rails-specific code through a Convention
+test_files: []