capistrano-database-yml 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81e5035d9d8bcfc7aa939e7998b3951831afd974
+  data.tar.gz: 446cef3b8d633c68f8645e05994a9fadc3f33273
+SHA512:
+  metadata.gz: d94a3bb350f08425f74e66f5985980f6ba8552763b1a12315e7ffa985fb429d7b6b6d9639ede18f9895bdcd6723708c568bd89524697854ab7e3032a714405d9
+  data.tar.gz: 8123784d09b9b52165036b8a5833768eb5302e3eb75dd4aefaea966307f773814cc1f739a805f7dc83c36e5210b57c1f1cf15095ba052be07f42850d5999330a

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    capistrano-database-yml (1.0.1)
+      capistrano (>= 3.1)
+      sshkit (>= 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.0.2)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.5.0)
+      airbrussh (>= 1.0.0)
+      capistrano-harrow
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-harrow (0.5.2)
+    i18n (0.7.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.2.0)
+    rake (11.2.2)
+    sshkit (1.11.1)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-database-yml!
+  rake
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2014 Bruno Sutic
+
+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,92 @@
+# Capistrano::DatabaseYml
+
+Capistrano tasks for handling `database.yml` when deploying Rails 4+ apps.
+This is a slightly modified clone of [capistrano-secrets-yml](https://github.com/capistrano-plugins/capistrano-secrets-yml).
+
+### Install
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-database-yml', '~> 1.0.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+- make sure your local `config/database.yml` is not git tracked. It **should be on
+  the disk**, but gitignored.
+
+- populate production database in local `config/database.yml`:
+
+        production:
+          adapter: mysql2
+
+- add to `Capfile`:
+
+        require 'capistrano/database_yml'
+
+- create `database.yml` file on the remote server by executing this task:
+
+        $ bundle exec cap production setup
+
+You can now proceed with other deployment tasks.
+
+#### What if a new config is added to database file?
+
+- add it to local `config/database.yml`:
+
+        production:
+          adapter: mysql2
+          foobar: some_other_config
+
+- if you're working in a team where other people have the deploy rights, compare
+  you local `database.yml` with the one on the server. This is to ensure you
+  didn't miss an update.
+- copy to the server:
+
+        $ bundle exec cap production setup
+
+- notify your colleagues that have the deploy rights that the remote
+  `database.yml` has been updated so they can change their copy.
+
+### How it works
+
+When you execute `$ bundle exec production setup`:
+
+- database from your local `database.yml` are copied to the server.<br/>
+- only "stage" database are copied: if you are deploying to `production`,
+  only production database are copied there
+- on the server database file is located  in `#{shared_path}/config/database.yml`
+
+On deployment:
+
+- database file is automatically symlinked to `#{current_path}/config/database.yml`
+
+### Configuration
+
+None.
+
+### More Capistrano automation?
+
+Check out [capistrano-plugins](https://github.com/capistrano-plugins) github org.
+
+### FAQ
+
+- shouldn't we be keeping configuration in environment variables as per
+  [12 factor app rules](http://12factor.net/config)?
+
+  On Heroku, yes.<br/>
+  With Capistrano, those env vars still have to be written somewhere on the disk
+  and used with a tool like [dotenv](https://github.com/bkeepers/dotenv).
+
+  Since we have to keep configuration on the disk anyway, it probably makes
+  sense to use Rails 4 built-in `database.yml` mechanism.
+
+### License
+
+[MIT](LICENSE.md)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-database-yml.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/database_yml/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-database-yml"
+  gem.version       = Capistrano::DatabaseYml::VERSION
+  gem.authors       = ["Shimpei Otsubo"]
+  gem.email         = ["potsbo@gmail.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, "")
+    Capistrano tasks for automating `database.yml` file handling for Rails 4+ apps.
+
+    This plugins syncs contents of your local database file and copies that to
+    the remote server.
+  EOF
+  gem.summary       = "Capistrano tasks for automating `database.yml` file handling for Rails 4+ apps."
+  gem.homepage      = "https://github.com/capistrano-plugins/capistrano-database-yml"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", ">= 3.1"
+  gem.add_dependency "sshkit", ">= 1.2.0"
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/database_yml.rb

@@ -0,0 +1,3 @@
+require "capistrano/database_yml/paths"
+require "capistrano/database_yml/helpers"
+load File.expand_path("../tasks/database_yml.rake", __FILE__)

data/lib/capistrano/database_yml/helpers.rb

@@ -0,0 +1,50 @@
+require "yaml"
+
+module Capistrano
+  module DatabaseYml
+    module Helpers
+
+      def local_database_yml(env)
+        @local_database_yml ||= YAML.load_file(database_yml_local_path)
+        @local_database_yml[env]
+      end
+
+      def database_yml_env
+        fetch(:database_yml_env).to_s
+      end
+
+      def database_yml_content
+        { database_yml_env => local_database_yml(database_yml_env) }.to_yaml
+      end
+
+      # error helpers
+
+      def check_git_tracking_error
+        puts
+        puts "Error - please remove '#{fetch(:database_yml_local_path)}' from git:"
+        puts
+        puts "    $ git rm --cached #{fetch(:database_yml_local_path)}"
+        puts
+        puts "and gitignore it:"
+        puts
+        puts "    $ echo '#{fetch(:database_yml_local_path)}' >> .gitignore"
+        puts
+      end
+
+      def check_config_present_error
+        puts
+        puts "Error - '#{database_yml_env}' config not present in '#{fetch(:database_yml_local_path)}'."
+        puts "Please populate it."
+        puts
+      end
+
+      def check_database_file_exists_error
+        puts
+        puts "Error - '#{fetch(:database_yml_local_path)}' file does not exists, and it's required."
+        puts
+      end
+
+    end
+  end
+end
+

data/lib/capistrano/database_yml/paths.rb

@@ -0,0 +1,17 @@
+require "pathname"
+
+module Capistrano
+  module DatabaseYml
+    module Paths
+
+      def database_yml_local_path
+        Pathname.new fetch(:database_yml_local_path)
+      end
+
+      def database_yml_remote_path
+        shared_path.join fetch(:database_yml_remote_path)
+      end
+
+    end
+  end
+end

data/lib/capistrano/database_yml/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module DatabaseYml
+    VERSION = "1.0.1"
+  end
+end

data/lib/capistrano/tasks/database_yml.rake

@@ -0,0 +1,58 @@
+include Capistrano::DatabaseYml::Paths
+include Capistrano::DatabaseYml::Helpers
+namespace :load do task :defaults do
+    set :database_yml_local_path, "config/database.yml"
+    set :database_yml_remote_path, "config/database.yml"
+    set :database_yml_env, -> { fetch(:rails_env) || fetch(:stage) }
+  end
+end
+
+namespace :database_yml do
+
+  task :check_database_file_exists do
+    next if File.exists?(database_yml_local_path)
+    check_database_file_exists_error
+    exit 1
+  end
+
+  task :check_git_tracking do
+    next unless system("git ls-files #{fetch(:database_yml_local_path)} --error-unmatch >/dev/null 2>&1")
+    check_git_tracking_error
+    exit 1
+  end
+
+  task :check_config_present do
+    next unless local_database_yml(database_yml_env).nil?
+    check_config_present_error
+    exit 1
+  end
+
+  desc "database.yml file checks"
+  task :check do
+    invoke "database_yml:check_database_file_exists"
+    invoke "database_yml:check_git_tracking"
+    invoke "database_yml:check_config_present"
+  end
+
+  desc "Setup `database.yml` file on the server(s)"
+  task setup: [:check] do
+    content = database_yml_content
+    on release_roles :all do
+      execute :mkdir, "-pv", File.dirname(database_yml_remote_path)
+      upload! StringIO.new(content), database_yml_remote_path
+    end
+  end
+
+  # Update `linked_files` after the deploy starts so that users'
+  # `database_yml_remote_path` override is respected.
+  task :database_yml_symlink do
+    set :linked_files, fetch(:linked_files, []).push(fetch(:database_yml_remote_path))
+  end
+  after "deploy:started", "database_yml:database_yml_symlink"
+
+end
+
+desc "Server setup tasks"
+task :setup do
+  invoke "database_yml:setup"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-database-yml
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Shimpei Otsubo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-14 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: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: |
+  Capistrano tasks for automating `database.yml` file handling for Rails 4+ apps.
+  This plugins syncs contents of your local database file and copies that to
+  the remote server.
+email:
+- potsbo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-database-yml.gemspec
+- lib/capistrano-database-yml.rb
+- lib/capistrano/database_yml.rb
+- lib/capistrano/database_yml/helpers.rb
+- lib/capistrano/database_yml/paths.rb
+- lib/capistrano/database_yml/version.rb
+- lib/capistrano/tasks/database_yml.rake
+homepage: https://github.com/capistrano-plugins/capistrano-database-yml
+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.1
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for automating `database.yml` file handling for Rails 4+
+  apps.
+test_files: []