repo_analyzer 1.0.0

data/lib/repo_analyzer/example_class.rb

@@ -0,0 +1,7 @@
+module RepoAnalyzer
+  class ExampleClass
+    def self.say_hi
+      "Hello Platanus developer!"
+    end
+  end
+end

data/lib/repo_analyzer/version.rb

@@ -0,0 +1,3 @@
+module RepoAnalyzer
+  VERSION = '1.0.0'
+end

data/lib/repo_analyzer.rb

@@ -0,0 +1,48 @@
+require "brakeman"
+require "octokit"
+require "rails_best_practices"
+require "rubocop"
+require "rubocop-performance"
+require "rubocop-platanus"
+require "rubocop-rails"
+require "rubocop-rspec"
+
+require "repo_analyzer/engine"
+
+module RepoAnalyzer
+  extend self
+
+  # You can add, in this module, your own configuration options as in the example below...
+  #
+  # attr_writer :my_option
+  #
+  # def my_option
+  #   return "Default Value" unless @my_option
+  #   @my_option
+  # end
+  #
+  # Then, you can customize the default behaviour (typically in a Rails initializer) like this:
+  #
+  # RepoAnalyzer.setup do |config|
+  #   config.root_url = "Another value"
+  # end
+
+  attr_writer :github_personal_token, :post_extracted_info_endpoint
+
+  def github_personal_token
+    return ENV["GITHUB_PERSONAL_TOKEN"] if @github_personal_token.blank?
+
+    @github_personal_token
+  end
+
+  def post_extracted_info_endpoint
+    return ENV["REPO_ANALYZER_URL"] if @post_extracted_info_endpoint.blank?
+
+    @post_extracted_info_endpoint
+  end
+
+  def setup
+    yield self
+    require "repo_analyzer"
+  end
+end

data/lib/tasks/repo_analyzer_tasks.rake

@@ -0,0 +1,7 @@
+namespace :repo_analyzer  do
+  desc "Extract repo info and post to defined endpoint"
+  task :analyze, [:repo_name] => :environment do |_t, args|
+    project_info = RepoAnalyzer::ExtractProjectInfoJob.perform_now(args.repo_name)
+    RepoAnalyzer::PostExtractedInfoJob.perform_now(args.repo_name, project_info)
+  end
+end

data/repo_analyzer.gemspec

@@ -0,0 +1,42 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem"s version:
+require "repo_analyzer/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "repo_analyzer"
+  s.version       = RepoAnalyzer::VERSION
+  s.authors       = ["Platanus", "Leandro Segovia"]
+  s.email         = ["rubygems@platan.us", "leandro@platan.us"]
+  s.homepage      = "https://github.com/platanus/repo_analyzer"
+  s.summary       = "Tool to extract technical debt"
+  s.description   = "Rails engine to extract technical debt"
+  s.license       = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "brakeman"
+  s.add_dependency "octokit", "~> 4.0"
+  s.add_dependency "rails", ">= 6.0"
+  s.add_dependency "rails_best_practices"
+  s.add_dependency "rubocop", "~> 1.9"
+  s.add_dependency "rubocop-performance"
+  s.add_dependency "rubocop-platanus", "~> 0.2"
+  s.add_dependency "rubocop-rails"
+  s.add_dependency "rubocop-rspec", "~> 2.2"
+
+  s.add_development_dependency "bundler", "~> 2.4.3"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "factory_bot_rails"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "rspec_junit_formatter"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rubocop", "~> 1.9"
+  s.add_development_dependency "rubocop-rails"
+end

data/spec/assets/test_project/README.md

@@ -0,0 +1 @@
+# Hola!

data/spec/assets/test_project/old_circleci_config.yml

@@ -0,0 +1,21 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/app
+
+    docker:
+    - image: platanus/compose:1.22.0
+
+    steps:
+    - checkout
+    - setup_remote_docker
+
+    - run: docker info
+    - run: docker-compose -f docker-compose.ci.yml pull
+    - run: docker-compose -f docker-compose.ci.yml build test
+    - run: bin/cibuild services
+    - run: bin/cibuild deps
+
+    - run: bin/cibuild db
+    - run: bin/cibuild tests
+    - run: bin/cibuild js_tests

data/spec/assets/test_project/valid_circleci_config.yml

@@ -0,0 +1,152 @@
+version: 2.1
+
+ruby-image: &ruby-image cimg/ruby:2.7
+postgres-image: &postgres-image postgres:11.3
+env-vars: &env-vars
+  BUNDLE_JOBS: 4
+  BUNDLE_PATH: vendor/bundle
+  RAILS_ENV: test
+orbs:
+  browser-tools: circleci/browser-tools@1.1
+
+executors:
+  test-executor:
+    docker:
+      - image: *ruby-image
+        environment: *env-vars
+      - image: *postgres-image
+
+  lint-executor:
+    docker:
+      - image: *ruby-image
+        environment: *env-vars
+
+commands:
+  setup:
+    description: checkout code, restore cache, install dependencies, save cache
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - bundle-dependencies-{{ checksum "Gemfile.lock" }}
+          - bundle-dependencies-
+
+      - restore_cache:
+          keys:
+          - yarn-dependencies-{{ checksum "yarn.lock" }}
+          - yarn-dependencies-
+
+      - run:
+          name: Install reviewdog
+          command: |
+            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+
+      - run:
+          name: Install bundle dependencies
+          command: |
+            BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")
+            gem install bundler:$BUNDLER_VERSION
+            bundle _$(echo $BUNDLER_VERSION)_ install
+
+      - run: sudo apt-get update && sudo apt-get install ca-certificates
+
+      - run:
+          name: Install yarn dependencies
+          command: |
+            curl -sL https://deb.nodesource.com/setup_$(cat .node-version).x | sudo -E bash -
+            sudo apt-get install -y nodejs
+            curl -o- -sL https://yarnpkg.com/install.sh | bash
+            sudo ln -s $HOME/.yarn/bin/yarn /usr/local/bin/yarn
+            yarn install --frozen-lockfile
+
+      - save_cache:
+          key: bundle-dependencies-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - save_cache:
+          key: yarn-dependencies-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+
+jobs:
+  test:
+    executor: test-executor
+    steps:
+      - setup
+      - browser-tools/install-chrome
+      - browser-tools/install-chromedriver
+
+      - run:
+          name: Wait for postgres service
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+
+      - run:
+          name: Setup database
+          command: bundle exec rails db:create db:schema:load
+
+      - run:
+          name: Run RSpec unit tests
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec.xml"
+            RSPEC_FORMAT_ARGS="-f progress --no-color -p 10"
+            bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+
+      - run:
+          name: Run simplecov
+          shell: /bin/bash
+          command: |
+            cat coverage/coverage.txt | ./bin/reviewdog -reporter=github-pr-review -efm="%f:%l:%c: %m"
+
+      - run:
+          name: Run RSpec system tests
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec-system.xml"
+            RSPEC_FORMAT_ARGS="--tag type:system -f progress --no-color -p 10"
+            bundle exec rspec spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+
+      - run:
+          name: Run jest
+          command: yarn run test
+
+      - store_test_results:
+          path: test_results
+
+  lint:
+    executor: lint-executor
+    steps:
+      - setup
+
+      - run:
+          name: Get files to lint
+          command: git diff origin/master --name-only --diff-filter=d > tmp/files_to_lint
+
+      - run:
+          name: Run rubocop
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(rb)$' | xargs bundle exec rubocop --force-exclusion \
+            | ./bin/reviewdog -reporter=github-pr-review -f=rubocop
+
+      - run:
+          name: Run eslint
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(js|jsx|vue)$' | xargs yarn run eslint \
+            | ./bin/reviewdog -reporter=github-pr-review -f=eslint
+
+      - run:
+          name: Run stylelint
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(scss|css|less)$' | xargs yarn run stylelint \
+            | ./bin/reviewdog -reporter=github-pr-review -f=stylelint
+
+workflows:
+  test_and_lint:
+    jobs:
+      - test:
+          context: org-global
+      - lint:
+          context: org-global

data/spec/assets/test_project/valid_gem_gemfile_lock

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in human_attributes.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]