noble_names 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8577468ea38ce947a30e3d08d4b4ec276428027
-  data.tar.gz: a70419e9e7fd703dbab474274539ac4e018c7a45
+SHA256:
+  metadata.gz: aca9a5ec054a904befe7713c8b1bb2de83b2badde064e28ba274ef0d94b74992
+  data.tar.gz: 67720c835320318c01b2193755928f82bde606db4ab360daa2cd76625fef4e83
 SHA512:
-  metadata.gz: f91c330cb728a195129f87571205496a2e255be87a1e10892b65987701a8fe4d3a129ecfb060522f26bb584855337af6375dfa5bd97aabf0e3bc4e87a8e7b612
-  data.tar.gz: 458b24de1913870098e1e5aac7f5080fddd0b0b4bba36556456cae87f926d1085cfc4783c7f5340a3a6acbbd8452b8198fa8892cce9d06375e80872813a07173
+  metadata.gz: 37c81bd00fb1ec5955179e1b6cecc2e278049be0b3bdb607d4307b7172d7b8bd118da9318c0cb79ae428ff1df7da872644c48b0e51dfcf1d9d63f7556e611a98
+  data.tar.gz: 84ab027a7ceb38f420c17410e6f9136592bc7bdc38297b517f4de1d4f88b0e82686aa477d8feb7c45f20d1847e948ac019ad4c1c6fc0b73bea1fd058391d65c9

data/.rubocop.yml

@@ -1,4 +1,4 @@
-Style/AlignParameters:
+Layout/AlignParameters:
   # Alignment of parameters in multi-line method calls.
   #
   # The `with_first_parameter` style aligns the following lines along the same
@@ -16,3 +16,11 @@ Style/AlignParameters:
   SupportedStyles:
     - with_first_parameter
     - with_fixed_indentation
+
+Metrics/BlockLength:
+  # Ignore the block lengths in these files as they are based on long blocks.
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'test/**/*.rb'

data/.travis.yml

@@ -2,14 +2,12 @@ language: ruby
 rvm:
   - jruby
   - 2.2.4
-  - 2.2.1
-  - 1.9.3
-  - 2.3.0
-before_install: gem install bundler flay flog rubocop
+  - 2.3.3
+  - 2.4.1
+  - 2.5.0
 install:
   - bundle install --retry=3
 script:
-  - bundle exec rake source_encoding
   - bundle exec rake test
   - bundle exec rubocop
   - bundle exec flay

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+<!--
+
+// Please add your own contribution below inside the Master section, no need to
+// set a version number, that happens during a deploy.
+//
+// These docs are aimed at users rather than danger developers, so please limit technical
+// terminology in here.
+
+-->
+
+## master
+
+### 1.0.0
+
+* Added link to rubydocs documentation.
+* Added project to code-climate.
+* Added support for native UTF-8 upcasing for ruby `>= 2.4`.
+* Drop support for ruby 1.9.3 and updated development dependencies.

data/README.md

@@ -1,5 +1,8 @@
 # NobleNames
 [![Build Status](https://travis-ci.org/Haniyya/noble_names.svg?branch=master)](https://travis-ci.org/Haniyya/noble_names)
+[![Documentation
+Status](https://readthedocs.org/projects/noble-names/badge/?version=latest)](http://www.rubydoc.info/gems/noble_names)
+[![Maintainability](https://api.codeclimate.com/v1/badges/614fe2d4f930a092e6f5/maintainability)](https://codeclimate.com/github/Haniyya/noble_names/maintainability)
 
 A small Gem to capitalize names with regard to nobility particles and prefixes.
 
@@ -80,10 +83,10 @@ This gem has no runtime-dependencies outside of the standard library and is
 therefore compatible with the following ruby versions:
 
 - jruby
+- 2.5.0
+- 2.4.3
 - 2.3.0
 - 2.2.4
-- 2.2.1
-- 1.9.3
 
 Other verions might work to but are not tested in ci so far.
 

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+
 require 'rake/testtask'
 
 desc 'Run tests'

data/lib/noble_names.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 require 'noble_names/match_index'
 require 'noble_names/version'
 require 'noble_names/config'
@@ -8,90 +8,98 @@ require 'noble_names/data'
 # The main Module that has all necessary functions to
 # process names.
 module NobleNames
-  # Capitalizes a word if it needs to be capitalized.
-  # @param [String] word the word that needs to be capitalized.
-  # @return [String] word the word either capitalized or not.
-  def self.noble_capitalize(word)
-    prefix = Data.nobility_prefixes.prefix?(word)
-    if Data.nobility_particles.in_particle_list?(word)
-      word.downcase
-    elsif prefix
-      capitalize(prefix) + capitalize(word.gsub(prefix, ''))
-    else
-      capitalize(word)
-    end
-  end
+  # Records whether String#upcase supports UTF-8 characters.
+  STANDARD_UPACE_SUPPORT = (RUBY_VERSION.to_f >= 2.4)
 
-  # Upcases the first small letters in each word,
-  # seperated by hyphons.
-  # The word is also not capitalized if it already contains
-  # a capitalized letter. This is to allow Business Names
-  # to have custom capitalization.
-  # But beware, words seperated by spaces stay small.
-  # @return [String] the capitalized word.
-  # @example
-  #   capitalize('hans-ebert')  #=> 'Hans-Ebert'
-  #   capitalize('john')        #=> 'John'
-  #   capitalize('john james')  #=> 'John james'
-  #   capitalize('eBase')       #=> 'eBase'
-  def self.capitalize(word)
-    if word =~ /[A-Z]|Ä|Ö|Ü/
-      word
-    else
-      word.gsub first_small_letters do |letter|
-        upcase(letter)
+  class << self
+    # Capitalizes a word if it needs to be capitalized.
+    # @param [String] word the word that needs to be capitalized.
+    # @return [String] word the word either capitalized or not.
+    def noble_capitalize(word)
+      prefix = Data.nobility_prefixes.prefix?(word)
+      if Data.nobility_particles.in_particle_list?(word)
+        word.downcase
+      elsif prefix
+        capitalize(prefix) + capitalize(word.gsub(prefix, ''))
+      else
+        capitalize(word)
       end
     end
-  end
 
-  # Upcases a letter even if it is a german mutated vowel.
-  # @return [String] letter the upcased letter.
-  # @example
-  #   upcase('t')         #=> 'T'
-  def self.upcase(letter)
-    match = letter.match(/ä|ö|ü/)
-    if match
-      case match.to_s
-      when 'ä' then 'Ä'
-      when 'ö' then 'Ö'
-      when 'ü' then 'Ü'
+    # Upcases the first small letters in each word,
+    # seperated by hyphons.
+    # The word is also not capitalized if it already contains
+    # a capitalized letter. This is to allow Business Names
+    # to have custom capitalization.
+    # But beware, words seperated by spaces stay small.
+    # @return [String] the capitalized word.
+    # @example
+    #   capitalize('hans-ebert')  #=> 'Hans-Ebert'
+    #   capitalize('john')        #=> 'John'
+    #   capitalize('john james')  #=> 'John james'
+    #   capitalize('eBase')       #=> 'eBase'
+    def capitalize(word)
+      if word =~ /[A-Z]|Ä|Ö|Ü/
+        word
+      else
+        word.gsub first_small_letters do |letter|
+          upcase(letter)
+        end
       end
-    else letter.upcase
     end
-  end
 
-  # A Regex literal to find the first letter of a string
-  # as well as the first letter after a hyphon.
-  # @return [Regexp] first_small_letters the regexp in question
-  def self.first_small_letters
-    /((\A.|(?<=\-).))/
-  end
+    # Checks weither a word is in the business particle list
+    # @param [String] word The word in question.
+    # @return [Boolean] result `true` if `word` is a business-particle
+    #   `false` otherwise
+    def business_particle?(word)
+      Data.business_particles.in_particle_list? word
+    end
 
-  # Checks weither a word is in the business particle list
-  # @param [String] word The word in question.
-  # @return [Boolean] result `true` if `word` is a business-particle
-  #   `false` otherwise
-  def self.business_particle?(word)
-    Data.business_particles.in_particle_list? word
-  end
+    # Corrects only the business particle and leaves the
+    # other words alone.
+    # @param [Array] words An array of words to be checked.
+    # @return [Array] words An array of corrected words.
+    # @example A Business Name
+    #   correct_business_particles([
+    #     'cool', 'and', 'hip', 'gmbh'
+    #   ])                    #=> ['cool', 'and', 'hip', 'GmbH']
+    def correct_business_particles(words)
+      words.map! do |word|
+        if business_particle?(word)
+          word
+            .replace(Data.business_particles.particles[word.downcase])
+        else
+          noble_capitalize(word)
+        end
+      end
+    end
 
-  # Corrects only the business particle and leaves the
-  # other words alone.
-  # @param [Array] words An array of words to be checked.
-  # @return [Array] words An array of corrected words.
-  # @example A Business Name
-  #   correct_business_particles([
-  #     'cool', 'and', 'hip', 'gmbh'
-  #   ])                    #=> ['cool', 'and', 'hip', 'GmbH']
-  def self.correct_business_particles(words)
-    words.map! do |word|
-      if business_particle?(word)
-        word
-          .replace(Data.business_particles.particles[word.downcase])
-      else
-        noble_capitalize(word)
+    private
+
+    # Upcases a letter even if it is a german mutated vowel.
+    # @return [String] letter the upcased letter.
+    # @example
+    #   upcase('t')         #=> 'T'
+    def upcase(letter)
+      return letter.upcase if STANDARD_UPACE_SUPPORT
+      match = letter.match(/ä|ö|ü/)
+      if match
+        case match.to_s
+        when 'ä' then 'Ä'
+        when 'ö' then 'Ö'
+        when 'ü' then 'Ü'
+        end
+      else letter.upcase
       end
     end
+
+    # A Regex literal to find the first letter of a string
+    # as well as the first letter after a hyphon.
+    # @return [Regexp] first_small_letters the regexp in question
+    def first_small_letters
+      /((\A.|(?<=\-).))/
+    end
   end
 
   # Applies the core extension

data/lib/noble_names/config.rb

@@ -1,8 +1,8 @@
-#-- encoding: UTF-8
+
 # :nodoc:
 module NobleNames
   SUPPORTED_LANGUAGES =
-    [:german, :english, :french, :spanish, :portuguese, :dutch].freeze
+    %i[german english french spanish portuguese dutch].freeze
 
   class << self
     attr_writer :configuration

data/lib/noble_names/core_ext/string.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 module NobleNames
   module CoreExt
     # This Module gives {String} the capability to

data/lib/noble_names/data.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 module NobleNames
   # The module responsible for maintaining and delivering
   # the match data as defined in the `data` directory.
@@ -13,7 +13,13 @@ module NobleNames
     # Otherwise it calls super.
     def self.method_missing(method, *args, &block)
       var = instance_variable_get("@#{method}")
-      var ? var : super(method, args, block)
+      var ? var : super
+    end
+
+    # Remember to define respond_to_missing.
+    def self.respond_to_missing?(method, *args, &block)
+      var = instance_variable_get("@#{method}")
+      var ? true : super
     end
   end
 end

data/lib/noble_names/initializer.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 require_relative 'core_ext/string.rb'
 
 # :nodoc:

data/lib/noble_names/match_index.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 require 'yaml'
 
 module NobleNames
@@ -51,7 +51,7 @@ module NobleNames
     # @return [Boolean] `true` if `word` is in the particle_list,
     #   `false` otherwise.
     def in_particle_list?(word)
-      reindex if @languages != NobleNames.configuration.languages
+      reindex if languages != NobleNames.configuration.languages
       particles.key? word
     end
 
@@ -61,8 +61,8 @@ module NobleNames
     #   used languages.
     def selected_data
       @selected_data ||=
-        @data
-        .select { |l| @languages.include? l.to_sym }
+        data
+        .select { |l| languages.include? l.to_sym }
         .values
         .flatten
     end
@@ -75,9 +75,9 @@ module NobleNames
     # @example
     #   prefix?('mcdormer')           #=> 'mc'
     def prefix?(word)
-      reindex if @languages != NobleNames.configuration.languages
+      reindex if languages != NobleNames.configuration.languages
       prefixes.each do |pre|
-        return pre if (word =~ Regexp.new(pre)) == 0
+        return pre unless (word =~ Regexp.new('^' + pre.to_s)).nil?
       end
       nil
     end
@@ -86,10 +86,15 @@ module NobleNames
 
     # Resets the state of the MatchIndex
     def reindex
-      @languages = NobleNames.configuration.languages
-      @selected_data = nil
-      @prefixes = nil
-      @particles = nil
+      self.languages     = NobleNames.configuration.languages
+      self.selected_data = nil
+      self.prefixes      = nil
+      self.particles     = nil
     end
+
+    private
+
+    attr_accessor :languages
+    attr_writer :particles, :prefixes, :selected_data
   end
 end

data/lib/noble_names/version.rb

@@ -1,4 +1,4 @@
-#-- encoding: UTF-8
+
 module NobleNames
-  VERSION = '0.1.5'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noble_names
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Martensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: flay
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: '0.52'
 description: |2
       This Gem uses a list of nobility particles to keep track of what to
       capitalize and what not.
@@ -93,6 +93,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -131,9 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A gem that titleizes strings while respecting certain linguistic differences.
 test_files: []
-has_rdoc: