repo-compare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 773b51d17d77a75045e4ef688366a80c4c00dc5de265792789c50c1797cf446d
+  data.tar.gz: 54fdb63bf82c42bf11aefa6cb3bd7565d8184a6744bd59efdbb8fed718117a55
+SHA512:
+  metadata.gz: be45085c8b9118870b9493633ecbed8d536b17296225ed8c258b40e33cc0161c5aab23a22d63284f749497187f4852e37a27634e82ef4e1a2ff97954dc0e80cb
+  data.tar.gz: 3a1c720c912fdf315bc8492d9ac329004ca88cc984967b1ddb04f72e046820dc52b9dc80347036750601ae32701b08608b045708db4f7928daeb4f7845332763

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Mattia Roccoberton
+
+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,57 @@
+# Repo Compare
+
+Track changes of another repository.
+
+Features:
+- check multiple paths of a repo;
+- create a summary of the changes using git compare (`-s` option);
+- create a detailed list of diffs;
+- ignore some changes to a specific file, saving hashes locally (`-u` option).
+
+It can be useful keep track of the changes of a master repo from a forked project, eventually preparing a check in the CI.
+
+**IMPORTANT**: the tool will add the other repository as remote source.
+
+## Installation
+
+- Add to your Gemfile: `gem 'repo-compare', require: false` (and execute `bundle`)
+- Create a config file in the root of your project (`.repo-compare.yml`):
+
+```yml
+---
+source_name: REPO_NAME
+source_branch: master
+source_base_path: OPTIONAL_INTERNAL_PATH
+source_repo: https://github.com/ACCOUNT_NAME/REPO_NAME.git
+paths:
+  - PATH1
+  - PATH2
+  - PATH3
+  - ...
+```
+
+- Execute the binary: `bundle exec repo-compare`
+
+Alternative option, install it at system level: `gem install repo-compare`
+
+## Usage
+
+The tool accepts some command line option:
+
+- `-h` or `--help`    : show this help
+- `-s` or `--summary` : generate an XML summary of the files changed (useful for CI)
+- `-u` or `--update`  : update the config file setting the current hashes to ignore
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
+
+## Contributors
+
+- [Mattia Roccoberton](https://blocknot.es/): author
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    # t.ruby_opts = %w[-w]
+    t.rspec_opts = ['--color', '--format documentation']
+  end
+
+  task default: :spec
+rescue LoadError
+  puts '! LoadError: no RSpec available'
+end

data/bin/repo-compare

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'repo-compare/config'
+require 'repo-compare/git_remote_update'
+require 'repo-compare/git_diff'
+require 'repo-compare/git_diff_raw'
+require 'repo-compare/summary'
+
+# Check the arguments
+action = nil
+ARGV.each do |arg|
+  case arg
+  when '-h', '--help'
+    puts <<~HELP
+      Repo Compare: a tool to detect changes between 2 repositories
+
+      Options:
+        -h or --help    : show this help
+        -s or --summary : generate an XML summary of the files changed (useful for CI)
+        -u or --update  : update the config file setting the current hashes to ignore
+    HELP
+    exit 0
+  when '-s', '--summary'
+    action = :summary
+  when '-u', '--update'
+    action = :update
+  end
+end
+
+# Load the config options
+config = RepoCompare::Config.new
+config_hash = config.to_h
+
+# Update the remote source
+RepoCompare::GitRemoteUpdate.new(config_hash).call
+
+# Compare paths
+results = config_hash['paths'].map do |path|
+  RepoCompare::GitDiffRaw.new(config_hash, path).call.merge(src: path)
+end
+
+if action == :summary
+  # Prepare a summary
+  puts RepoCompare::Summary.new(results).to_xml
+else
+  # Prepare a detailed diff
+  results.each do |res|
+    diff = RepoCompare::GitDiff.new(config_hash, res).call
+    puts diff unless diff.empty?
+  end
+end
+
+# Update the config
+config.update(results) if action == :update

data/lib/repo-compare/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RepoCompare
+  # Load configuration
+  class Config
+    CONFIG_PATH = '.repo-compare.yml'
+
+    def initialize
+      @config = File.exist?(CONFIG_PATH) ? YAML.load_file(CONFIG_PATH) : {}
+      @config['paths'] ||= []
+      @config['ignore'] ||= {}
+      @config['source_branch'] ||= 'master'
+    end
+
+    def to_h
+      @config.to_h
+    end
+
+    def update(results)
+      results.each do |result|
+        @config['ignore'][result[:src]] ||= {}
+        update_conf_path(@config['ignore'][result[:src]], result[:results])
+      end
+      File.open(CONFIG_PATH, 'w') { |f| f.puts(@config.to_yaml) }
+    end
+
+    private
+
+    def update_conf_path(conf, results)
+      results.each do |path, hash|
+        # require 'pry'; binding.pry
+        if conf[path]
+          # TODO: update...
+        else
+          conf[path] = hash
+        end
+      end
+    end
+  end
+end

data/lib/repo-compare/git_diff.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RepoCompare
+  # Compare 2 repos
+  class GitDiff
+    def initialize(config, result)
+      @config = config
+      @result = result
+    end
+
+    def call
+      @result[:results].map do |paths, _hash|
+        diff(paths)
+      end.join("\n")
+    end
+
+    private
+
+    def diff(paths)
+      src, dst = paths.split("\t")
+      dst ||= src
+      `git diff 'remotes/#{@config['source_name']}/#{@config['source_branch']}' -- '#{src}' '#{dst}'`
+    end
+  end
+end

data/lib/repo-compare/git_diff_raw.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RepoCompare
+  # Compare 2 repos
+  class GitDiffRaw
+    DIFF_OPTIONS = '--cc --raw'
+    EXP = /:\w+ \w+ (?<src>\w+) (?<dst>\w+) (?<status>\w+)\t(?<path>.+)/.freeze
+
+    def initialize(config, path)
+      @config = config
+      @context = { output: [] }
+      @path = path
+    end
+
+    def call
+      compare_repos
+      filter_changes
+      extract_results
+      @context.merge!(success?: true)
+    end
+
+    private
+
+    def compare_repos
+      cmd =  "git diff #{DIFF_OPTIONS} 'remotes/#{@config['source_name']}/#{@config['source_branch']}' -- "
+      cmd += "'#{@config['source_base_path']}/#{@path}' '#{@path}'"
+      @context[:output] = `#{cmd}`.scan(EXP)
+      @context
+    end
+
+    def extract_results
+      @context[:output].sort_by! { |item| item[3] }
+      @context[:results] = {}
+      @context[:output].each_with_object(@context[:results]) do |item, ret|
+        ret[item[3]] = item[0]
+      end
+      @context
+    end
+
+    def filter_changes
+      ignore = @config['ignore'][@path] || []
+      @context[:output].reject! { |line| line[0] == line[1] || ignore_changes?(ignore, line) }
+      @context
+    end
+
+    def ignore_changes?(ignore, line)
+      path = line[3]
+      ignore[path] == '-' || ignore[path] == line[0]
+    end
+  end
+end

data/lib/repo-compare/git_remote_update.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RepoCompare
+  # Update the remote source
+  class GitRemoteUpdate
+    def initialize(config)
+      @config = config
+    end
+
+    def call
+      if `git remote`.split("\n").none? @config['source_name']
+        `git remote add -f #{@config['source_name']} #{@config['source_repo']}`
+        puts('error with git remote add') & exit if $?.exitstatus != 0
+      end
+
+      `git remote update > /dev/null 2>&1`
+      puts('error with git remote update') & exit if $?.exitstatus != 0
+    end
+  end
+end

data/lib/repo-compare/summary.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module RepoCompare
+  # Create a diff summary
+  class Summary
+    def initialize(results)
+      @count = 0
+      @results = results || []
+    end
+
+    def to_xml
+      <<~SUMMARY
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="solidus_compare" tests="#{@count}" skipped="0" failures="#{@count}" errors="#{@count}" time="1" timestamp="#{DateTime.now.iso8601}">
+#{testcases}</testsuite>
+      SUMMARY
+    end
+
+    private
+
+    def testcases
+      @results.map do |result|
+        result[:results].map do |paths, hash|
+          @count += 1
+          # result[:src]
+          name = paths.gsub(/\t/, ' - ')
+          file = paths.split("\t")[-1]
+          "<testcase name=\"#{name}\" file=\"#{file}\" time=\"0\"><failure>hash: #{hash}\nfile: #{paths}</failure></testcase>"
+        end.join("\n")
+      end.join("\n")
+    end
+  end
+end

data/lib/repo-compare/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RepoCompare
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: repo-compare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-06 00:00:00.000000000 Z
+dependencies: []
+description: Track changes of another repo.
+email:
+- mat@blocknot.es
+executables:
+- repo-compare
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/repo-compare
+- lib/repo-compare/config.rb
+- lib/repo-compare/git_diff.rb
+- lib/repo-compare/git_diff_raw.rb
+- lib/repo-compare/git_remote_update.rb
+- lib/repo-compare/summary.rb
+- lib/repo-compare/version.rb
+homepage: https://github.com/blocknotes/repo-compare
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Repo Compare
+test_files: []