Rename constants

Author: nard-tech

spec/lib/annotate/annotate_routes_spec.rb

@@ -3,10 +3,11 @@
 
 describe AnnotateRoutes do
   ROUTE_FILE = 'config/routes.rb'.freeze
-  ANNOTATION_ADDED = "#{ROUTE_FILE} was annotated.".freeze
-  ANNOTATION_FILE_UNCHANGED = "#{ROUTE_FILE} was not changed.".freeze
-  ANNOTATION_FILE_COULD_NOT_FOUND = "#{ROUTE_FILE} could not be found.".freeze
-  ANNOTATION_REMOVED = "Annotations were removed from #{ROUTE_FILE}.".freeze
+
+  MESSAGE_ANNOTATED = "#{ROUTE_FILE} was annotated.".freeze
+  MESSAGE_UNCHANGED = "#{ROUTE_FILE} was not changed.".freeze
+  MESSAGE_NOT_FOUND = "#{ROUTE_FILE} could not be found.".freeze
+  MESSAGE_REMOVED = "Annotations were removed from #{ROUTE_FILE}.".freeze
 
   def mock_file(stubs = {})
     @mock_file ||= double(File, stubs)
@@ -30,7 +31,7 @@ def magic_comments_list_each
 
   it 'should check if routes.rb exists' do
     expect(File).to receive(:exist?).with(ROUTE_FILE).and_return(false)
-    expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_FILE_COULD_NOT_FOUND)
+    expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_NOT_FOUND)
     AnnotateRoutes.do_annotations
   end
 
@@ -47,7 +48,7 @@ def magic_comments_list_each
 
       expect(File).to receive(:read).with(ROUTE_FILE).and_return("").at_least(:once)
 
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED).at_least(:once)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).at_least(:once)
     end
 
     context 'without magic comments' do
@@ -73,7 +74,7 @@ def magic_comments_list_each
         expect(@mock_file).to receive(:puts).with("
 # ## Route Map
 #
-# Prefix    | Verb       | URI Pattern     | Controller#Action   
+# Prefix    | Verb       | URI Pattern     | Controller#Action
 # --------- | ---------- | --------------- | --------------------
 # myaction1 | GET        | /url1(.:format) | mycontroller1#action
 # myaction2 | POST       | /url2(.:format) | mycontroller2#action
@@ -130,7 +131,7 @@ def magic_comments_list_each
 
 # ## Route Map
 #
-# Prefix    | Verb       | URI Pattern     | Controller#Action   
+# Prefix    | Verb       | URI Pattern     | Controller#Action
 # --------- | ---------- | --------------- | --------------------
 # myaction1 | GET        | /url1(.:format) | mycontroller1#action
 # myaction2 | POST       | /url2(.:format) | mycontroller2#action
@@ -175,7 +176,7 @@ def magic_comments_list_each
       expect(File).to receive(:read).with(ROUTE_FILE).and_return("")
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
       expect(@mock_file).to receive(:puts).with("\n# == Route Map\n#\n")
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
 
       AnnotateRoutes.do_annotations
     end
@@ -184,7 +185,7 @@ def magic_comments_list_each
       expect(File).to receive(:read).with(ROUTE_FILE).and_return("")
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
       expect(@mock_file).to receive(:puts).with("\n# == Route Map\n#\n")
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
 
       AnnotateRoutes.do_annotations(ignore_routes: 'my_route')
     end
@@ -193,14 +194,14 @@ def magic_comments_list_each
       expect(File).to receive(:read).with(ROUTE_FILE).and_return("")
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
       expect(@mock_file).to receive(:puts).with("# == Route Map\n#\n")
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
 
       AnnotateRoutes.do_annotations(position_in_routes: 'top')
     end
 
     it 'should skip annotations if file does already contain annotation' do
       expect(File).to receive(:read).with(ROUTE_FILE).and_return("\n# == Route Map\n#\n")
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_FILE_UNCHANGED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED)
 
       AnnotateRoutes.do_annotations
     end
@@ -213,7 +214,7 @@ def magic_comments_list_each
         magic_comments_list_each do |magic_comment|
           expect(File).to receive(:read).with(ROUTE_FILE).and_return("#{magic_comment}\nSomething")
           expect(@mock_file).to receive(:puts).with("#{magic_comment}\n\n# == Route Map\n#\n\nSomething\n")
-          expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+          expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
           AnnotateRoutes.do_annotations(position_in_routes: 'top')
         end
       end
@@ -225,7 +226,7 @@ def magic_comments_list_each
         magic_comments_list_each do |magic_comment|
           expect(File).to receive(:read).with(ROUTE_FILE).and_return("#{magic_comment}\nSomething")
           expect(@mock_file).to receive(:puts).with("#{magic_comment}\nSomething\n\n# == Route Map\n#\n")
-          expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+          expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
           AnnotateRoutes.do_annotations(position_in_routes: 'bottom')
         end
       end
@@ -234,7 +235,7 @@ def magic_comments_list_each
         magic_comments_list_each do |magic_comment|
           expect(File).to receive(:read).with(ROUTE_FILE)
             .and_return("#{magic_comment}\n\n# == Route Map\n#\n")
-          expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_FILE_UNCHANGED)
+          expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED)
 
           AnnotateRoutes.do_annotations
         end
@@ -247,7 +248,7 @@ def magic_comments_list_each
       expect(File).to receive(:exist?).with(ROUTE_FILE).and_return(true)
       expect(AnnotateRoutes).to receive(:`).with('rake routes').and_return("(in /bad/line)\ngood line")
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
     end
 
     it 'should annotate and add a newline!' do
@@ -268,7 +269,7 @@ def magic_comments_list_each
       expect(File).to receive(:exist?).with(ROUTE_FILE).and_return(true)
       expect(AnnotateRoutes).to receive(:`).with('rake routes').and_return("another good line\ngood line")
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_ADDED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED)
     end
 
     it 'should annotate and add a newline!' do
@@ -294,7 +295,7 @@ def magic_comments_list_each
     before(:each) do
       expect(File).to receive(:exist?).with(ROUTE_FILE).and_return(true)
       expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
-      expect(AnnotateRoutes).to receive(:puts).with(ANNOTATION_REMOVED)
+      expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_REMOVED)
     end
 
     it 'should remove trailing annotation and trim trailing newlines, but leave leading newlines alone' do