law_string 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ba3b225b7f91b6da7026be6137d607974c7fe76d0feef5983f5c5935776f18d
+  data.tar.gz: 8bfae20247212726eeb888ec0d2db7cf34fb90d2d7c4ce334abbe99bd8300043
+SHA512:
+  metadata.gz: e1317870a9938822644d6eff85134ea263065c6a93ac4bc8e5288b835538ab06bfd6c95bc317521f81dccfecd8fb96082cae615bbd036a77013412892b9a13ee
+  data.tar.gz: b75cc034f6a7af6aeaa0cd1af7e6df702ca8059c72eb1e9c60bf3b69000cc6a974ffe0ebf7707564756d50c6d2b44a535f97358054a3c30224d3f18a4e2ec573

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in law_string.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    law_string (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  law_string!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robb Shecter
+
+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,32 @@
+# LawString
+
+[![Build Status](https://travis-ci.org/public-law/law_string.svg?branch=master)](https://travis-ci.org/public-law/law_string)
+
+A few string util functions which support the [Public.Law](https://www.public.law) apps. Optimized for reduced object instantiation
+at the expense of readability.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'law_string'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install law_string
+
+## Usage
+
+Provides;
+
+* `#add_typograpy` e.g., changing ASCII quotes to true double quotes
+* `#titleize` enhanced for English-language legal texts
+* `#initials` to detect, e.g., "A.S.C.A.P."
+
+See the tests for details.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "law_string"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/law_string.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "law_string"
+  spec.version       = '1.1.0'
+  spec.authors       = ["Robb Shecter"]
+  spec.email         = ["robb@public.law"]
+
+  spec.summary       = 'String Utils including a specialized #titleize.'
+  spec.description   = 'A set of utils narrowly written to support Public.Law. Focus on reducing object instantation at the cost of readability.'
+  spec.homepage      = "https://github.com/public-law/law_string"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/law_string.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'digest/md5'
+require 'set'
+
+# Specialized #titleize and #add_typography methods.
+class String
+  # For AP Style Titles
+  NOT_CAPITALIZED = Set.new %w[a an and at but by for in nor of on or out so the to up yet].freeze
+  INITIALISMS     = Set.new %w[atm].freeze
+
+  INITIALS_REGEX  = /^([a-zA-Z]\.)+$/
+  WHITESPACES_REGEX = /[[:space:]]/
+
+  def in?(an_array)
+    an_array.include?(self)
+  end
+
+  def initials?
+    INITIALS_REGEX.match?(self)
+  end
+
+  def initialism?
+    INITIALISMS.include?(self)
+  end
+
+  def starts_with?(str)
+    start_with?(str)
+  end
+
+  def md5_sum
+    Digest::MD5.hexdigest(self)
+  end
+
+  #
+  # A better titleize that creates a usable title according to English grammar
+  # rules. It's coded to reduce object allocation.
+  #
+  def titleize
+    new_string = self.clone(freeze: false)
+
+    new_string.tr!('_', ' ')
+    final_string = new_string.split(WHITESPACES_REGEX)
+                             .map { |w| titleize_word(w) }
+                             .join(' ')
+    final_string.capitalize_first_letter!
+    final_string
+  end
+
+  def titleize_word(word)
+    if word.start_with?('"', '(', '[', '{')
+      extra = word[0]
+      word  = word.tail
+    else
+      extra = ''
+    end
+
+    word.downcase!
+    if NOT_CAPITALIZED.include?(word)
+      # Do nothing
+    elsif word.initials? || word.initialism?
+      word.upcase!
+    else
+      word.capitalize!
+    end
+
+    if extra == ''
+      word
+    else
+      extra + word
+    end
+  end
+
+  def tail
+    self[1..-1]
+  end
+
+  #
+  # Replace my value with the titleized version.
+  #
+  def titleize!
+    replace titleize
+  end
+
+  #
+  # Return a new string enhanced with typographic characters:
+  #  Single quotes: ’
+  #  Section sign:  §
+  #  Double quotes: “”
+  #
+  def add_typography
+    tr("'", '’')
+      .gsub(/\bSec\./, '§')
+      .gsub(/"([^"]+)"/, '“\1”')
+  end
+
+  #
+  # Take text with potential encoding problems and
+  # aggressively make it safe for UTF-8 import.
+  #
+  def utf8_safe
+    encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+  end
+
+  def capitalize_first_letter
+    return '' if self == ''
+
+    new_string = self.clone(freeze: false)
+    new_string.capitalize_first_letter!
+    new_string
+  end
+
+  def capitalize_first_letter!
+    return self if self == ''
+    self[0] = self[0].upcase
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: law_string
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Robb Shecter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A set of utils narrowly written to support Public.Law. Focus on reducing
+  object instantation at the cost of readability.
+email:
+- robb@public.law
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- law_string.gemspec
+- lib/law_string.rb
+homepage: https://github.com/public-law/law_string
+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.7.6
+signing_key: 
+specification_version: 4
+summary: 'String Utils including a specialized #titleize.'
+test_files: []