duplicated_filename_checker 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ab8cff2f3e31f6071bd3a14773ba6ccc80b1de2
-  data.tar.gz: 329cc390c657a46b4d4a4795d1749c62e871f678
+  metadata.gz: f0bee9d09d0dc3b70e60cfc8e6b383f08e6070b8
+  data.tar.gz: f2dfc12500b29bfd22c9752dbf1dab479123be30
 SHA512:
-  metadata.gz: 3acbcc235243c4ba747a88323691fea36ddfcf308d99e175db7f11a36d1760208fa5d3abac0d6e11932d16934514d5f57c8c531fdc7a35a8ae54a903cd49ee46
-  data.tar.gz: 6d23f23982c269cbd602994489c38c0890fa5de9e1687991123c5bfb3d8d9a4160a478914831e751aedfb1264b835acacc95cf85a1291133a0345f7fb99230b5
+  metadata.gz: 6cc1ee617589e8e23bce4a5c4f9e2f6b9110b302658cc60fa3acf28b8d7187469fdac4739e6254d6f70c7d2ace7082eb1c23598d35d5629f8fc97382cef4ebea
+  data.tar.gz: da5031d498c68fd85b3da4c06da79b2d65c769815462e3c9f19146e4d776847c679e173057ca3f26718309462e7d3d4f00918274c6fab1c1ed4924ab171288ca

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1.2
   - 2.2.0
 script: rake test

data/README.md

@@ -15,6 +15,8 @@ install:
     $ gem install duplicated_filename_checker
 
 ## Usage
+### survey duplicate filename
+
 ```
 $ dup-filename ./survey_dir1_root ./survey_dir2_root
 
@@ -38,6 +40,14 @@ $ dup-filename ./survey_dir1_root ./survey_dir2_root
 
 ```
 
+### only filename option: `-l`
+```
+$ dup-filename -l ./survey_dir1_root ./survey_dir2_root
+dupfilename1.png
+dupfilename2.png
+
+```
+
 ## Usage `duplicated_filename_checker` as library
 
 You can use `duplicated_filename_checker` in ruby program.
@@ -87,4 +97,4 @@ p duplicate_file_profiles[0].path
 
 p duplicate_file_profiles[1].path
 #=> /Users/shinya131/survey_dir2_root/subdirectory/dupfilename1.png
-```
+```

data/bin/dup-filename

@@ -1,34 +1,27 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'duplicated_filename_checker'
 require 'optparse'
 
-# check argument
-unless ARGV.size > 0
-  raise ArgumentError.new('Specify the argument. Argument is survey target root paths.')
-end
+# read args
+options = ARGV.getopts("li:")
 
-# survey
+exclude_basename = options["i"]
+only_basename = options["l"]
 servey_root_paths = ARGV
-duplicated_file_profiles = DuplicatedFilenameChecker::Check.new(*servey_root_paths).execute
-
-# options
-options = ARGV.getopts("i:")
-ignore_keyword = options["i"]
 
-# formatting
-duplicated_file_profiles.each do |basename, file_profiles|
-  if ignore_keyword
-    next if basename =~ Regexp.new(ignore_keyword)
-  end
-
-  puts "## #{basename}"
+# survey
+include DuplicatedFilenameChecker
+duplicated_file_profiles = Check.new(*servey_root_paths).execute
+result = Formatter.new(duplicated_file_profiles)
 
-  file_profiles.each.with_index(1) do |file_profile, index|
-    puts "#{index}. #{file_profile.path}"
-    puts " * md5: #{file_profile.md5_digest}"
-    puts " * mtime: #{file_profile.stat.mtime}"
-    puts "\n"
-  end
+# filter
+result.exclude_basename(exclude_basename)
 
-  puts "\n"
+# show
+if only_basename
+  puts result.only_basename
+else
+  puts result.markdown
 end
+

data/lib/duplicated_filename_checker.rb

@@ -3,4 +3,5 @@ require "duplicated_filename_checker/version"
 module DuplicatedFilenameChecker
   require 'duplicated_filename_checker/file_profile'
   require 'duplicated_filename_checker/check'
+  require 'duplicated_filename_checker/formatter'
 end

data/lib/duplicated_filename_checker/check.rb

@@ -1,6 +1,9 @@
 class DuplicatedFilenameChecker::Check
-  def initialize(*survey_direcotry_roots)
-    @survey_target_paths =  survey_target_paths_by(survey_direcotry_roots)
+  def initialize(*check_direcotry_roots)
+    argument_size_validation!(check_direcotry_roots)
+    check_directory_exists_validation!(check_direcotry_roots)
+
+    @check_target_paths = check_target_paths_by(check_direcotry_roots)
   end
 
   def execute
@@ -9,28 +12,52 @@ class DuplicatedFilenameChecker::Check
 
   private
 
-  # select duplicate paths from survey target paths
+  # select duplicate paths from check target paths
   def duplicate_paths
-    @survey_target_paths.select do |path|
-      is_duplicate?(path.basename)
+    @check_target_paths.select do |file|
+      is_duplicate?(file.basename)
     end
   end
 
   def is_duplicate?(basename)
-    survey_paths_basename_list.count(basename) > 1
+    basename_with_count[basename] > 1
   end
 
-  # Baseames of survey_paths. It list is not uniq.
-  # @example ['basename1', 'basename1', 'basename2', 'basename3']
-  def survey_paths_basename_list
-    @basename_list ||= @survey_target_paths.map(&:basename) #memorize
+  # @return [Hash] basename with same basename count.
+  # @example { "basename_a.png" => 1, "basename_b.png" => 3, "basename_c.png" => 1 }
+  def basename_with_count
+    unless @basename_count.nil? # memorize
+      return @basename_count
+    end
+
+    @basename_count = Hash.new(0)
+
+    @check_target_paths.each do |file|
+      @basename_count[file.basename] += 1
+    end
+
+    @basename_count
   end
 
-  def survey_target_paths_by(root_paths)
+  def check_target_paths_by(root_paths)
     # get paths in subdirectory
     paths = root_paths.map{|root| Dir.glob("#{root}/**/*.*") }.flatten
 
     # exchange to FileProfile
     paths.map{|path| DuplicatedFilenameChecker::FileProfile.new(path) }
   end
+
+  def argument_size_validation!(check_direcotry_roots)
+    unless check_direcotry_roots.size > 0
+      raise ArgumentError.new('Specify the argument. Argument is survey target root paths.')
+    end
+  end
+
+  def check_directory_exists_validation!(check_direcotry_roots)
+    check_direcotry_roots.each do |dir|
+      unless File.exists?(dir)
+        raise ArgumentError.new("No such directory: #{dir}")
+      end
+    end
+  end
 end

data/lib/duplicated_filename_checker/file_profile.rb

@@ -18,6 +18,6 @@ class DuplicatedFilenameChecker::FileProfile
   end
 
   def stat
-    File.stat path
+    File.stat @file_path
   end
 end

data/lib/duplicated_filename_checker/formatter.rb

@@ -0,0 +1,58 @@
+class DuplicatedFilenameChecker::Formatter
+  def initialize(result_of_duplicate_filename_checker_check_execute)
+    @duplicate_file_profiles = result_of_duplicate_filename_checker_check_execute
+  end
+
+  def exclude_basename(exclude_basename_regexp)
+    @exclude_basename_regexp = exclude_basename_regexp
+  end
+
+  def hash
+    duplicate_file_profiles_with_filter
+  end
+
+  def only_basename
+    duplicate_file_profiles_with_filter.keys
+  end
+
+  # @example
+  # ### duplicate_filename.sample
+  # 1. /Users/nagai_shinya/gem/duplicated_filename_checker/test/sample_for_test/dir_a1/duplicate_filename.sample
+  #  * md5: 5258bf47639b8f906c1a17aee86c54dd
+  #  * mtime: 2015-03-07 13:44:05 +0900
+  #
+  # 2. /Users/nagai_shinya/gem/duplicated_filename_checker/test/sample_for_test/dir_b1/dir_b2/duplicate_filename.sample
+  #  * md5: 5258bf47639b8f906c1a17aee86c54dd
+  #  * mtime: 2015-03-07 13:44:05 +0900
+  def markdown
+    duplicate_file_profiles_with_filter.map do |basename, duplicate_file_profiles|
+      [
+        "## #{basename}\n",
+        "#{file_profile_to_markdown(duplicate_file_profiles)}",
+      ]
+    end.flatten.join
+  end
+
+  private
+
+  def duplicate_file_profiles_with_filter
+    unless @exclude_basename_regexp
+      return @duplicate_file_profiles
+    end
+
+    @duplicate_file_profiles.select do |basename, _|
+      !(basename =~ Regexp.new(@exclude_basename_regexp))
+    end
+  end
+
+  def file_profile_to_markdown(duplicate_file_profiles)
+    duplicate_file_profiles.map.with_index(1) do |file_profile, index|
+      [
+        "#{index}. #{file_profile.path}\n",
+        " * md5: #{file_profile.md5_digest}\n",
+        " * mtime: #{file_profile.stat.mtime}\n",
+        "\n"
+      ]
+    end.join
+  end
+end

data/lib/duplicated_filename_checker/version.rb

@@ -1,3 +1,3 @@
 module DuplicatedFilenameChecker
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/test/test_check.rb

@@ -1,28 +1,69 @@
 require 'minitest_helper'
 
-class TestCheck < MiniTest::Unit::TestCase
-  def setup
-    survey_dir_path_1 = './test/sample_for_test/dir_a1'
-    survey_dir_path_2 = './test/sample_for_test/dir_b1'
-    @sample_filename  = 'duplicate_filename.sample'
+describe DuplicatedFilenameChecker::Check do
+  describe '#initialize' do
 
-    @check = DuplicatedFilenameChecker::Check.new(survey_dir_path_1, survey_dir_path_2)
+    describe 'arguments no given.' do
+      it 'raise' do
+        assert_raises(ArgumentError){ DuplicatedFilenameChecker::Check.new }
+      end
+    end
+
+    describe 'survey target  directory is no exists.' do
+      it 'raise' do
+        assert_raises(ArgumentError){ DuplicatedFilenameChecker::Check.new('/not_exists_dir') }
+      end
+    end
   end
 
-  def test_execute
-    duplicate_file_paths = @check.execute
+  describe '#execute' do
+    describe 'survey target has duplicate basename files' do
+      before do
+        survey_dir_path_1 = './test/sample_for_test/dir_a1'
+        survey_dir_path_2 = './test/sample_for_test/dir_b1'
+        @sample_filenames = ['duplicate_filename_1.sample', 'duplicate_filename_2.png']
+
+        @check = DuplicatedFilenameChecker::Check.new(survey_dir_path_1, survey_dir_path_2)
+        @check_result = @check.execute
+      end
+
+      it 'key is duplicate filename' do
+        assert @check_result.keys.any?{|basename| @sample_filenames.include? basename }
+      end
+
+      describe 'value is duplicate file profiles' do
+        before do
+          @profiles = @check_result.values
+        end
+
+        it 'prfiles is DuplicatedFilenameChecker::FileProfile' do
+          @profiles.flatten.each do |path|
+            assert path.class == DuplicatedFilenameChecker::FileProfile
+          end
+        end
 
-    assert(duplicate_file_paths.class == Hash)
+        it 'proflies.first all basename is same' do
+          @profiles.flatten.each do |path|
+            assert @sample_filenames.include? path.basename
+          end
+        end
 
-    # key is duplicate filename
-    basename = duplicate_file_paths.keys.first
-    assert(basename == @sample_filename)
+        it 'proflies.first path is different' do
+          paths = @profiles.flatten.map(&:path)
+          assert paths == paths.uniq
+        end
+      end
+    end
 
-    # value is duplicate file paths
-    filepaths = duplicate_file_paths.values.first
+    describe 'survey target has not duplicate basename file' do
+      before do
+        @check = DuplicatedFilenameChecker::Check.new('./test/sample_for_test/dir_a1')
+        @check_result = @check.execute
+      end
 
-    assert filepaths.all?{ |path| path.class == DuplicatedFilenameChecker::FileProfile }
-    assert filepaths.all?{ |path| path.basename == @sample_filename } # all basename is same
-    assert filepaths.map(&:path) == filepaths.map(&:path).uniq        # all path is different
+      it 'result is empty hash' do
+        assert @check_result == {}
+      end
+    end
   end
 end

data/test/test_file_profile.rb

@@ -2,7 +2,7 @@ require 'minitest_helper'
 
 class TestFileProfile < MiniTest::Unit::TestCase
   def setup
-    @sample_filename      = 'duplicate_filename.sample'
+    @sample_filename      = 'duplicate_filename_1.sample'
     @sample_relative_path = File.join('./test/sample_for_test/dir_a1/', @sample_filename)
     @sample_fullpath      = File.join(test_fullpath, 'sample_for_test/dir_a1/', @sample_filename)
     @sample_md5_digest    = '5258bf47639b8f906c1a17aee86c54dd'

data/test/test_formatter.rb

@@ -0,0 +1,54 @@
+require 'minitest_helper'
+
+describe DuplicatedFilenameChecker::Formatter do
+  before do
+    survey_dir_path_1 = './test/sample_for_test/dir_a1'
+    survey_dir_path_2 = './test/sample_for_test/dir_b1'
+    @sample_filename  = 'duplicate_filename_1.sample'
+
+    @check_result = DuplicatedFilenameChecker::Check.new(survey_dir_path_1, survey_dir_path_2).execute
+    @formatter = DuplicatedFilenameChecker::Formatter.new(@check_result)
+  end
+
+  describe '#hash' do
+    it 'like plain result' do
+      assert @formatter.hash == @check_result
+    end
+  end
+
+  describe '#only_basename' do
+    it 'show only basenames' do
+      assert @formatter.only_basename.sort == ['duplicate_filename_1.sample', 'duplicate_filename_2.png'].sort
+    end
+  end
+
+  describe '#markdown' do
+    it 'first line has ##' do
+      first_line = @formatter.markdown.split("\n")[0]
+      assert first_line =~ /##/
+    end
+
+    it 'first line has basname' do
+      first_line = @formatter.markdown.split("\n")[0]
+      puts @formatter.markdown
+      assert first_line =~ /#{@sample_filename}/
+    end
+
+    it 'second line has path' do
+      second_line = @formatter.markdown.split("\n")[1]
+      duplicate_file_list = @check_result.values.first
+      assert duplicate_file_list.any?{|file| second_line =~ /#{file.path}/ }
+    end
+  end
+
+  describe '#exclude_basename' do
+    before do
+      @formatter.exclude_basename('.sample')
+    end
+
+    it 'ignored specified basename' do
+      assert @formatter.only_basename == ['duplicate_filename_2.png']
+      assert @formatter.hash.keys == ['duplicate_filename_2.png']
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duplicated_filename_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shinya131
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,12 +73,16 @@ files:
 - lib/duplicated_filename_checker.rb
 - lib/duplicated_filename_checker/check.rb
 - lib/duplicated_filename_checker/file_profile.rb
+- lib/duplicated_filename_checker/formatter.rb
 - lib/duplicated_filename_checker/version.rb
 - test/minitest_helper.rb
-- test/sample_for_test/dir_a1/duplicate_filename.sample
-- test/sample_for_test/dir_b1/dir_b2/duplicate_filename.sample
+- test/sample_for_test/dir_a1/duplicate_filename_1.sample
+- test/sample_for_test/dir_a1/duplicate_filename_2.png
+- test/sample_for_test/dir_b1/dir_b2/duplicate_filename_1.sample
+- test/sample_for_test/dir_b1/dir_b2/duplicate_filename_2.png
 - test/test_check.rb
 - test/test_file_profile.rb
+- test/test_formatter.rb
 homepage: https://github.com/Shinya131/duplicated_filename_checker
 licenses:
 - MIT
@@ -105,7 +109,10 @@ specification_version: 4
 summary: This gem is check duplicated filename in multiple directory.
 test_files:
 - test/minitest_helper.rb
-- test/sample_for_test/dir_a1/duplicate_filename.sample
-- test/sample_for_test/dir_b1/dir_b2/duplicate_filename.sample
+- test/sample_for_test/dir_a1/duplicate_filename_1.sample
+- test/sample_for_test/dir_a1/duplicate_filename_2.png
+- test/sample_for_test/dir_b1/dir_b2/duplicate_filename_1.sample
+- test/sample_for_test/dir_b1/dir_b2/duplicate_filename_2.png
 - test/test_check.rb
 - test/test_file_profile.rb
+- test/test_formatter.rb