capistrano-anycable 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cadc4f5cf54bcb4c678d188e87c051ebc40938208dfe77c2f754af3a187674f
-  data.tar.gz: 3fff761445c786fbdcef23a435dc168bf3af1eaa20488a654df5ab237b1b7927
+  metadata.gz: 19e776a35ab7eac2014e216dfaed84d5ba69bc79682f01c978f07f4306bf9920
+  data.tar.gz: 73456cb12315894f6085b498504dd674a20493d4c524b1da5f03f47563d78713
 SHA512:
-  metadata.gz: 93d7c4814b2ffdfa8fffafe5438fb470c78c9924e698c5cd2a11348e1501ef57a2042dcaf2664cbfc47783e5c49c82880215c8d6f3719112d94344f363ca599a
-  data.tar.gz: 2170556b0a7835551878b7324287869bfd128fcb5092a3d1c87fea7b8702531ef1626cc870422a53dff068fc6536b59e6bebe92221b7f1d7b14b5a48ea555497
+  metadata.gz: f5317506c6b085393a803c8cd15d7e100c813ef7cee57e23865e34c7775de6e38711ee0f885e2eac48ab835f3b406069ff029d994f03420489529cae4db00473
+  data.tar.gz: 87a38c8db9dbc971d685b0feafcac45b15e656717525b6607baaa60f7b1c8538f2d7bafab4db074507420c43801accf061363bcfae023580eca14bc9063bb41e

data/README.md

@@ -1,12 +1,23 @@
+[![Gem Version](https://badge.fury.io/rb/capistrano-anycable.svg)](https://rubygems.org/gems/capistrano-anycable) [![Build Status](https://travis-ci.org/anycable/capistrano-anycable.svg?branch=master)](https://travis-ci.org/anycable/capistrano-anycable)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/#capistrano)
+
+
 # Capistrano::Anycable
 
 AnyCable integration for Capistrano.
 
+# Requirements
+
+AnyCable >= 0.6.2
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add those lines to your application's Gemfile:
 
 ```ruby
+# To run daemonized `anycabled`
+gem "daemons", "~> 1.3", require: false
+
 gem "capistrano-anycable", group: :development
 ```
 
@@ -23,7 +34,29 @@ $ bundle
 require "capistrano/anycable"
 ```
 
-TBD
+## Configuration
+
+Available configuration options (with defaults):
+
+```ruby
+# Restart AnyCable after `deploy:restart` phase
+set :anycable_default_hooks, true
+
+# Capistrano roles to start AnyCable on
+set :anycable_roles, :app
+# Path to the root of your application
+set :anycable_path, -> { release_path }
+# Command to start AnyCable
+set :anycable_command, -> { [:bundle, :exec, :anycabled] }
+
+# Sets RAILS_ENV for AnyCable process
+set :anycable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+# AnyCable configuration parameters passed through enviroment,
+# see https://docs.anycable.io/#/ruby/configuration?id=parameters
+set :anycable_environment_variables, {}
+# Path to anycable.yml
+set :anycable_conf, nil
+```
 
 ## Contributing
 

data/lib/capistrano/anycable.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "capistrano/anycable/version"
+load File.expand_path("../tasks/anycable.rake", __FILE__)

data/lib/capistrano/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module AnyCable
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/capistrano/tasks/anycable.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :anycable_default_hooks, true
+
+    set :anycable_roles, :app
+    set :anycable_path, -> { release_path }
+    set :anycable_command, -> { [:bundle, :exec, :anycabled] }
+
+    set :anycable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+    set :anycable_environment_variables, {}
+    set :anycable_conf, nil
+
+    # For internal use only
+    set :_anycable_environment, -> do
+      fetch(:default_env).merge(fetch(:anycable_environment_variables)).merge(
+        {
+          rails_env: fetch(:anycable_env),
+          anycable_conf: fetch(:anycable_conf)
+        }.compact
+      )
+    end
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_anycable_hooks do
+    invoke "anycable:add_default_hooks" if fetch(:anycable_default_hooks)
+  end
+end
+
+namespace :anycable do
+  task :add_default_hooks do
+    after "deploy:restart", "anycable:restart"
+  end
+
+  desc "Start anycable process"
+  task :start do
+    anycabled :start
+  end
+
+  desc "Stop anycable process"
+  task :stop do
+    anycabled :stop
+  end
+
+  desc "Restart anycable process"
+  task :restart do
+    anycabled :restart
+  end
+
+  def anycabled(command)
+    on roles fetch(:anycable_roles) do
+      within fetch(:anycable_path) do
+        with fetch(:_anycable_environment) do
+          execute(*fetch(:anycable_command), command)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-anycable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sergey Ponomarev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,8 +89,10 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/capistrano-anycable.rb
 - lib/capistrano/anycable.rb
 - lib/capistrano/anycable/version.rb
+- lib/capistrano/tasks/anycable.rake
 homepage: http://github.com/anycable/capistrano-anycable
 licenses:
 - MIT
@@ -110,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: AnyCable integration for Capistrano