genderize 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d5896e1856dac2e401a587209c71b2cae369821
-  data.tar.gz: 6a116943a73774552baf065423aba613f3b4642c
+  metadata.gz: 2ee1ba31da4da138caff5ae82d75060bc9b7a65e
+  data.tar.gz: 02a6a2d5a0894b28b546db7fdedee478c9fe2a1d
 SHA512:
-  metadata.gz: 6f1afe0ebcb4288691692cebffc584697e5c83cd328ee9165892b98571d8bcddeed28270dd5ae492ccc6b87cb851bff25b4a8257328926fd5c1030dd024cf748
-  data.tar.gz: 5140e5c42950d1f64e6cc5715a31d37eea13fa7f65a6ff39c4abdd15e8d47a345927e89e7cc4afe50218280435baba9240312af4bf7ac90ed9248ef422fcabb3
+  metadata.gz: 949548a45ebe65219d834b7d9f8e3a92f3ed525ac67cb38570d8580d0d97fd474cc832c71f5e8af49e3fb7b46b480af53f52ba29c0b18fe291850992a9cff94d
+  data.tar.gz: 1b8c9cac5895dd580e0ab0733c45ed77d7be7c085be9e8bf9f22ce03e4ee0ce46de3fea67c02309802860152d4f3f5665d93a510ea2b81dd82a2389f859467ab

data/README.md

@@ -2,28 +2,126 @@
 
 Genderize is a simple Rails gem for adding gender helper methods to Rails models.
 
+_New:_ we now have non-binary as an option
+
 ## Example
 
 
-    # Setting the gender is simple - just set the attribute value to "m" or "f"
+### Feminine
+
+    # Setting the gender is simple - just set the attribute value to "m", "n", or "f"
     @user = User.new(gender: "f")
 
+    # This also works
+    @user = User.new(gender: "female")
+
     # This gives us a few helper methods to add gender specific text to our views
-    @user.gender.male? # => false  
+    @user.gender.male? # => false
+    @user.gender.non_binary? # => false
     @user.gender.name # => "female"
     @user.gender.to_s # => "f"
     @user.gender.abbr # => "f"
-    
+
     # gender pronouns
     # As the subject of a sentence
     @user.gender.subject # => 'she'
+
     # As the object of a sentence
     @user.gender.object # => 'her'
+
     # Showing possession
     @user.gender.possessive # => 'her'
+
+    # Writing a casual form of the gender
+    @user.gender.casual # => "girl"
+
+### Masculine
+
+    # Setting the gender is simple - just set the attribute value to "m", "n", or "f"
+    @user = User.new(gender: "m")
+
+    # This also works
+    @user = User.new(gender: "male")
+
+    # This gives us a few helper methods to add gender specific text to our views
+    @user.gender.female? # => false
+    @user.gender.non_binary? # => false
+    @user.gender.name # => "male"
+    @user.gender.to_s # => "m"
+    @user.gender.abbr # => "m"
+
+    # gender pronouns
+    # As the subject of a sentence
+    @user.gender.subject # => 'he'
+
+    # As the object of a sentence
+    @user.gender.object # => 'him'
+
+    # Showing possession
+    @user.gender.possessive # => 'his'
+
+    # Writing a casual form of the gender
+    @user.gender.casual # => "guy"
+
+### Non-binary
+
+    # Setting the gender is simple - just set the attribute value to "m", "n", or "f"
+    @user = User.new(gender: "n")
+
+    # This also works
+    @user = User.new(gender: "non-binary")
+    @user = User.new(gender: "non_binary")
+    @user = User.new(gender: "non binary")
+
+    # This gives us a few helper methods to add gender specific text to our views
+    @user.gender.female? # => false
+    @user.gender.male? # => false
+    @user.gender.non_binary? # => true
+    @user.gender.name # => "non_binary"
+    @user.gender.to_s # => "n"
+    @user.gender.abbr # => "n"
+
+    # gender pronouns
+    # As the subject of a sentence
+    @user.gender.subject # => 'they'
+
+    # As the object of a sentence
+    @user.gender.object # => 'them'
+
+    # Showing possession
+    @user.gender.possessive # => 'their'
+
+    # Writing a casual form of the gender
+    @user.gender.casual # => "person"
+
+### Blank (no gender specified)
+
+    @user = User.new(gender: "")
+
+    # This gives us a few helper methods to add gender specific text to our views
+    @user.gender.female? # => false
+    @user.gender.male? # => false
+    @user.gender.name # => ""
+    @user.gender.to_s # => ""
+    @user.gender.abbr # => ""
+
+    # gender pronouns
+    # As the subject of a sentence
+    @user.gender.subject # => 'they'
+
+    # As the object of a sentence
+    @user.gender.object # => 'them'
+
+    # Showing possession
+    @user.gender.possessive # => 'their'
+
     # Writing a casual form of the gender
-    @user.gender.casual # => "chick"
-  
+    @user.gender.casual # => "person"
+
+## Changing these values
+
+You can change the values for each of the methods described above by modifying your locales file. See [config/locales/en.yml](config/locales/genderize.en.yml) for more info.
+
 ## Installation
 
 Add this to your Gemfile:
@@ -45,7 +143,7 @@ Finally, to *genderize* a model attribute:
     class User < ActiveRecord::Base
 
       genderize
-      
+
       # ... or, if your db column isn't named `gender`
       genderize(:user_gender)
 
@@ -61,7 +159,7 @@ by another Githuber
 
 ## Documentation
 
-Full documentation is available here: http://rubydoc.info/gems/blogit
+Full documentation is available here: http://rubydoc.info/gems/genderize
 
 ## Contributing
 
@@ -71,12 +169,12 @@ You're welcome to contribute to Genderize.
 
 Copyright 2013 [Katana Code Ltd.](http://katanacode.com)
 
-See (LEGAL)[LEGAL] for full details.
+See [LEGAL](MIT-LICENSE) for full details.
 
 ## Credits
 
-Developed by [Katana Code](http://katanacode.com)
+Developed by [Katana](http://katanacode.com)
 
-## About Katana Code
+## About Katana
 
-Katana Code are [Ruby on Rails Developers Based in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").
+Katana are [mobile and web app developers based in Edinburgh, Scotland](http://katanacode.com/ "Katana").

data/config/locales/genderize.en.yml

@@ -3,26 +3,31 @@ en:
     name:
       masculine: "male"
       feminine: "female"
+      non_binary: "non_binary"
       blank: ""
 
   # pronouns
     subject:
       masculine: 'he'
       feminine: 'she'
+      non_binary: they
       blank: "they"
 
     object:
       masculine: 'him'
       feminine: 'her'
+      non_binary: them
       blank: "them"
 
     possessive:
       masculine: 'his'
       feminine: 'her'
+      non_binary: their
       blank: "their"
 
     # Other forms
     casual:
       masculine: guy
       feminine: girl
+      non_binary: person
       blank: person

data/lib/genderize.rb

@@ -35,16 +35,12 @@ module Genderize
       # Raises ArgumentError if gender is not a single alphanumeric character "m" or "f"
       define_method "#{col_name}=" do |string|
         string = string.to_s.first
-        unless string.to_s =~ /\A(m|f|)\Z/i
-          raise ArgumentError, "Gender must be one of '', 'm', or 'f'"
+        unless string.to_s =~ /\A(m|f|n|)\Z/i
+          raise ArgumentError, "Gender must be one of '', 'n', 'm', or 'f'"
         end
         write_attribute(col_name, string)
 
-        if string.blank?
-          instance_variable_set("@#{col_name}", string)
-        else
-          instance_variable_set("@#{col_name}", Genderize::Gender.new(read_attribute(col_name)))
-        end
+        instance_variable_set("@#{col_name}", Genderize::Gender.new(read_attribute(col_name)))
       end
 
     end

data/lib/genderize/gender.rb

@@ -4,13 +4,13 @@ module Genderize
     include I18n
 
     # Maps the gender abbreviation name to the full name for translation keys
-    ABR_KEY_NAME_MAPPING = { "" => "blank", "m" => "masculine", "f" => "feminine" }
+    ABR_KEY_NAME_MAPPING = { "" => "blank", "m" => "masculine", "f" => "feminine", "n" => "non_binary" }
 
 
     attr_reader :abbr
 
     def initialize(abbr)
-      unless abbr.blank? or abbr.to_s =~ /\A(f|m|female|male)\Z/i
+      unless abbr.blank? or abbr.to_s =~ /\A(f|m|n|female|male|non[ -_]?binary)\Z/i
         raise "Invalid abbreviation: '#{abbr}'"
       end
       @abbr = abbr.blank? ? '' : abbr.to_s.first.downcase
@@ -48,6 +48,10 @@ module Genderize
       abbr == 'f'
     end
 
+    def non_binary?
+      abbr == 'n'
+    end
+
     def blank?
       abbr == ""
     end

data/lib/genderize/version.rb

@@ -1,3 +1,3 @@
 module Genderize
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/spec/dummy/spec/models/user_spec.rb

@@ -4,26 +4,69 @@ describe User, type: :model do
 
   describe "gender" do
 
-    let(:user) { User.new(gender: "f") }
+    let(:user) { User.new(gender: gender) }
 
-    it "should return a Gender object" do
-      expect(user.gender).to be_an_instance_of(Genderize::Gender)
+    context "when female" do
+      let(:gender) { "f" }
+
+      it "should return a Gender object" do
+        expect(user.gender).to be_an_instance_of(Genderize::Gender)
+      end
+
+      it "should be female?" do
+        expect(user.gender).to be_female
+      end
     end
 
-    it "should be female?" do
-      expect(user.gender).to be_female
+    context "when male" do
+      let(:gender) { "m" }
+
+      it "should return a Gender object" do
+        expect(user.gender).to be_an_instance_of(Genderize::Gender)
+      end
+
+      it "should be male?" do
+        expect(user.gender).to be_male
+      end
     end
 
-    it "should be male when changed" do
-      user.gender = "m"
-      expect(user.gender).to be_male
+    context "when non-binary" do
+      let(:gender) { "n" }
+
+      it "should return a Gender object" do
+        expect(user.gender).to be_an_instance_of(Genderize::Gender)
+      end
+
+      it "should be non_binary?" do
+        expect(user.gender).to be_non_binary
+      end
     end
 
-    it "should be blank when changed" do
-      user.gender = ""
-      expect(user.gender).to be_empty
+    context "when blank" do
+      let(:gender) { "" }
+
+      it "should return a Gender object" do
+        expect(user.gender).to be_an_instance_of(Genderize::Gender)
+      end
+
+      it "should be blank?" do
+        expect(user.gender).to be_blank
+      end
     end
 
+    context "when changed" do
+      let(:gender) { "f" }
+
+      it "should be male when changed" do
+        user.gender = "m"
+        expect(user.gender).to be_male
+      end
+
+      it "should be blank when changed" do
+        user.gender = ""
+        expect(user.gender).to be_blank
+      end
+    end
   end
 
   describe "full gender names" do
@@ -31,6 +74,7 @@ describe User, type: :model do
     it 'should set the gender as the abbreviation' do
       expect(User.new(gender: "female").gender).to be_female
       expect(User.new(gender: "male").gender).to   be_male
+      expect(User.new(gender: "non-binary").gender).to be_non_binary
       expect(User.new(gender: "").gender).to       be_blank
     end
 

data/spec/lib/gender_spec.rb

@@ -2,18 +2,27 @@ require "spec_helper"
 
 describe Genderize::Gender do
 
-  let(:female) { Gender.new("f") }
-  let(:male)   { Gender.new("M") }
-  let(:blank)  { Gender.new('')  }
+  let(:female)     { Gender.new("f") }
+  let(:male)       { Gender.new("M") }
+  let(:non_binary) { Gender.new("n") }
+  let(:blank)      { Gender.new('')  }
 
   context "when full gender name is used" do
 
     it "should find the correct abbreviation" do
       expect(Gender.new("female").abbr).to eql('f')
       expect(Gender.new("male").abbr).to eql('m')
+      expect(Gender.new("non_binary").abbr).to eql('n')
       expect(Gender.new("").abbr).to eql('')
     end
 
+    it "can match a dash, underscore, space, or no separator for non_binary" do
+      separators = ["-", "_", " ", ''].each do |separator|
+        name = "non#{separator}binary"
+        expect(Gender.new(name).abbr).to eql('n')
+      end
+    end
+
   end
 
 
@@ -35,6 +44,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'non_binary" do
+        expect(non_binary.name).to eql("non_binary")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be ''" do
@@ -64,6 +81,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'n'" do
+        expect(non_binary.abbr).to eql("n")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be ''" do
@@ -93,6 +118,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'they'" do
+        expect(non_binary.subject).to eql("they")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be 'they'" do
@@ -121,6 +154,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'them'" do
+        expect(non_binary.object).to eql("them")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be 'them'" do
@@ -150,6 +191,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'their'" do
+        expect(non_binary.possessive).to eql("their")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be 'their'" do
@@ -180,6 +229,14 @@ describe Genderize::Gender do
 
     end
 
+    context "when non_binary" do
+
+      it "should be 'person'" do
+        expect(non_binary.casual).to eql("person")
+      end
+
+    end
+
     context "when blank" do
 
       it "should be 'person'" do
@@ -194,15 +251,17 @@ describe Genderize::Gender do
   describe :to_s do
 
     it "should equal the abbr value" do
-      expect(male.to_s).to   eql(male.abbr)
-      expect(female.to_s).to eql(female.abbr)
-      expect(blank.to_s).to  eql(blank.abbr)
+      expect(male.to_s).to       eql(male.abbr)
+      expect(female.to_s).to     eql(female.abbr)
+      expect(non_binary.to_s).to eql(non_binary.abbr)
+      expect(blank.to_s).to      eql(blank.abbr)
     end
 
     it "returns a string" do
-      expect(male.to_s).to   be_an_instance_of(String)
-      expect(female.to_s).to be_an_instance_of(String)
-      expect(blank.to_s).to  be_an_instance_of(String)
+      expect(male.to_s).to       be_an_instance_of(String)
+      expect(female.to_s).to     be_an_instance_of(String)
+      expect(non_binary.to_s).to be_an_instance_of(String)
+      expect(blank.to_s).to      be_an_instance_of(String)
     end
 
   end
@@ -210,9 +269,10 @@ describe Genderize::Gender do
   describe :capital_abbr do
 
     it "should equal the abbr value capitalized" do
-      expect(male.capital_abbr).to   eql(male.abbr.capitalize)
-      expect(female.capital_abbr).to eql(female.abbr.capitalize)
-      expect(blank.capital_abbr).to  eql(blank.abbr.capitalize)
+      expect(male.capital_abbr).to       eql(male.abbr.capitalize)
+      expect(female.capital_abbr).to     eql(female.abbr.capitalize)
+      expect(non_binary.capital_abbr).to eql(non_binary.abbr.capitalize)
+      expect(blank.capital_abbr).to      eql(blank.abbr.capitalize)
     end
 
   end
@@ -222,6 +282,7 @@ describe Genderize::Gender do
     it "should return true if passed abbr value" do
       expect(male == "m").to be_truthy
       expect(female == "f").to be_truthy
+      expect(non_binary == "n").to be_truthy
       expect(blank == nil).to be_truthy
       expect(blank == '').to be_truthy
     end
@@ -229,6 +290,7 @@ describe Genderize::Gender do
     it "should return false if not passed abbr value" do
       expect(male == "f").to be_falsey
       expect(female == 1).to be_falsey
+      expect(non_binary == "").to be_falsey
       expect(blank == "$").to be_falsey
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genderize
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Bodacious
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: A helpful class for gender-specific models in Ruby applications. Genderize
   adds useful helper methods for various pronouns and other written forms of male
   and female genders.
@@ -131,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A helpful class for gender-specific models in Ruby applications