Support --frozen option for routing annotations

Signed-off-by: kg8m <[email protected]>

Author: kg8m

lib/annotate/annotate_routes.rb

@@ -30,10 +30,18 @@ def do_annotations(options = {})
         new_content = annotate_routes(HeaderGenerator.generate(options), content, header_position, options)
         new_text = new_content.join("\n")
 
-        if rewrite_contents(existing_text, new_text)
-          puts "#{routes_file} was annotated."
+        if options[:frozen]
+          if needs_rewrite_contents?(existing_text, new_text)
+            abort "annotate error. #{routes_file} needs to be updated, but annotate was run with `--frozen`."
+          else
+            puts "#{routes_file} was not changed."
+          end
         else
-          puts "#{routes_file} was not changed."
+          if rewrite_contents(existing_text, new_text)
+            puts "#{routes_file} was annotated."
+          else
+            puts "#{routes_file} was not changed."
+          end
         end
       else
         puts "#{routes_file} could not be found."
@@ -83,14 +91,18 @@ def strip_on_removal(content, header_position)
     end
 
     def rewrite_contents(existing_text, new_text)
-      if existing_text == new_text
-        false
-      else
+      if needs_rewrite_contents?(existing_text, new_text)
         File.open(routes_file, 'wb') { |f| f.puts(new_text) }
         true
+      else
+        false
       end
     end
 
+    def needs_rewrite_contents?(existing_text, new_text)
+      existing_text != new_text
+    end
+
     def annotate_routes(header, content, header_position, options = {})
       magic_comments_map, content = Helpers.extract_magic_comments_from_array(content)
       if %w(before top).include?(options[:position_in_routes])

lib/tasks/annotate_routes.rake

@@ -14,6 +14,7 @@ task :annotate_routes => :environment do
   options[:position_in_routes] = Annotate::Helpers.fallback(ENV['position_in_routes'], ENV['position'])
   options[:ignore_routes] = Annotate::Helpers.fallback(ENV['ignore_routes'],  nil)
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
+  options[:frozen] = Annotate::Helpers.true?(ENV['frozen'])
   options[:wrapper_open] = Annotate::Helpers.fallback(ENV['wrapper_open'], ENV['wrapper'])
   options[:wrapper_close] = Annotate::Helpers.fallback(ENV['wrapper_close'], ENV['wrapper'])
   AnnotateRoutes.do_annotations(options)