capistrano-rails-toolbox 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6af5d8ead11b4f25cec2134b99014398bd25f3d1
+  data.tar.gz: 6f5242744f185fea1b3ab8a5b138697463eb6c45
+SHA512:
+  metadata.gz: 8a4875d95721131c84f4ac8a44260e5bc31febc640c5b40271c334d84f49f7aa995577b8405bdb0b401f7768278fc7a90692abf51ebc54f1626c14d086f2a5c2
+  data.tar.gz: d0e27c72c4ae42b87d5cc942c70ed446ea3195367e058b7b51ab013dffdb9c9b664d6979a39216237b100ef1ef410a0a2ccc140a54021e5aaf9a0ded0e7d8580

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 ACzero
+
+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/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/lib/capistrano/rails/toolbox.rb

@@ -0,0 +1,2 @@
+require 'capistrano/rails/toolbox/version'
+require 'capistrano/rails/toolbox/toolbox_tasks'

data/lib/capistrano/rails/toolbox/tasks/db.rake

@@ -0,0 +1,118 @@
+class NotSupportDatabaseAdapter < RuntimeError; end
+
+namespace :toolbox do
+  namespace :db do
+    desc <<-DESC
+      load remote databse data to local, support adapter: mysql2, postgresql
+    DESC
+    task :load_remote do
+      on roles(:db) do |server|
+        info "make sure you are not connecting to the local database"
+
+        local_config_path = 'config/database.yml'
+        remote_config_path = "#{shared_path}/config/database.yml"
+
+        puts <<-MSG
+default local config path: #{local_config_path}
+default remote config path: #{remote_config_path}
+        MSG
+
+        ask(:enter_path, "enter your custom config path?(Y/N)")
+        if fetch(:enter_path) == 'Y'
+          ask(:local_config_path, 'local database config path')
+          ask(:remote_config_path, 'remote database config path')
+          local_config_path = fetch(:local_config_path)
+          remote_config_path = fetch(:remote_config_path)
+        end
+
+        remote_config = remote_db_config(remote_config_path)
+        local_config = local_db_config(local_config_path)
+
+        db_filename = "db_dump"
+        dump_file_path = "#{fetch(:deploy_to)}/#{db_filename}"
+        local_file_path = "/tmp/#{db_filename}"
+
+        info "start dumping database from remote..."
+        no_output do
+          execute dump_cmd(remote_config, dump_file_path)
+        end
+
+        info "downloading..."
+        download! dump_file_path, local_file_path
+
+        info "reset local database"
+        system "bundle exec rake db:drop"
+        system "bundle exec rake db:create"
+
+        info "loading data..."
+        system import_cmd(local_config, local_file_path)
+
+        info "removing dump file..."
+        system "rm #{local_file_path}"
+        execute "rm #{dump_file_path}"
+        info "done!"
+      end
+    end
+
+    def remote_db_config(path)
+      remote_config = no_output do
+        capture("cat #{path}")
+      end
+
+      YAML::load(remote_config)[fetch(:stage).to_s]
+    end
+
+    def local_db_config(path)
+      YAML::load_file(path)["development"]
+    end
+
+    def dump_cmd(config, dump_file_path)
+      case config['adapter']
+      when 'postgresql'
+        cmd = "export PGPASSWORD=#{config['password']}; pg_dump #{config['database']}" +
+                " --username=#{config['username']} --no-owner --no-acl --format=c"
+        cmd << " --host=#{config['host']}" unless config['host'].nil?
+        cmd << " --port=#{config['port']}" unless config['port'].nil?
+        cmd + " > #{dump_file_path}"
+      when 'mysql2'
+        cmd = "mysqldump --routines --user=#{config['username']}" +
+                " --password=#{config['password']}"
+        cmd << " --host=#{config['host']}" unless config['host'].nil?
+        cmd << " --port=#{config['port']}" unless config['port'].nil?
+        cmd + " #{config['database']} > #{dump_file_path}"
+      else
+        raise NotSupportDatabaseAdapter.new
+      end
+    end
+
+    def import_cmd(config, db_file_path)
+      case config['adapter']
+      when 'postgresql'
+        cmd = "export PGPASSWORD=#{config['password']}; pg_restore #{db_file_path}" +
+                " --no-owner --no-acl -d #{config['database']}"
+        cmd << " --host=#{config['host']}" unless config['host'].nil?
+        cmd << " --port=#{config['port']}" unless config['port'].nil?
+        cmd
+      when 'mysql2'
+        cmd = "mysql --user=#{config['username']} --password=#{config['password']}"
+        cmd << " --host=#{config['host']}" unless config['host'].nil?
+        cmd << " --port=#{config['port']}" unless config['port'].nil?
+        cmd + " #{config['database']} < #{db_file_path}"
+      else
+        raise NotSupportDatabaseAdapter.new
+      end
+    end
+
+    def no_output
+      default = SSHKit.config.output
+      SSHKit.config.output = SSHKit::Formatter::Pretty.new(String.new)
+      result = yield
+      SSHKit.config.output = default
+      result
+    end
+
+    def db_config_path_msg
+      "enter your custom config path?(Y/N)"
+    end
+  end
+end

data/lib/capistrano/rails/toolbox/tasks/remote.rake

@@ -0,0 +1,57 @@
+namespace :toolbox do
+  namespace :remote do
+    desc <<-DESC
+      open a rails console for remote
+    DESC
+    task :console do
+      on roles(:app) do |server|
+        set :format, :pretty
+        puts "Opening a console on: #{host}...."
+        command = "cd #{fetch(:deploy_to)}/current && "\
+                  "RAILS_ENV=#{fetch(:stage)} "\
+                  "#{SSHKit.config.command_map[:bundle]} exec rails console"
+        puts command
+        exec "ssh #{server.user}@#{host} -t '#{command}'"
+      end
+    end
+
+    desc <<-DESC
+      tail rails log file
+    DESC
+    task :log do
+      on roles :app do
+        set :log_level, :debug
+        set :format, :pretty
+        configure_backend
+
+        log_path = "#{shared_path}/log/#{fetch(:rails_env)}.log"
+        command = "tail -F #{log_path}"
+        puts command
+        execute command
+      end
+    end
+
+    desc <<-DESC
+      download [stage].log file to local, enter the path to store the log file, current path for blank
+    DESC
+
+    task :download_log do
+      on roles :app do
+        log_fname = "#{fetch(:rails_env)}.log"
+        ask(:local_path,
+            '')
+        puts fetch(:local_path)
+        local_path = if fetch(:local_path).chars.count == 0
+                       "#{`pwd`.delete("\n")}/#{log_fname}"
+                     else
+                       "#{fetch(:local_path)}/#{log_fname}"
+                     end
+        log_path = "#{shared_path}/log/#{log_fname}"
+
+        info 'start download'
+        download! log_path, local_path
+        info "download complete, your log file is in #{local_path}"
+      end
+    end
+  end
+end

data/lib/capistrano/rails/toolbox/toolbox_tasks.rb

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

data/lib/capistrano/rails/toolbox/version.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module Rails
+    module Toolbox
+      VERSION = "0.4.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rails-toolbox
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- ACzero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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-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: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: tasks include loading db from server, tailing log and etc..
+email:
+- lzh.scut@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/capistrano-rails-toolbox.rb
+- lib/capistrano/rails/toolbox.rb
+- lib/capistrano/rails/toolbox/tasks/db.rake
+- lib/capistrano/rails/toolbox/tasks/remote.rake
+- lib/capistrano/rails/toolbox/toolbox_tasks.rb
+- lib/capistrano/rails/toolbox/version.rb
+homepage: https://github.com/AdaChina/capistrano-rails-toolbox
+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.2.5
+signing_key: 
+specification_version: 4
+summary: some useful tasks for capistrano-rails
+test_files: []