ghpreview 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecd6a28a4028bf030b8c9e94cb16ee9d6cb4764de12830f4e09340a001578508
+  data.tar.gz: 1f046c3bf96a82d23bbe5823ba9c8cbfa8d492fdab231cbb0a5306bd080a0f76
+SHA512:
+  metadata.gz: 4c9f845b3d78a8c13aff8a2d292b4a66fde9c6dcaf806101bff274179b7af4760e802ecd1ea68da80ba5524a4e49cf09adb96633f66835fa280e9681d39a7a20
+  data.tar.gz: 5f799472562d73c65b3bb8b758064f4d60c1fcd6c00b62d78f2624705b22108abd8287d5397269cf8f1ca18dfaf33ab7f3e5b4f3a71fc9be156e86b7bfb13b7c

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 .bundle
+.byebug_history
 .config
 .yardoc
 Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+## 0.2.0 - September 30th, 2019
+
+- First update after 6 years: Udpate gem versions to get the gem working again with modern rubies.
+- Currently tested in: 2.4, 2.5, 2.6 and ruby-head
+
+## 0.1.1 - December 23, 2013
+
+- Specify html-pipeline dependencies. Also now using Bundler to sandbox the required gems. This should make it fail if the dependencies are not specified in the gemspec.
+- Require rspec
+
+## 0.1.0 - December 22, 2013
+
+- Update Listener and use new API
+- Update versions of html-pipeline and github-linguist
+
+## 0.0.9 - August 9, 2013
+
+- Include anchor links in headings
+
+## 0.0.8 - June 22, 2013
+
+- Add convenience executables for testing
+- Extract Viewer, Wrapper, Converter, Watcher.
+- Allow an alternative browser to be used with the -a switch on GNU/Linux.
+
+## 0.0.7 - April 4, 2013
+
+- Alow an alternate browser to be used with the -a switch on Mac.
+
+## 0.0.6 - January 4, 2013
+
+- SIGINT trapping and error handling
+- Updates dependency versions
+
+## 0.0.5 - December 20, 2012
+
+- Lock version of github-linguist to known working version
+
+## 0.0.4 - December 18, 2012
+
+- Remove CamoFilter, add asset_root for EmojiFilter
+- Add note about icu.
+
+## 0.0.3 - November 30, 2012
+
+- Cache the stylesheets for a week
+- Avoids using the GitHub API and uses Github's html-pipeline.
+- Refactor obfuscated code.
+- Improvements on the README
+
+## 0.0.2 - November 26, 2012
+
+- Avoid SSL verifications errors when using open-uri
+- Adds Linux compatibility
+- Cache the fingerprinted stylesheets links for a day
+- Use ERB for HTML template
+- Add live updating preview as a command line option
+- Rename to ghpreview for better tab-completion
+
+## 0.0.1 - November 26, 2012
+
+- Initial release with executable.
+

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in github-preview.gemspec

data/README.md

@@ -39,7 +39,7 @@ To use an alternate browser, use the `-a` (or `--application`) option:
 # On Mac:
 $ ghpreview -a Safari.app README.md
 
-#On GNU/Linux:
+# On GNU/Linux:
 $ ghpreview -a konqueror README.md
 ```
 

data/Rakefile

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/ghpreview

@@ -1,32 +1,33 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-trap("INT") { exit }
+trap('INT') { exit }
 require 'optparse'
 require 'ghpreview'
 
 options = {}
 
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: ghpreview [options] FILE"
-  opts.separator ""
+  opts.banner = 'Usage: ghpreview [options] FILE'
+  opts.separator ''
 
-  opts.on("-w", "--watch", "Watch for changes") do |w|
+  opts.on('-w', '--watch', 'Watch for changes') do |w|
     options[:watch] = w
   end
 
-  opts.on("-a", "--application APP", "Alternate browser") do |a|
+  opts.on('-a', '--application APP', 'Alternate browser') do |a|
     options[:application] = a
   end
 end
 
-def valid_file? filename
-  filename and File.exist?(filename) and File.file?(filename)
+def valid_file?(filename)
+  filename && File.exist?(filename) && File.file?(filename)
 end
 
 begin
   optparse.parse!
   unless valid_file? ARGV[0]
-    puts "Missing markdown file."
+    puts 'Missing markdown file.'
     puts optparse
     exit
   end

data/ghpreview.gemspec

@@ -1,29 +1,43 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ghpreview/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "ghpreview"
+  gem.name          = 'ghpreview'
   gem.version       = GHPreview::VERSION
-  gem.authors       = ["Adam McCrea"]
-  gem.email         = ["adam@adamlogic.com"]
-  gem.description   = %q{Command line utility for previewing Markdown files with Github styling}
+  gem.authors       = ['Adam McCrea', 'Fernando Briano']
+  gem.email         = ['fernando@picandocodigo.net', 'adam@adamlogic.com']
+  gem.description   = 'Command line utility for previewing Markdown files with Github styling'
   gem.summary       = gem.description
-  gem.homepage      = "http://github.com/newcontext/ghpreview"
+  gem.homepage      = 'http://github.com/edgecase/ghpreview'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
+  gem.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/edgecase/ghpreview/issues",
+    "changelog_uri"     => "https://github.com/edgecase/ghpreview/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/edgecase/ghpreview/blob/master/README.md#gamesdb",
+    "homepage_uri"      => "https://github.com/edgecase/ghpreview",
+    "source_code_uri"   => "https://github.com/edgecase/ghpreview",
+  }
 
-  gem.add_dependency 'bundler', '~> 1.3'
-  gem.add_dependency 'listen', '~> 2.4.0'
+  gem.add_dependency 'bundler'
+  gem.add_dependency 'commonmarker', '~> 0.16'
+  gem.add_dependency 'escape_utils', '~> 1.0'
+  gem.add_dependency 'gemoji', '~> 2.0'
+  gem.add_dependency 'github-linguist', '~> 7.6'
+  gem.add_dependency 'github-markdown', '~> 0.6'
+  gem.add_dependency 'html-pipeline', '~> 2.12'
+  gem.add_dependency 'httpclient', '~> 2.8'
+  gem.add_dependency 'listen', '~> 3.1.5'
   gem.add_dependency 'rb-fsevent'
-  gem.add_dependency 'html-pipeline', '~> 1.1.0'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'github-linguist', '~> 2.10.5'
-  gem.add_dependency 'github-markdown', '~> 0.5'
-  gem.add_dependency 'sanitize', '~> 2.0'
-  gem.add_dependency 'gemoji', '~> 1.0'
+  gem.add_dependency 'rinku', '~> 1.7'
+  gem.add_dependency 'rouge', '~> 3.1'
+  gem.add_dependency 'sanitize', '~> 4.4.0'
+
+  gem.add_development_dependency 'byebug'
 end

data/lib/ghpreview.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'bundler/setup'

data/lib/ghpreview/converter.rb

@@ -1,24 +1,29 @@
+# frozen_string_literal: true
+
 require 'html/pipeline'
 
 module GHPreview
   class Converter
     def self.to_html(markdown)
       context = {
-        asset_root: "http://assets.github.com/images/icons/",
+        asset_root: 'https://github.githubassets.com/images/icons/',
+        base_url: 'https://github.githubassets.com/images/icons/',
         gfm: false
       }
 
       pipeline = HTML::Pipeline.new([
-        HTML::Pipeline::MarkdownFilter,
-        HTML::Pipeline::TableOfContentsFilter,
-        HTML::Pipeline::SanitizationFilter,
-        HTML::Pipeline::ImageMaxWidthFilter,
-        HTML::Pipeline::HttpsFilter,
-        HTML::Pipeline::MentionFilter,
-        HTML::Pipeline::EmojiFilter,
-        HTML::Pipeline::SyntaxHighlightFilter
-      ], context)
-      result = pipeline.call(markdown)[:output].to_s
+                                      HTML::Pipeline::MarkdownFilter,
+                                      HTML::Pipeline::SanitizationFilter,
+                                      HTML::Pipeline::ImageMaxWidthFilter,
+                                      HTML::Pipeline::TableOfContentsFilter,
+                                      HTML::Pipeline::HttpsFilter,
+                                      HTML::Pipeline::AutolinkFilter,
+                                      HTML::Pipeline::MentionFilter,
+                                      HTML::Pipeline::EmojiFilter,
+                                      HTML::Pipeline::SyntaxHighlightFilter
+                                    ], context)
+
+      pipeline.call(markdown)[:output].to_s
     end
   end
 end

data/lib/ghpreview/previewer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'converter'
 require_relative 'wrapper'
 require_relative 'viewer'
@@ -5,7 +7,6 @@ require_relative 'watcher'
 
 module GHPreview
   class Previewer
-
     def initialize(md_filepath, options = {})
       Wrapper.generate_template_with_fingerprinted_stylesheet_links
 
@@ -27,6 +28,5 @@ module GHPreview
       html = Wrapper.wrap_html(html)
       Viewer.view_html html, @application
     end
-
   end
 end

data/lib/ghpreview/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GHPreview
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/ghpreview/viewer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GHPreview
   class Viewer
     HTML_FILEPATH = '/tmp/ghpreview.html'
@@ -8,7 +10,7 @@ module GHPreview
       if RUBY_PLATFORM =~ /linux/
         command = if application
                     `#{application} #{HTML_FILEPATH} </dev/null &>/dev/null &`
-                    else
+                  else
                     `xdg-open #{HTML_FILEPATH}`
                   end
       else

data/lib/ghpreview/watcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen'
 
 module GHPreview
@@ -8,7 +10,7 @@ module GHPreview
       filename = File.basename(filepath)
       dirname  = File.dirname(File.expand_path(filepath))
 
-      listener = Listen.to(dirname, filter: /#{filename}$/) do |modified|
+      listener = Listen.to(dirname, filter: /#{filename}$/) do |_modified|
         yield
       end
       listener.start

data/lib/ghpreview/wrapper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'httpclient'
 
 module GHPreview
   class Wrapper
     GITHUB_URL               = 'https://github.com'
-    STYLED_TEMPLATE_FILEPATH = "/tmp/ghpreview-template.erb"
+    STYLED_TEMPLATE_FILEPATH = '/tmp/ghpreview-template.erb'
     TEMPLATE_CACHE_DURATION  = 60 * 60 * 24 * 7 # one week
     RAW_TEMPLATE_FILEPATH    = "#{File.dirname(__FILE__)}/template.erb"
 
@@ -32,9 +34,9 @@ module GHPreview
     private
 
     def self.stale_template?(filepath)
-      return true unless File.exists?(filepath)
+      return true unless File.exist?(filepath)
+
       File.mtime(filepath) < (Time.now - TEMPLATE_CACHE_DURATION)
     end
-
   end
 end

data/spec/converter_spec.rb

@@ -1,19 +1,19 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require_relative '../lib/ghpreview/converter'
 
 describe GHPreview::Converter do
   let(:converter) { GHPreview::Converter }
 
-  it "converts markdown to HTML" do
+  it 'converts markdown to HTML' do
     expect(converter.to_html('*Foo*')).to eql('<p><em>Foo</em></p>')
   end
 
-  it "includes anchor links in headings" do
-    expect(converter.to_html('# Foo')).to eql("<h1>\n<a name=\"foo\" href=\"#foo\"></a>Foo</h1>")
+  it 'includes anchor links in headings' do
+    expect(converter.to_html('# Foo')).to eql("<h1>\n<a id=\"foo\" class=\"anchor\" href=\"#foo\" aria-hidden=\"true\"><span aria-hidden=\"true\" class=\"octicon octicon-link\"></span></a>Foo</h1>")
   end
 
-  it "passes through non-ASCII characters" do
+  it 'passes through non-ASCII characters' do
     expect(converter.to_html('Baña')).to eql('<p>Baña</p>')
   end
 end

data/spec/preview_readme

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require './lib/ghpreview'
 

data/spec/watch_readme

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require './lib/ghpreview'
 

data/spec/wrapper_spec.rb

@@ -1,20 +1,20 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require_relative '../lib/ghpreview/wrapper'
 
 describe GHPreview::Wrapper do
   let(:wrapper) { GHPreview::Wrapper }
 
-  it "wraps an HTML fragment in a full document" do
+  it 'wraps an HTML fragment in a full document' do
     fragment = '<h1>foo</h1>'
     expect(wrapper.wrap_html(fragment)).to include('<html>')
   end
 
-  it "passes through non-ASCII chars" do
+  it 'passes through non-ASCII chars' do
     expect(wrapper.wrap_html('<h1>Baña</h1>')).to include('Baña')
   end
 
-  it "specifies the charset" do
+  it 'specifies the charset' do
     expect(wrapper.wrap_html('# foo')).to include("charset='utf-8'")
   end
 end

metadata

@@ -1,169 +1,223 @@
 --- !ruby/object:Gem::Specification
 name: ghpreview
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam McCrea
+- Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: escape_utils
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.6'
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github-linguist
+  name: rinku
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.5
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.5
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: github-markdown
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
-  name: gemoji
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: Command line utility for previewing Markdown files with Github styling
 email:
+- fernando@picandocodigo.net
 - adam@adamlogic.com
 executables:
 - ghpreview
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -182,33 +236,35 @@ files:
 - spec/preview_readme
 - spec/watch_readme
 - spec/wrapper_spec.rb
-homepage: http://github.com/newcontext/ghpreview
+homepage: http://github.com/edgecase/ghpreview
 licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/edgecase/ghpreview/issues
+  changelog_uri: https://github.com/edgecase/ghpreview/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/edgecase/ghpreview/blob/master/README.md#gamesdb
+  homepage_uri: https://github.com/edgecase/ghpreview
+  source_code_uri: https://github.com/edgecase/ghpreview
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Command line utility for previewing Markdown files with Github styling
 test_files:
 - spec/converter_spec.rb
 - spec/preview_readme
 - spec/watch_readme
 - spec/wrapper_spec.rb
-has_rdoc: