Giter VIP home page Giter VIP logo

name-tamer's Introduction

NameTamer

Gem Version Code Climate Coverage Status Developer status build status Codeship Status for Xenapto/name-tamer

NameTamer: making sense of names

Installation

Add this line to your application's Gemfile:

gem 'name-tamer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install name-tamer

Usage

Examples:

NameTamer['Mr. John Q. Smith III, MD'].simple_name # => John Smith

Or you can create an instance if you need several versions of the name

name_tamer = NameTamer.new 'Mr. John Q. Smith III, MD'
name_tamer.slug # => john-smith
name_tamer.simple_name # => John Smith
name_tamer.nice_name # => John Q. Smith
name_tamer.contact_type # => :person

NameTamer will make an intelligent guess at the type of the name but it's not infallible. NameTamer likes it if you tell it whether the name is a person or an organization:

name_tamer = NameTamer.new 'Di Doo Doo d.o.o.', contact_type: :organization
name_tamer.simple_name # => Di Doo Doo

Contributing

There must be lots of name suffixes and prefixes that I haven't catered for, so please get in touch if name-tamer doesn't recognise one that you've found.

If there are any other common two-word family names that I've missed then please let me know. name-tamer tries to make sure Helena Bonham Carter gets slugified to helena-bonham-carter and not helena-carter, but I'm sure there are loads of two-word family names I don't know about.

Please read all the following articles before contributing:

How to contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Acknowledgements

  1. Thanks to Ryan Bigg for the guide to making your first gem https://github.com/radar/guides/blob/master/gem-development.md

name-tamer's People

Contributors

dominicsayers avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.