genderizr 0.0.5 → 0.0.7

data/README.md

@@ -4,11 +4,11 @@ A ruby gem to genderize strings.  It owes a little to [JackDanger's feminizer](h
 
 ## Usage
 
-`feminize_string(string)` replaces masculine words in `string` with their feminine counterparts 
+`Genderizr.feminize(string)` replaces masculine words in *string* with their feminine counterparts 
 
-`masculize_string(string)` replaces feminine words
+`Genderizr.masculize(string)` replaces feminine words
 
-`genderize_string(string, turn_feminine)` Feminizes `string` if `turn_feminine` evaluates to `true`, masculizes `string` otherwise.
+`Genderizr.genderize(string, turnFeminine)` Takes a masculine *string* and Feminizes it if *turnFeminine* evaluates to *true*, otherwise masculizes *string*.
 
 ### On its own
 
@@ -17,7 +17,7 @@ A ruby gem to genderize strings.  It owes a little to [JackDanger's feminizer](h
 1.9.3-p0 :001 > require 'genderizr'
  => true 
 
-1.9.3-p0 :002 > Genderizr.feminize_string("A man needs to keep his head up")
+1.9.3-p0 :002 > Genderizr.feminize("A man needs to keep his head up")
  => "A woman needs to keep her head up" 
 ```
 
@@ -25,12 +25,20 @@ A ruby gem to genderize strings.  It owes a little to [JackDanger's feminizer](h
 
 Genderizr monkey-patches the String class... cause that's the Rails Way.
 
-It adds `String#feminize`, `String#genderize(turn_feminine)` and `String#masculize`
+It adds `String#feminize`, `String#genderize(turnFeminine)` and `String#masculize`
 
 Now you can do cool stuff like
 
 ```ruby
 # app/views/users/show.html.erb
 
-<%= @user.name %> <%= "updated his status".genderize(@user.female?) %>
+<%= "#{@user.name} updated his status".genderize(@user.female?) %>
+```
+Produces
+```
+Dean updated his status.
+```
+or
+```
+Adrienne updated her status.
 ```

data/lib/genderizr.rb

@@ -1,97 +1,134 @@
-require 'genderizr/version'
+# encoding: utf-8
 require 'strscan'
 
 module Genderizr
 
-  extend self
+  VERSION = "0.0.7"
 
-  def feminize(string)
-    genderize(string, true)
+  def self.monkey_patch(mod)
+    mod.send(:include, Genderizr::InstanceMethods)
+    mod.send(:extend, Genderizr::Forms)
   end
 
 
-  def genderize(string,turn_feminine)
-    return "" if string.nil?
-    result = ""
-    s = StringScanner.new(string)
-    until s.eos? do
-      word = s.scan(/\w+|\W+/)
-      genderized = turn_feminine ? masculine_to_feminine[word] :
-                                   feminine_to_masculine[word]
-      result << (genderized.nil? ? word : genderized)
+  module Changers
+
+    def feminize(string)
+      genderize(string, true)
     end
-    result
-  end
 
 
-  def masculize(string)
-    genderize(string, false)
-  end
+    def genderize(string,turn_feminine)
+      return "" if string.nil?
+      lookup = turn_feminine ? masculine_to_feminine : feminine_to_masculine
+      result = ""
+      s = StringScanner.new(string)
+      until s.eos? do
+        word = s.scan(/\w+|\W+/)
+        result << (lookup[word].nil? ? word : lookup[word])
+      end
+      result
+    end
 
 
-  module StringMethods
-    def feminize; Genderizr.feminize(self); end
-    def genderize(turn_feminine); Genderizr.genderize(self,turn_feminine); end
-    def masculize; Genderizr.masculize(self); end
+    def masculize(string)
+      genderize(string, false)
+    end
+
   end
+  extend Genderizr::Changers
+
+
+  module Forms
+
+    def m2f_forms
+      @m2f_forms ||= masculine_to_feminine
+    end
+
 
+    def m2f_forms=(hash)
+      @f2m_forms = hash.invert
+      @m2f_forms = hash
+    end
+
+  private
+
+    def feminine_to_masculine
+      @f2m_forms ||= m2f_forms.invert
+    end
+
+
+    def default_m2f_forms
+      {
+        '♂' => '♀',
+        '⚨' => '♀',
+        '⚩' => '♀',
+        '⚣' => '⚢',
+        'boy' => 'girl',
+        'boyish' => 'girlish',
+        'boys' => 'girls',
+        'brother' => 'sister',
+        'brothers' => 'sisters',
+        'cowboy' => 'cowgirl',
+        'cowboys' => 'cowgirls',
+        'craftsman' => 'craftswoman',
+        'dad' => 'mom',
+        'daddy' => 'mommy',
+        'dick' => 'pussy',
+        'dude' => 'lady',
+        'dudes' => 'ladies',
+        'ex-wife' => 'ex-husband',
+        'father' => 'mother',
+        'fathers' => 'mothers',
+        'gentleman' => 'lady',
+        'gentlemen' => 'ladies',
+        'guy' => 'gal',
+        'guys' => 'gals',
+        'he' => 'she',
+        'him' => 'her',
+        'himself' => 'herself',
+        'his' => 'her',
+        'king' => 'queen',
+        'kings' => 'queens',
+        'male' => 'female',
+        'man' => 'woman',
+        'manhood' => 'womanhood',
+        'manlier' => 'womanlier',
+        'manliest' => 'womanliest',
+        'manliness' => 'womanliness',
+        'manly' => 'womanly',
+        'masculine' => 'feminine',
+        'masculinity' => 'femininity',
+        'men' => 'women',
+        'mister' => 'miss',  # Careful here going from feminine to masculine
+        'mr' => 'ms',
+        'mr.' => 'ms.',
+        'nobleman' => 'noblewoman',
+        'patriarch' => 'matriarch',
+        'prince' => 'princess',
+        'princes' => 'princesses',
+        'waited' => 'waitressed',
+        'waiter' => 'waitress'
+      }
+    end
 
-private
 
-  def feminine_to_masculine
-    masculine_to_feminine.invert
+    def masculine_to_feminine
+      @m2f_forms ||= default_m2f_forms
+    end
+
   end
+  extend Genderizr::Forms
 
-  def masculine_to_feminine
-    {
-      'boy' => 'girl',
-      'boyish' => 'girlish',
-      'boys' => 'girls',
-      'brother' => 'sister',
-      'brothers' => 'sisters',
-      'cowboy' => 'cowgirl',
-      'cowboys' => 'cowgirls',
-      'craftsman' => 'craftswoman',
-      'dad' => 'mom',
-      'daddy' => 'mommy',
-      'dick' => 'pussy',
-      'dude' => 'lady',
-      'dudes' => 'ladies',
-      'ex-wife' => 'ex-husband',
-      'father' => 'mother',
-      'fathers' => 'mothers',
-      'gentleman' => 'lady',
-      'gentlemen' => 'ladies',
-      'guy' => 'gal',
-      'guys' => 'gals',
-      'he' => 'she',
-      'him' => 'her',
-      'himself' => 'herself',
-      'his' => 'her',
-      'king' => 'queen',
-      'kings' => 'queens',
-      'male' => 'female',
-      'man' => 'woman',
-      'manhood' => 'womanhood',
-      'manlier' => 'womanlier',
-      'manliest' => 'womanliest',
-      'manliness' => 'womanliness',
-      'manly' => 'womanly',
-      'masculine' => 'feminine',
-      'masculinity' => 'femininity',
-      'men' => 'women',
-      'mr' => 'ms',
-      'mr.' => 'ms.',
-      'nobleman' => 'noblewoman',
-      'patriarch' => 'matriarch',
-      'prince' => 'princess',
-      'princes' => 'princesses',
-      'waitress' => 'waiter',
-      'waitressed' => 'waited'
-    }
+
+  module InstanceMethods
+    def feminize; Genderizr.feminize(self); end
+    def genderize(turn_feminine); Genderizr.genderize(self,turn_feminine); end
+    def masculize; Genderizr.masculize(self); end
   end
+
 end
 
-if defined?(Rails) && Rails::VERSION::MAJOR >= 3
-  require 'genderizr/rails'
+if defined?(Rails)
+  Genderizr.monkey_patch(String)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genderizr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
+date: 2012-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -35,8 +35,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/genderizr/rails.rb
-- lib/genderizr/version.rb
 - lib/genderizr.rb
 homepage: https://github.com/brundage/genderizr
 licenses: []

data/lib/genderizr/rails.rb

@@ -1,2 +0,0 @@
-require 'genderizr'
-class String; include Genderizr::StringMethods; end

data/lib/genderizr/version.rb

@@ -1 +0,0 @@
-module Genderizr; VERSION = "0.0.5"; end