rowr 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fea7df6d4e1adb7ebe5a92dc53bdbc19002171d
+  data.tar.gz: e29245ead1eedb69de5b92626cf3e4759bf03a74
+SHA512:
+  metadata.gz: 064b7ec66b949cec8b6d9fc323ac8268b3a4c2736732ae916afb49559e53200879f25b59bbbb797555397acc23f2ea3875245d1283524fae7bcb6d358ac1e097
+  data.tar.gz: 0d535ab043e508d36b9238f33cb9b41cbf7c8f564bdda59c52a10afb62147c661e53897f9dc92eb5d599c6e66262c6ace2ddf690f5c0f49b62e50d388eaf4b29

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lukeaeschleman@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# ROWR: Really Old Website Resurrector
+
+[![Build Status](https://travis-ci.org/UNC-Libraries/ROWR.svg?branch=master)](https://travis-ci.org/UNC-Libraries/ROWR)
+
+It's basically link find/replace tool for a really old websites. ROWR will parse through your site files and look for any
+broken links. When it finds one, it will prompt you to either replace, remove, 
+ROWR takes a really old website, one that might be living on a cd flash drive for archival purposes, and allows you to clean up
+any broken links.
+
+## Installation
+
+After installing ruby, add `gem 'rowr'` to your application's Gemfile or run the following from the command line:
+
+    $ gem install rowr
+
+## Usage
+
+`rowr start` Start the script, will prompt you for information about the really old site.
+While running, you can always prematurely stop the script with CMD+C or CTRL+C.
+
+`rowr continue` Continue where you left off.
+ 
+`rowr reset` Destroy all changes made and restart the process.  
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/UNC-Libraries/ROWR/issues.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/).
+

data/bin/setup

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

data/exe/rowr

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rowr/command_line'
+
+result = Rowr::CommandLine.start( ARGV )
+
+exit 1 unless result # non-zero exit status on process telling us there's problems.

data/lib/rowr.rb

@@ -0,0 +1,20 @@
+require 'rowr/version'
+require 'rowr/zipper'
+require 'rowr/resurrector'
+require 'rowr/prompter'
+require 'rowr/printer'
+require 'rowr/link_processor'
+require 'rowr/state_saver'
+require 'fileutils'
+require 'faraday'
+require 'slop'
+require 'thor'
+require 'tty-prompt'
+require 'json'
+require 'yaml'
+require 'zip'
+require 'zip/zip_file_generator'
+
+module Rowr
+
+end

data/lib/rowr/command_line.rb

@@ -0,0 +1,61 @@
+require 'rowr'
+require 'tty-prompt'
+
+module Rowr
+
+  class CommandLine < Thor
+
+    desc 'start',
+         'resurrect a really old website'
+
+    def start
+      rowr = Rowr::Resurrector.new
+      rowr.start
+    end
+
+    desc 'continue',
+         'continue resurrecting'
+
+    def continue
+      rowr = Rowr::Resurrector.new
+      rowr.continue
+    end
+
+    desc 'reset',
+         'restart the really old website resurrection'
+
+    def reset
+      rowr = Rowr::Resurrector.new
+      rowr.reset
+    end
+
+    desc 'test <file>',
+         'test the resurrector on a single file'
+
+    def test(file)
+      return unless File.exist? File.expand_path(file)
+
+      f = File.expand_path(file)
+      rowr = Rowr::Resurrector.new
+
+      rowr.options.source_directory = File.dirname(f)
+      rowr.prompt_user_for_option 'old_host?'
+      rowr.prompt_user_for_option 'new_base_path?'
+      rowr.prompt_user_for_option 'check_external_urls?'
+
+      rowr.init_link_processor
+
+      rowr.link_processor.containing_file = f
+
+      text = File.read(f)
+      unless text.valid_encoding?
+        text = text.encode('UTF-16be', :invalid=>:replace, :replace=>'&nbsp;').encode('UTF-8')
+      end
+      text = rowr.clean_no_quotes(text)
+      rowr.check_urls(text)
+
+    end
+
+  end
+
+end

data/lib/rowr/link_processor.rb

@@ -0,0 +1,234 @@
+require 'rowr'
+
+module Rowr
+
+  class LinkProcessor
+
+    attr_reader   :local_site_dir
+    attr_reader   :old_domain
+    attr_accessor :new_base_path
+    attr_accessor :cached
+    attr_reader   :link_to_check
+    attr_accessor :containing_file
+    attr_reader   :target_file
+
+    def initialize(src_dir, old_domain = nil, new_base_path = nil, check_external_urls = true, cached = {})
+      @printer = Rowr::Printer.new
+      @prompt = TTY::Prompt.new(active_color: :cyan)
+      @pastel = Pastel.new
+      @local_site_dir = src_dir
+      @old_domain = old_domain
+      @new_base_path = new_base_path
+      @check_external_urls = check_external_urls
+      @cached = cached
+    end
+
+    ################################
+    # Attributes
+    ################################
+    def link_to_check=(value)
+      if external?(value)
+        @link_to_check = value
+      else
+        value.sub!(old_url_regex, '') if @old_domain
+        if value.start_with?('/')
+          @link_to_check = value.sub(%r{(^/)}, '')
+          @target_file = File.expand_path(File.join(@local_site_dir, @link_to_check))
+        else
+          @link_to_check = File.dirname(@containing_file).sub(@local_site_dir, '') + '/' + value
+          @link_to_check.sub!(%r{(^/)}, '')
+          @target_file = File.expand_path(File.join(File.dirname(@containing_file), value))
+        end
+      end
+    end
+
+    def old_url_regex
+      %r{^(https?://|//)#{@old_domain}}i if @old_domain
+    end
+
+    ################################
+    # Checkers
+    ################################
+
+    def external?(link)
+      !old_uri?(link) && uri?(link) ? true : false
+    end
+
+    def old_uri?(link)
+      if @old_domain
+        link =~ old_url_regex
+      else
+        false
+      end
+    end
+
+    def uri?(link)
+      link =~ %r{^(https?:|//)}i
+    end
+
+    def in_cache?
+      @cached.key?(link_key)
+    end
+
+    def response_code(link)
+      begin
+        res = Faraday.get link
+        return res.status
+      rescue
+        return 0
+      end
+    end
+
+    def trim_hash(file)
+      file.sub(/#(.*?)$/,'')
+    end
+
+    def target_file_exists?
+      File.exist?(trim_hash(@target_file))
+    end
+
+    def broken_external_link?
+      res = response_code(@link_to_check)
+      res > 399 || res < 200
+    end
+
+    def is_valid_replacement?(link)
+      if uri?(link)
+        res = response_code(link)
+        res < 400 || res > 199
+      else
+        File.exist?(File.join(@local_site_dir, link))
+      end
+    end
+
+    ################################
+    # Misc
+    ################################
+
+    def link_key
+      @link_to_check.to_sym
+    end
+
+    def add_to_cache(new_link)
+      @cached[link_key] = new_link
+    end
+
+    def recommend_files
+      Dir.glob("#{@local_site_dir}/**/{#{File.basename(@target_file)}}").map! do |f|
+        f.sub(@local_site_dir,'')
+      end
+    end
+
+    def prepend_new_base_path(link)
+      check = @new_base_path[1..-1].chop
+      new_link = link.sub(%r{^/?#{check}},'')
+      new_link = new_link.sub(/^\//,'')
+      @new_base_path + new_link
+    end
+
+    ################################
+    # Processors
+    ################################
+
+    def process_link
+      @new_base_path + @link_to_check if target_file_exists?
+    end
+
+    def process_broken_link
+      return cached[link_key] if in_cache?
+      replacement = nil
+      @printer.print_broken_link_warning @containing_file, @link_to_check
+      replacement = ask_recommended_files unless recommend_files.empty?
+      replacement = ask_wtd unless replacement
+      ask_to_cache(replacement)
+      replacement
+    end
+
+    def process_external
+      return nil unless @check_external_urls && broken_external_link?
+      @printer.print_broken_link_warning @containing_file, @link_to_check
+      replacement = ask_wtd
+      ask_to_cache(replacement)
+      replacement
+    end
+
+    def process(link, file = nil)
+      @containing_file = file if file
+      self.link_to_check = link
+
+      if external?(@link_to_check)
+        replacement = process_external
+      else
+        replacement = process_link
+        replacement = process_broken_link unless replacement
+      end
+      replacement
+    end
+
+    ################################
+    # Asks
+    ################################
+
+    def ask_recommended_files
+      @printer.print_line ' I found some matching files ', '+', :blue
+      recommended_files = recommend_files
+      choice = @prompt.select(
+          'Would you like to replace the broken link with any of the following?',
+          recommended_files + ['None of these match'],
+          per_page: 10
+      )
+      choice == 'None of these match' ? nil : prepend_new_base_path(choice)
+    end
+
+    def ask_to_cache(new_link)
+      case new_link
+      when nil
+        message = "SKIP all instances of " + @pastel.green("#{@link_to_check}") + "?"
+      when '#'
+        message = "REMOVE all instances of " + @pastel.green("#{@link_to_check}") + "?"
+      else
+        message = "REPLACE all instances of " + @pastel.green("#{@link_to_check}") + " with " + @pastel.blue("#{new_link}") + "?"
+      end
+      add_to_cache(new_link) if @prompt.yes?(message)
+    end
+
+    def ask_wtd
+      @printer.line_break 0
+      wtd = @prompt.enum_select"What would you like to do?" do |menu|
+        menu.default 1
+
+        menu.choice 'Enter a new link', 1
+        menu.choice 'Remove the link', 2
+        menu.choice 'Skip', 3
+      end
+
+      case wtd
+      when 1
+        ask_new_link
+      when 2
+        '#'
+      when 3
+        nil
+      end
+    end
+
+    def ask_new_link
+      new_link = @prompt.ask('Enter the replacement:')
+      unless is_valid_replacement?(new_link)
+        if uri?(new_link)
+          @prompt.error("Sorry, the url you've provided is not returning a 200 status code")
+        else
+          @prompt.error('Sorry, that file does not exist')
+        end
+        new_link = ask_new_link
+      end
+
+      if uri?(new_link)
+        new_link
+      else
+        prepend_new_base_path(new_link)
+      end
+    end
+
+  end
+end

data/lib/rowr/printer.rb

@@ -0,0 +1,64 @@
+require 'rowr'
+
+module Rowr
+
+  class Printer
+
+    def initialize(line_length = 50)
+      @pastel = Pastel.new
+      @line_length = line_length
+    end
+
+    def line(text = '', char = '~')
+      message = text.to_s
+      return message if too_long?(message)
+
+      waves = char * ((@line_length - message.length) / 2).ceil
+      output = "#{waves}#{message}#{waves}"
+      output + (char * (50 - output.length))
+    end
+
+    def too_long?(string)
+      string.length > @line_length
+    end
+
+    def line_break(duration)
+      puts "\n"
+      sleep(duration)
+    end
+
+    def print_line(message = nil, char = '~', color = 'green')
+      puts @pastel.send(color.to_sym, line(message, char))
+    end
+
+    def print_intro
+      print_line
+      print_line ' ROWR! '
+      print_line
+      line_break 1
+    end
+
+    def print_outro
+      print_line
+      print_line " You're all done! "
+      print_line
+      print_line ' rowr... '
+      print_line
+    end
+
+    def print_broken_link_warning(file, link)
+      line_break 0
+      print_line '', '!', 'yellow'
+      print_line ' Broken Link ', '!', 'yellow'
+      puts @pastel.magenta.bold('File: ', @pastel.red(file))
+      puts @pastel.magenta.bold('Link: ', @pastel.green(link))
+    end
+
+    def print_file_header(file)
+      print_line ' FILE ', '*', 'cyan'
+      print_line " #{file} ", '*', 'cyan'
+      print_line '', '*', 'cyan'
+    end
+
+  end
+end

data/lib/rowr/prompter.rb

@@ -0,0 +1,113 @@
+require 'rowr'
+
+module Rowr
+
+  class Prompter
+
+    attr_reader     :source_directory
+    attr_reader     :exts_to_use
+    attr_reader     :old_host
+    attr_reader     :new_base_path
+    attr_accessor   :check_external_urls
+
+    def initialize
+      @prompt = TTY::Prompt.new
+    end
+
+    def source_directory=(value)
+      dir = File.expand_path(value)
+      @source_directory = dir if Dir.exist?(dir)
+    end
+
+    def old_host=(value)
+      if value.to_s.empty?
+        @old_host = false
+      else
+        @old_host = value.chomp('/').chomp('/').sub(%r{https?://}, '')
+      end
+    end
+
+    def exts_to_use=(value)
+      exts = []
+      if value
+        exts = value.split
+        exts.map! { |e| e.start_with?('.') ? e[1..-1] : e } if exts.is_a?(Array)
+      end
+      exts = %w(htm html) + exts
+      @exts_to_use = exts.uniq
+    end
+
+    def new_base_path=(value)
+      clean = ''
+      unless value.to_s.empty?
+        clean = value.sub(%r{https?://(.*?)(/|$)}, '')
+        clean = clean.split('/')
+        clean = clean.reject(&:empty?)
+        clean.shift if clean.first =~ /\./
+        clean = clean.join('/')
+      end
+      @new_base_path = clean.to_s.empty? ? '/' : "/#{clean}/"
+    end
+
+    def dir_select
+      @prompt.select('Where is this really old website?') do |menu|
+        menu.default 1
+
+        menu.choice "#{Dir.pwd} (The current dir)", 1
+        menu.choice "Another directory?", 2
+      end
+    end
+
+    def ask_for_other_source_directory
+      dir = @prompt.ask('Please type in the path to that directory?') do |q|
+        q.required true
+      end
+      unless Dir.exist?(File.expand_path(dir))
+        @prompt.error("Sorry, #{dir} doesn't seem to exist")
+        ask_for_other_source_directory
+      end
+      dir
+    end
+
+    def old_host?
+      self.old_host = @prompt.ask('What was the old host? (e.g. www.google.com)')
+    end
+
+    def source_directory?
+      self.source_directory = case dir_select
+                              when 1
+                                Dir.pwd
+                              when 2
+                                ask_for_other_source_directory
+                              end
+    end
+
+    def additional_exts?
+      @prompt.say('By default, I\'ll will scan any .html and .htm files.')
+      self.exts_to_use  = @prompt.ask('Please list any other extensions, or hit Enter to skip')
+    end
+
+    def new_base_path?
+      self.new_base_path = @prompt.ask('What will be the url of the resurrected site?')
+    end
+
+    def check_external_urls?
+      self.check_external_urls = @prompt.select('If I find an link to an external site, what should I do?') do |menu|
+        menu.default 1
+
+        menu.choice 'Ask me about it', true
+        menu.choice 'Skip it', false
+      end
+    end
+
+    def generate_hash
+      {
+        source_directory: source_directory,
+        exts_to_use: exts_to_use,
+        old_host: old_host,
+        new_base_path: new_base_path,
+        check_external_urls: check_external_urls
+      }
+    end
+  end
+end

data/lib/rowr/resurrector.rb

@@ -0,0 +1,183 @@
+require 'rowr'
+
+module Rowr
+
+  class Resurrector
+
+    attr_accessor :link_processor
+    attr_accessor :options
+
+    def initialize
+      @printer = Rowr::Printer.new
+      @option_getter = Rowr::Prompter.new
+      @state = Rowr::StateSaver.new Dir.pwd, 'rowr_state.json'
+      @prompt = TTY::Prompt.new
+      @config = {}
+    end
+
+    def init_link_processor(cached = {})
+      @link_processor = Rowr::LinkProcessor.new(
+        @config[:source_directory],
+        @config[:old_host],
+        @config[:new_base_path],
+        @config[:check_external_urls],
+        cached
+      )
+    end
+
+    def files_with_exts(exts)
+      regex = /\.(#{exts.join('|')})$/i
+      Dir.glob(File.join(@config[:source_directory], '**', '*')).grep(regex).reject { |f| !File.file?(f) }
+    end
+
+    def clean_no_quotes(file_contents)
+      find = %r{(?<=href=|src=|background=)(?!['"])(?<content>[^> ]*)}mi
+      file_contents.gsub(find) do |match|
+        "\"#{$~[:content]}\""
+      end
+    end
+
+    def check_urls(file_contents)
+      find = %r{(?<=(?<=href=|src=|url\(|background=)['"])(?!(mailto:|#))(?<content>.*?)(?=["'])}mi
+      file_contents.gsub(find) do |match|
+        content = $~[:content].strip
+        replacement = @link_processor.process(content)
+        replacement.nil? ? content : replacement
+      end
+    end
+
+    def prompt_user_for_option(option)
+      @option_getter.send(option.to_sym)
+    end
+
+    def gather_options
+      @printer.line_break 0
+      prompt_user_for_option 'old_host?'
+      @printer.line_break 0
+      prompt_user_for_option 'new_base_path?'
+      @printer.line_break 0
+      prompt_user_for_option 'additional_exts?'
+      @printer.line_break 0
+      prompt_user_for_option 'check_external_urls?'
+      @printer.line_break 0
+    end
+
+    def load_state
+      @state.load_state
+      @config = @state.config
+    end
+
+    def continue
+      unless @state.config_file_exists?
+        loop do
+          @printer.print_line " I can't find a rowr save file in this directory... "
+          prompt_user_for_option 'source_directory?'
+          @state.src = @option_getter.source_directory
+          break if @state.config_file_exists?
+        end
+      end
+      load_state
+      run
+    end
+
+    def start
+      @printer.print_intro
+      @printer.print_line " Before we start, I've got some questions "
+      prompt_user_for_option 'source_directory?'
+      @state.src = @option_getter.source_directory
+      if @state.config_file_exists?
+        @prompt.say("I've found a rowr save file.")
+        continue_resp = @prompt.select('Would you like to continue or reset?', %w(Continue Reset))
+        if continue_resp == 'Reset'
+          reset
+        else
+          continue
+        end
+      end
+      prep
+    end
+
+    def reset
+      zipper = Rowr::Zipper.new Dir.pwd
+      if zipper.backup_file_exists?
+        @option_getter.source_directory = Dir.pwd
+      else
+        loop do
+          @prompt.warn("I can't find a rowr backup file in this directory. Where is the old site?")
+          prompt_user_for_option 'source_directory?'
+          zipper.src = @option_getter.source_directory
+          break if zipper.backup_file_exists?
+        end
+      end
+      zipper.restore
+      prep
+    end
+
+    def prep
+      gather_options
+      @config = @option_getter.generate_hash
+      @state.save_config(@config)
+      @printer.print_line " Let's get started "
+      @printer.line_break 0.5
+      run
+    end
+
+    def run
+      # Backup
+      zipper = Rowr::Zipper.new @config[:source_directory]
+      zipper.backup
+
+      # Prep the link processor
+      init_link_processor(@state.cached)
+      files = files_with_exts(@config[:exts_to_use])
+      count = files.length
+
+      # Print the run intro
+      @printer.print_line
+      @printer.print_line " I've found #{count} files to scan "
+      @printer.print_line
+      @printer.line_break 0.5
+      unless @state.scanned_files.empty?
+        count -= @state.scanned_files.length
+        @printer.print_line(
+          " Skipping #{@state.scanned_files.length} files, previously scanned.",
+          '!',
+          'red'
+        )
+        @printer.line_break 0.5
+      end
+
+      files.each do |f|
+        # Skip any previously scanned files
+        next if @state.scanned_files.include?(f)
+
+        # Print the intro
+        @printer.print_file_header f
+        @printer.line_break 0
+
+        # Run @link_processor over all matching links
+        text = File.read(f)
+        @link_processor.containing_file = f
+        unless text.valid_encoding?
+          text = text.encode('UTF-16be', invalid: :replace, replace: '&nbsp;').encode('UTF-8')
+        end
+        text = clean_no_quotes(text)
+        text = check_urls(text)
+        File.open(f, 'w') { |file| file.puts text }
+        count -= 1
+
+        ## Update the state
+        @state.scanned_files << f
+        @state.cached = @link_processor.cached
+        @state.save_state
+
+        # Print count, onto next file
+        @printer.line_break 0
+        @printer.print_line " #{count} files left ", '*', 'cyan'
+        @printer.line_break 0
+      end
+
+      @printer.print_outro
+    end
+  end
+end

data/lib/rowr/state_saver.rb

@@ -0,0 +1,47 @@
+require 'rowr'
+
+module Rowr
+
+  class StateSaver
+
+    def initialize(src_dir, filename)
+      @src = src_dir
+      @file = File.expand_path(File.join(@src, filename))
+      @config = {}
+      @cached = {}
+      @scanned_files = []
+    end
+
+    attr_accessor :src
+    attr_reader   :file
+    attr_reader   :config
+    attr_accessor :scanned_files
+    attr_accessor :cached
+
+    def config_file_exists?
+      File.exist?(@file)
+    end
+
+    def save_state
+      hashed = {
+        config: @config,
+        cached: @cached,
+        scanned_files: scanned_files
+      }
+      File.open(@file, 'wb') { |f| f.write JSON.pretty_generate(hashed) }
+    end
+
+    def load_state
+      file = JSON.parse(File.open(@file).read, symbolize_names: true)
+      @config = file[:config]
+      @cached = file[:cached]
+      @scanned_files = file[:scanned_files]
+    end
+
+    def save_config(config)
+      @config = config
+      save_state
+    end
+
+  end
+end

data/lib/rowr/version.rb

@@ -0,0 +1,3 @@
+module Rowr
+  VERSION = "0.2.0"
+end

data/lib/rowr/zipper.rb

@@ -0,0 +1,64 @@
+require 'rowr'
+
+module Rowr
+
+  class Zipper
+
+    def initialize(src_dir)
+      @src = src_dir
+      @filename = 'rowr_backup_files'
+      @backup_dir = File.join(src, filename)
+    end
+
+    attr_accessor :src
+    attr_reader   :filename
+    attr_reader   :backup_dir
+
+    def backup
+      copy
+      zip
+      remove
+    end
+
+    def remove
+      FileUtils.remove_dir(backup_dir)
+    end
+
+    def copy
+      FileUtils.mkdir_p backup_dir
+      files = Dir.glob(File.join(src, '*')).reject { |f| File.basename(f) == filename }
+      FileUtils.cp_r files, backup_dir
+    end
+
+    def zip
+      zip = File.join(src,"#{filename}.zip")
+      File.delete zip if File.exist?(zip)
+      zf = ZipFileGenerator.new(backup_dir, zip)
+      zf.write
+    end
+
+    def restore
+      delete_all_files_except_backup
+      unzip
+    end
+
+    def unzip
+      Zip::File.open(File.join(src, "#{filename}.zip")) do |zip_file|
+        zip_file.each do |file|
+          file_path = File.join(src, file.name)
+          FileUtils.mkdir_p(File.dirname(file_path))
+          zip_file.extract(file, file_path) unless File.exist?(file_path)
+        end
+      end
+    end
+
+    def backup_file_exists?
+      File.exist?(File.expand_path(File.join(src, "#{filename}.zip")))
+    end
+
+    def delete_all_files_except_backup
+      FileUtils.rm_rf (Dir.glob(File.join(src, '*')).reject { |f| File.basename(f) =~ /^rowr_/ })
+    end
+
+  end
+end

data/lib/zip/zip_file_generator.rb

@@ -0,0 +1,48 @@
+require 'zip'
+
+# This is a simple example which uses rubyzip to
+# recursively generate a zip file from the contents of
+# a specified directory. The directory itself is not
+# included in the archive, rather just its contents.
+#
+# Usage:
+#   directoryToZip = "/tmp/input"
+#   outputFile = "/tmp/out.zip"
+#   zf = ZipFileGenerator.new(directoryToZip, outputFile)
+#   zf.write()
+class ZipFileGenerator
+
+  # Initialize with the directory to zip and the location of the output archive.
+  def initialize(inputDir, outputFile)
+    @inputDir = inputDir
+    @outputFile = outputFile
+  end
+
+  # Zip the input directory.
+  def write()
+    entries = Dir.entries(@inputDir); entries.delete("."); entries.delete("..")
+    io = Zip::File.open(@outputFile, Zip::File::CREATE)
+
+    writeEntries(entries, "", io)
+    io.close()
+  end
+
+  # A helper method to make the recursion work.
+  private
+  def writeEntries(entries, path, io)
+
+    entries.each { |e|
+      zipFilePath = path == "" ? e : File.join(path, e)
+      diskFilePath = File.join(@inputDir, zipFilePath)
+      # puts "Deflating " + diskFilePath
+      if  File.directory?(diskFilePath)
+        io.mkdir(zipFilePath)
+        subdir = Dir.entries(diskFilePath); subdir.delete("."); subdir.delete("..")
+        writeEntries(subdir, zipFilePath, io)
+      else
+        io.get_output_stream(zipFilePath) { |f| f.puts(File.open(diskFilePath, "rb").read())}
+      end
+    }
+  end
+
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rowr
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Luke Aeschleman
+- Jason Casden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Refactors pieces of old websites so they can be hosted again or archived.
+email:
+- lukeaeschleman@gmail.com
+- casden@gmail.com
+executables:
+- rowr
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- bin/setup
+- exe/rowr
+- lib/rowr.rb
+- lib/rowr/command_line.rb
+- lib/rowr/link_processor.rb
+- lib/rowr/printer.rb
+- lib/rowr/prompter.rb
+- lib/rowr/resurrector.rb
+- lib/rowr/state_saver.rb
+- lib/rowr/version.rb
+- lib/rowr/zipper.rb
+- lib/zip/zip_file_generator.rb
+homepage: https://github.com/UNC-Libraries/ROWR
+licenses:
+- Apache-2.0
+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.6.13
+signing_key: 
+specification_version: 4
+summary: The Really Old Website Refactorer
+test_files: []