reality-naming 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33cd4dd2f5f82a779ed983c49a872c4001678abf
-  data.tar.gz: 367634974667ec6f7889c15b865e596cb755a4f6
+  metadata.gz: 93affae9e11127f3ff0829c4cf41543abdaa856b
+  data.tar.gz: 602958900a76367f835167890474592da0efa8ef
 SHA512:
-  metadata.gz: 9648506e6a58ca17f723d9c04d2ed596374697b3be9e89a7170cf701b2f422a11cfc11edbf68f58096ef7b9565f0e1db25dddb9f3799080d035de2ac0d3f2212
-  data.tar.gz: 4c4645945d1279eae6ce694b657b802da2fca945ed3d882db1022164877b87a060ca73e21bfa08b2d99d19012d13842adcc371cb5f4625724e532ccda11b9006
+  metadata.gz: 3ec45873f720803cdd6a780963444234007058e2d6e772e757f87fa9816c6b39feab5e887320522b2a811bee51981993313cd1b396d5589ddff28624d7279399
+  data.tar.gz: aca10220b7052d4c8eb03dedd2a2afb70bf15ec3876987c0728a59a7f8413356801c734aaeeaaacb5bcc8fb5f062d7e57a808270933d08b7c2295ba9420bc6f5

data/.gitattributes

@@ -1,6 +1,12 @@
+# DO NOT EDIT: File is auto-generated
 * -text
-*.rb text -crlf -binary
-*.rdoc text -crlf -binary
-*.textile text -crlf -binary
-*.txt text -crlf -binary
-*.erb text -crlf -binary
+*.gemspec text
+*.md text
+*.rb text
+*.yml text
+.gitattributes text
+.gitignore text
+.ruby-version text
+Gemfile text
+LICENSE text
+Rakefile text

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+<!--
+Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
+Please make sure that you are familiar with and follow the Code of Conduct for
+this project (found in the CODE_OF_CONDUCT.md file).
+
+Please fill out this template with all the relevant information so we can
+understand what's going on and fix the issue.
+
+I may ask you to submit the fix (after giving some direction).
+-->
+
+Environment:
+
+<!--
+  Please provide the version of this project where the issue occurred as well as the
+  versions of other environmental factors. This could be virtual machine version, os
+  version, browser version etc.
+-->
+
+Relevant code or config:
+
+```
+
+```
+
+What you did:
+
+
+
+What happened:
+
+<!-- Please provide the full error message/screenshots/anything -->
+
+Reproduction repository:
+
+<!--
+If possible, please create a repository that reproduces the issue with the
+minimal amount of code possible.
+-->
+
+Problem description:
+
+
+
+Suggested solution:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# 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,
+education, socio-economic status, 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 peter@realityforge.org. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -1,19 +1,34 @@
 # How to Contribute
 
-Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+We'd love to accept your patches and contributions to this project. Pull requests are part of
+what makes open source great. There are just a few small guidelines you need to follow.
 
-* Fork it
-* 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 new Pull Request
+## Code of Conduct
 
-Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+Participation in this project comes under the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)
+
+## Submitting code via Pull Requests
+
+- We follow the [Github Pull Request Model](https://help.github.com/articles/about-pull-requests/) for
+  all contributions.
+- For large bodies of work, we recommend creating an issue outlining the feature that you wish to build,
+  and describing how it will be implemented. This gives a chance for review to happen early, and ensures
+  no wasted effort occurs.
+- All submissions, will require review before being merged.
+- Finally - *Thanks* for considering submitting code to the project!
+
+## Formatting
+
+When submitting pull requests, make sure to do the following:
+
+- Maintain the same code style as the rest of the project.
+- Remove trailing whitespace. Many editors will do this automatically.
+- Ensure any new files have [a trailing newline](https://stackoverflow.com/questions/5813311/no-newline-at-end-of-file)
 
 ## How to speed the merging of pull requests
 
-* Describe your changes in the CHANGELOG.
-* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Describe your changes in the CHANGELOG.md (if present).
+* Give yourself some credit in the appropriate place (usually the CHANGELOG.md).
 * Make commits of logical units.
 * Ensure your commit messages help others understand what you are doing and why.
 * Check for unnecessary whitespace with `git diff --check` before committing.
@@ -23,4 +38,6 @@ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
 ## Additional Resources
 
 * [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [How to write a good Git Commit message](https://chris.beams.io/posts/git-commit/) -
+  Great way to make sure your Pull Requests get accepted.
+* [An Open Source Etiquette Guidebook](https://css-tricks.com/open-source-etiquette-guidebook/#article-header-id-1)

data/lib/reality/naming.rb

@@ -106,10 +106,14 @@ module Reality
             plural = "#{singular[0, length - 1]}ves" unless singular =~ /[aeiou][aeiou]f$/
           elsif last_2ch == 'fe'
             plural = "#{singular[0, length - 2]}ves"
-          elsif %w(ch sh).include?(last_2ch)
+          elsif %w(is).include?(last_2ch)
             plural = "#{singular[0, length - 2]}es"
-          elsif %w(s x z).include?(last_ch)
-            plural = "#{singular[0, length - 1]}es"
+          elsif %w(on).include?(last_2ch)
+            plural = "#{singular[0, length - 2]}a"
+          elsif %w(ss ch sh).include?(last_2ch) || %w(s x z).include?(last_ch)
+            plural = "#{singular}es"
+          elsif %w(o).include?(last_ch)
+            plural = "#{singular}es"
           end
         end
         plural || "#{singular}s"
@@ -140,8 +144,36 @@ module Reality
 
       def default_pluralization_rules
         rules = []
-        rules << Proc.new { |string| string == 'child' ? 'children' : nil }
-        rules << Proc.new { |string| string == 'Child' ? 'Children' : nil }
+        exception_map = {}
+        %w(sheep series species deer fish).each do |w|
+          w2 = w[0...1].upcase + w[1..-1]
+          exception_map[w] = w
+          exception_map[w2] = w2
+        end
+        exception_map['child'] = 'children'
+        exception_map['goose'] = 'geese'
+        exception_map['man'] = 'men'
+        exception_map['woman'] = 'women'
+        exception_map['tooth'] = 'teeth'
+        exception_map['mouse'] = 'mice'
+        exception_map['foot'] = 'feet'
+        exception_map['person'] = 'people'
+        exception_map['photo'] = 'photos'
+        exception_map['piano'] = 'pianos'
+        exception_map['halo'] = 'halos'
+        exception_map['belief'] = 'beliefs'
+        exception_map['chef'] = 'chefs'
+        exception_map['chief'] = 'chiefs'
+        exception_map['fez'] = 'fezzes'
+        exception_map['gas'] = 'gasses'
+        exception_map['cactus'] = 'cacti'
+        exception_map['focus'] = 'foci'
+
+        exception_map.dup.each_pair do |k, v|
+          exception_map[k[0...1].upcase + k[1..-1]] = v[0...1].upcase + v[1..-1]
+        end
+
+        rules << Proc.new { |string| exception_map[string] }
         rules
       end
 

data/reality-naming.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{reality-naming}
-  s.version            = '1.10.0'
+  s.version            = '1.11.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']

data/test/test_naming.rb

@@ -6,24 +6,30 @@ class TestNaming < Reality::Naming::TestCase
     assert_equal 'cats', Reality::Naming.pluralize(:cat)
     assert_equal 'poppies', Reality::Naming.pluralize('poppy')
     assert_equal 'says', Reality::Naming.pluralize('say')
-    assert_equal 'foos', Reality::Naming.pluralize('foo')
+    assert_equal 'fooes', Reality::Naming.pluralize('foo')
+    assert_equal 'dispatches', Reality::Naming.pluralize('dispatch')
+    assert_equal 'bushes', Reality::Naming.pluralize('bush')
+    assert_equal 'losses', Reality::Naming.pluralize('loss')
+    assert_equal 'boxes', Reality::Naming.pluralize('box')
+    assert_equal 'blitzes', Reality::Naming.pluralize('blitz')
+    assert_equal 'trusses', Reality::Naming.pluralize('truss')
+    assert_equal 'buses', Reality::Naming.pluralize('bus')
+    assert_equal 'marshes', Reality::Naming.pluralize('marsh')
+    assert_equal 'potatoes', Reality::Naming.pluralize('potato')
+    assert_equal 'tomatoes', Reality::Naming.pluralize('tomato')
+    assert_equal 'analyses', Reality::Naming.pluralize('analysis')
+    assert_equal 'ellipses', Reality::Naming.pluralize('ellipsis')
+    assert_equal 'phenomena', Reality::Naming.pluralize('phenomenon')
+    assert_equal 'criteria', Reality::Naming.pluralize('criterion')
   end
 
   def test_custom_pluralization_rules
-    assert_equal 'heros', Reality::Naming.pluralize('hero')
-    assert_equal 'cats', Reality::Naming.pluralize('cat')
-    Reality::Naming.add_pluralization_rule do |string|
-      string == 'hero' ? 'heroes' : nil
-    end
-    assert_equal 'heroes', Reality::Naming.pluralize('hero')
     assert_equal 'cats', Reality::Naming.pluralize('cat')
     Reality::Naming.add_pluralization_rule do |string|
       string == 'cat' ? 'catz' : nil
     end
-    assert_equal 'heroes', Reality::Naming.pluralize('hero')
     assert_equal 'catz', Reality::Naming.pluralize('cat')
     Reality::Naming.clear_pluralization_rules
-    assert_equal 'heros', Reality::Naming.pluralize('hero')
     assert_equal 'cats', Reality::Naming.pluralize('cat')
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reality-naming
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -45,9 +45,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE