git_diff_lcs 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2123947d389e4a5c12a5a274fb8e5598f20fcdfc275309b5e1a2edc1b9d5c461
-  data.tar.gz: 73b19ddf4745c3c5760587eeab2f161e26969e173d6bf58af232fc9d689e74cb
+  metadata.gz: e1b6be903d8a4f4a01f76b6bb78e2760951c57bbf1ae01c1f08025be9a3fe466
+  data.tar.gz: 336de7d1164b9f315e83866901cc8beffe189bc5143e687f9f441881b0dffd0d
 SHA512:
-  metadata.gz: 16d21b22cae93be9c4018b00c27445ad1690e08e1b59bf636e81eff1b3233864c2082c919d429525d0962275136dfeb537ba0527dcdc894f3d9d8050899f9339
-  data.tar.gz: 20d284393155dc560423e06962f6759720e3785f50a30079bea557e9685da69e4971db9bbdd9048e6d652fa35ee6cc40401d5f6ac83c5c0527fd42c9e21d4c25
+  metadata.gz: ef89f50965b515f05fbe905aaf2f0b1c1b835d15e0cd0c30401c63f2ab63d78def8c710b26f0e886fe23a0a8b187c6f5a63abdcc83fbbd9e7a4fa3da28d05d38
+  data.tar.gz: 3d571ae3db7b6e9fc55d6df2d135996cbbfa68312b30803274230d8a30a03fc1bd0f39310c9e7bf81059e695ad61d1e3e7ce1f2f7da3d87c81d8dfda7e74060e

data/Gemfile.lock

@@ -1,63 +1,63 @@
-PATH
-  remote: .
-  specs:
-    git_diff_lcs (0.0.4)
-      diff-lcs (= 1.4.4)
-      git (= 1.8.1)
-      thor (= 1.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.4.4)
-    git (1.8.1)
-      rchardet (~> 1.8)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rchardet (1.8.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (0.93.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
-    thor (1.1.0)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  x64-mingw32
-  x86_64-linux
-
-DEPENDENCIES
-  git_diff_lcs!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.80)
-
-BUNDLED WITH
-   2.2.13
+PATH
+  remote: .
+  specs:
+    git_diff_lcs (0.0.6)
+      diff-lcs (= 1.4.4)
+      git (= 1.8.1)
+      thor (= 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rchardet (1.8.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x64-mingw32
+  x86_64-linux
+
+DEPENDENCIES
+  git_diff_lcs!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.13

data/README.md

@@ -1,4 +1,4 @@
-# GitDiffLcs
+# GitDiffLCS
 
 Generally, git diff --stat does not contain modifications, so we added it to display modifications using the LCS algorithm.
 
@@ -12,28 +12,29 @@ $ gem install git_diff-lcs
 ### 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
 
-#### diff(repo, src, dest)
+#### 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')
+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)
+#### 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 = 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

data/exe/git_diff_lcs

@@ -4,4 +4,4 @@
 
 require "git_diff_lcs"
 
-GitDiffLcs::CLI.start(ARGV)
+GitDiffLCS::CLI.start(ARGV)

data/git_diff_lcs.gemspec

@@ -1,27 +1,27 @@
-# frozen_string_literal: true
-
-require_relative "lib/git_diff_lcs/version"
-
-Gem::Specification.new do |spec|
-  spec.name        = "git_diff_lcs"
-  spec.version     = GitDiffLcs::VERSION
-  spec.authors     = ["SEO SANG HYUN"]
-  spec.email       = "btpink.seo@gmail.com"
-
-  spec.summary     = "'git diff --shortstat' with modifications"
-  spec.description = "Add modifications to 'git diff --shortstat' using the LCS algorithm."
-  spec.homepage    = "https://github.com/btpink-seo/git-diff-lcs"
-  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)/}) }
-  end
-  spec.require_paths = ["lib"]
-  spec.bindir        = "exe"
-  spec.executables   << "git_diff_lcs"
-
-  spec.license       = "MIT"
-  spec.add_dependency "diff-lcs", "1.4.4"
-  spec.add_dependency "git", "1.8.1"
-  spec.add_runtime_dependency "thor", "1.1.0"
-end
+# frozen_string_literal: true
+
+require_relative "lib/git_diff_lcs/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "git_diff_lcs"
+  spec.version     = GitDiffLCS::VERSION
+  spec.authors     = ["SEO SANG HYUN"]
+  spec.email       = "btpink.seo@gmail.com"
+
+  spec.summary     = "'git diff --shortstat' with modifications"
+  spec.description = "Add modifications to 'git diff --shortstat' using the LCS algorithm."
+  spec.homepage    = "https://github.com/btpink-seo/git-diff-lcs"
+  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)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.bindir        = "exe"
+  spec.executables << "git_diff_lcs"
+
+  spec.license = "MIT"
+  spec.add_dependency "diff-lcs", "1.4.4"
+  spec.add_dependency "git", "1.8.1"
+  spec.add_runtime_dependency "thor", "1.1.0"
+end

data/lib/git_diff_lcs.rb

@@ -1,13 +1,26 @@
-# frozen_string_literal: true
-
-require "git_diff_lcs/stat"
-require "git_diff_lcs/version"
-require "git_diff_lcs/cli"
-
-# Git Diff LCS
-module GitDiffLcs
-  def self.diff(repo, src, dest)
-    diff = GitDiffLcs::Stat.new(repo, src, dest)
-    diff.summary
-  end
-end
+# frozen_string_literal: true
+
+require "git_diff_lcs/stat"
+require "git_diff_lcs/version"
+require "git_diff_lcs/cli"
+
+# Git Diff LCS
+module GitDiffLCS
+  # Get diff summary with LCS algorithm
+  #
+  # Arguments:
+  #   [String] repo: repo git repository address
+  #   [String] src: src src commit or branch
+  #   [String] dest: 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")
+  #   => 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
+  end
+end

data/lib/git_diff_lcs/cli.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
-require "thor"
-
-# Git Diff LCS
-module GitDiffLcs
-  # Command Line Interface
-  class CLI < Thor
-    def self.exit_on_failure?
-      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)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "thor"
+
+# Git Diff LCS
+module GitDiffLCS
+  # Command Line Interface
+  class CLI < Thor
+    def self.exit_on_failure?
+      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)
+    end
+  end
+end

data/lib/git_diff_lcs/stat.rb

@@ -1,105 +1,118 @@
-# frozen_string_literal: true
-
-require "securerandom"
-require "diff/lcs"
-require "git"
-
-# Git Diff LCS
-module GitDiffLcs
-  # Stat
-  class Stat
-    SRC_FOLDER = "src_#{SecureRandom.uuid}"
-    DEST_FOLDER = "dest_#{SecureRandom.uuid}"
-    INIT_COUNT = [0, 0, 0].freeze
-
-    # repo(String) : git repository address
-    # src(String) : src commit or branch
-    # dest(String) : dest commit or branch
-    def initialize(repo, src, dest)
-      @go_next = false
-      @dir = Dir.mktmpdir
-      @add, @del, @mod = *INIT_COUNT
-      @target_files = []
-
-      @diff = git_clone(repo, src, dest).diff(src, dest)
-      @target_files = @diff.name_status.keys
-      calculate
-    rescue Git::GitExecuteError
-      puts "[ERROR] wrong git info(repo or src or dest)"
-    end
-
-    def summary
-      total = @add + @del + @mod
-      changed = @target_files.size
-      "#{changed} files changed, #{@add} insertions(+), #{@del} deletions(-), #{@mod} modifications(!), total(#{total})"
-    end
-
-    def insertions
-      @add
-    end
-
-    def deletions
-      @del
-    end
-
-    def modifications
-      @mod
-    end
-
-    private
-
-    def close
-      FileUtils.rm_rf(@dir)
-    end
-
-    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
-
-    def open_src_file(src_filename, dest_filename)
-      File.open(src_filename)
-    rescue Errno::ENOENT
-      # p "new file in dest #{file}"
-      @add += open_dest_file(nil, dest_filename).readlines.size
-      @go_next = true
-    end
-
-    def open_dest_file(src, dest_filename)
-      File.open(dest_filename)
-    rescue Errno::ENOENT
-      # p "deleted file in dest #{file}"
-      @del += src.readlines.size
-      @go_next = true
-    end
-
-    def add_result(diff)
-      # p diff if diff.adding? || diff.deleting? || diff.changed?
-      @add += 1 if diff.adding?
-      @del += 1 if diff.deleting?
-      @mod += 1 if diff.changed?
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def calculate
-      @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)
-
-        diffs = Diff::LCS.sdiff(src.readlines, dest.readlines)
-        diffs.each { |d| add_result(d) }
-      end
-      close
-    end
-    # rubocop:enable Metrics/MethodLength
-  end
-end
+# 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 +1,5 @@
-# frozen_string_literal: true
-
-module GitDiffLcs
-  VERSION = "0.0.5"
-end
+# frozen_string_literal: true
+
+module GitDiffLCS
+  VERSION = "0.0.6"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_diff_lcs
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - SEO SANG HYUN
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs