git_diff_lcs 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b6be903d8a4f4a01f76b6bb78e2760951c57bbf1ae01c1f08025be9a3fe466
-  data.tar.gz: 336de7d1164b9f315e83866901cc8beffe189bc5143e687f9f441881b0dffd0d
+  metadata.gz: 5cf11c03244890d238b1b72e02230eef6bf3827e76af08a0e05b97078cb4f936
+  data.tar.gz: 9e0cfc354d65e4457e87cca22517746907ea8362ff30230c21e60c9d40ae9d16
 SHA512:
-  metadata.gz: ef89f50965b515f05fbe905aaf2f0b1c1b835d15e0cd0c30401c63f2ab63d78def8c710b26f0e886fe23a0a8b187c6f5a63abdcc83fbbd9e7a4fa3da28d05d38
-  data.tar.gz: 3d571ae3db7b6e9fc55d6df2d135996cbbfa68312b30803274230d8a30a03fc1bd0f39310c9e7bf81059e695ad61d1e3e7ce1f2f7da3d87c81d8dfda7e74060e
+  metadata.gz: 935d894185b4497f6c0770df6aabe85e0cf186364d4e1c0647d8fd6176afbfc2023170ef40d88b897b7d6b3466c15c6a24ed4a79868a984c4de66a740f130410
+  data.tar.gz: 8a8f1ef61c6c68132e72c9e909ca1c0526db48ce09f4353e048b49589fdf17fdbdc8209155de4c582bd090b36593994f3bf5339c54e2a797c1816612a44a0676

data/.github/workflows/main.yml

@@ -1,18 +1,18 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.0
-    - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.3
-        bundle install
-        bundle exec rake
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_diff_lcs (0.0.6)
+    git_diff_lcs (0.1.0)
       diff-lcs (= 1.4.4)
       git (= 1.8.1)
       thor (= 1.1.0)

data/README.md

@@ -1,46 +1,26 @@
-# GitDiffLCS
-
-Generally, git diff --stat does not contain modifications, so we added it to display modifications using the LCS algorithm.
-
-## Installation
-```bash
-$ gem install git_diff-lcs
-```
-
-## How to use
-
-### CLI
-
-```bash
-$ git_diff_lcs diff [GIT_REPOSITORY] [SRC(BRANCH OR COMMIT)] [DEST(BRANCH OR COMMIT)]
-$ git_diff_lcs diff https://github.com/btpink-seo/git-diff-lcs.git test/src test/dest
-```
-
-### Ruby
-
-#### GitDiffLCS.diff(repo, src, dest)
-
-src, dest is branch name or commit
-
-```ruby
-require 'git_diff_lcs'
-
-GitDiffLCS.diff('https://github.com/btpink-seo/git-diff-lcs.git', 'test/src', 'test/dest')
-# => 5 files changed, 13 insertions(+), 6 deletions(-), 2 modifications(!), total(21)
-```
-
-#### GitDiffLCS::Stat.new(repo, src, dest)
-
-```ruby
-require 'git_diff_lcs'
-
-stat = GitDiffLCS::Stat.new('https://github.com/btpink-seo/git-diff-lcs.git', 'test/src', 'test/dest')
-stat.summary
-# => 5 files changed, 13 insertions(+), 6 deletions(-), 2 modifications(!), total(21)
-stat.insertions
-# => 13
-stat.deletions
-# => 6
-stat.modifications
-# => 2
-```
+# GitDiffLCS
+
+Generally, git diff --stat does not contain modifications, so we added it to display modifications using the LCS algorithm.
+
+## Installation
+```bash
+$ gem install git_diff-lcs
+```
+
+## How to use
+
+```bash
+$ git_diff_lcs shortstat  [GIT_REPOSITORY or WORKING_DIRECTORY] [SRC(branch or commit)] [DEST(branch or commit)]
+$ git_diff_lcs shortstat  https://github.com/btpink-seo/git-diff-lcs.git test/src test/dest
+$ git_diff_lcs shortstat  workspace/git-diff-lcs test/src test/dest
+```
+
+## compare with git diff
+
+```bash
+$ git diff --shortstat test/src test/dest
+ 5 files changed, 15 insertions(+), 8 deletions(-)
+
+$ git_diff_lcs shortstat https://github.com/btpink-seo/git-diff-lcs.git test/src test/dest
+ 5 files changed, 13 insertions(+), 6 deletions(-), 2 modifications(!), total(21)
+```

data/bin/console

@@ -1,18 +1,18 @@
-# A file which has a shebang line as its first line is
-# granted execute permission.
-
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "git_diff_lcs"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+# A file which has a shebang line as its first line is
+# granted execute permission.
+
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "git_diff_lcs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/git_diff_lcs

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-
-#!/usr/bin/env ruby
-
-require "git_diff_lcs"
-
-GitDiffLCS::CLI.start(ARGV)
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require "git_diff_lcs"
+
+GitDiffLCS::CLI.start(ARGV)

data/git_diff_lcs.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/git_diff_lcs/version"
+require_relative "lib/git_diff_lcs/constants"
 
 Gem::Specification.new do |spec|
   spec.name        = "git_diff_lcs"
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.4.0"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|script)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]
   spec.bindir        = "exe"

data/lib/git_diff_lcs.rb

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
-require "git_diff_lcs/stat"
-require "git_diff_lcs/version"
+require "git_diff_lcs/shortstat"
+require "git_diff_lcs/constants"
 require "git_diff_lcs/cli"
+require "git_diff_lcs/lib_git"
 
 # Git Diff LCS
 module GitDiffLCS
-  # Get diff summary with LCS algorithm
+  # Get diff --shortstat with LCS algorithm
   #
   # Arguments:
-  #   [String] repo: repo git repository address
-  #   [String] src: src src commit or branch
-  #   [String] dest: dest commit or branch
+  #   [String] git_target: git repository address or working directory
+  #   [String] src: commit or branch
+  #   [String] dest: commit or branch
   #
   # Return:
   #   [String] diff summary (changed files, insertions, deletions, modifications and total)
   #
   # Example:
-  #   >> GitDiffLCS.diff("https://github.com/btpink-seo/git-diff-lcs.git", "test/src", "test/dest")
+  #   >> GitDiffLCS.shortstat("https://github.com/btpink-seo/git-diff-lcs.git", "test/src", "test/dest")
   #   => 5 files changed, 13 insertions(+), 6 deletions(-), 2 modifications(!), total(21)
-  def self.diff(repo, src, dest)
-    diff = GitDiffLCS::Stat.new(repo, src, dest)
-    diff.errors.empty? ? diff.summary : diff.errors.first
+  def self.shortstat(git_target, src, dest)
+    shortstat = GitDiffLCS::Shortstat.new(git_target, src, dest)
+    shortstat.errors.empty? ? shortstat.summary : shortstat.errors.first
   end
 end

data/lib/git_diff_lcs/cli.rb

@@ -2,7 +2,6 @@
 
 require "thor"
 
-# Git Diff LCS
 module GitDiffLCS
   # Command Line Interface
   class CLI < Thor
@@ -10,9 +9,9 @@ module GitDiffLCS
       true
     end
 
-    desc "diff GIT_REPOSITORY SRC(BRANCH OR COMMIT) DEST(BRANCH OR COMMIT)", "get diff with LCS"
-    def diff(repo, src, dest)
-      puts GitDiffLCS.diff(repo, src, dest)
+    desc "shortstat GIT_REPOSITORY SRC(BRANCH OR COMMIT) DEST(BRANCH OR COMMIT)", "get diff with LCS"
+    def shortstat(repo, src, dest)
+      puts GitDiffLCS.shortstat(repo, src, dest)
     end
   end
 end

data/lib/git_diff_lcs/constants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module GitDiffLCS
+  # gem version
+  VERSION = "0.1.0"
+
+  # Source folder
+  SRC_FOLDER = "src_#{SecureRandom.uuid}"
+
+  # Destination folder
+  DEST_FOLDER = "dest_#{SecureRandom.uuid}"
+
+  # Initial diff count number
+  INIT_COUNT = [0, 0, 0].freeze
+end

data/lib/git_diff_lcs/lib_git.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "git"
+
+module GitDiffLCS
+  # Git
+  class LibGit
+    attr_reader :git
+
+    # initialize GitDiffLCS::LibGit
+    #
+    # Arguments:
+    #   [String] git_target: git repository address or working directory
+    #   [String] dir: temporary folder
+    #   [String] src: commit or branch
+    #   [String] dest: commit or branch
+    def initialize(git_target, dir, src, dest)
+      @dir = dir
+      @src = src
+      @dest = dest
+      get_git(git_target)
+    end
+
+    def diff
+      @diff ||= @git.diff(@src, @dest)
+    end
+
+    private
+
+    # Git.open or Git.clone
+    def get_git(git_target)
+      git_clone(git_target)
+    rescue Git::GitExecuteError
+      git_open(git_target)
+    end
+
+    # If there is no folder, create a new one.
+    def copy_with_path(src_file, dest_file)
+      FileUtils.mkpath(File.dirname(dest_file))
+      FileUtils.cp(src_file, dest_file)
+    rescue Errno::ENOENT
+      nil
+    end
+
+    def copy_to_tmp(commit, src_dir, dest_dir)
+      @git.checkout(commit)
+      diff.name_status.each do |filename, _|
+        copy_with_path("#{@dir}/#{src_dir}/#{filename}", "#{@dir}/#{dest_dir}/#{filename}")
+      end
+    end
+
+    # git open and copy to destination folder for compare
+    def git_open(working_dir)
+      @git = Git.open(working_dir)
+      prev_branch = @git.branch.name
+      @git.checkout(@src)
+      copy_to_tmp(@dest, working_dir, GitDiffLCS::DEST_FOLDER)
+      copy_to_tmp(@src, working_dir, GitDiffLCS::SRC_FOLDER)
+      @git.checkout(prev_branch)
+    end
+
+    # git clone and copy to destination folder for compare
+    def git_clone(repo)
+      @git = Git.clone(repo, GitDiffLCS::SRC_FOLDER, path: @dir)
+      @git.checkout(@src)
+      copy_to_tmp(@dest, GitDiffLCS::SRC_FOLDER, GitDiffLCS::DEST_FOLDER)
+      @git.checkout(@src)
+    end
+  end
+end

data/lib/git_diff_lcs/shortstat.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "diff/lcs"
+require "git"
+
+module GitDiffLCS
+  # Shortstat
+  class Shortstat
+    attr_reader :add, :del, :mod, :errors
+    alias insertions add
+    alias deletions del
+    alias modifications mod
+
+    # initialize GitDiffLCS::Shortstat
+    #
+    # Arguments:
+    #   [String] git_target: git repository address or working directory
+    #   [String] src: commit or branch
+    #   [String] dest: commit or branch
+    def initialize(git_target, src, dest)
+      @dir = Dir.mktmpdir
+      @add, @del, @mod = *GitDiffLCS::INIT_COUNT
+      @errors = []
+      @git = GitDiffLCS::LibGit.new(git_target, @dir, src, dest)
+      calculate
+    rescue Git::GitExecuteError, ArgumentError
+      @errors << "[ERROR] wrong arguments"
+    ensure
+      FileUtils.rm_rf(@dir)
+    end
+
+    # Get diff summary
+    # changed files, insertions, deletions, modifications and total
+    #
+    # Return:
+    #   [String] diff summary
+    def summary
+      " #{@git.diff.name_status.keys.size} files changed, "\
+      "#{@add} insertions(+), #{@del} deletions(-), #{@mod} modifications(!), "\
+      "total(#{@add + @del + @mod})"
+    end
+
+    private
+
+    # add each count variable
+    def add_result(diff)
+      @add += 1 if diff.adding?
+      @del += 1 if diff.deleting?
+      @mod += 1 if diff.changed?
+    end
+
+    # count diff
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def calculate
+      @git.diff.name_status.each do |filename, status|
+        src_filename = "#{@dir}/#{GitDiffLCS::SRC_FOLDER}/#{filename}"
+        dest_filename = "#{@dir}/#{GitDiffLCS::DEST_FOLDER}/#{filename}"
+
+        case status
+        when "A"
+          @add += File.open(dest_filename).readlines.size
+          next
+        when "D"
+          @del += File.open(src_filename).readlines.size
+          next
+        else
+          src = File.open(src_filename)
+          dest = File.open(dest_filename)
+          Diff::LCS.sdiff(src.readlines, dest.readlines).each { |d| add_result(d) }
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_diff_lcs
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - SEO SANG HYUN
@@ -74,8 +74,9 @@ files:
 - git_diff_lcs.gemspec
 - lib/git_diff_lcs.rb
 - lib/git_diff_lcs/cli.rb
-- lib/git_diff_lcs/stat.rb
-- lib/git_diff_lcs/version.rb
+- lib/git_diff_lcs/constants.rb
+- lib/git_diff_lcs/lib_git.rb
+- lib/git_diff_lcs/shortstat.rb
 homepage: https://github.com/btpink-seo/git-diff-lcs
 licenses:
 - MIT

data/lib/git_diff_lcs/stat.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require "securerandom"
-require "diff/lcs"
-require "git"
-
-# Git Diff LCS
-module GitDiffLCS
-  # Stat
-  class Stat
-    # Source folder
-    SRC_FOLDER = "src_#{SecureRandom.uuid}"
-
-    # Destination folder
-    DEST_FOLDER = "dest_#{SecureRandom.uuid}"
-
-    # Initial diff count number
-    INIT_COUNT = [0, 0, 0].freeze
-
-    # Initial array for target_files and errors
-    INIT_ARRAY = Array.new(2, [])
-
-    attr_reader :add, :del, :mod, :errors
-    alias insertions add
-    alias deletions del
-    alias modifications mod
-
-    # initialize GitDiffLCS::Stat
-    #
-    # Arguments:
-    #   [String] repo: repo git repository address
-    #   [String] src: src src commit or branch
-    #   [String] dest: dest commit or branch
-    def initialize(repo, src, dest)
-      @go_next = false
-      @dir = Dir.mktmpdir
-      @add, @del, @mod = *INIT_COUNT
-      @target_files, @errors = *Array.new(2, [])
-      @diff = git_clone(repo, src, dest).diff(src, dest)
-      calculate
-    rescue Git::GitExecuteError
-      @errors << "[ERROR] wrong git info(repository or src or dest)"
-    ensure
-      FileUtils.rm_rf(@dir)
-    end
-
-    # Get diff summary
-    # changed files, insertions, deletions, modifications and total
-    #
-    # Return:
-    #   [String] diff summary
-    #
-    # Example:
-    #   >> stat = GitDiffLCS::Stat.new("https://github.com/btpink-seo/git-diff-lcs.git", "test/src", "test/dest")
-    #   >> stat.summary
-    #   => 5 files changed, 13 insertions(+), 6 deletions(-), 2 modifications(!), total(21)
-    def summary
-      total = @add + @del + @mod
-      changed = @target_files.size
-      "#{changed} files changed, #{@add} insertions(+), #{@del} deletions(-), #{@mod} modifications(!), total(#{total})"
-    end
-
-    private
-
-    # git clone and copy to destination folder for compare
-    def git_clone(repo, src, dest)
-      git = Git.clone(repo, SRC_FOLDER, path: @dir)
-      git.checkout(dest)
-      FileUtils.copy_entry("#{@dir}/#{SRC_FOLDER}", "#{@dir}/#{DEST_FOLDER}")
-      git.checkout(src)
-      git
-    end
-
-    # open_src_file
-    # if dosen't exist file, add insertions all dest line length
-    def open_src_file(src_filename, dest_filename)
-      File.open(src_filename)
-    rescue Errno::ENOENT
-      # new file in dest
-      @add += open_dest_file(nil, dest_filename).readlines.size
-      @go_next = true
-    end
-
-    # open_dest_file
-    # if dosen't exist file, add deletions all src line length
-    def open_dest_file(src, dest_filename)
-      File.open(dest_filename)
-    rescue Errno::ENOENT
-      # deleted file in dest
-      @del += src.readlines.size
-      @go_next = true
-    end
-
-    # add each count variable
-    def add_result(diff)
-      @add += 1 if diff.adding?
-      @del += 1 if diff.deleting?
-      @mod += 1 if diff.changed?
-    end
-
-    # count diff
-    def calculate
-      @target_files = @diff.name_status.keys
-      @target_files.each do |file|
-        src_filename = "#{@dir}/#{SRC_FOLDER}/#{file}"
-        dest_filename = "#{@dir}/#{DEST_FOLDER}/#{file}"
-
-        src = open_src_file(src_filename, dest_filename)
-        dest = open_dest_file(src, dest_filename)
-
-        next if @go_next && !(@go_next = !@go_next)
-        next if FileUtils.cmp(src_filename, dest_filename)
-
-        Diff::LCS.sdiff(src.readlines, dest.readlines).each { |d| add_result(d) }
-      end
-    end
-  end
-end

data/lib/git_diff_lcs/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module GitDiffLCS
-  VERSION = "0.0.6"
-end