gendered 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5859ca1d1852db42a01dd6bebff96919f330de
+  data.tar.gz: a140d18f8c36eb7a57c96442de2ab59e1c21daf9
+SHA512:
+  metadata.gz: a9b94c3fe3227f97963dd2bc391a27d8d4cf51de5d621c0635e56666e30c1a115bf51c6f5f3e18a2c8e8f42c83fb6b7a183362a19085ae0ab73aee94e990f499
+  data.tar.gz: 579f61a222de993b23679c4aee149892840040d45f91fbb9852dee8b7a5efa30b893e15699450535f62f0799fc16c3ea9a235dcde595754584fd27134f608f9d

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: exec

data/.gitignore

@@ -0,0 +1,12 @@
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gendered.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sean Devine
+
+MIT License
+
+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,45 @@
+# Gendered
+
+**THIS LIBRARY IS STILL IN DEVELOPMENT.**
+
+Guess the gender of a name with the help of the [genderize.io](http://genderize.io).
+
+```bash
+gem install gendered
+```
+
+You can guess one name at a time...
+```ruby
+> require 'gendered'
+> name = Gendered::Name.new("Sean")
+> name.gender
+> :not_guessed
+> name.guess!
+=> :male
+> name.male?
+=> true
+> name.female?
+=> false
+> name.probability
+=> "0.99E0"
+> name.sample_size
+=> 967
+```
+
+Or batch up a list of names (which sends only one request to the API)...
+```ruby
+> require 'gendered'
+> name_list = Gendered::NameList.new(["Sean","Theresa"])
+> name_list.guess!
+=> [:male, :female]
+> name_list.collect { |name| name.male? }
+=> [true, false]
+> name_list.collect { |name| name.female? }
+=> [false, true]
+> name_list.collect { |name| name.probability.to_f }
+=> [0.99, 1.0]
+> name_list.collect { |name| name.sample_size }
+=> [967, 370]
+> name_list["Sean"].gender
+=> :male
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/exec/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/exec/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/exec/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/exec/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/exec/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/gendered.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gendered/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gendered"
+  spec.version       = Gendered::VERSION
+  spec.authors       = ["Sean Devine"]
+  spec.email         = ["barelyknown@icloud.com"]
+  spec.summary       = "Guess the gender of a name."
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", ">= 0.6.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gendered.rb

@@ -0,0 +1,12 @@
+require 'bigdecimal'
+
+require "http"
+
+require "gendered/version"
+require "gendered/name"
+require "gendered/name_list"
+require "gendered/guesser"
+
+module Gendered
+
+end

data/lib/gendered/guesser.rb

@@ -0,0 +1,42 @@
+module Gendered
+  class Guesser
+
+    attr_accessor :names
+
+    def initialize(values)
+      raise ArgumentError, "cannot be empty" if Array(values).empty?
+
+      @names = Array(values)
+    end
+
+    def guess!
+      response = HTTP.get(url)
+      case response.code
+      when 200
+        @names = JSON.parse(response.body).collect do |guess|
+          name = names.find { |n| n.to_s == guess["name"] }
+
+          if name.is_a?(String)
+            name = Name.new(guess["name"])
+          end
+
+          name.tap do |n|
+            n.gender = guess["gender"].to_sym
+            n.probability = guess["probability"]
+            n.sample_size = guess["count"]
+          end
+        end
+        self.names
+      end
+    end
+
+    def url
+      url = "http://api.genderize.io/?"
+      name_queries = names.collect.with_index do |name, index|
+        "name[#{index}]=#{name}"
+      end
+      url + name_queries.join("&")
+    end
+
+  end
+end

data/lib/gendered/name.rb

@@ -0,0 +1,67 @@
+module Gendered
+  class Name
+    VALID_GENDERS = %i(male female)
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+
+      @gender, @probability, @sample_size = nil, nil, nil
+    end
+
+    alias_method :to_s, :value
+
+    def guessed?
+      !!@gender
+    end
+
+    def guess!
+      Guesser.new(self).guess!
+      gender
+    end
+
+    def probability=(value)
+      decimal = BigDecimal(value.to_s)
+      raise ArgumentError, "value not between 0.01 and 1.0" if decimal <= 0 || decimal > 1
+
+      @probability = decimal
+    end
+
+    def probability
+      @probability || :unknown
+    end
+
+    def sample_size=(value)
+      integer = Integer(value)
+      raise ArgumentError, "value not greater than or equal to 0" if integer < 0
+
+      @sample_size = integer
+    end
+
+    def sample_size
+      @sample_size || :unknown
+    end
+
+    def gender=(value)
+      symbol = value.to_sym
+      raise ArgumentError, "not a valid gender" unless VALID_GENDERS.include?(symbol)
+      @gender = symbol
+    end
+
+    def gender
+      @gender || :not_guessed
+    end
+
+    def male?
+      return :not_guessed unless guessed?
+      gender == :male
+    end
+
+    def female?
+      return :not_guessed unless guessed?
+      gender == :female
+    end
+
+  end
+end

data/lib/gendered/name_list.rb

@@ -0,0 +1,34 @@
+module Gendered
+  class NameList
+    include Enumerable
+
+    attr_reader :names
+
+    def initialize(values)
+      @names = Array(values).collect do |value|
+        case value
+        when String then Name.new(value)
+        when Name then value
+        end
+      end
+    end
+
+    def guess!
+      Guesser.new(names).guess!
+      names.collect(&:gender)
+    end
+
+    def each(&block)
+      names.each do |name|
+        block.call name
+      end
+    end
+
+    def [](value)
+      names.find do |name|
+        name.value == value
+      end
+    end
+
+  end
+end

data/lib/gendered/version.rb

@@ -0,0 +1,3 @@
+module Gendered
+  VERSION = "0.0.1"
+end

data/spec/lib/gendered/guesser_spec.rb

@@ -0,0 +1,34 @@
+module Gendered
+  describe Guesser do
+
+    let :names do
+      ["Sean","Theresa"]
+    end
+
+    subject do
+      described_class.new names
+    end
+
+    it "is initialized with names" do
+      expect(subject.names).to eq names
+    end
+
+    it "creates the correct url" do
+      expect(subject.url).to eq "http://api.genderize.io/?name[0]=Sean&name[1]=Theresa"
+    end
+
+    it "cannot be initialized with an empty array" do
+      expect{described_class.new([])}.to raise_error ArgumentError
+    end
+
+    describe "#guess!" do
+      it "returns a valid guesses hash" do
+        names = subject.guess!
+        names.each do |name|
+          expect(name).to be_a Name
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/gendered/name_list_spec.rb

@@ -0,0 +1,33 @@
+module Gendered
+  describe NameList do
+    subject do
+      described_class.new values
+    end
+    let :values do
+      ["Sean","Theresa"]
+    end
+    describe "#guess!" do
+      it "guesses correctly" do
+        guesser = double(Guesser)
+        expect(guesser).to receive(:guess!)
+        expect(Guesser).to receive(:new).with(subject.names).and_return(guesser)
+        subject.guess!
+      end
+    end
+    context "when the values are strings" do
+      it "sets the names" do
+        subject.names.each.with_index do |name, index|
+          expect(name.value).to eq values[index]
+        end
+      end
+    end
+    context "when the values are names" do
+      let :values do
+        [Name.new("Sean"),Name.new("Theresa")]
+      end
+      it "sets the names" do
+        expect(subject.names).to eq values
+      end
+    end
+  end
+end

data/spec/lib/gendered/name_spec.rb

@@ -0,0 +1,147 @@
+module Gendered
+  describe Name do
+
+    let :value do
+      "Sean"
+    end
+
+    subject do
+      described_class.new value
+    end
+
+    it "initializes with a value" do
+      expect(subject.value).to eq value
+    end
+
+    describe "#to_s" do
+      it "converts with its value" do
+        expect(subject.to_s).to eq subject.value
+      end
+    end
+
+    describe "guess!" do
+      it "returns the gender" do
+        expect(subject.guess!).to eq :male
+      end
+    end
+
+    describe "#gender=" do
+      described_class::VALID_GENDERS.each do |value|
+        it "can set the gender to #{value}" do
+          subject.gender = value
+          expect(subject.gender).to eq value
+        end
+      end
+      it "raises an argument error if the gender is set to something invalid" do
+        %w(eunich).each do |value|
+          expect{subject.gender = value}.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe "#gender" do
+      it "is not_guessed" do
+        expect(subject.gender).to eq :not_guessed
+      end
+    end
+
+    context "when the gender is male" do
+      before { subject.gender = :male }
+      it "is male" do
+        expect(subject).to be_male
+      end
+      it "is not female" do
+        expect(subject).to_not be_female
+      end
+    end
+
+    context "when the gender is female" do
+      before { subject.gender = :female }
+      it "is female" do
+        expect(subject).to be_female
+      end
+      it "is not male" do
+        expect(subject).to_not be_male
+      end
+    end
+
+    context "when the gender is not set" do
+      describe "#male?" do
+        it "is not_guessed" do
+          expect(subject.male?).to eq :not_guessed
+        end
+      end
+      describe "#female?" do
+        it "is not_guessed" do
+          expect(subject.female?).to eq :not_guessed
+        end
+      end
+    end
+
+    describe "#guessed" do
+      context "when the gender is set" do
+        before do
+          subject.gender = :male
+        end
+        it "is guessed" do
+          expect(subject).to be_guessed
+        end
+      end
+      context "when the gender is not set" do
+        it "is not guessed" do
+          expect(subject).to_not be_guessed
+        end
+      end
+    end
+
+    describe "#probability=" do
+      it "can set probability greater than 0 and less than or equal to 1" do
+        probabilities = [BigDecimal("0.01")]
+        until probabilities.last == 1
+          probabilities << (probabilities.last + BigDecimal("0.01"))
+        end
+        probabilities.each do |p|
+          subject.probability = p
+          expect(subject.probability).to eq BigDecimal(p.to_s)
+        end
+      end
+      it "raises an ArgumentError if the value is 0" do
+        expect{subject.probability = 0}.to raise_error(ArgumentError)
+      end
+      it "raises an ArgumentError if the value is greater than 1" do
+        expect{subject.probability = 1.01}.to raise_error(ArgumentError)
+      end
+      it "raises an ArgumentError if the value can't convert to a decimal" do
+        expect{subject.probability = "not a decimal"}.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "#sample_size=" do
+      it "raises an ArgumentError if the value can't be converted to an Integer" do
+        expect{subject.sample_size = "not an integer"}.to raise_error(ArgumentError)
+      end
+      it "can set an integer sample size greater than or equal to 0" do
+        (0..1).each do |value|
+          subject.sample_size = value
+          expect(subject.sample_size).to eq value
+        end
+      end
+      it "raises an ArgumentError if the value is less than 0" do
+        expect{subject.sample_size = -1}.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "#probability" do
+      it "is :unknown unless set" do
+        expect(subject.probability).to eq :unknown
+      end
+    end
+
+    describe "#sample_size" do
+      it "is :unknown unless set" do
+        expect(subject.sample_size).to eq :unknown
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "gendered"
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: gendered
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Devine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Guess the gender of a name.
+email:
+- barelyknown@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exec/bundler
+- exec/htmldiff
+- exec/ldiff
+- exec/rake
+- exec/rspec
+- gendered.gemspec
+- lib/gendered.rb
+- lib/gendered/guesser.rb
+- lib/gendered/name.rb
+- lib/gendered/name_list.rb
+- lib/gendered/version.rb
+- spec/lib/gendered/guesser_spec.rb
+- spec/lib/gendered/name_list_spec.rb
+- spec/lib/gendered/name_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Guess the gender of a name.
+test_files:
+- spec/lib/gendered/guesser_spec.rb
+- spec/lib/gendered/name_list_spec.rb
+- spec/lib/gendered/name_spec.rb
+- spec/spec_helper.rb
+has_rdoc: