california 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9adb6fd666b3eabfd3b9bd6c4da5dd419c3f06b5
+  data.tar.gz: ff63ffad385ad07dd09c421c05babc3140aa44e6
+SHA512:
+  metadata.gz: dd60f30690bc3442ce3ad810c5df6295c69ed69cc89410d69f80d73f17abb18d816078d08cbddf510694fd33167858004aa5847cf4c7cae5506e90a4bc54958d
+  data.tar.gz: fd9fbae30bdcce5eb55436f738634d759cf9a66aa34a47a869f1daabad874af6ab7b134ec4c96788b2ad9017a08082aca6819c3b4f5067f132a3405e3b0c2359

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2015 halo
+
+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,57 @@
+## Opinionated capistrano deployment for dummies Edit
+
+[![Build Status](https://travis-ci.org/halo/california.svg?branch=master)](https://travis-ci.org/halo/california)
+
+### Requirements
+
+* Ruby >= 2.0
+* Bundler
+
+### Installation
+
+Create a new repository with a Gemfile like this and run `bundle install` to get the california gem.
+
+```ruby
+# Content of Gemfile
+source 'https://rubygems.org'
+
+gem 'california', github: 'halo/california'
+```
+
+Then run the generator for creating your first app you may want to deploy.
+Let's say the name of the app is "hello_world".
+
+```ruby
+# Inside the directory of your newly created repository
+bundle exec california generate hello_world
+```
+
+Modify `hello_world/deploy/production.rb` (or whichever stages you have) and define which servers you want to deploy to.
+
+### Server preparation
+
+When deploying your `hello_world` app, it is assumed that you can ssh into the server with the user `hello_world` and that the repository has been cloned to `/mnt/apps/hello_world/repository`.
+
+Any additional environment variables needed to configure your application should be located in a file called `/mnt/envs/hello_world`.
+
+```bash
+# Example of content of /mnt/envs/hello_world
+SECRET_TOKEN="abcdef"
+DATABASE_URL="postgres://db.example.com"
+```
+
+### Deployment
+
+Essentially you just run vanilla capistrano 3 commands from inside the respective application directory.
+
+```ruby
+cd hello_world
+
+# Examples:
+bundle exec cap staging deploy
+bundle exec cap production deploy migrate=true
+```
+
+### Copyright
+
+MIT 2016 halo. See [MIT-LICENSE](http://github.com/halo/california/blob/master/MIT-LICENSE).

data/bin/california

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/california/cli'
+
+California::Cli.start ARGV

data/lib/california/capfile.rb

@@ -0,0 +1,10 @@
+require 'pathname'
+require 'capistrano/setup'
+require 'capistrano/framework'
+
+require 'capistrano/scm/plugin'
+# No-op to tell capistrano that we don't want any SCM hooks to be loaded
+install_plugin Capistrano::SCM::Plugin
+
+load 'california/capistrano/tasks/deploy.rake'
+load 'california/capistrano/tasks/rails.rake'

data/lib/california/capistrano/tasks/deploy.rake

@@ -0,0 +1,116 @@
+# The basic capistrano framework provides us with a certain order of tasks when you run "rake deploy".
+# See https://github.com/capistrano/capistrano/blob/master/lib/capistrano/tasks/framework.rake
+# In the code below we hook in into those tasks provided by the deploy framework.
+
+namespace :deploy do
+
+  # –––––––––––––––––
+  # Updating the code
+  # –––––––––––––––––
+
+  task :updating do
+    logger.info 'Updating the repository...'
+
+    on roles :app do
+      as fetch(:application) do
+        within fetch(:deploy_to) do
+
+          # Remembering which revision we had before making any changes.
+          set :previous_revision, capture(:git, 'rev-parse', 'HEAD')
+
+          # Updating the code.
+          execute :git, :reset, '--hard'
+          execute :git, :fetch, :origin
+          execute :git, :checkout, '--force', "origin/#{fetch(:branch)}"
+
+          # The update went well so let's persist the revision change.
+          # Note: We use ruby because there is no bash command that can write to files *without I/O redirection*.
+          set :current_revision, capture(:git, 'rev-parse', 'HEAD')
+          execute :ruby, '-e', %("File.write :REVISION.to_s,      %|#{fetch(:current_revision)}|"  )
+          execute :ruby, '-e', %("File.write :PREV_REVISION.to_s, %|#{fetch(:previous_revision)}|" )
+          execute :ruby, '-e', %("File.write :BRANCH.to_s,        %|#{fetch(:branch)}|"            )
+        end
+      end
+    end
+  end
+
+  # ––––––––––––––
+  # Set robots.txt
+  # ––––––––––––––
+
+  desc 'Disallow robots unless deploying to production.'
+  task :disallow_robots do
+    next if fetch(:stage).to_s == 'production'
+    logger.info "Overriding robots.txt for environment #{fetch(:stage)}..."
+
+    on roles :app do
+      as fetch(:application) do
+        within File.join(fetch(:deploy_to), 'public') do
+          execute :echo, %("User-agent: *\nDisallow: /\n" > robots.txt)
+        end
+      end
+    end
+  end
+
+  # –––––––––––––––
+  # Running Bundler
+  # –––––––––––––––
+
+  task :updated do
+    logger.info 'Running Bundler...'
+
+    on roles :app do
+      as fetch(:application) do
+        within fetch(:deploy_to) do
+
+          # Running Bundler.
+          core_count = capture(:nproc).chomp
+          execute :bundle, :install, '--deployment', '--quiet', '--without', 'development', 'test', '--jobs', core_count
+        end
+      end
+    end
+  end
+
+  # ––––––––––––––––––
+  # Restarting the app
+  # ––––––––––––––––––
+
+  task :publishing do
+    logger.info 'Restarting the app...'
+
+    on roles :app do
+      as fetch(:application) do
+        within File.join(fetch(:deploy_to), 'tmp') do
+
+          execute :touch, 'restart.txt'
+        end
+      end
+    end
+  end
+
+  # ––––––––––––––––––––––––––
+  # Persisting the deploy time
+  # ––––––––––––––––––––––––––
+
+  task :finishing do
+    logger.info 'Persisting the deploy time...'
+
+    on roles :app do
+      as fetch(:application) do
+        within fetch(:deploy_to) do
+
+          execute :ruby, '-e', %("File.write :DEPLOYED_AT.to_s, Time.now")
+        end
+      end
+    end
+  end
+
+  task :finished do
+    logger.info 'Congratulations! ¯\_(ツ)_/¯'
+  end
+
+  task :failed do
+    logger.info 'Oh no, the deployment failed'
+  end
+
+end

data/lib/california/capistrano/tasks/rails.rake

@@ -0,0 +1,32 @@
+namespace :rails do
+
+  namespace :assets do
+    task :precompile do
+      logger.info 'Precompiling assets on all web servers...'
+
+      on roles :web_server do
+        as fetch(:application) do
+          within fetch(:deploy_to) do
+            execute :bundle, :exec, :rake, 'assets:precompile'
+          end
+        end
+      end
+    end
+  end
+
+  task :migrate do
+    on primary :migrator do
+      as fetch(:application) do
+        if fetch(:migrate)
+          within fetch(:deploy_to) do
+            logger.info 'Migrating the database...'
+            execute :bundle, :exec, :rake, 'db:migrate'
+          end
+        else
+          logger.warn 'Skipping Rails migrations because you did NOT add this to your cap command: migrate=true'
+        end
+      end
+    end
+  end
+
+end

data/lib/california/cli.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+module California
+  class Cli < Thor
+    include Thor::Actions
+
+    desc 'generate APPNAME', 'Generates the skeleton for a new app'
+
+    def generate(appname)
+      template 'templates/app/Capfile', "#{appname}/Capfile"
+      template 'templates/app/config/deploy.rb', "#{appname}/config/deploy.rb"
+      template 'templates/app/config/deploy/stage.rb', "#{appname}/config/deploy/staging.rb"
+      template 'templates/app/config/deploy/stage.rb', "#{appname}/config/deploy/production.rb"
+    end
+
+    def self.source_root
+      File.dirname __FILE__
+    end
+
+  end
+end

data/lib/california/stage

@@ -0,0 +1,2 @@
+# Wrapper so you can call `load 'california/stage` without `.rb` extension
+load 'california/stage.rb'

data/lib/california/stage.rb

@@ -0,0 +1,100 @@
+module BenderLogger
+  def self.logger
+    @logger ||= logger!
+  end
+
+  def self.logger!
+    instance = ::Logger.new STDOUT
+    instance.formatter = proc do |_, _, _, msg|
+      line = '–' * (msg.size + 2)
+      [nil, line, " #{msg}", line, nil].join("\n") + "\n"
+    end
+    instance
+  end
+
+end
+
+def logger
+  BenderLogger.logger
+end
+
+# Rails environment sanity check.
+if fetch(:rails_env)
+  raise 'Please refrain from setting the :rails_env parameter. We use :rack_env instead.'
+end
+
+# We derive the environment from the stage name.
+set :rack_env, 'production' if fetch(:stage).to_s.include?('production')
+set :rack_env, 'staging' if fetch(:stage).to_s.include?('staging')
+set :rack_env, 'test' if fetch(:stage).to_s.include?('test')
+
+# Rack environment sanity check.
+unless %w[test staging production].include? fetch(:rack_env)
+  raise "#{fetch(:rack_env).inspect} does not seem to be a valid Rails environment."
+end
+
+# Making sure we set the right environment in every context.
+fetch(:default_env)[:rack_env] = fetch(:rack_env)
+fetch(:default_env)[:rails_env] = fetch(:rack_env)
+
+# Unlike "normal" capistrano, we deploy right into the repository.
+set :deploy_to, "/mnt/apps/#{fetch(:application)}/repository"
+# Alias for cap task that use release_path
+set(:release_path, -> { fetch(:deploy_to) })
+
+# The branch can be set in various ways, default is master.
+set :branch, ENV['branch'] || ENV['BRANCH'] || fetch(:branch, :master)
+
+# Keep track of whether we should run migrations or not.
+# We do this to get rid of the overhead of maintaining a separate "migrations" task.
+set :migrate, ENV['migrate'] || ENV['MIGRATE'] || fetch(:migrate, false)
+
+# Branch sanity check
+in_production = fetch(:rack_env).to_s.downcase == 'production'
+non_master_branch = fetch(:branch).to_s.downcase != 'master'
+
+if in_production && non_master_branch && ENV['i_dont_know_what_im_doing'] != 'true'
+  message = "You are courageous, trying to deploy the branch #{fetch(:branch).inspect} to production.\n"
+  message += "If you know what you're doing you can bypass this warning \
+    by adding this to your cap command: i_dont_know_what_im_doing=true"
+  raise message
+end
+
+module SSHKit
+  class Command
+    # Define $HOME to be in /mnt/apps/USERNAME
+    # Add ~/bin to $PATH
+    # Source any existing .bash_profile in the home directory
+    def user
+      return yield unless options[:user]
+      %(sudo -u #{options[:user]} #{environment_string} -- bash -c '\
+        export HOME=/mnt/apps/#{options[:user]}; \
+        export PATH="$HOME/bin:$PATH"; \
+        source $HOME/.bash_profile; \
+        #{yield.to_s.gsub("'", %q('"'"'))}')
+    end
+  end
+
+  class CommandMap
+    def defaults
+      Hash.new do |hash, command|
+        # Avoid using `/usr/bin/env` at all
+        hash[command] = command.to_s
+      end
+    end
+  end
+end
+
+module Capistrano
+  class Configuration
+    class Server < SSHKit::Host
+      class Properties
+
+        # Making the properties indifferent to symbol/string keys.
+        def fetch(key)
+          @properties[key] || @properties[key.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/california/templates/app/Capfile

@@ -0,0 +1,2 @@
+# You can run `cap` commands in directories that have a `Capfile`.
+require 'california/capfile'

data/lib/california/templates/app/config/deploy.rb

@@ -0,0 +1,8 @@
+set :application, File.basename(File.expand_path('../..', __FILE__))
+
+# Disallow robots unless deploying to production.
+after 'deploy:updated', 'deploy:disallow_robots'
+
+# For Rails you should uncomment these custom task hooks.
+# after 'deploy:updated', 'rails:assets:precompile'
+# after 'deploy:updated', 'rails:migrate'

data/lib/california/templates/app/config/deploy/stage.rb

@@ -0,0 +1,17 @@
+# The stage name is derived from this very filename,
+# which should include "production", "staging", or "test" in its name.
+set :stage, File.basename(__FILE__, '.rb')
+
+# Loading task defaults.
+load 'california/stage'
+
+# You need to define at least one server.
+# The one with the role "migrator" will be entitled to run migrations:
+# server '203.0.113.19', roles: %w{ all app web_server migrator }
+
+# You may also set any custom Capistrano options:
+# set :ssh_options, {
+#   forward_agent: true,
+#   port: 12345,
+#   keys: Pathname.new('~/.ssh/mykey').expand_path.to_s,
+# }

data/lib/california/version.rb

@@ -0,0 +1,3 @@
+module California
+  VERSION = '0.4.1'.freeze
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: california
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- halo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard-rspec
+  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: rb-fsevent
+  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: 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'
+description: See https://github.com/halo/california
+email: 
+executables:
+- california
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- bin/california
+- lib/california/capfile.rb
+- lib/california/capistrano/tasks/deploy.rake
+- lib/california/capistrano/tasks/rails.rake
+- lib/california/cli.rb
+- lib/california/stage
+- lib/california/stage.rb
+- lib/california/templates/app/Capfile
+- lib/california/templates/app/config/deploy.rb
+- lib/california/templates/app/config/deploy/stage.rb
+- lib/california/version.rb
+homepage: https://github.com/halo/california
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Capistrano 3 for dummies.
+test_files: []