setup_script_generator 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c829d0750e6fccda26bffda6ec50825da73518a8c93064848a8c9c46071d4e47
-  data.tar.gz: 7c02754e0c5f48330263ffa97a3ce1734a1806f36a66b81556189dcd2a7f9421
+  metadata.gz: 7abbab871c8809934382abcaded81af412afe8a30837dbbb9337d48e8eb0fb02
+  data.tar.gz: 9b220d798bac841e9436822710fc55f131b284b660cbbad30cd03f3ffb5ca71b
 SHA512:
-  metadata.gz: 3f7d03380b393dc293bd61ceb27399ffc374abbfcb672a1d588b3b33325827958d817eb13a4afbbc2ddfa5031d581cd549721088228e184230f9d7bd4021d402
-  data.tar.gz: aff1f842639f2acbe98238cc8f6ae9f68900bd90752dfdba934988c7b5d60d1f7c8e96318ce1e0cd4233fa0b59d404aa91f400c5296c79788829bfa57e47a828
+  metadata.gz: b04ff789fdf36f3914d30a3bb1dd37881d637b4566d850a3c5aa681cbdd4570f6f9b11146f4d12b6bf415a026ea93bde4d6ff16e57108c71f3ac25da3ef57385
+  data.tar.gz: 314df7615aa78a2cb4e9881c876e0b1669658bc92f2d9ad5d20c5fbf99ae1fd459688f4daf2a1b8e203c4ce3402d0c5c132c1e39155815abbc34fd1abd14a67e

data/.editorconfig

@@ -0,0 +1,2 @@
+[README.md]
+max_line_length = unset

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+Gemfile.lock
 pkg

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in setup_script_generator.gemspec
 gemspec
+
+gem "rake"

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Elliot Winkler
+Copyright (c) 2019-2020 Elliot Winkler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,81 +1,96 @@
 # Setup Script Generator
 
-Every project needs a [setup script][setup-script]. This is an executable that a
-new contributor to the project can run in order to quickly prepare his or her
-machine for development.
+Every project needs a [setup script][setup-script]
+to quickly ready new developers for contributing to the project.
+However, a good setup script is time-consuming to write:
 
 [setup-script]: https://thoughtbot.com/blog/shell-script-suggestions-for-speedy-setups
 
-The problem is that a good setup script is time-consuming to write:
+* The script must make sure that the proper version of your project's language is installed,
+  taking into account the usage of version managers.
+* The script must be idempotent,
+  installing new requirements while skipping over existing ones.
+* The script must provide friendly messages (successful or otherwise).
+* The script must be quick to run.
+* The script must be usable on multiple platforms.
+* The script must be easy to read and maintain.
 
-* The script must be portable, which means handling installation of software
-  using package managers on different platforms.
-* The script must be snappy, which (along with the previous point) dictates the
-  use of Bash.
-* The script must make sure that the proper version of your project's
-  implementation language is installed, and if said language has version
-  managers (such as for Ruby or Node), the script must take them into account
-  as well.
-* The script must provide friendly errors if any checks fail.
-  (Bonus points for colors and/or emoji.)
-* The script must be idempotent, so that if changes to the development are
-  made, the script can be run again, and any requirements that are already
-  satisfied will be skipped, while new requirements will be installed.
-* The script must be easy to read and maintain in the future.
+Given these constraints,
+this project generates a setup script that you can place in your own project.
+This script is implemented in Bash
+so that it is is performant, portable, and maintainable.
 
-Given this, this project provides a way to generate a setup script for your own
-project, so that you can keep all of your teammates on the same page and offer
-them a nice experience going forward.
-
-## Installation
-
-Currently, the generator is available through a Ruby gem. You can install this
-gem by first installing Ruby, then running:
+## Usage
 
-    gem install setup_script_generator
+Currently, the generator is available through a Ruby gem.
+You can install this gem by first installing Ruby, then by running:
 
-## Usage
+```
+gem install setup_script_generator
+```
 
-After installing the gem, navigate to your project. Generally, setup scripts are
-kept in `bin`, so to generate a script, run:
+After installing the gem, navigate to your project.
+You now have the `generate-setup` command
+which will allow you to generate a setup script where you like.
+A common location is `bin/setup`, so you could say:
 
     generate-setup bin/setup
 
-Now, by default, this won't do a whole lot. That's because a setup script is
-much more useful with *provisions*, which add checks and steps for a particular
-language, framework, or service. For instance, if your project requires Ruby,
-then you'd want to say:
+Now open up this file in your editor.
+By default, this script is fairly empty,
+although it does offer a section at the top
+to which you can add custom code:
 
-    generate-setup bin/setup --provision ruby
+``` bash
+provision-project() {
+  # ...
+}
+```
 
-You can add more than one provision if that's what you need:
+While it is perfectly fine to update this function,
+you will probably find it more useful to run `generate-setup` with a set of *provisions*.
+These extend your script with checks and installation steps
+for languages, frameworks, or services on which your project relies.
+For instance, if your project requires Ruby,
+then you'd want to run:
 
-    generate-setup bin/setup --provision ruby --provision node
+```
+generate-setup bin/setup --provision ruby
+```
 
-You can get a list of available provisions by running:
+(Don't worry, if you've already run `generate-setup`,
+you can re-run it at any point in the future
+to add or remove provisions.)
 
-    generate-setup --list-provisions
+You can also use more than one provision if that's what you need:
 
-And if you want to view the setup script before you generate it, you can tack
-`--dry-run` to the end of the command. For instance:
+```
+generate-setup bin/setup --provision ruby --provision node
+```
 
-    generate-setup bin/setup --provision ruby --dry-run
+And you can get a list of available provisions by running:
+
+```
+generate-setup --list-provisions
+```
 
 Finally, to see the full list of options, run:
 
-    generate-setup --help
+```
+generate-setup --help
+```
 
 ## Development
 
-Naturally, this gem comes with its own setup script you can use to get started.
-Just run:
-
-    bin/setup
+Naturally, this project comes with its own setup script.
+Simply run this command to get started:
 
-To release a new version, update `version.rb`, then run `rake release`.
+```
+bin/setup
+```
 
 ## Author/License
 
-(c) 2019 Elliot Winkler (<elliot.winkler@gmail.com>).
-
-Available under the [MIT license](LICENSE.txt).
+Setup Script Generator is copyright © 2019-2020 Elliot Winkler
+(<elliot.winkler@gmail.com>)
+and is released under the [MIT license](LICENSE.txt).

data/bin/setup

@@ -17,12 +17,12 @@ provision-project() {
 
 ### DON'T MODIFY ANYTHING BELOW THIS LINE! #####################################
 
-# This setup script was generated with setup_script_generator 0.2.1,
+# This setup script was generated with setup_script_generator 0.2.3,
 # available on RubyGems.
 #
 # To regenerate this section, install the gem and run:
 #
-#     generate-setup
+#     generate-setup -p ruby
 #
 
 # --- SETUP --------------------------------------------------------------------
@@ -177,10 +177,106 @@ setup() {
   cd "$(dirname "$(dirname "$0")")"
   check-for-package-manager
   install-development-libraries
-  provision-project
+  run-provisions
+  if type provision-project &>/dev/null; then
+    provision-project
+  fi
   success "Setup complete!"
 }
 
+# --- RUBY ---------------------------------------------------------------------
+
+provision-ruby() {
+  USE_BUNDLER_1=0
+
+  if [[ -f .tool-versions ]]; then
+    REQUIRED_RUBY_VERSION=$(cat .tool-versions | grep '^ruby ' | sed -Ee 's/^ruby (.+)$/\1/')
+  elif [[ -f .ruby-version ]]; then
+    REQUIRED_RUBY_VERSION=$(cat .ruby-version)
+  else
+    error "You don't seem to have a Ruby version set in your project."
+    print-wrapped "\
+You'll need to create either a .tool-versions file or .ruby-version file in your
+project before you can run this script."
+    exit 1
+  fi
+
+  ensure-ruby-development-libraries-installed
+  ensure-ruby-installed
+  ensure-project-ruby-dependencies-installed
+}
+
+ensure-ruby-development-libraries-installed() {
+  local platform=$(determine-platform)
+
+  if [[ $platform == "linux" ]]; then
+    banner "Installing Ruby development libraries"
+    install apt=ruby-dev rpm=ruby-devel
+  fi
+}
+
+ensure-ruby-installed() {
+  if has-executable asdf; then
+    if ! (asdf current ruby | grep $REQUIRED_RUBY_VERSION'\>' &>/dev/null); then
+      banner "Installing Ruby $REQUIRED_RUBY_VERSION with asdf"
+      asdf install ruby $REQUIRED_RUBY_VERSION
+    fi
+  elif has-executable rbenv; then
+    if ! (rbenv versions | grep $REQUIRED_RUBY_VERSION'\>' &>/dev/null); then
+      banner "Installing Ruby $REQUIRED_RUBY_VERSION with rbenv"
+      rbenv install --skip-existing "$REQUIRED_RUBY_VERSION"
+    fi
+  elif has-executable chruby-exec; then
+    PREFIX='' source /usr/local/share/chruby/chruby.sh
+    if ! (chruby '' | grep $REQUIRED_RUBY_VERSION'\>' &>/dev/null); then
+      if has-executable install-ruby; then
+        banner "Installing Ruby $REQUIRED_RUBY_VERSION with install-ruby"
+        install-ruby "$REQUIRED_RUBY_VERSION"
+      else
+        error "Please use chruby to install Ruby $REQUIRED_RUBY_VERSION!"
+      fi
+    fi
+  elif has-executable rvm; then
+    if ! (rvm list | grep $required_ruby_version'\>' &>/dev/null); then
+      banner "Installing Ruby $required_ruby_version with rvm"
+      rvm install $required_ruby_version
+      rvm use $required_ruby_version
+    fi
+  else
+    error "You don't seem to have a Ruby manager installed."
+    print-wrapped "\
+We recommend using asdf. You can find instructions to install it here:
+
+    https://asdf-vm.com
+
+When you're done, close and re-open this terminal tab and re-run this script."
+    exit 1
+  fi
+}
+
+has-bundler() {
+  has-executable bundle && bundle -v &>/dev/null
+}
+
+ensure-project-ruby-dependencies-installed() {
+  banner 'Installing Ruby dependencies'
+
+  if [[ $USE_BUNDLER_1 -eq 1 ]] && (! has-bundler || [[ $(bundle -v) =~ '^1\.' ]]); then
+    gem install bundler -v '~> 1.0'
+  elif ! has-bundler; then
+    gem install bundler
+  fi
+
+  bundle check || bundle install
+}
+
+run-provisions() {
+  provision-ruby
+
+  if type provision-project &>/dev/null; then
+    provision-project
+  fi
+}
 
 # --- FIN ----------------------------------------------------------------------
 

data/lib/setup_script_generator/templates/provisions/ruby.sh

@@ -1,4 +1,6 @@
 provision-ruby() {
+  USE_BUNDLER_1=0
+
   if [[ -f .tool-versions ]]; then
     REQUIRED_RUBY_VERSION=$(cat .tool-versions | grep '^ruby ' | sed -Ee 's/^ruby (.+)$/\1/')
   elif [[ -f .ruby-version ]]; then

data/lib/setup_script_generator/version.rb

@@ -1,3 +1,3 @@
 module SetupScriptGenerator
-  VERSION = "0.2.3".freeze
+  VERSION = "0.2.4".freeze
 end

data/setup_script_generator.gemspec

@@ -30,8 +30,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  # spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: setup_script_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Elliot Winkler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-14 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'
+date: 2020-06-20 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 - elliot.winkler@gmail.com
@@ -46,10 +18,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
-- ".ruby-version"
+- ".tool-versions"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/.ruby-version

@@ -1 +0,0 @@
-2.6.3

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    setup_script_generator (0.2.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (10.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  rake (~> 10.0)
-  setup_script_generator!
-
-BUNDLED WITH
-   1.17.3