melon 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.2.0 2011-01-26
+* Major improvements:
+  * added --recursive flag to add subcommand
+  * added 'list' subcommand
+  * added 'show' subcommand
+  * cleaned up help text
+
 === 0.1.0 2011-01-25
 
 * Initial release, basic functionality present:

data/features/add.feature

@@ -0,0 +1,57 @@
+Feature: Adding files to the database
+  In order to have something to compare new files to
+  As a user
+  I should be able to add files to the database
+
+
+  Background:
+    Given a file named "test_file" with:
+    """
+    This file is a test file
+    """
+
+  Scenario: Adding files to a melon database
+    When I run "melon -d test.db add test_file"
+    Then the output should contain a hash
+    And the output should contain "test_file"
+
+  Scenario: Adding a file that already exists
+    When I run "melon -d test.db add test_file"
+    And I run "melon -d test.db add test_file"
+    Then it should fail with:
+    """
+    melon: path already present in database
+    """
+
+  Scenario: Adding a directory itself
+    Given a directory named "testo"
+    When I run "melon -d test.db add testo"
+    Then it should fail with:
+    """
+    directory
+    """
+
+  Scenario: Adding a file that doesn't exist
+    When I run "melon -d test.db add nonexistant_file"
+    Then it should fail with:
+    """
+    melon: no such file: nonexistant_file
+    """
+
+  Scenario: Adding a directory recursively
+    Given a file named "dir/test1" with:
+    """
+    First test file
+    """
+    And a file named "dir/test2" with:
+    """
+    Second test file
+    """
+    And a file named "dir/test/test3" with:
+    """
+    Third test file
+    """
+    When I run "melon -d test.db add -r dir"
+    Then the output should contain "dir/test1"
+    And the output should contain "dir/test2"
+    And the output should contain "dir/test/test3"

data/features/check.feature

@@ -0,0 +1,27 @@
+Feature: Check
+  In order to see if a given file is tracked by the database
+  As a user
+  I should be able to query the database with a file
+
+  Background:
+    Given a file named "test_file" with:
+    """
+    This file is a test file
+    """
+
+  Scenario: Checking a file that is not in the database
+    When I run "melon -d test.db check test_file"
+    Then the output should contain "test_file"
+    And the output should start with "/"
+
+  Scenario: Checking a file that is in the database:
+    When I run "melon -d test.db add -q test_file"
+    And I run "melon -d test.db check test_file"
+    Then the output should be empty
+
+  Scenario: Checking a file that doesn't exist
+    When I run "melon -d test.db check nonexistant_file"
+    Then it should fail with:
+    """
+    melon: no such file: nonexistant_file
+    """

data/features/edges.feature

@@ -7,7 +7,14 @@ Feature: Edge cases
     """
     When I run "cp test_file test_file_2"
     And I run "melon -d test.db add test_file test_file_2"
-    Then the stderr should contain:
+    Then it should fail with:
     """
     melon: file exists elsewhere in the database
     """
+
+  Scenario: Unrecognized command
+    When I run "melon whizzle bang"
+    Then it should fail with:
+    """
+    melon: unrecognized command: whizzle
+    """

data/features/list.feature

@@ -0,0 +1,18 @@
+Feature: List
+  In order to see what's tracked by the database
+  As a user
+  I should be able to get a list of tracked files
+
+  Scenario: Listing files
+    Given a file named "test_file" with:
+    """
+    Test file 1
+    """
+    And a file named "file_test" with:
+    """
+    Test file 2
+    """
+    And I run "melon -d test.db add -q test_file file_test"
+    When I run "melon -d test.db list"
+    Then the output should contain "test_file"
+    And the output should contain "file_test"

data/features/show.feature

@@ -0,0 +1,28 @@
+Feature: Show
+  In order to see where a file is stored (according the database)
+  As a user
+  I should be able to query the database with a file
+
+  Background:
+    Given a file named "dir/test_file" with:
+    """
+    This file is a test file
+    """
+    And I run "cp dir/test_file ."
+
+  Scenario: Showing a file that is not in the database
+    When I run "melon -d test.db show test_file"
+    Then the output should be empty
+
+  Scenario: Showing a file that is in the database:
+    When I run "melon -d test.db add -q dir/test_file"
+    And I run "melon -d test.db show test_file"
+    Then the output should contain "dir/test_file"
+    And the output should start with "/"
+
+  Scenario: Showing a file that doesn't exist
+    When I run "melon -d test.db show nonexistant_file"
+    Then it should fail with:
+    """
+    melon: no such file: nonexistant_file
+    """

data/lib/melon/cli.rb

@@ -1,11 +1,14 @@
 require 'ostruct'
+require 'pstore'
 require 'optparse'
 
 require 'melon/version'
 require 'melon/commands'
+require 'melon/helpers'
 
 module Melon
   class CLI
+    include Helpers
 
     def self.execute(arguments=[])
       new(arguments).run
@@ -42,15 +45,17 @@ module Melon
       # look for command class in args.shift
       command_name = arguments.shift
       begin
-        command = Commands.const_get(command_name.capitalize)
-        command.new(arguments, options).run
-      # rescue NameError
-      #   CLI.error "unrecognized command: #{command_name}"
+        c = Commands[command_name.capitalize]
+      rescue NameError => e
+        # don't swallow NoMethodErrors
+        raise e unless e.instance_of?(NameError)
+        error "unrecognized command: #{command_name}"
       end
+      c.new(arguments, options).run
     end
 
     def parse_options
-      options = CLI.default_options
+      options = self.class.default_options
 
       parser = OptionParser.new do |p|
         p.banner = "Usage: melon [options] COMMAND [command-options] [ARGS]"
@@ -82,40 +87,15 @@ module Melon
           puts p
           exit 0
         end
-
       end
 
       begin
         parser.order!(arguments)
       rescue OptionParser::ParseError => e
-        CLI.error e
+        error e
       end
 
       options
     end
-
-    def format_command(name, desc, margin = 4, width = 22, wrapdesc = 80)
-      pad = "\n" + ' ' * width
-      desc = wrap_text(desc, wrapdesc - width).split("\n").join(pad)
-
-      ' ' * margin + "#{name.ljust(width-margin)}#{desc}"
-    end
-
-    def wrap_text(txt, col = 80)
-      txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
-               "\\1\\3\n") 
-    end
-    
-    
-    def self.error(error_obj_or_str, code = 1)
-      if error_obj_or_str.respond_to?('to_s')
-        error_str = error_obj_or_str.to_s
-      else
-        error_str = error_obj_or_str.inspect
-      end
-
-      $stderr.puts "melon: #{error_str}"
-      exit code
-    end
   end
 end

data/lib/melon/commands.rb

@@ -1,16 +1,32 @@
-require 'pstore'
-require 'ftools'
-
 require 'melon/hasher'
-require 'melon/cli'
-
-# TODO: in commands, parse arguments with parse!  in CLI, parse with order!
+require 'melon/helpers'
 
 module Melon
   module Commands
+    def self.each
+      consts = []
+      base = self.const_get('Base')
+      self.constants.each do |c|
+        const = self.const_get(c)
+        if const.superclass == base
+          consts << const
+          yield const 
+        end
+      end
+      consts
+    end
+
+    class << self
+      alias :[] :const_get
+    end
+
     # 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
 
@@ -31,10 +47,18 @@ module Melon
         begin
           parser.parse!(args)
         rescue OptionParser::ParseError => e
-          CLI.error "#{self.class.to_s.split("::").last.downcase}: #{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
@@ -47,12 +71,20 @@ module Melon
         @parser ||= OptionParser.new do |p|
           p.banner = "Usage: melon add [options] file [file [file ...]]"
           p.separator ""
-          p.separator Add.description
+          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
@@ -64,29 +96,73 @@ module Melon
       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)
-              CLI.error "argument is a directory: #{arg}"
+              error "argument is a directory: #{arg}"
             end
 
             if options.database[:by_path][filename]# and !options.force
-              CLI.error "path already present in database: #{arg}"
+              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]
-              CLI.error "file exists elsewhere in the database: #{arg}"
+              error "file exists elsewhere in the database: #{arg}"
             end
 
 
             options.database[:by_hash][hash] = filename
             options.database[:by_path][filename] = hash
-            puts "#{hash}:#{filename}"
+            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
@@ -101,7 +177,13 @@ module Melon
         @parser ||= OptionParser.new do |p|
           p.banner = "Usage: melon check file [file [file ...]]"
           p.separator ""
-          p.separator Check.description
+          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
 
@@ -118,5 +200,35 @@ module Melon
         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
   end
 end

data/lib/melon/helpers.rb

@@ -0,0 +1,43 @@
+module Melon
+  module Helpers
+    def format_command(name, desc, options = {})
+      options = {
+        :margin => 4,
+        :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)
+
+      ' ' * options[:margin] +
+        "#{name.ljust(options[:width] - options[:margin])}#{desc}"
+    end
+
+    def wrap_text(txt, col = 80)
+      txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
+               "\\1\\3\n") 
+    end
+
+    def blockquote(string, options = {})
+      options = {
+        :margin => 4,
+        :wrap => 70
+      }.update(options)
+      options[:width] = options.delete(:margin)
+      format_command('', string.gsub(/\s+/,' ').gsub('\. ', '.  '), options)
+    end
+    
+    def error(error_obj_or_str, code = 1)
+      if error_obj_or_str.respond_to?('to_s')
+        error_str = error_obj_or_str.to_s
+      else
+        error_str = error_obj_or_str.inspect
+      end
+
+      $stderr.puts "melon: #{error_str}"
+      exit code
+    end
+  end
+end

data/lib/melon/version.rb

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

data/script/console

@@ -1,12 +1,15 @@
 #!/usr/bin/env ruby
-# File: script/console
+
 irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 
-libs =  " -r irb/completion"
-libs <<  " -r irb/ext/save-history"
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+libs = []
+libs << " -I #{lib_dir}"
+libs << " -r irb/completion"
+libs << " -r irb/ext/save-history"
 
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
 libs <<  " -r #{File.dirname(__FILE__) + '/../lib/melon.rb'}"
 puts "Loading melon gem"
+
 exec "#{irb} #{libs} --simple-prompt"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: melon
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Andrew Roberts
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 -05:00
+date: 2011-01-26 00:00:00 -05:00
 default_executable: melon
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,18 +78,19 @@ files:
 - Rakefile
 - TODO
 - bin/melon
-- features/basic.feature
+- features/add.feature
+- features/check.feature
 - features/edges.feature
+- features/list.feature
+- features/show.feature
 - features/step_definitions/basic_steps.rb
 - features/support/env.rb
 - lib/melon.rb
 - lib/melon/cli.rb
 - lib/melon/commands.rb
-- lib/melon/commands/add.rb
-- lib/melon/commands/basic_command.rb
-- lib/melon/commands/help.rb
 - lib/melon/example.rb
 - lib/melon/hasher.rb
+- lib/melon/helpers.rb
 - lib/melon/version.rb
 - melon.gemspec
 - script/console
@@ -133,8 +134,11 @@ signing_key:
 specification_version: 3
 summary: A media catalog
 test_files: 
-- features/basic.feature
+- features/add.feature
+- features/check.feature
 - features/edges.feature
+- features/list.feature
+- features/show.feature
 - features/step_definitions/basic_steps.rb
 - features/support/env.rb
 - spec/melon/cli_spec.rb

data/features/basic.feature

@@ -1,33 +0,0 @@
-Feature: Basic usage
-
-  Background:
-    Given a file named "test_file" with:
-    """
-    This file is a test file
-    """
-
-  Scenario: Adding files to a melon database
-    When I run "melon -d test.db add test_file"
-    Then the output should contain a hash
-    And the output should contain "test_file"
-
-  Scenario: Adding a file that already exists
-    When I run "melon -d test.db add test_file"
-    And I run "melon -d test.db add test_file"
-    Then the output should contain:
-    """
-    melon: path already present in database
-    """
-    And the exit status should not be 0
-
-  Scenario: Checking a file that is not in the database
-    When I run "melon -d test.db check test_file"
-    Then the output should contain "test_file"
-    And the output should start with "/"
-
-  Scenario: Adding a directory
-    Given a directory named "testo"
-    When I run "melon -d test.db add testo"
-    Then the output should contain "directory"
-    And the exit status should not be 0
-

data/lib/melon/commands/add.rb

@@ -1,10 +0,0 @@
-module Melon
-  module Commands
-    class Add
-      extend BasicCommand
-
-
-    end
-  end
-end
-

data/lib/melon/commands/basic_command.rb

@@ -1,19 +0,0 @@
-module Melon
-  module Commands
-    module BasicCommand
-
-      def execute(arguments, options)
-        new(arguments, options).run
-      end
-
-      # returns name {padding} description, for usage"
-      def short_usage(padding="   ")
-        name = Melon::Commands.translate_command(self)
-        extra_spaces = Melon::Commands.commands.collect do |c|
-          c.length
-        end.max - name.length
-        "#{name}#{padding}#{' ' * extra_spaces}#{self.description}"
-      end
-    end
-  end
-end

data/lib/melon/commands/help.rb

@@ -1,51 +0,0 @@
-require 'melon/commands/basic_command'
-
-module Melon
-  module Commands
-    class Help
-      # Help is a basic command that also ties itself in to cli#usage, so
-      # it's a little bit unconventional.  Retrospectively, I should not
-      # have written it first.  
-      extend BasicCommand
-
-      def self.description
-        "Get help with a specific command, or with Melon in general"
-      end
-
-      attr_accessor :arguments
-
-      def initialize(arguments, options)
-        self.arguments = arguments
-      end
-      
-      def parser
-        @parser ||= OptionParser.new do |opts|
-          Melon::Commands.command_hash.each do |name, command|
-            next if command == self.class
-            # TODO help banner: gem help help
-            # TODO flesh out parsing - give short_usage for each command
-            opts.on(name) { command.parser }
-          end
-        end
-      end
-
-      def run
-        begin
-          parser.parse!(arguments)
-        rescue OptionParser::InvalidOption => e
-          puts "melon: #{e.to_s}"
-          exit 1
-        end
-
-        if arguments == ['help']
-          puts parser
-          exit
-        end
-        
-        # if arguments are empty, we handled it in CLI
-        puts "melon: '#{arguments.join(' ')}' is not a recognized command."
-        exit 1
-      end
-    end
-  end
-end