noble_names 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ace660f0424c63de5937d950c7442f706976f18d
-  data.tar.gz: e26dc771b958b344a201e30a11dc862ee22b277e
+  metadata.gz: 480cc88d0cb89226200c6b51d78cd942ffe5912c
+  data.tar.gz: cbf6278af0d3a18fc3eac8b2690fc60ccc241781
 SHA512:
-  metadata.gz: d9942342c95d151c76717f0163230cf9159a6ce969280d4948b4c8e7c041bb876be50ec5d32ef0b7eeeaa62c5c0da96959e4854faa3461628b80e29191349fa4
-  data.tar.gz: 840c0a06b942238fb1016a33ed0d25e7b49862bc7ccb78ee2e8b53e00b39309274f146d56369d835cf8bdc3967b29913900cf77175c18ff8e5dac82f8c90c79b
+  metadata.gz: 60b631d1ac2fb82ab19b8348181cd1826f616d03fdc06d4e4c8d11e89cfaeda331d9b8dca3e6ea2951afc3dcc4220a415f1f5a6057dc42f97d68489e2d5564e3
+  data.tar.gz: ddcdf43c06c6ce3b04601900c5b87f41011500305891c3b276d373a20b54a7cfbd0a16f4991c9b81ab66a066782b9f39dc5796200bbcdf9d20d91710d6aad8cd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in noble_names.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Paul Martensen
+
+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,69 @@
+# NobleNames
+
+A small Gem to capitalize names with regard to nobility particles.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noble_names'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noble_names
+
+## Usage
+
+Just
+```ruby
+require 'noble_names'
+```
+and use `String#to_title` to correctly format your names.
+```ruby
+"james of windsor".to_title #=> "James of Windsor"
+"joseph von und zu reinbeck".to_title #=> "Joseph von und zu Reinbeck"
+```
+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"
+```
+
+### Languages
+So far only English and German 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
+NobleNames.configure do |config|
+  config.languages = [:english,:spanish]
+end
+```
+This way other language particles will be ignored.
+```ruby
+"joseph von und zu reinbeck".to_title #=> "Joseph Von Und Zu Reinbeck"
+```
+
+## Development
+
+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).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+desc 'Run tests'
+task default: :test
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'noble_names'
+
+# 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

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/data/particles.yml

@@ -0,0 +1,26 @@
+particles:
+  german:
+    - 'von'
+    - 'und'
+    - 'zu'
+    - 'v.'
+    - 'vom'
+    - 'zum'
+    - 'der'
+    - 'dem'
+  english:
+    - 'of'
+    - 'de'
+  french:
+    - 'de'
+    - 'le'
+    - 'la'
+  spanish:
+    - 'de'
+    - 'da'
+  portuguese:
+    - 'de'
+    - 'da'
+    - 'du'
+
+

data/lib/noble_names/config.rb

@@ -0,0 +1,27 @@
+module NobleNames
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    def initialize
+      @languages = [:all]
+    end
+
+    def languages=(languages)
+      @languages = Array(languages)
+    end
+
+    def languages
+      @languages == [:all] ? SUPPORTED_LANGUAGES : @languages
+    end
+  end
+end

data/lib/noble_names/core_ext/string.rb

@@ -0,0 +1,19 @@
+module NobleNames
+  module CoreExt
+    module String
+      # Capitalizes each Word in a name
+      # except for those which are nobility particles
+      #   'jamie jones'.to_title      # => 'Jamie Jones'
+      #   'jamie of windsor'.to_title # => 'Jamie of Windsor'
+      def to_title
+        dup.to_title!
+      end
+
+      def to_title!
+        words = split(/\s+/)
+        words.map! { |w| NobleNames.noble_capitalize(w) }
+        replace(words * ' ')
+      end
+    end
+  end
+end

data/lib/noble_names/initializer.rb

@@ -0,0 +1,11 @@
+require_relative 'core_ext/string.rb'
+
+module NobleNames
+  # This is wrapped in a method so it isn't immediatly
+  # evaluated when its loaded
+  def self.initialize
+    String.class_eval do
+      include NobleNames::CoreExt::String
+    end
+  end
+end

data/lib/noble_names/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noble_names
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul Martensen
@@ -60,7 +60,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/particles.yml
 - lib/noble_names.rb
+- lib/noble_names/config.rb
+- lib/noble_names/core_ext/string.rb
+- lib/noble_names/initializer.rb
+- lib/noble_names/version.rb
 homepage: https://github.com/Haniyya/noble_names
 licenses:
 - MIT