trout 0.1 → 0.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+gem "cucumber"
+gem "aruba"
+gem "rake"
+gem "rspec", :require => false
+

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.1)
+    builder (2.1.2)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    gherkin (2.1.5)
+      trollop (~> 1.16.2)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rspec (1.3.0)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  rake
+  rspec

data/README.textile

@@ -46,3 +46,47 @@ h2. Author
 
 Copyright 2010 Joe Ferris
 
+<pre>
+                                                ;t                                                  
+                                              jfLLf                                                 
+                                             tLfGfGL                                                
+                                           tLjjEffGDt                                               
+                                          fjfjfffLfGL;                                              
+                                         GffffLLLLLGLGGGGLDL;                                       
+                                        .GfffLLGGGLDLfffffGLGEGGLGf                                 
+                                         :GGGDGLLLLGfLfffGLELEfLfLGLLG                              
+                                     ffDLLLDGLffDDjjjjjLGffEfLLfELGGLLGL,                           
+                                tLfffGfjjLfffjjjjjjjjjjjjjLjDffLELffLLLfLDG                         
+                    jj:      ffLjjGtiittfitGifttfftttDtjtjGtDjjGjjjLfLjffffLG                       
+                    jDGj  GDjtjGi;;;t;tt,,it;;Liij;iiGtttttiftLtjjtjjjffffLfffL.                    
+                     ,fLfftjti,;:..:.:.:,G;,G,i;,;t;tijtititLtitjftjGttjjLDffLLLD                   
+                    tjfjL;,:..i.,. .: t::i,,j:,;;;;ii;;tii;fiiDitttGtitttfjjjfDfLG                  
+                  Lfffij....    .i .;:..;;j,;i,,i;;;;t;iGiiiDititiLijttftijttLjfGLGt                
+  ;Gf;          fLfjj,,:tt...::,:,::,G,,,fti;iiiti;iiititftjttttjtitiftjiftititfLGLDD               
+ fEKDGELt     LLDt;;;;,,,,t,i;ii;;;;i;,iittttttjtjjjtttttttjjttjjjjLjtttitiGtGtffiLGDD,             
+  DDGGGffL,ijLLii;jji;titifijjtiti;ifi;i;ij;ttt;tttijtttDtttjjttjjjfjjfjDjttitjGjGGGDEDD.           
+  KGDLffLLfLjiijiiijtttjjjjjttiti;ttt;;ttit,i;i;titittjttfttGitDttjjjjjttjjjtffjffjGLDDDDE:         
+  EGDLLEGLftLtLtiLjtLjjjjttittiiiiititittiiiittijititttjtitftttittjtttjffjfffjjfLLjLLLGGGEDD        
+  iDGLDDDGjjtEjjjtffjfjjjttjjittitttit;tiii;tttttitiijtiittjtttttttGttGjtjffjffLfifLffGGGDGEEKj     
+   DGGGGGLfLfjfjjfjjjtttjjjtjttjttjjttitiittiiittitttiiitttttjtjjtititjttjfLLffGtffLffLLLGGDGGGE    
+   GGEGLLffjjjfDjfjfjjjjfffffjjtttjttitititttttjttttitttttjjjtitjtfttttjfftGLLGffLLLGGLLtjfffGLLL.  
+    LDDGGLfLfffjjtjfLD. ;LLffLLfjjtjtttitittitttttittti;tttiitttttttttjjfffLLLLfjLGLLGLDLffjffLjtL: 
+    KDLEGGjfjfjjffG    ttjtLttjfLffjjtttttjttttjttttttjtttttiittttttttjjjLLLGLtLfLLLLLGEGGftLjjt;t  
+    jELDEfffjjffj      tttjjtjfitjfffjjjjjjjjjjjtjtttjtttttttttttjjtjjjfftfGLL;GLGLLLLGLf;tLj,G.    
+     GDDDLfffjfj       ,ittfjfit   GLfLLLLLLLLLffjttttttttttttttttttjjfjfjjfLGiGLGLLffj;,LjiiG      
+     KGKGDLffff         ;iitjff          .fGLGGGijjjjjjttttttttttttttjjfLff,LGjLGDGLLi,;fftDG       
+     DELLfjLLL          ,;ijff                DiftjjLffjjjjtttttttjjjjfffjD,itGfGLLfj:tLjtfG        
+     ;EfEELfLj          ,;itj                Ljitt EDfLGLffjjjjjjjjjjffLjjtD:fLGijftifjtt;j;t.t.:;t 
+      LfKfGDG           :;ij                .,tttfi      :fLLLLLfffffffLfftGGjfffEGGftfi;i;:iLjjit  
+      tfDffDf            :i                 ,;;itft           ,LLLLLGLfLLGfGGLi.,tKKDffLLGDDGLLL    
+       GLEfDf                                ;;itjj                  jGGGGDfLLGL.:tjGLLLG,          
+       DDGDGL                                ;;iijj                 tjLGGDDKKKKDLGt,: .             
+       jfGEj                                  ,;it:                 tjffLGDLKKKWKK                  
+        GEfL                                  .:;;                  tjjffLGjEKEEKKK                 
+        GLf,                                    .                   ;jjjjfLfEEEEEKW                 
+        .Lf                                                         .tjjjjfiDDEEEEK                 
+         L                                                           ttjjjf  LEEEE:                 
+                                                                      tjjjf    ;ED                  
+                                                                       ittj                         
+                                                                         :
+</pre>

data/features/help.feature

@@ -0,0 +1,60 @@
+Feature: get help on using trout
+
+  Scenario Outline: Specify an unknown command
+    When I run "trout <arguments>"
+    Then the output should contain:
+      """
+      I don't know how to "<command>."
+      Run "trout help" for usage information.
+      """
+    Examples:
+      | arguments | command |
+      | swim      | swim    |
+      | help swim | swim    |
+
+  Scenario Outline: Run an invalid command
+    When I run "<invalid command>"
+    Then the output should contain:
+      """
+      I don't understand the options you provided.
+      Run "<help command>" for usage information.
+      """
+    Examples:
+      | invalid command               | help command        |
+      | trout checkout                | trout help checkout |
+      | trout checkout file           | trout help checkout |
+      | trout checkout file url extra | trout help checkout |
+      | trout update                  | trout help update   |
+      | trout update file extra       | trout help update   |
+
+  Scenario Outline: Ask for help
+    When I run "<help command>"
+    Then the output should contain:
+      """
+      trout helps you sync individual files from other git repositories.
+      """
+    And the output should contain:
+      """
+      Commands:
+      """
+    And the output should not contain:
+      """
+      I don't know how
+      """
+    Examples:
+      | help command |
+      | trout        |
+      | trout help   |
+      | trout -h     |
+      | trout --help |
+
+  Scenario Outline: Ask for usage for a particular command
+    When I run "trout help <command>"
+    Then the output should contain:
+      """
+      Usage: trout <command> <usage>
+      """
+    Examples:
+      | command  | usage            |
+      | checkout | filename git_url |
+      | update   | filename         |

data/features/sync_gemfile.feature

@@ -1,6 +1,5 @@
 Feature: sync a Gemfile between two repositories
 
-  @puts @announce
   Scenario: sync a Gemfile
     Given a directory named "upstream_repo"
     And a directory named "child_repo"
@@ -16,6 +15,10 @@ Feature: sync a Gemfile between two repositories
     And I run "git commit -m 'Added gemfile'"
     And I cd to "../child_repo"
     And I run "trout checkout Gemfile ../upstream_repo"
+    Then the output should contain:
+      """
+      Checked out Gemfile from ../upstream_repo.
+      """
     And I run "cat Gemfile"
     Then the output should contain:
       """
@@ -39,7 +42,11 @@ Feature: sync a Gemfile between two repositories
       gem "redcloth"
       """
     When I run "trout update Gemfile"
-    And I run "cat Gemfile"
+    Then the output should contain:
+      """
+      Merged changes to Gemfile.
+      """
+    When I run "cat Gemfile"
     Then the output should contain:
       """
       source "http://rubygems.org"
@@ -49,6 +56,26 @@ Feature: sync a Gemfile between two repositories
       gem "redcloth"
       =======
       gem "postgresql"
-      >>>>>>> .trout/upstream
+      >>>>>>> /tmp/upstream
+      """
+    When I write to "Gemfile" with:
+      """
+      source "http://rubygems.org"
+      gem "rails"
+      gem "mysql"
+      gem "redcloth"
+      """
+    When I run "trout update Gemfile"
+    Then the output should contain:
+      """
+      Gemfile already up to date.
+      """
+    And I run "cat Gemfile"
+    Then the output should contain:
+      """
+      source "http://rubygems.org"
+      gem "rails"
+      gem "mysql"
+      gem "redcloth"
       """
 

data/lib/trout/cli.rb

@@ -1,3 +1,4 @@
+require 'optparse'
 require 'trout/managed_file'
 
 module Trout
@@ -6,31 +7,104 @@ module Trout
       new(arguments).run
     end
 
-    attr_reader :arguments, :git_url, :filename, :file, :command
+    attr_accessor :command, :option_parser, :arguments, :file
 
     def initialize(arguments)
-      self.arguments = arguments
-      self.file = ManagedFile.new(filename)
+      self.arguments     = arguments
+      self.option_parser = parse_options
     end
 
     def run
       case command
       when 'checkout'
-        self.git_url = arguments[2]
+        build_file
+        git_url = next_argument
+        end_arguments
         file.copy_from(git_url)
       when 'update'
+        build_file
+        end_arguments
         file.update
+      when 'help', nil
+        puts option_parser
+        if arguments_left?
+          puts
+          usage_for(next_argument)
+        end
+      else
+        unknown_command(command)
       end
     end
 
     private
 
-    def arguments=(arguments)
-      @arguments    = arguments
-      self.command  = arguments[0]
-      self.filename = arguments[1]
+    def parse_options
+      option_parser = OptionParser.new do |parser|
+        parser.banner =
+          "trout helps you sync individual files from other git repositories.\n\n" +
+          "Usage: trout [options] command arguments"
+
+        parser.separator ""
+        parser.separator "Options:"
+        parser.separator ""
+
+        parser.on("-h", "--help", "View this help document")
+
+        parser.separator ""
+        parser.separator "Commands:"
+        parser.separator ""
+        parser.separator "  checkout - start tracking a file from another repository"
+        parser.separator "  help     - get usage details for a specific command"
+        parser.separator "  update   - synchronize changes to a tracked file"
+      end
+
+      option_parser.parse!(arguments)
+
+      if arguments_left?
+        self.command = next_argument
+      else
+        self.command = 'help'
+      end
+
+      option_parser
+    end
+
+    def next_argument
+      arguments.shift or invalid_arguments
     end
 
-    attr_writer :git_url, :filename, :file, :command
+    def arguments_left?
+      !arguments.empty?
+    end
+
+    def invalid_arguments
+      puts "I don't understand the options you provided."
+      puts %{Run "trout help #{command}" for usage information.}
+      exit
+    end
+
+    def end_arguments
+      invalid_arguments if arguments_left?
+    end
+
+    def build_file
+      self.file = ManagedFile.new(next_argument)
+    end
+
+    def usage_for(command)
+      case command
+      when 'checkout'
+        puts "Usage: trout checkout filename git_url"
+      when 'update'
+        puts "Usage: trout update filename"
+      else
+        unknown_command(command)
+      end
+    end
+
+    def unknown_command(command)
+      puts %{I don't know how to "#{command}."}
+      puts %{Run "trout help" for usage information.}
+    end
   end
 end

data/lib/trout/managed_file.rb

@@ -13,13 +13,20 @@ module Trout
       checkout(git_url)
       copy_to_destination
       write_url_and_version
+      puts "Checked out #{filename} from #{git_url}."
     ensure
       cleanup
     end
 
     def update
       checkout(previous_git_url)
-      merge_to_destination
+      if up_to_date?
+        puts "#{filename} already up to date."
+      else
+        merge_to_destination
+        write_url_and_version
+        puts "Merged changes to #{filename}."
+      end
     ensure
       cleanup
     end
@@ -65,10 +72,6 @@ module Trout
       FileUtils.mkdir(working_root)
     end
 
-    def working_root
-      '.trout'
-    end
-
     def write_url_and_version
       version_list.update(filename,
                           'git_url' => checked_out_url,
@@ -76,7 +79,7 @@ module Trout
     end
 
     def checked_out_version
-      git_command("rev-parse HEAD")
+      git_command("rev-parse master")
     end
 
     def checkout_last_version
@@ -95,12 +98,16 @@ module Trout
       version_list.version_for(filename)
     end
 
+    def up_to_date?
+      previous_git_version == checked_out_version
+    end
+
     def version_list
-      @version_list ||= VersionList.new(working('versions'))
+      @version_list ||= VersionList.new('.trout')
     end
 
     def working(*paths)
-      File.join(working_root, *paths)
+      File.join('/tmp', *paths)
     end
 
     def enforce_newline(path)

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: trout
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Joe Ferris
@@ -14,13 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-10 00:00:00 -04:00
+date: 2010-09-21 00:00:00 -04:00
 default_executable: trout
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: cucumber
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id001
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: aruba
+  name: cucumber
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,8 +41,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id002
   type: :development
-  version_requirements: *id002
+  name: aruba
+  prerelease: false
 description: |-
   Trout allows you to maintain a base version of special
         files (like Gemfile) in one repository, and then syncronize just that
@@ -60,6 +60,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - Rakefile
 - README.textile
@@ -67,6 +69,7 @@ files:
 - lib/trout/managed_file.rb
 - lib/trout/version_list.rb
 - lib/trout.rb
+- features/help.feature
 - features/support/env.rb
 - features/sync_gemfile.feature
 - bin/trout
@@ -105,5 +108,6 @@ signing_key:
 specification_version: 3
 summary: So your common files can swim upstream.
 test_files: 
+- features/help.feature
 - features/support/env.rb
 - features/sync_gemfile.feature