calcifer 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c1bdeaf9f49017bb6f2aff22d00c18f7bb68557214065f9ace1eba6c5d2751
-  data.tar.gz: 0f7feb93dfceeb89a75c507111e283d846f71e1c025e520333511a320b1c33b0
+  metadata.gz: c7d116a75730c531b8425c3358f6988fd46c3cf480fa73e6fea53a783ae9db4e
+  data.tar.gz: bcd079c57f89dcdedac1c6d3f43d656a09dff5b14a058b6655a218c76ab6a97e
 SHA512:
-  metadata.gz: a7f917e7934082a97c5b230dd6b41003cfcd7da2f8e13657dd705bf868497f538c28b27073af41c8fb05cb274d49c60ad669ff3a95e6d5615423fc861ee5ec20
-  data.tar.gz: a81969f58b5f626d64119bff0f938d11e7d2c1a98d1d759991f54c3b60af205dd63f75013ab9791f7fa49c476ccc194d3e57920924a81ac941d1a8016ae564ef
+  metadata.gz: e12138c209b2a7a49aced35daa7c9f181d0b7668a6066a3a565135480781ff1c12ffe6157d35201f0e9892f97fbe9bc4c756ab41a88a0cfaf992578c6fbe67a6
+  data.tar.gz: 6f2b9e7ca8fe6392804f9a641559ce4df4998734f81bf3b8cd227172860a4486dd222e2d8f6dea67d85cd3d518b49d72e7323db351927e084193efd4b16cf46a

data/.github/workflows/main.yml

@@ -0,0 +1,41 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby and install gems
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Build env
+        run: |
+          sudo apt-get -yqq install libpq-dev
+          gem install bundler:1.17.0
+          bundle install
+      
+      - name: Run Rspec
+        run: bundle exec rspec
+      - name: Run Rubocop
+        run: bundle exec rubocop
+
+
+

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - calcifer.gemspec
+    - spec/fixtures/**
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in calcifer.gemspec
 gemspec

data/Gemfile.lock

@@ -1,13 +1,26 @@
 PATH
   remote: .
   specs:
-    calcifer (0.1.1)
+    calcifer (0.4.0)
+      rgl (~> 0.5.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     diff-lcs (1.5.0)
+    generator (0.0.1)
+    lazy_priority_queue (0.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (10.5.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rgl (0.5.7)
+      lazy_priority_queue (~> 0.1.0)
+      stream (~> 0.5.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -21,6 +34,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    stream (0.5.3)
+      generator
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -30,6 +58,7 @@ DEPENDENCIES
   calcifer!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 1.25)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,4 +1,6 @@
 # Calcifer
+
+Calcifer helps you find test files that are directly related to the files you changed.
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,8 +19,14 @@ Or install it yourself as:
 
 ## Usage
 
-`bundle exec calcifer | xargs bundle exec rspec`
+To search for related files using uncommitted changes, just do the following
+
+    $ bundle exec calcifer | xargs bundle exec rspec
+
+To search for related files using the other branch changes as a reference, just do the following
+
 
+    $ bundle exec calcifer -b 'branch_name' | xargs bundle exec rspec
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/GustavoDuarteM/calcifer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/calcifer.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/GustavoDuarteM/calcifer"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.6.4'
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
@@ -37,7 +39,10 @@ Gem::Specification.new do |spec|
   spec.executables     = ['calcifer']
   spec.require_paths   = ["lib"]
 
+  spec.add_dependency 'rgl', "~>0.5.7"
+
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.25"
 end

data/lib/calcifer/builders/root_file_builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Buiders
+    class RootFileBuilder
+      def initialize(file)
+        @file = file
+      end
+
+      def build
+        return unless @file
+
+        module_name = Calcifer::Finders::ModuleNameFinder.new(@file).execute
+        Calcifer::Graph::RootFile.new(module_name, @file) if module_name
+      end
+    end
+  end
+end

data/lib/calcifer/factories/list_file_factory.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Factories
+    class ListFileFactory
+      PARAM_BRANCH = ['-b', '-branch'].freeze
+
+      def initialize(params)
+        @params = params
+      end
+
+      def fabricate
+        extract_parameters
+
+        return Calcifer::Finders::FilesDiffFinder.new if @branch.nil?
+
+        Calcifer::Finders::FilesBranchDiffFinder.new(@branch)
+      end
+
+      private
+
+      def extract_parameters
+        params_list.each do |param|
+          param_branch(param)
+        end
+      end
+
+      def params_list
+        @params_list = []
+        (0..@params.length - 1).step(2) do |num|
+          range = 2 + num
+          @params_list << @params[num..range]
+        end
+
+        @params_list
+      end
+
+      def param_branch(array_param)
+        param, value = array_param
+
+        return unless PARAM_BRANCH.include?(param)
+
+        @branch = value
+      end
+    end
+  end
+end

data/lib/calcifer/finders/file_related_finder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Finders
+    class FileRelatedFinder
+      attr_reader :related_spec_files
+
+      def initialize(module_name)
+        @module_name = module_name
+      end
+
+      def execute
+        related_files_path.split
+      end
+
+      private
+
+      def related_files_path
+        `grep -Rlw '#{@module_names}' ./app`
+      end
+    end
+  end
+end

data/lib/calcifer/finders/files_branch_diff_finder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Finders
+    class FilesBranchDiffFinder
+      def initialize(branch)
+        @branch = branch
+      end
+
+      def execute
+        @file_list = git_files.split.map(&lambda { |file_path|
+          file = File.open(file_path)
+          file if file.size.positive? && File.extname(file.path) == '.rb'
+        }).compact
+      end
+
+      def git_files
+        `git diff --name-only #{@branch}...`
+      end
+    end
+  end
+end

data/lib/calcifer/finders/module_name_finder.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Finders
+    class ModuleNameFinder
+      MODULE_REGEX = /^(module)\s\w+/.freeze
+      CLASS_REGEX = /^(class)\s\w+/.freeze
+      ONE_LINE_CLASS_REGEX = /^(class)\s\w+\s<\s\w+;\s(end)/.freeze
+      attr_reader :modules
+
+      def initialize(file)
+        @file = file
+        @module_name = []
+      end
+
+      def execute
+        return unless @file
+
+        @file.readlines.each do |line|
+          next if one_line_class_definition?(line)
+
+          if module_definition?(line)
+            @module_name << line.gsub('module', '').strip
+          elsif class_definition?(line)
+            @module_name << line.gsub('class', '').gsub(/<(.*)/, '').strip
+            break
+          end
+        end
+
+        mount_module_name
+      end
+
+      private
+
+      def one_line_class_definition?(line)
+        line.strip.match(ONE_LINE_CLASS_REGEX)&.length&.positive?
+      end
+
+      def module_definition?(line)
+        line.strip.match(MODULE_REGEX)&.length&.positive?
+      end
+
+      def class_definition?(line)
+        line.strip.match(CLASS_REGEX)&.length&.positive?
+      end
+
+      def mount_module_name
+        return unless @module_name.length.positive?
+
+        @module_name.join('::')
+      end
+    end
+  end
+end

data/lib/calcifer/finders/spec_files_related_finder.rb

@@ -5,25 +5,19 @@ module Calcifer
     class SpecFilesRelatedFinder
       attr_reader :related_spec_files
 
-      def initialize(modules)
-        @modules = modules
+      def initialize(related_files_path)
+        @related_files_path = related_files_path
       end
 
       def execute
         @related_spec_files = specs_to_related_files.join(' ').strip
       end
 
-      private
-
-      def related_files_path
-        module_names = @modules.join('\\|')
-        `grep -Rlw '#{module_names}' ./app`
-      end
-
       def specs_to_related_files
-        related_files_path.split.map(&lambda { |file_path|
-          file_path.gsub('./app', './spec').gsub('.rb', '_spec.rb')
-        }).select { |file_path_spec| File.file?(file_path_spec) }
+        @related_files_path.map(&lambda { |file_path|
+          spec_file_path = file_path.gsub('./app', './spec').gsub('.rb', '_spec.rb')
+          File.file?(spec_file_path) ? spec_file_path : nil
+        }).compact
       end
     end
   end

data/lib/calcifer/graph/graph_list_file.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Graph
+    class GraphListFile
+      def initialize(file_list)
+        @file_list = file_list
+      end
+
+      def execute
+        graph_list_file = @file_list.map(&->(file) { Calcifer::Buiders::RootFileBuilder.new(file).build }).compact
+
+        graph_list_file.each do |graph|
+          related_files = Calcifer::Finders::FileRelatedFinder.new(graph.module_name).execute
+          graph_vertices = related_files.map { |related_file| [graph.file_path, related_file] }
+          graph.graph_root.add_edges(*graph_vertices)
+        end
+
+        graph_list_file
+      end
+
+      def file_list
+        Calcifer::Finders::FilesDiffFinder.new.execute
+      end
+    end
+  end
+end

data/lib/calcifer/graph/root_file.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Calcifer
+  module Graph
+    class RootFile
+      attr :graph_root, :module_name, :file_path
+
+      def initialize(module_name, file)
+        @module_name = module_name
+        @file = file
+        @file_path = file.path
+        build_graph_root
+      end
+
+      def add_related_file_path(file_path)
+        @graph_root.add_edge(@file.path, file_path)
+      end
+
+      def related_files_paths
+        @graph_root.vertices - [@file.path]
+      end
+
+      private
+
+      def build_graph_root
+        @graph_root = RGL::DirectedAdjacencyGraph.new
+        @graph_root.add_vertex(@file.path)
+      end
+    end
+  end
+end

data/lib/calcifer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Calcifer
-  VERSION = "0.1.1"
+  VERSION = '0.4.0'
 end

data/lib/calcifer.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require 'calcifer/version'
-require 'calcifer/finders/modules_finder'
-require 'calcifer/finders/files_diff_finder'
-require 'calcifer/finders/spec_files_related_finder'
+Dir["#{File.dirname(__FILE__)}/calcifer/**/*.rb"].sort.each { |file| require file }
+require 'rgl/adjacency'
 
 module Calcifer
   class Error < StandardError; end
+  class << self
+    def execute
+      file_list_finder = Calcifer::Factories::ListFileFactory.new(ARGV).fabricate
+      file_list = file_list_finder.execute
+      graph_list_file = Calcifer::Graph::GraphListFile.new(file_list).execute
+      spec_files_path = graph_list_file.map(&:related_files_paths).flatten
+      spec_files_path_list = Calcifer::Finders::SpecFilesRelatedFinder.new(spec_files_path).execute
 
-  def self.execute
-    file_list = Calcifer::Finders::FilesDiffFinder.new.execute
-    module_list = Calcifer::Finders::ModulesFinder.new(file_list).execute
-    spec_files_path_list = Calcifer::Finders::SpecFilesRelatedFinder.new(module_list).execute
-
-    printf %x[echo #{spec_files_path_list}]
+      printf `echo #{spec_files_path_list}`
+    end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: calcifer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Gustavo Duarte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
 description: 
 email:
 - gustavo_dmuniz@yahoo.com.br
@@ -60,8 +88,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -74,9 +104,15 @@ files:
 - bin/setup
 - calcifer.gemspec
 - lib/calcifer.rb
+- lib/calcifer/builders/root_file_builder.rb
+- lib/calcifer/factories/list_file_factory.rb
+- lib/calcifer/finders/file_related_finder.rb
+- lib/calcifer/finders/files_branch_diff_finder.rb
 - lib/calcifer/finders/files_diff_finder.rb
-- lib/calcifer/finders/modules_finder.rb
+- lib/calcifer/finders/module_name_finder.rb
 - lib/calcifer/finders/spec_files_related_finder.rb
+- lib/calcifer/graph/graph_list_file.rb
+- lib/calcifer/graph/root_file.rb
 - lib/calcifer/version.rb
 homepage: https://github.com/GustavoDuarteM/calcifer
 licenses:
@@ -92,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: This gem helps to find class test files related to pending changes in git.

data/lib/calcifer/finders/modules_finder.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Calcifer
-  module Finders
-    class ModulesFinder
-      MODULE_REGEX = /^(module)\s\w+/.freeze
-      CLASS_REGEX = /^(class)\s\w+/.freeze
-      attr_reader :modules
-
-      def initialize(file_list)
-        @file_list = file_list
-        @modules = []
-      end
-
-      def execute
-        @file_list.each do |file|
-          module_name = build_module_name(file)
-          @modules << module_name if module_name.length.positive?
-        end
-        @modules
-      end
-
-      private
-
-      def build_module_name(file)
-        # TODO add clause to one line defnition as "class Error < StandardError; end"
-        module_name = ''
-        file.readlines.each do |line|
-          if line.strip.match(MODULE_REGEX)&.length&.positive?
-            module_name += "#{line.gsub('module', '').strip}::"
-          elsif line.strip.match(CLASS_REGEX)&.length&.positive?
-            module_name += line.gsub('class', '').gsub(/<(.*)/, '').strip
-            break
-          end
-        end
-        module_name
-      end
-    end
-  end
-end