law_string 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +35 -0
- data/LICENSE.txt +21 -0
- data/README.md +32 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/law_string.gemspec +27 -0
- data/lib/law_string.rb +117 -0
- metadata +99 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8ba3b225b7f91b6da7026be6137d607974c7fe76d0feef5983f5c5935776f18d
|
4
|
+
data.tar.gz: 8bfae20247212726eeb888ec0d2db7cf34fb90d2d7c4ce334abbe99bd8300043
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e1317870a9938822644d6eff85134ea263065c6a93ac4bc8e5288b835538ab06bfd6c95bc317521f81dccfecd8fb96082cae615bbd036a77013412892b9a13ee
|
7
|
+
data.tar.gz: b75cc034f6a7af6aeaa0cd1af7e6df702ca8059c72eb1e9c60bf3b69000cc6a974ffe0ebf7707564756d50c6d2b44a535f97358054a3c30224d3f18a4e2ec573
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
law_string (1.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.3)
|
10
|
+
rake (10.5.0)
|
11
|
+
rspec (3.7.0)
|
12
|
+
rspec-core (~> 3.7.0)
|
13
|
+
rspec-expectations (~> 3.7.0)
|
14
|
+
rspec-mocks (~> 3.7.0)
|
15
|
+
rspec-core (3.7.1)
|
16
|
+
rspec-support (~> 3.7.0)
|
17
|
+
rspec-expectations (3.7.0)
|
18
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
19
|
+
rspec-support (~> 3.7.0)
|
20
|
+
rspec-mocks (3.7.0)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.7.0)
|
23
|
+
rspec-support (3.7.1)
|
24
|
+
|
25
|
+
PLATFORMS
|
26
|
+
ruby
|
27
|
+
|
28
|
+
DEPENDENCIES
|
29
|
+
bundler (~> 1.16)
|
30
|
+
law_string!
|
31
|
+
rake (~> 10.0)
|
32
|
+
rspec (~> 3.0)
|
33
|
+
|
34
|
+
BUNDLED WITH
|
35
|
+
1.16.1
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 Robb Shecter
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# LawString
|
2
|
+
|
3
|
+
[](https://travis-ci.org/public-law/law_string)
|
4
|
+
|
5
|
+
A few string util functions which support the [Public.Law](https://www.public.law) apps. Optimized for reduced object instantiation
|
6
|
+
at the expense of readability.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
gem 'law_string'
|
14
|
+
```
|
15
|
+
|
16
|
+
And then execute:
|
17
|
+
|
18
|
+
$ bundle
|
19
|
+
|
20
|
+
Or install it yourself as:
|
21
|
+
|
22
|
+
$ gem install law_string
|
23
|
+
|
24
|
+
## Usage
|
25
|
+
|
26
|
+
Provides;
|
27
|
+
|
28
|
+
* `#add_typograpy` e.g., changing ASCII quotes to true double quotes
|
29
|
+
* `#titleize` enhanced for English-language legal texts
|
30
|
+
* `#initials` to detect, e.g., "A.S.C.A.P."
|
31
|
+
|
32
|
+
See the tests for details.
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "law_string"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/law_string.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "law_string"
|
8
|
+
spec.version = '1.1.0'
|
9
|
+
spec.authors = ["Robb Shecter"]
|
10
|
+
spec.email = ["robb@public.law"]
|
11
|
+
|
12
|
+
spec.summary = 'String Utils including a specialized #titleize.'
|
13
|
+
spec.description = 'A set of utils narrowly written to support Public.Law. Focus on reducing object instantation at the cost of readability.'
|
14
|
+
spec.homepage = "https://github.com/public-law/law_string"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
27
|
+
end
|
data/lib/law_string.rb
ADDED
@@ -0,0 +1,117 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'digest/md5'
|
4
|
+
require 'set'
|
5
|
+
|
6
|
+
# Specialized #titleize and #add_typography methods.
|
7
|
+
class String
|
8
|
+
# For AP Style Titles
|
9
|
+
NOT_CAPITALIZED = Set.new %w[a an and at but by for in nor of on or out so the to up yet].freeze
|
10
|
+
INITIALISMS = Set.new %w[atm].freeze
|
11
|
+
|
12
|
+
INITIALS_REGEX = /^([a-zA-Z]\.)+$/
|
13
|
+
WHITESPACES_REGEX = /[[:space:]]/
|
14
|
+
|
15
|
+
def in?(an_array)
|
16
|
+
an_array.include?(self)
|
17
|
+
end
|
18
|
+
|
19
|
+
def initials?
|
20
|
+
INITIALS_REGEX.match?(self)
|
21
|
+
end
|
22
|
+
|
23
|
+
def initialism?
|
24
|
+
INITIALISMS.include?(self)
|
25
|
+
end
|
26
|
+
|
27
|
+
def starts_with?(str)
|
28
|
+
start_with?(str)
|
29
|
+
end
|
30
|
+
|
31
|
+
def md5_sum
|
32
|
+
Digest::MD5.hexdigest(self)
|
33
|
+
end
|
34
|
+
|
35
|
+
#
|
36
|
+
# A better titleize that creates a usable title according to English grammar
|
37
|
+
# rules. It's coded to reduce object allocation.
|
38
|
+
#
|
39
|
+
def titleize
|
40
|
+
new_string = self.clone(freeze: false)
|
41
|
+
|
42
|
+
new_string.tr!('_', ' ')
|
43
|
+
final_string = new_string.split(WHITESPACES_REGEX)
|
44
|
+
.map { |w| titleize_word(w) }
|
45
|
+
.join(' ')
|
46
|
+
final_string.capitalize_first_letter!
|
47
|
+
final_string
|
48
|
+
end
|
49
|
+
|
50
|
+
def titleize_word(word)
|
51
|
+
if word.start_with?('"', '(', '[', '{')
|
52
|
+
extra = word[0]
|
53
|
+
word = word.tail
|
54
|
+
else
|
55
|
+
extra = ''
|
56
|
+
end
|
57
|
+
|
58
|
+
word.downcase!
|
59
|
+
if NOT_CAPITALIZED.include?(word)
|
60
|
+
# Do nothing
|
61
|
+
elsif word.initials? || word.initialism?
|
62
|
+
word.upcase!
|
63
|
+
else
|
64
|
+
word.capitalize!
|
65
|
+
end
|
66
|
+
|
67
|
+
if extra == ''
|
68
|
+
word
|
69
|
+
else
|
70
|
+
extra + word
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
def tail
|
75
|
+
self[1..-1]
|
76
|
+
end
|
77
|
+
|
78
|
+
#
|
79
|
+
# Replace my value with the titleized version.
|
80
|
+
#
|
81
|
+
def titleize!
|
82
|
+
replace titleize
|
83
|
+
end
|
84
|
+
|
85
|
+
#
|
86
|
+
# Return a new string enhanced with typographic characters:
|
87
|
+
# Single quotes: ’
|
88
|
+
# Section sign: §
|
89
|
+
# Double quotes: “”
|
90
|
+
#
|
91
|
+
def add_typography
|
92
|
+
tr("'", '’')
|
93
|
+
.gsub(/\bSec\./, '§')
|
94
|
+
.gsub(/"([^"]+)"/, '“\1”')
|
95
|
+
end
|
96
|
+
|
97
|
+
#
|
98
|
+
# Take text with potential encoding problems and
|
99
|
+
# aggressively make it safe for UTF-8 import.
|
100
|
+
#
|
101
|
+
def utf8_safe
|
102
|
+
encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
|
103
|
+
end
|
104
|
+
|
105
|
+
def capitalize_first_letter
|
106
|
+
return '' if self == ''
|
107
|
+
|
108
|
+
new_string = self.clone(freeze: false)
|
109
|
+
new_string.capitalize_first_letter!
|
110
|
+
new_string
|
111
|
+
end
|
112
|
+
|
113
|
+
def capitalize_first_letter!
|
114
|
+
return self if self == ''
|
115
|
+
self[0] = self[0].upcase
|
116
|
+
end
|
117
|
+
end
|
metadata
ADDED
@@ -0,0 +1,99 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: law_string
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Robb Shecter
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-05-18 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.16'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
description: A set of utils narrowly written to support Public.Law. Focus on reducing
|
56
|
+
object instantation at the cost of readability.
|
57
|
+
email:
|
58
|
+
- robb@public.law
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- ".gitignore"
|
64
|
+
- ".rspec"
|
65
|
+
- ".travis.yml"
|
66
|
+
- Gemfile
|
67
|
+
- Gemfile.lock
|
68
|
+
- LICENSE.txt
|
69
|
+
- README.md
|
70
|
+
- Rakefile
|
71
|
+
- bin/console
|
72
|
+
- bin/setup
|
73
|
+
- law_string.gemspec
|
74
|
+
- lib/law_string.rb
|
75
|
+
homepage: https://github.com/public-law/law_string
|
76
|
+
licenses:
|
77
|
+
- MIT
|
78
|
+
metadata: {}
|
79
|
+
post_install_message:
|
80
|
+
rdoc_options: []
|
81
|
+
require_paths:
|
82
|
+
- lib
|
83
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
84
|
+
requirements:
|
85
|
+
- - ">="
|
86
|
+
- !ruby/object:Gem::Version
|
87
|
+
version: '0'
|
88
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
89
|
+
requirements:
|
90
|
+
- - ">="
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: '0'
|
93
|
+
requirements: []
|
94
|
+
rubyforge_project:
|
95
|
+
rubygems_version: 2.7.6
|
96
|
+
signing_key:
|
97
|
+
specification_version: 4
|
98
|
+
summary: 'String Utils including a specialized #titleize.'
|
99
|
+
test_files: []
|