capistrano-nvm-helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c47e80a38392602cb78ab075dcc07095ca7f45420e322c0e08526cacad30ae04
+  data.tar.gz: 15c526f08d15386418af4d82a8de69c40ed8fa06222a2198350b9aa7b31afe33
+SHA512:
+  metadata.gz: 59de74d2eb5d1d793de3e4a333e11819907a6a7c1ba1917608c0dd9af4e053fcb596d11870f83cb61f88d15e79b4a7b05a79e2ef379e17fdfd5d67380fe998f2
+  data.tar.gz: 3a343355a3e76518b4ebcd8089782acb6870fc2da642899fca5d80dffa85445ec58b0a0c7f55fb93e2aa1a8058c24cbe3b496d28d6ccac96dcd8c1017dd075d2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Released]
+
+## [0.1.0] - 2023-10-26
+
+- add NVM setup to Capistrano 3.x

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-nvm-helper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    capistrano-nvm-helper (0.1.0)
+      capistrano (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.5.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.18.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-ssh (7.2.0)
+    rake (13.0.6)
+    sshkit (1.21.5)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bundler
+  capistrano-nvm-helper!
+  rake
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Encore Shao
+
+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,50 @@
+# Capistrano::Nvm::Helper
+
+This gem provides idiomatic nvm support for Capistrano 3.x (and 3.x *only*).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add capistrano-nvm-helper
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install capistrano-nvm-helper
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require "capistrano/nvm-helper"
+```
+
+Configurable options in `config/deploy.rb`:
+
+```ruby
+set :nvm_type, :user # or :system
+set :nvm_node, 'v14.16.1'
+
+# in case you want to set nvm version from the file:
+# set :nvm_node, File.read('.nvmrc').strip
+
+set :nvm_prefix, "source #{fetch(:nvm_path)}/nvm.sh; "
+set :nvm_map_bins, %w{rake gem bundle yarn rails}
+```
+
+## Rails
+
+If you want to use nvm in your rails app deployment tasks (like `deploy:assets:precompile`), consider adding `rake` to `nvm_map_bins`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ekohe/capistrano-nvm-helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ekohe/capistrano-nvm-helper/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capistrano::Nvm::Helper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ekohe/capistrano-nvm-helper/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/capistrano-nvm-helper.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/capistrano/nvm/helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "capistrano-nvm-helper"
+  spec.version = Capistrano::Nvm::Helper::VERSION
+  spec.authors = ["Encore Shao"]
+  spec.email = ["encore@ekohe.com"]
+
+  spec.summary = %q{NVM support for Capistrano 3.x}
+  spec.description = %q{NVM support for Capistrano 3.x}
+  spec.homepage = "https://github.com/ekohe/capistrano-nvm-helper"
+  spec.license = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ekohe/capistrano-nvm-helper/CODE_OF_CONDUCT.md"
+  spec.metadata["changelog_uri"] = "https://github.com/ekohe/capistrano-nvm-helper/CHANGELOG.md"
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/nvm/helper/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Nvm
+    module Helper
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/capistrano/nvm/helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "helper/version"
+
+module Capistrano
+  module Nvm
+    module Helper
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/capistrano/nvm-helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path("../tasks/nvm-helper.rake", __FILE__)

data/lib/capistrano/tasks/nvm-helper.rake

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+namespace :nvm do
+  task validate: :'nvm:wrapper' do
+    on release_roles(fetch(:nvm_roles)) do
+      nvm_node = fetch(:nvm_node)
+      if nvm_node.nil?
+        error "NVM: nvm_node is not set"
+        exit 1
+      end
+
+      nvm_node_path = fetch(:nvm_node_path)
+      nvm_node_path = [nvm_node_path] unless nvm_node_path.is_a?(Array)
+
+      unless test(nvm_node_path.map {|p| "[ -d #{p} ]" }.join(" || "))
+        error "NVM: #{nvm_node} is not installed or not found in any of #{nvm_node_path.join(" ")}"
+        exit 1
+      end
+    end
+  end
+
+  task :map_bins do
+    SSHKit.config.default_env.merge!({ node_version: "#{fetch(:nvm_node)}" })
+    nvm_prefix = fetch(:nvm_prefix, -> { "#{fetch(:nvm_exec_path)}" } )
+
+    fetch(:nvm_map_bins).each do |command|
+      SSHKit.config.command_map.prefix[command.to_sym].unshift(nvm_prefix)
+    end
+  end
+
+  task :wrapper do
+    on release_roles(fetch(:nvm_roles)) do
+      upload! StringIO.new(
+        "#!/bin/bash -e\nsource \"#{fetch(:nvm_path)}/nvm.sh\"\nnvm use $NODE_VERSION\nexec \"$@\""
+      ), "#{fetch(:nvm_exec_path)}"
+
+      execute :chmod, "+x", "#{fetch(:nvm_exec_path)}"
+    end
+  end
+end
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'nvm:validate'
+  after stage, 'nvm:map_bins'
+end
+
+namespace :load do
+  task :defaults do
+    set :nvm_path, -> {
+      nvm_path = fetch(:nvm_custom_path)
+      nvm_path ||= if fetch(:nvm_type, :user) == :system
+        "/usr/local/nvm"
+      else
+        "$HOME/.nvm"
+      end
+    }
+
+    set :nvm_roles, fetch(:nvm_roles, :all)
+    set :nvm_node_path, -> {
+      [
+        "#{fetch(:nvm_path)}/#{fetch(:nvm_node)}",
+        "#{fetch(:nvm_path)}/versions/node/#{fetch(:nvm_node)}"
+      ]
+    }
+    set :nvm_map_bins, %w{node npm yarn}
+    set :nvm_exec_path, "#{fetch(:tmp_dir)}/nvm-exec-#{fetch(:application)}-#{fetch(:environment)}-#{fetch(:user)}.sh"
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-nvm-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Encore Shao
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: NVM support for Capistrano 3.x
+email:
+- encore@ekohe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-nvm-helper.gemspec
+- lib/capistrano-nvm-helper.rb
+- lib/capistrano/nvm-helper.rb
+- lib/capistrano/nvm/helper.rb
+- lib/capistrano/nvm/helper/version.rb
+- lib/capistrano/tasks/nvm-helper.rake
+homepage: https://github.com/ekohe/capistrano-nvm-helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ekohe/capistrano-nvm-helper
+  source_code_uri: https://github.com/ekohe/capistrano-nvm-helper/CODE_OF_CONDUCT.md
+  changelog_uri: https://github.com/ekohe/capistrano-nvm-helper/CHANGELOG.md
+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: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: NVM support for Capistrano 3.x
+test_files: []