net-ftp-list 3.2.11 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac7690dd10010600fa4b5d91dbd083f549361bd279381ee44194948d0d10cc2
-  data.tar.gz: 6effa8abfb935b263038ebcf7a993bd77334f7d57c0631065b04781563a7e632
+  metadata.gz: 3664e5c75774117ae0ec40734948526a60d5f8b55a38629a9abe56e0d2599813
+  data.tar.gz: 26ebefa96b9b63150c4c63af7c7912c8346f9ae080066eac3d37a198264645a7
 SHA512:
-  metadata.gz: 152ab46668a0b77b896d444d1ef2d4ef1c32c9d9106f5d6e203c2864757e2e045c1663c906b35eaa599361fccda8a5c726975f1c229ed4ae479510d4825b055a
-  data.tar.gz: e0e1b61861bd271da806f44503595b14fc4580b2166981f701446957d34af225de1da90bfa1da7fa075854055234a69bf9df80b42d8728f040537cfac4978221
+  metadata.gz: cff6489e1af74de5c0c25b5b5461b2be0ce57f4cb52086d36f7876836db07cacd120e3e34143c63d0ea06ad7504092ff1702ff7c87513368468aee72ef2486ad
+  data.tar.gz: 655bee68bff7169c0ab47f6e9124c129e6339b953e635165cb7feebd82fa44a85b921d688b63b432ad0eab8c7c8a189107ab538f5ec4bfdca8df0ec22f1f3ff7

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.idea/*
+.idea/**/*
+*.gem
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: "2.5"
+
+Metrics/ParameterLists:
+  Exclude:
+    - lib/net/ftp/list/entry.rb
+Metrics/MethodLength:
+  Exclude:
+    - lib/net/ftp/list/unix.rb
+    - test/**/*.rb

data/Gemfile

@@ -1,6 +1,2 @@
 source 'https://rubygems.org'
-
-group :development do
-  gem 'jeweler'
-  gem 'test-unit'
-end
+gemspec

data/Gemfile.lock

@@ -1,63 +1,59 @@
+PATH
+  remote: .
+  specs:
+    net-ftp-list (3.3.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    builder (3.2.3)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.16.0)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      mime-types (>= 1.16, < 3.0)
-      oauth2 (~> 1.0)
-    hashie (3.5.7)
-    highline (1.7.10)
-    jeweler (2.3.9)
-      builder
-      bundler
-      git (>= 1.2.5)
-      github_api (~> 0.16.0)
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      psych
-      rake
-      rdoc
-      semver2
-    jwt (1.5.6)
-    mime-types (2.99.3)
-    mini_portile2 (2.3.0)
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    power_assert (1.1.1)
-    psych (3.0.2)
-    rack (2.0.4)
-    rake (12.3.1)
-    rdoc (6.0.3)
-    semver2 (3.4.2)
-    test-unit (3.2.7)
+    ast (2.4.2)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    power_assert (2.0.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.6.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    test-unit (3.4.1)
       power_assert
-    thread_safe (0.3.6)
+    timecop (0.9.4)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler
+  net-ftp-list!
+  rake
+  rubocop-bsm
   test-unit
+  timecop
 
 BUNDLED WITH
-   1.16.1
+   2.2.14

data/Rakefile

@@ -1,54 +1,22 @@
-require 'rubygems'
-require 'rake'
-require 'yaml'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "net-ftp-list"
-    gem.summary = %Q{Parse FTP LIST command output.}
-    gem.email = "enquiries@statelesssystems.com"
-    gem.homepage = "http://github.com/stateless-systems/net-ftp-list"
-    gem.authors = ["Stateless Systems"]
-  end
-  Jeweler::RubygemsDotOrgTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rdoc/task'
+require 'rubocop/rake_task'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :default => :test
-
-require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "net-ftp-list #{version}"
+  rdoc.title = 'net-ftp-list'
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop test]

data/lib/net/ftp/list.rb

@@ -21,9 +21,9 @@ module Net::FTP::List
   end
 
   # Parse a line from FTP LIST responsesa and return a Net::FTP::List::Entry
-  def self.parse(*args)
-    Parser.with_each_parser do | p |
-      entry = p.parse(*args)
+  def self.parse(*args, **opts)
+    Parser.parsers.each do |parser|
+      entry = parser.parse(*args, **opts)
       return entry if entry
     end
   end
@@ -32,4 +32,3 @@ module Net::FTP::List
   class ParseError < RuntimeError
   end
 end
-

data/lib/net/ftp/list/entry.rb

@@ -2,17 +2,28 @@
 class Net::FTP::List::Entry
   include Comparable
 
-  ALLOWED_ATTRIBUTES = [:raw, :basename, :dir, :file, :symlink, :mtime, :filesize, :device, :server_type, :symlink_destination] #:nodoc:
+  attr_reader :raw, :basename, :type, :filesize, :mtime, :server_type, :symlink_destination
+  alias to_s raw
+  alias name basename
+  alias size filesize
 
   # Create a new entry object. The additional argument is the list of metadata keys
   # that can be used on the object. By default just takes and set the raw list entry.
   #   Net::FTP::List.parse(raw_list_string) # => Net::FTP::List::Parser instance.
-  def initialize(raw_ls_line, optional_attributes = {}) #:nodoc:
+  def initialize(raw_ls_line,
+    basename: nil,
+    type: nil,
+    mtime: nil,
+    filesize: nil,
+    server_type: nil,
+    symlink_destination: nil) #:nodoc:
     @raw = raw_ls_line.respond_to?(:force_encoding) ? raw_ls_line.force_encoding('utf-8') : raw_ls_line
-    optional_attributes.each_pair do |key, value|
-      raise ArgumentError, "#{key} is not supported" unless ALLOWED_ATTRIBUTES.include?(key)
-      instance_variable_set("@#{key}", value.respond_to?(:force_encoding) ? value.force_encoding('utf-8') : value)
-    end
+    @basename = basename || ''
+    @type = type
+    @mtime = mtime || Time.now
+    @filesize = filesize || 0
+    @server_type = server_type || 'Unknown'
+    @symlink_destination = symlink_destination
   end
 
   # Tests for objects equality (value and type).
@@ -22,83 +33,52 @@ class Net::FTP::List::Entry
   # @return [true, false] true if the objects are equal and have the same type; false otherwise.
   #
   def eql?(other)
-    return false if !other.instance_of? self.class
-    return true if self.object_id == other.object_id
+    return false unless other.is_a?(::Net::FTP::List::Entry)
+    return true if equal?(other)
 
-    self.raw == other.raw # if it's exactly the same line then the objects are the same
+    raw == other.raw # if it's exactly the same line then the objects are the same
   end
 
-
   # Compares the receiver against another object.
   #
   # @param (see #eql?)
   #
-  # @return [Fixnum]  -1, 0, or +1 depending on whether the receiver is less than, equal to, or greater than the other object.
+  # @return [Integer]  -1, 0, or +1 depending on whether the receiver is less than, equal to, or greater than the other object.
   #
   def <=>(other)
-    if other.instance_of? self.class
-      return self.filesize <=> other.filesize
-    elsif other.instance_of? Fixnum or other.instance_of? Integer or other.instance_of? Float
-      return self.filesize <=> other
+    case other
+    when ::Net::FTP::List::Entry
+      return filesize <=> other.filesize
+    when Numeric
+      return filesize <=> other
     end
-    raise ArgumentError.new('comparison of %s with %s failed!' % [self.class, other.class])
-  end
 
-  # The raw list entry string.
-  def raw
-    @raw ||= ''
-  end
-  alias_method :to_s, :raw
-
-  # The items basename (filename).
-  def basename
-    @basename ||= ''
-  end
-  alias name basename
-
-  # Symlink destination, the "/etc" in "bar -> /etc". May be nil.
-  def symlink_destination
-    @symlink_destination
+    raise ArgumentError, format('comparison of %<self>s with %<other>s failed!', self: self.class, other: other.class)
   end
 
   # Looks like a directory, try CWD.
   def dir?
-    !!(@dir ||= false)
+    type == :dir
   end
   alias directory? dir?
 
   # Looks like a file, try RETR.
   def file?
-    !!(@file ||= false)
+    type == :file
   end
 
   # Looks like a symbolic link.
   def symlink?
-    !!(@symlink ||= false)
+    type == :symlink
   end
 
   # Looks like a device.
   def device?
-    !!(@device ||= false)
-  end
-
-  # Returns the modification time of the file/directory or the current time if unknown
-  def mtime
-    @mtime || Time.now
-  end
-
-  # Returns the filesize of the entry or 0 for directorties
-  def filesize
-    @filesize || 0
-  end
-  alias size filesize
-
-  # Returns the detected server type if this entry
-  def server_type
-    @server_type || "Unknown"
+    type == :device
   end
 
+  # Is the entry type unknown?
   def unknown?
-    @dir.nil? && @file.nil? && @symlink.nil? && @device.nil?
+    !dir? && !file? && !symlink? && !device?
   end
 end

data/lib/net/ftp/list/microsoft.rb

@@ -11,36 +11,34 @@ require 'date'
 class Net::FTP::List::Microsoft < Net::FTP::List::Parser
   REGEXP = %r!
     ^\s*
-    ([0-9\-:\/]{5,})\s+([0-9\-:]{3,}(?:[aApP][mM])?)\s+
+    ([0-9\-:/]{5,})\s+([0-9\-:]{3,}(?:[aApP][mM])?)\s+
     (?:(<DIR>)|([0-9]+))\s+
     (\S.*)
     \s*$
-  !x
+  !x.freeze
 
   # Parse a Microsoft(NT) like FTP LIST entries.
-  def self.parse(raw)
+  def self.parse(raw, timezone: :utc)
     match = REGEXP.match(raw.strip) or return false
 
-    date_match = %r!(\d\d).(\d\d).(\d\d(?:\d\d)?)!.match(match[1])
+    date_match = /(\d\d).(\d\d).(\d\d(?:\d\d)?)/.match(match[1])
     date_format = date_match[1].to_i > 12 ? '%d-%m-%y' : '%m-%d-%y'
-    date_format.sub!(%r{%y}, '%Y') if date_match[3].length > 2
+    date_format.sub!(/%y/, '%Y') if date_match[3].length > 2
 
-    if match[1] !~ /\-/
-      date_format.gsub!(/\-/, '/') if match[1] =~ %r{/}
-      date_format.gsub!(/\-/, ':') if match[1] =~ %r{:}
+    unless /-/.match?(match[1])
+      date_format.tr!('-', '/') if %r{/}.match?(match[1])
+      date_format.tr!('-', ':') if /:/.match?(match[1])
     end
 
-    mtime = DateTime.strptime("#{match[1]} #{match[2]}", "#{date_format} %H:%M%p")
-    is_dir = match[3] == '<DIR>'
-    filesize = is_dir ? 0 : match[4].to_i
+    mtime = parse_time("#{match[1]} #{match[2]}", format: "#{date_format} %H:%M%p", timezone: timezone)
+    type  = match[3] == '<DIR>' ? :dir : :file
 
     emit_entry(
       raw,
-      :dir => is_dir,
-      :file => !is_dir,
-      :filesize => filesize,
-      :basename => match[5],
-      :mtime => mtime
+      type: type,
+      filesize: match[4].to_i,
+      basename: match[5],
+      mtime: mtime,
     )
   end
 end