capify-rbenv 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa81866e990f52998c1095061b3d6213a39f891e108540dab79c4345ce16596d
+  data.tar.gz: 65dfc7661e797bd5da57846bfcabc77dbda4579f504227f51902b0cbae04badc
+SHA512:
+  metadata.gz: 5346d8028276476d0a8fd51c076720efb8197f3dcb66644e8c472328e90b846f050598a321429e9be2137d27edfb42ec7b1c75b583ae3811a3ba19a3c3081524
+  data.tar.gz: 87e16f87e3b4125bee086de6bc64346369681a3e21a7f043c44150b1fb645ace1756ff15ccd1edfaff6b5cfe4eb7e7df7bf8b0084fde2035c842ff8445599006

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capify-rbenv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Muhammad Usman
+
+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,97 @@
+# Capify::Rbenv
+
+Capistrano recipes to setup rbenv, ruby and bundler. It provides all the goodies of [capistrano-rbenv](https://github.com/capistrano/rbenv) and adds more features, like:
+
+* Install [rbenv](https://github.com/rbenv/rbenv) if not installed already.
+* Install [ruby-build](https://github.com/rbenv/ruby-build) if not installed already.
+* Install specified ruby version if not installed already.
+* Install specified bundler version if not installed already.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.13'
+gem 'capify-rbenv', '~> 1.0'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+## Usage
+
+```ruby
+# Capfile
+require 'capistrano/rbenv'
+
+
+# config/deploy.rb
+set :rbenv_ruby, '2.7.1' # Set ruby version to install (Required)
+set :rbenv_bundler, '2.1.4' # Set bundler version to install (Required)
+
+# In case you want to set ruby version from .ruby-version file:
+# set :rbenv_ruby, File.read('.ruby-version').strip
+```
+
+Following is the list of all optional configurable options along with their default values and examples.
+
+```ruby
+# Set rbenv installation type (user/system)
+set :rbenv_type, :user
+
+# Set rbenv installation path
+set :rbenv_path, fetch(:rbenv_type) == :system ? '/usr/local/rbenv' : '$HOME/.rbenv'
+
+# Set rbenv directory for installed ruby versions
+set :rbenv_ruby_dir, "#{fetch(:rbenv_path)}/versions/#{fetch(:rbenv_ruby)}"
+
+# Set or append the list of dependencies to install
+# See lib/capistrano/tasks/defaults.rake for default dependencies
+append :rbenv_deps, 'libsqlite3-dev', 'sqlite3'
+
+# Set dependencies installer
+set :rbenv_deps_installler, 'apt-get install -y'
+
+# Set or append customs bins to create under rbenv
+# See lib/capistrano/tasks/defaults.rake for default bins
+append :rbenv_map_bins, 'puma', 'pumactl'
+```
+
+When you `require 'capistrano/rbenv'` in your Capfile, it will add default hooks to capistrano deploy that will automatically setup everything (rbenv, ruby, bundler) you need. If you want to skip the default hooks and setup everything on your own, use the following instructions,
+
+```ruby
+# Capfile
+require 'capistrano/rbenv/without_hooks'
+
+
+# Then add it as a hook
+after :some_task, 'rbenv:setup'
+
+# Or invoke manually
+task :custom_setup do
+  invoke 'rbenv:setup'
+end
+```
+
+## Available tasks
+
+```ruby
+rbenv:install              # Install rbenv
+rbenv:install_ruby         # Install ruby
+rbenv:install_bundler      # Install bundler gem
+rbenv:install_ruby_build   # Install/Update ruby_build - rbenv plugin
+rbenv:setup                # Setup rbenv, ruby-build, ruby and bundler
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uxxman/capify-rbenv.
+
+
+## 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 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capify/rbenv"
+
+# 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/capify-rbenv.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/capistrano/rbenv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capify-rbenv'
+  spec.version       = Capistrano::Rbenv::VERSION
+  spec.authors       = ['Muhammad Usman']
+  spec.email         = ['uxman.sherwani@gmail.com']
+
+  spec.summary       = 'Capistrano recipe to setup rbenv, ruby and bundler'
+  spec.description   = 'Setup ruby environemnt on remote server(s) using rbenv'
+  spec.homepage      = 'https://github.com/uxxman/capify-rbenv'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # 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{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+  spec.add_dependency 'sshkit', '~> 1.3'
+end

data/lib/capistrano/rbenv.rb

@@ -0,0 +1 @@
+require 'capistrano/rbenv/with_hooks'

data/lib/capistrano/rbenv/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Rbenv
+    VERSION = '4.0.0'.freeze
+  end
+end

data/lib/capistrano/rbenv/with_hooks.rb

@@ -0,0 +1,3 @@
+load File.expand_path('../tasks/defaults.rake', __dir__)
+load File.expand_path('../tasks/rbenv.rake', __dir__)
+load File.expand_path('../tasks/deploy.rake', __dir__)

data/lib/capistrano/rbenv/without_hooks.rb

@@ -0,0 +1,2 @@
+load File.expand_path('../tasks/defaults.rake', __dir__)
+load File.expand_path('../tasks/rbenv.rake', __dir__)

data/lib/capistrano/tasks/defaults.rake

@@ -0,0 +1,56 @@
+namespace :load do
+  task :defaults do
+    default_deps = %w[
+      libpq-dev
+      libssl-dev
+      zlib1g-dev
+      libreadline-dev
+      build-essential
+    ]
+
+    default_bins = %w[
+      gem
+      rake
+      ruby
+      rails
+      bundle
+    ]
+
+    # Set ruby version to install using rbenv (Required)
+    # set :rbenv_ruby, '2.7.1'
+
+    # Set bundler version to install using rbenv (Required)
+    # set :rbenv_bundler, '2.1.4'
+
+    # Set rbenv installation type (user/system)
+    set_if_empty :rbenv_type, :user
+
+    # Set rbenv installation path
+    set_if_empty :rbenv_path, fetch(:rbenv_type) == :system ? '/usr/local/rbenv' : '$HOME/.rbenv'
+
+    # Set rbenv directory for installed ruby versions
+    set_if_empty :rbenv_ruby_dir, "#{fetch(:rbenv_path)}/versions/#{fetch(:rbenv_ruby)}"
+
+    # Set list of custom dependencies to install
+    set_if_empty :rbenv_deps, default_deps.join(' ')
+
+    # Set dependencies installer
+    set_if_empty :rbenv_deps_installler, 'apt-get install -y'
+
+    # Set customs bins to create under rbenv
+    set_if_empty :rbenv_map_bins, default_bins
+  end
+end
+
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, :rbenv_map_bins do
+    SSHKit.config.default_env.merge!({ rbenv_root: fetch(:rbenv_path), rbenv_version: fetch(:rbenv_ruby) })
+    SSHKit.config.command_map[:rbenv] = "#{fetch(:rbenv_path)}/bin/rbenv"
+    rbenv_prefix = fetch(:rbenv_prefix, "#{fetch(:rbenv_path)}/bin/rbenv exec")
+
+    fetch(:rbenv_map_bins).uniq.each do |command|
+      SSHKit.config.command_map.prefix[command.to_sym].unshift(rbenv_prefix)
+    end
+  end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,3 @@
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'rbenv:setup'
+end

data/lib/capistrano/tasks/rbenv.rake

@@ -0,0 +1,59 @@
+namespace :rbenv do
+  RBENV_REPO_URL = 'https://github.com/rbenv/rbenv.git'.freeze
+  RUBY_BUILD_REPO_URL = 'https://github.com/rbenv/ruby-build.git'.freeze
+
+
+  desc 'Install rbenv'
+  task :install do
+    on roles(:app) do
+      next if test "[ -d #{fetch(:rbenv_path)} ]"
+
+      execute :sudo, "#{fetch(:rbenv_deps_installler)} #{fetch(:rbenv_default_deps)} #{fetch(:rbenv_deps)}"
+      execute :git, "clone #{RBENV_REPO_URL} #{fetch(:rbenv_path)}"
+    end
+  end
+
+
+  desc 'Install/Update ruby-build - rbenv plugin'
+  task :install_ruby_build do
+    on roles(:app) do
+      ruby_build_path = "#{fetch(:rbenv_path)}/plugins/ruby-build"
+
+      if test "[ -d #{ruby_build_path} ]"
+        execute :git, "-C #{ruby_build_path} pull"
+      else
+        invoke 'rbenv:install'
+        execute :git, "clone #{RUBY_BUILD_REPO_URL} #{ruby_build_path}"
+      end
+    end
+  end
+
+
+  desc 'Install ruby'
+  task :install_ruby do
+    on roles(:app) do
+      next if test "[ -d #{fetch(:rbenv_ruby_dir)} ]"
+
+      invoke 'rbenv:install_ruby_build'
+      execute :rbenv, "install #{fetch(:rbenv_ruby)}"
+    end
+  end
+
+
+  desc 'Install bundler'
+  task :install_bundler do
+    on roles(:app) do
+      next if test :gem, :query, "-q -i -n ^bundler$ -v #{fetch(:rbenv_bundler)}"
+
+      invoke 'rbenv:install_ruby'
+      execute "echo 'gem: --no-document' >> ~/.gemrc"
+      execute :gem, :install, :bundler, "-v #{fetch(:rbenv_bundler)}"
+    end
+  end
+
+
+  desc 'Setup rbenv, ruby-build, ruby and bundler'
+  task :setup do
+    invoke 'rbenv:install_bundler'
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: capify-rbenv
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Muhammad Usman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Setup ruby environemnt on remote server(s) using rbenv
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capify-rbenv.gemspec
+- lib/capistrano/rbenv.rb
+- lib/capistrano/rbenv/version.rb
+- lib/capistrano/rbenv/with_hooks.rb
+- lib/capistrano/rbenv/without_hooks.rb
+- lib/capistrano/tasks/defaults.rake
+- lib/capistrano/tasks/deploy.rake
+- lib/capistrano/tasks/rbenv.rake
+homepage: https://github.com/uxxman/capify-rbenv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/uxxman/capify-rbenv
+  source_code_uri: https://github.com/uxxman/capify-rbenv
+  changelog_uri: https://github.com/uxxman/capify-rbenv
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Capistrano recipe to setup rbenv, ruby and bundler
+test_files: []