net-ftp-list 0.3 → 0.4

data/README.txt

@@ -21,20 +21,14 @@ See the RFC for more guff on LIST and NLST: http://www.ietf.org/rfc/rfc0959.txt
 * The factory and abstract base class for parsers are one and the same. OO geeks will cry.
 * More OS's and server types. Only servers that return Unix like LIST responses will work at the moment.
 * Calling <tt>if entry.file? or entry.dir?</tt> is hard work when you really mean <tt>unless entry.unknown?</tt>
-* I'm not sure about overwriting Net::FTP's +list+, +ls+ and +dir+. It's a base lib after all and people will be
-  expecting String. Perhaps I'd be better to <tt>class Parser < String</tt> for the abstract parser.
-* The block handling for +list+, +ls+ and +dir+ has a nasty +map+ that's essentially building up an unused Array.
 
 == SYNOPSIS
 
-By requiring Net::FTP::List instances are created by calling any of Net::FTP's <tt>list</tt>, <tt>ls</tt> or
-<tt>dir</tt> metods. The <tt>to_s</tt> method still returns the raw line so for the most part this should be
-transparent.
-
   require 'net/ftp' # Not really required but I like to list dependencies sometimes.
   require 'net/ftp/list'
 
   ftp = Net::FTP.open('somehost.com', 'user', 'pass')
+  ftp.extend Net::FTP::List # Tweak list, ls and dir to returned parsed content.
   ftp.list('/some/path') do |entry|
     # Ignore everything that's not a file (so symlinks, directories and devices etc.)
     next unless entry.file?

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
 require 'rake/testtask'
 
 NAME = 'net-ftp-list'
-VERS = '0.3'
+VERS = '0.4'
 
 CLEAN.include ['**/*.log', '*.gem']
 CLOBBER.include ['**/*.log']

data/lib/net/ftp/list.rb

@@ -8,30 +8,18 @@ require 'net/ftp/list/unix'
 module Net #:nodoc:
   class FTP #:nodoc:
 
-    alias_method :raw_list, :list
-    def list(*args, &block)
-      # TODO: Map in void context when you pass a block.
-      raw_list(*args).map do |raw|
-        entry = Net::FTP::List.parse(raw)
-        block ? yield(entry) : entry
-      end
-    end
-
     # Parse FTP LIST responses.
     #
-    # Simply require the library and each entry from Net::FTP +list+, +ls+ or +dir+ methods will
-    # be parsed by the LIST parse as best it can.
+    # Mixin the +Net::FTP::List+ module and subsequent calls to the Net::FTP +list+, +ls+ or +dir+ methods will be
+    # parsed by the LIST parser as best it can.
     #
     # == Creation
     #
-    # By requiring Net::FTP::List instances are created by calling any of Net::FTP's +list+, +ls+ or
-    # +dir+ metods. The +to_s+ method still returns the raw line so for the most part this should be
-    # transparent.
-    #
     #   require 'net/ftp' # Not really required but I like to list dependencies sometimes.
     #   require 'net/ftp/list'
     #
     #   ftp = Net::FTP.open('somehost.com', 'user', 'pass')
+    #   ftp.extend Net::FTP::List
     #   ftp.list('/some/path') do |entry|
     #     # Ignore everything that's not a file (so symlinks, directories and devices etc.)
     #     next unless entry.file?
@@ -46,22 +34,29 @@ module Net #:nodoc:
     # None at this time. At worst you'll end up with an Net::FTP::List::Unknown instance which won't have any extra
     # useful information. Methods like <tt>dir?</tt>, <tt>file?</tt> and <tt>symlink?</tt> will all return +false+.
     module List
-      class << self
 
-        # Parse a raw FTP LIST line.
-        #
-        #   Net::FTP::List.parse(raw_list_string) # => Net::FTP::List::Parser instance.
-        def parse(raw)
-          Parser.parse(raw)
-        end
-
-        # Parse a raw FTP LIST line.
-        #
-        # An alias for +parse+.
-        alias_method :new, :parse
+      def self.extended(klass) #:nodoc:
+        class << klass
+  
+          alias_method :raw_list, :list
+          def list(*args, &block)
+            if block
+              raw_list(*args) do |raw|
+                Net::FTP::List::Parser.parse(raw)
+                yield raw
+              end
+            else
+              raw_list(*args).map do |raw|
+                Net::FTP::List::Parser.parse(raw)
+              end
+            end
+          end
 
+        end
       end
+
     end
 
   end
 end
+

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

@@ -21,55 +21,54 @@ module Net
       class Parser
         @@parsers = []
 
+        # Parse a raw FTP LIST line.
+        #
+        # 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)
+          @raw = raw
+        end
+
         # The raw list entry string.
-        attr_reader :raw
+        def raw
+          @raw
+        end
+        alias_method :to_s, :raw
 
         # The items basename (filename).
-        attr_reader :basename
+        def basename
+          @basename
+        end
 
         # Looks like a directory, try CWD.
         def dir?
-          !!self.dir
+          !!@dir
         end
 
         # Looks like a file, try RETR.
         def file?
-          self.file
+          !!@file
         end
 
         # Looks like a symbolic link.
         def symlink?
-          !!self.symlink
+          !!@symlink
         end
 
-        # Parse a raw FTP LIST line.
-        #
-        # 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)
-          self.raw = raw
-        end
-
-        # Stringify.
-        def to_s
-          raw
-        end
-        alias_method :raw, :to_s
-
         class << self
-
           # Acts as a factory.
           #
           # TODO: Having a class be both factory and abstract implementation seems a little nutty to me. If it ends up
           # too confusing or gives anyone the shits I'll move it.
-          def inherited(klass)
+          def inherited(klass) #:nodoc:
             @@parsers << klass
           end
 
           # Factory method.
           #
-          # Attempt to find and parse a list item with the a parser.
+          # Attempt to find a parser and parse a list item. At worst the item will return an Net::FTP::List::Unknown
+          # instance. This may change in the future so that only parsable entries are kept.
           def parse(raw)
             @@parsers.reverse.each do |parser|
               begin
@@ -81,15 +80,6 @@ module Net
           end
         end
 
-        protected
-          # Protected boolean.
-          attr_accessor :file, :dir, :symlink
-
-          # Protected raw list entry string.
-          attr_writer :raw
-
-          # Protected item basename (filename).
-          attr_writer :basename
       end
 
       # Unknown parser.

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

@@ -38,16 +38,16 @@ module Net
           match = REGEXP.match(raw.strip) or raise ParserError
 
           case match[1]
-            when /d/    then self.dir = true
-            when /l/    then self.symlink = true
-            when /[f-]/ then self.file = true
+            when /d/    then @dir = true
+            when /l/    then @symlink = true
+            when /[f-]/ then @file = true
             when /[bc]/ then # Do nothing with devices for now.
             else ParserError 'Unknown LIST entry type.'
           end
 
           # TODO: Permissions, users, groups, date/time.
 
-          self.basename = match[21].match(/^(.+)(?:\s+\->.+)?$/)[0].strip
+          @basename = match[21].match(/^(.+)(?:\s+\->.+)?$/)[0].strip
         end
       end
 

data/test/test_net_ftp_list.rb

@@ -4,8 +4,8 @@ require 'net/ftp/list'
 class TestNetFTPList < Test::Unit::TestCase
 
   def setup
-    @dir  = Net::FTP::List.new('drwxr-xr-x   4 user     group       4096 Dec 10 20:23 etc')
-    @file = Net::FTP::List.new('-rw-r--r--   1 root     other        531 Jan 29 03:26 README')
+    @dir  = Net::FTP::List::Parser.parse('drwxr-xr-x   4 user     group       4096 Dec 10 20:23 etc')
+    @file = Net::FTP::List::Parser.parse('-rw-r--r--   1 root     other        531 Jan 29 03:26 README')
   end
 
   def test_parse_new
@@ -14,7 +14,7 @@ class TestNetFTPList < Test::Unit::TestCase
   end
 
   def test_rubbish_lines
-    assert_instance_of Net::FTP::List::Unknown, Net::FTP::List.new("++ bah! ++")
+    assert_instance_of Net::FTP::List::Unknown, Net::FTP::List::Parser.parse("++ bah! ++")
   end
 
   def test_ruby_unix_like_dir

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: net-ftp-list
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2008-01-13 00:00:00 +11:00
+  version: "0.4"
+date: 2008-01-16 00:00:00 +11:00
 summary: Parse FTP LIST command output.
 require_paths: 
 - lib