deadlink 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb5e6436cde33615811d3788e82efa4aae463b0b
-  data.tar.gz: c4b3acda36bf178319b056384504370b5fa22802
+  metadata.gz: 7538d034a5581e58ea5b20677fcf57ef79a79297
+  data.tar.gz: d5cab5c98c9546972f54ee9148aa6d276294d923
 SHA512:
-  metadata.gz: bafda7f50283eb4ecc701de7bcf60436697dc5611da533e7dcff1044fdd04804089ccb3a7b324898f5e32770c6ecaf1cd02594494b884670601ba3ddfd3c6151
-  data.tar.gz: a7e9dc7d73724d5af0eb690a1ec90a94b3cfadf017b4254d4f2e3fea6f26e77ae511323d0a178e46045a9f7bd36fb8170557a544fd5d4338a30fab0f62ad6a1d
+  metadata.gz: f5a53cb6ee7664b250e60c8aedc052c97af63afd3fd4a2accc6c225b4645bc8dc96c058a5fb0ab918712fc5c60eb7fbfa8b6f3bf2f7f54c44cef54234b2c0480
+  data.tar.gz: 9c7fccd5a8a65db23b05f2a1eb72c85967e13d44e43d64605eb9ef6f284e1b7e363a1c99704698232544a570e1bf9a263a092567dd6d0d19fd59b4cd2cf3d49c

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.2
-
+- 2.2.2
 before_install: gem install bundler -v 1.10.6
-
 cache: bundler
-
 notifications:
-  email: false
+  email: false
+  slack:
+    secure: wXu1Ozr6IS53djD3ISOALmVx2DTgpnHstFdCi+COtbFXEQgskF2R2esAfd22k3/muWdmOE4pyPzQ8kljOjBnP+9uupBfkt+U50ZKry1M4Hygy7hbUES+iUpjxKnF6RvmEodrQ8H9vFQi6Ookeh3x5cEiUyikJ72XDLPd17gpd0AhvwcH2dqBDq7AgJU/BqgM8MF/87k1O9sLrQd8ED9zHBG6fj0SLPy4EzkbF9NpkmMnzjDNbliuQ1Q5ty0Uhe4GfJFAQ3FBbOOjL2LLpohxuJHLV0JI7VixwAYz+3N8Xl5+t2CSYVf1BTEZKMPa7kQ64hy8EQLMW0b6tghcHE0LLNzh83euIYO/ayCQ5s9urjZbZFn2Q0QUPj7RPbGMKtdO9h2OVyM1PMZqLLEvEw9rmxEDN42sPczgagZmiGd7xwhxavwT2qXlg0K2aLXmgOqTEOc/yDwrKXz4/5f+Vw2b0BOhOQlf2M6D8x3xIF2MqCdkm+lCcTh3Nxn2Vlh2z6YmuPbvFxrhzEMFjSY9kYSzqiBFt7K9flDRqpWWAVLn9ra2rScyEhS4+tA/CLBi4zt6cP7T+AUVsi8hZLPbz6j7iiLdRag7SXpv34nxuB9rJdo3DK45zr5MfpDEvgFUu2930gbNidb03yOzm7k/YwbvabQGoWnXpMCEuYwYPC7Txoc=
+    on_success: change
+    on_failure: change

data/README.md

@@ -29,7 +29,6 @@ $ deadlink deadlink/
 result is this
 
 ```
-example.md#title1 in ./README.md line: 43
 contributor-covenant.org in ./README.md line: 73
 nothing_file3.md in ./test/files/dir1/nest_file1.md line: 2
 dir1/nothing_nest_file2.md in ./test/files/top.md line: 3
@@ -42,10 +41,7 @@ nothing.txt in ./test/files/top.md line: 8
 this gem not check following patterns yet. applying these patterns to gem is future task.
 
 - http(s) link
-- anchor link ( only check file path part )
-  - e.g. `[anhor link](example.md#title1)` => check example.md 
 - multibyte characters
-- specify file.
 
 ## Installation
 
@@ -53,7 +49,7 @@ this gem not check following patterns yet. applying these patterns to gem is fut
 
 ## Usage
 
-specify path of directory
+### specify path of directory
 
 ```
 $ deadlink <dir>
@@ -71,6 +67,12 @@ if you not specify `<dir>` path, deadlink scan top directory of current git repo
 $ deadlink
 ```
 
+### specify a file
+
+```
+$ deadlink <file path>
+```
+
 ### Option
 
 `-p` option output for editor. In this repository case

data/deadlink.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "minitest-reporters"
 
 end

data/lib/deadlink/md_file.rb

@@ -0,0 +1,42 @@
+module Deadlink
+  class MdFile
+
+    attr_reader :path, :headers, :link_paths
+    
+    def initialize(file_path, repo_root)
+      @path = file_path
+      @headers = []
+      @link_paths = []
+      init(repo_root)
+    end
+    
+    private
+    
+    def init(repo_root)
+      File.open(@path) do |f|
+        f.each_with_index do |line,index|
+          attribute(line, index, repo_root)
+        end
+      end
+    end
+
+    def attribute(line, index, repo_root)
+      if line =~ heading_pattern # capture sharp header part
+        header = Regexp.last_match[:header].downcase.rstrip.gsub(/\s+/," ")
+        @headers.push header.gsub(" ", "-")
+      end
+      line.scan link_pattern do |link| # capthure links path part
+        @link_paths.push Path.new(@path, link[0], index + 1, repo_root)
+      end
+    end
+
+    def heading_pattern
+      /^\#{1,6} +(?<header>.+)/
+    end
+
+    def link_pattern
+      /\[[^\]]*\]\((?<link>[^)]+)\)/
+    end
+    
+  end
+end

data/lib/deadlink/md_files.rb

@@ -0,0 +1,27 @@
+require 'forwardable'
+
+module Deadlink
+  class MdFiles
+
+    include Enumerable
+    extend Forwardable
+    def_delegators :@files,:[],:empty?, :each
+
+    def initialize(files)
+      @files = files
+    end
+    
+    def header_include?(path, anchor)
+      file = find_by(path)
+      return file.headers.include?(anchor) unless file.nil?
+      false
+    end
+    
+    private
+
+    def find_by(path)
+      @files.each { |file| return file if file.path == path }
+    end
+    
+  end
+end

data/lib/deadlink/path.rb

@@ -1,7 +1,7 @@
 module Deadlink
   class Path
 
-    attr_reader :link, :cur_file_path, :index
+    attr_reader :cur_file_path, :link, :index, :anchor
 
     def initialize(cur_file_path, link, index, repo_root)
       @cur_file_path = cur_file_path
@@ -12,23 +12,29 @@ module Deadlink
       hash = split_link(link)
       @link_file_path = hash[:filepath]
       @anchor = hash[:anchor]
-    end
 
-    def deadlink?
-      !FileTest.exist?(abusolute_path) && ignore 
+      @abusolute_link_file_path = abusolute_link_file_path
     end
 
+    def deadlink?(files)
+      (not_exist? || anchor_invalid?(files)) && not_ignore?
+    end
+    
     private
 
-    def ignore
-      !url?
+    def anchor_invalid?(files)
+      return false if @anchor.empty?
+      if @link_file_path.empty?
+        return !files.header_include?(@cur_file_path, @anchor)
+      end
+      !files.header_include?(@abusolute_link_file_path, @anchor)
     end
-
-    def url?
-      @link =~ /https?:\/\/[\S]+/
+    
+    def exist?
+      FileTest.exist?(@abusolute_link_file_path)
     end
     
-    def abusolute_path
+    def abusolute_link_file_path
       if specify_root?(@link_file_path)
         return File.join(@repo_root, @link_file_path)
       else
@@ -38,12 +44,30 @@ module Deadlink
 
     def split_link(link)
       # split <filenpath>#<anchor>
-      hash = link.match(/(?<filepath>[^#]*)#*(?<anchor>.*)/)
+      link.match(/(?<filepath>[^#]*)#*(?<anchor>.*)/)
     end
 
     def specify_root?(path)
       path[0] == "/"
     end
 
+    def ignore?
+      url?
+    end
+
+    def url?
+      @link =~ /https?:\/\/[\S]+/
+    end
+
+    ## negative wrap 
+    
+    def not_exist?
+      !exist?
+    end
+
+    def not_ignore?
+      !ignore?
+    end
+    
   end
 end

data/lib/deadlink/paths.rb

@@ -3,11 +3,14 @@ module Deadlink
 
     attr_reader :deadlinks
 
-    def initialize(paths)
-      @paths = paths
-      @deadlinks = paths.select { |path| path.deadlink? }
-    end
+    def initialize(files)
+      @files = files
+      @paths = []
+      @files.each { |file| @paths.concat(file.link_paths) }
 
+      @deadlinks = @paths.select { |path| path.deadlink?(@files) }
+    end
+    
     def deadlink_include?
       @deadlinks.any?
     end

data/lib/deadlink/scanner.rb

@@ -15,34 +15,33 @@ module Deadlink
         puts @target_path + ": No such file or directory"
         return false
       end
-      return true
+      true
     end
 
     def md_files
+      files = []
       if File.directory?(@target_path)
-        Dir.glob(File.join(@target_path, '/**/*.{md,markdown}'))
+        glob do |file_path| 
+          files.push(MdFile.new(file_path, @repo_root))
+        end
       else
-        files = []
-        files.push(@target_path)
+        files.push(MdFile.new(@target_path, @repo_root))
       end
+      MdFiles.new(files)
     end
 
     def paths(files)
-      paths = []
-      files.each do |file|
-        File.open(file) do |f|
-          f.each_with_index do |line, index|
-            line.scan /\[[^\]]*\]\(([^)]+)\)/ do |link|
-              paths.push Path.new(f.path, link[0], index + 1, @repo_root)
-            end
-          end
-        end
-      end
-      Paths.new(paths)
+      Paths.new(files)
     end
 
     private
 
+    def glob
+      Dir.glob(File.join(@target_path, '/**/*.{md,markdown}')) do |file_path|
+        yield file_path
+      end
+    end
+    
     def repo_root(target_path)
       dir = target_path
       until dir.empty? do

data/lib/deadlink/version.rb

@@ -1,3 +1,3 @@
 module Deadlink
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/deadlink.rb

@@ -1,8 +1,12 @@
 require "deadlink/version"
 require 'deadlink/scanner'
+require 'deadlink/md_file'
 require 'deadlink/path'
 require 'deadlink/paths'
 require 'deadlink/decorator'
+require 'deadlink/md_files.rb'
+
+
 require 'optparse'
 
 module Deadlink

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deadlink
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - yutakakinjyo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
 description: check deadlink from markdown file in your git repository
 email:
 - yutakakinjyo@gmail.com
@@ -87,6 +101,8 @@ files:
 - exe/deadlink
 - lib/deadlink.rb
 - lib/deadlink/decorator.rb
+- lib/deadlink/md_file.rb
+- lib/deadlink/md_files.rb
 - lib/deadlink/path.rb
 - lib/deadlink/paths.rb
 - lib/deadlink/scanner.rb