address_titlecase 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89a94ec779de3ec14ee166a34206e1b676512f3609809dc13d204b9686e63c75
+  data.tar.gz: 972d4ae32751ff4bdecbb93162e683219fcf2f675dd6f294cd52912b04d92cc2
+SHA512:
+  metadata.gz: 174280271ff568569298780d87828f9783f94fab655db2e7b126fa1a41333d657b25761325c33129b4aa02ff0850cfdee35d0df3098135e290cde11a6fecc21b
+  data.tar.gz: 83bab68c5b9c5492813bc2e8fcfef3c7a4f882e2c3fbae071b532161e74d23ac59c732668d246c41a539140ebf84092da29fa73ff1cbef47718f9eb3117ef84d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4
+script:
+ - bundle
+ - bundle exec rubocop
+ - bundle exec rspec 

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in address_titlecase.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 juliannaroen
+
+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,41 @@
+# Address Titlecase
+
+[![Build Status](https://travis-ci.com/juliannaroen/address_titlecase.svg?token=GqtPi1VKmx9gqq9JuxSW&branch=master)](https://travis-ci.com/juliannaroen/address_titlecase)
+
+Titleize US addresses so that states, directions, and other abbreviations that would normally be titlecased by [`String#titleize`](https://apidock.com/rails/String/titleize) remain uppercase.
+
+```ruby
+> "123 SESAME ST SE, SALEM, OR 97301".address_titlecase
+=> "123 Sesame St SE, Salem, OR 97301"
+```
+
+## Options
+
+Customize transformations by providing an `overrides` argument where the keys denote the words/abbreviations that should be mapped to specific values.
+
+```ruby
+> "123 SESAME ST SE, SALEM, OR 97301".address_titlecase(overrides: { 'ST' => 'ST', 'SE' => 'Se' })
+=> "123 Sesame ST Se, Salem, OR 97301"
+```
+
+`address_titlecase` is also aliased as `address_titleize`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'address_titlecase'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install address_titlecase
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/address_titlecase.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'address_titlecase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'address_titlecase'
+  spec.version       = AddressTitlecase::VERSION
+  spec.authors       = ['juliannaroen']
+  spec.email         = ['jsroen@gmail.com']
+
+  spec.summary       = 'Smartly capitalize US addresses'
+  spec.homepage      = 'https://github.com/juliannaroen/address_titlecase'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'address_titlecase'
+
+# 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/lib/address_titlecase.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'address_titlecase/version'
+require 'address_titlecase/titleizer'

data/lib/address_titlecase/titleizer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module AddressTitlecase
+  # AddressTitlecase::Titleizer
+  # .titleize
+  #
+  #   Will titlecase a given US address string.
+  #   Words that should be overridden can be passed as an overrides hash option.
+  #
+  #   Ex:
+  #     AddressTitlecase::Titleizer.titleize('123 sesame st', overrides: { 'st' => 'ST' }) => '123 Sesame ST'
+  class Titleizer
+    class << self
+      US_STATES = %w[AL AK AZ AR CA CO CT DE FL GA HI ID IL IN IA KS KY LA ME MD MA MI MN MS MO MT NE NV NH NJ NM NY NC ND OH OK OR PA RI SC SD TN TX UT VT VA WA WV WI WY].freeze
+      TERRITORIES = %w[AS DC FM GU MH MP PW PR VI].freeze
+      MILITARY = %w[APO FPO MPO AE AA AP].freeze
+      DIRECTIONS = %w[NE NW SE SW].freeze
+      COUNTRIES = %w[USA].freeze
+      MISC = %w[PO RR].freeze
+
+      REMAIN_UPCASE = US_STATES | TERRITORIES | MILITARY | DIRECTIONS | COUNTRIES | MISC
+
+      def titleize(address, opts)
+        overrides = opts['overrides'] || opts[:overrides] || {}
+        address.gsub(/\w+['’]?\w*/) do |word|
+          overriden_word = overrides[word]
+          if overriden_word
+            overriden_word
+          elsif REMAIN_UPCASE.include?(word.upcase)
+            word.upcase
+          else
+            word.capitalize
+          end
+        end
+      end
+    end
+  end
+end
+
+# String
+# .address_titlecase
+#
+#   Allow the AddressTitlecase::Titleizer.titleize method to be called on a String object as `address_titlecase`.
+#   Method is also aliased to `address_titleize`.
+#
+#   Ex:
+#     '123 sesame st'.address_titlecase(overrides: {'st' => 'ST'}) => '123 Sesame ST'
+class String
+  def address_titlecase(opts = {})
+    AddressTitlecase::Titleizer.titleize(self, opts)
+  end
+
+  alias address_titleize address_titlecase
+end

data/lib/address_titlecase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AddressTitlecase
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: address_titlecase
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- juliannaroen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry-byebug
+  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: rake
+  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: 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: rubocop
+  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'
+description: 
+email:
+- jsroen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- address_titlecase.gemspec
+- bin/console
+- bin/setup
+- lib/address_titlecase.rb
+- lib/address_titlecase/titleizer.rb
+- lib/address_titlecase/version.rb
+homepage: https://github.com/juliannaroen/address_titlecase
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Smartly capitalize US addresses
+test_files: []