titleize_br 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff00bc73a8ff03715df6c49b937bc9471089fa0e8a8a335ed21a399461c336c4
+  data.tar.gz: 00c77b67bf913d6969844401400123253033fd6545324b0ef72f482047843dc6
+SHA512:
+  metadata.gz: 656cb7b5b352674c0e94a5c7561b6661b7a84e2d5dec7d99db377bf4309578952b8f4161b1d20cf163ca092e9fad8de912a5f7d8797987ec00ea728a8faeed92
+  data.tar.gz: 2f61ad4cb369bb0c6933617ababa1dbea59d2c07bd39991b5d69ae055c12f4ef7a1540feb111eec8ba704ed8c5b40ae96d74f523fccf8be36dd2ae316ce64eee

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*

data/.ruby-gemset

@@ -0,0 +1 @@
+titleize_br

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-04-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in titleize_br.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    titleize_br (1.0.0)
+      activesupport (> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  titleize_br!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gabriel Rodríguez
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gabriel Rodriguez
+
+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,44 @@
+# TitleizeBr
+
+This gem is gives brazilians an easy way to titleize strings with our own grammar rules from ABNT.
+
+```ruby
+'o teste de titleize'.titleize
+=> "O Teste De Titleize"
+'o teste de titleize'.titleize_br
+=> "O Teste de Titleize" 
+```
+
+- First character or word is always capitalized
+- Connectives (pronouns and articles) are not capitalized unless they appear first
+
+Please open an issue or pull request if you find a word that is not being treated correctly
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add titleize_br
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install titleize_br
+
+## Usage
+
+`'string'.titleize_br`
+
+## 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 the created tag, 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/gabrielrdrguez/titleize_br.
+Please use imperative commit messages: https://cbea.ms/git-commit/#imperative 
+
+## 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 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/core_ext/string.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class String
+  def titleize_br
+    TitleizeBr.titleize(self)
+  end
+end

data/lib/titleize_br/version.rb

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

data/lib/titleize_br.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'titleize_br/version'
+require 'active_support/core_ext/string/inflections'
+require 'core_ext/string'
+
+module TitleizeBr
+  class Error < StandardError; end
+  CONNECTIVES = %w[a ao aos as com da das de do dos e em na nas no nos o os ou para pela pelas pelo pelos pra pras pro
+                   pros um uma à às á é].freeze
+  class << self
+    def titleize(string)
+      parts = string.titleize.split(' ').map do |word|
+        infer_case_of_word(word)
+      end
+
+      parts.first.capitalize! if connective?(parts.first)
+      parts.join(' ')
+    end
+
+    private
+
+    def connective?(string)
+      regex = /^(#{CONNECTIVES.join('|')})$/i
+      string.strip.match?(regex)
+    end
+
+    def roman_numeral?(word)
+      word.strip.match(/^M{0,3}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})$/i)
+    end
+
+    def infer_case_of_word(word)
+      word.downcase! if connective?(word)
+      word.upcase! if roman_numeral?(word)
+      word
+    end
+  end
+end

data/sig/titleize_br.rbs

@@ -0,0 +1,4 @@
+module TitleizeBr
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/titleize_br.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/titleize_br/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'titleize_br'
+  spec.version = TitleizeBr::VERSION
+  spec.authors = ['Gabriel Rodriguez']
+  spec.email = ['gabriel.rdrguez@gmail.com']
+
+  spec.summary = 'Rails String#titleize but with brazilian ABNT rules.'
+  spec.homepage = 'https://github.com/gabrielrdrguez/titleize_br'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/gabrielrdrguez/titleize_br'
+  spec.metadata['changelog_uri'] = 'https://github.com/gabrielrdrguez/titleize_br/blob/main/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'activesupport', '> 4'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: titleize_br
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Rodriguez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- gabriel.rdrguez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_ext/string.rb
+- lib/titleize_br.rb
+- lib/titleize_br/version.rb
+- sig/titleize_br.rbs
+- titleize_br.gemspec
+homepage: https://github.com/gabrielrdrguez/titleize_br
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gabrielrdrguez/titleize_br
+  source_code_uri: https://github.com/gabrielrdrguez/titleize_br
+  changelog_uri: https://github.com/gabrielrdrguez/titleize_br/blob/main/CHANGELOG.md.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Rails String#titleize but with brazilian ABNT rules.
+test_files: []