noble_names 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 480cc88d0cb89226200c6b51d78cd942ffe5912c
-  data.tar.gz: cbf6278af0d3a18fc3eac8b2690fc60ccc241781
+  metadata.gz: 1c5d9da46ce4f5d0cf223b6a634fc8dae69c1f5b
+  data.tar.gz: b337349e71df3a4895c26b1ec006fe1a288e65b0
 SHA512:
-  metadata.gz: 60b631d1ac2fb82ab19b8348181cd1826f616d03fdc06d4e4c8d11e89cfaeda331d9b8dca3e6ea2951afc3dcc4220a415f1f5a6057dc42f97d68489e2d5564e3
-  data.tar.gz: ddcdf43c06c6ce3b04601900c5b87f41011500305891c3b276d373a20b54a7cfbd0a16f4991c9b81ab66a066782b9f39dc5796200bbcdf9d20d91710d6aad8cd
+  metadata.gz: 2633569e625d6b881027d160115fc0691a595eee5db40adf1ee3e48787602f39276aea2e43b3647d4f402d8e50cdf1114e5a6088dc89aef9cfbe51f593241b11
+  data.tar.gz: 2d44bd790a2f263cc7ddb7d7dfe70514eb2c585eb3df9a78e2ba139d9f62c404a438f7deb7dbb06e0b3753f7821df6d67c3a7d7a48ec2f7b9af9163725cf914e

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Style/AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same
+  # column as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_fixed_indentation
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation

data/.travis.yml

@@ -1,4 +1,14 @@
 language: ruby
 rvm:
+  - jruby
   - 2.2.4
-before_install: gem install bundler -v 1.11.2
+  - 2.2.1
+  - 1.9.3
+  - 2.3.0
+before_install: gem install bundler flay flog rubocop
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake test
+  - bundle exec rubocop
+  - bundle exec flay

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+--readme README.md
+lib/**/*.rb 

data/README.md

@@ -1,6 +1,7 @@
 # NobleNames
+[![Build Status](https://travis-ci.org/Haniyya/noble_names.svg?branch=master)](https://travis-ci.org/Haniyya/noble_names)
 
-A small Gem to capitalize names with regard to nobility particles.
+A small Gem to capitalize names with regard to nobility particles and prefixes.
 
 ## Installation
 
@@ -26,18 +27,19 @@ require 'noble_names'
 ```
 and use `String#to_title` to correctly format your names.
 ```ruby
-"james of windsor".to_title #=> "James of Windsor"
+"james of windsor".to_title           #=> "James of Windsor"
 "joseph von und zu reinbeck".to_title #=> "Joseph von und zu Reinbeck"
+"tywin mclannister".to_title          #=> "Tywin McLannister"
 ```
 you can also use the bang method:
 ```ruby
 my_string = "joseph von und zu reinbeck"
 my_string.to_title!
-my_string                                 #=> "Joseph von und zu Reinbeck"
+my_string                             #=> "Joseph von und zu Reinbeck"
 ```
 
 ### Languages
-So far only English and German are supported.
+So far English, German, French, Spanish and Portuguese are supported.
 By default all available languages are used. If you want to configure which one
 to use for your application, you can do it like so:
 ```ruby
@@ -54,14 +56,29 @@ This way other language particles will be ignored.
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+To install this gem onto your local machine, run `bundle exec rake install`. 
 
 ## Contributing
-
-To add more particles from other languages, just add them to the
-`data/particles.yml` file.
-Bug reports and pull requests are welcome on GitHub at https://github.com/Haniyya/noble_names.
-
+- Fork it ( https://github.com/Haniyya/noble_names/fork )
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create a new Pull Request
+
+To add more particles or prefixes from other languages, just add them to the
+`data/particles.yml` or `data/prefixes.yml` file respectively.
+
+## Compatability
+This gem has no runtime-dependencies outside of the standard library and is
+therefore compatible with the following ruby versions:
+
+- jruby
+- 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.
 
 ## License
 

data/bin/build.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+echo "Running build on $RUBY_VERSION."
+bundle install --retry=3
+bundle exec rake test
+bundle exec rubocop
+bundle exec flay

data/data/prefixes.yml

@@ -0,0 +1,3 @@
+prefixes:
+  english:
+    - 'mc'

data/lib/noble_names.rb

@@ -1,28 +1,46 @@
 require 'noble_names/version'
 require 'noble_names/config'
 require 'noble_names/initializer'
-require 'yaml'
+require 'noble_names/data'
 
+# {include:file:README.md}
 module NobleNames
-  SUPPORTED_LANGUAGES = [:german, :english, :french, :spanish, :portuguese].freeze
-
-  DATA_PATH = File.expand_path('../../data/', __FILE__).freeze
-
-  PARTICLES = YAML.load_file(File.expand_path(
-                               'particles.yml', DATA_PATH
-  ))['particles'].freeze
-
+  # Capitalizes a word if it needs to be capitalized.
+  # @param [String] word the word that needs to be capitalized.
+  # @param [String] word the word either capitalized or not.
   def self.noble_capitalize(word)
-    in_particle_list?(word) ? word : word.capitalize
+    prefix = prefix?(word)
+    if in_particle_list?(word)
+      word
+    elsif prefix
+      prefix.capitalize + word.gsub(prefix, '').capitalize
+    else
+      word.capitalize
+    end
   end
 
+  # Checks weither a word is in the nobility particle list.
+  # @param [String] word the word that is checked.
+  # @return [Boolean] `true` if `word` is in the particle_list,
+  #   `false` otherwise.
   def self.in_particle_list?(word)
-    particles = PARTICLES
-                .select { |lang| NobleNames.configuration.languages.include?(lang.to_sym) }
-                .values.flatten
-    particles.include? word
+    Data.particles.include? word
+  end
+
+  # Checks weither a word has a prefix as defined in
+  # `data/prefixes.yml` and returns it.
+  # @param [String] word the word that needs to be checked.
+  # @return [String] pre the Prefix of the word. `nil` if
+  #   it has none.
+  # @example
+  #   prefix?('james mcdormer')           #=> 'mc'
+  def self.prefix?(word)
+    Data.prefixes.each do |pre|
+      return pre if (word =~ Regexp.new(pre)) == 0
+    end
+    nil
   end
 
-  # Extends String
+  # Applies the core extension
   initialize
 end

data/lib/noble_names/config.rb

@@ -1,4 +1,8 @@
+# :nodoc:
 module NobleNames
+  SUPPORTED_LANGUAGES =
+    [:german, :english, :french, :spanish, :portuguese].freeze
+
   class << self
     attr_writer :configuration
 
@@ -7,19 +11,35 @@ module NobleNames
     end
   end
 
+  # Here you can configure how the module behaves.
+  # @example Only use german
+  #   NobleNames.configure do |config|
+  #     config.languages = :german
+  #   end
+  # @example Use multiple languages
+  #   NobleNames.configure do |config|
+  #     config.languages = [:german, :spanish]
+  #   end
   def self.configure
     yield(configuration)
   end
 
+  # The Configuration-Class for NobleNames,
+  # Here you can set the languages you want supported.
   class Configuration
     def initialize
       @languages = [:all]
     end
 
+    # Setter for `@languages`.
+    # @param [Symbol] languages is turned into an `Array`.
     def languages=(languages)
       @languages = Array(languages)
     end
 
+    # Returns all supported languages if `@languages` is set to
+    # `:all`. Returns the configured languages otherwise
+    # @return [Array] languages an array of language symbols.
     def languages
       @languages == [:all] ? SUPPORTED_LANGUAGES : @languages
     end

data/lib/noble_names/core_ext/string.rb

@@ -1,14 +1,24 @@
 module NobleNames
   module CoreExt
+    # This Module gives {String} the capability to
+    # titleize itself.
     module String
       # Capitalizes each Word in a name
       # except for those which are nobility particles
+      # @return [String] name a new String matching the old `self`
+      #   titleized.
+      # @example Titleize names
       #   'jamie jones'.to_title      # => 'Jamie Jones'
       #   'jamie of windsor'.to_title # => 'Jamie of Windsor'
       def to_title
         dup.to_title!
       end
 
+      # Does the same as {String#to_title} but replaces the old string.
+      # @example Titleize a name
+      #   str = 'jamie of windsor'
+      #   str.to_title!
+      #   str                     #=> 'Jamie of Windsor'
       def to_title!
         words = split(/\s+/)
         words.map! { |w| NobleNames.noble_capitalize(w) }

data/lib/noble_names/data.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module NobleNames
+  # The module responsible for maintaining and delivering
+  # the match data as defined in the `data` directory.
+  module Data
+    DATA_PATH = File.expand_path('../../../data/', __FILE__).freeze
+    MATCH_DATA = Hash[Dir.glob(DATA_PATH + '/*.yml').collect do |f|
+      yaml = YAML.load_file(f)
+      yaml.first
+    end]
+
+    def self.particles
+      select_languages(MATCH_DATA['particles'])
+    end
+
+    def self.prefixes
+      select_languages(MATCH_DATA['prefixes'])
+    end
+
+    def self.select_languages(collection)
+      collection
+        .select { |l| NobleNames.configuration.languages.include? l.to_sym }
+        .values
+        .flatten
+    end
+  end
+end

data/lib/noble_names/initializer.rb

@@ -1,5 +1,6 @@
 require_relative 'core_ext/string.rb'
 
+# :nodoc:
 module NobleNames
   # This is wrapped in a method so it isn't immediatly
   # evaluated when its loaded

data/lib/noble_names/version.rb

@@ -1,3 +1,3 @@
 module NobleNames
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noble_names
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paul Martensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.8.4
-description: "This Gem uses a list of nobility particles to keep track of what to
-  \n  capitalize and what not."
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+description: |2
+      This Gem uses a list of nobility particles to keep track of what to
+      capitalize and what not.
 email:
 - paul.martensen@gmx.de
 executables: []
@@ -61,17 +90,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/build.sh
 - bin/console
 - bin/setup
 - data/particles.yml
+- data/prefixes.yml
 - lib/noble_names.rb
 - lib/noble_names/config.rb
 - lib/noble_names/core_ext/string.rb
+- lib/noble_names/data.rb
 - lib/noble_names/initializer.rb
 - lib/noble_names/version.rb
 homepage: https://github.com/Haniyya/noble_names