repo_analyzer 1.0.0

data/app/extractors/repo_analyzer/github_extractor.rb

@@ -0,0 +1,64 @@
+module RepoAnalyzer
+  class GithubExtractor < ProjectInfoExtractor
+    private
+
+    def extracted_info
+      {
+        last_commit_date: last_commit_date.to_s,
+        last_contributors: last_contributors,
+        contributors: contributors
+      }
+    end
+
+    def last_contributors
+      @last_contributors ||= contributors.select do |contributor|
+        contributors_from_commits.include?(contributor[:login])
+      end
+    end
+
+    def contributors_from_commits
+      @contributors_from_commits ||= last_commits.inject([]) do |users, commit|
+        if commit[:author]
+          login = commit[:author][:login]
+          users << login unless users.include?(login)
+        end
+
+        users
+      end
+    end
+
+    def contributors
+      @contributors ||= project_data_bridge.contributors.map do |contributor|
+        build_user_info(contributor)
+      end
+    end
+
+    def build_user_info(data)
+      {
+        login: data[:login],
+        avatar_url: data[:avatar_url],
+        contributions: data[:contributions]
+      }
+    end
+
+    def last_commits
+      @last_commits ||= begin
+        return [] if last_commit_date == :not_found
+
+        project_data_bridge.commits(
+          from_date: last_commit_date - 2.months,
+          to_date: last_commit_date + 1.day
+        )
+      end
+    end
+
+    def last_commit_date
+      @last_commit_date ||= project_data_bridge.commits(
+        from_date: Date.current - 2.years,
+        to_date: Date.current
+      ).first[:commit][:author][:date].to_date
+    rescue NoMethodError
+      :not_found
+    end
+  end
+end

data/app/extractors/repo_analyzer/power_types_extractor.rb

@@ -0,0 +1,21 @@
+module RepoAnalyzer
+  class PowerTypesExtractor < ProjectInfoExtractor
+    POWERTYPES = %i{
+      commands
+      services
+      observers
+      values
+      utils
+      clients
+    }
+
+    private
+
+    def extracted_info
+      POWERTYPES.inject({}) do |memo, type|
+        memo[type] = project_data_bridge.dir_files("app/#{type}").any?
+        memo
+      end
+    end
+  end
+end

data/app/extractors/repo_analyzer/project_config_extractor.rb

@@ -0,0 +1,53 @@
+module RepoAnalyzer
+  class ProjectConfigExtractor < ProjectInfoExtractor
+    MAKEFILE_CMDS_REGEXP = /^([\w|-]*):/
+    RUBOCOP_RULES_REGEXP = %r{^([\w|/]+):}
+
+    EXCLUDED_MAKEFILE_CMDS = %w{
+      run
+      help
+    }
+
+    EXCLUDED_RUBOCOP_RULES = %w{
+      require
+    }
+
+    private
+
+    def extracted_info
+      {
+        simplecov: simplecov?,
+        makefile_commands: makefile_commands,
+        rubocop_rules: rubocop_rules
+      }
+    end
+
+    def simplecov?
+      project_data_bridge.file_exist?("spec/simplecov_config.rb")
+    end
+
+    def makefile_commands
+      extract_matches_from_content(makefile_content, MAKEFILE_CMDS_REGEXP).reject do |cmd|
+        EXCLUDED_MAKEFILE_CMDS.include?(cmd)
+      end
+    end
+
+    def rubocop_rules
+      extract_matches_from_content(rubocop_rules_content, RUBOCOP_RULES_REGEXP).reject do |rule|
+        EXCLUDED_RUBOCOP_RULES.include?(rule)
+      end
+    end
+
+    def extract_matches_from_content(content, regexp)
+      content.to_s.scan(regexp).flatten.sort
+    end
+
+    def makefile_content
+      @makefile_content ||= project_data_bridge.file_content("Makefile")
+    end
+
+    def rubocop_rules_content
+      @rubocop_rules_content ||= project_data_bridge.file_content(".rubocop.yml")
+    end
+  end
+end

data/app/extractors/repo_analyzer/project_info_extractor.rb

@@ -0,0 +1,20 @@
+module RepoAnalyzer
+  class ProjectInfoExtractor
+    def initialize(project_data_bridge)
+      @project_data_bridge = project_data_bridge
+    end
+
+    def extract
+      key = self.class.name.underscore.split("/").last.to_sym
+      { key => extracted_info.with_indifferent_access }
+    end
+
+    private
+
+    def extracted_info
+      raise RepoAnalyzer::Error.new("extracted_info method not implemented")
+    end
+
+    attr_reader :project_data_bridge
+  end
+end

data/app/extractors/repo_analyzer/project_versions_extractor.rb

@@ -0,0 +1,80 @@
+module RepoAnalyzer
+  class ProjectVersionsExtractor < ProjectInfoExtractor
+    CI_VERSION_REGEXP = /^version:\s(\d)/
+    RAILS_VERSION_REGEX = /^\s{4}rails \((\d.*)\)/
+    PAPERCLIP_VERSION = /^\s{4}paperclip \((\d.*)\)/
+    SHRINE_VERSION = /^\s{4}shrine \((\d.*)\)/
+    RUBOCOP_VERSION = /^\s{4}rubocop \((\d.*)\)/
+    SIDEKIQ_VERSION = /^\s{4}sidekiq \((\d.*)\)/
+
+    private
+
+    def extracted_info
+      {
+        rails_version: gem_version(RAILS_VERSION_REGEX),
+        node_version: package_version("engines.node"),
+        vue_version: package_version("dependencies.vue"),
+        vue_router_version: package_version("dependencies.vue-router"),
+        typescript_version: package_version("dependencies.typescript"),
+        tailwind_version: tailwind_version,
+        paperclip_version: gem_version(PAPERCLIP_VERSION),
+        shrine_version: gem_version(SHRINE_VERSION),
+        sidekiq_version: gem_version(SIDEKIQ_VERSION),
+        circleci_version: circleci_version,
+        rubocop_version: gem_version(RUBOCOP_VERSION),
+        eslint_version: package_version("devDependencies.eslint"),
+        stylelint_version: package_version("devDependencies.stylelint")
+      }
+    end
+
+    def tailwind_version
+      return "2" if package_json_content.to_s.include?("postcss7-compat")
+
+      package_version("dependencies.tailwindcss")
+    end
+
+    def gem_version(regexp)
+      gemfile_content&.match(regexp)&.captures&.first
+    end
+
+    def package_version(dependency)
+      content = package_json_content
+      return nil if content.blank?
+
+      version = JSON.parse(content)
+                    .dig(*dependency.split(".")).to_s.split("")
+                    .select do |value|
+        value == "." || int?(value)
+      end
+
+      version.pop if version.last == "."
+      return version.join("") if version.present?
+
+      nil
+    rescue JSON::ParserError
+      nil
+    end
+
+    def circleci_version
+      ci_config_content&.match(CI_VERSION_REGEXP)&.captures&.first
+    end
+
+    def int?(value)
+      Integer(value)
+    rescue ArgumentError
+      false
+    end
+
+    def package_json_content
+      @package_json_content ||= project_data_bridge.file_content("package.json")
+    end
+
+    def gemfile_content
+      @gemfile_content ||= project_data_bridge.file_content("Gemfile.lock")
+    end
+
+    def ci_config_content
+      @ci_config_content ||= project_data_bridge.file_content(".circleci/config.yml")
+    end
+  end
+end

data/app/extractors/repo_analyzer/rails_best_practices_extractor.rb

@@ -0,0 +1,36 @@
+module RepoAnalyzer
+  class RailsBestPracticesExtractor < ProjectInfoExtractor
+    private
+
+    def extracted_info
+      analyzer.analyze
+      { errors: errors }
+    end
+
+    def errors
+      @errors ||= analyzer.errors.map do |error|
+        next unless error.filename.include?(project_data_bridge.project_path)
+
+        {
+          file_path: get_file_path(error),
+          message: error.message,
+          type: error.type.gsub("RailsBestPractices::", ""),
+          url: error.url
+        }
+      end.compact
+    end
+
+    def get_file_path(error)
+      [
+        error.filename.gsub(%r{\A\D*#{project_data_bridge.project_path}/}, ""),
+        error.line_number
+      ].reject(&:blank?).join(":")
+    end
+
+    def analyzer
+      @analyzer ||= RailsBestPractices::Analyzer.new(
+        project_data_bridge.project_path
+      )
+    end
+  end
+end

data/app/extractors/repo_analyzer/rubocop_extractor.rb

@@ -0,0 +1,74 @@
+module RepoAnalyzer
+  class RubocopExtractor < ProjectInfoExtractor
+    private
+
+    def extracted_info
+      { offenses: grouped_offenses_by_severit_and_cop }
+    end
+
+    def grouped_offenses_by_severit_and_cop
+      result = {}
+
+      grouped_offenses_by_severity.each do |severity, offenses|
+        result[severity] = offenses.group_by do |offense|
+          offense.delete(:severity)
+          offense.delete(:cop)
+        end
+      end
+
+      result
+    end
+
+    def grouped_offenses_by_severity
+      offenses.group_by do |offense|
+        offense[:severity]
+      end
+    end
+
+    def offenses
+      rubocop_json["files"].inject([]) do |memo, file_data|
+        file_data["offenses"].each do |offense|
+          memo << {
+            path: offense_file_name(file_data["path"], offense),
+            cop: offense["cop_name"],
+            message: get_message(offense["message"]),
+            severity: offense["severity"]
+          }
+        end
+        memo
+      end
+    end
+
+    def get_message(message)
+      parts = message.to_s.split(": ")
+      return parts.first if parts.size == 1
+
+      parts.shift
+      parts.join(": ")
+    end
+
+    def offense_file_name(file_path, offense)
+      [
+        file_path.gsub(%r{\A\D*#{project_data_bridge.project_path}/}, ""),
+        offense['location']['line'].to_s,
+        offense['location']['column'].to_s
+      ].join(':')
+    end
+
+    def rubocop_json
+      options, paths = RuboCop::Options.new.parse(
+        [
+          "--format", "json",
+          "--config", Rails.root.join(".rubocop.yml").to_s,
+          project_data_bridge.project_path
+        ]
+      )
+
+      runner = RuboCop::Runner.new(options, RuboCop::ConfigStore.new)
+      rubocop_result_content = OutputUtils.with_captured_stdout { runner.run(paths) }
+      JSON.parse(rubocop_result_content)
+    rescue RuboCop::Error
+      { "files" => [] }
+    end
+  end
+end

data/app/extractors/repo_analyzer/tests_info_extractor.rb

@@ -0,0 +1,87 @@
+module RepoAnalyzer
+  class TestsInfoExtractor < ProjectInfoExtractor
+    TESTEABLE_RAILS_RESOURCES = %i{
+      controllers
+      mailers
+      models
+      jobs
+      policies
+      commands
+      services
+      observers
+      values
+      utils
+      clients
+    }
+
+    EXCLUDED_FILES = %w{
+      previews
+      application_record
+      application_controller
+      base_controller
+      application_job
+      concern
+      application_mailer
+      application_policy
+      default_policy
+      admin_user_policy
+      comment_policy
+      page_policy
+    }
+
+    private
+
+    def extracted_info
+      {
+        swagger_tests_count: swagger_tests,
+        system_tests_count: system_tests_count,
+        jest_tests_count: jest_tests_count,
+        rails_code_coverage: rails_code_coverage.merge(total: coverage_total)
+      }
+    end
+
+    def swagger_tests
+      project_data_bridge.dir_files("spec/integration").count
+    end
+
+    def system_tests_count
+      project_data_bridge.dir_files("spec/system").count
+    end
+
+    def jest_tests_count
+      project_data_bridge.dir_files("app/javascript").count do |file|
+        file.include?("spec.js")
+      end
+    end
+
+    def rails_code_coverage
+      TESTEABLE_RAILS_RESOURCES.inject({}) do |data, resource|
+        tests_count = project_data_bridge.dir_files("spec/#{resource}").count do |file|
+          valid_file?(file)
+        end
+        files_count = project_data_bridge.dir_files("app/#{resource}").count do |file|
+          valid_file?(file)
+        end
+        data[resource] = { files_count: files_count, tests_count: tests_count }
+        coverage_total[:files_count] += files_count
+        coverage_total[:tests_count] += tests_count
+        data
+      end
+    end
+
+    def valid_file?(file)
+      EXCLUDED_FILES.each do |key|
+        return false if file.include?(key) || !file.ends_with?(".rb")
+      end
+
+      true
+    end
+
+    def coverage_total
+      @coverage_total ||= {
+        files_count: 0,
+        tests_count: 0
+      }
+    end
+  end
+end

data/app/helpers/repo_analyzer/application_helper.rb

@@ -0,0 +1,4 @@
+module RepoAnalyzer
+  module ApplicationHelper
+  end
+end

data/app/jobs/repo_analyzer/application_job.rb

@@ -0,0 +1,4 @@
+module RepoAnalyzer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/repo_analyzer/extract_project_info_job.rb

@@ -0,0 +1,35 @@
+module RepoAnalyzer
+  class ExtractProjectInfoJob < ApplicationJob
+    def perform(repo_name)
+      project_info = {}
+      bridge = RepoAnalyzer::ProjectDataBridge.new(repo_name)
+
+      for_each_extractor do |extractor|
+        extracted_data = extractor.new(bridge).extract
+        project_info.merge!(extracted_data)
+      end
+
+      project_info
+    end
+
+    private
+
+    def for_each_extractor(&block)
+      extractors_from_directory.each do |extractor|
+        next if extractor == ::RepoAnalyzer::ProjectInfoExtractor
+
+        block.call(extractor)
+      end
+    end
+
+    def extractors_from_directory
+      Dir[
+        RepoAnalyzer::Engine.root.join("app/extractors/repo_analyzer/*.rb")
+      ].map do |path|
+        file_name = path.split('/').last
+        extractor_name = file_name.split('.').first.camelize
+        Object.const_get("::RepoAnalyzer::#{extractor_name}")
+      end
+    end
+  end
+end

data/app/jobs/repo_analyzer/post_extracted_info_job.rb

@@ -0,0 +1,28 @@
+require 'zlib'
+require 'base64'
+require 'net/http'
+require 'uri'
+
+module RepoAnalyzer
+  class PostExtractedInfoJob < ApplicationJob
+    def perform(repo_name, project_info)
+      encoded_project_info = encode_project_info(project_info)
+      response = post_project_info(repo_name, encoded_project_info)
+      response.is_a?(Net::HTTPCreated)
+    end
+
+    private
+
+    def post_project_info(repo_name, encoded_project_info)
+      uri = URI(RepoAnalyzer.post_extracted_info_endpoint)
+      data = { repo_name: repo_name, project_info: encoded_project_info }.to_json
+      headers = { "Content-Type" => "application/json" }
+      Net::HTTP.post(uri, data, headers)
+    end
+
+    def encode_project_info(project_info)
+      compressed_data = Zlib::Deflate.deflate(project_info.to_json)
+      Base64.encode64(compressed_data)
+    end
+  end
+end

data/app/mailers/repo_analyzer/application_mailer.rb

@@ -0,0 +1,6 @@
+module RepoAnalyzer
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/repo_analyzer/application_record.rb

@@ -0,0 +1,5 @@
+module RepoAnalyzer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/utils/output_utils.rb

@@ -0,0 +1,10 @@
+class OutputUtils
+  def self.with_captured_stdout
+    original_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = original_stdout
+  end
+end

data/app/values/repo_analyzer/project_data_bridge.rb

@@ -0,0 +1,48 @@
+module RepoAnalyzer
+  class ProjectDataBridge
+    EXCLUDED_FILE_NAMES = %w{. .. .keep .gitkeep}
+
+    attr_reader :project_path
+
+    def initialize(repo_name, project_path = Rails.root.to_s)
+      @repo_name = repo_name
+      @project_path = project_path
+    end
+
+    def file_exist?(file_path)
+      File.exist?("#{project_path}/#{file_path}")
+    end
+
+    def file_content(file_path)
+      return unless file_exist?(file_path)
+
+      File.open("#{project_path}/#{file_path}").read
+    end
+
+    def dir_files(dir_path)
+      Dir.glob("#{project_path}/#{dir_path}/**/*").reject do |file_name|
+        EXCLUDED_FILE_NAMES.include?(file_name)
+      end
+    rescue Errno::ENOENT
+      []
+    end
+
+    def commits(options = {})
+      github_client.commits(repo_name, options)
+    end
+
+    def contributors
+      github_client.contributors(repo_name)
+    end
+
+    private
+
+    attr_reader :repo_name
+
+    def github_client
+      @github_client ||= RepoAnalyzer::GithubClient.new(
+        RepoAnalyzer.github_personal_token
+      )
+    end
+  end
+end

data/app/views/layouts/repo_analyzer/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Repo analyzer</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "repo_analyzer/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/repo_analyzer/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require "rails/engine/commands"

data/config/routes.rb

@@ -0,0 +1,2 @@
+RepoAnalyzer::Engine.routes.draw do
+end

data/lib/generators/repo_analyzer/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+
+Example:
+    rails generate repo_analyzer:install

data/lib/generators/repo_analyzer/install/install_generator.rb

@@ -0,0 +1,19 @@
+class RepoAnalyzer::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template "initializer.rb", "config/initializers/repo_analyzer.rb"
+  end
+
+  def mount_routes
+    line = "Rails.application.routes.draw do\n"
+    inject_into_file "config/routes.rb", after: line do <<-"HERE".gsub(/^ {4}/, '')
+      mount RepoAnalyzer::Engine => "/repo_analyzer"
+    HERE
+    end
+  end
+
+  def copy_engine_migrations
+    rake "railties:install:migrations"
+  end
+end

data/lib/generators/repo_analyzer/install/templates/initializer.rb

@@ -0,0 +1,2 @@
+RepoAnalyzer.setup do |config|
+end

data/lib/repo_analyzer/engine.rb

@@ -0,0 +1,15 @@
+module RepoAnalyzer
+  class Engine < ::Rails::Engine
+    isolate_namespace RepoAnalyzer
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+
+    initializer "initialize" do
+      # Require here all your engine's classes.
+      require_relative "./example_class"
+    end
+  end
+end