more_possessive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddf5f5426b6d841f2b96f530ecf3f07c63f66ec1
+  data.tar.gz: 5e85a0a56dec4b39f748a9083ee6e9295ea8bcb4
+SHA512:
+  metadata.gz: 400a39f4b776574a66fbc004165dc1d011117b1a0d27e415f36492bad661e0251f6e6ce603bb85565a2c0f091eec13d403f61f038420208acc925bacaf2efbfb
+  data.tar.gz: 0e791dcefb6fedfc3600bf186048b995c3967af4eaca4f7bbb892db40875fca9a5c3cdb409866480c22edf740046988c79578292f2a36985984e59581e677c4a

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Brian Clubb, Robert Wünsch, Alizain Feerasta
+
+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,35 @@
+# possessive
+
+Rails gem that lets you get a possessive form of a string. Supports localization in the style of ActiveSupport::Inflector.
+
+## Example
+
+    "Brian".possessive    # => Brian's
+    "Sooners".possessive  # => Sooners'
+
+## Install
+
+    # Gemfile
+    gem "more_possessive"
+
+## Localization
+
+Sample configuration for German:
+
+    # config/initializers/inflections.rb
+    Possessive::Inflector.inflections(:de) do |inflect|
+      inflect.possessive /$/, 's'
+      inflect.possessive /(s|x|z)$/i, '\1’'
+    end
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2017 Brian Clubb, Robert Wünsch, Alizain Feerasta. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "more_possessive"
+    gem.summary = "Rails plugin that lets you get a possessive form of a string for use on sites"
+    gem.description = "Rails plugin that lets you get a possessive form of a string for use on sites"
+    gem.email = "alizain.feerasta@gmail.com"
+    gem.homepage = "http://github.com/alizain/more_possessive"
+    gem.authors = ["Brian Clubb", "Jamie Flournoy", "Nick Howard"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "more_possessive #{version}"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/core_ext/string/inflections.rb

@@ -0,0 +1,7 @@
+require 'possessive/inflector/methods'
+
+class String
+  def possessive(locale = nil)
+    Possessive::Inflector.possessive(self, locale || I18n.locale)
+  end
+end

data/lib/possessive.rb

@@ -0,0 +1,5 @@
+require 'possessive/inflector/inflections'
+require 'possessive/inflector/methods'
+
+require 'possessive/inflections'
+require 'core_ext/string/inflections'

data/lib/possessive/inflections.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'possessive/inflector/inflections'
+
+#--
+# Defines the standard inflection rules. These are the starting point for
+# new projects and are not considered complete. The current set of inflection
+# rules is frozen. This means, we do not change them to become more complete.
+# This is a safety measure to keep existing applications from breaking.
+#++
+Possessive::Inflector.inflections(:en) do |inflect|
+  inflect.possessive /$/, '’s'
+  inflect.possessive /([^’]s)$/i, '\1’'
+  inflect.possessive /(sh)$/i, '\1es’'
+  inflect.possessive /(ss)$/i, '\1’s'
+  inflect.possessive 'it', 'its'
+end

data/lib/possessive/inflector/inflections.rb

@@ -0,0 +1,65 @@
+# Inspired by ActiveSupport::Inflector
+module Possessive
+  module Inflector
+    extend self
+
+    # A singleton instance of this class is yielded by Inflector.inflections,
+    # which can then be used to specify additional inflection rules. If passed
+    # an optional locale, rules for other languages can be specified. The
+    # default locale is <tt>:en</tt>. Only rules for English are provided.
+    #
+    #   ActiveSupport::Inflector.inflections(:en) do |inflect|
+    #     inflect.possessive /(sh)$/i, '\1es’'
+    #     inflect.possessive /(ss)$/i, '\1’s'
+    #   end
+    #
+    # Later rules override previous rules.
+    class Inflections
+      @__instance__ = {}
+
+      def self.instance(locale = :en)
+        @__instance__[locale] ||= new
+      end
+
+      attr_reader :possessives
+
+      def initialize
+        @possessives = []
+      end
+
+      # Specifies a possessive form of a string by a regular expression rule or
+      # by a string mapping. When using a regular expression based replacement,
+      # the normal possessive form is called after the replacement. When a
+      # string is used, the possessive form should be specified as desired (example:
+      # 'The name', not 'the_name').
+      #
+      #   possessive /$/, '’s'
+      #   possessive 'it', 'its'
+      def possessive(rule, replacement)
+        rule = /^#{rule}$/ if rule.is_a?(String)
+        @possessives.insert(0, [rule, replacement])
+      end
+
+      # Clears the loaded inflections.
+      def clear
+        @possessives = []
+      end
+    end
+
+    # Yields a singleton instance of Inflector::Inflections so you can specify
+    # additional inflector rules. If passed an optional locale, rules for other
+    # languages can be specified. If not specified, defaults to <tt>:en</tt>.
+    # Only rules for English are provided.
+    #
+    #   Possessive::Inflector.inflections(:en) do |inflect|
+    #     inflect.uncountable 'rails'
+    #   end
+    def inflections(locale = :en)
+      if block_given?
+        yield Inflections.instance(locale)
+      else
+        Inflections.instance(locale)
+      end
+    end
+  end
+end

data/lib/possessive/inflector/methods.rb

@@ -0,0 +1,32 @@
+# Inspired by ActiveSupport::Inflector
+module Possessive
+  # The Inflector transforms words into their possessive form.
+  # The default inflections for possessive form are kept in inflections.rb.
+  module Inflector
+    extend self
+
+    # Returns the possessive form of the word in the string.
+    #
+    # If passed an optional +locale+ parameter, the possessive form of the word
+    # will be determined using rules defined for that language. By default,
+    # this parameter is set to <tt>:en</tt>.
+    #
+    #   'Brian'.possessive           # => "Brian’s"
+    #   'Steelers'.possessive        # => "Steelers’"
+    #   'class'.possessive           # => "class’s"
+    #   'fish'.possessive            # => "fishes’"
+    #   'Brian'.possessive(:de)      # => "Brians"
+    def possessive(word, locale = :en)
+      result = word.to_s.dup
+
+      if word.empty?
+        result
+      else
+        inflections(locale).possessives.each do |(rule, replacement)|
+          break if result.sub!(rule, replacement)
+        end
+        result
+      end
+    end
+  end
+end

data/more_possessive.gemspec

@@ -0,0 +1,40 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: more_possessive 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "more_possessive".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Brian Clubb".freeze, "Jamie Flournoy".freeze, "Nick Howard".freeze]
+  s.date = "2017-02-26"
+  s.description = "Rails plugin that lets you get a possessive form of a string for use on sites".freeze
+  s.email = "alizain.feerasta@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/core_ext/string/inflections.rb",
+    "lib/possessive.rb",
+    "lib/possessive/inflections.rb",
+    "lib/possessive/inflector/inflections.rb",
+    "lib/possessive/inflector/methods.rb",
+    "more_possessive.gemspec",
+    "rails/init.rb",
+    "test/helper.rb",
+    "test/test_possessive.rb"
+  ]
+  s.homepage = "http://github.com/alizain/more_possessive".freeze
+  s.rubygems_version = "2.6.4".freeze
+  s.summary = "Rails plugin that lets you get a possessive form of a string for use on sites".freeze
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "possessive"

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+
+require 'i18n'
+require 'possessive'

data/test/test_possessive.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require 'helper'
+
+class InflectorTest < Test::Unit::TestCase
+  test "Possessive with a normal string" do
+    assert_equal "Brian’s", "Brian".possessive
+    assert_equal "BRIAN’s", "BRIAN".possessive
+  end
+
+  test "Possessive with a string ending with s" do
+    assert_equal "Steelers’", "Steelers".possessive
+    assert_equal "STEELERS’", "STEELERS".possessive
+  end
+
+  test "Possessive with strings ending in sh" do
+    assert_equal "fishes’", "fish".possessive
+  end
+
+  test "Possessive with strings ending in ss" do
+    assert_equal "class’s", "class".possessive
+  end
+
+  test "Possessive with it" do
+    assert_equal "its", "it".possessive
+  end
+
+  test "Possessive with something containing the string rule: 'it', 'its'" do
+    assert_equal "little’s", "little".possessive
+  end
+
+  test "Possessive with an empty string" do
+    assert_equal "", "".possessive
+  end
+
+  test "Possessive with localization" do
+    Possessive::Inflector.inflections(:de) do |inflect|
+      inflect.possessive /$/, 's'
+      inflect.possessive /(s|x|z)$/i, '\1’'
+    end
+
+    assert_equal('Bachs', 'Bach'.possessive(:de))
+    assert_equal('Bach’s', 'Bach'.possessive)
+
+    assert_equal('Blitz’', 'Blitz'.possessive(:de))
+    assert_equal('Blitz’s', 'Blitz'.possessive)
+
+    assert_equal('Felix’', 'Felix'.possessive(:de))
+    assert_equal('Felix’s', 'Felix'.possessive)
+
+    assert_equal('Fuchs’', 'Fuchs'.possessive(:de))
+    assert_equal('Fuchs’', 'Fuchs'.possessive)
+
+    Possessive::Inflector.inflections(:de) { |inflect| inflect.clear }
+
+    assert Possessive::Inflector.inflections(:de).possessives.empty?
+    assert !Possessive::Inflector.inflections.possessives.empty?
+  end
+
+  test "clear rules" do
+    with_dup do
+      Possessive::Inflector.inflections do |inflect|
+        # ensure any data is present
+        inflect.possessive(/$/, '’s')
+
+        inflect.clear
+
+        assert inflect.possessives.empty?
+      end
+    end
+  end
+
+  # Dups the singleton and yields, restoring the original inflections later.
+  # Use this in tests what modify the state of the singleton.
+  #
+  # This helper is implemented by setting @__instance__ because in some tests
+  # there are module functions that access Possessive::Inflector.inflections,
+  # so we need to replace the singleton itself.
+  def with_dup
+    original = Possessive::Inflector::Inflections.instance_variable_get(:@__instance__)
+    Possessive::Inflector::Inflections.instance_variable_set(:@__instance__, original.dup)
+  ensure
+    Possessive::Inflector::Inflections.instance_variable_set(:@__instance__, original)
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: more_possessive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Clubb
+- Jamie Flournoy
+- Nick Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-26 00:00:00.000000000 Z
+dependencies: []
+description: Rails plugin that lets you get a possessive form of a string for use
+  on sites
+email: alizain.feerasta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".document"
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/core_ext/string/inflections.rb
+- lib/possessive.rb
+- lib/possessive/inflections.rb
+- lib/possessive/inflector/inflections.rb
+- lib/possessive/inflector/methods.rb
+- more_possessive.gemspec
+- rails/init.rb
+- test/helper.rb
+- test/test_possessive.rb
+homepage: http://github.com/alizain/more_possessive
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Rails plugin that lets you get a possessive form of a string for use on sites
+test_files: []