cloner 0.6.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4327a76f4dbae0a838b04277cf1dfc42e40bd493a6557453fe20dd094ae7a017
-  data.tar.gz: 4b80a4c1ca652c01ab173b1711b84862a806c2318c246d700bd4abf21fa96cc0
+  metadata.gz: 5f868fc34e630fd4d7cf91feed0e10677c104d1c9544f2ab9724c56e5cacc1d0
+  data.tar.gz: 799f6879a9355879f954766b971c081a222e47beeefe1b534d9ff6e7ce95a1a8
 SHA512:
-  metadata.gz: 39f309d98f2cd91d9df01ed50a0805590f8272bbf3be16302ae12891e0b27982816d25be76da99e5c38930027c9c5b5db473e55ad21e4a6f4ef5375a7490de68
-  data.tar.gz: 7d2f51fc2ca8d95e509836970e1c74bdc5a1dba1a8a4f9da8b72361904b6ee86de67a59c0f322fcb75258879215c96198cf1c2bb9ebfe90b75944497b7686c45
+  metadata.gz: 8c1b04ebd2ad21597a614bd24912b7c4f4c11daa2b147a32c36213a1c7bbd288d527a8af429fdc0070c8366a69b6a7d48438f80e7615557f927912ee2ee596ac
+  data.tar.gz: 82f4ae3722521acf3e46843c07bcee0da07a461434b8757897e98487ee8a688f14f00c79415b5181d5f468eae8d209ddfd809b7e61f2c6a10635833ee4707a59

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

@@ -2,6 +2,9 @@
 
 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
 
 Add this line to your application's Gemfile:
@@ -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

@@ -82,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.to_s.end_with?('/')
+      to = "#{to}/" unless to.to_s.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.1"
+  VERSION = "0.9.2"
 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.1
+  version: 0.9.2
 platform: ruby
 authors:
 - glebtv
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2020-08-29 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.7.7
-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