hexo_disqus_migrator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 190cc06190b2b89529f49d72291d72f7da02f96f
+  data.tar.gz: 5f392ca5ab4899290099964df764294af11cb7f0
+SHA512:
+  metadata.gz: dcd58da42cfa460fd0de234d1189954395495cb22fb91448b698a8d1afd6365ed83f4698960edf89b931ead562a5110b8f59e042c440a278976f982139224714
+  data.tar.gz: 18ee909d29eb20932e62ee39317dbf01ecab7c13e495f8144a9fbdf3d7bae36117cc942d31da9cdd79d17bb49d674f2574929bf0294a4ed0f65b61ab248554a4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TimNew
+
+MIT License
+
+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,55 @@
+hexo_disqus_migrator [![Gem version][gem-image]][gem-url] [![Dependency Status][depstat-image]][depstat-url]
+===============
+
+> [hexo_disqus_migrator] is a tool that help blogger to generate [Disqus Url Mapper] for your [Hexo] or [Octopress] blog
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hexo_disqus_migrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hexo_disqus_migrator
+
+## Usage
+
+    $ disqus_migrator post_links.csv
+
+For more detail about Disqus comments migartion, read [Disqus Url Mapper] document.
+
+For more detail about the tool, check out built-in help
+    
+    $ disqus_migrator help
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT
+
+[![Gem downloads][gem-downloads]][gem-url]
+
+[gem-image]: http://img.shields.io/gem/v/hexo_disqus_migrator.svg?style=flat
+[gem-url]: http://rubygems.org/gems/hexo_disqus_migrator
+[gem-downloads]: http://img.shields.io/gem/dtv/hexo_disqus_migrator.svg?style=flat
+
+[depstat-url]: https://gemnasium.com/timnew/hexo_disqus_migrator
+[depstat-image]: http://img.shields.io/gemnasium/timnew/hexo_disqus_migrator.svg?style=flat
+
+[hexo_disqus_migrator]: https://github.com/timnew/hexo_disqus_migrator
+[Disqus Url Mapper]: https://help.disqus.com/customer/portal/articles/912757-url-mapper
+[Hexo]: http://hexo.io/
+[Octopress]: http://octopress.org/
+
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/disqus_migrator

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'hexo_disqus_migrator'
+
+require 'commander/import'
+
+program :version, '0.0.1'
+program :description, 'Disqus comments migrator for Hexo'
+
+command :migrate do |c|
+  c.syntax = 'migrator migrate [options]'
+  c.summary = 'Generate Disqus URL mapping CSV'
+  c.description = ''
+  c.example 'description', 'command example'
+  c.option '-i', '--input FILE', 'The csv generated by Disqus'
+  c.option '-o', '--output FILE', 'Name pattern for generated CSV'
+  c.option '-r', '--reports overview, unconfident, excluded, invalid', Array, 'Reports to be displayed'
+  c.option '-R', '--report FILE', 'Write report to file'
+  c.option '-u', '--[no-]unconfidient', 'Do/Don\' generate unconfident migrations'
+  c.option '-c', '--[no-]confirm', 'Do/Don\'t confirm unconfident link one by one'
+  c.option '-b', '--[no-]invalid', 'Do/Don\' generate invalid migrations'
+  c.action do |args, options|
+    options.default input: 'links.csv',
+                    output: 'migration',
+                    overview: true,
+                    reports: %w(overview unconfident excluded invalid),
+                    report: nil,
+                    unconfidient: true,
+                    verify: true,
+                    invalid: false
+
+    migrator = Migrator.new(options.input)
+
+    migrator.migrate
+
+    report = ''
+    options.reports.each do |r|
+      case r.downcase[0].to_sym
+        when :o
+          report += migrator.overview_report.render
+        when :u
+          report += migrator.unconfident_report.render
+        when :e
+          report += migrator.excluded_report.render
+        when :i
+          report += migrator.invalid_report.render
+        else
+          log 'error', "Invalid report #{r}"
+      end
+    end
+
+    File.write options.report, report if options.report
+
+    if options.verify
+      migrator.confirm_unconfidents
+    end
+
+    migrator.write_confident options.output + '.csv'
+    migrator.write_unconfident options.output + '.unconfident.csv' if options.unconfidient
+    migrator.write_invalid options.output + '.invalid.csv' if options.invalid
+  end
+end
+
+default_command :migrate

data/hexo_disqus_migrator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hexo_disqus_migrator'
+  spec.version       = Migrator::VERSION
+  spec.authors       = ['TimNew']
+  spec.email         = ['timnew.wti@gmail.com']
+  spec.description   = %q{hexo_disqus_migrator is a tool that help blogger to generate Disqus Url Mapper for your Hexo or Octopress blog}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'commander', '~> 4.2.0'
+  spec.add_dependency 'terminal-table', '~> 1.4.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/hexo_disqus_migrator.rb

@@ -0,0 +1,10 @@
+require 'migrator/version'
+
+require 'CSV'
+require 'uri'
+require 'terminal-table'
+require 'commander'
+
+require 'migrator/rule'
+require 'migrator/mapping'
+require 'migrator/migrator'

data/lib/migrator/mapping.rb

@@ -0,0 +1,57 @@
+class Mapping
+  attr_reader :migrator, :url, :host, :path, :local_path, :basename
+
+  attr_accessor :new_url, :tags
+
+  attr_accessor :output, :confident
+  alias_method :output?, :output
+  alias_method :confident?, :confident
+
+  def new_path
+    new_url.path
+  end
+
+  def new_path=(path)
+    @new_url = URI(url.to_s)
+    @new_url.path = URI.escape(path)
+    @new_url
+  end
+
+  def new_local_path
+    Migrator.local_path new_path
+  end
+
+  def new_basename
+    File.basename new_path
+  end
+
+  def initialize(migrator, url_text)
+    @migrator = migrator
+
+    @url = URI(url_text)
+    @host = url.host
+    @path = url.path
+    @local_path = Migrator.local_path path
+    @basename = File.basename path
+
+    @tags = []
+    @new_url = @url
+    @confident = true
+    @output = false
+  end
+
+  def isnt?(tag)
+    !tags.include?(tag)
+  end
+  alias_method :isnt, :isnt?
+
+  def is?(tag)
+    tags.include?(tag)
+  end
+  alias_method :is, :is?
+
+  def execute
+    migrator.migrate_mapping self
+    self
+  end
+end

data/lib/migrator/migrator/class_methods.rb

@@ -0,0 +1,65 @@
+class Migrator
+  module ClassMethods
+
+    ROOT_PATH = File.join(Dir.pwd, 'public')
+    ROOT = Pathname.new ROOT_PATH
+    POSTS_FOLDER = Pathname.new File.join(Dir.pwd, 'source/_posts')
+
+    VERIFIER = Rule.new(:valid_checker, false) do
+      setup_match { |m| m.isnt?(:ignored) }
+      setup_action do |m|
+        local_file = Migrator.local_path m.new_path
+
+        if local_file.exist?
+          m.tags << :valid
+        else
+          m.tags << :invalid
+          m.output = false
+        end
+      end
+    end
+
+    FIX_CHECKER = Rule.new(:fix_checker, false) do
+      setup_match { |m| m.is?(:broken) }
+      setup_match { |m| m.isnt?(:fixed) }
+      setup_match { |m| Migrator.local_path(m.new_path).exist? }
+      setup_action do |m|
+        m.tags << :fixed
+        true
+      end
+    end
+
+    def root
+      ROOT
+    end
+
+    def posts
+      POSTS_FOLDER.each_child(false)
+    end
+
+    def local_path(path)
+      Pathname.new File.join(ROOT_PATH, path)
+    end
+
+    def to_url(path)
+      path[ROOT_PATH.length..-1]
+    end
+
+    def name_components(path)
+      base_name = File.basename(path)
+      base_name.split('-')
+    end
+
+    def verifier
+      VERIFIER
+    end
+
+    def delegate_to_class(*names)
+      names.each do |name|
+        define_method name do |*args|
+          self.class.send name, *args
+        end
+      end
+    end
+  end
+end

data/lib/migrator/migrator/outputs.rb

@@ -0,0 +1,59 @@
+class Migrator
+  module Outputs
+    include Commander::Methods
+
+    def write(type, filename, &filter)
+      puts "Write #{type} to file #{filename}"
+      CSV.open(filename, 'wb') do |csv|
+        data = mappings.select(&filter)
+        table_print data, "#{type} Entries", :basename, :tags
+        progress data do |mapping|
+          csv << [mapping.url.to_s, mapping.new_url.to_s]
+        end
+      end
+      puts
+    end
+
+    def write_confident(filename)
+      write('Confident', filename) do |m|
+        m.output? && m.confident?
+      end
+    end
+
+    def write_unconfident(filename)
+      write('Unconfident', filename) do |m|
+        m.output? && !m.confident?
+      end
+    end
+
+    def write_invalid(filename)
+      write('Invalid', filename) do |m|
+        m.is(:invalid)
+      end
+    end
+
+    def confirm_unconfidents
+      mappings.select { |m| m.output? and !m.confident? }.each do |m|
+        agreed = false
+        until agreed do
+          puts "Old: #{m.url}"
+          puts "New: #{m.new_url}"
+          agreed = agree('Okay to output?')
+
+          unless agreed
+            case choose("What to do?", :manual, :invalid, :cancel)
+              when :manual
+                m.new_url = ask('New Url:')
+              when :invalid
+                m.tags << :invalid
+                m.output = false
+                agreed = true
+              when :cancel
+                # do nothing
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/migrator/migrator/reports.rb

@@ -0,0 +1,37 @@
+class Migrator
+  module Reports
+    def table_print(data, title, *columns)
+      table = Terminal::Table.new do |t|
+        t.headings = columns
+        t.title = title
+        data.each do |mapping|
+          t.add_row columns.map { |c| mapping.send(c) }
+        end
+      end
+
+      puts table
+      puts
+
+      table
+    end
+
+    def overview_report
+      table_print mappings, 'Overview', :basename, :host, :tags, :output?, :confident?
+    end
+
+    def unconfident_report
+      data = mappings.select { |m| !m.confident? }
+      table_print data, 'Unconfident', :url, :new_url
+    end
+
+    def excluded_report
+      data = mappings.select { |m| !m.output? }
+      table_print data, 'Excluded', :basename, :host, :tags
+    end
+
+    def invalid_report
+      data = mappings.select { |m| m.is?(:invalid) }
+      table_print data, 'Invalid', :url, :tags, :new_path
+    end
+  end
+end

data/lib/migrator/migrator/rules.rb

@@ -0,0 +1,140 @@
+class Migrator
+  module Rules
+    RULES = []
+
+    def rules
+      RULES
+    end
+
+    def self.rule(*args, &block)
+      RULES << Rule.new(*args, &block)
+    end
+
+    rule(:ignored) do
+      setup_match { |m| m.host == 'localhost' }
+      setup_action do |m|
+        m.output = false
+        true
+      end
+    end
+
+    rule(:update_host) do
+      setup_match { |m| m.host != 'timnew.me' }
+      setup_action do |m|
+        m.output = true
+        false
+      end
+    end
+
+    rule(:normalize_url) do
+      regex = /\/\//
+      setup_match { |m| m.path =~ regex }
+      setup_action do |m|
+        m.output = true
+        m.new_path = m.new_path.gsub regex, '/'
+        false
+      end
+    end
+
+    rule(:broken) do
+      setup_match { |m| !m.new_local_path.exist? }
+      setup_action do |m|
+        m.output = false
+        false
+      end
+    end
+
+    rule(:fix_root) do
+      setup_match { |m| m.is?(:broken) }
+      setup_match do |m|
+        !m.new_path.start_with?('/blog/')
+      end
+
+      setup_action do |m|
+        m.new_path = m.new_path.gsub(/^\/[^\/]+\//, '/blog/')
+        m.output = true
+        FIX_CHECKER.apply(m)
+      end
+    end
+
+    rule(:time_stamp_url) do
+      setup_match { |m| m.is?(:broken) }
+      setup_match { |m| m.isnt?(:fixed) }
+
+      setup_match { |m| m.new_basename.match(/^\d\d\d\d-\d\d-\d\d-/) }
+
+      setup_action do |m|
+        m.new_path = m.new_path.sub(/\/\d\d\d\d-\d\d-\d\d-/, '/')
+        m.output = true
+        FIX_CHECKER.apply(m)
+      end
+    end
+
+    rule(:time_stamp_path, false) do
+      setup_match { |m| m.is?(:broken) }
+      setup_match { |m| m.isnt?(:fixed) }
+      setup_action do |m|
+        pattern = "*-#{m.basename}.md"
+        local_file = Migrator.posts.find { |f| f.fnmatch? pattern }
+
+        if local_file.nil?
+          false
+        else
+          m.tags << name
+          timestamp_path= local_file.basename.to_s.match(/^(\d\d\d\d-\d\d-\d\d)/).to_s.gsub(/-/, '/')
+
+          m.output = true
+          m.new_path = File.join('/', 'public', 'timestamp_path', m.basename.to_s)
+          FIX_CHECKER.apply(m)
+        end
+      end
+    end
+
+    rule(:auto_rename) do
+      setup_match { |m| m.is?(:broken) }
+      setup_match { |m| m.isnt?(:fixed) }
+
+      setup_match do |m|
+        parent = m.local_path.parent
+        parent.exist? and parent.children.length == 1
+      end
+
+      setup_action do |m|
+        m.new_path = Migrator.to_url m.local_path.parent.children.first.to_s
+        m.confident = false
+        m.output = true
+        FIX_CHECKER.apply(m)
+      end
+    end
+
+    rule(:fuzzy_rename) do
+      setup_match { |m| m.tags.include?(:broken) }
+
+      setup_match do |m|
+        parent = m.local_path.parent
+        parent.exist?
+      end
+
+      setup_action do |m|
+        components = Migrator.name_components(m.new_path)
+
+        fuzzy_matched = m.local_path.parent
+        .each_child
+        .sort_by do |candidate|
+          candidate_components = Migrator.name_components(candidate.to_s)
+          result = components & candidate_components
+          result.length
+        end
+        .reverse
+        .first
+
+        m.new_path = Migrator.to_url fuzzy_matched.to_s
+
+        m.confident = false
+        m.output = true
+        FIX_CHECKER.apply(m)
+      end
+    end
+
+  end
+end

data/lib/migrator/migrator.rb

@@ -0,0 +1,34 @@
+require 'migrator/rules'
+require 'migrator/class_methods'
+require 'migrator/reports'
+require 'migrator/outputs'
+
+class Migrator
+  extend Rules
+  extend ClassMethods
+
+  include Reports
+  include Outputs
+
+  delegate_to_class :root, :local_path, :to_url, :rules, :verifier
+
+  attr_reader :mappings
+
+  def initialize(csv_file)
+    @mappings = CSV.open(csv_file)
+    .map { |row| Mapping.new(self, row[0]) }
+  end
+
+  def migrate_mapping(mapping)
+    rules.find do |rule|
+      rule.apply(mapping)
+    end
+    verifier.apply(mapping)
+  end
+
+  def migrate
+    mappings.map do |mapping|
+      mapping.execute
+    end
+  end
+end

data/lib/migrator/rule.rb

@@ -0,0 +1,33 @@
+
+class Rule
+  attr_reader :name, :auto_tag
+
+  def initialize(name, auto_tag = true, &block)
+    @name = name
+    @auto_tag = auto_tag
+    @match_blocks = []
+    instance_eval &block
+  end
+
+  def apply(mapping)
+    return false unless match?(mapping)
+    act(mapping)
+  end
+
+  def setup_match(&block)
+    @match_blocks << block
+  end
+
+  def match?(mapping)
+    @match_blocks.all? {|b| b.call(mapping) }
+  end
+
+  def setup_action(&block)
+    @action_block = block
+  end
+
+  def act(mapping)
+    mapping.tags << name if auto_tag
+    @action_block.call(mapping)
+  end
+end

data/lib/migrator/version.rb

@@ -0,0 +1,3 @@
+module Migrator
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: hexo_disqus_migrator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TimNew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: 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'
+description: hexo_disqus_migrator is a tool that help blogger to generate Disqus Url
+  Mapper for your Hexo or Octopress blog
+email:
+- timnew.wti@gmail.com
+executables:
+- disqus_migrator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/disqus_migrator
+- hexo_disqus_migrator.gemspec
+- lib/hexo_disqus_migrator.rb
+- lib/migrator/mapping.rb
+- lib/migrator/migrator.rb
+- lib/migrator/migrator/class_methods.rb
+- lib/migrator/migrator/outputs.rb
+- lib/migrator/migrator/reports.rb
+- lib/migrator/migrator/rules.rb
+- lib/migrator/rule.rb
+- lib/migrator/version.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: hexo_disqus_migrator is a tool that help blogger to generate Disqus Url Mapper
+  for your Hexo or Octopress blog
+test_files: []