locum-best-practices 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37dbd568428a0a7db41755ce105508feeddf3e33
+  data.tar.gz: ad8eb844d10781ba5f27927f9ca4777e8542f3f4
+SHA512:
+  metadata.gz: acfd99e1207a6eb9c9103a504ed100a96503b944c29a7395fdaef20d3318f69f6b89e774e06bc5545e667a4f30fdefad896719e13a587865791af43fa03a3bc1
+  data.tar.gz: a48875099928ceb685b041dda9fc79bbc718a98c1d0c480faa56574843db34b24e79ab455b0d39b1a62e5a0088719ee93c930256502ed0c6b4e09f39698f6a89

data/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.*
+!/.editorconfig
+!/.gitignore
+!/.rubocop.yml
+.idea/
+doc/

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - db/**/*
+  RunRailsCops: true
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 25
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 25

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Locum::Best::Practices
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/locum/best/practices`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locum-best-practices'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locum-best-practices
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/locum-best-practices. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,12 @@
+ßrequire "bundler/setup"
+require "locum_best_practices"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/capistrano/locum.rb

@@ -0,0 +1,5 @@
+require 'capistrano/locum/defaults'
+require 'capistrano/locum/assets'
+require 'capistrano/locum/remote'
+require 'capistrano/locum/sidekiq'
+require 'capistrano/locum/ssh'

data/lib/capistrano/locum/assets.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/assets.cap', __FILE__)

data/lib/capistrano/locum/defaults.rb

@@ -0,0 +1,40 @@
+namespace :load do
+  task :defaults do
+    lock '3.4.0'
+    load "config/deploy.rb"
+    load "config/deploy/#{fetch(:stage)}.rb"
+
+    set :deploy_to,             "/home/#{fetch(:user)}/projects/#{fetch(:application)}"
+    set :unicorn_config_path,   "/etc/unicorn/#{fetch(:application)}.#{fetch(:login)}.rb"
+    set :unicorn_pid,           "/var/run/unicorn/#{fetch(:user)}/#{fetch(:application)}.#{fetch(:login)}.pid"
+    set :sidekiq_pid,           "#{fetch(:deploy_to)}/shared/tmp/pids/sidekiq-0.pid"
+    set :bundle_without,        [:development, :test, :console, :doc]
+    set :use_sudo,              false
+
+    ask :branch,                proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+
+    set :scm,                   :git
+    set :format,                :pretty
+    set :pty,                   true
+
+    set :log_level,             :info
+    set :keep_releases,         5
+    set :env, worker_count:     8
+
+    set :linked_files,          fetch(:linked_files, []) + %w(config/database.yml config/application.yml config/newrelic.yml)
+    set :linked_dirs,           fetch(:linked_dirs, []) + %w(bin log tmp/cache tmp/pids tmp/sockets vendor/bundle public/system)
+
+    set :default_environments,  'RAILS_ENV=production'
+    set :production_rake,       "rvm use #{fetch(:rvm_ruby_version)} do bundle exec rake #{fetch(:default_environments)}"
+    set :rake,                  "rvm use #{fetch(:rvm_ruby_version)} do bundle exec rake"
+    set :bundle_cmd,            "rvm use #{fetch(:rvm_ruby_version)} do bundle"
+
+    set :assets_roles,          [:web, :app, :db]
+
+    set :sidekiq_start_cmd,     "cd #{fetch(:deploy_to)}/current; #{fetch(:bundle_cmd)} exec sidekiq " \
+                                '--index 0 -C config/sidekiq.yml --environment production --daemon'
+    set :sidekiq_stop_cmd,      "kill -QUIT `cat #{fetch(:sidekiq_pid)}`"
+
+    after 'deploy:publishing',  'unicorn:restart'
+  end
+end

data/lib/capistrano/locum/remote.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/remote.cap', __FILE__)

data/lib/capistrano/locum/sidekiq.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/sidekiq.cap', __FILE__)

data/lib/capistrano/locum/ssh.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/ssh.cap', __FILE__)

data/lib/capistrano/tasks/assets.cap

@@ -0,0 +1,22 @@
+namespace :assets do
+  desc 'Assets precompile'
+  task :compile do
+    on roles(:app, :web, :db) do
+      execute "cd #{fetch(:deploy_to)}/current; #{fetch(:production_rake)} assets:precompile"
+    end
+  end
+
+  desc 'Assets clear'
+  task :clear do
+    on roles(:app, :wev, :db) do
+      execute "cd #{fetch(:deploy_to)}/current; #{fetch(:production_rake)} assets:clean"
+    end
+  end
+
+  desc 'Assets nuke'
+  task :nuke do
+    on roles(:app, :wev, :db) do
+      execute "cd #{fetch(:deploy_to)}/current; #{fetch(:production_rake)} assets:clobber"
+    end
+  end
+end

data/lib/capistrano/tasks/remote.cap

@@ -0,0 +1,15 @@
+namespace :remote do
+  # TODO: move comments to README
+  # e.g: 'cap stage logs:tail[logfile]' will tail 'shared_path/log/logfile.log'.
+  desc 'Tail logs on remote host'
+  task :logs, :file do |_t, args|
+    on roles(:app) do |server|
+      info "Opening a console on: #{server} ..."
+      params = "#{fetch(:user)}@#{server}"
+      file = "#{args[:file] || fetch(:rails_env)}"
+      params += %( -t "tail -f #{fetch(:deploy_to)}/shared/log/#{file}.log")
+      info "Read logs for user: #{fetch(:user)}"
+      exec "ssh #{params}"
+    end
+  end
+end

data/lib/capistrano/tasks/sidekiq.cap

@@ -0,0 +1,24 @@
+namespace :sidekiq do
+  desc 'Sidekiq start'
+  task :start do
+    on roles(:app, :web) do
+      execute "#{fetch(:sidekiq_start_cmd)}"
+    end
+  end
+
+  desc 'Sidekiq Stop'
+  task :stop do
+    on roles(:app, :web) do
+      execute "#{fetch(:sidekiq_stop_cmd)}"
+    end
+  end
+
+  desc 'Sidekiq restart'
+  task :restart do
+    on roles(:app, :web) do
+      execute "#{fetch(:sidekiq_stop_cmd)}; sleep 5; #{fetch(:sidekiq_start_cmd)}"
+    end
+  end
+
+  after 'unicorn:restart', 'sidekiq:restart'
+end

data/lib/capistrano/tasks/ssh.cap

@@ -0,0 +1,17 @@
+namespace :ssh do
+  desc 'SSH connect and move to current folder'
+  task :connect do
+    on roles(:app) do |server|
+      server_index = ARGV[2].to_i
+
+      return if server != roles(:app)[server_index]
+
+      info "Opening a console on: #{server} ..."
+      params = "#{fetch(:user)}@#{server}"
+      params += " -p #{server.port}" if server.port
+      params += %( -t "cd projects/#{fetch(:application)}/current && bash -l")
+      info "Connection success for user: #{fetch(:user)}"
+      exec "ssh #{params}"
+    end
+  end
+end

data/lib/generators/locum/deploy_generator.rb

@@ -0,0 +1,21 @@
+module Locum
+  class DeployGenerator < Rails::Generators::Base
+    desc <<-EOF
+Prepares application to deploy and add custom stages. `testing` and `production` stages are created by default.
+    EOF
+
+    argument :stages, type: :array, default: [], banner: 'custom stages'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_deploy_templates
+      directory 'deploy', '.'
+    end
+
+    def create_custom_stages
+      stages.each do |stage|
+        template 'deploy/config/deploy/testing.rb.tt', "config/deploy/#{stage}.rb"
+        template 'deploy/config/environments/testing.rb.tt', "config/environments/#{stage}.rb"
+      end
+    end
+  end
+end

data/lib/generators/locum/templates/deploy/Capfile.tt

@@ -0,0 +1,11 @@
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/rvm'
+require 'capistrano/rails'
+require 'capistrano/bundler'
+require 'capistrano/rails/migrations'
+require 'capistrano/rails/assets'
+require 'capistrano3/unicorn'
+require 'capistrano/locum'
+
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/lib/generators/locum/templates/deploy/config/deploy.rb.tt

@@ -0,0 +1,4 @@
+set :user,              'your_ssh_user'
+set :login,             'your_locum_login'
+set :rvm_ruby_version,  'your_ruby_version'
+set :repo_url,          'git@bitbucket.org:DCStudio/your_application_name'

data/lib/generators/locum/templates/deploy/config/deploy/production.rb.tt

@@ -0,0 +1,8 @@
+set :application, 'your_application_name'
+set :rails_env,   :production
+set :ssh_options, forward_agent: true
+
+server 'production-host.domain',
+       roles:   %w(web app db),
+       primary: true,
+       user:    fetch(:user)

data/lib/generators/locum/templates/deploy/config/deploy/testing.rb.tt

@@ -0,0 +1,10 @@
+set :application,       'your_application_name'
+set :rails_env,         :testing
+set :keep_releases,     3
+set :env, worker_count: 4
+set :ssh_options, forward_agent: true
+
+server 'testing-host.domain',
+       roles:   %w(web app db),
+       primary: true,
+       user:    fetch(:user)

data/lib/locum-best-pratices.rb

@@ -0,0 +1,2 @@
+module LocumBestPractices
+end

data/lib/locum_best_practices/version.rb

@@ -0,0 +1,3 @@
+module LocumBestPractices
+  VERSION = '0.2'
+end

data/locum-best-practices.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locum_best_practices/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'locum-best-practices'
+  spec.version       = LocumBestPractices::VERSION
+  spec.authors       = %w(DarkWater)
+  spec.email         = %w(darkwater666@mail.ru)
+
+  spec.summary       = 'Simple best practices, used for soft deployment to locum hosting'
+  spec.description   = 'Contains deploy configuration'
+  spec.homepage      = 'http://darkcreative-studio.ru'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)/) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe/) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'redcarpet', '~> 1.17'
+  spec.add_development_dependency 'yard', '~> 0.7.5'
+
+  spec.add_dependency 'capistrano', '~> 3.4.0'
+  spec.add_dependency 'capistrano-rails', '~> 1.1'
+  spec.add_dependency 'capistrano-rvm'
+  spec.add_dependency 'capistrano3-unicorn'
+
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: locum-best-practices
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- DarkWater
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: capistrano-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: capistrano-rvm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano3-unicorn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: Contains deploy configuration
+email:
+- darkwater666@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/capistrano/locum.rb
+- lib/capistrano/locum/assets.rb
+- lib/capistrano/locum/defaults.rb
+- lib/capistrano/locum/remote.rb
+- lib/capistrano/locum/sidekiq.rb
+- lib/capistrano/locum/ssh.rb
+- lib/capistrano/tasks/assets.cap
+- lib/capistrano/tasks/remote.cap
+- lib/capistrano/tasks/sidekiq.cap
+- lib/capistrano/tasks/ssh.cap
+- lib/generators/locum/deploy_generator.rb
+- lib/generators/locum/templates/deploy/Capfile.tt
+- lib/generators/locum/templates/deploy/config/deploy.rb.tt
+- lib/generators/locum/templates/deploy/config/deploy/production.rb.tt
+- lib/generators/locum/templates/deploy/config/deploy/testing.rb.tt
+- lib/locum-best-pratices.rb
+- lib/locum_best_practices/version.rb
+- locum-best-practices.gemspec
+homepage: http://darkcreative-studio.ru
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple best practices, used for soft deployment to locum hosting
+test_files: []
+has_rdoc: