repo_analyzer 1.0.0

data/Gemfile.lock

@@ -0,0 +1,320 @@
+PATH
+  remote: .
+  specs:
+    repo_analyzer (1.0.0)
+      brakeman
+      octokit (~> 4.0)
+      rails (>= 6.0)
+      rails_best_practices
+      rubocop (~> 1.9)
+      rubocop-performance
+      rubocop-platanus (~> 0.2)
+      rubocop-rails
+      rubocop-rspec (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7)
+      actionpack (= 6.1.7)
+      activesupport (= 6.1.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7)
+      actionpack (= 6.1.7)
+      activejob (= 6.1.7)
+      activerecord (= 6.1.7)
+      activestorage (= 6.1.7)
+      activesupport (= 6.1.7)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7)
+      actionpack (= 6.1.7)
+      actionview (= 6.1.7)
+      activejob (= 6.1.7)
+      activesupport (= 6.1.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7)
+      actionview (= 6.1.7)
+      activesupport (= 6.1.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7)
+      actionpack (= 6.1.7)
+      activerecord (= 6.1.7)
+      activestorage (= 6.1.7)
+      activesupport (= 6.1.7)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7)
+      activesupport (= 6.1.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7)
+      activesupport (= 6.1.7)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7)
+      activesupport (= 6.1.7)
+    activerecord (6.1.7)
+      activemodel (= 6.1.7)
+      activesupport (= 6.1.7)
+    activestorage (6.1.7)
+      actionpack (= 6.1.7)
+      activejob (= 6.1.7)
+      activerecord (= 6.1.7)
+      activesupport (= 6.1.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    brakeman (5.3.1)
+    builder (3.2.4)
+    code_analyzer (0.5.5)
+      sexp_processor
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crass (1.0.6)
+    date (3.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.11.0)
+    erubis (2.7.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.2.0)
+      factory_bot (~> 6.2.0)
+      railties (>= 5.0.0)
+    faraday (2.7.1)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    mail (2.8.0)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    nenv (0.3.0)
+    net-imap (0.3.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-linux)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    public_suffix (5.0.1)
+    racc (1.6.1)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (6.1.7)
+      actioncable (= 6.1.7)
+      actionmailbox (= 6.1.7)
+      actionmailer (= 6.1.7)
+      actionpack (= 6.1.7)
+      actiontext (= 6.1.7)
+      actionview (= 6.1.7)
+      activejob (= 6.1.7)
+      activemodel (= 6.1.7)
+      activerecord (= 6.1.7)
+      activestorage (= 6.1.7)
+      activesupport (= 6.1.7)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    rails_best_practices (1.23.2)
+      activesupport
+      code_analyzer (~> 0.5.5)
+      erubis
+      i18n
+      json
+      require_all (~> 3.0)
+      ruby-progressbar
+    railties (6.1.7)
+      actionpack (= 6.1.7)
+      activesupport (= 6.1.7)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.6.1)
+    require_all (3.0.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.0.1)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.11)
+      rspec-expectations (~> 3.11)
+      rspec-mocks (~> 3.11)
+      rspec-support (~> 3.11)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-platanus (0.2.0)
+      rubocop (>= 0.89.0)
+    rubocop-rails (2.17.3)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    sexp_processor (4.16.1)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    timeout (0.3.1)
+    tins (1.31.0)
+      sync
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.4.3)
+  coveralls
+  factory_bot_rails
+  guard-rspec
+  pry
+  pry-rails
+  repo_analyzer!
+  rspec-rails
+  rspec_junit_formatter
+  rubocop (~> 1.9)
+  rubocop-rails
+  sqlite3
+
+BUNDLED WITH
+   2.4.3

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  spec_dic = "spec"
+  # RSpec files
+  watch("spec/spec_helper.rb") { spec_dic }
+  watch("spec/rails_helper.rb") { spec_dic }
+  watch(%r{^spec/support/(.+)\.rb$}) { spec_dic }
+  watch(%r{^spec/.+_spec\.rb$})
+  # Engine files
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2023 Platanus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+# Repo Analyzer
+
+[![Gem Version](https://badge.fury.io/rb/repo_analyzer.svg)](https://badge.fury.io/rb/repo_analyzer)
+[![CircleCI](https://circleci.com/gh/platanus/repo_analyzer.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/repo_analyzer)
+
+Rails engine to extract useful information about the project.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "repo_analyzer"
+```
+
+```bash
+bundle install
+```
+
+Run the installer:
+
+```bash
+rails generate repo_analyzer:install
+```
+
+Then, configure ENV vars:
+
+- `GITHUB_PERSONAL_TOKEN`: to extract commits info.
+- `REPO_ANALYZER_URL`: POST endpoint where you want to process extracted info.
+
+## Usage
+
+In order to extract the information you can execute:
+
+```ruby
+RepoAnalyzer::ExtractProjectInfoJob.perform_now("github-repo-name")
+```
+
+Example:
+
+```ruby
+project_info = RepoAnalyzer::ExtractProjectInfoJob.perform_now("platanus/example-project")
+```
+
+You will get something like this:
+
+```ruby
+{
+  circleci_extractor: {
+    "platanus_compose" => false,
+    "jest" => true,
+    "rspec" => true,
+    "system_tests" => true,
+    "code_coverage" => true,
+    "rubocop" => true,
+    "eslint" => true,
+    "stylelint" => true
+  },
+  github_extractor: {
+    "last_commit_date" => "2023-01-25",
+    "last_contributors" => [
+      {
+        "login" => "flouMicaza",
+        "avatar_url" => "https://avatars.githubusercontent.com/u/24324363?v=4",
+        "contributions" => 316
+      },
+      {
+        "login" => "ankaph",
+        "avatar_url" => "https://avatars.githubusercontent.com/u/1688697?v=4",
+        "contributions" => 207
+      }
+    ],
+    "contributors" => [
+      {
+        "login" => "flouMicaza",
+        "avatar_url" => "https://avatars.githubusercontent.com/u/24324363?v=4",
+        "contributions" => 316
+      },
+      {
+        "login" => "ankaph",
+        "avatar_url" => "https://avatars.githubusercontent.com/u/1688697?v=4",
+        "contributions" => 207
+      }
+    ]
+  },
+  power_types_extractor: {
+    "commands" => false,
+    "services" => false,
+    "observers" => true,
+    "values" => false,
+    "utils" => true,
+    "clients" => true
+  },
+  # ...
+}
+```
+
+Each key (`circleci_extractor`, `github_extractor`, `power_types_extractor`, etc) contains useful information about the project that you can use whatever you want.
+Extractors live here: https://github.com/platanus/repo_analyzer/tree/master/app/extractors/repo_analyzer
+
+Then, the extracted information can be posted to some endpoint defined on this ENV var `REPO_ANALYZER_URL` executing:
+
+```ruby
+RepoAnalyzer::PostExtractedInfoJob.perform_now("platanus/example-project", project_info)
+```
+
+### Script
+
+You can extract and POST the info using the following rake task:
+
+```bash
+bin/rake "repo_analyzer:analyze[github-repo-name]"
+```
+
+Example:
+
+```bash
+`bin/rake "repo_analyzer:analyze[platanus/example-project]"`
+```
+
+## Development
+
+You can add a new extractor here: https://github.com/platanus/repo_analyzer/tree/master/app/extractors/repo_analyzer
+This one must implement methods defined on this base class: https://github.com/platanus/repo_analyzer/blob/master/app/extractors/repo_analyzer/project_info_extractor.rb#L14
+
+## Testing
+
+To run the specs you need to execute, in the root path of the engine, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/repo_analyzer/spec` directory.
+
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/repo_analyzer/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Run `bundle install`.
+4. Commit new release. For example: `Releasing v0.1.0`.
+5. Create tag. For example: `git tag v0.1.0`.
+6. Push tag. For example: `git push origin v0.1.0`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/repo_analyzer/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Repo Analyzer is maintained by [platanus](http://platan.us).
+
+## License
+
+Repo Analyzer is © 2023 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks

data/app/assets/config/repo_analyzer_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/repo_analyzer .css

data/app/assets/stylesheets/repo_analyzer/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/clients/repo_analyzer/github_client.rb

@@ -0,0 +1,31 @@
+module RepoAnalyzer
+  class GithubClient
+    def initialize(personal_token)
+      @personal_token = personal_token
+    end
+
+    def contributors(repo_name)
+      client.contributors(repo_name, true)
+    end
+
+    def commits(repo_name, from_date: nil, to_date: nil)
+      from_date ||= Date.current - 2.years
+      to_date ||= Date.tomorrow
+      client.commits_between(repo_name, from_date.to_s, to_date.to_s)
+    end
+
+    def file_content(repo_name, file_path)
+      Base64.decode64(client.content(repo_name, path: file_path)[:content])
+    rescue Octokit::NotFound
+      ""
+    end
+
+    private
+
+    attr_reader :personal_token
+
+    def client
+      @client ||= Octokit::Client.new(access_token: personal_token, per_page: 10000)
+    end
+  end
+end

data/app/controllers/repo_analyzer/application_controller.rb

@@ -0,0 +1,4 @@
+module RepoAnalyzer
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/extractors/repo_analyzer/brakeman_extractor.rb

@@ -0,0 +1,33 @@
+module RepoAnalyzer
+  class BrakemanExtractor < ProjectInfoExtractor
+    CONFIDENCE = {
+      0 => "High",
+      1 => "Medium",
+      2 => "Weak"
+    }
+
+    private
+
+    def extracted_info
+      { warnings: brakeman_info }
+    end
+
+    def brakeman_info
+      @brakeman_info ||= begin
+        tracker = Brakeman.run(app_path: project_data_bridge.project_path)
+        tracker.checks.warnings.map do |warning|
+          {
+            warning_type: warning.warning_type,
+            check: warning.check,
+            message: warning.message.to_s,
+            file_path: warning.file.relative,
+            link: warning.link,
+            line: warning.line,
+            confidence: CONFIDENCE[warning.confidence],
+            code: warning.format_code
+          }
+        end
+      end
+    end
+  end
+end

data/app/extractors/repo_analyzer/circleci_extractor.rb

@@ -0,0 +1,46 @@
+module RepoAnalyzer
+  class CircleciExtractor < ProjectInfoExtractor
+    COVERAGE_REGEXP = /(coverage)/
+    RUBOCOP_REGEXP = /(rubocop)/
+    ESLINT_REGEXP = /(eslint)/
+    STYLELINT_REGEXP = /(stylelint)/
+    JEST_REGEXP = /(yarn\srun\stest)/
+    JEST_REGEXP_ALT = /(cibuild\sjs_tests)/
+    RSPEC_REGEXP = /(rspec\.xml)/
+    RSPEC_REGEXP_ALT = /(cibuild\stests)/
+    SYSTEM_REGEXP = /(rspec-system\.xml)/
+    PLATANUS_COMPOSE_REGEXP = %r{(platanus/compose)}
+
+    private
+
+    def extracted_info
+      {
+        platanus_compose: content_by_regexp?(PLATANUS_COMPOSE_REGEXP),
+        jest: content_by_regexp?(JEST_REGEXP, JEST_REGEXP_ALT),
+        rspec: content_by_regexp?(RSPEC_REGEXP, RSPEC_REGEXP_ALT),
+        system_tests: content_by_regexp?(SYSTEM_REGEXP),
+        code_coverage: content_by_regexp?(COVERAGE_REGEXP),
+        rubocop: content_by_regexp?(RUBOCOP_REGEXP),
+        eslint: content_by_regexp?(ESLINT_REGEXP),
+        stylelint: content_by_regexp?(STYLELINT_REGEXP)
+      }
+    end
+
+    def content_by_regexp?(*regexps)
+      !!content_by_regexp(regexps)
+    end
+
+    def content_by_regexp(regexps)
+      regexps.each do |regexp|
+        is_valid = config_content&.match(regexp)&.captures&.first
+        return true if is_valid
+      end
+
+      false
+    end
+
+    def config_content
+      @config_content ||= project_data_bridge.file_content(".circleci/config.yml")
+    end
+  end
+end