typogruby 1.0.6 → 1.0.7

data/HISTORY.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## 1.0.7
+
+* Improved Ruby 1.9 compatibility
+* Improved documentation
+* Merged test helper and test case
+
+## 1.0.6
+
+* Bugfix: ignore inline javascript
+
+## 1.0.5
+
+* Manage gem dependencies using Bundler
+
+## 1.0.4
+
+* Bugfix: no longer regard combination of digits and periods as caps.
+* Bugfix: do not add consecutive non-breaking spaces to prevent widows
+
+## 1.0.3
+
+* Bugfix: caps also ignores unequal but same excepted tags
+* Feature: added command-line program
+* Improved documentation
+
+## 1.0.2
+
+* Bugfix: initial_quotes also wraps named HTML entities
+* Bugfix: caps no longer wraps consecutive numbers
+
+## 1.0
+
+* First release

data/README.md

@@ -1,4 +1,4 @@
-# typogruby
+# Typogruby
 
 Helps you improve your web typograpbhy with some standard text filters.
 
@@ -39,41 +39,9 @@ This will output the contents of your file with all filters applied. Use `typogr
 * ...and on [Typogrify][3]
 * [Description of typogrify][1]
 
-[1]: http://jeffcroft.com/blog/2007/may/29/typogrify-easily-produce-web-typography-doesnt-suc/
-[2]: http://github.com/hunter/typography-helper
-[3]: http://code.google.com/p/typogrify
-[4]: http://avdgaag.github.com/typogruby
-[5]: http://github.com/avdgaag/Typography-tmbundle
-
 ## Changelog
 
-### 1.0.6
-
-* Bugfix: ignore inline javascript
-
-### 1.0.5
-
-* Manage gem dependencies using Bundler
-
-### 1.0.4
-
-* Bugfix: no longer regard combination of digits and periods as caps.
-* Bugfix: do not add consecutive non-breaking spaces to prevent widows
-
-### 1.0.3
-
-* Bugfix: caps also ignores unequal but same excepted tags
-* Feature: added command-line program
-* Improved documentation
-
-### 1.0.2
-
-* Bugfix: initial_quotes also wraps named HTML entities
-* Bugfix: caps no longer wraps consecutive numbers
-
-### 1.0
-
-* First release
+See HISTORY.md for the complete changelog.
 
 ## Note on Patches/Pull Requests
 
@@ -85,25 +53,13 @@ This will output the contents of your file with all filters applied. Use `typogr
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-## License
-
-Copyright (c) 2010 Arjan van der Gaag
+## Credits
 
-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:
+By Arjan van der Gaag ([avdgaag @ github][6]) based on the hard work of lots of others. See LICENSE for license details (same as Ruby).
 
-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.
+[1]: http://jeffcroft.com/blog/2007/may/29/typogrify-easily-produce-web-typography-doesnt-suc/
+[2]: http://github.com/hunter/typography-helper
+[3]: http://code.google.com/p/typogrify
+[4]: http://avdgaag.github.com/typogruby
+[5]: http://github.com/avdgaag/Typography-tmbundle
+[6]: http://github.com/avdgaag

data/Rakefile

@@ -44,7 +44,13 @@ task :default => :test
 
 begin
   require 'yard'
-  YARD::Rake::YardocTask.new
+  YARD::Rake::YardocTask.new do |t|
+    t.options = [
+      '--files', 'LICENSE',
+      '--files', 'HISTORY.md',
+      '--title', 'Typogruby API documentation'
+    ]
+  end
 rescue LoadError
   task :yardoc do
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.7

data/lib/typogruby.rb

@@ -4,6 +4,13 @@ require 'digest/md5'
 # A collection of simple helpers for improving web
 # typograhy. Based on TypographyHelper by Luke Hartman and Typogrify.
 #
+# @example Using all filters
+# require 'typogruby'
+# Typogruby.improve('my text')
+#
+# @example Using a single filter
+# Typogruby.initial_quotes('my text')
+#
 # @see http://github.com/hunter/typography-helper
 # @see http://code.google.com/p/typogrify
 # @author Arjan van der Gaag <arjan.vandergaag@gmail.com>
@@ -28,7 +35,7 @@ module Typogruby
   end
 
   # converts a & surrounded by optional whitespace or a non-breaking space
-  # to the HTML entity and surrounds it in a span with a styled class
+  # to the HTML entity and surrounds it in a span with a styled class.
   #
   # @example
   # amp('One & two')
@@ -65,7 +72,7 @@ module Typogruby
   # replaces space(s) before the last word (or tag before the last word)
   # before an optional closing element (<tt>a</tt>, <tt>em</tt>,
   # <tt>span</tt>, strong) before a closing tag (<tt>p</tt>, <tt>h[1-6]</tt>,
-  # <tt>li</tt>, <tt>dt</tt>, <tt>dd</tt>) or the end of the string
+  # <tt>li</tt>, <tt>dt</tt>, <tt>dd</tt>) or the end of the string.
   #
   # @example
   # > widont('A very simple test')
@@ -119,7 +126,7 @@ module Typogruby
   end
 
   # surrounds two or more consecutive captial letters, perhaps with interspersed digits and periods
-  # in a span with a styled class
+  # in a span with a styled class.
   #
   # @example
   # caps("A message from KU")
@@ -140,7 +147,7 @@ module Typogruby
   def caps(text)
     ignore_scripts(text) do |t|
       # $1 is an excluded HTML tag, $2 is the part before the caps and $3 is the caps match
-      t.gsub(/<(?i)(code|pre)(?-i).+?<(?i)\/\1(?-i)>|(\s|&nbsp;|^|'|"|>)([A-Z\d][A-Z\d\.']{1,})(?!\w)/)  do |str|
+      t.gsub(/(?i:<(:code|pre).+?<\/\1>)|(\s|&nbsp;|^|'|"|>)([A-Z\d][A-Z\d\.']{1,})(?!\w)/)  do |str|
         excluded, before, caps = $1, $2, $3
         if excluded
           str
@@ -155,7 +162,7 @@ module Typogruby
 
   # encloses initial single or double quote, or their entities
   # (optionally preceeded by a block element and perhaps an inline element)
-  # with a span that can be styled
+  # with a span that can be styled.
   #
   # @example
   # initial_quotes('"With primes"')
@@ -180,7 +187,7 @@ module Typogruby
     end
   end
 
-  # main function to do all the functions from the method
+  # main function to do all the functions from the method.
   # @param [String] text input text
   # @return [String] input text with all filters applied
   def improve(text)

data/test/test_typogruby.rb

@@ -1,6 +1,12 @@
-require 'helper'
+require 'rubygems'
+require 'bundler'
+require 'test/unit'
+require 'typogruby'
+Bundler.setup
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 class TestTypogruby < Test::Unit::TestCase
+  include Typogruby
 
   def test_should_replace_amps
     assert_equal 'One <span class="amp">&amp;</span> two', amp('One & two')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: typogruby
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Arjan van der Gaag
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 +02:00
+date: 2010-08-23 00:00:00 +02:00
 default_executable: typogruby
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,13 +73,13 @@ files:
 - .document
 - .gitignore
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bin/typogruby
 - lib/typogruby.rb
-- test/helper.rb
 - test/test_typogruby.rb
 - typogrify.gemspec
 has_rdoc: true
@@ -117,5 +117,4 @@ signing_key:
 specification_version: 3
 summary: Improves web typography like Django's Typogrify
 test_files: 
-- test/helper.rb
 - test/test_typogruby.rb

data/test/helper.rb

@@ -1,13 +0,0 @@
-require 'rubygems'
-require 'bundler'
-require 'test/unit'
-
-Bundler.setup
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'typogruby'
-
-class Test::Unit::TestCase
-  include Typogruby
-end