cloner 0.6.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dedfd02ba4a012b43cb0775bd2ec3cd563691415
-  data.tar.gz: 0607bccaae03a55e6fe60fa80e0fedc2883606ed
+SHA256:
+  metadata.gz: 48065947b30b56516063f5d9e83b20f365ff9c706471629db00263926a22f398
+  data.tar.gz: 3baca4e368a95a2dbe0b29d2197169f512e3d0fe7d9ecf2d6576f10590530847
 SHA512:
-  metadata.gz: 4beb6a1618af270122ea5205029b49ad4ebe632f7451d7bfba0c280601cf39c96b26d32aa8a7f170fac0f49928766248d37185ae34aa53ffb8a52f1a813d1eab
-  data.tar.gz: 6ea9aaa455d224a9e82ba80bf2a2cfd19e21f4483c12eedd9b58cda2652af71c48e4f913d27c7d0121930ac80e332c832bcb3ddd79acc1f44b987cc5066fbe27
+  metadata.gz: 21c0b290b324a34524427ce8bd2f0b1f2ddd1034a925384c3e2a7aae36c951dbce630ba2a8335ef55b8524f197e2eff8c4097a236186907a328b91e914318ccc
+  data.tar.gz: 34aa3d7f03dd927193e734e7eb79a99ed4dc5577dd018c873b503f22048b20045c61bdea3361e74042241af8ab3983b11964c12f21bd28a3d4a8f3bf2f13be34

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+ruby-2.6.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 glebtv
+Copyright (c) 2014-2020 glebtv
 
 MIT License
 

data/README.md

@@ -1,6 +1,9 @@
 # Cloner
 
-Easily clone your production Mongoid or PostgreSQL database and files for local development or staging area.
+Easily clone your production Mongoid or PostgreSQL / MySQL database and files for local development or staging area.
+
+Uses rsync and database-specific default dump/restore tools (pg_dump/pg_restore, mysqldump/mysql, mongodump/mongorestore)
+
 
 ## Installation
 
@@ -20,37 +23,44 @@ Or install it yourself as:
 
 ## Usage
 
-create ```lib/tasks/dl.thor``` with following content:
-
-    require 'cloner'
-
-    class Dl < Cloner::Base
-      no_commands do
-        def rails_path
-          File.expand_path("../../../config/environment", __FILE__)
-        end
-        def ssh_host
-          'hottea.ru'
-        end
-        def ssh_user
-          'tea'
-        end
-        def remote_dump_path
-          '/data/tea/dump'
-        end
-        def remote_app_path
-          "/data/tea/app/current"
-        end
-      end
-
-      desc "download", "clone files and DB from production"
-      def download
-        load_env
-        clone_db
-        rsync_public("ckeditor_assets")
-        rsync_public("uploads")
-      end
+For generate cloner base template, run:
+
+```
+bundle exec rails generate cloner
+```
+
+This is create `lib/tasks/dl.thor` file with following content:
+```ruby
+require 'cloner'
+
+class Dl < Cloner::Base
+  no_commands do
+    def rails_path
+      File.expand_path("../../../config/environment", __FILE__)
     end
+    def ssh_host
+      'hottea.ru'
+    end
+    def ssh_user
+      'tea'
+    end
+    def remote_dump_path
+      '/data/tea/dump'
+    end
+    def remote_app_path
+      "/data/tea/app/current"
+    end
+  end
+
+  desc "download", "clone files and DB from production"
+  def download
+    load_env
+    clone_db
+    rsync_public("ckeditor_assets")
+    rsync_public("uploads")
+  end
+end
+```
 
 Adjust it to your project and deployment.
 
@@ -58,6 +68,30 @@ Run it:
 
     thor dl
 
+
+If you generate extended cloner template as: `rails g cloner -e`,
+you can run `thor dl` with additional parameters, for example:
+```
+bundle exec thor dl -D # For skip clone database
+bundle exec thor dl -F # For skip clone files
+```
+
+For details see help:
+```
+bundle exec thor help dl:download
+
+Usage:
+  thor dl:download
+
+Options:
+      [--from=FROM]                            # stage name where cloner get data
+                                               # Default: production
+  -D, [--skip-database], [--no-skip-database]  # skip clone database
+  -F, [--skip-files], [--no-skip-files]        # skip clone files
+
+clone files and DB from production
+```
+
 ## Additional
 
 All functions from cloner/internal.rb can be overriden, for example:
@@ -73,6 +107,26 @@ All functions from cloner/internal.rb can be overriden, for example:
       {}
     end
 
+## Changelog
+
+### 0.9.0
+
+- Add option to rsync to allow sync one file (thx @AnatolyShirykalov)
+- Add env_database to allow overriding database env (thx @Yarroo)
+
+### 0.8.0
+
+- Change default rsync flags - -z to -zz to support newer versions of rsync
+- Allow overriding rsync flags via ```rsync_flags``` and ```rsync_compression```
+
+### 0.7.0
+
+- Add thor file generators
+
+### 0.6.0
+
+- Support MySQL
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/cloner/fork )

data/cloner.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency 'net-ssh'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end
 

data/lib/cloner/ar.rb

@@ -1,10 +1,14 @@
 module Cloner::Ar
   def ar_conf
     @conf ||= begin
-      YAML.load_file(Rails.root.join('config', 'database.yml'))[Rails.env]
+      YAML.load_file(Rails.root.join('config', 'database.yml'))[env_database]
     end
   end
 
+  def env_database
+    Rails.env
+  end
+
   def ar_to
     ar_conf['database']
   end

data/lib/cloner/mysql.rb

@@ -44,8 +44,8 @@ module Cloner::MySQL
 
   def my_dump_restore
     puts "restoring DB"
-    host = ar_conf['host'].present? ? " -h #{e ar_conf['host']}" : ""
-    port = ar_conf['port'].present? ? " -p #{e ar_conf['port']}" : ""
+    host = ar_conf['host'].present? ? " --host #{e ar_conf['host']}" : ""
+    port = ar_conf['port'].present? ? " --port #{e ar_conf['port']}" : ""
     restore = "#{my_bin_path 'mysql'} #{my_restore_param} --user #{e ar_conf['username']} #{my_local_auth}#{host}#{port} #{e ar_to} < #{e(my_path + '/cloner.sql')}"
     puts restore if verbose?
     pipe = IO.popen(restore)
@@ -65,7 +65,7 @@ module Cloner::MySQL
   def my_dump_copy
     FileUtils.mkdir_p(my_path)
     `mkdir -p #{e my_path}`
-    rsync(remote_dump_path + '/', my_path)
+    rsync(remote_dump_path, my_path)
   end
 
   def clone_my

data/lib/cloner/postgres.rb

@@ -31,11 +31,19 @@ module Cloner::Postgres
   def pg_restore_param
     "--no-owner -Fc -c"
   end
-
+  
   def pg_bin_path(util)
     util
   end
 
+  def pg_local_bin_path(util)
+    pg_bin_path(util)
+  end
+  
+  def pg_remote_bin_path(util)
+    pg_bin_path(util)
+  end 
+
   def pg_dump_remote
     puts "backup remote DB via ssh"
     do_ssh do |ssh|
@@ -44,7 +52,7 @@ module Cloner::Postgres
       check_ssh_err(ret)
       host = ar_r_conf['host'].present? ? " -h #{e ar_r_conf['host']}" : ""
       port = ar_r_conf['port'].present? ? " -p #{e ar_r_conf['port']}" : ""
-      dump = pg_remote_auth + "#{pg_bin_path 'pg_dump'} #{pg_dump_param} -U #{e ar_r_conf['username']}#{host}#{port} #{e ar_r_conf['database']} > #{e(remote_dump_path + '/tmp.bak')}"
+      dump = pg_remote_auth + "#{pg_remote_bin_path 'pg_dump'} #{pg_dump_param} -U #{e ar_r_conf['username']}#{host}#{port} #{e ar_r_conf['database']} > #{e(remote_dump_path + '/tmp.bak')}"
       puts dump if verbose?
       ret = ssh_exec!(ssh, dump)
       check_ssh_err(ret)
@@ -55,7 +63,7 @@ module Cloner::Postgres
     puts "restoring DB"
     host = ar_conf['host'].present? ? " -h #{e ar_conf['host']}" : ""
     port = ar_conf['port'].present? ? " -p #{e ar_conf['port']}" : ""
-    restore = pg_local_auth + "#{pg_bin_path 'pg_restore'} #{pg_restore_param} -U #{e ar_conf['username']}#{host}#{port} -d #{e ar_to} #{e(pg_path + '/tmp.bak')}"
+    restore = pg_local_auth + "#{pg_local_bin_path 'pg_restore'} #{pg_restore_param} -U #{e ar_conf['username']}#{host}#{port} -d #{e ar_to} #{e(pg_path + '/tmp.bak')}"
     puts restore if verbose?
     pipe = IO.popen(restore)
     while (line = pipe.gets)
@@ -74,7 +82,7 @@ module Cloner::Postgres
   def pg_dump_copy
     FileUtils.mkdir_p(pg_path)
     `mkdir -p #{e pg_path}`
-    rsync(remote_dump_path + '/', pg_path)
+    rsync(remote_dump_path, pg_path)
   end
 
   def clone_pg

data/lib/cloner/rsync.rb

@@ -1,8 +1,21 @@
 module Cloner::RSync
   extend ActiveSupport::Concern
-  def rsync(from, to)
+
+  def rsync_compression
+    "-zz"
+  end
+
+  def rsync_flags
     port = ssh_opts[:port] || 22
-    cmd = "rsync -e ssh -zutvr --checksum -e \"ssh -p #{port}\" #{e ssh_user}@#{e ssh_host}:#{e from}/ #{e to}/"
+    "#{rsync_compression} -utvr --checksum -e \"ssh -p #{port}\""
+  end
+
+  def rsync(from, to, directory: true, raise_on_error: false)
+    if directory
+      from = "#{from}/" unless from.end_with?('/')
+      to = "#{to}/" unless to.end_with?('/')
+    end
+    cmd = "rsync #{rsync_flags} #{e ssh_user}@#{e ssh_host}:#{e from} #{e to}"
     puts "Running RSync: #{cmd}"
     pipe = IO.popen(cmd)
     while (line = pipe.gets)
@@ -11,6 +24,9 @@ module Cloner::RSync
     pipe.close
     ret = $?.to_i
     if ret != 0
+      if raise_on_error
+        raise "Error: local command exited with #{ret}"
+      end
       puts "Error: local command exited with #{ret}"
     end
   end

data/lib/cloner/version.rb

@@ -1,4 +1,4 @@
 module Cloner
-  VERSION = "0.6.0"
+  VERSION = "0.9.1"
 end
 

data/lib/generators/cloner_generator.rb

@@ -0,0 +1,25 @@
+class ClonerGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  class_option :extend, default: false, type: :boolean, aliases: '-e'
+
+  desc "This generator create lib/tasks/dl.thor"
+  def create_task_file
+    unless options[:extend]
+      create_default_task_file
+    else
+      create_extended_task_file
+    end
+  end
+
+  private
+  def create_default_task_file
+    copy_file 'cloner_base.template', 'lib/tasks/dl.thor'
+  end
+
+  def create_extended_task_file
+    say 'Create extend file'
+    @username = Rails.application.class.parent_name.downcase
+    template 'cloner_extend.thor.erb', 'lib/tasks/dl.thor'
+  end
+end

data/lib/generators/templates/cloner_base.template

@@ -0,0 +1,29 @@
+require 'cloner'
+
+class Dl < Cloner::Base
+  no_commands do
+    def rails_path
+      File.expand_path("../../../config/environment", __FILE__)
+    end
+    def ssh_host
+      'hottea.ru'
+    end
+    def ssh_user
+      'tea'
+    end
+    def remote_dump_path
+      '/data/tea/dump'
+    end
+    def remote_app_path
+      "/data/tea/app/current"
+    end
+  end
+
+  desc "download", "clone files and DB from production"
+  def download
+    load_env
+    clone_db
+    rsync_public("ckeditor_assets")
+    rsync_public("uploads")
+  end
+end

data/lib/generators/templates/cloner_extend.thor.erb

@@ -0,0 +1,72 @@
+require 'cloner'
+
+class Dl < Cloner::Base
+  no_commands do
+    def rails_path
+      File.expand_path("../../../config/environment", __FILE__)
+    end
+    def stages
+      @_stages ||= {
+        # TODO: Add new stages here if you needed
+        production: {
+          # TODO: Fix production settings
+          ssh_host: 'production.example.com',
+          ssh_user: '<%= @username %>'
+        },
+        staging: {
+          # TODO: Fix staging settings
+          ssh_host: 'production.example.com',
+          ssh_user: '<%= @username %>'
+        }
+      }
+    end
+    def ssh_host
+      stages.dig(options[:from].to_sym, :ssh_host)
+    end
+    def ssh_user
+      stages.dig(options[:from].to_sym, :ssh_user)
+    end
+    def remote_dump_path
+      # TODO: Fix remote dump path
+      '/data/<%= @username %>/dump'
+    end
+    def remote_app_path
+      # TODO: Fix remote app path
+      '/data/<%= @username %>/app/current'
+    end
+  end
+
+  class_option :from,
+               default: 'production',
+               type: :string,
+               desc: 'stage name where cloner get data'
+  class_option :skip_database,
+               default: false,
+               type: :boolean,
+               aliases: '-D',
+               desc: 'skip clone database'
+  class_option :skip_files,
+               default: false,
+               type: :boolean,
+               aliases: '-F',
+               desc: 'skip clone files'
+
+  desc "download", "clone files and DB from production"
+  def download
+    load_env
+    say "Clone from: #{options[:from]}", :green
+    if options[:skip_database]
+      say "Skip clone database!", :yellow
+    else
+      clone_db
+    end
+
+    if options[:skip_files]
+      say "Skip clone files!", :yellow
+    else
+      # TODO: Fix folders for synchronization here
+      rsync_public("ckeditor_assets")
+      rsync_public("uploads")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloner
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.1
 platform: ruby
 authors:
 - glebtv
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -56,30 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: ''
 email:
 - glebtv@gmail.com
@@ -88,10 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
-- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -106,11 +104,14 @@ files:
 - lib/cloner/rsync.rb
 - lib/cloner/ssh.rb
 - lib/cloner/version.rb
+- lib/generators/cloner_generator.rb
+- lib/generators/templates/cloner_base.template
+- lib/generators/templates/cloner_extend.thor.erb
 homepage: https://github.com/rs-pro/cloner
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Easily clone your production Mongoid database and files for local development
 test_files: []

data/.ruby-gemset

@@ -1 +0,0 @@
-cloner

data/HISTORY.md

@@ -1,3 +0,0 @@
-### 0.6.0
-
-Support MySQL