capitalize_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a89cd7c8d70e2337f2f025ad4f0f0807e9c4ed884fbf7a02ad9912ae1f4097d
+  data.tar.gz: 2cec25cab661fcacd636133252da6720f54fa726337364b9df1bd99b71d52e87
+SHA512:
+  metadata.gz: de90462c0e36b85e600e68982e2ec5cbe602cc3544ac6c805c6c22d102e151ddb67774d0076584fef9cbb11bb30b6c533d32c59fe06100317ed4bb51158bce11
+  data.tar.gz: 7cd8809904377811111bbd1ae500c5a7a60ca90672a79ea451b5b99a57a8cd74e792d2b7e2a79c009823e869919b5fc4d389064c6f78bf807b18607554b84704

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 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [[0.1.0]] - 2020-10-21
+### Added
+- Initial capitalization logic and spec

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capitalize_attributes.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    capitalize_attributes (0.1.0)
+      activemodel (>= 5.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capitalize_attributes!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mark Oveson
+
+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,60 @@
+# Capitalize Attributes
+
+Capitalize Attributes is an ActiveModel extension that can automatically capitalize names and place-names that were entered as all-lowercase or all-uppercase text. This is often the case when a user is asked to provide personal information such as name, state, city, or country in an input form.
+
+Capitalize Attributes does not attempt to work magic on mixed-case text. If someone goes to the trouble of using the shift key at some point during input, we assume they know what they are doing. This gem only affects values that are entirely uppercase or entirely lowercase.
+
+Capitalize Attributes works with ActiveRecord and ActiveModel models.
+
+This gem was inspired by the workhorse `strip_attributes` gem: https://github.com/rmm5t/strip_attributes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capitalize_attributes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capitalize_attributes
+
+## Usage
+
+To use this gem, include the gem and then list the attributes that should be capitalized, like this:
+
+```ruby
+class MyModel < ::ApplicationRecord
+  include CapitalizeAttributes
+
+  capitalize_attributes :first_name, :last_name, :city
+end
+
+=> record = MyModel.new(first_name: "whisper", last_name: "SHOUT", city: "McCall")
+=> record.validate
+=> record.first_name
+#> "Whisper"
+=> record.last_name
+#> "Shout"
+=> record.city
+#> "McCall"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moveson/capitalize_attributes.
+
+## 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,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 "capitalize_attributes"
+
+# 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/capitalize_attributes.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/capitalize_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capitalize_attributes"
+  spec.version       = CapitalizeAttributes::VERSION
+  spec.authors       = ["Mark Oveson"]
+  spec.email         = ["mark.oveson@gmail.com"]
+
+  spec.summary       = %q{Automatically capitalizes names and place-names.}
+  spec.description   = %q{An ActiveModel extension that provides automatic capitalization for name and place-name attributes.}
+  spec.homepage      = "https://www.github.com/moveson/capitalize_attributes"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/moveson/capitalize_attributes/blob/master/CHANGELOG.md"
+
+  # 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('..', __FILE__)) 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_dependency "activemodel", ">= 5.0", "< 7.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

data/lib/capitalize_attributes.rb

@@ -0,0 +1,38 @@
+require "active_model"
+require "capitalize_attributes/selective_capitalizer"
+
+module CapitalizeAttributes
+  extend ::ActiveSupport::Concern
+
+  included do
+    before_validation :capitalize_record
+    class_attribute :capitalizable_attribute_names
+    self.capitalizable_attribute_names = []
+  end
+
+  module ClassMethods
+    def capitalize_attributes(*attributes)
+      attributes.each(&method(:capitalize_attribute))
+    end
+
+    def capitalize_attribute(attribute)
+      self.capitalizable_attribute_names << attribute.to_s
+    end
+  end
+
+  private
+
+  def capitalize_record
+    capitalizable_attributes = attributes.slice(*self.capitalizable_attribute_names)
+
+    capitalizable_attributes.each do |attr, value|
+      if value.present?
+        new_value = ::CapitalizeAttributes::SelectiveCapitalizer.perform(value)
+        self.send("#{attr}=", new_value) if new_value != value
+      end
+    end
+
+    # Don't cancel later callbacks
+    true
+  end
+end

data/lib/capitalize_attributes/matchers.rb

@@ -0,0 +1,49 @@
+module CapitalizeAttributes
+  module Matchers
+
+    # RSpec Examples:
+    #
+    #   it { is_expected.to capitalize_attribute(:first_name) }
+    #   it { is_expected.to capitalize_attributes(:first_name, :last_name) }
+    #   it { is_expected.not_to capitalize_attribute(:password) }
+    #   it { is_expected.not_to capitalize_attributes(:password, :encrypted_password) }
+    def capitalize_attribute(*attributes)
+      CapitalizeAttributeMatcher.new(attributes)
+    end
+
+    alias_method :capitalize_attributes, :capitalize_attribute
+
+    class CapitalizeAttributeMatcher
+      def initialize(attributes)
+        @attributes = attributes
+        @options = {}
+      end
+
+      def matches?(subject)
+        @attributes.all? do |attribute|
+          @attribute = attribute
+          subject.send("#{@attribute}=", "string")
+          subject.validate
+          subject.send(@attribute) == "String"
+        end
+      end
+
+      def failure_message # RSpec 3.x
+        "Expected #{@attribute} to be capitalized, but it was not"
+      end
+
+      alias_method :failure_message_for_should, :failure_message # RSpec 1.2, 2.x, and minitest-matchers
+
+      def failure_message_when_negated # RSpec 3.x
+        "Expected #{@attribute} not to be capitalized, but it was"
+      end
+
+      alias_method :failure_message_for_should_not, :failure_message_when_negated # RSpec 1.2, 2.x, and minitest-matchers
+      alias_method :negative_failure_message, :failure_message_when_negated # RSpec 1.1
+
+      def description
+        "capitalize #{@attributes.map { |el| "##{el}" }.to_sentence}"
+      end
+    end
+  end
+end

data/lib/capitalize_attributes/selective_capitalizer.rb

@@ -0,0 +1,58 @@
+require "active_support/core_ext/string"
+
+module CapitalizeAttributes
+  class SelectiveCapitalizer
+    ABBREVIATION_MAX_LENGTH = 4
+    ABBREVIATION_VOWELS = %w(a e i o u y).freeze
+    ROMAN_NUMERALS = %w(i ii iii iv v vi vii viii ix x).to_set.freeze
+    ALWAYS_DOWNCASED_WORDS = [
+      "de",
+      "of",
+      "on",
+      "the",
+    ].to_set.freeze
+
+    def self.perform(value)
+      words = value.split
+      words.map { |word| capitalize(word) }.join(" ")
+    end
+
+    def self.capitalize(word)
+      # Modify the word only if it is all lowercase or all uppercase.
+      # This avoids inadvertently capitalizing names intended to have mixed
+      # case, like "McDonald".
+      #
+      # If a word is mixed case, we assume the person entering it
+      # intends the case to be as entered.
+      return word unless word.downcase == word || word.upcase == word
+
+      downcased_word = word.downcase
+
+      case
+      when always_downcased?(downcased_word)
+        downcased_word
+      when abbreviation?(downcased_word)
+        word.upcase
+      when roman_numeral?(downcased_word)
+        word.upcase
+      else
+        word.titleize
+      end
+    end
+
+    def self.abbreviation?(downcased_word)
+      return false if downcased_word.length > ABBREVIATION_MAX_LENGTH
+
+      chars = downcased_word.chars
+      (chars - ABBREVIATION_VOWELS) == chars
+    end
+
+    def self.roman_numeral?(downcased_word)
+      ROMAN_NUMERALS.include?(downcased_word)
+    end
+
+    def self.always_downcased?(downcased_word)
+      ALWAYS_DOWNCASED_WORDS.include?(downcased_word)
+    end
+  end
+end

data/lib/capitalize_attributes/version.rb

@@ -0,0 +1,3 @@
+module CapitalizeAttributes
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: capitalize_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Oveson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: An ActiveModel extension that provides automatic capitalization for name
+  and place-name attributes.
+email:
+- mark.oveson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capitalize_attributes.gemspec
+- lib/capitalize_attributes.rb
+- lib/capitalize_attributes/matchers.rb
+- lib/capitalize_attributes/selective_capitalizer.rb
+- lib/capitalize_attributes/version.rb
+homepage: https://www.github.com/moveson/capitalize_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/moveson/capitalize_attributes
+  source_code_uri: https://www.github.com/moveson/capitalize_attributes
+  changelog_uri: https://github.com/moveson/capitalize_attributes/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Automatically capitalizes names and place-names.
+test_files: []