capistrano-opscomplete 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9557996df286d6b2ad029eb5915b019a1c158f6e
-  data.tar.gz: f53793ef28924bf828c7b9c3a7daa4a9eb4d4c4c
+SHA256:
+  metadata.gz: fbb4c106ea61f218ac2ed13cab91256b12d76e6d064343d36a9b78c941bba2af
+  data.tar.gz: 4c849d23d37b0abfab117914d29edfd9425bf6ddbb12baed15586474fd33bcb1
 SHA512:
-  metadata.gz: 47efafd91d9cca904694c487043c6b7475a581fe6a625a8f437da6c9ea64251af51f688677e4706c39e5da9441416d141dfac2775c7bf19d75a81cc90d9d47dd
-  data.tar.gz: c2ae884f910cbc6fd398d7c3df31c8670cc80e6cb213fbdbf92422629fb25690692016be0b6d71b6df5aeb65984f0f5091fb157780017cb65c3ce5936938442d
+  metadata.gz: 529b9dd12ad04f4cfd707704505c57f69276b01c53a9ed944e5bfa13eb8537dca8cc21c3a25eed03b8049810df11f78b23ca87a9050a66bb868901d7531ea2f0
+  data.tar.gz: 37d3ceb10b4d99ab89ee12730dfda034cb26d482e8b11545e49a3fd71e88a4e26ae74ae0168d7bda6d608e53843d2d33e666464a16d82bd74ec95c76d0382771

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.3.0] - 2019-04-05
+### Added
+- You can now specify the rubygems and bundler version to be installed. (#4)
+
+### Changed
+- Support more rubygems versions by using --no-document rather than --no-ri/--no-rdoc (#6)
+- Use makandra-rubocop to improve code style, moved some rbenv calls to DSL (#3)
+- Fixed a deprecation warning where opscomplete:ruby:update_ruby_build was called multiple times. (#7)
+
+### Removed
+- `appserver:restart` task has been obsoleted. Please use https://github.com/capistrano/passenger (#1)
+
 ## [0.2.0] - 2018-08-28
 ### Added
 - Look up .ruby-version from your local branch (cwd) if other options fail
@@ -14,4 +26,5 @@
 ### Added
 - Initial release.
 
+[0.3.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.1.0...v0.2.0

data/Gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
-
-#git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in capistrano-opscomplete.gemspec
 gemspec

data/README.md

@@ -33,8 +33,6 @@ Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration.
 ```ruby
 # After unpacking your release, before bundling, compiling assets, ...
 after 'deploy:updating', 'opscomplete:ruby:ensure'
-# After your application has been successfully deployed and the current symlink has been set
-after 'deploy:published', 'opscomplete:appserver:restart'
 ```
 
 ## Usage
@@ -80,14 +78,12 @@ More specifically this task will:
     - Install the `bundler` and `geordi` gem if required.
     - Run `rbenv rehash` if required.
 
-**Note:** If, for any reason, no `.ruby-version` file can be found in your release or current working directory, you may set the following option in deploy.rb:
+**Note:** If, for any reason, no `.ruby-version` file can be found in your release or current working directory, you may set the following option in `deploy.rb`:
 
 ```ruby
 set :opscomplete_ruby_version, '<VERSION>'
 ```
 
-Where `<VERSION>` is the desired ruby version.
-
 **Optional:** By default, the ruby version is checked/installed for all server roles. If you want to limit the rbenv operations to certain roles, set `rbenv_roles` in your `deploy.rb`:
 
 ```ruby
@@ -96,15 +92,17 @@ set :rbenv_roles, :web
 set :rbenv_roles, [:web, :worker]
 ```
 
-### opscomplete:appserver:restart
-
-To restart your application server execute:
+**Optional:** By default, the most recent version of bundler will be installed. If you want a specific bundler version available for your release, set it in your `deploy.rb`:
 
-    $ bundle exec cap <ENVIRONMENT> opscomplete:appserver:restart
+```ruby
+set :bundler_version, '<VERSION>'
+```
 
-Where `<ENVIRONMENT>` could be `production`, `staging**, ...
+**Optional:** By default, the rubygems version defined by the ruby-build manifest will be installed. If you want a specific rubygems version available for your release, set it in your `deploy.rb`:
 
-**Note**: The current version of this gem only support the passenger app server. The current version of this gem does not support restarting your application, if multiple instances of passenger are running on the same host. This would be the case if you have Apache _and_ Nginx servers running on the same host.
+```ruby
+set :rubygems_version, '<VERSION>'
+```
 
 ### Using capistrano hooks
 
@@ -112,7 +110,6 @@ There are many hooks available in the [default deploy flow](https://capistranorb
 
 ```ruby
 after 'deploy:updating', 'opscomplete:ruby:ensure'
-after 'deploy:published', 'opscomplete:appserver:restart'
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/capistrano-opscomplete.gemspec

@@ -1,36 +1,39 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "capistrano/opscomplete/version"
+require 'capistrano/opscomplete/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "capistrano-opscomplete"
-  spec.version       = Capistrano::Opscomplete::VERSION
-  spec.authors       = ["Makandra Operations"]
-  spec.email         = ["ops@makandra.de"]
+  spec.name     = 'capistrano-opscomplete'
+  spec.version  = Capistrano::Opscomplete::VERSION
+  spec.authors  = ['Makandra Operations']
+  spec.email    = ['ops@makandra.de']
 
-  spec.summary       = %q{Capistrano tasks for easy deployment to a makandra opscomplete environment.}
-  spec.homepage      = "https://opscomplete.com/ruby"
+  spec.summary  = %q(Capistrano tasks for easy deployment to a makandra opscomplete environment.)
+  spec.homepage = 'https://opscomplete.com/ruby'
 
-  spec.license       = 'MIT'
+  spec.license  = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # 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('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^((test|spec|features)/|.gitignore|.rubocop.yml)}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_rubygems_version = '>=2.0.1'
+
+  spec.add_development_dependency 'makandra-rubocop', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_dependency 'capistrano', '>=3.0', '<4.0.0'
 end

data/lib/capistrano/dsl/opscomplete.rb

@@ -2,7 +2,7 @@ module Capistrano
   module DSL
     # A whole capistrano/rake namespace, for grouping our helpers and tasks
     module Opscomplete
-      def managed_ruby
+      def managed_ruby?
         test("[ -f #{rbenv_root_path}/.ruby_managed_by_makandra ]")
       end
 
@@ -56,12 +56,36 @@ module Capistrano
       def rbenv_installed_rubies
         if test("[ -d #{rbenv_root_path}/versions ]")
           rbenv_installed_rubies = capture(:ls, '-1', "#{rbenv_root_path}/versions").split("\n")
-          return rbenv_installed_rubies.map!(&:strip)
+          rbenv_installed_rubies.map!(&:strip)
         else
           warn("Could not look up installed versions from missing '.rbenv/versions' directory. This is probably the first ruby install for this rbenv.")
-          return []
+          []
         end
       end
+
+      def rbenv_exec(*args)
+        execute(:rbenv, :exec, *args)
+      end
+
+      def gem_installed?(name, version = nil)
+        if version
+          test(:rbenv, :exec, "gem query --quiet --installed --version #{version} --name-matches ^#{name}$")
+        else
+          test(:rbenv, :exec, :gem, :query, "--quiet --installed --name-matches ^#{name}$")
+        end
+      end
+
+      def gem_install(name, version = nil)
+        if version
+          rbenv_exec('gem install', name, '--no-document', '--version', version)
+        else
+          rbenv_exec('gem install', name, '--no-document')
+        end
+      end
+
+      def rubygems_install(version)
+        rbenv_exec('gem update --no-document --system', version)
+      end
     end
   end
 end

data/lib/capistrano/opscomplete.rb

@@ -1,4 +1,4 @@
-require "capistrano/opscomplete/version"
+require 'capistrano/opscomplete/version'
 
-load File.expand_path('../opscomplete/tasks.rake', __FILE__)
-load File.expand_path('../opscomplete/deploy.rake', __FILE__)
+load File.expand_path('opscomplete/tasks.rake', __dir__)
+load File.expand_path('opscomplete/deploy.rake', __dir__)

data/lib/capistrano/opscomplete/tasks.rake

@@ -19,7 +19,7 @@ namespace :opscomplete do
     desc 'Check if rbenv global ruby is set according to application\'s .ruby-version.'
     task :check do
       on roles fetch(:rbenv_roles, :all) do |host|
-        warn("#{host}: Managed ruby environment! Won't do any changes to ruby version.") if managed_ruby
+        warn("#{host}: Managed ruby environment! Won't do any changes to ruby version.") if managed_ruby?
         unless capture(:rbenv, :global) == app_ruby_version
           raise Capistrano::ValidationError,
                 "#{host}: Ruby version is not set according to application\'s .ruby-version file. Use cap opscomplete:ruby:ensure."
@@ -52,8 +52,11 @@ namespace :opscomplete do
     # desc 'Install bundler gem'
     task :install_bundler do
       on roles fetch(:rbenv_roles, :all) do
-        next if test(:rbenv, :exec, :gem, :query, '--quiet --installed --name-matches ^bundler$')
-        execute(:rbenv, :exec, :gem, :install, :bundler, '--quiet --no-rdoc --no-ri')
+        if fetch(:bundler_version, false)
+          gem_install('bundler', fetch(:bundler_version)) unless gem_installed?('bundler', fetch(:bundler_version))
+        else
+          gem_install('bundler') unless gem_installed?('bundler')
+        end
         set :rbenv_needs_rehash, true
       end
     end
@@ -61,45 +64,48 @@ namespace :opscomplete do
     # desc 'Install geordi gem'
     task :install_geordi do
       on roles fetch(:rbenv_roles, :all) do
-        next if test(:rbenv, :exec, :gem, :query, '--quiet --installed --name-matches ^geordi$')
-        execute(:rbenv, :exec, :gem, :install, :geordi, '--quiet --no-rdoc --no-ri')
+        gem_install('geordi') unless gem_installed?('geordi')
         set :rbenv_needs_rehash, true
       end
     end
 
+    task :install_rubygems do
+      on roles fetch(:rbenv_roles, :all) do
+        # if no rubygems_version was set, we use and don't check the rubygems version installed by rbenv
+        if fetch(:rubygems_version, false)
+          current_rubygems_version = capture(:rbenv, :exec, :gem, '--version').chomp
+          info("Ensuring requested RubyGems version #{fetch(:rubygems_version)}")
+          next if current_rubygems_version == fetch(:rubygems_version)
+          info("Previously installed RubyGems version was #{current_rubygems_version}")
+          rbenv_exec(:gem, :update, '--no-document', '--system', fetch(:rubygems_version))
+          set :rbenv_needs_rehash, true
+        end
+      end
+    end
+
     desc 'Install and configure ruby according to applications .ruby-version.'
     task :ensure do
+      invoke('opscomplete:ruby:update_ruby_build')
       on roles fetch(:rbenv_roles, :all) do |host|
-        if managed_ruby
+        if managed_ruby?
           raise Capistrano::ValidationError, "#{host}: Managed ruby environment! Won't do any changes to ruby version."
         end
         if rbenv_installed_rubies.include?(app_ruby_version)
           info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
+        elsif rbenv_installable_rubies.include?(app_ruby_version)
+          info("#{host}: Required ruby version is not installed, but available for installation.")
+          execute(:rbenv, :install, app_ruby_version)
+          set :rbenv_needs_rehash, true
         else
-          invoke('opscomplete:ruby:update_ruby_build')
-          if rbenv_installable_rubies.include?(app_ruby_version)
-            info("#{host}: Required ruby version is not installed, but available for installation.")
-            execute(:rbenv, :install, app_ruby_version)
-            set :rbenv_needs_rehash, true
-          else
-            raise Capistrano::ValidationError,
-                  "#{host}: Ruby version required by application is neither installed nor installable using ruby-install."
-          end
+          raise Capistrano::ValidationError,
+                "#{host}: Ruby version required by application is neither installed nor installable using ruby-install."
         end
         execute(:rbenv, :global, app_ruby_version) unless capture(:rbenv, :global) == app_ruby_version
       end
+      invoke('opscomplete:ruby:install_rubygems')
       invoke('opscomplete:ruby:install_bundler')
       invoke('opscomplete:ruby:install_geordi')
       invoke('opscomplete:ruby:rehash') if fetch(:rbenv_needs_rehash, false)
     end
   end
-
-  namespace :appserver do
-    desc 'Restart Application'
-    task :restart do
-      on roles :app do
-        execute "sudo passenger-config restart-app --ignore-app-not-running #{fetch(:deploy_to)}"
-      end
-    end
-  end
 end

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: makandra-rubocop
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +87,6 @@ files:
 - bin/console
 - bin/setup
 - capistrano-opscomplete.gemspec
-- lib/capistrano-opscomplete.rb
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb
 - lib/capistrano/opscomplete/deploy.rake
@@ -97,10 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Capistrano tasks for easy deployment to a makandra opscomplete environment.