user_naming 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33ea227853001c9d8674cfd5703ebcaad565b2dd
+  data.tar.gz: a2a2eb43f59a8ef1daa9433fa7fc9b99af37450e
+SHA512:
+  metadata.gz: b9c30d24ecd52fd29db5309ec3ce320f0894704214a54f7598ee1d517c5dbf686e6ab196906a1b4873c83b0c432c61584be546fa6d3d3394a123a75f3f578edc
+  data.tar.gz: 648a0e057fcb4b16b570c9a114d15dd5ff14c109c1a372582740db543a3ac14ccf7713c5a50ae1ae4b124e4cbccca775e534167ef6ffa150c803f6ff6e52374c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+cache: bundler
+
+language:
+  -ruby
+
+rvm:
+  - 2.3.3
+
+before_install: gem install bundler -v 1.14.6
+
+sudo: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tomichj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Justin Tomich
+
+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,72 @@
+# UserNaming
+
+UserNaming is a simple gem that provides a 'name' column and some methods to standardize displaying user names in
+rails applications.
+
+This isn't a big gem: it's a migration and a module with 4 or 5 methods that you include in your 'user' class. 
+But, it lets me deal with user's names in the same way in every application I build. Over time, this pays off.
+
+This gem currently supports rails 5 and beyond; adding 4.2 support is trivial, but would also require
+adding an `appraisal` configuration. Open for PRs if interested.
+
+
+## Installation
+
+Add this line to your application's `Gemfile` and run `bundle install` to install it:
+
+```ruby
+gem 'user_naming'
+```
+
+Then run the UserNaming install generator:
+
+```sh
+rails generate user_naming:install
+```
+
+If your user model is not `User`, you can (optionally) specify a user model with the `--model` flag. For example,
+if your user model class is `Person`:
+
+```sh
+rails generate user_naming:install --model Person
+```
+
+After you've run the install generator, apply the migration that was just generated:
+```sh
+rails db:migrate
+```
+
+The generator does the following:
+
+* Insert `include UserNaming::User` into your `User` model.
+* Create a migration to add a `name` column to your `User` table.
+
+
+## Usage
+
+UserNaming supports setting the user's name as one field via `name=`.
+
+Non-mutating accessors to read the user's name in different formats are provided: 
+
+- name - the full name
+- first_name - always the first word of the name
+- middle name - everything that's not the first or last name
+- last_name - the last word of the name
+- initials - initials, joined without period or any other delimiter
+- first_name_last_initial - first name, last initial with a .
+
+That's it!
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomichj/user_naming. 
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "user_naming"
+
+# 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(__FILE__)

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/lib/generators/user_naming/helpers.rb

@@ -0,0 +1,102 @@
+module UserNaming
+  module Generators
+    module Helpers
+      private
+
+      def copy_migration(migration_name, config = {})
+        unless migration_exists?(migration_name)
+          migration_template(
+            "db/migrate/#{migration_name}",
+            "db/migrate/#{migration_name}",
+            config.merge(migration_version: migration_version)
+          )
+        end
+      end
+
+
+      def migration_exists?(name)
+        existing_migrations.include?(name)
+      end
+
+      def existing_migrations
+        @existing_migrations ||= Dir.glob('db/migrate/*.rb').map do |file|
+          migration_name_without_timestamp(file)
+        end
+      end
+
+      def migration_name_without_timestamp(file)
+        file.sub(%r{^.*(db/migrate/)(?:\d+_)?}, '')
+      end
+
+
+
+
+      def migration_version
+        if Rails.version >= '5.0.0'
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
+
+
+      # Either return the model passed in a classified form or return the default "User".
+      def model_class_name
+        options[:model] ? options[:model].classify : 'User'
+      end
+
+      def model_path
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
+      end
+
+      def file_path
+        model_name.underscore
+      end
+
+      def namespace
+        Rails::Generators.namespace if Rails::Generators.respond_to?(:namespace)
+      end
+
+      def namespaced?
+        !namespace.nil?
+      end
+
+      def model_name
+        if namespaced?
+          [namespace.to_s] + [model_class_name]
+        else
+          [model_class_name]
+        end.join('::')
+      end
+
+      def table_reference_name
+        table_name.singularize
+      end
+
+      def table_name
+        @table_name ||= begin
+          base = plural_name
+          (class_path + [base]).join('_')
+        end
+      end
+
+      def class_path
+        @class_path
+      end
+
+      def singular_name
+        @file_name
+      end
+
+      def plural_name
+        singular_name.pluralize
+      end
+
+      def assign_names!(name) #:nodoc:
+        @class_path = name.include?('/') ? name.split('/') : name.split('::')
+        @class_path.map!(&:underscore)
+        @file_name = @class_path.pop
+      end
+
+    end
+  end
+end

data/lib/generators/user_naming/install/install_generator.rb

@@ -0,0 +1,48 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+require 'generators/user_naming/helpers'
+
+module UserNaming
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include UserNaming::Generators::Helpers
+
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :model,
+                   optional: true,
+                   type: :string,
+                   banner: 'model',
+                   desc: "Specify the model class name if you will use anything other than 'User'"
+
+      def initialize(*)
+        super
+        assign_names!(model_class_name)
+      end
+
+      def verify
+        # if options[:model] && !File.exist?(model_path)
+        if !File.exist?(model_path)
+          puts "Exiting: the model class #{options[:model] || 'User' } is not found. You must have a valid user model."
+          exit 1
+        end
+      end
+
+      def inject_into_user_model
+        inject_into_class(model_path, model_class_name, "  include UserNaming::User\n")
+      end
+
+      def create_name_migration
+        copy_migration 'add_name_to_users.rb'
+      end
+
+      private
+
+      # for generating a timestamp when using `create_migration`
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+    end
+  end
+end

data/lib/generators/user_naming/install/templates/db/migrate/add_name_to_users.rb

@@ -0,0 +1,5 @@
+class AddNameToUsers < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :users, :name, :string
+  end
+end

data/lib/user_naming/user.rb

@@ -0,0 +1,76 @@
+module UserNaming
+  module User
+    extend ActiveSupport::Concern
+
+    # First name.
+    #
+    # The first name is always the first word of the name.
+    #
+    # @return [String]
+    def first_name
+      name.split.first
+    end
+
+
+    # Middle name.
+    #
+    # The middle name is everything between the first name and last name,
+    # or empty string.
+    #
+    # @return [String]
+    def middle_name
+      name.split[1..-2].join(' ')
+    end
+
+    # The last name.
+    #
+    # A name with only one part will return an empty string.
+    # A name with two or more parts will return everything after the first part.
+    #
+    # Examples:
+    #   'Bilbo' will have a last name of ''.
+    #   'Bilbo Foo Baggins' will have a last name of 'Foo Baggins'.
+    #
+    # @return [String]
+    def last_name
+      if name.split.count > 1
+        name.split[-1]
+      else
+        ''
+      end
+    end
+
+    # Initials.
+    #
+    # The initials are the first letter of each name part,
+    # joined together *without* periods.
+    #
+    # Examples:
+    #   'Bilbo' will have initials of 'B'.
+    #   'Bilbo Foo Baggins' will have initials of 'BFB'.
+    #   'Bilbo Bartlet Foo Baggins' will have initials of 'BBFB'.
+    #
+    # @return [String]
+    def initials
+      name.split.collect{|p| p[0].upcase }.join
+    end
+
+    # The first name and the last initial.
+    #
+    # If only one name, just the first name is returned.
+    #
+    # Examples:
+    #   'Bilbo' will be 'B'
+    #   'Bilbo Foo Baggins' will be 'Bilbo B'
+    #
+    # @return [String]
+    def first_name_last_initial
+      if name.split.count > 1
+        first_name + ' ' + last_name[0].upcase + '.'
+      else
+        first_name
+      end
+    end
+
+  end
+end

data/lib/user_naming/version.rb

@@ -0,0 +1,3 @@
+module UserNaming
+  VERSION = '1.0.0'.freeze
+end

data/lib/user_naming.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'user_naming/version'
+require 'user_naming/user'
+
+module UserNaming
+  # Your code goes here...
+end

data/user_naming.gemspec

@@ -0,0 +1,30 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'user_naming/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'user_naming'
+  spec.version       = UserNaming::VERSION
+  spec.authors       = ['Justin Tomich']
+  spec.email         = ['justin@tomich.org']
+  spec.homepage      = 'http://github.com/tomichj/user_naming'
+  spec.summary       = 'A rails gem providing naming methods for user models'
+  spec.description   = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+
+  spec.require_paths = ['lib']
+  spec.extra_rdoc_files = %w[LICENSE.txt README.md CODE_OF_CONDUCT.md]
+  spec.rdoc_options = ['--charset=UTF-8']
+
+  spec.add_dependency 'rails', '>= 5.0', '< 5.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: user_naming
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Tomich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- justin@tomich.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- CODE_OF_CONDUCT.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/user_naming/helpers.rb
+- lib/generators/user_naming/install/install_generator.rb
+- lib/generators/user_naming/install/templates/db/migrate/add_name_to_users.rb
+- lib/user_naming.rb
+- lib/user_naming/user.rb
+- lib/user_naming/version.rb
+- user_naming.gemspec
+homepage: http://github.com/tomichj/user_naming
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A rails gem providing naming methods for user models
+test_files: []