rubypants 0.2.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 766f0400e12ec2e5bb64917568fcf5dba1b7fdf7e31632c62144602e0b1bd674
+  data.tar.gz: 87de02ec38116b4d9d179e80f958f608101565a9724f63a751e7efb642dab7ff
+SHA512:
+  metadata.gz: 543191639285ce9c53716b19fcbfa72dd6b14e96f53cb88b87a62f5cf4446725ceeb384c6ea3c7767c97409195d7e5cb11c8694d06eb93545284b230b2407bf0
+  data.tar.gz: ed420062908b83fa18c96bb8048870095350f4d9b45ac2294939a9265f775c04a1aa4c5d7e40ed8b3bee741a013103be0bf218e4d18e4e0e59dbbe3eb6cd2fc0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - jruby
+
+# Workaround for `NoMethodError: undefined method 'spec' for nil:NilClass`,
+# see https://travis-ci.org/jmcnevin/rubypants/jobs/167182556
+# and https://github.com/travis-ci/travis-ci/issues/5239
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "codecov", :require => false, :group => :test

data/{README → LICENSE.rdoc}

@@ -1,42 +1,15 @@
-= RubyPants -- SmartyPants ported to Ruby
+= Copyright and License
+
+== Copyright
 
 Ported by Christian Neukirchen <mailto:chneukirchen@gmail.com>
-  Copyright (C) 2004 Christian Neukirchen
+Copyright (C) 2004 Christian Neukirchen
 
-Incooporates ideas, comments and documentation by Chad Miller
-  Copyright (C) 2004 Chad Miller
+Incorporates ideas, comments and documentation by Chad Miller
+Copyright (C) 2004 Chad Miller
 
 Original SmartyPants by John Gruber
-  Copyright (C) 2003 John Gruber
-
-
-== RubyPants
-
-RubyPants is a Ruby port of the smart-quotes library SmartyPants.
-
-The original "SmartyPants" is a free web publishing plug-in for
-Movable Type, Blosxom, and BBEdit that easily translates plain ASCII
-punctuation characters into "smart" typographic punctuation HTML
-entities.
-
-See rubypants.rb for more information.
-
-
-== Incompatibilities
-
-RubyPants uses a different API than SmartyPants; it is compatible to
-Red- and BlueCloth.  Usually, you call RubyPants like this:
-
-  nicehtml = RubyPants.new(uglyhtml, options).to_html
-
-where +options+ is an Array of Integers and/or Symbols (if you don't
-pass any options, RubyPants will use <tt>[2]</tt> as default.)
-
-*Note*:: This is incompatible to SmartyPants, which uses <tt>[1]</tt>
-         for default.
-
-The exact meaning of numbers and symbols is documented at RubyPants#new.
-
+Copyright (C) 2003 John Gruber
 
 == SmartyPants license:
 
@@ -73,10 +46,7 @@ liability, or tort (including negligence or otherwise) arising in
 any way out of the use of this software, even if advised of the
 possibility of such damage.
 
-
-== RubyPants license
-
-Copyright (C) 2004 Christian Neukirchen
+=== RubyPants license
 
 RubyPants is a derivative work of SmartyPants and smartypants.py.
 
@@ -104,11 +74,3 @@ caused and on any theory of liability, whether in contract, strict
 liability, or tort (including negligence or otherwise) arising in
 any way out of the use of this software, even if advised of the
 possibility of such damage.
-
-
-== Links
-
-John Gruber:: http://daringfireball.net
-SmartyPants:: http://daringfireball.net/projects/smartypants
-Chad Miller:: http://web.chad.org
-Christian Neukirchen:: http://kronavita.de/chris

data/README.rdoc

@@ -0,0 +1,121 @@
+= RubyPants: SmartyPants for Ruby
+
+{<img src="https://img.shields.io/gem/v/rubypants.svg?maxAge=2592000&style=plastic" alt="Gem">}[https://rubygems.org/gems/rubypants]
+{<img src="https://img.shields.io/travis/jmcnevin/rubypants.svg?maxAge=2592000&style=plastic" alt="Travis">}[https://travis-ci.org/jmcnevin/rubypants]
+{<img src="https://img.shields.io/codecov/c/github/jmcnevin/rubypants.svg?maxAge=2592000&style=plastic" alt="CodeCov">}[https://codecov.io/gh/jmcnevin/rubypants]
+
+== Synopsis
+
+RubyPants is a Ruby port of the smart-quotes library SmartyPants.
+
+The original "SmartyPants" is a free web publishing plug-in for
+Movable Type, Blosxom, and BBEdit that easily translates plain ASCII
+punctuation characters into "smart" typographic punctuation HTML
+entities.
+
+
+== Description
+
+RubyPants can perform the following transformations:
+
+* Straight quotes (<tt>"</tt> and <tt>'</tt>) into "curly" quote
+  HTML entities
+* Backticks-style quotes (<tt>``like this''</tt>) into "curly" quote
+  HTML entities
+* Dashes (<tt>--</tt> and <tt>---</tt>) into en- and em-dash
+  entities
+* Three consecutive dots (<tt>...</tt> or <tt>. . .</tt>) into an
+  ellipsis entity
+
+This means you can write, edit, and save your posts using plain old
+ASCII straight quotes, plain dashes, and plain dots, but your
+published posts (and final HTML output) will appear with smart
+quotes, em-dashes, and proper ellipses.
+
+RubyPants does not modify characters within <tt><pre></tt>,
+<tt><code></tt>, <tt><kbd></tt>, <tt><math></tt>, <tt><style></tt> or
+<tt><script></tt> tag blocks. Typically, these tags are used to
+display text where smart quotes and other "smart punctuation" would
+not be appropriate, such as source code or example markup.
+
+
+== Installation
+
+  gem install rubypants
+
+Or, in your application's Gemfile:
+
+  gem 'rubypants'
+
+
+== Example of Usage
+
+  RubyPants.new("String with 'dumb' quotes.").to_html
+
+For additional options, consult the documention in
+<tt>lib/rubypants/core.rb</tt>.
+
+
+== Backslash Escapes
+
+If you need to use literal straight quotes (or plain hyphens and
+periods), RubyPants accepts the following backslash escape sequences
+to force non-smart punctuation. It does so by transforming the
+escape sequence into a decimal-encoded HTML entity:
+
+  \\    \"    \'    \.    \-    \`
+
+This is useful, for example, when you want to use straight quotes as
+foot and inch marks: 6'2" tall; a 17" iMac.  (Use <tt>6\'2\"</tt>
+resp. <tt>17\"</tt>.)
+
+
+== Algorithmic Shortcomings
+
+One situation in which quotes will get curled the wrong way is when
+apostrophes are used at the start of leading contractions. For
+example:
+
+  'Twas the night before Christmas.
+
+In the case above, RubyPants will turn the apostrophe into an
+opening single-quote, when in fact it should be a closing one. I
+don't think this problem can be solved in the general case--every
+word processor I've tried gets this wrong as well. In such cases,
+it's best to use the proper HTML entity for closing single-quotes
+("<tt>&#8217;</tt>") by hand.
+
+
+== Bugs
+
+To file bug reports or feature requests, please create an issue in this gem's
+GitHub repository.
+
+If the bug involves quotes being curled the wrong way, please send
+example text to illustrate.
+
+
+== Authors
+
+John Gruber did all of the hard work of writing this software in
+Perl for Movable Type and almost all of this useful documentation.
+Chad Miller ported it to Python to use with Pyblosxom.
+
+Christian Neukirchen provided the Ruby port, as a general-purpose
+library that follows the *Cloth API.
+
+Jeremy McNevin posted this code to GitHub ages ago, but has recently
+been trying to improve it where possible.
+
+Aron Griffis made jekyll-pants[https://github.com/scampersand/jekyll-pants]
+which depends on RubyPants, and consequently jumped in to help out with
+issues and pull requests.
+
+
+== Links
+
+John Gruber :: http://daringfireball.net
+SmartyPants :: http://daringfireball.net/projects/smartypants
+Chad Miller :: http://web.chad.org
+Christian Neukirchen :: http://kronavita.de/chris
+Aron Griffis :: https://arongriffis.com

data/Rakefile

@@ -1,84 +1,7 @@
-# Rakefile for rubypants  -*-ruby-*-
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-
-
 desc "Run all the tests"
 task :default => [:test]
 
-desc "Do predistribution stuff"
-task :predist => [:doc]
-
-
 desc "Run all the tests"
 task :test do
-  ruby 'test_rubypants.rb'
-end
-
-desc "Make an archive as .tar.gz"
-task :dist => :test do
-  system "darcs dist -d rubypants#{get_darcs_tree_version}"
-end
-
-
-desc "Generate RDoc documentation"
-Rake::RDocTask.new(:doc) do |rdoc|
-  rdoc.options << '--line-numbers --inline-source --all'
-  rdoc.rdoc_files.include 'README'
-  rdoc.rdoc_files.include 'rubypants.rb'
-end
-
-
-spec = Gem::Specification.new do |s|
-  s.name = 'rubypants'
-  s.version = '0.2.0'
-  s.summary = "RubyPants is a Ruby port of the smart-quotes library SmartyPants."
-  s.description = <<-EOF
-RubyPants is a Ruby port of the smart-quotes library SmartyPants.
-
-The original "SmartyPants" is a free web publishing plug-in for
-Movable Type, Blosxom, and BBEdit that easily translates plain ASCII
-punctuation characters into "smart" typographic punctuation HTML
-entities.
-  EOF
-  s.files = FileList['**/*rb', 'README', 'Rakefile'].to_a
-  s.test_file = "test_rubypants.rb"
-  s.extra_rdoc_files = ["README"]
-  s.rdoc_options = ["--main", "README"]
-  s.rdoc_options.concat ['--line-numbers', '--inline-source', '--all']
-  s.rdoc_options.concat ['--exclude',  'test_rubypants.rb']
-  s.require_path = '.'
-  s.author = "Christian Neukirchen"
-  s.email = "chneukirchen@gmail.com"
-  s.homepage = "http://www.kronavita.de/chris/blog/projects/rubypants.html"
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-end
-
-
-# Helper to retrieve the "revision number" of the darcs tree.
-def get_darcs_tree_version
-  return ""  unless File.directory? "_darcs"
-
-  changes = `darcs changes`
-  count = 0
-  tag = "0.0"
-  
-  changes.each("\n\n") { |change|
-    head, title, desc = change.split("\n", 3)
-    
-    if title =~ /^  \*/
-      # Normal change.
-      count += 1
-    elsif title =~ /tagged (.*)/
-      # Tag.  We look for these.
-      tag = $1
-      break
-    else
-      warn "Unparsable change: #{change}"
-    end
-  }
-
-  "-" + tag + "." + count.to_s
+  ruby 'test/rubypants_test.rb'
 end