parse_name_from_email 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ee897aba1e60e21402a1cf07fcc85ab8e123184
-  data.tar.gz: fc113234ab0becf423fec1ffc4a0662f766bf2b5
+SHA256:
+  metadata.gz: 1c37fd43925e0c838c5f8553eb87d8c94f6dcb222a0cb9bd7a575f8f1d5b7aba
+  data.tar.gz: 120d5c5a32999e490171ff0402dd05b25696c426ddacc99025b16a740a74659b
 SHA512:
-  metadata.gz: 996df631c20f641e84ba590057f9fec3383fd29ceaf0073df4289de588aa1cbb3b52e5373e1d3773ae006cf2c75e0f566725b44e0b74ca8f1fba32a47aac6717
-  data.tar.gz: 4bd4b45421fd8af03941a9bc2755880d8aaa944ffc6339d00900711cbe498877c3337ec025938c9dd14804274dc6f96cfa637a44c1c6317e1fa1854b0dd09cb3
+  metadata.gz: 0c99cb038a424cf080c904148e42f70484a57ecb732f6f684ce64f4ad5932951084998bcf699c1ccaca7967307c6f451682fc994cd9991f4c1c43aca78368698
+  data.tar.gz: 5fafb380692ae78b2f8f7dfd6c7c7f3444a904379d798f7c6bbb926e253c1b24eba0550d049b92616483671be9a3ea50fc9faf3841f6e68c3ae577f871ad4a24

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.6.0
+
+before_install:
+  - gem update bundler
+
+matrix:
+  include:
+    - rvm: 2.0
+      gemfile: gemfiles/ruby-2.0
+    - rvm: 2.1
+      gemfile: gemfiles/ruby-2.1
+    - rvm: 2.2
+      gemfile: gemfiles/ruby-2.2
+    - rvm: 2.2.3
+      gemfile: gemfiles/ruby-2.2
+    - rvm: 2.6.0
+      gemfile: gemfiles/ruby-2.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parse_name_from_email.gemspec
+gemspec
+
+gem 'activesupport'
+
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Prokop Simek, Applifting
+
+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,102 @@
+# ParseNameFromEmail
+
+[![Gem Version](https://badge.fury.io/rb/parse_name_from_email.svg)](https://badge.fury.io/rb/parse_name_from_email)
+[![Build Status](https://travis-ci.org/Applifting/parse_name_from_email.svg?branch=master)](https://travis-ci.org/Applifting/parse_name_from_email)
+
+Rails gem to easily parse user name from email address.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parse_name_from_email'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parse_name_from_email
+
+## Configuration
+
+You don't need to configure anything, but if you want to customize the behaviour, use the following snippet:
+
+```ruby
+ParseNameFromEmail.configure do |config|
+  # split email address with regexp
+  config.regexp = /(?=[A-Z])|(?:([0-9]+))|\.|-|\?|!|\+|\;|\_/
+
+  ## Recognizing plus parts in gmail addresses
+  #
+  # DEFAULT: true
+  #
+  # if TRUE:
+  #   email address:  'example+something123@gmail.com'
+  #   result name:    'Example (Something 123)'
+  #
+  # if FALSE:
+  #   email address:  'example+something123@gmail.com'
+  #   result name:    'Example'
+  config.friendly_plus_part = true
+end
+```
+
+Values in the above snippet are the default values.
+
+## Usage
+
+```ruby
+# getting email address
+ParseNameFromEmail.get_email_name('john-snow@example.com') # => 'john-snow'
+ParseNameFromEmail.get_email_name('john-snow+nickname@example.com') # => 'john-snow+nickname'
+
+# parsing name from email address
+ParseNameFromEmail.parse_name_from('JohnSnow@example.com') # => 'John Snow'
+ParseNameFromEmail.parse_name_from('john-snow@example.com') # => 'John Snow'
+ParseNameFromEmail.parse_name_from('john_snow@example.com') # => 'John Snow'
+ParseNameFromEmail.parse_name_from('john123snow@example.com') # => 'John Snow'
+ParseNameFromEmail.parse_name_from('John Snow <john.snow@example.com>') # => 'John Snow'
+
+# validating RFC format of email
+ParseNameFromEmail.valid_rfc_format?('john-snow@example.com') # => false
+ParseNameFromEmail.valid_rfc_format?('John Snow <john.snow@example.com>') # => true
+
+# if config.friendly_plus_part = true
+ParseNameFromEmail.parse_name_from('JohnSnow+Nickname123@example.com') # => 'John Snow (Nickname 123)'
+
+# if config.friendly_plus_part = false
+ParseNameFromEmail.parse_name_from('JohnSnow+Nickname123@example.com') # => 'John Snow'
+
+# batches
+string_with_emails = 'John Snow <john.snow@example.com>, alice.123@3x4mpl3.app'
+ParseNameFromEmail.parse_names_from(string_with_emails) # => ['John Snow', 'Alice']
+
+string_with_emails = 'lily+black@example.com, alice.123@3x4mpl3.app'
+ParseNameFromEmail.parse_names_from(string_with_emails) # => ['Lily (black)', 'Alice']
+
+# advanced parsing
+string_with_emails = 'john.snow@example.com, lily+black@example.com'
+ParseNameFromEmail.parse_emails_with_names_from(string_with_emails)
+# => {'john.snow@example.com' => 'John Snow', 'lily+black@example.com' => 'Lily (black)'}
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Applifting/parse_name_from_email.
+
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 3.2'
+gem 'rspec'
+
+gemspec :path => "../"

data/gemfiles/ruby-2.1

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.1'
+gem 'rspec'
+
+gemspec :path => "../"

data/gemfiles/ruby-2.2

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.1'
+gem 'rspec'
+
+gemspec :path => "../"

data/gemfiles/ruby-2.6

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 5.1'
+gem 'rspec'
+
+gemspec :path => "../"

data/lib/parse_name_from_email/batch.rb

@@ -0,0 +1,9 @@
+module ParseNameFromEmail
+  class Batch
+    class << self
+      def split_emails_to_array(string_with_emails)
+        string_with_emails.split(/\;|\,/)
+      end
+    end
+  end
+end

data/lib/parse_name_from_email/configuration.rb

@@ -0,0 +1,31 @@
+module ParseNameFromEmail
+  class Configuration
+    attr_accessor :regexp, :friendly_plus_part
+
+    def initialize
+      # split email address with regexp (test: https://regex101.com/r/pF5mS4)
+      @regexp = /(?=[A-Z])|(?:([0-9]+))|\.|-|\?|!|\+|\;|\_/
+
+      ## Recognizing plus parts in gmail addresses
+      #
+      # DEFAULT: true
+      #
+      # if TRUE:
+      #   email address:  'example+something123@gmail.com'
+      #   result name:    'Example (Something 123)'
+      #
+      # if FALSE:
+      #   email address:  'example+something123@gmail.com'
+      #   result name:    'Example'
+      @friendly_plus_part = true
+    end
+
+    def self.regexp_to_split_by_rfc
+      /(\<|\>)/
+    end
+
+    def self.regex_for_validation_format_as_rfc
+      /(\<[\S]*[\S]*\.[\S]*\>)/
+    end
+  end
+end

data/lib/parse_name_from_email/version.rb

@@ -0,0 +1,3 @@
+module ParseNameFromEmail
+  VERSION = '1.0.4'.freeze
+end

data/lib/parse_name_from_email.rb

@@ -0,0 +1,110 @@
+require 'active_support/all'
+
+require 'parse_name_from_email/version'
+require 'parse_name_from_email/configuration'
+require 'parse_name_from_email/batch'
+
+module ParseNameFromEmail
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    # parses string of multiple emails to hash of emails and generated names
+    def parse_emails_with_names_from(string_with_emails)
+      emails = Batch.split_emails_to_array(string_with_emails)
+      result = {}
+      emails.each { |email| result[get_email_address(email)] = parse_name_from(email) }
+      result
+    end
+
+    # parses string of multiple emails to array of names
+    def parse_names_from(string_with_emails)
+      emails = Batch.split_emails_to_array(string_with_emails)
+      result = []
+      emails.each { |email| result << parse_name_from(email) }
+      result
+    end
+
+    # main logic of parsing one email address
+    def parse_name_from(email)
+      # if emails is in RFC format, return the name if not blank
+      name_from_rfc = get_name_if_rfc_format_of_email(email)
+      return name_from_rfc unless name_from_rfc.blank?
+
+      # get part before '@'
+      email_name = get_email_name(email)
+
+      splitted_by_plus = split_plus_part(email_name) # get part before and after plus part
+
+      # if friendly plus part, make result more readable
+      if splitted_by_plus.size >= 2
+        email_name = splitted_by_plus[0...-1].join(' ') # reject part after plus and overwrite it joined to string
+        if configuration.friendly_plus_part
+          plus_part = splitted_by_plus.last # last part is after plus and it should be gmail nickname
+        end
+      end
+
+      splitted_email = split_to_words(email_name) # split email name by regex
+
+      name = make_human_readable(splitted_email) # join email name with space
+
+      # add part after plus
+      if configuration.friendly_plus_part && !plus_part.blank?
+        name += ' ' unless name.blank?
+        name += "(#{plus_part})" unless plus_part.blank?
+      end
+
+      name # return result
+    end
+
+    # split email by '@' and get only email name
+    def get_email_name(email)
+      email.split('@').first
+    end
+
+    # is rfc format? if true, return me only the email address
+    def get_email_address(email)
+      if valid_rfc_format?(email)
+        email = email.split(/\</).last.to_s.delete('>')
+      end
+      email.strip
+    end
+
+    # if is rfc format of email, returns only name
+    def get_name_if_rfc_format_of_email(email)
+      name = email.split(/\</).first.to_s.strip if valid_rfc_format?(email)
+      name
+    end
+
+    # split email plus part
+    def split_plus_part(email)
+      email.split('+')
+    end
+
+    # split email by regex
+    def split_to_words(email_name)
+      email_name.split(configuration.regexp)
+    end
+
+    # after regex join it with blank space and upcase first letters
+    def make_human_readable(array)
+      humanized_elements = array.map { |el| el.strip.humanize }
+      humanized_elements.reject(&:empty?).reject{ |str| str =~ /\d/ }.join(' ')
+    end
+
+    # match regexp if is valid rfc format
+    def valid_rfc_format?(email)
+      match = (email =~ Configuration.regex_for_validation_format_as_rfc)
+      match.present?
+    end
+  end
+end

data/parse_name_from_email.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parse_name_from_email/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'parse_name_from_email'
+  spec.version       = ParseNameFromEmail::VERSION
+  spec.authors       = ['Prokop Simek, Applifting']
+  spec.email         = ['prokop.simek@applifting.cz']
+
+  spec.summary       = 'Parse name from email address.'
+  spec.description   = 'This gem makes it easy to parse name from email addresses.'
+  spec.homepage      = 'https://github.com/Applifting/parse_name_from_email'
+  spec.license       = 'MIT'
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency 'activesupport', '>= 3.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_name_from_email
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Prokop Simek, Applifting
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,7 +58,24 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/ruby-2.0
+- gemfiles/ruby-2.1
+- gemfiles/ruby-2.2
+- gemfiles/ruby-2.6
+- lib/parse_name_from_email.rb
+- lib/parse_name_from_email/batch.rb
+- lib/parse_name_from_email/configuration.rb
+- lib/parse_name_from_email/version.rb
+- parse_name_from_email.gemspec
 homepage: https://github.com/Applifting/parse_name_from_email
 licenses:
 - MIT
@@ -78,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Parse name from email address.