Dahistory 0.1.0 → 0.2.0

data/README.md

@@ -10,30 +10,36 @@ It is mainly to help you keep backups of files you overwrite on servers you admi
 **Example:** You use Chef or Puppet to write a config file, but you want to be sure you
 are overwriting a file you have encountered before.
 
+Installation
+------------
+
+    gem 'Dahistory'
+
 Useage
 ------
 
     require "Dahistory"
 
     path = "some/file.txt"
-    Dahistory_File( path )
-    # Checks your ./history directory.
+    
+    Dahistory path 
+    
+    # Checks your directory (default "./history").
     # If not found there, saves copy of file in ./pending dir and
     #  raises Dahistory::Pending_File, "pending/HOSTNAME,path,some,file.txt.TIMESTAMP"
 
     # You review the file,
-    #   move the file from the pending directory, and 
+    #   move the file from the pending directory to your source/history dir, and 
     #   re-do your last command (Capistrano, Chef, Puppet, etc.)
 
 Override the default settings:
 
-    Dahistory.check { |o|
+    Dahistory { |o|
     
-      o.file        "file/path.txt"
-      o.dirs        [ "dir1", "dir2" ]
-      o.backup_dir  "./history"
-      o.pending_dir "pending_dir_path"
-      o.backup_file "#{`hostname`}.backup.path.txt"
+      o.file        "file/name.txt"
+      o.dirs        "dir1", "dir2"  # defaults to "./history"
+      o.pending_dir "./pending"
+      o.backup_file "#{`hostname`}.name.txt.#{Time.now.to_i}"
       
     }
 

data/lib/Dahistory/version.rb

@@ -1,3 +1,3 @@
 class Dahistory
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/Dahistory.rb

@@ -1,108 +1,102 @@
 require 'Dahistory/version'
 
+def Dahistory file = nil
+  da = Dahistory.new { |o| 
+    o.file(file) if file
+    yield(o)     if block_given?
+  }
+
+  da.save
+end # === def
 
 class Dahistory
  
   Pending = Class.new(RuntimeError)
   
-  module Class_Methods
-
-    def check file = nil
-      da = Dahistory.new { |o| 
-        o.file(file) if file
-        yield(o)     if block_given?
-      }
-      
-      da.save
+  module Base
+    
+    def initialize file_path = nil
+      @file = nil
+      file!(file_path) if file_path
+      dirs         './history'
+      pending_dir  './pending'
+      yield(self) if block_given?
     end
 
-  end # === module
+    old_meths = public_instance_methods
 
-  extend Class_Methods
-
-  def initialize file_path = nil
-    @file = nil
-    file!(file_path) if file_path
-    dirs      ['.']
-    pending_dir  "./pending"
-    @backup_dir = nil
-    yield(self) if block_given?
-  end
-  
-  old_meths = public_instance_methods
-
-  def file path
-    @file = File.expand_path(path)
-  end
+    def file path
+      @file = File.expand_path(path)
+    end
 
-  def dirs *args
-    @dirs = args.flatten.map { |dir| File.expand_path dir }
-  end
+    def dirs *args
+      @dirs = args.flatten.map { |dir| File.expand_path dir }
+    end
 
-  def backup_dir dir
-    @backup_dir = File.expand_path(dir)
-  end
+    def pending_dir dir = :RETURN
+      @pending_dir = File.expand_path(dir)
+    end
 
-  def pending_dir dir = :RETURN
-    @pending_dir = File.expand_path(dir)
-  end
+    (public_instance_methods - old_meths ).each { |name| 
 
-  (public_instance_methods - old_meths ).each { |name| 
-    
-    alias_method :"#{name}_set", name
+      alias_method :"#{name}_set", name
 
-    eval %~
+      eval %~
       def #{name} *args, &blok
-      
+
         if args.empty?
-        
+
           unless instance_variable_defined?(:@#{name})
             raise ArgumentError, "Instance variable not set: @#{name}"
           end
           @#{name}
-          
+
         else
-        
+
           #{name}_set(*args, &blok)
-          #
+
         end
-        
-      end # === def
-    ~
-    
-  }
-  
-  def backup_file str = :RETURN
-    if str == :RETURN
-      @backup_file ||= "#{`hostname`.strip}-#{file.gsub('/',',')}.#{Time.now.utc.strftime "%Y.%m.%d.%H.%M.%S"}"
-      return @backup_file
-    end
-    
-    @backup_file = str
-  end
-
-  def source_files
-    dirs.map { |path| 
-      full = File.join( File.expand_path(path), "/*")
-      files = Dir.glob( full, File::FNM_DOTMATCH ).select { |unk| File.file?(unk) }
-    }.flatten
-  end
-  
-  def save 
 
-    content  = File.read(file)
-    standard = content.gsub("\r", '')
+      end # === def
+          ~
 
-    old = source_files.detect { |path| 
-      raw = File.read(path) 
-      raw.gsub("\r","") == standard
     }
 
-    if !old
-      File.write(backup_file, content)
-      raise Pending, backup_file
+    def backup_file str = :RETURN
+      if str == :RETURN
+        @backup_file ||= "#{`hostname`.strip}-#{file.gsub('/',',')}.#{Time.now.utc.strftime "%Y.%m.%d.%H.%M.%S"}"
+        return @backup_file
+      end
+
+      @backup_file = str
     end
+
+    def source_files
+      dirs.map { |path| 
+        full = File.join( File.expand_path(path), "/*")
+        files = Dir.glob( full, File::FNM_DOTMATCH ).select { |unk| File.file?(unk) }
+      }.flatten
+    end
+
+    def save 
+
+      content  = File.read(file)
+      standard = content.gsub("\r", '')
+
+      old = source_files.detect { |path| 
+        raw = File.read(path) 
+        raw.gsub("\r","") == standard
+      }
+
+      if !old
+        File.write(backup_file, content)
+        raise Pending, backup_file
+      end
+
+    end # === def
     
-  end # === def
+  end # === Base
   
+  include Base
+
 end # === class Dahistory

data/spec/tests/Dashistory.rb

@@ -10,7 +10,7 @@ describe "Dahistory: new pending file" do
     chdir {
       File.write(file, target)
       pending = begin
-                  Dahistory.check("files/a.txt") 
+                  Dahistory "files/a.txt" 
                 rescue Dahistory::Pending => e
                   e.message
                 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Dahistory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: