edumacator 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.12"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem 'simplecov', '~> 0.7.1'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Graham Davison
+
+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:
+
+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.

data/README.md

@@ -0,0 +1,42 @@
+edumacator
+==========
+
+“Educates” quotes and replaces some other typographic characters like em-dashes (—) and ellipses (…).
+
+It uses a simple algorithm to identify double quotes, single quotes, and apostrophes. Two dashes are replaced by an em-dash, and three dots, with a space or not, are replaced by an ellipsis.
+
+```
+Edumacator.educate %q{Jim's friend mumbled, "I guess..."}
+```
+converts to
+```
+Jim’s friend mumbled, “I guess…”
+```
+
+It assumes that the text passed in is plain text. Markup such as HTML will not survive being edumacated:
+```
+<img src="cat.gif">
+```
+would become
+```
+<img src=“cat.gif”>
+```
+which wouldn’t work so well.
+
+It also assumes English quoting rules, because [nobody agrees](http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks) how to do it. I’m also guessing that writers in languages that use quotes that aren’t like dumb-quotes will use the correct quotes. Submit an issue if I’m wrong!
+
+See TODO.md for future plans.
+
+Contributing to edumacator
+--------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright (c) 2013 Graham Davison. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "edumacator"
+  gem.homepage = "http://github.com/gdavison/edumacator"
+  gem.license = "MIT"
+  gem.summary = %Q{Educates quotes and other typographical elements}
+  gem.description = %Q{“Educates” quotes and replaces some other typographic characters like em-dashes (—) and ellipses (…).}
+  gem.email = "g.m.davison@computer.org"
+  gem.authors = ["Graham Davison"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "edumacator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.md

@@ -0,0 +1,5 @@
+Edumacator TODOs
+================
+* use proper primes (′) and double-primes (″) for feet/inches and minutes/seconds
+* handle markup languages
+* option to output XML numeric entities directly?

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/edumacator.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+class Edumacator
+  
+  def self.educate(string)
+    result = string.gsub %r{(\S)"},    %q{\1”} # closing double quote
+    result = result.gsub %r{"},        %q{“}   # opening double quote
+                                        
+    result = result.gsub %r{(\S)'},    %q{\1’} # closing single quote
+    result = result.gsub %r{'},        %q{‘}   # opening single quote
+      
+    result = result.gsub %r{\.\.\.},   %q{…}   # ellipsis
+    result = result.gsub %r{\. \. \.}, %q{…}   # ellipsis with spaces
+    
+    result = result.gsub %r{--},       %q{—}   # em dash
+  end
+end

data/spec/edumacator_spec.rb

@@ -0,0 +1,96 @@
+# encoding: UTF-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Edumacator" do
+  
+  context 'double quotes' do
+  
+    it 'handles quotes in the middle' do
+      expect(Edumacator::educate(%q{the "real" thing})).to eq(%q{the “real” thing})
+    end
+    
+    it 'handles quotes at the end' do
+      expect(Edumacator::educate(%q{the "one"})).to eq(%q{the “one”})
+    end
+    
+    it 'handles quotes at the begining' do
+      expect(Edumacator::educate(%q{"double" quote})).to eq(%q{“double” quote})
+    end
+    
+    it 'handles quotes at both ends' do
+      expect(Edumacator::educate(%q{"the whole enchilada"})).to eq(%q{“the whole enchilada”})
+    end
+    
+  end
+  
+  context 'single quotes' do
+  
+    it 'handles quotes in the middle' do
+      expect(Edumacator::educate(%q{the 'real' thing})).to eq(%q{the ‘real’ thing})
+    end
+    
+    it 'handles quotes at the end' do
+      expect(Edumacator::educate(%q{the 'one'})).to eq(%q{the ‘one’})
+    end
+    
+    it 'handles quotes at the begining' do
+      expect(Edumacator::educate(%q{'single' quote})).to eq(%q{‘single’ quote})
+    end
+    
+    it 'handles quotes at both ends' do
+      expect(Edumacator::educate(%q{'the whole enchilada'})).to eq(%q{‘the whole enchilada’})
+    end
+    
+  end
+  
+  context 'apostrophes' do
+    
+    it %q{handles "'s"} do
+      expect(Edumacator::educate(%q{Timmy's ball})).to eq(%q{Timmy’s ball})
+    end
+    
+    it %q{handles "O'"} do
+      expect(Edumacator::educate(%q{O'Brien})).to eq(%q{O’Brien})
+    end
+    
+    # this is a very English-specific rule
+    it 'handles an apostrophe at the end of a plural word' do
+      expect(Edumacator::educate(%q{the boys' ball})).to eq(%q(the boys’ ball))
+    end
+  end
+  
+  context 'nesting' do
+    
+    it 'handles single quotes inside double quotes' do
+      # yeah, quotes inside. blah blah blah.
+      expect(Edumacator::educate(%q{"So I told him 'get lost!'", he said.})).to eq(%q{“So I told him ‘get lost!’”, he said.})
+    end
+    
+    # this seems to be a British-style thing
+    it 'handles double quotes inside single quotes' do
+      expect(Edumacator::educate(%q{'And I said to him "not a chance!"', was the reply.})).to eq(%q{‘And I said to him “not a chance!”’, was the reply.})
+    end
+    
+    it 'handles apostrophes inside double quotes' do
+      expect(Edumacator::educate(%q{"That's mine," she said.})).to eq(%q{“That’s mine,” she said.})
+    end
+  end
+  
+  context 'ellipsis...' do
+    it 'handles an ellipsis' do
+      expect(Edumacator::educate(%q{trailing off...})).to eq(%q{trailing off…})
+    end
+    
+    it 'handles an ellipsis with spaces between dots' do
+      expect(Edumacator::educate(%q{trailing off. . .})).to eq(%q{trailing off…})
+    end
+  end
+  
+  context 'dashes' do
+    it 'handles --' do
+      expect(Edumacator::educate(%q{the reason -- in their minds})).to eq(%q{the reason — in their minds})
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'edumacator'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: edumacator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Graham Davison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: “Educates” quotes and replaces some other typographic characters like
+  em-dashes (—) and ellipses (…).
+email: g.m.davison@computer.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- VERSION
+- lib/edumacator.rb
+- spec/edumacator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gdavison/edumacator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1751189798172313461
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Educates quotes and other typographical elements
+test_files: []