solargraph-rails-init 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ab7bbc5e69a862fdc9d7dab811099ab9330787fe784b324d699c74827a1f5f2
+  data.tar.gz: 7539801b051fa4f3939bcde2ef252caea6af3b98d8ef2e2723311a56fbad1add
+SHA512:
+  metadata.gz: 2a6c2f0b9dd006b94d0e87a5f6ae2422cecfee6614a9a178e0f797af99675a74b4329246830763b71e4b8a847eb06f99121b7a4d52e8cb4f8a38c0b1f98ef420
+  data.tar.gz: 4d7b06d798db0c5f911b6b95d15c0e7ee0f589dedb460cddbe42ed9528b07285ac10885f5056a7edfe88a8d6ca7a819138f8bf3b14404ac506b754aa57239122

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in solargraph-rails-init.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    solargraph-rails-init (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.3)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  solargraph-rails-init!
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Carl Mercier
+
+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,38 @@
+# solargraph-rails-init
+
+A simple script to configure Solargraph to work with Rails that acts as a shortcut to the following commands:
+
+```bash
+gem install solargraph
+solargraph download-core
+yard gems
+solargraph bundle
+curl -s https://gist.githubusercontent.com/cmer/024991c85c4de01dab17632b2dc7f064/raw > .solargraph.yml
+curl -s https://gist.githubusercontent.com/castwide/28b349566a223dfb439a337aea29713e/raw > config/definitions.rb
+```
+
+
+## Installation
+
+Run the following commands in your Rails app root directory:
+
+```ruby
+gem install solargraph-rails-init
+solargraph-rails-init
+```
+
+Run `solargraph-rails-init` again if you install new gems or change your Ruby version.
+
+## Inspiration
+
+This was inspired by [Setting up Solargraph for VSCode](https://www.youtube.com/watch?v=mkLDPpDSWng).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmer/solargraph-rails-init.
+
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solargraph/rails/init"
+
+# 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/exe/solargraph-rails-init

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+puts "Installing Solargraph gem..."
+`gem install solargraph`
+
+puts "Installing documentation. This might take a while..."
+`solargraph download-core`
+`yard gems`
+`solargraph bundle`
+
+unless File.exist?('.solargraph.yml')
+  puts "Copying .solargraph.yml..."
+  `curl -s https://gist.githubusercontent.com/cmer/024991c85c4de01dab17632b2dc7f064/raw > .solargraph.yml`
+else
+  puts "Skipped copying .solargraph.yml. Already exists."
+end
+
+unless File.exist?('config/definitions.rb')
+  puts "Copying definitions.rb..."
+  `curl -s https://gist.githubusercontent.com/castwide/28b349566a223dfb439a337aea29713e/raw > config/definitions.rb`
+else
+  puts "Skipped copying .definitions.rb. Already exists."
+end
+
+puts "Done!"

data/lib/solargraph/rails/init.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "init/version"
+
+module Solargraph
+  module Rails
+    module Init
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/solargraph/rails/init/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Rails
+    module Init
+      VERSION = "0.1.0"
+    end
+  end
+end

data/solargraph-rails-init.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/solargraph/rails/init/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "solargraph-rails-init"
+  spec.version       = Solargraph::Rails::Init::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = "A simple script to initialize a Rails app to use Solargraph"
+  spec.description   = "A simple script to initialize a Rails app to use Solargraph"
+  spec.homepage      = "https://github.com/cmer/solargraph-rails-init"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cmer/solargraph-rails-init"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: solargraph-rails-init
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-14 00:00:00.000000000 Z
+dependencies: []
+description: A simple script to initialize a Rails app to use Solargraph
+email:
+- foss@carlmercier.com
+executables:
+- solargraph-rails-init
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/solargraph-rails-init
+- lib/solargraph/rails/init.rb
+- lib/solargraph/rails/init/version.rb
+- solargraph-rails-init.gemspec
+homepage: https://github.com/cmer/solargraph-rails-init
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cmer/solargraph-rails-init
+  source_code_uri: https://github.com/cmer/solargraph-rails-init
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A simple script to initialize a Rails app to use Solargraph
+test_files: []