capistrano-spa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33e81a7627dc79c0c3e40d41b17d307958996a30
+  data.tar.gz: 62df7aea1a418e6ba9b1cbfca7c9c9e87c7793eb
+SHA512:
+  metadata.gz: a743db04e9d1656bdf090ca64ab5465a3308e30c0324cb1e5fbb8a4b42cc698b67d81b9e3446c0d4242eb4f92d69386e08b4b1404704e9bda6205886a12ab4cc
+  data.tar.gz: be66fb55246bb9cdbbbc20c26c564e57105d7cf89e7a4003c1aed5bc7d9bea7564a9aab54ed319182b8aa810f604d936838b998535acdbc0820ce48630145a16

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Efigence
+
+MIT License
+
+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,69 @@
+# Capistrano::SPA
+
+Want to deploy a single-page-application (which uses your rails api) along with your rails backend?
+
+#### Requirements
+
+* using capistrano v3
+* keeping front-end app in separate repository
+* not keeping `public` directory inside your rails app repository
+
+#### Installation
+
+1. Add to Gemfile: `gem "capistrano-spa"`
+2. Require in Capfile: `require 'capistrano/spa'`
+
+#### Usage
+
+Preferred way is to use it with [capistrano rsync](https://github.com/Bladrak/capistrano-rsync) extension.
+
+Task `spa:all` consists of 4 tasks:
+
+1. `spa:create_cache` - clones your SPA app into `YOUR_RAILS_APP/tmp` (or other dir of your choice)
+2. `spa:update_cache` - updates spa cache dir, if already been cloned
+3. `spa:build`: builds the SPA app with command you've passed (defaults to `yarn install && yarn build`)
+4. `spa:copy_to_rsync_dir`: copies the built package (that usually means `dist`) into the `public` folder of rsync cache directory of your Rails application
+
+You need to call the Capistrano task provided by this gem by yourself (this way you can call it anytime you need - depending on your deploy strategy). If you're using `capistrano-rsync`, then proper way to do it is after rails rsync cache dir has been prepared - it's going to append content of SPA app into `public` dir just before it's rsync'ed to server.
+
+`after 'rsync:stage_done', 'spa:all'`
+
+If you need asset pipeline's assets on production, then it's advised to precompile then locally just after running `spa:all`. This way rails assets will get appended to public folder before rsync'ing data to server. As an alternative to `capistrano/rails/migrations`, you can do it like:
+
+    # Precompile webpack assets locally
+    namespace :assets do
+      task :compile do
+        run_locally do
+          with rails_env: fetch(:stage) do
+            Dir.chdir fetch(:rsync_stage) do
+              execute 'cp config/database.dev.yml config/database.yml'
+              execute :bundle, 'exec bin/rails assets:precompile'
+            end
+          end
+        end
+      end
+    end
+
+    after 'spa:all', 'assets:compile'
+
+#### Configuration
+
+* `:spa_repo_url` - required
+* `:spa_cache_dir`, defaults to: `tmp/spa`
+* `:spa_branch`, , defaults to: `master`
+* `:spa_build_dir`, defaults to: `dist`
+* `:spa_git_remote`, defaults to: `origin`
+* `:rsync_cache_dir`, default to `tmp/deploy`
+* `:spa_build_cmds`, default to: `[[:yarn, "install"], [:yarn, "build"]]`
+
+#### Notes
+
+If you don't want to use rsync strategy for your rails app, you can skip the last task (`spa:copy_to_rsync_dir`) and move the SPA build to the server by yourself in anyway you like it.
+
+Also, depending on your `apache/nginx` server config, `index.html` file might be served automatically, or if it's not on static files whitelist you can either add it to the list or serve `index.html` from controller, like:
+
+    root "welcome#index"
+
+    def index
+      render file: 'public/index.html', layout: false
+    end    

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+# Do nothing by default
+task :default

data/capistrano-spa.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-spa"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jacek Grzybowski"]
+  gem.email         = ["jacek213@gmail.com"]
+  gem.description   = %q{Capistrano tasks for Single Page Apps deployment}
+  gem.summary       = %q{Capistrano tasks for Single Page Apps deployment}
+  gem.homepage      = "https://github.com/efigence/capistrano-spa"
+
+  gem.licenses      = ["MIT"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '~> 3.1'
+  gem.add_dependency 'capistrano-bundler', '~> 1.1'
+end

data/lib/capistrano/spa.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/spa.rake", __FILE__)

data/lib/capistrano/tasks/spa.rake

@@ -0,0 +1,65 @@
+namespace :load do
+  task :defaults do
+    set :spa_cache_dir, "tmp/spa"
+    set :spa_branch, "master"
+    set :spa_build_dir, "dist"
+    set :spa_git_remote, "origin"
+    set :rsync_cache_dir, fetch(:rsync_stage, "tmp/deploy")
+    set :spa_build_cmds, [
+      [:yarn, "install"],
+      [:yarn, "build"],
+    ]
+    set :spa_repo_url, -> { raise Capistrano::ValidationError, "spa_repo_url param is required!" }
+  end
+end
+
+namespace :spa do
+  desc 'Clone SPA repository to cache dir, unless exists already'
+  task :create_cache do
+    next if File.directory?(fetch(:spa_cache_dir))
+
+    run_locally do
+       execute :git,
+        :clone,
+        fetch(:spa_repo_url),
+        fetch(:spa_cache_dir),
+        '--quiet --depth=1 --no-single-branch'
+    end
+  end
+
+  desc 'Pull latest changes into SPA cache dir'
+  task :update_cache do
+    target = "#{fetch(:spa_git_remote)}/#{fetch(:spa_branch)}"
+    run_locally do
+      within fetch(:spa_cache_dir) do
+        execute :git, :fetch, '--quiet --all --prune --depth=1'
+        execute :git, :checkout, fetch(:spa_branch), '--quiet'
+        execute :git, :reset, target, '--hard'
+      end
+    end
+  end
+
+  desc 'Build SPA application'
+  task :build do
+    run_locally do
+      within fetch(:spa_cache_dir) do
+        fetch(:spa_build_cmds).each do |cmd|
+          execute *cmd
+        end
+      end
+    end
+  end
+
+  desc 'Copy files to local rsync cache dir'
+  task :copy_to_rsync_dir do
+    destination_dir = "#{fetch(:rsync_cache_dir)}/public"
+    build_dir = "#{fetch(:spa_cache_dir)}/#{fetch(:spa_build_dir)}"
+
+    run_locally do
+      execute :rm, '-rf', destination_dir
+      execute :cp, '-r', build_dir, destination_dir
+    end
+  end
+
+  task :all => [:create_cache, :update_cache, :build, :copy_to_rsync_dir]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-spa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacek Grzybowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-30 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: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Capistrano tasks for Single Page Apps deployment
+email:
+- jacek213@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-spa.gemspec
+- lib/capistrano-spa.rb
+- lib/capistrano/spa.rb
+- lib/capistrano/tasks/spa.rake
+homepage: https://github.com/efigence/capistrano-spa
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for Single Page Apps deployment
+test_files: []