capistrano-opscomplete 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a434f5baae62ed091c04472a4dc20f427a79aadc
-  data.tar.gz: d4a151042cfaf864fcfe0a9b9b33b6924b3cffa9
+  metadata.gz: 9557996df286d6b2ad029eb5915b019a1c158f6e
+  data.tar.gz: f53793ef28924bf828c7b9c3a7daa4a9eb4d4c4c
 SHA512:
-  metadata.gz: '09ee42b231e8269735885573d3acda6b1a12d46d0813f17b2167e6ac37a1e9ec7edfcbc7c2e554918cbbdeb6a79983afce3f9a50d7f3361657f6220da90b33cf'
-  data.tar.gz: dfc4c295ea1c29a0366c0a6cbcd8fc4c7fdbdae69d3515d53bace18d02dd386f0a328d4dc2d3fa75117dcea3bba76873024a9e25c3885b74e2da2fa947c6dad7
+  metadata.gz: 47efafd91d9cca904694c487043c6b7475a581fe6a625a8f437da6c9ea64251af51f688677e4706c39e5da9441416d141dfac2775c7bf19d75a81cc90d9d47dd
+  data.tar.gz: c2ae884f910cbc6fd398d7c3df31c8670cc80e6cb213fbdbf92422629fb25690692016be0b6d71b6df5aeb65984f0f5091fb157780017cb65c3ce5936938442d

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [0.2.0] - 2018-08-28
+### Added
+- Look up .ruby-version from your local branch (cwd) if other options fail
+
+### Changed
+- Don't use Task#invoke!() to allow support of more capistrano versions (<3.8.2)
+- Update documentation to use other capistrano hook, so release_dir is available
+- .ruby-version lookup precedence now includes local branch (cwd)
+- Fixed a bug where capistrano exits if no ruby version has ever been installed using rbenv
+- Less verbose output while updating ruby-build plugin
+- If no :rbenv_roles have been provided, default to :all role
+
+## 0.1.0 - 2018-07-11
+### Added
+- Initial release.
+
+[0.2.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.1.0...v0.2.0

data/README.md

@@ -1,7 +1,6 @@
 # Capistrano::Opscomplete
 
-This gem provides capistrano tasks for convenient deployment to a makandra [OpsComplete for Ruby](https://opscomplete.com/ruby) environment. If you find any bugs or run
-into a problem, please drop us a mail or open an issue.
+This gem provides capistrano tasks for convenient deployment to a makandra [OpsComplete for Ruby](https://opscomplete.com/ruby) environment. If you find any bugs or run into a problem, please drop us a mail or open an issue.
 
 ## Installation
 
@@ -27,20 +26,23 @@ require 'capistrano/opscomplete'
 
 Verify the gem was installed and tasks are available:
 
-    $ bundle exec cap -T | grep opscomplete
+    $ bundle exec cap -T opscomplete
 
-Optional: If you want to manage ruby versions for certain roles, set `rbenv_roles` in your `deploy.rb`:
+Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration. An example configuration could look like this:
 
 ```ruby
-set :rbenv_roles, :app
+# 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'
 ```
 
-You might also want to configure some hooks, see [using capistrano hooks](#using-capistrano-hooks).
-
 ## Usage
 
-If you encounter any errors, please make sure you have the newest version of the capistrano-opscomplete gem installed. Don't hesitate to
-contact the OpsComplete for Ruby team for further support.
+If you encounter any errors, please make sure you have the newest version of the capistrano-opscomplete gem installed. Don't hesitate to contact the OpsComplete for Ruby team for further support.
+
+You might also want to configure some hooks to automatically update the ruby version, see [using capistrano hooks](#using-capistrano-hooks).
+
 
 ### List available tasks
 
@@ -48,19 +50,19 @@ To see available capistrano tasks, execute:
 
     $ bundle exec cap -T
 
+
 ### opscomplete:ruby:check
 
-The `opscomplete:ruby:check` task checks for a properly configured ruby. It will not try to correct any misconfigurations, but just abort
-the capistrano run.
+The `opscomplete:ruby:check` task checks for a properly configured ruby. It will not try to correct any misconfigurations, but just abort the capistrano run.
 
     $ bundle exec cap <ENVIRONMENT> opscomplete:ruby:check
 
 Where `<ENVIRONMENT>` could be `production`, `staging`, ...
 
+
 ### opscomplete:ruby:ensure
 
-The `opscomplete:ruby:ensure` task checks for a ruby as requested in application's `.ruby-version` file and will try to correct some
-misconfigurations.
+The `opscomplete:ruby:ensure` task checks for a ruby as requested in application's `.ruby-version` file and will try to correct some misconfigurations.
 
     $ bundle exec cap <ENVIRONMENT> opscomplete:ruby:ensure
 
@@ -69,14 +71,16 @@ Where `<ENVIRONMENT>` could be `production`, `staging`, ...
 More specifically this task will:
   - Check whether you are running a 'managed ruby' (installed with OpsComplete for Ruby) or if you have to install ruby using this gem or rbenv.
   - If you are using 'unmanaged ruby':
-    - Checks if ruby version requested by `.ruby-version` is installed.
-    - If it is not installed, checks if it can be installed using `ruby-build` and installs it.
+    - Check if desired ruby version is installed. The following lookup precedence for the desired version is being used:
+      1) The value of `:opscomplete_ruby_version` from your capistrano config. Leave this empty unless you want to override the desired version.
+      2) A file in the `release_path` on the server (e.g. `/var/www/staging.myapp.biz/releases/20180523234205/.ruby-version`)
+      3) A file in the current working directory of your local checkout (e.g. `/home/user/code/myapp/.ruby-version`)
+    - If the desired version is not installed, it checks if it can be installed using `ruby-build` and installs it.
     - Check if `rbenv global` version is set according to application's `.ruby-version` file. Change it if required.
     - 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 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>'
@@ -84,25 +88,33 @@ 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
+set :rbenv_roles, :web
+# or
+set :rbenv_roles, [:web, :worker]
+```
+
 ### opscomplete:appserver:restart
 
 To restart your application server execute:
 
     $ bundle exec cap <ENVIRONMENT> opscomplete:appserver:restart
 
-Where `<ENVIRONMENT>` could be `production`, `staging`, ...
+Where `<ENVIRONMENT>` could be `production`, `staging**, ...
 
-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.
+**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.
 
 ### Using capistrano hooks
 
-There are many hooks in the [default deploy flow](https://capistranorb.com/documentation/getting-started/flow/) to integrate tasks into your own deployment configuration. To ensure a ruby version according to your application is installed during deployment, add the following to your `Capfile`.
+There are many hooks available in the [default deploy flow](https://capistranorb.com/documentation/getting-started/flow/) to integrate tasks into your own deployment configuration. To ensure a ruby version according to your application is installed during deployment, add the following to your `Capfile`.
 
 ```ruby
-before 'deploy:starting', 'opscomplete:ruby:ensure'
+after 'deploy:updating', 'opscomplete:ruby:ensure'
 after 'deploy:published', 'opscomplete:appserver:restart'
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome.
+Bug reports and pull requests are welcome. Don't hesitate to [open a new issue](https://github.com/makandra/capistrano-opscomplete/issues/new).

data/lib/capistrano/dsl/opscomplete.rb

@@ -19,12 +19,24 @@ module Capistrano
       end
 
       def app_ruby_version
-        app_ruby_version_file_path = release_path.join('.ruby-version').to_s
+        release_ruby_version_file_path = release_path.join('.ruby-version').to_s
+
+        # 1) Get version from capistrano configuration (highest precedence, 'override')
         if fetch(:opscomplete_ruby_version)
-          warn("Using version from :opscomplete_ruby_version setting: #{fetch(:opscomplete_ruby_version)}.")
+          debug("Using version from :opscomplete_ruby_version setting: #{fetch(:opscomplete_ruby_version)}.")
           return fetch(:opscomplete_ruby_version)
-        elsif test("[ -f #{app_ruby_version_file_path} ]")
-          return capture(:cat, app_ruby_version_file_path)
+
+        # 2) Get version from .ruby-version in release dir (after deploy:updating, before deploy:updated)
+        elsif test("[ -f #{release_ruby_version_file_path} ]")
+          debug("Using version from server's release_dir/.ruby-version file: #{capture(:cat, release_ruby_version_file_path)}")
+          return capture(:cat, release_ruby_version_file_path)
+
+        # 3) Get version from local checkout/cwd
+        elsif File.readable?('.ruby-version')
+          debug("Using version from local (cwd) .ruby-version file: #{File.read('.ruby-version').strip}")
+          return File.read('.ruby-version').strip
+
+        # FAIL: We have no idea which version to use
         else
           raise Capistrano::ValidationError, 'Could not find application\'s .ruby-version. Consider setting opscomplete_ruby_version.'
         end
@@ -33,7 +45,7 @@ module Capistrano
       def rbenv_installable_rubies
         rbenv_installable_rubies = capture(:rbenv, :install, '--list').split("\n")
         rbenv_installable_rubies.map!(&:strip)
-        rbenv_installable_rubies.delete("Available version:")
+        rbenv_installable_rubies.delete('Available version:')
         rbenv_installable_rubies
       end
 
@@ -42,8 +54,13 @@ module Capistrano
       end
 
       def rbenv_installed_rubies
-        rbenv_installed_rubies = capture(:ls, '-1', "#{rbenv_root_path}/versions").split("\n")
-        rbenv_installed_rubies.map!(&:strip)
+        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)
+        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
     end
   end

data/lib/capistrano/opscomplete/tasks.rake

@@ -11,18 +11,18 @@ namespace :opscomplete do
   namespace :ruby do
     # desc 'Rehash rbenv shims (run this after installing executables).'
     task :rehash do
-      on roles fetch(:rbenv_roles) do
+      on roles fetch(:rbenv_roles, :all) do
         execute(:rbenv, :rehash)
       end
     end
 
     desc 'Check if rbenv global ruby is set according to application\'s .ruby-version.'
     task :check do
-      on roles fetch(:rbenv_roles) do |host|
+      on roles fetch(:rbenv_roles, :all) do |host|
         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,
-                "Ruby version is not set according to application's .ruby-version file. Use cap opscomplete:ruby:ensure."
+                "#{host}: Ruby version is not set according to application\'s .ruby-version file. Use cap opscomplete:ruby:ensure."
         end
         info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
       end
@@ -30,7 +30,7 @@ namespace :opscomplete do
 
     # desc 'Install rbenv plugin ruby-build'
     task :install_ruby_build do
-      on roles fetch(:rbenv_roles) do
+      on roles fetch(:rbenv_roles, :all) do
         next if test "[ -d #{rbenv_ruby_build_path} ]"
         execute :git, :clone, ruby_build_repo_url, rbenv_ruby_build_path
       end
@@ -38,10 +38,10 @@ namespace :opscomplete do
 
     # desc 'Update rbenv plugin ruby-build'
     task :update_ruby_build do
-      on roles fetch(:rbenv_roles) do
+      on roles fetch(:rbenv_roles, :all) do
         if test "[ -d #{rbenv_ruby_build_path} ]"
           within rbenv_ruby_build_path do
-            execute :git, :pull
+            execute :git, :pull, '-q'
           end
         else
           warn('Could not find ruby-build.')
@@ -51,46 +51,46 @@ namespace :opscomplete do
 
     # desc 'Install bundler gem'
     task :install_bundler do
-      on roles fetch(:rbenv_roles) 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')
-        invoke!('opscomplete:ruby:rehash')
+        set :rbenv_needs_rehash, true
       end
     end
 
     # desc 'Install geordi gem'
     task :install_geordi do
-      on roles fetch(:rbenv_roles) 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')
-        invoke!('opscomplete:ruby:rehash')
+        set :rbenv_needs_rehash, true
       end
     end
 
     desc 'Install and configure ruby according to applications .ruby-version.'
     task :ensure do
-      on roles fetch(:rbenv_roles) do |host|
+      on roles fetch(:rbenv_roles, :all) do |host|
         if managed_ruby
-          raise Capistrano::ValidationError, "Managed ruby environment! Won't do any changes to ruby version."
+          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.")
         else
           invoke('opscomplete:ruby:update_ruby_build')
           if rbenv_installable_rubies.include?(app_ruby_version)
-            warn('Required ruby version is not installed, but available for installation.')
-            info("Installing ruby #{app_ruby_version}.")
+            info("#{host}: Required ruby version is not installed, but available for installation.")
             execute(:rbenv, :install, app_ruby_version)
-            invoke!('opscomplete:ruby:rehash')
+            set :rbenv_needs_rehash, true
           else
             raise Capistrano::ValidationError,
-                  'Ruby version required by application is neither installed nor installable using ruby-install.'
+                  "#{host}: Ruby version required by application is neither installed nor installable using ruby-install."
           end
         end
         execute(:rbenv, :global, app_ruby_version) unless capture(:rbenv, :global) == app_ruby_version
       end
       invoke('opscomplete:ruby:install_bundler')
       invoke('opscomplete:ruby:install_geordi')
+      invoke('opscomplete:ruby:rehash') if fetch(:rbenv_needs_rehash, false)
     end
   end
 

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md