dump 1.0.4 → 1.0.5

data/lib/dump/railtie.rb

@@ -1,4 +1,5 @@
 module Dump
+  # Add rake tasks to rails app
   class Railtie < Rails::Railtie
     rake_tasks do
       load 'tasks/assets.rake'

data/lib/dump_rake.rb

@@ -11,11 +11,24 @@ require 'archive/tar/minitar'
 require 'dump_rake/archive_tar_minitar_fix'
 require 'progress'
 
+require 'dump_rake/rails_root'
+require 'dump_rake/assets'
+require 'dump_rake/table_manipulation'
+require 'dump_rake/dump'
+require 'dump_rake/dump_reader'
+require 'dump_rake/dump_writer'
+require 'dump_rake/env'
+
+# Main interface
 class DumpRake
   class << self
     def versions(options = {})
       Dump.list(options).each do |dump|
-        puts DumpRake::Env[:show_size] || $stdout.tty? ? "#{dump.human_size.to_s.rjust(7)}\t#{dump}" : dump
+        if DumpRake::Env[:show_size] || $stdout.tty?
+          puts "#{dump.human_size.to_s.rjust(7)}\t#{dump}"
+        else
+          puts dump
+        end
         begin
           case options[:summary].to_s.downcase[0, 1]
           when *%w[1 t y]
@@ -47,14 +60,14 @@ class DumpRake
       if dump
         DumpReader.restore(dump.path)
       else
-        $stderr.puts "Avaliable versions:"
+        $stderr.puts 'Avaliable versions:'
         $stderr.puts Dump.list
       end
     end
 
     def cleanup(options = {})
-      unless options[:leave].nil? || /^\d+$/ === options[:leave] || options[:leave].downcase == 'none'
-        raise 'LEAVE should be number or "none"'
+      unless options[:leave].nil? || /^\d+$/ =~ options[:leave] || options[:leave].downcase == 'none'
+        fail 'LEAVE should be number or "none"'
       end
 
       to_delete = []
@@ -79,7 +92,3 @@ class DumpRake
     end
   end
 end
-
-%w[rails_root assets table_manipulation dump dump_reader dump_writer env].each do |file|
-  require "dump_rake/#{file}"
-end

data/lib/dump_rake/archive_tar_minitar_fix.rb

@@ -1,4 +1,6 @@
-class Archive::Tar::Minitar::Reader::EntryStream
+require 'archive/tar/minitar'
+
+Archive::Tar::Minitar::Reader::EntryStream.class_eval do
   def getbyte
     return nil if @read >= @size
     ret = @io.getbyte

data/lib/dump_rake/assets.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 class DumpRake
+  # Helper for listing assets for dump
   module Assets
     SPLITTER = /[:,]/
 

data/lib/dump_rake/continious_timeout.rb

@@ -1,38 +1,38 @@
 # based on Timeout
 
-module ContiniousTimeout
-  class TimeoutException < ::Exception
-  end
+class DumpRake
+  # Timeout if does not finish or defer in requested time
+  module ContiniousTimeout
+    class TimeoutException < ::Exception; end
 
-  class RestartException < ::Exception
-  end
+    class RestartException < ::Exception; end
 
-  class Deferer
-    def initialize(thread)
-      @thread = thread
-    end
+    # Object with defer method
+    class Deferer
+      def initialize(thread)
+        @thread = thread
+      end
 
-    def defer
-      @thread.raise RestartException.new
+      def defer
+        @thread.raise RestartException.new
+      end
     end
-  end
 
-  def self.timeout(sec)
-    begin
+    def self.timeout(sec)
       x = Thread.current
       y = Thread.start do
         1.times do
           begin
             sleep sec
-          rescue RestartException => e
+          rescue RestartException
             retry
           end
         end
-        x.raise TimeoutException, "execution expired" if x.alive?
+        x.raise TimeoutException, 'execution expired' if x.alive?
       end
       yield Deferer.new(y)
     ensure
-      y.kill if y and y.alive?
+      y.kill if y && y.alive?
     end
   end
 end

data/lib/dump_rake/dump.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 class DumpRake
+  # Base class for dump
   class Dump
     include TableManipulation
     def self.list(options = {})
@@ -19,7 +20,7 @@ class DumpRake
       if path_or_options.is_a?(Hash)
         options = path_or_options
 
-        name = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        name = Time.now.utc.strftime('%Y%m%d%H%M%S')
 
         description = clean_description(options[:desc])
         name += "-#{description}" unless description.blank?
@@ -52,12 +53,12 @@ class DumpRake
 
     def parts
       @parts ||=
-      if m = name.match(/^(\d{#{4+2+2 + 2+2+2}})(-[^@]+)?((?:@[^@]+)+)?\.(tmp|tgz)$/)
+      if (m = name.match(/^(\d{#{4 + 2 + 2 + 2 + 2 + 2}})(-[^@]+)?((?:@[^@]+)+)?\.(tmp|tgz)$/))
         {
           :time => m[1],
           :desc => m[2] && m[2][1, m[2].length],
           :tags => m[3] && m[3][1, m[3].length],
-          :ext => m[4]
+          :ext => m[4],
         }
       else
         {}
@@ -83,7 +84,7 @@ class DumpRake
     def name
       @name ||= File.basename(path)
     end
-    alias to_s name
+    alias_method :to_s, :name
 
     def size
       File.size(path) rescue nil
@@ -93,29 +94,30 @@ class DumpRake
       number = size
       return nil if number.nil?
       degree = 0
-      symbols = %W[B K M G T]
+      symbols = %w[B K M G T]
       while number >= 1000 && degree < symbols.length - 1
         degree += 1
         number /= 1024.0
       end
-      "#{'%.2f' % number}#{symbols[degree]}"
+      format('%.2f%s', number, symbols[degree])
     end
 
     def inspect
-      "#<%s:0x%x %s>" % [self.class, object_id, path.to_s.sub(/^.+(?=..\/[^\/]*$)/, '…')]
+      "#<#{self.class}:0x#{object_id} #{path}>"
     end
 
     def lock
-      if lock = File.open(path, 'r')
-        begin
-          if lock.flock(File::LOCK_EX | File::LOCK_NB)
-            yield
-          end
-        ensure
-          lock.flock(File::LOCK_UN)
-          lock.close
+      lock = File.open(path, 'r')
+      begin
+        if lock.flock(File::LOCK_EX | File::LOCK_NB)
+          yield
         end
+      ensure
+        lock.flock(File::LOCK_UN)
+        lock.close
       end
+    rescue Errno::ENOENT
+      nil
     end
 
     def silence(&block)
@@ -142,32 +144,35 @@ class DumpRake
       Pathname(path.to_s.sub(/#{parts[:ext]}$/, ext))
     end
 
+    # Cleanup name of dump
     module CleanNParse
       def clean_str(str, additional = nil)
         str.to_s.strip.gsub(/\s+/, ' ').gsub(/[^A-Za-z0-9 \-_#{Regexp.escape(additional.to_s) if additional}]+/, '_')
       end
+
       def clean_description(description)
         clean_str(description, '()#')[0, 50].strip
       end
+
       def clean_tag(tag)
         clean_str(tag).downcase.sub(/^\-+/, '')[0, 20].strip
       end
+
       def clean_tags(tags)
         tags.to_s.split(',').map{ |tag| clean_tag(tag) }.uniq.reject(&:blank?).sort
       end
+
       def get_filter_tags(tags)
         groups = Hash.new{ |hash, key| hash[key] = SortedSet.new }
         tags.to_s.split(',').each do |tag|
-          if m = tag.strip.match(/^(\-|\+)?(.*)$/)
-            type = {'+' => :mandatory, '-' => :forbidden}[m[1]] || :simple
-            unless (claned_tag = clean_tag(m[2])).blank?
-              groups[type] << claned_tag
-            end
-          end
+          next unless (m = tag.strip.match(/^(\-|\+)?(.*)$/))
+          type = {'+' => :mandatory, '-' => :forbidden}[m[1]] || :simple
+          next unless (cleaned_tag = clean_tag(m[2])).present?
+          groups[type] << cleaned_tag
         end
         [:simple, :mandatory].each do |type|
           if (clashing = (groups[type] & groups[:forbidden])).present?
-            raise "#{type} tags clashes with forbidden ones: #{clashing}"
+            fail "#{type} tags clashes with forbidden ones: #{clashing}"
           end
         end
         groups.each_with_object({}){ |(key, value), hsh| hsh[key] = value.to_a }

data/lib/dump_rake/dump_reader.rb

@@ -1,4 +1,5 @@
 class DumpRake
+  # Reading dump
   class DumpReader < Dump
     attr_reader :stream, :config
 
@@ -15,6 +16,7 @@ class DumpRake
       end
     end
 
+    # Helper class for building summary of dump
     class Summary
       attr_reader :text
       alias_method :to_s, :text
@@ -54,11 +56,11 @@ class DumpRake
         if assets.present?
           sum.header 'Assets'
           sum.data assets.sort.map{ |entry|
-            if String === entry
+            if entry.is_a?(String)
               entry
             else
               asset, paths = entry
-              if Hash === paths
+              if paths.is_a?(Hash)
                 "#{asset}: #{Summary.pluralize paths[:files], 'file'} (#{Summary.pluralize paths[:total], 'entry'} total)"
               else
                 "#{asset}: #{Summary.pluralize paths, 'entry'}"
@@ -87,7 +89,7 @@ class DumpRake
 
     def find_entry(matcher)
       stream.each do |entry|
-        if matcher === entry.full_name
+        if entry.full_name.match(matcher)
           # we can not return entry - after exiting stream.each the entry will be invalid and will read from tar start
           return yield(entry)
         end
@@ -120,27 +122,26 @@ class DumpRake
         Rake::Task['db:drop'].invoke
         Rake::Task['db:create'].invoke
       when !DumpRake::Env.no?(:migrate_down)
-        if avaliable_tables.include?('schema_migrations')
-          find_entry("schema_migrations.dump") do |entry|
-            migrated = table_rows('schema_migrations').map{ |row| row['version'] }
-
-            dump_migrations = []
-            Marshal.load(entry) # skip header
-            dump_migrations << Marshal.load(entry).first until entry.eof?
-
-            migrate_down = (migrated - dump_migrations)
-
-            unless migrate_down.empty?
-              migrate_down.reverse.with_progress('Migrating down') do |version|
-                DumpRake::Env.with_env('VERSION' => version) do
-                  Rake::Task['db:migrate:down'].tap do |task|
-                    begin
-                      task.invoke
-                    rescue ActiveRecord::IrreversibleMigration
-                      $stderr.puts "Irreversible migration: #{version}"
-                    end
-                    task.reenable
+        return unless avaliable_tables.include?('schema_migrations')
+        find_entry('schema_migrations.dump') do |entry|
+          migrated = table_rows('schema_migrations').map{ |row| row['version'] }
+
+          dump_migrations = []
+          Marshal.load(entry) # skip header
+          dump_migrations << Marshal.load(entry).first until entry.eof?
+
+          migrate_down = (migrated - dump_migrations)
+
+          unless migrate_down.empty?
+            migrate_down.reverse.with_progress('Migrating down') do |version|
+              DumpRake::Env.with_env('VERSION' => version) do
+                Rake::Task['db:migrate:down'].tap do |task|
+                  begin
+                    task.invoke
+                  rescue ActiveRecord::IrreversibleMigration
+                    $stderr.puts "Irreversible migration: #{version}"
                   end
+                  task.reenable
                 end
               end
             end
@@ -154,13 +155,12 @@ class DumpRake
     end
 
     def read_schema
-      if restore_schema?
-        read_entry_to_file('schema.rb') do |f|
-          DumpRake::Env.with_env('SCHEMA' => f.path) do
-            Rake::Task['db:schema:load'].invoke
-          end
-          Rake::Task['db:schema:dump'].invoke
+      return unless restore_schema?
+      read_entry_to_file('schema.rb') do |f|
+        DumpRake::Env.with_env('SCHEMA' => f.path) do
+          Rake::Task['db:schema:load'].invoke
         end
+        Rake::Task['db:schema:dump'].invoke
       end
     end
 
@@ -209,42 +209,41 @@ class DumpRake
 
     def read_assets
       return if DumpRake::Env[:restore_assets] && DumpRake::Env[:restore_assets].empty?
-      unless config[:assets].blank?
-        assets = config[:assets]
-        if Hash === assets
-          assets_count = assets.values.sum{ |value| Hash === value ? value[:total] : value }
-          assets_paths = assets.keys
-        else
-          assets_count, assets_paths = nil, assets
-        end
+      return if config[:assets].blank?
+
+      assets = config[:assets]
+      if assets.is_a?(Hash)
+        assets_count = assets.values.sum{ |value| value.is_a?(Hash) ? value[:total] : value }
+        assets_paths = assets.keys
+      else
+        assets_count, assets_paths = nil, assets
+      end
 
-        if DumpRake::Env[:restore_assets]
-          assets_paths.each do |asset|
-            DumpRake::Assets.glob_asset_children(asset, '**/*').reverse.each do |child|
-              if read_asset?(child, DumpRake::RailsRoot)
-                case
-                when File.file?(child)
-                  File.unlink(child)
-                when File.directory?(child)
-                  begin
-                    Dir.unlink(child)
-                  rescue Errno::ENOTEMPTY
-                    nil
-                  end
-                end
+      if DumpRake::Env[:restore_assets]
+        assets_paths.each do |asset|
+          DumpRake::Assets.glob_asset_children(asset, '**/*').reverse.each do |child|
+            next unless read_asset?(child, DumpRake::RailsRoot)
+            case
+            when File.file?(child)
+              File.unlink(child)
+            when File.directory?(child)
+              begin
+                Dir.unlink(child)
+              rescue Errno::ENOTEMPTY
+                nil
               end
             end
           end
-        else
-          DumpRake::Env.with_env(:assets => assets_paths.join(':')) do
-            Rake::Task['assets:delete'].invoke
-          end
         end
+      else
+        DumpRake::Env.with_env(:assets => assets_paths.join(':')) do
+          Rake::Task['assets:delete'].invoke
+        end
+      end
 
-        read_assets_entries(assets_paths, assets_count) do |stream, root, entry, prefix|
-          if !DumpRake::Env[:restore_assets] || read_asset?(entry.full_name, prefix)
-            stream.extract_entry(root, entry)
-          end
+      read_assets_entries(assets_paths, assets_count) do |stream, root, entry, prefix|
+        if !DumpRake::Env[:restore_assets] || read_asset?(entry.full_name, prefix)
+          stream.extract_entry(root, entry)
         end
       end
     end
@@ -252,14 +251,14 @@ class DumpRake
     def read_asset?(path, prefix)
       DumpRake::Env.filter(:restore_assets, DumpRake::Assets::SPLITTER).custom_pass? do |value|
         File.fnmatch(File.join(prefix, value), path) ||
-        File.fnmatch(File.join(prefix, value, '**'), path)
+          File.fnmatch(File.join(prefix, value, '**'), path)
       end
     end
 
-    def read_assets_entries(assets_paths, assets_count)
+    def read_assets_entries(_assets_paths, assets_count)
       Progress.start('Assets', assets_count || 1) do
         found_assets = false
-        # old style — in separate tar
+        # old style - in separate tar
         find_entry('assets.tar') do |assets_tar|
           def assets_tar.rewind
             # rewind will fail - it must go to center of gzip
@@ -275,7 +274,7 @@ class DumpRake
         end
 
         unless found_assets
-          # new style — in same tar
+          # new style - in same tar
           assets_root_link do |tmpdir, prefix|
             stream.each do |entry|
               if entry.full_name.starts_with?("#{prefix}/")