typeright 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13bc4a3b0f0714a4482f760fcefc813e235de5e2
+  data.tar.gz: 1a5f7d619d40aed8e7aeca9ead01fca4b4411ab2
+SHA512:
+  metadata.gz: 62a4ae93dd82bc5eef065e2f7922dac49aa9c3c65d6dc5d10aef8a2d65150d558425b8e20b40725b5a81151a4e3a741e67f8c79fbbd0fdbee3d2af441da401af
+  data.tar.gz: 52f1f89a7e38e986c58ece3b6ebbc99be48f685f20c54ad2d4597ebb9f072ff5a996aff97adb12963bda82fce9c5cab0135c15153c1df7e8e0395b2f8490af77

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+coverage
+rdoc
+pkg
+.bundle
+Gemfile.lock
+*.gem
+*.log
+doc/

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+env: CI="travis"
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-2

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'rake'
+  gem 'rspec', '>= 3'
+  gem 'rubocop'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+
+  gem 'coveralls', require: false if ENV['CI']
+end

data/Guardfile

@@ -0,0 +1,22 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+
+# guard :rubocop do
+guard :rubocop, all_on_start: false, keep_failed: false, cli: ['-D'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^generators\/(.+)\.rb$/) { |_m| 'spec/schemaless/worker_spec' }
+
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Typeright Authors
+
+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,62 @@
+# TypeRight
+
+    ________________________________________________________________
+            ______                       ____
+              /                          /    )   ,         /
+    ---------/---------------__----__---/___ /--------__---/__--_/_-
+            /      /   /   /   ) /___) /    |   /   /   ) /   ) /
+    _______/______(___/___/___/_(___ _/_____|__/___(___/_/___/_(_ __
+                     /   /                            /
+                 (_ /   /                         (_ /
+
+
+
+Makes text more pleasant for the eyes.
+
+
+Turns this:
+
+```
+And so... "Why?" -- He replied
+Because -> this! And => this!
+Also, notice some math: Pi + 2 * 180 / 2.
+```
+
+Into this:
+
+```
+And so… “Why?” — He replied.
+Because → It’s cool! And ⇒ I like beautiful text!.
+Also, notice some math: π + 2 × 180 ÷ 2.
+```
+
+## Install
+
+    gem install typeright
+
+
+## Use
+
+    Typeright.s(a_text)
+
+
+## Todo
+
+- Spaces
+
+## Won't Do
+
+Non UTF-8 modifications. Eg. `Small Caps`.
+
+For that complement with a client-side lib:
+
+
+Inspiration and thanks
+
+https://github.com/davidmerfield/Typeset
+
+
+## Also nice
+
+http://webtypography.net/
+http://kyleamathews.github.io/typography.js/#/

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: :spec

data/bench/all.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'benchmark'
+require 'typeright'
+
+puts
+puts "                                    Typeright! v#{Typeright::VERSION}"
+
+N = 100_000
+P1 = "Some 'simple' paragraph -> will be nice to -- see"
+P2 = <<DOC
+
+From https://pine.fm/LearnToProgram/
+
+I guess this all began back in 2002. I was thinking about teaching programming, and what a great language Ruby would be for learning how to program. I mean, we were all excited about Ruby because it was powerful, elegant, and really just fun, but it seemed to me that it would also be a great way to get into programming in the first place.
+
+Unfortunately, there wasn't much Ruby documentation geared for newbies at the time. Some of us in the community were talking about what such a "Ruby for the Nuby" tutorial would need, and more generally, how to teach programming at all. The more I thought about this, the more I had to say (which surprised me a bit). Finally, someone said, "Chris, why don't you just write a tutorial instead of talking about it?" So I did.
+
+And it wasn't very good. I had all these ideas that were good in theory, but the actual task of making a great tutorial for non-programmers was vastly more challenging than I had realized. (I mean, it seemed good to me, but I already knew how to program.)
+
+What saved me was that I made it really easy for people to contact me, and I always tried to help people when they got stuck. When I saw a lot of people getting stuck in one place, I'd rewrite it. It was a lot of work, but it slowly got better and better.
+
+A couple of years later, it was getting pretty good. :-) So good, in fact, that I was ready to pronounce it finished, and move on to something else. And right about then came an opportunity to turn the tutorial into a book. Since it was already basically done, I figured this would be no problem. I'd just clean up a few spots, add some more exercises, maybe some more examples, a few more chapters, run it by 50 more reviewers...
+
+It took me another year, but now I think it's really really good, mostly because of the hundreds of brave souls who have helped me write it.
+
+DOC
+
+Benchmark.bmbm do |b|
+  b.report { N.times { Typeright.s(P1) } }
+  b.report { N.times { Typeright.s(P2) } }
+end

data/bin/typeright

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'typeright'
+
+puts
+puts "                                  Typeright! v#{Typeright::VERSION}"
+
+Typeright::CLI.work(ARGV)

data/lib/typeright/calculator.rb

@@ -0,0 +1,31 @@
+module Typeright
+  # Numbers and symbols replacement
+  module Calculator
+    class << self
+      def work(txt)
+        math(arrows(txt))
+      end
+
+      def arrows(txt)
+        txt
+          .gsub(/(^|\s)\=\>(\W)/, '\1⇒\2')
+          .gsub(/(^|\s)-\>(\W)/, '\1→\2')
+          .gsub(/(^|\s)\<-(\W)/, '\1←\2')
+          .gsub(/(^|\s)\<\=(\W)/, '\1⇐\2')
+          .gsub(/(^|\s)\<\<(\w)/, '\1«\2')
+          .gsub(/(\w)\>\>(\s|$)/, '\1»\2')
+      end
+
+      # Maybe (1) -> ① ⨉×
+      def math(txt)
+        txt
+          .gsub(/(^|\s)Pi(\W)/, '\1π\2')
+          .gsub(/(\d\s)\/(\s\d)/, '\1÷\2')
+          .gsub(/(\d\s)\*(\s\d)/, '\1×\2')
+          .gsub(/(^|\s)\!\=(\W)/, '\1≠\2')
+          .gsub(/(^|\s)\+-(\s)/, '\1±\2')
+          .gsub(/(\w)%o(\s|$)/, '\1‰\2')
+      end
+    end
+  end
+end

data/lib/typeright/cli.rb

@@ -0,0 +1,13 @@
+# require 'thor'
+
+module Typeright
+  # Nice cli
+  class CLI # < Thor
+    def self.work(args)
+      txt = args.empty? ? STDIN.gets : File.read(args.join)
+      STDOUT.puts
+      STDOUT.puts Typeright.s txt
+      STDOUT.puts
+    end
+  end
+end

data/lib/typeright/punctuator.rb

@@ -0,0 +1,12 @@
+module Typeright
+  # UTF-8 hyphens -- for everyone
+  module Punctuator
+    def self.work(txt)
+      # Elipses
+      txt
+        .gsub(/\.{3}/, '…')
+        .gsub(/--/, '—')
+        .tr('-', '–')
+    end
+  end
+end

data/lib/typeright/quotator.rb

@@ -0,0 +1,19 @@
+module Typeright
+  # Let's "quote"
+  module Quotator
+    def self.work(txt)
+      txt
+        .gsub(/(\W|^)"(\w)/, '\1“\2') # beginning "
+        .gsub(/(“[^"]*)"([^"]*$|[^“"]*“)/, '\1”\2') # ending "
+        .gsub(/([^0-9])"/, '\1”') # remaining " at end of word
+        .gsub(/(\W|^)'(\S)/, '\1‘\2') # beginning '
+        .gsub(/([a-z])'([a-z])/i, '\1’\2') # conjunction's possession
+        .gsub(/((‘[^']*)|[a-z])'([^0-9]|$)/i, '\1’\3') # ending '
+        .gsub(/(‘)([0-9]{2}[^’]*)(‘([^0-9]|$)|$|’[a-z])/i, '’\2\3') # abbrev. years like '93
+        .gsub(/(\B|^)‘(?=([^’]*’\b)*([^’‘]*\W[’‘]\b|[^’‘]*$))/i, '\1’')
+        .gsub(/'''/, '‴') # triple prime
+        .gsub(/("|'')/, '″') # double prime
+        .tr("'", '′')
+    end
+  end
+end

data/lib/typeright/version.rb

@@ -0,0 +1,4 @@
+# Typeright version
+module Typeright
+  VERSION = '0.0.3'
+end

data/lib/typeright.rb

@@ -0,0 +1,24 @@
+# require 'pry'
+# require 'yaml'
+require 'typeright/version'
+require 'typeright/cli'
+
+# Typeright!
+module Typeright
+  # autoload :Hyphenator, 'typeright/hyphenator'
+  autoload :Punctuator, 'typeright/punctuator'
+  autoload :Quotator,   'typeright/quotator'
+  autoload :Calculator, 'typeright/calculator'
+
+  TYPERS = [
+    Calculator,
+    Punctuator,
+    Quotator
+  ]
+
+  def self.s(txt)
+    TYPERS.reduce(txt) do |s, t|
+      t.work(s)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+# require 'pry'
+begin
+  require 'spec'
+rescue LoadError
+  require 'rspec'
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'typeright'
+# include Typeright
+
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+FOR_README = <<TXT
+And so... "Why?" -- He replied.
+Because -> It's cool! And => I like beautiful text!'.
+Also, notice some math: Pi + 2 * 180 / 2.
+TXT
+
+RSpec.configure do |config|
+  # config.mock_with(:mocha)
+
+  config.after(:suite) do
+    puts
+    puts FOR_README
+    puts
+    puts Typeright.s(FOR_README)
+  end
+end

data/spec/typeright/calculator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Typeright do
+  it 'should do some math +-' do
+    expect(Typeright.s('So, Pi +- 3.1?')).to eq('So, π ± 3.1?')
+  end
+
+  it 'should do some math ->' do
+    expect(Typeright.s('So, Pi -> 3.1?')).to eq('So, π → 3.1?')
+  end
+
+  it 'should do some math <-' do
+    expect(Typeright.s('Go back <- this')).to eq('Go back ← this')
+  end
+
+  it 'should do some math =>' do
+    expect(Typeright.s('So, Pi => 3.1?')).to eq('So, π ⇒ 3.1?')
+  end
+
+  it 'should do some math <=' do
+    expect(Typeright.s('Go back <= this')).to eq('Go back ⇐ this')
+  end
+
+  it 'should do some math <<>>' do
+    expect(Typeright.s('Said <<hello>>')).to eq('Said «hello»')
+  end
+
+  it 'should do some math <<>>' do
+    expect(Typeright.s('Said <<hello>>')).to eq('Said «hello»')
+  end
+
+  it 'should not touch ``' do
+    expect(Typeright.s('Said `hello`')).to eq('Said `hello`')
+  end
+end

data/spec/typeright_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Typeright do
+  it 'should change minus to hyphens' do
+    expect(Typeright.s('And suddenly -- No more.'))
+      .to eq('And suddenly — No more.')
+  end
+
+  it 'should change dots to ellipse' do
+    expect(Typeright.s('And suddenly... No more.'))
+      .to eq('And suddenly… No more.')
+  end
+
+  it 'should make beautiful quotes' do
+    expect(Typeright.s('And suddenly... "No more".'))
+      .to eq('And suddenly… “No more”.')
+  end
+
+  it 'should make beautiful quotes' do
+    expect(Typeright.s("Walk among us... 'Nevermind!'"))
+      .to eq('Walk among us… ‘Nevermind!’')
+  end
+
+  it 'should do some math Pi π' do
+    expect(Typeright.s('So, Pi = 3.14...')).to eq('So, π = 3.14…')
+  end
+
+  it 'should do some math != π' do
+    expect(Typeright.s('So, Pi != 1???')).to eq('So, π ≠ 1???')
+  end
+
+  it 'should do some math +-' do
+    expect(Typeright.s('So, Pi +- 3.1?')).to eq('So, π ± 3.1?')
+  end
+
+  it 'should do some math ->' do
+    expect(Typeright.s('So, Pi -> 3.1?')).to eq('So, π → 3.1?')
+  end
+
+  it 'should do some math %o' do
+    expect(Typeright.s('It means 10%o')).to eq('It means 10‰')
+  end
+
+  {
+    'pretty :-) So good' => 'pretty :-) So good',
+    'place, I\'d rewrite it' => 'place, I’d rewrite it',
+    'by 50 more reviewers...' => 'by 50 more reviewers…',
+    'So "Why don\'t you" -- implied' => 'So “Why don’t you” — implied',
+    'So "Why don\'t you?"' => 'So “Why don’t you?”',
+    'So "Why don\'t you".' => 'So “Why don’t you”.',
+    'So "Why don\'t you?".' => 'So “Why don’t you?”.'
+  }.each do |k, v|
+    it "should work nice with #{k} -> #{v}" do
+      expect(Typeright.s(k)).to eq(v)
+    end
+  end
+end

data/typeright.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'typeright/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'typeright'
+  s.version     = Typeright::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = ['Marcos Piccinini']
+  s.homepage    = 'http://github.com/nofxx/typeright'
+  s.email       = 'x@nofxx.com'
+  s.description = 'Make text beautiful'
+  s.summary     = 'Make text UTF-8 beautiful'
+  s.license     = 'MIT'
+
+  s.executables = ['typeright']
+  s.default_executable = 'typeright'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: typeright
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Marcos Piccinini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies: []
+description: Make text beautiful
+email: x@nofxx.com
+executables:
+- typeright
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bench/all.rb
+- bin/typeright
+- lib/typeright.rb
+- lib/typeright/calculator.rb
+- lib/typeright/cli.rb
+- lib/typeright/punctuator.rb
+- lib/typeright/quotator.rb
+- lib/typeright/version.rb
+- spec/spec_helper.rb
+- spec/typeright/calculator_spec.rb
+- spec/typeright_spec.rb
+- typeright.gemspec
+homepage: http://github.com/nofxx/typeright
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Make text UTF-8 beautiful
+test_files:
+- spec/spec_helper.rb
+- spec/typeright/calculator_spec.rb
+- spec/typeright_spec.rb