Make --timestamp optional by default

Author: Cuong Tran

README.rdoc

@@ -179,7 +179,7 @@ you can do so with a simple environment variable, instead of editing the
             --format
             --force                      Force new annotations even if there are no changes.
             --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
-        --no-timestamp                   Do not include an updated time in routes
+        --timestamp                      Include an updated time in routes.rb
 
 
 == Sorting

bin/annotate

@@ -132,8 +132,8 @@ OptionParser.new do |opts|
     ENV['force'] = 'yes'
   end
 
-  opts.on('--no-timestamp', 'Exclude timestamp in (routes) annotation') do
-    ENV['no_timestamp'] = 'true'
+  opts.on('--timestamp', 'Include timestamp in (routes) annotation') do
+    ENV['timestamp'] = 'true'
   end
 
   opts.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |value|

lib/annotate.rb

@@ -22,7 +22,7 @@ module Annotate
   FLAG_OPTIONS=[
     :show_indexes, :simple_indexes, :include_version, :exclude_tests,
     :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
-    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace, :no_timestamp
+    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace, :timestamp
   ]
   OTHER_OPTIONS=[
     :model_dir, :ignore_columns

lib/annotate/annotate_routes.rb

@@ -33,7 +33,7 @@ def self.do_annotations(options={})
     routes_map.shift if(routes_map.first =~ /^\(in \//)
 
     header = [
-      "#{PREFIX}" + (options[:no_timestamp] ? "" : " (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})"),
+      "#{PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})" : ""),
       "#"
     ] + routes_map.map { |line| "# #{line}".rstrip }
 

spec/annotate/annotate_routes_spec.rb

@@ -24,13 +24,13 @@ def mock_file(stubs={})
 
     it "should annotate and add a newline!" do
       File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo")
-      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map \(Updated \d{4}-\d{2}-\d{2} \d{2}:\d{2}\)\n#\n# good line\n/)
+      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map\n#\n# good line\n/)
       AnnotateRoutes.do_annotations
     end
 
     it "should not add a newline if there are empty lines" do
       File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo\n")
-      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map \(Updated \d{4}-\d{2}-\d{2} \d{2}:\d{2}\)\n#\n# good line\n/)
+      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map\n#\n# good line\n/)
       AnnotateRoutes.do_annotations
     end
 
@@ -47,20 +47,20 @@ def mock_file(stubs={})
 
     it "should annotate and add a newline!" do
       File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo")
-      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map \(Updated \d{4}-\d{2}-\d{2} \d{2}:\d{2}\)\n#\n# another good line\n# good line\n/)
+      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map\n#\n# another good line\n# good line\n/)
       AnnotateRoutes.do_annotations
     end
 
     it "should not add a newline if there are empty lines" do
       File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo\n")
-      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map \(Updated \d{4}-\d{2}-\d{2} \d{2}:\d{2}\)\n#\n# another good line\n# good line\n/)
+      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map\n#\n# another good line\n# good line\n/)
       AnnotateRoutes.do_annotations
     end
 
-    it "should not add a timestamp when :no-timestamp is passed" do
-      File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo\n")
-      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map\n#\n# another good line\n# good line\n/)
-      AnnotateRoutes.do_annotations :no_timestamp => true
+    it "should add a timestamp when :timestamp is passed" do
+      File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo")
+      @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n# == Route Map \(Updated \d{4}-\d{2}-\d{2} \d{2}:\d{2}\)\n#\n# another good line\n# good line\n/)
+      AnnotateRoutes.do_annotations :timestamp => true
     end
 
   end
@@ -74,13 +74,13 @@ def mock_file(stubs={})
     end
 
     it "should remove trailing annotation and trim trailing newlines, but leave leading newlines alone" do
-      File.should_receive(:read).with("config/routes.rb").and_return("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nActionController::Routing...\nfoo\n\n\n\n\n\n\n\n\n\n\n# == Route Map (Updated 2012-08-16 00:00)\n#\n# another good line\n# good line\n")
+      File.should_receive(:read).with("config/routes.rb").and_return("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nActionController::Routing...\nfoo\n\n\n\n\n\n\n\n\n\n\n# == Route Map\n#\n# another good line\n# good line\n")
       @mock_file.should_receive(:puts).with(/\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nActionController::Routing...\nfoo\n/)
       AnnotateRoutes.remove_annotations
     end
 
     it "should remove prepended annotation and trim leading newlines, but leave trailing newlines alone" do
-      File.should_receive(:read).with("config/routes.rb").and_return("# == Route Map (Updated 2012-08-16 00:00)\n#\n# another good line\n# good line\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nActionController::Routing...\nfoo\n\n\n\n\n\n\n\n\n\n\n")
+      File.should_receive(:read).with("config/routes.rb").and_return("# == Route Map\n#\n# another good line\n# good line\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nActionController::Routing...\nfoo\n\n\n\n\n\n\n\n\n\n\n")
       @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n\n\n\n\n\n\n\n\n\n\n/)
       AnnotateRoutes.remove_annotations
     end