melon 0.5.0 → 0.6.0

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.6.0 2011-02-10
+* Major improvements
+  * melon now expands symlinks by default
+  * Added --preserve-symlinks option
+
+* Minor improvements
+  * Fixed bug with add --update
+  * Fixed 'melon help'
+
 === 0.5.0 2011-02-09
 * Major improvements:
   * Added --recursive option to 'check' subcommand
@@ -9,7 +18,7 @@
 
 === 0.3.0 2011-01-28
 * Major improvements:
-  * added 'help' command'
+  * added 'help' command
 
 === 0.2.0 2011-01-26
 * Major improvements:

data/features/add.feature

@@ -61,12 +61,25 @@ Feature: Adding files to the database
     And the output should contain "dir/test/test3"
     And the output should contain "test_file"
     
-  Scenario: Adding as an update
+  Scenario: Updating via add
     Given a file named "test2" with:
     """
     Also a test file
     """
     And I run "melon -d test.db add -q test_file"
-    When I run "melon -d test.db add -u test_file test2"
+    When I run "melon -d test.db add -u test2 test_file"
     Then the output should contain "test2"
     And the output should not contain "test_file"
+
+  Scenario: Adding a symlinked file
+    Given I run "ln -s test_file link"
+    When I run "melon -d test.db add link"
+    Then the output should contain "test_file"
+    And the output should not contain "link"
+
+  Scenario: Adding a symlinked file, preserving symlinks
+    Given I run "ln -s test_file link"
+    When I run "melon -d test.db add -p link"
+    Then the output should not contain "test_file"
+    And the output should contain "link"
+

data/features/help.feature

@@ -0,0 +1,15 @@
+Feature: Getting help
+  In order to use all of melon's features correctly
+  As a user
+  I should be able to get help using melon
+
+  Scenario: General help
+    When I run "melon help"
+    Then the output should contain "Usage:"
+    And the output should contain "Commands:"
+    And the output should contain "Options:"
+
+  Scenario: Help with a particular command
+    When I run "melon help add"
+    Then the output should contain "Usage: melon add"
+    And the output should contain "Options:"

data/lib/melon/cli.rb

@@ -14,7 +14,7 @@ module Melon
       new(arguments).run
     end
 
-    attr_accessor :arguments
+    attr_accessor :arguments, :options, :parser 
 
     def initialize(arguments)
       self.arguments = arguments
@@ -26,40 +26,8 @@ module Melon
       options
     end    
 
-    def run
-      options = parse_options
-      options.database = PStore.new(File.expand_path(options.database_path))
-
-      # prepare db
-      options.database.transaction do
-        options.database[:by_hash] ||= {}
-        options.database[:by_path] ||= {}
-      end
-
-      unless arguments.empty?
-        run_command(options)
-      end
-    end
-
-    def run_command(options)
-      # look for command class in args.shift
-      command_name = arguments.shift
-      begin
-        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 = self.class.default_options
-
-      # TODO: empty args should be -h
-
-      parser = OptionParser.new do |p|
+    def parser
+      @parser ||= OptionParser.new do |p|
         p.banner = "Usage: melon [options] COMMAND [command-options] [ARGS]"
 
         p.separator ""
@@ -67,7 +35,6 @@ module Melon
         p.separator ""
 
         Commands.each do |command|
-          # help goes last
           if command.command_name == 'help'
             next
           end
@@ -75,9 +42,6 @@ module Melon
           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 ""
@@ -87,17 +51,61 @@ module Melon
           options.database_path = database
              end
 
-        p.on_tail("-v", "--version", "Show version") do
+        p.on("-v", "--version", "Show version") do
           puts Melon.version_string
           exit 0
         end
 
-        p.on_tail("-h", "--help", "This is it") do
+        p.on("-h", "--help", "This is it") do
           puts p
           exit 0
         end
+
+        p.separator ""
+        p.separator "For more information on a specific command," +
+          " use 'melon help COMMAND'"
       end
 
+    end
+
+    def run
+      parse_options
+      options.database = PStore.new(File.expand_path(options.database_path))
+
+      # prepare db
+      options.database.transaction do
+        options.database[:by_hash] ||= {}
+        options.database[:by_path] ||= {}
+      end
+
+      if arguments.empty?
+        puts parser
+        exit
+      else
+        # look for command class in args.shift
+        command_name = arguments.shift
+
+        run_command(command_name)
+      end
+    end
+
+    def run_command(command_name)
+      begin
+        command_class = 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 = command_class.new(arguments, options)
+      (command_name == 'help' ? c.run(self) : c.run)
+    end
+
+    def parse_options
+      self.options = self.class.default_options
+
+      # TODO: empty args should be -h
+
       begin
         parser.order!(arguments)
       rescue OptionParser::ParseError => e

data/lib/melon/commands.rb

@@ -7,7 +7,7 @@ module Melon
       self.constants.sort.each do |c|
         const = self.const_get(c)
 
-        if const.superclass == Base
+        if const.respond_to?(:superclass) && const.superclass == Base
           consts << const
           yield const 
         end
@@ -22,12 +22,12 @@ module Melon
 
     # 1.0 list
     # TODO: check needs -r
+    # TODO: update- a function of add, ignore files that are already present in the db
     # 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 attempts to remove it by hash
     # TODO: list needs --paths(only) and --hashes(only)
-    # 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
     #          could be:
     #            1.  move file

data/lib/melon/commands/add.rb

@@ -1,5 +1,6 @@
 require 'melon/hasher'
 require 'melon/commands/base'
+require 'melon/commands/common_options'
 
 module Melon
   module Commands
@@ -13,14 +14,18 @@ module Melon
           options.quiet = true
         end
 
-        parser.on("-r", "--recursive", "Recursively add directory contents") do
-          options.recursive = true
-        end
+        CommonOptions.recursive(parser, options)
 
-        parser.on("-u" "--update", 
+        parser.on("-u", "--update", 
                   "Skip paths already present in the database") do
           options.update = true
-                  end
+        end
+
+        CommonOptions.preserve_symlinks(parser, options)
+      end
+
+      def usageargs
+        "FILE [FILE [FILE ...]]"
       end
 
       def run
@@ -33,6 +38,7 @@ module Melon
         options.database.transaction do
           args.each do |arg|
             filename = File.expand_path(arg)
+            filename = resolve_symlinks(filename) unless options.preserve_symlinks
 
             if File.directory?(filename)
               error "argument is a directory: #{arg}"

data/lib/melon/commands/base.rb

@@ -48,10 +48,13 @@ module Melon
       def usageargs; end
       def helptext; end
 
+      def run; raise; end
+
       def self.description
         raise
       end
 
+
       def parse_options!
         begin
           parser.parse!(args)

data/lib/melon/commands/check.rb

@@ -1,4 +1,5 @@
 require 'melon/commands/base'
+require 'melon/commands/common_options'
 
 module Melon
   module Commands
@@ -15,13 +16,12 @@ EOS
       end
 
       def usageargs
-        "file [file [file ...]"
+        "FILE [FILE [FILE ...]]"
       end
 
       def parser_options(parser)
-        parser.on("-r", "--recursive", "Recursively check directory contents") do
-          options.recursive = true
-        end
+        CommonOptions.recursive(parser, options)
+        CommonOptions.preserve_symlinks(parser, options)
       end
 
       def run
@@ -32,14 +32,17 @@ EOS
         end
 
         options.database.transaction do
-          args.each do |filename|
+          args.each do |arg|
+            filename = File.expand_path(arg)
+            filename = resolve_symlinks(filename) unless options.preserve_symlinks
+
             if File.directory?(filename)
               error "argument is a directory: #{arg}"
             end
 
             hash = Hasher.digest(filename)
             unless options.database[:by_hash][hash]
-              puts File.expand_path(filename)
+              puts filename
             end
           end
         end

data/lib/melon/commands/common_options.rb

@@ -0,0 +1,17 @@
+module Melon
+  module Commands
+    module CommonOptions
+      def self.recursive(parser, options)
+        parser.on("-r", "--recursive", "Recursively process directories") do
+          options.recursive = true
+        end
+      end
+
+      def self.preserve_symlinks(parser, options)
+        parser.on("-p", "--preserve-symlinks", "Don't expand symlinks") do
+          options.preserve_symlinks = true
+        end
+      end
+    end
+  end
+end

data/lib/melon/commands/help.rb

@@ -1,3 +1,4 @@
+require 'melon/cli'
 require 'melon/commands/base'
 require 'melon/commands'
 
@@ -8,10 +9,15 @@ module Melon
         "Get help with a specific command"
       end
 
-      def run
+      def run(cli)
+        if args.empty?
+          puts cli.parser
+          exit
+        end
         help = args.shift
         begin
           puts Commands[help.capitalize].new(args, options).parser
+          exit
         rescue NameError => e
           # don't swallow NoMethodErrors
           raise e unless e.instance_of?(NameError)

data/lib/melon/commands/show.rb

@@ -8,7 +8,7 @@ module Melon
       end
 
       def usageargs
-        "file [file [file ...]]"
+        "FILE [FILE [FILE ...]"
       end
 
       def helptext

data/lib/melon/helpers.rb

@@ -53,5 +53,9 @@ module Melon
         end
       end.flatten.reject { |arg| File.directory?(arg) }
     end
+
+    def resolve_symlinks(file)
+      Pathname.new(file).realpath.to_s
+    end
   end
 end

data/lib/melon/version.rb

@@ -1,6 +1,6 @@
 module Melon
   def self.version
-    "0.5.0"
+    "0.6.0"
   end
 
   def self.version_string

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: melon
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Andrew Roberts
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 -05:00
+date: 2011-02-10 00:00:00 -05:00
 default_executable: melon
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,7 @@ files:
 - features/add.feature
 - features/check.feature
 - features/edges.feature
+- features/help.feature
 - features/list.feature
 - features/show.feature
 - features/step_definitions/basic_steps.rb
@@ -91,6 +92,7 @@ files:
 - lib/melon/commands/add.rb
 - lib/melon/commands/base.rb
 - lib/melon/commands/check.rb
+- lib/melon/commands/common_options.rb
 - lib/melon/commands/help.rb
 - lib/melon/commands/list.rb
 - lib/melon/commands/show.rb
@@ -143,6 +145,7 @@ test_files:
 - features/add.feature
 - features/check.feature
 - features/edges.feature
+- features/help.feature
 - features/list.feature
 - features/show.feature
 - features/step_definitions/basic_steps.rb