epdiff 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f072768d70f69bb8390ee6fcb2b9261a2eee8df99084a7d162ec7cf0827ea5
-  data.tar.gz: 97a0b665572c96e42f72d3a0c27f15cab7354814bac786b93d44163b76ca899f
+  metadata.gz: eade3ce9735f322e276d9979f95bac249e6f1c97652c7ed81751aab53040822e
+  data.tar.gz: 17f524806a498fce7443f82b720130d532151d7cc0480fae467dede02dcf927b
 SHA512:
-  metadata.gz: '092f898933263c56d975e02cb50be1881e043817a79ddf7b54abf1c5a849ab0d259075048d03bab8ddf336a48b34a9dfb3b0efc5a38bb922a18949c9e358b4de'
-  data.tar.gz: 0f3f84ecae7a44c54e5b263969c4e64cb558d73ca1c167d39dea2211ed4fa24fe76fa28ed1f230b3b2c6b7f327b5839e610730dea5baf45eeff5c6e71afc18c2
+  metadata.gz: d26b43c8660ce91b714fae6e4f9c9edaa1631d61b5f72ccad304179057e1923b3ac9d14ae80c4344fc70b0d754991a344f85103bdcc12f0cacab95775c598dae
+  data.tar.gz: 92a0d7cd8c8fee867a08b3fe390885903df627cb693431a10c67c6dcced232d390a397cec9021da48a7f8aed9e933614012ebf9682d03a5ebc96b570087e90d3

data/.github/workflows/ruby-win.yml

@@ -0,0 +1,28 @@
+name: Ruby on Win
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake test # do not use rubucop on windows

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,31 @@
+# inherit_from: .rubocop_todo.yml
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 117
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in epdiff.gemspec
 gemspec

data/Rakefile

@@ -1 +1,20 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+desc 'Check with rubocop'
+task :rubocop do
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  warn 'rubocop not found'
+end
+
+task default: %i[test rubocop]

data/bin/epdiff

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'epdiff'
-Epdiff.execute(*ARGV)
+exit_code = Epdiff.execute(*ARGV)
+exit(exit_code)

data/epdiff.gemspec

@@ -1,22 +1,27 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "epdiff/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'epdiff/version'
 
 Gem::Specification.new do |s|
-  s.name        = "epdiff"
+  s.name        = 'epdiff'
   s.version     = Epdiff::VERSION
-  s.authors     = ["takahashim"]
-  s.email       = ["maki@rubycolor.org"]
-  s.homepage    = ""
-  s.summary     = %q{diff command for EPUB files.}
-  s.description = %q{diff command for EPUB files.}
+  s.authors     = ['takahashim']
+  s.email       = ['maki@rubycolor.org']
+  s.homepage    = ''
+  s.summary     = 'diff command for EPUB files.'
+  s.description = 'diff command for EPUB files.'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.add_runtime_dependency "rubyzip", "~> 2.3.0"
-  s.add_runtime_dependency "pastel"
-  s.add_runtime_dependency "tty-file"
-  s.add_development_dependency "rake"
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_runtime_dependency 'pastel'
+  s.add_runtime_dependency 'rubyzip', '~> 2.3.0'
+  s.add_runtime_dependency 'tty-file'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rake'
+  s.add_development_dependency 'test-unit'
 end

data/lib/epdiff.rb

@@ -1,4 +1,6 @@
-require "epdiff/version"
+# frozen_string_literal: true
+
+require 'epdiff/version'
 require 'optparse'
 require 'tmpdir'
 require 'fileutils'
@@ -6,9 +8,9 @@ require 'zip'
 require 'pastel'
 require 'tty/file'
 
-
+# EPUB diff class
 class Epdiff
-  TEXT_EXT = %w(xhtml html xml opf css txt)
+  TEXT_EXT = %w[xhtml html xml opf css txt].freeze
 
   def self.execute(*args)
     new.execute(*args)
@@ -24,22 +26,22 @@ class Epdiff
 
   def unzip(filename, dir)
     Zip::InputStream.open(filename) do |zio|
-      while entry = zio.get_next_entry
-        if  entry.file?
-          entry_filename = File.join(dir, entry.name)
-          FileUtils.mkdir_p File.dirname(entry_filename)
-          File.binwrite(entry_filename, zio.read)
-        end
+      while entry = zio.get_next_entry # rubocop:disable Lint/AssignmentInCondition
+        next unless entry.file?
+
+        entry_filename = File.join(dir, entry.name)
+        FileUtils.mkdir_p File.dirname(entry_filename)
+        File.binwrite(entry_filename, zio.read)
       end
     end
   end
 
-  def show_diff(file1, file2, work_dir)
+  def show_diff(_file1, _file2, work_dir)
     Dir.chdir(work_dir) do
-      files1 = Dir.glob("file1/**/*")
-      files2 = Dir.glob("file2/**/*")
-      files1_s = files1.map{|d| d.sub(%r{^file1/}, '')}
-      files2_s = files2.map{|d| d.sub(%r{^file2/}, '')}
+      files1 = Dir.glob('file1/**/*')
+      files2 = Dir.glob('file2/**/*')
+      files1_s = files1.map { |d| d.sub(%r{^file1/}, '') }
+      files2_s = files2.map { |d| d.sub(%r{^file2/}, '') }
       files_common = files1_s & files2_s
       files_common.each do |path|
         if File.file?("file1/#{path}")
@@ -65,41 +67,40 @@ class Epdiff
 
   def text_file?(path)
     extname = File.extname(path).sub(/\A\./, '')
-    if TEXT_EXT.include?(extname)
-      extname
-    else
-      nil
-    end
+    extname if TEXT_EXT.include?(extname)
   end
 
   def text_diff(_path, path1, path2)
-    diff = @color ? TTY::File.diff(path1, path2, verbose: false) : TTY::File.diff(path1, path2, verbose: false, color: nil)
-    if diff != "No differences found\n" && diff.strip != ""
-      @exit_code = 1
-      print diff
-    end
+    diff = if @color
+             TTY::File.diff(path1, path2, verbose: false)
+           else
+             TTY::File.diff(path1, path2, verbose: false, color: nil)
+           end
+
+    return if diff == "No differences found\n" || diff.strip == ''
+
+    @exit_code = 1
+    print diff
   end
 
   def binary_diff(path, path1, path2)
     content1 = File.binread(path1)
     content2 = File.binread(path2)
-    if content1 != content2
-      @exit_code = 1
-      message = "DIFF: #{path} has some differences.\n"
-      print @color ? @cyan.call(message) : message
-    end
+
+    return if content1 == content2
+
+    @exit_code = 1
+    message = "DIFF: #{path} has some differences.\n"
+    print @color ? @cyan.call(message) : message
   end
 
   def execute(*args)
-
     tmpdir = work_dir = nil
-    diff_path = nil
-    unzip_path = nil
 
-    opts = OptionParser.new do |opts|
+    options = OptionParser.new do |opts|
       opts.banner = "Usage: epdiff [options] [filename] [filename]\n"
 
-      opts.on('-t','--tmpdir DIR', 'Set tepmorary directory') do |dir|
+      opts.on('-t', '--tmpdir DIR', 'Set tepmorary directory') do |dir|
         tmpdir = dir
       end
 
@@ -119,35 +120,31 @@ class Epdiff
     end
 
     begin
-
-      opts.parse!(args)
+      options.parse!(args)
 
       if args.size != 2
         # invalid option
-        puts opts
+        puts options
         exit
       end
 
       work_dir = tmpdir || Dir.mktmpdir
 
       file1, file2 = *args
-      FileUtils.mkdir_p(work_dir+"/file1")
-      FileUtils.mkdir_p(work_dir+"/file2")
+      FileUtils.mkdir_p("#{work_dir}/file1")
+      FileUtils.mkdir_p("#{work_dir}/file2")
 
       unzip(file1, "#{work_dir}/file1")
       unzip(file2, "#{work_dir}/file2")
 
       @exit_code = 0
       show_diff(file1, file2, work_dir)
-      exit(@exit_code)
-    rescue => e
+
+      @exit_code
+    rescue StandardError => e
       warn e
-      puts opts
     ensure
-      if work_dir && !tmpdir
-        FileUtils.rm_rf(work_dir)
-      end
+      FileUtils.rm_rf(work_dir) if work_dir && !tmpdir
     end
   end
-
 end

data/lib/epdiff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Epdiff
-  VERSION = "2.0.0.rc2"
+  VERSION = '2.0.0'
 end

data/test/fixtures/sample_diff0.txt

@@ -0,0 +1,22 @@
+--- file1/OEBPS/book.opf
++++ file2/OEBPS/book.opf
+@@ -17,6 +17,7 @@
+     <item id="style-css" href="style.css" media-type="text/css"/>
+     <item id="titlepage-xhtml" href="titlepage.xhtml" media-type="application/xhtml+xml"/>
+     <item id="test1-xhtml" href="test1.xhtml" media-type="application/xhtml+xml"/>
++    <item id="images-Hokusai_Setsubun_no_Oni-jpg" href="images/Hokusai_Setsubun_no_Oni.jpg" media-type="image/jpeg"/>
+   </manifest>
+   <spine page-progression-direction="ltr">
+     <itemref idref="book" linear="no"/>
+--- file1/OEBPS/test1.xhtml
++++ file2/OEBPS/test1.xhtml
+@@ -9,7 +9,7 @@
+ </head>
+ <body>
+ <h1><a id="h1"></a><span class="secno">第1章　</span>test1</h1>
+-<p>this is a test EPUB file.</p>
++<p>this is a EPUB file to test <strong>epdiff</strong>.</p>
+ </body>
+ </html>
+DIFF: OEBPS/images/Hokusai_Setsubun_no_Oni.jpg only exists in 2nd.
+

data/test/fixtures/sample_diff1.txt

@@ -0,0 +1,21 @@
+--- file1/OEBPS/book.opf
++++ file2/OEBPS/book.opf
+@@ -17,6 +17,7 @@
+     <item id="style-css" href="style.css" media-type="text/css"/>
+     <item id="titlepage-xhtml" href="titlepage.xhtml" media-type="application/xhtml+xml"/>
+     <item id="test1-xhtml" href="test1.xhtml" media-type="application/xhtml+xml"/>
++    <item id="images-Hokusai_Setsubun_no_Oni-jpg" href="images/Hokusai_Setsubun_no_Oni.jpg" media-type="image/jpeg"/>
+   </manifest>
+   <spine page-progression-direction="ltr">
+     <itemref idref="book" linear="no"/>
+--- file1/OEBPS/test1.xhtml
++++ file2/OEBPS/test1.xhtml
+@@ -9,7 +9,7 @@
+ </head>
+ <body>
+ <h1><a id="h1"></a><span class="secno">第1章　</span>test1</h1>
+-<p>this is a test EPUB file.</p>
++<p>this is a EPUB file to test <strong>epdiff</strong>.</p>
+ </body>
+ </html>
+DIFF: OEBPS/images/Hokusai_Setsubun_no_Oni.jpg only exists in 2nd.

data/test/run_test.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+base_dir = File.expand_path('..', __dir__)
+lib_dir  = File.join(base_dir, 'lib')
+test_dir = File.join(base_dir, 'test')
+
+$LOAD_PATH.unshift(lib_dir)
+
+require 'test/unit'
+
+argv = ARGV || ['--max-diff-target-string-size=10000']
+exit Test::Unit::AutoRunner.run(true, test_dir, argv)

data/test/test_epdiff.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'epdiff'
+
+class EpdiffTest < Test::Unit::TestCase
+  def setup; end
+
+  def teardown; end
+
+  def test_ezpdiff_execute_color
+    out = $stdout
+    $stdout = StringIO.new
+    begin
+      Epdiff.new.execute(File.join(fixtures_dir, 'book_orig.epub'),
+                         File.join(fixtures_dir, 'book_image.epub'))
+      result = $stdout.string
+    ensure
+      $stdout = out
+    end
+    expected = File.read(File.join(fixtures_dir, 'sample_diff0.txt'))
+    assert_equal expected, result
+  end
+
+  def test_ezpdiff_execute_nocolor
+    out = $stdout
+    $stdout = StringIO.new
+    begin
+      Epdiff.new.execute('-C',
+                         File.join(fixtures_dir, 'book_orig.epub'),
+                         File.join(fixtures_dir, 'book_image.epub'))
+      result = $stdout.string
+    ensure
+      $stdout = out
+    end
+    expected = File.read(File.join(fixtures_dir, 'sample_diff1.txt'))
+    assert_equal expected, result
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'test/unit'
+
+def fixtures_dir
+  File.join(__dir__, 'fixtures')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epdiff
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors:
 - takahashim
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: pastel
+  name: tty-file
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-file
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,7 +130,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby-win.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -83,6 +142,14 @@ files:
 - epdiff.gemspec
 - lib/epdiff.rb
 - lib/epdiff/version.rb
+- test/fixtures/book_image.epub
+- test/fixtures/book_new.epub
+- test/fixtures/book_orig.epub
+- test/fixtures/sample_diff0.txt
+- test/fixtures/sample_diff1.txt
+- test/run_test.rb
+- test/test_epdiff.rb
+- test/test_helper.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -97,12 +164,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: diff command for EPUB files.
-test_files: []
+test_files:
+- test/fixtures/book_image.epub
+- test/fixtures/book_new.epub
+- test/fixtures/book_orig.epub
+- test/fixtures/sample_diff0.txt
+- test/fixtures/sample_diff1.txt
+- test/run_test.rb
+- test/test_epdiff.rb
+- test/test_helper.rb