lenc 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81e06c0955051deca4de3a4687debbed0d38ab2e
-  data.tar.gz: 38b7cf28b8c71b99711d440a27dc7535fc82ed02
+  metadata.gz: 0599074c2a147d12b565284ba7d57126d1e4fda4
+  data.tar.gz: b78817f171113983d8c7a412191d4b78b1683045
 SHA512:
-  metadata.gz: be50fb30cf452036677c901f05c5eaa81db9fcc6b071a2029ec87f11b4c89d9f9ff39606e97ec428720e304a2a02188253abadeea8db67cc9363ddfa22377011
-  data.tar.gz: c5e73819b059507bffa9aac25dbb7c22f21a256d278898e1139285627609a80c98b8a7bda407663e8d54c4a8ba2e63a1c0433c0ee8bcb777a966bc17b1ac6024
+  metadata.gz: f19660e7bdde1ffb36153dd0947dbd9bfd66e3f05c71610a5ab4b5f9db931fd34ab57421c901bd77d54a7d5b9a80c6f53fcd71f24c46bc24a503dc56125ca911
+  data.tar.gz: d8c08ff48b5ea0deaf6d565e29d702e85b0a6625fb09fcbf1d578d3997f20f6dce0f619dc0e2f45c1942254da2ec1bd7b6d4ab6d47bfe59bb49264024917183f

data/lib/lenc/encr.rb

@@ -15,6 +15,7 @@ class EncrApp
         opt :verbose,"verbose operation"
         opt :where, "specify source directory (default = current directory)", :type => :strings
         opt :quiet, "quiet operation"
+        opt :dryrun, "show which files will be modified, but make no changes"
     end
     
     options = Trollop::with_standard_exception_handling p do

data/lib/lenc/repo.rb

@@ -69,9 +69,13 @@ module LEnc
     end
     
     
+    # We now ignore 'dot-underscore' files which OSX seems to create sometimes
+    # to store additional information about other files.
+    
     DEFAULTIGNORE = \
       "#{LENC_REPO_FILENAME}\n " \
        ".DS_Store\n" + \
+       "._*\n" + \
       ".recoverdefaults\n"
 
     STATE_CLOSED = 0
@@ -300,11 +304,13 @@ module LEnc
     # @raise IllegalStateException if repository isn't open.
     # 
     def perform_encrypt()
+      db = warndb 0
       raise IllegalStateException if @state != STATE_OPEN
       
       enc_dir = @encrDir
       if in_place?
         enc_dir = @repoBaseDir
+        !db || pr("perform_encrypt, enc_dir set to repoBaseDir #{@repoBaseDir}\n")
       end
       
       setInputOutputDirs(@startDir,enc_dir)
@@ -317,7 +323,7 @@ module LEnc
       puts("Encrypting...") if @verbosity >= 1
 
       begin
-        ecrypt_directory_contents(@repoBaseDir, enc_dir)
+        encrypt_directory_contents(@repoBaseDir, enc_dir)
         puts("...done.") if @verbosity >= 1
       end
     end
@@ -763,8 +769,10 @@ module LEnc
         end
         
         temp_enc_path = convertFile(sourceFile, true, showProgress)
+        !db || pr(" converted [#{sourceFile}] to temp [#{temp_enc_path}]\n")
         if not @dryrun
           FileUtils.mv(temp_enc_path, encryptFile)
+          !db || pr("  moved temp to encryptFile #{encryptFile}\n")
         end
         
       end
@@ -822,9 +830,9 @@ module LEnc
     # @param sourceDir  absolute path of source directory
     # @param encryptDir absolute path of encryption directory
     #
-    def ecrypt_directory_contents(sourceDir, encryptDir)
+    def encrypt_directory_contents(sourceDir, encryptDir)
       
-      db = (warndb 0)
+      db = warndb 0
       
       !db || pr("\n\nencryptDir\n %s =>\n %s\n",d(sourceDir),d(encryptDir))
       
@@ -869,6 +877,7 @@ module LEnc
       # Examine each file in source dir
       dirc = dir_entries(sourceDir)
       
+      !db || pr(" dirc=%s\n",d2(dirc))
       dirc.each do |f2|
         # Convert string to ASCII-8BIT encoding.
         f = to_ascii8(f2)
@@ -909,7 +918,7 @@ module LEnc
           encrPath = File.join(encryptDir, encrName)
           
           if File.directory?(filePath) 
-            ecrypt_directory_contents(filePath, encrPath)
+            encrypt_directory_contents(filePath, encrPath)
           else 
             !db || pr("...attempting to encrypt file #{filePath} to #{encrPath}...\n")
             encrypt_file(filePath, encrPath)
@@ -924,16 +933,17 @@ module LEnc
           end
           
           if File.directory?(filePath) 
-            ecrypt_directory_contents(filePath, filePath)
+            encrypt_directory_contents(filePath, filePath)
             # Rename the directory to its encrypted form, if necessary
-            if filePath != encrPath
+            if (not @dryrun) && (filePath != encrPath)  
               !db || pr(" renaming now-encrypted file from\n  #{filePath}\n to\n  #{encrPath}\n")
               FileUtils.mv(filePath,encrPath)
             end
           else
             encrypt_file(filePath, encrPath)
             # Delete unencrypted file, if not using original names
-            if !@orignames && !@dryrun
+            if (not @dryrun) && (not @orignames)
+              !db || pr(" attempting to remove unencrypted file #{filePath}\n")
               FileUtils.rm(filePath)
             end
           end
@@ -968,7 +978,7 @@ module LEnc
                 printf("Removing encrypted version of missing (or ignored) file " \
                 +  rel_path(File.join(sourceDir, orphanOrigName), @inputDir) + ": " + orphanPath)
               end
-              if !@dryrun
+              if not @dryrun
                 remove_file_or_dir(orphanPath)
               end
             rescue DecryptionError
@@ -1035,9 +1045,11 @@ module LEnc
           if !@orignames
             raise ArgumentError,"decrypted already exists: #{decrPath}" \
                           if File.exist?(decrPath)
-                        
-            !db || pr(" renaming now-decrypted directory from\n  #{filePath}\n to\n  #{decrPath}\n")
-            FileUtils.mv(filePath,decrPath)
+            
+            if not @dryrun            
+              !db || pr(" renaming now-decrypted directory from\n  #{filePath}\n to\n  #{decrPath}\n")
+              FileUtils.mv(filePath,decrPath)
+            end
           end
         else
           decrPathDisp = File.join(decr_dir_name,decrName)
@@ -1084,7 +1096,9 @@ module LEnc
         if File.file?(recoverDir)
           raise RecoveryError, "Cannot replace existing file '" + recoverDir + "' with directory" 
         end
-        Dir.mkdir(recoverDir) if not @dryrun
+        if not @dryrun
+          Dir.mkdir(recoverDir) 
+        end
       end
         
       if not File.directory?(encryptDir)
@@ -1196,7 +1210,7 @@ module LEnc
         
         fr = File.open(srcPath, 'rb')
         fw = Tempfile.new("repo")
-        
+        !db || pr("created temporary file #{fw.path}\n")
         cSize = 100000
         
         # Predict number of chunks required
@@ -1256,6 +1270,7 @@ module LEnc
         pr("\n")
       end
       
+      !db || pr(" (done convertFile)\n")
       fw
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jeff Sember
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -39,7 +39,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/lenc.rb
-- lib/lenc/_OLD_tools.rb
 - lib/lenc/aes.rb
 - lib/lenc/config_file.rb
 - lib/lenc/encr.rb

data/lib/lenc/_OLD_tools.rb

@@ -1,628 +0,0 @@
-require 'set'
-require 'fileutils'
-
-# Various utility and debug convenience functions.
-#
-
-# Convenience method to perform 'require_relative' on a set of files
-#
-# @param fileListStr  space-delimited file/path items, without .rb extensions
-# @param subdir  optional path to files relative to this file
-#
-def req(fileListStr,subdir = nil)
-  fileListStr.split(' ').each do |x|
-    if subdir
-      x = File.join(subdir,x)
-    end
-    x += '.rb'
-    require_relative(x)
-  end
-end
-
-# Shorthand for printf(...)
-# @param args passed to printf
-def pr(*args)
-  printf(*args)
-end
-
-# Convert an object to a human-readable string,
-# or <nil>; should be considered a debug-only feature
-# 
-def d(arg)
-  arg.nil? ? "<nil>" : arg.inspect
-end
-
-# Convert an object to a human-readable string,
-# by calling a type-appropriate function: da, dh, or just d.
-# @param arg object
-# @param indent optional indentation for pretty printing; if result
-#          spans multiple lines, each line should be indented by this amount
-#
-def d2(arg, indent = 0)
-  return da(arg, indent) if arg.is_a? Array
-  return dh(arg, indent) if arg.is_a? Hash
-  return df(arg) if arg.class == FalseClass || arg.class == TrueClass
-  return d(arg)  
-end
-
-# Convert an object to a human-readable string, prefixed with its type
-#
-def dt(arg)
-  if arg.nil?
-    return "<nil>"
-  end
-  s = arg.class.to_s
-  s << ':'
-  s << arg.inspect
-  s
-end
-
-# Append a particular number of spaces to a string
-def add_sp(s, indent = 0)
-  s << ' ' * indent
-end
-
-# Pretty-print an array,
-# one element to a line
-# @param indent indentation of each line, in spaces
-def da(array, indent = 0)
-  return d(array) if !array
-  s = 'Array ['
-  indent += 2
-  array.each do |x| 
-    s << "\n"
-    add_sp(s,indent)
-    s2 = d2(x, indent + 2)
-    s << s2
-  end
-  s << " ]"
-  s
-end
-
-# Pretty-print a hash,
-# one element to a line
-# @param indent indentation of each line, in spaces
-def dh(hash, indent = 0)
-  return d(hash) if !hash
-  s = 'Hash {'
-  indent += 2
-  hash.each_pair do |key,val| 
-    s2 = d(key)
-    s3 = d2(val, indent + 4)
-    s << "\n " 
-    add_sp(s,indent)
-    s << s2.chomp << " => " << s3.chomp
-  end
-  s << " }"
-  s
-end
-
-# Generate debug description of a boolean value
-# @param flag value to interpret as a boolean; prints 'T' iff not nil
-# @param label optional label 
-def df(flag, label=nil)
-  s = ''
-  if label
-    s << label << ':'
-  end
-  s << (flag ? "T" : "F")
-  s << ' '
-  s
-end
-
-# Assert that a value is true.  Should be considered a 
-# very temporary, debug-only option; it is slow and
-# generates a warning that it is being called.
-# @param cond condition
-# @param msg generates additional message using printf(), if these arguments exist
-def assert!(cond, *msg)
-  one_time_alert("warning",0,"Checking assertion")
-  if not cond
-    str = (msg.size == 0) ? "assertion error" : sprintf(*msg)
-    raise Exception, str
-  end
-end
-
-# Extensions to the Enumerable module
-#
-module Enumerable
-  # Calculate a value for each item, and return the item with the
-  # highest value, its index, and the value.
-  # @yieldparam function to calculate value of an object, given that object as a parameter
-  # @return the triple [object, index, value] reflecting the maximum value, or
-  #   nil if there were no items
-  def max_with_index 
-    
-    best = nil
-    
-    each_with_index do |obj,ind|
-      sc = yield(obj)
-      if !best || best[2] < sc
-        best = [obj,ind,sc]
-      end
-    end
-    best
-  end
-end
-
-# Get a nice, concise description of the file and line
-# of some caller within the stack.
-# 
-# @param nSkip the number of items deep in the call stack to look
-#
-def get_caller_location(nSkip = 2) 
-  
-  filename = nil
-  linenumber = nil
-  
-  if nSkip >= 0 && nSkip < caller.size
-    fi = caller[nSkip]   
-    
-    i = fi.index(':')
-    j = nil
-    if i
-      j = fi.index(':',i+1)
-    end
-    if j
-      pth = fi[0,i].split('/')
-      if pth.size
-        filename = pth[-1]
-      end
-      linenumber = fi[i+1,j-i-1]  
-    end
-  end
-  if filename && linenumber
-    loc = filename + " ("+linenumber+")"
-  else 
-    loc = "(UNKNOWN LOCATION)"
-  end
-  loc
-end
-
-# Set of alert strings that have already been reported
-# (to avoid printing anything on subsequent invocations)
-#
-$AlertStrings = Set.new
-
-# Print a message if it hasn't yet been printed,
-# which includes the caller's location
-#
-# @param typeString  e.g., "warning", "unimplemented"
-# @param nSkip    the number of levels deep that the caller is in the stack
-# @param args    if present, calls sprintf(...) with these to append to the message
-#
-def one_time_alert(typeString, nSkip, *args) 
-  loc = get_caller_location(nSkip + 2)
-  s = "*** "+typeString+" " + loc
-  if args && args.size
-    s2 = sprintf(args[0], *args[1..-1])
-    msg = s + ": " + s2
-  else 
-    msg = s
-  end
-
-  if $AlertStrings.add?(msg)
-    puts msg
-  end
-end
-     
-# Print a 'warning' alert, one time only 
-# @param args if present, calls printf() with these
-def warn(*args) 
-  one_time_alert("warning",0, *args)
-end
-
-# Convenience method for setting 'db' true within methods,
-# and to print a one-time warning if so.
-# @param val value to set db to; it is convenient to disable
-#    debug printing quickly by adding a zero, e.g., 'warndb 0'
-#
-def warndb(val = true)
-  if !val || val == 0
-    return false
-  end
-  one_time_alert("warning",1, "Debug printing enabled")
-  true
-end
-
-# Print an 'unimplemented' alert, one time only 
-# @param args if present, calls printf() with these
-def unimp(*args)
-  one_time_alert("unimplemented", 0, *args)
-end
-
-# Write a string to a text file
-#
-def write_text_file(path, contents)
-    File.open(path, "wb") {|f| f.write(contents) }
-end
-
-# Read a file's contents, return as a string
-#
-def read_text_file(path)
-  contents = nil
-  File.open(path,"rb") {|f| contents = f.read }
-  contents
-end
-
-# Method that takes a code block as an argument to 
-# achieve the same functionality as Java/C++'s
-#  do {
-#    ...
-#    ...  possibly with 'break' to jump to the end ...
-#  } while (false);
-#
-def block
-  yield
-end
-
-# Exception class for objects in illegal states
-#
-class IllegalStateException < Exception
-end
-
-def to_hex(value, num_digits=4) 
-  s = sprintf("%x", value)
-  s.rjust(num_digits,'0')
-end
-
-def hex_dump(byte_array_or_string, title=nil, offset=0, length= -1, bytes_per_row=16, with_text=true) 
-  ss = hex_dump_to_string(byte_array_or_string, title, offset, length, bytes_per_row, with_text)
-  puts ss
-end
-
-def hex_dump_to_string(byte_array_or_string, title=nil, offset=0, length= -1, bytes_per_row=16, with_text=true)
-  
-  byte_array = byte_array_or_string
-  if byte_array.is_a? String
-    byte_array = byte_array.bytes.to_a
-  end
-  
-  ss = ''
-  
-  if title 
-    ss << title << ":\n"
-  end
-  
-  if length < 0 
-    length = byte_array.size - offset
-  end
-    
-  length = [length, byte_array.size - offset].min
-  
-  max_addr = offset + length - 1
-  num_digits = 4
-  while (1 << (4 * num_digits)) <= max_addr
-    num_digits += 1
-  end
-  
-  while true
-    ss << to_hex(offset, num_digits)
-    ss << ': '
-    
-    chunk = [length, bytes_per_row].min
-    bytes_per_row.times do |i|
-      if i % 4 == 0 
-        ss << '  '
-      end
-      
-      if i < chunk 
-        v = byte_array[offset + i]
-        ss << ((v != 0) ? to_hex(v,2) : '..')
-        ss << ' '
-      else
-        ss << '   '
-      end
-  
-    end
-        
-        
-    if with_text 
-      ss << '  |'
-      bytes_per_row.times do |i|
-        if i < chunk 
-          v = byte_array[offset + i]
-          ss << ((v >= 32 && v < 127) ? v : '_')
-        end
-      end
-      ss << '|'
-    end
-    ss << "\n"
-    
-    length -= chunk
-    offset += chunk
-    break if length <= 0
-  end
-    
-  ss << "\n"
-  ss
-end
-
-$prevTime = nil
-
-# Calculate time elapsed, in seconds, from last call to this function;
-# if it's never been called, returns zero
-def elapsed 
-  curr = Time.now.to_f
-  elap = 0
-  if $prevTime
-    elap = curr - $prevTime
-  end
-  $prevTime = curr
-  elap
-end
-
-# Delete a file or directory, if it exists.
-# Caution!  If directory, deletes all files and subdirectories.
-def remove_file_or_dir(pth)
-  if File.directory?(pth)
-    FileUtils.remove_dir(pth)
-  elsif File.file?(pth)
-    FileUtils.remove_file(pth)
-  end
-end  
-
-require 'stringio'
-
-$IODest = nil
-$OldStdOut = nil
-
-def capture_begin
-    raise IllegalStateException if $IODest
-    $IODest = StringIO.new
-    $OldStdOut, $stdout = $stdout, $IODest
-end
-
-def capture_end
-  raise IllegalStateException if !$IODest
-  $stdout = $OldStdOut  
-  ret = $IODest.string
-  $IODest = nil
-  ret
-end
-
-def match_expected_output(str = nil)
-  
-  if !str
-    str = capture_end
-  end
-  
-  cl_method = caller[0][/`.*'/][1..-2]
-  if (cl_method.start_with?("test_"))
-    cl_method = cl_method[5..-1]
-  end
-  path = "_output_" + cl_method + ".txt"
-#  path = File.absolute_path(path)
-  
-  if !File.file?(path)
-    printf("no such file #{path} exists, writing it...\n")
-    writeTextFile(path,str)
-  else
-    exp_cont = read_text_file(path)  
-    if str != exp_cont
-      d1 = str
-      d2 = exp_cont
-#      d1 = hex_dump_to_string(str,"Output")
-#      d2 = hex_dump_to_string(exp_cont,"Expected")
-            
-      raise IllegalStateException,"output did not match expected:\n#{d1}#{d2}"
-    end
-  end
-end
-
-# Convenience method to detect if a script is being run
-# e.g. as a 'main' method (for debug purposes only).
-# If so, it changes the current directory to the 
-# directory containing the script (if such a directory exists).
-#
-# @param file pass __FILE__ in here
-# @return true if so
-# 
-def main?(file)
-  
-  scr = $0
-
-  # The test/unit framework seems to be adding a suffix ": xxx#xxx.."
-  # to the .rb filename, so adjust in this case
-  i = scr.index(".rb: ")
-  if i
-    scr = scr[0...i+3]
-  end
-
-  if (ret = (file == scr))
-    dr = File.dirname(file)
-    if File.directory?(dr)
-      Dir.chdir(dr)
-    end
-  end
-  ret
-end
-
-if defined? Test::Unit
-  
-  # A simple extension to Ruby's Test::Unit class that provides
-  # suite-level setup/teardown methods.
-  # 
-  # If test suite functionality is desired within a script,
-  # then require 'test/unit' before requiring 'tools.rb'.
-  # This will cause the following class, MyTestSuite, to be defined.
-  #
-  # The user's test script can define subclasses of this,
-  # and declare test methods with the name 'test_xxxx', where
-  # xxxx is lexicographically between 01 and zz.
-  #
-  # There are two levels of setup/teardown called : suite level, and
-  # method level.  For example, if the user's test class performs two tests:
-  #
-  #  def test_b   ... end
-  #  def test_c   ... end
-  #
-  # Then the test framework will make these calls:
-  #
-  #     suite_setup
-  #   
-  #     method_setup
-  #     test_b
-  #     method_teardown
-  #   
-  #     method_setup
-  #     test_c
-  #     method_teardown
-  #   
-  #     suite_teardown
-  #
-  # Notes
-  # -----
-  # 1) The usual setup / teardown methods should NOT be overridden; instead,
-  # use the method_xxx alternatives.
-  #
-  # 2) The base class implementations of method_/suite_xxx do nothing.
-  # 
-  # 3) The number of test cases reported may be higher than you expect, since
-  # there are additional test methods defined by the TestSuite class to
-  # implement the suite setup / teardown functionality.
-  #
-  # 4) Avoid naming test methods that fall outside of test_01 ... test_zz.
-  #
-  class MyTestSuite < Test::Unit::TestCase
-    
-    # This is named to be the FIRST test called.  It
-    # will do suite-level setup, and nothing else.
-    def test_00_setup
-      @@suiteSetup = true
-      suite_setup()
-    end
-    
-    # This is named to be the LAST test called.  It
-    # will do suite-level teardown, and nothing else.
-    def test_zzzzzz_teardown
-      suite_teardown()
-      @@suiteSetup = false
-    end
-    
-    # True if called within suite-level setup/teardown window
-    def _suite_active?
-      !(@__name__ == "test_00_setup" || @__name__ == "test_zzzzzz_teardown")
-    end
-    
-    def setup
-      if _suite_active?
-        # If only a specific test was requested, the
-        # suite setup may not have run... if not, do it now.
-        if !defined? @@suiteSetup
-          suite_setup
-        end
-        return 
-      end
-      method_setup
-    end
-    
-    def teardown
-      if _suite_active?
-        if !defined? @@suiteSetup
-          suite_teardown
-        end
-        return 
-      end
-      method_teardown
-    end
-  
-    def suite_setup
-    end
-    
-    def suite_teardown
-    end
-    
-    def method_setup
-    end
-    
-    def method_teardown
-    end
-  end
-end
-
-# Construct a string from an array of bytes 
-# @param byte_array array of bytes, or string (in which case it
-#   returns it unchanged)
-#
-def bytes_to_str(byte_array)
-  return byte_array if byte_array.is_a? String
-  
-  byte_array.pack('C*')
-end
-
-# Construct an array of bytes from a string  
-# @param str string, or array of bytes (in which case it
-#   returns it unchanged)
-#
-def str_to_bytes(str)
-  return str if str.is_a? Array
-  str.bytes
-end
-
-# Get directory entries, excluding '.' and '..'
-#
-def dir_entries(path)
-  ents = Dir.entries(path)
-  ents.reject!{|entry| entry == '.' || entry == '..'}
-end
-
-def int_to_bytes(x)
-  [(x >> 24) & 0xff, (x >> 16) & 0xff, (x >> 8) & 0xff, x & 0xff]
-end
-  
-def short_to_bytes(x) 
-  [(x >> 8) & 0xff, x & 0xff]
-end
- 
-# Decode a short from an array of bytes (big-endian).
-# @param ba array of bytes
-# @param offset offset of first (most significant) byte
-#
-def short_from_bytes(ba, offset=0) 
-  (ba[offset] << 8) | ba[offset + 1] 
-end
-    
-# Decode an int from an array of bytes (big-endian).
-# @param ba array of bytes
-# @param offset offset of first (most significant) byte
-#
-def int_from_bytes(ba, offset=0) 
-  (((((ba[offset] << 8) | ba[offset + 1]) << 8) | \
-      ba[offset + 2]) << 8) | ba[offset + 3]
-end
-
-# Transform string to 8-bit ASCII (i.e., just treat each byte as-is)
-#
-def to_ascii8(str)
-  str.force_encoding("ASCII-8BIT")
-end
-
-# Verify that a string is encoded as ASCII-8BIT
-def simple_str(s)
-  if s.encoding.name != 'ASCII-8BIT' && s.encoding.name != 'UTF-8'
-    pr("string [%s]\n encoding is %s,\n expected ASCII-8BIT\n",s,s.encoding.name)
-    assert!(false)
-  end
-end
-
-# Truncate or pad string so it has a particular size
-#
-# @param s input string
-# @param size 
-# @param pad padding character to use if string needs to grow
-# @return modified string
-#
-def str_sized(s, size, pad="\0")
-  s[0...size].ljust(size,pad)
-end
-
-# Determine if running on the Windows operating system.
-# Note: there is some debate about the best way to do this.
-#
-def windows?
-  if !defined? $__windows__
-    $__windows__ = (RUBY_PLATFORM =~ /mswin/)
-  end
-  $__windows__
-end