dir-to-xml 1.0.8 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe35ab7508e85463cf2aeb0105e30e38372912a8a47f7d90a298caa702ff0dd
-  data.tar.gz: fff6e43ea00d6a697e0b4aaa7aedbd5ef7d38645756b01329b0f9095edea3b11
+  metadata.gz: c0d019bf13b52e143181d63f55ecb59d4afd6d0528316f8eabc98dad63d7701e
+  data.tar.gz: 706dfd39b2ec9a414394374736bc390a9fc786243181ccdc65ca4c7b42f16f90
 SHA512:
-  metadata.gz: 06ee8ffb01712045e85717db1c74f67ccd68e526ee74e18d1905800eea6d55d75e634badb9f13b00f36d5eac1204d1ea62961db5f84ad03ae49bd9f1c36dae86
-  data.tar.gz: 8243bee16134b8a3d41de944b37eff432fcd7b785f83703537ff156d4e6f127cc17c59c858e957b942fc21e24b1805d24fa0608e1f539f7226d3a16f0f4235b4
+  metadata.gz: 761c9d38635ad4b9391a8b532713c2c8aa0c3b7e08172d811bf60772135392e4e8fbfc477239083cae926255c005aa689963d03b13aa5965b6a32804f7270067
+  data.tar.gz: d067ed9b1577125f7bc3b6cf8527531f9ced333a687486e65576307b4462d8ce27f2216042121147d64561e107e5f97d18d82b42a3e6cb4e732ddcbd4f1e9b61

data/lib/dir-to-xml.rb

@@ -2,308 +2,264 @@
 
 # file: dir-to-xml.rb
 
+require 'c32'
 require 'dxlite'
 
 
-class DirToXML
-
-  attr_reader :dx, :activity
-
-  def initialize(x= '.', recursive: false, index: 'dir.xml', debug: false)
+# How dir-to-xml should work
+#
+# if the dir.xml file doesn't exist then
+#
+#   generate the dir.xml file
+#
+# else
+#
+#   # the dir.xml file does exist
+#
+#   # check for one of the following:
+#   #  1 or more new files
+#   #  1 or more removed files
+#   #  1 or more modified files
+#
+# note: Ideally The index needs to be stored and retrieved the fastest way possible.
+#       This is why it's saved as a .json file rather .xml
+#
+# tested:
+# * finding the latest file in the current directory
+# * finding the latest file in a sub-directory (using recursive: true)
 
-    super()
 
-    @debug = debug
-
-    @dx = nil
-    @activity = {new: [], modified: []}
+class DirToXML
+  using ColouredText
+  include RXFHelperModule
 
-    if x.is_a? DxLite then
+  attr_reader :new_files, :deleted_files, :dx, :latest_files, :latest_file
 
-      @dx = x
-      @a = @dx.to_a
-      @object = @a
+  def initialize(obj= '.', index: 'dir.json', recursive: false,
+                 verbose: true, debug: false)
 
-      return self
+    if verbose then
+      puts
+      puts 'DirToXML at your service!'.highlight
+      puts
+      puts
     end
 
-    path = x
+    @index, @recursive, @verbose, @debug = index, recursive, verbose, debug
 
-    @path, @index, @recursive = path, index, recursive
+    if File.basename(obj) == index then
 
-    raise "Directory not found." unless File.exists? path
-    filepath = File.join(path, index)
+      #read the index file
+      @path = File.dirname(obj)
+      puts 'intialize() @path: ' + @path.inspect if @debug
 
-
-    if File.exists? filepath then
-
-      @dx = DxLite.new(File.join(@path, @index), debug: @debug)
+      @dx = read(obj)
 
     else
+      @path = obj
+      puts 'intialize() @path: ' + @path.inspect if @debug
 
-      @dx = DxLite.new('directory[title, file_path, last_modified, ' + \
-              'description]/file(name, type, ext, ctime, mtime, atime, ' + \
-              'description, owner, group, permissions)')
-
-      puts 'before title' if @debug
-      @dx.title = 'Index of ' + File.expand_path(@path)
-      @dx.file_path = File.expand_path(@path)
-      @dx.last_modified = ''
-
+      new_scan()
     end
 
-    if @debug then
-      puts 'before Dir.glob'
-      puts '_path: ' + File.join(path, "*").inspect
-    end
+  end
 
-    a = Dir.glob(File.join(path, "*")).map{|x| File.basename(x) }.sort
-    puts 'a: ' + a.inspect if @debug
+  def activity()
+    {
+      new: @new_files,
+      deleted: @deleted_files,
+      modified: @latest_files
+    }
+  end
 
-    a.delete index
+  alias changes activity
 
-    return if a.empty?
+  def directories()
+    @dx.all.select {|x| x.type == 'directory'}.map(&:name)
+  end
 
-    a2 = a.inject([]) do |r, filename|
+  def find_all_by_ext(s)
+    @dx.find_all_by_ext(s)
+  end
 
-      x = File.join(path, filename)
+  def find_by_filename(s)
+    @dx.find_by_filename(s)
+  end
 
-      begin
-      r << {
-        name: filename,
-        type: File::ftype(x),
-        ext: File.extname(x),
-        ctime: File::ctime(x),
-        mtime: File::mtime(x),
-        atime: File::atime(x)
-      }
-      rescue
-        r
-      end
+  def latest()
 
+    if @latest_file then
+      File.join(@latest_file[:path], @latest_file[:name])
     end
 
-    # has the directory been modified since last time?
-    #
-    if @dx and @dx.respond_to? :last_modified and \
-        @dx.last_modified.length > 0 then
-
-      puts 'nothing to do' if @debug
-      puts 'a2: ' + a2.inspect if @debug
-      file = a2.max_by {|x| x[:mtime]}
-
-      if @debug then
-        puts 'file: ' + file.inspect
-        puts 'd1: '  + Time.parse(@dx.last_modified).inspect
-        puts 'd2: ' + (file[:mtime]).inspect
-      end
-
-      if Time.parse(@dx.last_modified) >= file[:mtime] then
-        @a = @dx.to_a
-        return
-      end
+  end
 
-    end
+  def new_scan()
 
-    puts 'stage 2' if @debug
+    t = Time.now
+    records = scan_dir @path
+    puts 'new_scan() records: ' + records.inspect if @debug
 
-    if @dx and @dx.respond_to? :last_modified  then
+    a = records.map {|x| x[:name]}
 
-      if @dx.last_modified.length > 0 then
+    if FileX.exists? File.join(@path, @index) then
 
-        t = Time.parse(@dx.last_modified)
+      @dx = read()
 
-        # find the most recently modified cur_files
-        recent = a2.select {|x| x[:mtime] > t }.map {|x| x[:name]} \
-            - %w(dir.xml dir.json)
+      old_records = @dx.to_a
+      a2 = old_records.map {|x| x[:name]}
 
-        # is it a new file or recently modified?
-        new_files = recent - @dx.to_a.map {|x| x[:name]}
-        modified = recent - new_files
+      # delete any old files
+      #
+      @deleted_files = a2 - a
 
-      else
+      if @deleted_files.any? then
 
-        new_files = a2.select {|x| x[:type] == 'file'}.map {|x| x[:name]}
-        modified = []
+        @deleted_files.each do |filename|
+          record = @dx.find_by_name filename
+          record.delete if record
+        end
 
       end
 
-      @activity = {modified: modified, new: new_files}
-
-    end
+      # check for newly modified files
+      # compare the file date with index file last modified date
+      #
+      dtx_last_modified = Time.parse(@dx.last_modified)
 
+      select_records = records.select do |file|
 
-    command = File.exists?(File.join(path, index)) ? :refresh : :dxify
+        file[:mtime] > dtx_last_modified or file[:type] == 'directory'
 
-    self.method(command).call a2
-    puts '@dx: ' + @dx.inspect if @debug
-    puts '@dx.last_modified: ' + @dx.last_modified.inspect if @debug
+      end
 
+      puts 'select_records: ' + select_records.inspect if @debug
+      find_latest(select_records) if select_records.any?
 
-    @a = @dx.to_a
+      # Add any new files
+      #
+      @new_files = a - a2
 
-    if recursive then
+      if @new_files.any? then
 
-      self.filter_by(type: :directory).to_a.each do |x|
+        @dx.last_modified = Time.now.to_s
+        @dx.import @new_files.map {|filename| getfile_info(filename) }
 
-        path2 = File.join(path, x[:name])
-        DirToXML.new(path2, recursive: true)
       end
-    end
 
-    @object = @a
+      @dx.last_modified = Time.now.to_s if @deleted_files.any?
 
-  end
+    else
 
-  def directories(&blk)
+      @dx = new_index(records)
+      find_latest(records)
 
-    self.to_dx.all.select {|x| x.type == 'directory'}.map(&:name)
+    end
 
-  end
+    t2 = Time.now - t
+    puts ("directory scanned in %.2f seconds" % t2).info if @verbose
 
-  def filter(&blk)
-    @dx.filter &blk
   end
 
-  def filter_by(pattern=/.*/, type: nil, ext: nil, &blk)
+  def read(index=@index)
 
-    @object = @a.select do |x|
+    t = Time.now
+    puts 'read path: ' + File.join(@path, index).inspect if @Debug
 
-      puts '_x: ' + x.inspect if @debug
-      pattern_match = x[:name] =~ pattern
+    dx = DxLite.new(File.join(@path, index), autosave: true)
 
-      type_match = type ? x[:type] == type.to_s : true
-      ext_match = ext ? x[:ext] == ext.to_s : true
+    t2 = Time.now - t
+    puts ("%s read in %.2f seconds" % [@index, t2]).info if @verbose
 
-      pattern_match and type_match and ext_match
+    return dx
 
-    end
-
-    return if @object.empty?
-
-    @dx = DxLite.new
-    @dx.import @object
-
-    block_given? ? @dx.all.map(&:name).each(&blk) : self
-
-  end
-
-  def find_all_by_ext(s)
-    @dx.all.select {|item| item.ext == s}
-  end
-
-  def find_by_filename(s)
-    @dx.all.find {|item| item.name == s}
   end
 
-  alias find_by_file find_by_filename
-
-  def last_modified(ext=nil)
+  private
 
-    if ext and ext != '*' then
-      @object = @a.select{|x| x[:ext][/#{ext}/] or x[:type] == 'directory'}
-    end
+  def find_latest(files)
 
-    a = sort_by :mtime
+    @latest_files = files.sort_by {|file| file[:mtime]}
+    puts '@latest_files:  ' + @latest_files.inspect if @debug
 
-    lm =  a[-1]
+    @latest_file = @latest_files[-1]
+    @latest_file[:path] = @path
+    puts ':@latest_file: ' + @latest_file.inspect if @debug
 
-    if @recursive and lm[:type] == 'directory' then
-      return [lm, DirToXML.new(File.join(@path,  lm[:name])).last_modified]
-    else
-      lm
-    end
-  end
+    dir_list = directories()
 
-  def save()
-    @dx.save File.join(@path, @index)
-  end
+    if dir_list.any? then
 
-  def select_by_ext(ext, &blk)
+      dir_latest = dir_list.map do |dir|
 
-    @a = @dx.to_a unless @a
+        puts 'dir: ' + dir.inspect if @debug
+        dtx2 = DirToXML.new(File.join(@path, dir), index: @index,
+                            recursive: true, verbose: false, debug: @debug)
+        [dir, dtx2.latest_file]
 
-    @object = ext != '*' ? @a.select{|x| x[:ext][/#{ext}$/]} : @a
-    return if @object.empty?
+      end.reject {|_,latest|  latest.nil? }.sort_by {|_, x| x[:mtime]}.last
 
-    dx = DxLite.new
-    dx.import @object
-    dtx = DirToXML.new(dx)
-    block_given? ? dtx.dx.all.map(&:name).each(&blk) : dtx
-  end
+      puts 'dir_latest: ' + dir_latest.inspect if @debug
 
-  def sort_by(sym)
+      @latest_file = if dir_latest and \
+                          ((dir_latest.last[:mtime] > latest_file[:mtime]) \
+                                     or latest_file.nil? \
+                                     or latest_file[:type] == 'directory') then
 
-    puts 'inside sort_by' if @debug
-    procs = [
-      [
-        :mtime,
-        lambda do |obj|
-          obj.sort_by do |x|
-            x[:mtime].is_a?(String) ? Time.parse(x[:mtime]) : x[:mtime]
-          end
-        end
-      ]
-    ]
-    proc1 = procs.assoc(sym).last
+        dir_latest.last[:path] = File.expand_path(File.join(@path, dir_latest.first))
+        dir_latest.last
 
-    puts '@object: ' + @object.inspect if @debug
-    @object = @a = @dx.to_a if @object.nil?
-    proc1.call(@object)
+      elsif latest_file and latest_file[:type] == 'file'
 
-  end
+        latest_file[:path] = File.expand_path(@path)
+        latest_file
 
-  def sort_by_last_modified()
-    sort_by :mtime
-  end
+      end
 
-  alias sort_by_lastmodified sort_by_last_modified
+    else
+      return
+    end
 
-  def to_a
-    @object || @a
   end
 
-  def to_h()
-    self.to_a.inject({}){|r,x| r.merge(x[:name] => x)}
-  end
+  def getfile_info(filename)
 
-  def to_xml(options=nil)
-    @dx.to_xml options
-  end
+    x = File.join(@path, filename)
+    puts 'x: ' + x.inspect if @debug
 
-  def to_dynarex
-    @dx.clone
+    begin
+      {
+        name: filename,
+        type: File::ftype(x),
+        ext: File.extname(x),
+        mtime: File::mtime(x),
+        description: ''
+      }
+    end
   end
 
-  alias to_dx to_dynarex
+  def new_index(records)
 
-  private
+    dx = DxLite.new('directory[title, file_path,  ' +
+                      'last_modified, description]/file(name, ' +
+                                    'type, ext, mtime, description)')
 
-  def dxify(a)
+    puts 'before title' if @debug
+    dx.title = 'Index of ' + @path
+    dx.file_path = @path
+    dx.last_modified = Time.now
+    dx.import records.reverse
+    dx.save File.join(@path, @index)
 
-    @dx.last_modified = Time.now.to_s  if @dx.respond_to? :last_modified
-    @dx.import a
-    @dx.save File.join(@path, @index)
+    return dx
 
   end
 
-  def refresh(cur_files)
-
-    puts 'inside refresh' if @debug
-
-    prev_files = @dx.to_a
-
-    #puts 'prev_files: ' + prev_files.inspect
-    #puts 'cur_files: ' + cur_files.inspect
-
-    cur_files.each do |x|
-
-      file = prev_files.find {|item| item[:name] == x[:name] }
-      #puts 'found : ' + file.inspect if @debug
-      x[:description] = file[:description] if file and file[:description]
-    end
+  def scan_dir(path)
 
-    dxify(cur_files)
+    a = DirX.glob(File.join(path, "*")).map {|x| File.basename(x) }
+    a.delete @index
+    a.map {|filename| getfile_info(filename) }
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dir-to-xml
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.3
 platform: ruby
 authors:
 - James Robertson
@@ -11,52 +11,72 @@ cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEXjCCAsagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFnZW1t
-  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjEwMTIzMTgwNTQ4WhcN
-  MjIwMTIzMTgwNTQ4WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
-  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC3/Li6
-  /b2XI6+wLVA57zxSEu6RtQqu94GlPisH87ziQS+xYDYq8MqrlqHwA2O6GyK+dnCS
-  V0pdXagOSMj27drmy9j6AhdOGxZTvB4M+q2uxxSt1AU8jAlKVBhRiKt15sbSF43K
-  3cY/PrccN4XpJT1YD44WU4+FwaGatFwcAsHtPpxYZgYMZj1sY+wnlKklqBrcWo6H
-  21+fRAVgHi5dqypH6Yez5Rc2rUKEg72OIU76iSjyx9XP8CiX4sxSqw+HRwyCkjKx
-  d5Onb6vhlSyWpBwRmPRP1bbiztxho4Pla28HM+qVvLIqHpCYoWZi2xmKBoJ5oKPx
-  cUj1ThI5nucnixrbg5dUjhJF9Ews4PukHtG2uIc/7WG+vCbZHn2CZNqH4HfB8cW5
-  yoeD4sBFEJwzK8nfGZuAwJ0yOi8yZTqcW8HyK/IVXH+fqC1NsQVEL5yYhnaCCVvx
-  ShG2g5rh48kNN5CsIQb87WP3J/YnsXhIz3+dwJPmLt+QuWE6sI1NkGWHQFECAwEA
-  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUEmUqvmku
-  azMk41rHySinmAUmae8wJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
+  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjIwMjEwMTcwNzMwWhcN
+  MjMwMjEwMTcwNzMwWjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
+  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCjKYHi
+  pAa4sq7iRTV7XB75YoxA+OKNh8nqMnSNeOw3lJ3UYW4ulFKOvD+2LddRH1DD3CrP
+  0AYx2MI56Pu/UgtLZkze5pMf6CqLn8MCvonuSjNTj01bDi+fq8xAKu85LwG3xVP3
+  kqMCppRwlf7wtkc8tkC6vjc+GhggwTda8z7quTtiVpy2r3JJUs4QXDTqzfKNC+la
+  dueojDyI3m6mmaGyoT3k3LpTc0Vjg3JeiYsyWxGvK6R0JWqZiv7uwlxtzvuK/v5h
+  1iMhim2hB/6pFZalAddVfzvPCQiRek7nDKxPgvMDze2GIzvrpOapntu18nC1FYnO
+  kAC8vIStaFxmYzZYMB5h8C5q2xhJ3u6uGdyhpMuwvQOkhq4jdvI8SJ04eBhQH0DI
+  ta8OyiPQoqwegXXhBGU35/yZczB6QFswBaw7jTFcya1YKFDvXmLWOl0g6UOFnl66
+  QXnaC/xwRBh48VGALRPCgHuSf0Ag5LP+rv52s6Fbbs5B6syj059gNLO+DKkCAwEA
+  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU/5KH1BIb
+  QxZC8hteME4fAEsveW8wJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
   c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1hc3RlckBqYW1lc3JvYmVydHNvbi5ldTAN
-  BgkqhkiG9w0BAQsFAAOCAYEAUyL0Sh3Ld6sK0fldg057McECcaOIyB/nKJApz1er
-  ET9qYthBvhpcaNNo19NFuf9W9UyaE6RI9Eb07DvGYyVP/b0yTrIKyzXzSAwFmrek
-  3VUVAhdqOIrIrf16Zpm4NoOGTOst+6sXZ9KQ52DPPwxdLbRCL7HkUFBMIVf2x2LV
-  XflA8IOlSUPH2vmHJnE0yfs7Lzd5+xYpKeOzQSHo0p+SBDzIim3mOZ3ryf4IZQhv
-  wh0fYGJ2iC/w3rPA78Awm6FNPlGCPjgPIz4mliMicRI/sZmFQvn8+2HYWEzDDOO8
-  zYvUB7rkjDGXYqN1Ft3N6EOuNworOFjUlcPrDFCQHf4UgPjD6Z8WbYkI9c7LWtjc
-  HJCyl/PVyS0Srbl8IPn7JsgUCS7S02KOnVzukQ7PTc1wBlAZ4mNb7N9EOp90GP9a
-  YSREEphg3phQsU9LV4Dlc2Id4gB3W+//c1Ek6TFieKoVemKMkbtB1lgqsEpTCfwh
-  oNUg84DlSmZ2z9LKagBVAlDy
+  BgkqhkiG9w0BAQsFAAOCAYEAXGQs4E7LZmG5OckxSpsJVhHaRYXp7ZghKTbn/K6X
+  fEtU8x781gphdo4wNOg8XA4MGAmZTBRi+7x9JE/NmxkC8KtqMSR89ynUtlhRldkF
+  +4uiJNtUSn9Ya3RyfUADF7gJ9OM4WpjXbpXBLtHe+GETjwl3EfDGQ6SNiUCRRaH+
+  DXthsMNrME6QFQ+n2IW7E2nn6ElLACWRUA1lqyRSC6doomKS3BIOmMmZ4aBrtIlB
+  3zBEnu2eXHgd2OkfIiFO+DU2wVF2cs01V41lk575rciiWKGfybmDT3+CQu3kTUHz
+  PkegIP3JOdHPhLsfzgycgbjOaNSEX21SDhPwmLmSng0oNn56N9Po1qFKUG0+XxvA
+  qkFeIsspayVS94HDHTs68XQx4XsZJHfV/H9Sw331V1H7QJkXdbmEDVHXa5D+lI4g
+  m7hEq9GAsvYejQNMhcxlvi+e70d3QiEg+2SVsBHaUGURzv0LjycCOjOaUxQA5swC
+  JKGINad8xoEL7XIDoO6EnBcY
   -----END CERTIFICATE-----
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: c32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: dxlite
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.2
 description: 
 email: digital.robertson@gmail.com
 executables: []
@@ -76,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.3
+      version: 3.0.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="