reality-naming 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9396e1de974493ab043925298d8445f73f588931
+  data.tar.gz: 184b19dafca01e19e2dad153fe54a3c7e5795f78
+SHA512:
+  metadata.gz: 71a6d7206db5bdf20cf23d6ab71af718fb325b914ca0db6f705506e0e07c472d3bf2b93e8da1affbe8edca70557ba2aebb296d9006b43d545860764b69f71e56
+  data.tar.gz: 7388465b802b0b0aa5965d983296e37ebf78f4396b9a8f51f7b6a4c7fd22cc50198e47f3bd00ff88f529ef026c589ea1b131f0691cffa1d88ea515b63dc17a6c

data/.gitattributes

@@ -0,0 +1,6 @@
+* -text
+*.rb text -crlf -binary
+*.rdoc text -crlf -binary
+*.textile text -crlf -binary
+*.txt text -crlf -binary
+*.erb text -crlf -binary

data/.gitignore

@@ -0,0 +1,8 @@
+*.iml
+/*.ipr
+/*.iws
+/.rakeTasks
+/Gemfile.lock
+/patch.diff
+/pkg
+/rdoc

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.1
+  - jruby-19mode
+jdk:
+  - oraclejdk7
+git:
+  depth: 10
+before_install:
+  - gem update bundler

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+
+* 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
+
+Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+
+## 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).
+* 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.
+* Maintain the same code style.
+* Maintain the same level of test coverage or improve it.
+
+## Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '= 0.9.2.2'
+gem 'minitest', '= 5.9.1'
+gem 'test-unit', '= 3.1.5'

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,14 @@
+# reality-naming
+
+[![Build Status](https://secure.travis-ci.org/realityforge/reality-naming.png?branch=master)](http://travis-ci.org/realityforge/reality-naming)
+
+`reality-naming` is a simple library to convert names between different naming conventions.
+Conventions supported include:
+
+* **Pascal Case**: i.e. `MySupportLibrary`
+* **Camel Case**: i.e. `mySupportLibrary`
+* **Underscore**: i.e. `my_support_library`
+* **Xml**: i.e. `my-support-library`
+* **Uppercase Constantize**: i.e. `MY_SUPPORT_LIBRARY`
+
+It also supports basic mechanisms for pluralizing names. See the code for basic documentation.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+desc 'Default Task'
+task :default => [:test, :build]
+
+desc 'Test Task'
+Rake::TestTask.new do |t|
+  files = FileList['test/helper.rb', 'test/test_*.rb']
+  t.loader = :rake
+  t.test_files = files
+  t.libs << '.'
+  t.warning = true
+end

data/lib/reality/naming.rb

@@ -0,0 +1,127 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality
+  module Naming
+
+    class << self
+      def camelize?(word)
+        camelize(word) == word
+      end
+
+      def camelize(input_word)
+        word_parts = split_into_words(input_word).collect { |part| part[0...1].upcase + part[1..-1] }
+        return word_parts[0].downcase if (word_parts.size == 1 && word_parts[0] == word_parts[0].upcase)
+        word = word_parts.join('')
+        word[0...1].downcase + word[1..-1]
+      end
+
+      def pascal_case?(word)
+        pascal_case(word) == word
+      end
+
+      def pascal_case(word)
+        word_parts = split_into_words(word).collect { |part| part[0...1].upcase + part[1..-1] }
+        return word_parts[0] if (word_parts.size == 1 && word_parts[0] == word_parts[0].upcase)
+        word_parts.join('')
+      end
+
+      def underscore?(word)
+        underscore(word) == word
+      end
+
+      def underscore(input_word)
+        split_into_words(input_word).join('_').downcase
+      end
+
+      def xmlize?(word)
+        xmlize(word) == word
+      end
+
+      def xmlize(word)
+        underscore(word).tr('_', '-')
+      end
+
+      def jsonize?(word)
+        jsonize(word) == word
+      end
+
+      def jsonize(word)
+        camelize(word)
+      end
+
+      def uppercase_constantize?(word)
+        uppercase_constantize(word) == word
+      end
+
+      def uppercase_constantize(word)
+        underscore(word).upcase
+      end
+
+      def pluralize(string)
+        singular = string.to_s
+        length = singular.size
+        last_ch = last(singular)
+        last_2ch = last(singular, 2)
+
+        plural = nil
+        pluralization_rules.each do |rule|
+          plural = rule.call(singular)
+          break unless plural.nil?
+        end
+        if plural.nil?
+          if last_ch == 'y'
+            plural = "#{singular[0, length - 1]}ies" unless singular =~ /[aeiou]y$/
+          elsif last_ch == 'f'
+            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)
+            plural = "#{singular[0, length - 2]}es"
+          elsif %w(s x z).include?(last_ch)
+            plural = "#{singular[0, length - 1]}es"
+          end
+        end
+        plural || "#{singular}s"
+      end
+
+      def add_pluralization_rule(&block)
+        pluralization_rules << block
+      end
+
+      def clear_pluralization_rules
+        pluralization_rules.clear
+      end
+
+      def split_into_words(word)
+        word = word.to_s.dup
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!('-', '_')
+        word.split('_')
+      end
+
+      private
+
+      def pluralization_rules
+        @pluralization_rules ||= []
+      end
+
+      def last(s, limit = 1)
+        return s if limit > s.size
+        s[-limit, limit]
+      end
+    end
+  end
+end

data/reality-naming.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name               = %q{reality-naming}
+  s.version            = '1.0.0'
+  s.platform           = Gem::Platform::RUBY
+
+  s.authors            = ['Peter Donald']
+  s.email              = %q{peter@realityforge.org}
+
+  s.homepage           = %q{https://github.com/realityforge/reality-naming}
+  s.summary            = %q{A library to convert names between different naming conventions.}
+  s.description        = %q{A library to convert names between different naming conventions.}
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.default_executable = []
+  s.require_paths      = %w(lib)
+
+  s.has_rdoc           = false
+  s.rdoc_options       = %w(--line-numbers --inline-source --title reality-naming)
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/autorun'
+require 'test/unit/assertions'
+require 'reality/naming'
+
+class Reality::Naming::TestCase < Minitest::Test
+  include Test::Unit::Assertions
+
+  def setup
+    Reality::Naming.clear_pluralization_rules
+  end
+end

data/test/test_naming.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestNaming < Reality::Naming::TestCase
+  def test_pluralize
+    assert_equal 'cats', Reality::Naming.pluralize('cat')
+    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')
+  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
+
+  def test_split_into_words
+    assert_equal %w(my Support Library), Reality::Naming.split_into_words('mySupportLibrary')
+    assert_equal %w(My Support Library), Reality::Naming.split_into_words('MySupportLibrary')
+    assert_equal %w(my support library), Reality::Naming.split_into_words('my-support-library')
+    assert_equal %w(my support library), Reality::Naming.split_into_words('my_support_library')
+    assert_equal %w(MY SUPPORT LIBRARY), Reality::Naming.split_into_words('MY_SUPPORT_LIBRARY')
+  end
+
+  def test_conversions
+    perform_check(:camelize, 'mySupportLibrary')
+    perform_check(:pascal_case, 'MySupportLibrary')
+    perform_check(:xmlize, 'my-support-library')
+    perform_check(:underscore, 'my_support_library')
+    perform_check(:jsonize, 'mySupportLibrary')
+    perform_check(:jsonize, 'mySupportLibrary')
+    perform_check(:uppercase_constantize, 'MY_SUPPORT_LIBRARY')
+  end
+
+  def perform_check(method_name, result)
+    assert_equal result, Reality::Naming.send(method_name, 'MySupportLibrary'), "Checking conversion to #{result}"
+    assert_equal result, Reality::Naming.send(method_name, 'my_support_library'), "Checking conversion to #{result}"
+    assert_equal result, Reality::Naming.send(method_name, 'my-support-library'), "Checking conversion to #{result}"
+    assert_equal result, Reality::Naming.send(method_name, :'MySupportLibrary'), "Checking conversion to #{result}"
+    assert_equal result, Reality::Naming.send(method_name, :'my_support_library'), "Checking conversion to #{result}"
+    assert_equal result, Reality::Naming.send(method_name, :'my-support-library'), "Checking conversion to #{result}"
+    assert_equal Reality::Naming.send(:"#{method_name}?", result), true
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: reality-naming
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Donald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies: []
+description: A library to convert names between different naming conventions.
+email: peter@realityforge.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/reality/naming.rb
+- reality-naming.gemspec
+- test/helper.rb
+- test/test_naming.rb
+homepage: https://github.com/realityforge/reality-naming
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- reality-naming
+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.1
+signing_key: 
+specification_version: 4
+summary: A library to convert names between different naming conventions.
+test_files: []