headingify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd7969833778861cc551085dfbe3ac56fb12910f
+  data.tar.gz: 4c797dfe295a5894fe0764c22f2c101b2b2c1a4d
+SHA512:
+  metadata.gz: 738d8051b28d6b99ea89e68234ee81b4d41e041d83f23b11915aeba6967af3e116747ec1974ebb58d6e74e9b2bf406cd5aade5e9dcdda75881bb17d73203ad94
+  data.tar.gz: 27077477d9340025330f22c84bf6f6d3da4f4278a88ac3c7f01e340f8722a9f093cbd9f737b9a6d88868d15fe182e7f8b2bfb8ff89e7cac6409f7b5bd6356991

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in headingify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Calo
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,46 @@
+= Headingify
+
+A method used to convert a string into a heading. It extends the String class; currently only supporting the English language. Please contribute if you are adept in other languages utilizing articles, conjuctions, and prepositions.
+
+Headingify is based off of grammatical rules set forth in The Chicago Manual of Style. ed. 16 pgf. 8.155.
+
+== Download and Installation
+
+The latest version of Headingify can be installed with RubyGems:
+  
+  % [sudo] gem install headingify
+
+Add this line to your application's Gemfile:
+
+  gem 'headingify'
+    
+== Usage
+
+To execute in standalone mode do the following:
+  
+  % headingify "a simple string, including the preposition 'with'."
+    > A Simple String, including the Preposition 'with'.
+
+To escape words in a string do the following:
+  
+  % headingify "folding of the \%CheY\% protein."
+    > Folding of the CheY Protein.
+
+Headingify works on the String class, and can also be used in code:
+  
+  s = "a simple string, including the preposition 'with'.".headingify
+  title = "folding of the \%CheY\% protein."; title.headingify!
+
+== License
+
+Headingify is released under the MIT license:
+
+  * http://www.opensource.org/licenses/MIT
+
+== Contributing
+
+1. Fork it (https://github.com/vulcancreative/headingify/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/headingify

@@ -0,0 +1,23 @@
+#! /usr/bin/env ruby
+
+require 'headingify'
+
+# print help by default
+if ARGV.length == 0
+  print Headingify.help
+end
+
+ARGV.each_with_index do |s, i|
+  if s =~ /-*h$/ || s =~ /-*help$/
+    print Headingify.help
+  elsif s =~ /-*v$/ || s =~ /-*version$/
+    t = "#{Headingify::TITLE}"
+    v = "#{Headingify::VERSION}"
+    u = "(#{Headingify::UPDATE} revision #{Headingify::REVISION})"
+    print "#{t}, #{v} #{u}\n"
+  elsif i == 0
+    print s.headingify + "\n"
+  else
+    print Headingify.help
+  end
+end

data/headingify.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'headingify/info'
+
+Gem::Specification.new do |s|
+  s.name          = "headingify"
+  s.version       = Headingify::VERSION
+  s.authors       = ["Chris Calo"]
+  s.email         = ["ccalo@vulcanca.com"]
+  s.summary       = "A method used to convert a string into a heading."
+  s.description   = "#{s.summary} It extends String class; English only."
+  s.homepage      = "http://vulcanca.com"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+end

data/lib/headingify/core_ext/string.rb

@@ -0,0 +1,76 @@
+class String
+  def headingify
+    #
+    # built to syntactically supercede String.[titlecase|titleize]
+    #
+    # example : "garlic is as \%GOOD\% as ten mothers"
+    # yields  : "Garlic Is as GOOD as Ten Mothers"
+    #
+    # based on rules in The Chicago Manual of Style: ed. 16 pgf. 8.155
+    # inspired by http://titlecapitalization.com/
+    # © 2014 Copyright Chris Calo. Vulcan Creative, LLC.
+    #
+
+    # http://en.wikipedia.org/wiki/English_articles
+    articles = %w[a an the]
+
+    # http://en.wikipedia.org/wiki/Conjunction_(grammar)
+    conjunctions = %w[and but or nor for yet so]
+
+    # http://en.wikipedia.org/wiki/List_of_English_prepositions
+    prepositions = %w[a abaft aboard about above absent across afore after 
+    against along alongside amid amidst among amongst an anenst apropos 
+    apud around as aside astride at athwart atop barring before behind 
+    below beneath beside besides between beyond but by circa concerning 
+    despite down during except excluding failing following for forenenst 
+    from given in including inside into like mid midst minus modulo near 
+    nigh next notwithstanding of off on onto opposite out outside over 
+    pace past per plus pro qua regarding round sans save since than through 
+    thru throughout thruout til till times to toward towards under 
+    underneath unlike until unto up upon versus via vice vis-a-vis 
+    vis-à-vis with within without worth]
+
+    # combine for ease of iteration
+    blacklist = (articles + conjunctions + prepositions).uniq!
+
+    # prepare initial string for modification
+    working = self.split
+
+    # determines whether word has quoting characters, or not
+    include_open_quote = lambda do |w|
+      q = %w[' " ’ ‘ “ ”]
+
+      return true if q.include?(w[0]) || q.include?(w[w.length - 1])
+      return false
+    end
+
+    # capitalize only what's necessary
+    working.each_with_index do |(s), i|
+      working[i] = /\\%(.*)\\%/.match(s)[1] if s.include?("\%")
+      next if s =~ /^o'.*$/
+      if blacklist.include?(s) && i == 0; s.capitalize!; next; end
+      blacklist.include?(s) ? s.downcase! : s.capitalize!
+
+      if include_open_quote.call(s)
+        open = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[1]
+        temp = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[2]
+        last = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[3]
+        punc = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[4]
+
+        unless temp.nil?
+          blacklist.include?(temp) ? temp.downcase! : temp.capitalize!
+          temp = open + temp unless open.nil?
+          temp = temp + last unless last.nil?
+          temp = temp + punc unless punc.nil?
+          working[i] = temp
+        end
+      end
+    end
+
+    working.join(" ")
+  end
+  
+  def headingify!
+    replace self.headingify
+  end
+end

data/lib/headingify/info.rb

@@ -0,0 +1,21 @@
+module Headingify
+  TITLE          = "Ruby String.headingify Core Extension"
+  VERSION        = "0.0.1"
+  UPDATE         = "2014-11-19"
+  REVISION       = "4"
+  USAGE          = "headingify \"string\" | \"an \\%ESCAPED\\% string\""
+  EXAMPLE_INPUT  = "\"garlic is as \\%GOOD\\% as ten mothers\""
+  EXAMPLE_OUTPUT = "Garlic Is as GOOD as Ten Mothers"
+
+  def self.usage
+    "Usage: #{USAGE}"
+  end
+
+  def self.example
+    "input : #{EXAMPLE_INPUT}\nyield : #{EXAMPLE_OUTPUT}"
+  end
+
+  def self.help
+    "#{Headingify.usage}\n\n#{Headingify.example}\n" 
+  end
+end

data/lib/headingify.rb

@@ -0,0 +1,5 @@
+require 'headingify/info'
+require 'headingify/core_ext/string'
+
+module Headingify
+end

data/spec/headingify_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Headingify do
+  it "should return the input String as a proper title" do
+    input = ["i'm dale, but you have to call me dragon.", 
+    "i swear, i'm so pissed off at my mom.", 
+    "as soon as she's of age, i'm putting her in a home.", 
+    "i'm fucking miserable. i had to get up at 10 o'clock this morning!", 
+    "why are you so sweaty? i was watching cops.", 
+    "dad, what are you doing? it's 'shark week'!", 
+    "i want to roll you into a little ball and shove you up my vagina.", 
+    "i traveled 500 miles to give you my seed!", 
+    "a simple string, including the preposition 'with'."]
+
+    output = ["I'm Dale, but You Have to Call Me Dragon.", 
+    "I Swear, I'm so Pissed off at My Mom.", 
+    "As Soon as She's of Age, I'm Putting Her in a Home.", 
+    "I'm Fucking Miserable. I Had to Get up at 10 o'clock This Morning!", 
+    "Why Are You so Sweaty? I Was Watching Cops.", 
+    "Dad, What Are You Doing? It's 'Shark Week'!", 
+    "I Want to Roll You into a Little Ball and Shove You up My Vagina.", 
+    "I Traveled 500 Miles to Give You My Seed!", 
+    "A Simple String, including the Preposition 'with'."]
+
+    input.each_with_index do |s, i|
+      expect(s.headingify).to eq(output[i])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'headingify'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: headingify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Calo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A method used to convert a string into a heading. It extends String class;
+  English only.
+email:
+- ccalo@vulcanca.com
+executables:
+- headingify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/headingify
+- headingify.gemspec
+- lib/headingify.rb
+- lib/headingify/core_ext/string.rb
+- lib/headingify/info.rb
+- spec/headingify_spec.rb
+- spec/spec_helper.rb
+homepage: http://vulcanca.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A method used to convert a string into a heading.
+test_files:
+- spec/headingify_spec.rb
+- spec/spec_helper.rb