melon 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.3.0 2011-01-28
+* Major improvements:
+  * added 'help' command'
+
 === 0.2.0 2011-01-26
 * Major improvements:
   * added --recursive flag to add subcommand

data/features/add.feature

@@ -51,7 +51,12 @@ Feature: Adding files to the database
     """
     Third test file
     """
-    When I run "melon -d test.db add -r dir"
+    And a file named "test_file" with:
+    """
+    Test file that's not in the subfolder
+    """
+    When I run "melon -d test.db add -r dir test_file"
     Then the output should contain "dir/test1"
     And the output should contain "dir/test2"
     And the output should contain "dir/test/test3"
+    And the output should contain "test_file"

data/lib/melon/cli.rb

@@ -57,6 +57,8 @@ module Melon
     def parse_options
       options = self.class.default_options
 
+      # TODO: empty args should be -h
+
       parser = OptionParser.new do |p|
         p.banner = "Usage: melon [options] COMMAND [command-options] [ARGS]"
 
@@ -64,11 +66,18 @@ module Melon
         p.separator "Commands:"
         p.separator ""
 
-        %w(add check).each do |command|
-          cls = Commands.const_get(command.capitalize)
-          p.separator format_command(command, cls.description)
-        end
+        Commands.each do |command|
+          # help goes last
+          if command.command_name == 'help'
+            next
+          end
 
+          p.separator format_command(command.command_name,
+                                     command.description)
+        end
+        # TODO: add help command back into parser helptext
+        # p.separator format_command(Commands::Help.command_name,
+        #                            Commands::Help.description)
         p.separator ""
         p.separator "Options:"
         p.separator ""

data/lib/melon/commands/add.rb

@@ -0,0 +1,56 @@
+require 'melon/hasher'
+require 'melon/commands/base'
+
+module Melon
+  module Commands
+    class Add < Base
+      def self.description
+        "Add files to the melon database"
+      end
+
+      def parser_options(parser)
+        parser.on("-q", "--quiet", "Suppress printing of hash and path") do
+          options.quiet = true
+        end
+
+        parser.on("-r", "--recursive", "Recursively add directory contents") do
+          options.recursive = true
+        end
+      end
+
+      def run
+        parse_options!
+
+        if options.recursive
+          self.args = recursively_expand(args)
+        end
+
+        options.database.transaction do
+          args.each do |arg|
+            filename = File.expand_path(arg)
+
+            if File.directory?(filename)
+              error "argument is a directory: #{arg}"
+            end
+
+            if options.database[:by_path][filename]
+              error "path already present in database: #{arg}"
+            end
+
+            # hash strategy should be encapsulated, ergo indirection here
+            hash = Hasher.digest(filename)
+
+            if options.database[:by_hash][hash]
+              error "file exists elsewhere in the database: #{arg}"
+            end
+
+
+            options.database[:by_hash][hash] = filename
+            options.database[:by_path][filename] = hash
+            puts "#{hash}:#{filename}" unless options.quiet
+          end
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/base.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+require 'melon/helpers'
+
+module Melon
+  module Commands
+    class Base
+      include Helpers
+      attr_accessor :args, :options
+      attr_reader :description
+
+      def initialize(args, options)
+        self.args = args
+        self.options = options
+      end
+
+      def self.command_name
+        self.to_s.split("::")[-1].downcase
+      end
+
+      def parser
+        @parser ||= OptionParser.new do |p|
+          p.banner = usagebanner
+          p.separator ""
+          p.separator blockquote(self.class.description + ".", :margin => 0)
+          p.separator ""
+
+          if helptext
+            p.separator blockquote(" " + helptext)
+            p.separator ""
+          end
+
+          if self.respond_to? :parser_options
+            p.separator "Options:"
+            p.separator ""
+            parser_options(p)
+          end
+        end
+      end
+
+
+      def usagebanner
+        usage = "Usage: melon #{self.class.command_name}"
+        usage << " [options]" if self.respond_to?(:parser_options)
+        usage << ' ' << usageargs if usageargs
+        usage
+      end
+
+      def usageargs; end
+      def helptext; end
+
+      def self.description
+        raise
+      end
+
+      def parse_options!
+        begin
+          parser.parse!(args)
+        rescue OptionParser::ParseError => e
+          error "#{self.class.command_name}: #{e}"
+        end
+
+        # verify remaining args are files - overrideable
+        verify_args
+      end
+
+      def verify_args
+        args.each do |arg|
+          error "no such file: #{arg}" unless File.exists?(arg)
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/check.rb

@@ -0,0 +1,35 @@
+require 'melon/commands/base'
+
+module Melon
+  module Commands
+    class Check < Base
+      def self.description
+        "Determine whether or not a copy of a file resides in the database"
+      end
+
+      def helptext
+        <<EOS
+If the file's hash matches a hash in the database, nothing is
+printed.  Otherwise, the full path to the file is printed.
+EOS
+      end
+
+      def usageargs
+        "file [file [file ...]"
+      end
+
+      def run
+        parse_options!
+
+        options.database.transaction do
+          args.each do |filename|
+            hash = Hasher.digest(filename)
+            unless options.database[:by_hash][hash]
+              puts File.expand_path(filename)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/help.rb

@@ -0,0 +1,23 @@
+require 'melon/commands/base'
+require 'melon/commands'
+
+module Melon
+  module Commands
+    class Help < Base
+      def self.description
+        "Get help with a specific command"
+      end
+
+      def run
+        help = args.shift
+        begin
+          puts Commands[help.capitalize].new(args, options).parser
+        rescue NameError => e
+          # don't swallow NoMethodErrors
+          raise e unless e.instance_of?(NameError)
+          error "unrecognized command: #{help}"
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/list.rb

@@ -0,0 +1,33 @@
+require 'melon/commands/base'
+
+module Melon
+  module Commands
+    class List < Base
+      def self.description
+        "List the files tracked by the database"
+      end
+
+      def parser_options(parser)
+          parser.on("-p", "--paths", "print only paths") do
+            options.only_paths = true
+          end
+          # TODO: re-enable this as -h after help command goes in
+          # parser.on("--hashes", "print only hashes") { options.only_hashes = true }
+      end
+
+      def verify_args
+        error "invalid argument: #{args.shift}" unless args.empty?
+      end
+
+      def run
+        parse_options!
+
+        options.database.transaction do
+          options.database[:by_hash].each_pair do |hash, path|
+            puts "#{path}:#{hash}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/show.rb

@@ -0,0 +1,36 @@
+require 'melon/commands/base'
+
+module Melon
+  module Commands
+    class Show < Base
+      def self.description
+        "Show where the database thinks a file is located"
+      end
+
+      def usageargs
+        "file [file [file ...]]"
+      end
+
+      def helptext
+        <<EOS
+  If the file's hash matches a hash in the database, then
+the associated path in the database is printed.  Otherwise,
+nothing is printed.
+EOS
+      end
+
+      def run
+        parse_options!
+
+        options.database.transaction do
+          args.each do |filename|
+            hash = Hasher.digest(filename)
+            if path = options.database[:by_hash][hash]
+              puts path
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands.rb

@@ -1,14 +1,13 @@
-require 'melon/hasher'
-require 'melon/helpers'
+Dir[File.join(File.dirname(__FILE__), "commands/*.rb")].each {|f| require f}
 
 module Melon
   module Commands
     def self.each
       consts = []
-      base = self.const_get('Base')
-      self.constants.each do |c|
+      self.constants.sort.each do |c|
         const = self.const_get(c)
-        if const.superclass == base
+
+        if const.superclass == Base
           consts << const
           yield const 
         end
@@ -20,215 +19,19 @@ module Melon
       alias :[] :const_get
     end
 
-    # needs a 'verify' command to check integrity of database
+
+    # 1.0 list
+    # TODO: needs a 'verify' command to check integrity of database
     #   both internal 2-hash consistency (consistency) and db<->filesystem
     #   matching up (integrity) [file exists, hashes match]
-    # needs a 'remove' command, or some way to deal with deletes/renames
-    # needs a 'list' command
-    class Base
-      include Helpers
-      attr_accessor :args, :options
-      attr_reader :description
-
-      def initialize(args, options)
-        self.args = args
-        self.options = options
-      end
-
-      def parser
-        raise
-      end
-
-      def self.description
-        raise
-      end
-
-      def parse_options!
-        begin
-          parser.parse!(args)
-        rescue OptionParser::ParseError => e
-          error "#{self.class.to_s.split("::").last.downcase}: #{e}"
-        end
-
-        # verify remaining args are files - overrideable
-        verify_args
-      end
-
-      def verify_args
-        args.each do |arg|
-          error "no such file: #{arg}" unless File.exists?(arg)
-        end
-      end
-    end
-
-    class Add < Base
-
-      def self.description
-        "Add files to the melon database"
-      end
-
-      def parser
-        @parser ||= OptionParser.new do |p|
-          p.banner = "Usage: melon add [options] file [file [file ...]]"
-          p.separator ""
-          p.separator blockquote(Add.description + ".")
-
-          p.separator ""
-          p.separator "Options:"
-          p.separator ""
-
-          p.on("-q", "--quiet", "Suppress printing of hash and path") do
-            options.quiet = true
-          end
-
-          p.on("-r", "--recursive", "Recursively add directory contents") do
-            options.recursive = true
-          end
-
-          # p.on("-f", "--force",
-          #      "Force the recalculation of the path that",
-          #      " already exists in the database") do
-          #   options.force = true
-          #      end
-        end
-      end
-
-      def run
-        parse_options!
-
-        if options.recursive
-          self.args = args.collect do |arg|
-            if File.directory?(arg)
-              Dir["#{arg}/**/*"]
-            else
-              arg
-            end
-          end.flatten.reject { |arg| File.directory?(arg) }
-        end
-
-        options.database.transaction do
-          args.each do |arg|
-            filename = File.expand_path(arg)
-
-            if File.directory?(filename)
-              error "argument is a directory: #{arg}"
-            end
-
-            if options.database[:by_path][filename]# and !options.force
-              error "path already present in database: #{arg}"
-            end
-
-            # hash strategy should be encapsulated, ergo indirection here
-            hash = Hasher.digest(filename)
-
-            if options.database[:by_hash][hash]
-              error "file exists elsewhere in the database: #{arg}"
-            end
-
-
-            options.database[:by_hash][hash] = filename
-            options.database[:by_path][filename] = hash
-            puts "#{hash}:#{filename}" unless options.quiet
-          end
-        end
-      end
-    end
-
-    class Show < Base
-      def self.description
-        "Show where the database thinks a file is located"
-      end
-
-      def parser
-        @parser ||= OptionParser.new do |p|
-          p.banner = "Usage: melon show file [file [file ...]]"
-          p.separator ""
-          p.separator blockquote(self.class.description + <<EOS
-.  If the file's hash matches a hash in the database, then
-the associated path in the database is printed.  Otherwise,
-nothing is printed.
-EOS
-                                )
-          p.separator ""
-          
-        end
-      end
-
-      def run
-        parse_options!
-
-        options.database.transaction do
-          args.each do |filename|
-            hash = Hasher.digest(filename)
-            if path = options.database[:by_hash][hash]
-              puts path
-            end
-          end
-        end
-      end
-    end
-
-    class Check < Base
-      def self.description
-        "Determine whether or not a copy of a file resides in the database"
-      end
-
-      def parser
-        @parser ||= OptionParser.new do |p|
-          p.banner = "Usage: melon check file [file [file ...]]"
-          p.separator ""
-          p.separator blockquote(self.class.description + <<EOS
-.  If the file's hash matches a hash in the database, nothing is
-printed.  Otherwise, the full path to the file is printed.
-EOS
-                                )
-          p.separator ""
-          
-        end
-      end
-
-      def run
-        parse_options!
-
-        options.database.transaction do
-          args.each do |filename|
-            hash = Hasher.digest(filename)
-            unless options.database[:by_hash][hash]
-              puts File.expand_path(filename)
-            end
-          end
-        end
-      end
-    end
-
-    class List < Base
-      def self.description
-        "List the files tracked by the database"
-      end
-
-      def parser
-        @parser ||= OptionParser.new do |p|
-          p.banner = "Usage: melon list"
-          p.separator ""
-          p.separator blockquote(self.class.description)
-          p.separator ""
-          
-        end
-      end
-
-      def verify_args
-        error "invalid argument: #{args.shift}" unless args.empty?
-      end
-
-      def run
-        parse_options!
-
-        options.database.transaction do
-          options.database[:by_hash].each_pair do |hash, path|
-            puts "#{path}:#{hash}"
-          end
-        end
-      end
-    end
+    # TODO: needs a 'remove' command, or some way to deal with deletes/renames
+    #   remove: given a tracked file, removes it
+    #           given an untracked file, it hashes it
+    #             and removes it by hash
+    # TODO: list needs --paths(only) and --hashes(only)
+    #            --count
+    # TODO: check needs -r
+    # TODO: update- a function of add, ignore files that are already present in the db
+    # TODO: handle moving a file somehow -- hopefully a function of update
   end
 end

data/lib/melon/hasher.rb

@@ -3,6 +3,7 @@ require 'digestif/hasher'
 
 module Melon
   class Hasher
+    # TODO: scale seek size up with file size
     def self.digest(filename)
       hasher = Digestif::Hasher.new(filename)
       hasher.options.read_size = 40000

data/lib/melon/helpers.rb

@@ -6,7 +6,7 @@ module Melon
         :width => 22,
         :wrap => 80
       }.update(options)
-      
+
       pad = "\n" + ' ' * options[:width]
       desc = self.wrap_text(desc, options[:wrap] - options[:width])
       desc = desc.split("\n").join(pad)
@@ -25,8 +25,12 @@ module Melon
         :margin => 4,
         :wrap => 70
       }.update(options)
+
       options[:width] = options.delete(:margin)
-      format_command('', string.gsub(/\s+/,' ').gsub('\. ', '.  '), options)
+      options[:margin] = 0
+      format_command('', string.gsub(/\s+/,' ').
+                     gsub(/\. /, '.  ').
+                     gsub(/^ /, '  '), options)
     end
     
     def error(error_obj_or_str, code = 1)
@@ -39,5 +43,15 @@ module Melon
       $stderr.puts "melon: #{error_str}"
       exit code
     end
+
+    def recursively_expand(filelist)
+      filelist.collect do |arg|
+        if File.directory?(arg)
+          Dir["#{arg}/**/*"]
+        else
+          arg
+        end
+      end.flatten.reject { |arg| File.directory?(arg) }
+    end
   end
 end

data/lib/melon/version.rb

@@ -1,6 +1,6 @@
 module Melon
   def self.version
-    "0.2.0"
+    "0.3.0"
   end
 
   def self.version_string

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: melon
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Andrew Roberts
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -05:00
+date: 2011-01-28 00:00:00 -05:00
 default_executable: melon
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,6 +88,12 @@ files:
 - lib/melon.rb
 - lib/melon/cli.rb
 - lib/melon/commands.rb
+- lib/melon/commands/add.rb
+- lib/melon/commands/base.rb
+- lib/melon/commands/check.rb
+- lib/melon/commands/help.rb
+- lib/melon/commands/list.rb
+- lib/melon/commands/show.rb
 - lib/melon/example.rb
 - lib/melon/hasher.rb
 - lib/melon/helpers.rb