annotate 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5fdb0f67e1790c14efff769d33ea5bd83e0120a2aa90ed3c738d04a8247266
-  data.tar.gz: 07d173cb24fe0476aba4152feb618c29a303705e882301718177ed7ad34501e4
+  metadata.gz: 14932a4a189792b68c9d85c63313d0d60322ca22fed18a7a4a00edd47348743a
+  data.tar.gz: 351b61b7b3eac94f1ce6d8a86e1630bbbf6c0920cacfe46319163a86bc189887
 SHA512:
-  metadata.gz: 8c2e1d4d012e7d65b1282bc8497db61d9d95bdfa1ea1709d362d3b1c35609d659183f58a42ae3e48833a6be9519daf09e2b538b06b7ccf1706d2c963c4301027
-  data.tar.gz: 8ac9930d48f5ed72d1f6b453956882c637360323b31bc465d0ff3803f015c1adc93275c0a4eb46d29431588bc1b8110e8a5408f81d417e0b65d5132e318c25a4
+  metadata.gz: a717f48aff793ea4566fca6919eb4fe85b1545fe93b0bece91c5a9507cbb87fe14aa35ac520e618e98f8db92fe11010a8fe8653802b25b83b24590467e5d64f1
+  data.tar.gz: d13aab072e5e3901788f4aff809e08f3d28ac24cf0eed4187b0e5c0f98008f3c95a7553b58c4f50705f2f42729e96a05a57631356715953bb7d29531e4365fbd

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 3.1.1
+Changes
+- Bump required ruby version to >= 2.4 [#772](https://github.com/ctran/annotate_models/pull/772)
+- [Revert #677] Fix column default annotations [#768](https://github.com/ctran/annotate_models/pull/768)
+
+Project Improvements
+- Refactor by adding AnnotateRoutes::Helpers [#770](https://github.com/ctran/annotate_models/pull/770) 
+- Bump puma from 4.3.1 to 4.3.3 in /spec/integration/rails_6.0.2.1 [#771](https://github.com/ctran/annotate_models/pull/771)
+- Bump puma from 3.12.2 to 4.3.3 in /spec/integration/rails_5.2.4.1 [#769](https://github.com/ctran/annotate_models/pull/769)
+- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_5.2.4.1 [#766](https://github.com/ctran/annotate_models/pull/766)
+- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_6.0.2.1 [#765](https://github.com/ctran/annotate_models/pull/765)
+- Refactor test cases of AnnotateRoutes [#760](https://github.com/ctran/annotate_models/pull/760)
+- Rename FactoryGirl -> FactoryBot comment [#759](https://github.com/ctran/annotate_models/pull/759)
+
 ## 3.1.0
 Changes
 - Fix new lines after comments for rubocop compatibility [#757](https://github.com/ctran/annotate_models/pull/757)

data/annotate.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name = 'annotate'
   s.version = Annotate.version
 
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.authors = ['Alex Chaffee', 'Cuong Tran', 'Marcos Piccinini', 'Turadg Aleahmad', 'Jon Frisby']
   s.description = 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.'

data/lib/annotate/annotate_models.rb

@@ -38,7 +38,7 @@ module AnnotateModels
   BLUEPRINTS_TEST_DIR   = File.join('test', "blueprints")
   BLUEPRINTS_SPEC_DIR   = File.join('spec', "blueprints")
 
-  # Factory Girl https://github.com/thoughtbot/factory_bot
+  # Factory Bot https://github.com/thoughtbot/factory_bot
   FACTORY_BOT_TEST_DIR = File.join('test', "factories")
   FACTORY_BOT_SPEC_DIR = File.join('spec', "factories")
 
@@ -213,7 +213,7 @@ module AnnotateModels
     end
 
     def schema_default(klass, column)
-      quote(klass.columns.find { |x| x.name.to_s == column.name.to_s }.try(:default))
+      quote(klass.column_defaults[column.name])
     end
 
     def retrieve_indexes_from_table(klass)

data/lib/annotate/annotate_routes.rb

@@ -19,18 +19,19 @@
 #
 # Released under the same license as Ruby. No Support. No Warranty.
 #
+
+require_relative './annotate_routes/helpers'
+
 module AnnotateRoutes
   PREFIX = '== Route Map'.freeze
   PREFIX_MD = '## Route Map'.freeze
   HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
 
-  MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
-
   class << self
     def do_annotations(options = {})
       if routes_file_exist?
         existing_text = File.read(routes_file)
-        content, header_position = strip_annotations(existing_text)
+        content, header_position = Helpers.strip_annotations(existing_text)
         new_content = annotate_routes(header(options), content, header_position, options)
         new_text = new_content.join("\n")
 
@@ -47,7 +48,7 @@ module AnnotateRoutes
     def remove_annotations(_options={})
       if routes_file_exist?
         existing_text = File.read(routes_file)
-        content, header_position = strip_annotations(existing_text)
+        content, header_position = Helpers.strip_annotations(existing_text)
         new_content = strip_on_removal(content, header_position)
         new_text = new_content.join("\n")
         if rewrite_contents(existing_text, new_text)
@@ -73,7 +74,7 @@ module AnnotateRoutes
     def header(options = {})
       routes_map = app_routes_map(options)
 
-      magic_comments_map, routes_map = extract_magic_comments_from_array(routes_map)
+      magic_comments_map, routes_map = Helpers.extract_magic_comments_from_array(routes_map)
 
       out = []
 
@@ -113,35 +114,6 @@ module AnnotateRoutes
       end
     end
 
-    # TODO: write the method doc using ruby rdoc formats
-    # This method returns an array of 'real_content' and 'header_position'.
-    # 'header_position' will either be :before, :after, or
-    # a number.  If the number is > 0, the
-    # annotation was found somewhere in the
-    # middle of the file.  If the number is
-    # zero, no annotation was found.
-    def strip_annotations(content)
-      real_content = []
-      mode = :content
-      header_position = 0
-
-      content.split(/\n/, -1).each_with_index do |line, line_number|
-        if mode == :header && line !~ /\s*#/
-          mode = :content
-          real_content << line unless line.blank?
-        elsif mode == :content
-          if line =~ /^\s*#\s*== Route.*$/
-            header_position = line_number + 1 # index start's at 0
-            mode = :header
-          else
-            real_content << line
-          end
-        end
-      end
-
-      real_content_and_header_position(real_content, header_position)
-    end
-
     def strip_on_removal(content, header_position)
       if header_position == :before
         content.shift while content.first == ''
@@ -168,7 +140,7 @@ module AnnotateRoutes
     end
 
     def annotate_routes(header, content, header_position, options = {})
-      magic_comments_map, content = extract_magic_comments_from_array(content)
+      magic_comments_map, content = Helpers.extract_magic_comments_from_array(content)
       if %w(before top).include?(options[:position_in_routes])
         header = header << '' if content.first != ''
         magic_comments_map << '' if magic_comments_map.any?
@@ -208,24 +180,6 @@ module AnnotateRoutes
       routes_map
     end
 
-    # @param [Array<String>] content
-    # @return [Array<String>] all found magic comments
-    # @return [Array<String>] content without magic comments
-    def extract_magic_comments_from_array(content_array)
-      magic_comments = []
-      new_content = []
-
-      content_array.each do |row|
-        if row =~ MAGIC_COMMENT_MATCHER
-          magic_comments << row.strip
-        else
-          new_content << row
-        end
-      end
-
-      [magic_comments, new_content]
-    end
-
     def content(line, maxs, options = {})
       return line.rstrip unless options[:format_markdown]
 
@@ -235,18 +189,5 @@ module AnnotateRoutes
         sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
       end.join(' | ')
     end
-
-    def real_content_and_header_position(real_content, header_position)
-      # By default assume the annotation was found in the middle of the file
-
-      # ... unless we have evidence it was at the beginning ...
-      return real_content, :before if header_position == 1
-
-      # ... or that it was at the end.
-      return real_content, :after if header_position >= real_content.count
-
-      # and the default
-      return real_content, header_position
-    end
   end
 end

data/lib/annotate/annotate_routes/helpers.rb

@@ -0,0 +1,69 @@
+module AnnotateRoutes
+  module Helpers
+    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+
+    class << self
+      # TODO: write the method doc using ruby rdoc formats
+      # This method returns an array of 'real_content' and 'header_position'.
+      # 'header_position' will either be :before, :after, or
+      # a number.  If the number is > 0, the
+      # annotation was found somewhere in the
+      # middle of the file.  If the number is
+      # zero, no annotation was found.
+      def strip_annotations(content)
+        real_content = []
+        mode = :content
+        header_position = 0
+
+        content.split(/\n/, -1).each_with_index do |line, line_number|
+          if mode == :header && line !~ /\s*#/
+            mode = :content
+            real_content << line unless line.blank?
+          elsif mode == :content
+            if line =~ /^\s*#\s*== Route.*$/
+              header_position = line_number + 1 # index start's at 0
+              mode = :header
+            else
+              real_content << line
+            end
+          end
+        end
+
+        real_content_and_header_position(real_content, header_position)
+      end
+
+      # @param [Array<String>] content
+      # @return [Array<String>] all found magic comments
+      # @return [Array<String>] content without magic comments
+      def extract_magic_comments_from_array(content_array)
+        magic_comments = []
+        new_content = []
+
+        content_array.each do |row|
+          if row =~ MAGIC_COMMENT_MATCHER
+            magic_comments << row.strip
+          else
+            new_content << row
+          end
+        end
+
+        [magic_comments, new_content]
+      end
+
+      private
+
+      def real_content_and_header_position(real_content, header_position)
+        # By default assume the annotation was found in the middle of the file
+
+        # ... unless we have evidence it was at the beginning ...
+        return real_content, :before if header_position == 1
+
+        # ... or that it was at the end.
+        return real_content, :after if header_position >= real_content.count
+
+        # and the default
+        return real_content, header_position
+      end
+    end
+  end
+end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '3.1.0'
+    '3.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Alex Chaffee
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,7 @@ files:
 - lib/annotate/active_record_patch.rb
 - lib/annotate/annotate_models.rb
 - lib/annotate/annotate_routes.rb
+- lib/annotate/annotate_routes/helpers.rb
 - lib/annotate/constants.rb
 - lib/annotate/helpers.rb
 - lib/annotate/parser.rb
@@ -105,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="