deadlink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8934c98c596784a15c40112a43895da912885596
+  data.tar.gz: 7bf9ffbc09c3f3f8dc588fb9ce49d27137dcbbf1
+SHA512:
+  metadata.gz: 7a7405ebc139388902b768248054bc8bfe3211aa00d75b712c834d04c1710eaa3f3ac5bb6dc16117c3563a69c489c402b0a387c2c5d39d4101a3764e653ba261
+  data.tar.gz: 0752e347503050eeb59d81f282392595246c56888b0088eadfa152469c399d49214953fac7cdae7fae821532539dd70dbba50c7760248cd1c21389ec8e7311d9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6
+
+notifications:
+  email: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deadlink.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 yutakakinjyo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Deadlink
+
+[![Build Status](https://travis-ci.org/yutakakinjyo/deadlink.svg?branch=master)](https://travis-ci.org/yutakakinjyo/deadlink)
+
+Check **deadlink** of markdown files in your git repository.
+
+**Example**
+
+`$ ls`
+
+`git_repo`
+
+`$ deadlink git_repo`
+
+show deadlink info.
+
+`<deadlink> in <md file path> line: <line number>`
+
+case of this repository
+
+```
+$ git clone git@github.com:yutakakinjyo/deadlink.git
+$ cd 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
+nothing_dir in ./test/files/top.md line: 5
+nothing.txt in ./test/files/top.md line: 8
+```
+
+## not check patterns
+
+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
+
+`$ gem install deadlink`
+
+## Usage
+
+specify path of directory
+
+```
+$ deadlink <dir>
+```
+
+if your not specify <dir> path, `.` path is specfied. 
+
+```
+$ deadlink => $ deadlink .
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yutakakinjyo/deadlink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deadlink"
+
+# 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

data/bin/setup

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

data/deadlink.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deadlink/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deadlink"
+  spec.version       = Deadlink::VERSION
+  spec.authors       = ["yutakakinjyo"]
+  spec.email         = ["yutakakinjyo@gmail.com"]
+
+  spec.summary       = %q{check deadlink from markdown file in your git repository}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/yutakakinjyo/deadlink"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+end

data/exe/deadlink

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'deadlink'
+
+target_dir = ARGV[0].nil? ? '.' : ARGV[0]
+Deadlink.scan(target_dir)

data/lib/deadlink.rb

@@ -0,0 +1,13 @@
+require "deadlink/version"
+require 'deadlink/scanner'
+require 'deadlink/path'
+require 'deadlink/paths'
+
+module Deadlink
+  def self.scan(target_dir)
+    scanner = Scanner.new(target_dir)
+    files = scanner.md_files
+    paths = scanner.paths(files)
+    paths.print_deadlinks
+  end
+end

data/lib/deadlink/path.rb

@@ -0,0 +1,51 @@
+module Deadlink
+  class Path
+    def initialize(file_path, link, index)
+      @file_path = file_path
+      @link = link
+      @index = index
+    end
+
+    def deadlink
+      puts @link + ' in ' + @file_path + ' line: ' + @index.to_s if deadlink?
+    end
+
+    def deadlink?
+      !exist? && ignore 
+    end
+
+    private
+    
+    def exist?
+      File.exist?(link_path) || Dir.exist?(link_path)
+    end
+
+    def ignore
+      !url?
+    end
+
+    def url?
+      @link =~ /https?:\/\/[\S]+/
+    end
+
+    def link_path
+      # split path ; <filename>#<title>
+      cap = @link.match(/(?<filelink>[^#]*)#*(?<anchor>.*)/)
+      if cap[:filelink][0] == "/"
+        return File.join(repo_root, cap[:filelink])
+      end
+
+      File.expand_path(cap[:filelink], File.dirname(@file_path))
+    end
+
+    def repo_root
+      dir = File.dirname(@file_path)
+      while(!dir.empty?) do
+        return dir if Dir.exist?(File.join(dir, ".git"))
+        dir = File.expand_path("../", dir)
+      end
+      dir
+    end
+
+  end
+end

data/lib/deadlink/paths.rb

@@ -0,0 +1,29 @@
+module Deadlink
+  class Paths
+    def initialize(paths)
+      @paths = paths
+      @deadlinks = paths.select { |path| path.deadlink? }
+    end
+
+    def deadlink_include?
+      @deadlinks.any?
+    end
+
+    def deadlinks
+      @deadlinks
+    end
+
+    def print_deadlinks
+      @paths.each { |path| path.deadlink }
+    end
+
+    def count
+      @paths.count
+    end
+
+    def [](i)
+      @paths[i]
+    end
+
+  end
+end

data/lib/deadlink/scanner.rb

@@ -0,0 +1,25 @@
+module Deadlink
+  class Scanner
+    def initialize(target_dir)
+      @target_dir = target_dir
+    end
+
+    def md_files
+      Dir.glob(File.join(@target_dir, '/**/*.md'))
+    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)
+            end
+          end
+        end
+      end
+      Paths.new(paths)
+    end
+  end
+end

data/lib/deadlink/version.rb

@@ -0,0 +1,3 @@
+module Deadlink
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: deadlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yutakakinjyo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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
+executables:
+- deadlink
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deadlink.gemspec
+- exe/deadlink
+- lib/deadlink.rb
+- lib/deadlink/path.rb
+- lib/deadlink/paths.rb
+- lib/deadlink/scanner.rb
+- lib/deadlink/version.rb
+homepage: https://github.com/yutakakinjyo/deadlink
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: check deadlink from markdown file in your git repository
+test_files: []