upmark 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e6c728e71452e9983f7fe6ef59948cca6fd691b
-  data.tar.gz: 87daa0b2e4e6105b43e88502b6f645a2e84e423a
+SHA256:
+  metadata.gz: e6e70467bec74fa706947ab9b0aea3c6cf626c6cf201a07aa918b5fba980a1a2
+  data.tar.gz: a237b227e1c64e116dad035548ac4d364f9fca96956b26ad7b90f0b5919b29fc
 SHA512:
-  metadata.gz: 25919f578df35140965011b7c2cb2ce57308f52adf0a05373ba26f4aff5973d3c810c6fb53b473efc9ce50744325b12a9331ee0a1934b715e61be6a8df830cf5
-  data.tar.gz: 018f24f9bf5db7e63e79c5301c3ee6035d7028ff9521951a4c03de346358b32a14fc716ead14ac8da41ad146d2e24edd0543a2ee26f42f5610fd0c3734102f01
+  metadata.gz: 8c132b5f1a0fdc78cd7c5a4e3c7b3a9bad1a7aacfc7ad3e59f9d2a88bdb03bdd610bd5a907bddf565e2183c0c70dc0558834b80e7fddac8ad9421fe245f2e99c
+  data.tar.gz: 7a4997aea6c74b5a2ee3adcf377e963663ca1ce6e4aec1cb48dc7d3066f0f8ec46710235885df300e6bd0fe15923825b130f0ab1de22bfc15d649bacbaae98b8

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2011 The Conversation Media Group
+Copyright (c) 2016 The Conversation Media Group
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,16 +4,18 @@ A HTML to Markdown converter.
 
 ## Installation
 
-    gem install upmark
+    > gem install upmark
 
 ## Usage
 
 In ruby:
 
-    require "upmark"
-    html = %q{<p>messenger <strong>bag</strong> skateboard</p>}
-    markdown = Upmark.convert(html)
-    puts markdown
+```ruby
+require "upmark"
+html = "<p>messenger <strong>bag</strong> skateboard</p>"
+markdown = Upmark.convert(html)
+puts markdown
+```
 
 From the command-line:
 
@@ -46,7 +48,3 @@ Upmark defines a parsing expression grammar (PEG) using the very awesome [Parsle
 2. Normalize the AST into a nested hash of HTML elements.
 3. Mark the block and span-level subtrees which should be ignored (`table`, `div`, `span`, etc).
 4. Convert the AST leaves into Markdown.
-
-## License
-
-Upmark is Copyright (c) 2014 The Conversation Media Group and distributed under the MIT license.

data/lib/upmark.rb

@@ -1,7 +1,5 @@
 require "parslet"
 
-require "core_ext/array"
-
 require 'upmark/errors'
 require "upmark/parser/xml"
 require 'upmark/transform_helpers'

data/lib/upmark/errors.rb

@@ -1,14 +1,14 @@
 module Upmark
   class ParseFailed < StandardError
+    attr_reader :cause
 
     def initialize(message, cause)
       @cause = cause
       super(message)
     end
 
-    def cause
-      @cause
+    def ascii_tree
+      @cause && @cause.ascii_tree
     end
-
   end
 end

data/lib/upmark/transform/markdown.rb

@@ -54,7 +54,7 @@ module Upmark
 
       element(:ol) do |element|
         children = element[:children].map {|value| value.strip != "" ? value : nil }.compact
-        children.map_with_index {|value, i| "#{i + 1}. #{value}\n" }
+        children.map.with_index {|value, i| "#{i + 1}. #{value}\n" }
       end
 
       element(:a) do |element|

data/spec/acceptance/upmark_spec.rb

@@ -55,6 +55,28 @@ RSpec.describe Upmark, ".convert" do
     end
   end
 
+  context "<a> with inline elements, no href" do
+    specify 'converts as plain text' do
+      expect(<<-HTML.strip
+        <a>How Australia can respond to the security challenges posed by climate change in the Asian Century</a>
+      HTML
+      ).to convert_to <<-MD.strip
+How Australia can respond to the security challenges posed by climate change in the Asian Century
+      MD
+    end
+  end
+
+  context "<a> with id href" do
+    specify 'converts as plain text' do
+      expect(<<-HTML.strip
+        <a href=\"#sdfootnote3anc\">Labor MP calls to end dogs</a>
+      HTML
+      ).to convert_to <<-MD.strip
+Labor MP calls to end dogs
+      MD
+    end
+  end
+
   context "<img>" do
     specify 'converts as ![]()' do
       expect(<<-HTML.strip

data/spec/errors_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Upmark::ParseFailed, ".ascii_tree" do
+  it "delegates to a cause object" do
+    cause = double(ascii_tree: double)
+    error = Upmark::ParseFailed.new("oh noes", cause)
+    expect(error.ascii_tree).to be(cause.ascii_tree)
+  end
+
+  it "returns nil when there is no cause" do
+    error = Upmark::ParseFailed.new("oh noes", nil)
+    expect(error.ascii_tree).to be_nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upmark
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Josh Bassett
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.2
 description: Upmark has the skills to convert your HTML to Markdown.
 email: dev@theconversation.edu.au
 executables:
@@ -75,11 +75,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/upmark
-- lib/core_ext/array.rb
 - lib/upmark.rb
 - lib/upmark/errors.rb
 - lib/upmark/parser/xml.rb
@@ -89,6 +88,7 @@ files:
 - lib/upmark/transform/preprocess.rb
 - lib/upmark/transform_helpers.rb
 - spec/acceptance/upmark_spec.rb
+- spec/errors_spec.rb
 - spec/spec_helper.rb
 - spec/unit/lib/upmark/parser/xml_spec.rb
 - spec/unit/lib/upmark/transform/markdown_spec.rb
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -111,12 +111,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: upmark
-rubygems_version: 2.5.1
+rubygems_version: 2.7.0
 signing_key: 
 specification_version: 4
 summary: A HTML to Markdown converter.
 test_files:
+- spec/spec_helper.rb
 - spec/unit/lib/upmark/parser/xml_spec.rb
 - spec/unit/lib/upmark/transform/markdown_spec.rb
-- spec/spec_helper.rb
 - spec/acceptance/upmark_spec.rb
+- spec/errors_spec.rb

data/lib/core_ext/array.rb

@@ -1,9 +0,0 @@
-class Array
-  def map_with_index
-    result = []
-    each_with_index do |element, index|
-      result << yield(element, index)
-    end
-    result
-  end
-end