solargraph-rails-init 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2ba9759675d9a9fef359a171ebc194abf23d958de334dd34bd28a60442f3a54
-  data.tar.gz: 33d6459e24bd175b0c7ffa8aeec1fbddf220693acbc3526518f287079c14a63d
+  metadata.gz: c4bbdcabdffa226f66ec626b47187d1284f8580e7be42dcabd2a5768623d4751
+  data.tar.gz: d393432009cfa4a6de9cfccb41524f5d3905cb8eaf840dacd0e582141d9ab7c4
 SHA512:
-  metadata.gz: '0870d6b8c9b9cd9fe7020f6727c26ad8031f028503f3e1a67c85e11542783b55d6d8f815bded7e2e08283294cad651b258d1a48f4f184a95fee0d31760e63e19'
-  data.tar.gz: 177584f0a62b3a226c91e8dc906513bec5fb553b5b89187a446f68304ed500cff6ca14487927bbd10f6fbb85ef1158af455aa6aecdcaf2fa16cdad07e18a6115
+  metadata.gz: aecc346759f711981781aa760ee4d3092c7901ce187858f68d01b54e1f6f1ce7a14c65aea5e9378d2840fa329c2bb9487c6fbcb7c85546eb8ff53df1cf525882
+  data.tar.gz: 3018410c3cc714e74bbb973af0a5d335a0731b87f69745e75e2ceaeecd2414016beb9ee86df9c1da4e10ca752ca1bb2e8eeaeaae660c3366443fd97b0652dd6c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph-rails-init (0.1.1)
+    solargraph-rails-init (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,6 +4,7 @@ A simple script that configures Solargraph to work with Rails. It acts as a shor
 
 ```bash
 gem install solargraph
+gem install solargraph-rails --pre  # if --solargraph-rails-gem is specified
 solargraph download-core
 yard gems
 solargraph bundle
@@ -12,13 +13,17 @@ curl -s https://gist.githubusercontent.com/castwide/28b349566a223dfb439a337aea29
 ```
 
 
-## Installation
+## Installation & Usage
 
 Run the following commands in your Rails app root directory:
 
 ```bash
 gem install solargraph-rails-init
 solargraph-rails-init
+
+# See also:
+solargraph-rails-init --help
+solargraph-rails-init --solargraph-rails-gem # also add/initialize the optional solargraph-rails gem
 ```
 
 Run `solargraph-rails-init` again if you install new gems or change your Ruby version.

data/exe/solargraph-rails-init

@@ -1,25 +1,81 @@
 #!/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."
+require 'optparse'
+require 'yaml'
+
+SOLARGRAPH_YML = ".solargraph.yml"
+DEFINITIONS_RB = "config/definitions.rb"
+
+def run
+  parse_options
+  exec_cmd "gem install solargraph",   title: "Installing Solargraph gem..."
+  exec_cmd "solargraph download-core", title: "Installing documentation. This might take a while..."
+  exec_cmd "yard gems"
+  exec_cmd "solargraph bundle"
+
+  unless File.exist?(SOLARGRAPH_YML)
+    exec_cmd "curl -s https://gist.githubusercontent.com/cmer/024991c85c4de01dab17632b2dc7f064/raw > #{SOLARGRAPH_YML}", title: "Copying .solargraph.yml..."
+  else
+    puts "Skipped copying .solargraph.yml. Already exists."
+  end
+
+  unless File.exist?(DEFINITIONS_RB)
+    exec_cmd "curl -s https://gist.githubusercontent.com/castwide/28b349566a223dfb439a337aea29713e/raw > #{DEFINITIONS_RB}", title: "Copying definitions.rb..."
+  else
+    puts "Skipped copying .definitions.rb. Already exists."
+  end
+
+  install_sgr if install_sgr?
+
+  puts "Done!"
+end
+
+def exec_cmd(cmd, title: nil)
+  puts title if title
+  out = `#{cmd}`
+  if $? != 0
+    puts out
+    puts "\nAn error as occured. Aborting.\n"
+    exit 1
+  end
 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."
+def install_sgr?
+  @options[:sgr]
+end
+
+def install_sgr
+  exec_cmd "gem install solargraph-rails --pre", title: "Installing `solargraph-rails` gem..."
+
+  puts "Add `solargraph-rails` plugin to #{SOLARGRAPH_YML}"
+  h = YAML.load_file(SOLARGRAPH_YML)
+  h['plugins'] ||= []
+  h['plugins'] << 'solargraph-rails' unless h['plugins'].include?('solargraph-rails')
+
+  File.open(SOLARGRAPH_YML, "w") do |file|
+    file.write h .to_yaml
+  end
+end
+
+def parse_options
+  @options = {}
+  optparse = OptionParser.new do |opts|
+    # Set a banner, displayed at the top of the help screen.
+    opts.banner = "Usage: solargraph-rails-init [options]"
+
+    @options[:sgr] = false
+    opts.on('-g', '--solargraph-rails-gem', 'Install and configure the solargraph-rails gem') do
+      @options[:sgr] = true
+    end
+
+    # This displays the help screen, all programs are assumed to have this option.
+    opts.on('-h', '--help', 'Display this screen') do
+      puts opts
+      exit
+    end
+  end
+
+  optparse.parse!
 end
 
-puts "Done!"
+run

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

@@ -3,7 +3,7 @@
 module Solargraph
   module Rails
     module Init
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rails-init
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Carl Mercier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies: []
 description: A simple script that configures Solargraph to work with Rails.
 email: