commento 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7cc261c10ba9619a4d6f78856bd6307fd02a6f9a448db2f0672aabaff4e038c
-  data.tar.gz: c4efb2c2b2b5d9da69e3fa4a9f0555e8b6ebd712a03f7b8e3a4949d80da6a927
+  metadata.gz: 9a65354f12eb0a8c66c0bc901f87bb35f1ddf2d9d18f2b399c8e13758bc779e7
+  data.tar.gz: b0d88b4c72e2b6e6404b762b2113a6c61779c2d7a3cc4a7732c09452599d895c
 SHA512:
-  metadata.gz: 5b62dd5d4983d649927fff20945286694af6ebebac4b7f07279b8a15026831220310eb6613e2a0930a936fe50296c97c343c8c17b25563dc48c61ebdb55cf93f
-  data.tar.gz: 275e6b4fe545516a63539efd94254918dc564a222ba2023a5273e7460d5bfc9e1b5408464ac6878e8f5cf006d9940741be9bc261eba691c894f0c87b8ebb985f
+  metadata.gz: def8375883745c14c5fa4b032bec57a3e4030299fc79c4a0a214e46f177d4e962c93d99a2f899d51e8db450cb4e14ca26d5805430f678b5489b85f14893a72f1
+  data.tar.gz: b7fe5588c90a2c072efb614a43201220c443410ed149b3965ea5baf65e93276506e85fe61c4d859e2a15556e4d8232b379e6425f9b288013f48918594689c168

data/lib/commento/adapters/active_record.rb

@@ -8,8 +8,6 @@ module Commento
       # Public: The name of the adapter.
       attr_reader :name
 
-      SKIP_COLUMN_NAME = %w[id uuid created_at updated_at].freeze
-
       # Public: Initialize a new ActiveRecord adapter instance.
       #
       # name - The Symbol name for this adapter. Optional (default :active_record)
@@ -46,24 +44,30 @@ module Commento
 
       # Public: Returns comments for tables and columns.
       def comments_for_database
-        execute(tables_comments_sql).to_a.map! do |table_data|
-          {
-            table_name: table_data['table_name'],
-            table_comment: table_data['obj_description'],
-            columns: execute(columns_comments_sql(table_data['table_name'])).to_a.filter_map do |column_data|
-              next if SKIP_COLUMN_NAME.include?(column_data['column_name'])
-
-              {
-                column_name: column_data['column_name'],
-                column_comment: column_data['col_description']
-              }
-            end
-          }
+        execute(tables_comments_sql).to_a.filter_map do |table_data|
+          next if configuration.skip_table_names.include?(table_data['table_name'])
+
+          parse_data(table_data)
         end
       end
 
       private
 
+      def parse_data(table_data)
+        {
+          table_name: table_data['table_name'],
+          table_comment: table_data['obj_description'],
+          columns: execute(columns_comments_sql(table_data['table_name'])).to_a.filter_map do |column_data|
+            next if configuration.skip_column_names.include?(column_data['column_name'])
+
+            {
+              column_name: column_data['column_name'],
+              column_comment: column_data['col_description']
+            }
+          end
+        }
+      end
+
       def tables_comments_sql
         <<-SQL.squish
           SELECT
@@ -94,6 +98,10 @@ module Commento
       def execute(sql)
         ::ActiveRecord::Base.connection.execute(sql)
       end
+
+      def configuration
+        Commento.configuration
+      end
     end
   end
 end

data/lib/commento/configuration.rb

@@ -2,10 +2,14 @@
 
 module Commento
   class Configuration
-    attr_accessor :adapter
+    attr_accessor :adapter, :include_folders, :exclude_folders, :skip_table_names, :skip_column_names
 
     def initialize
       @adapter = nil
+      @include_folders = %w[app lib]
+      @exclude_folders = ['app/assets']
+      @skip_table_names = %w[ar_internal_metadata schema_migrations]
+      @skip_column_names = %w[id uuid created_at updated_at]
     end
   end
 end

data/lib/commento/report.rb

@@ -2,10 +2,17 @@
 
 module Commento
   class Report
+    COMMENTO_FOLDER_NAME = 'commento'
+
+    def initialize(data_scraper: Commento::Scrapers::Ruby.new)
+      @data_scraper = data_scraper
+    end
+
     def create_report
-      FileUtils.mkdir_p('commento')
+      @commento_data = @data_scraper.call
+      FileUtils.mkdir_p(COMMENTO_FOLDER_NAME)
       File.write(
-        "commento/index.#{template_format}",
+        "#{COMMENTO_FOLDER_NAME}/#{file_name}",
         main_template.gsub('%tables_placeholder%', tables_placeholder)
       )
     end
@@ -23,9 +30,19 @@ module Commento
 
     def columns_placeholder(table_name, columns)
       columns.map do |column_data|
+        full_column_name = "#{table_name}.#{column_data[:column_name]}"
         column_template
-          .gsub('%column_name%', "#{table_name}.#{column_data[:column_name]}")
+          .gsub('%column_name%', full_column_name)
           .gsub('%column_comment%', column_data[:column_comment].presence || '')
+          .gsub('%data_placeholder%', data_placeholder(full_column_name))
+      end.join
+    end
+
+    def data_placeholder(full_column_name)
+      return '' if @commento_data[full_column_name].blank?
+
+      @commento_data[full_column_name].map do |filename|
+        data_template.gsub('%commento_data%', filename)
       end.join
     end
 
@@ -45,7 +62,11 @@ module Commento
       raise NotImplementedError
     end
 
-    def template_format
+    def data_template
+      raise NotImplementedError
+    end
+
+    def file_name
       raise NotImplementedError
     end
 

data/lib/commento/reports/html.rb

@@ -35,11 +35,22 @@ module Commento
       end
 
       def column_template
-        "        <p>%column_name%: %column_comment%</p>\n"
+        [
+          "        <div class='column-body'>",
+          '          <p>%column_name%: %column_comment%</p>',
+          "          <div class='column-data'>",
+          '%data_placeholder%',
+          '          </div>',
+          "        </div>\n"
+        ].join("\n")
+      end
+
+      def data_template
+        '            <span>%commento_data%</span>'
       end
 
-      def template_format
-        'html'
+      def file_name
+        'index.html'
       end
 
       def styles
@@ -52,6 +63,10 @@ module Commento
           '.table-header h3 { padding: .25rem; background: #bbb }',
           '.table-header p { padding: .25rem; margin: 0 }',
           '.table-body { padding: 0 .25rem }',
+          '.column-body { margin-bottom: .5rem; }',
+          '.column-body p { margin: 0 }',
+          '.column-data { display: flex; flex-direction: column; margin: .5rem 0 }',
+          '.column-data span { font-style: italic; padding-left: 1rem }',
           '</style>'
         ].join
       end

data/lib/commento/scrapers/ruby.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Commento
+  module Scrapers
+    class Ruby
+      COMMENTO_MATCH_REGEXP = /^[ \t]*# commento:.+$/.freeze
+
+      # @data contains data with next format
+      # {
+      #   'fantasy_sports.points' => [
+      #     'app/services/some_service.rb:11'
+      #   ]
+      # }
+      # key - table_name.column_name
+      # values - lines of files where these columns are changed in the code
+      def initialize
+        @data = {}
+      end
+
+      def call
+        configuration.include_folders.each { |include_folder| iterate_folder(include_folder) }
+        @data
+      end
+
+      private
+
+      def iterate_folder(include_folder)
+        Dir.glob("#{include_folder}/**/*.rb").each do |filename|
+          next if exclude_folders.include?(filename.split('/')[0..-2].join('/'))
+
+          File.open(filename) { |lines| iterate_filelines(lines, filename) }
+        end
+      end
+
+      # commento line looks like
+      # commento: fantasy_sports.points, fantasy_sports.statistics
+      def iterate_filelines(lines, filename)
+        lines.each.with_index(1) do |line, index|
+          next unless COMMENTO_MATCH_REGEXP.match?(line)
+
+          fields = line.strip.split('# commento: ')[-1].split(',').map(&:strip)
+          fields.each do |field|
+            @data[field] ||= []
+            @data[field] << "#{filename}:#{index}"
+          end
+        end
+      end
+
+      def exclude_folders
+        @exclude_folders ||= configuration.exclude_folders
+      end
+
+      def configuration
+        Commento.configuration
+      end
+    end
+  end
+end

data/lib/commento/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commento
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

data/lib/commento.rb

@@ -8,6 +8,7 @@ require 'commento/dsl'
 require 'commento/helpers'
 require 'commento/report'
 require 'commento/reports/html'
+require 'commento/scrapers/ruby'
 
 module Commento
   extend self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commento
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -82,6 +82,7 @@ files:
 - lib/commento/helpers.rb
 - lib/commento/report.rb
 - lib/commento/reports/html.rb
+- lib/commento/scrapers/ruby.rb
 - lib/commento/version.rb
 homepage: https://github.com/kortirso/commento
 licenses: