randomperson 1.3.0 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1684642d6e98a13f159efde26ebe53651d96da4d
+  data.tar.gz: 6f28d8aa62754e2846598656b2437dd747988e90
+SHA512:
+  metadata.gz: 261270fc67ef91ae518840afd78cb2ccb2519e5409688998752e56bf129538f030d1c4136397ea6f8b880268676d9f938170b1b964feb5fc415159d9f4d72a25
+  data.tar.gz: 7c3831ddaf8ea131f4480c7eee0cd9c393e9ba8585b4e8e04f2aecfd4ba6a1dbab68e5ae0c1bb6d83990e0695056ea671a15ee305a46c57478e643a82cb80c64

data/.gitignore

@@ -1,6 +1,7 @@
 *.old
 .rvmrc
 *.tmproj
+.DS_Store
 
 *.gem
 
@@ -18,7 +19,10 @@ rdoc
 coverage/
 Gemfile.lock
 vendor/
+vendor.noindex/
 bin/
+doc/
 docs/
 .yardoc/
 .rbx/
+.bundle/

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format nested
+--format documentation

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 1.9.2
+  - 2.2.0
 # whitelist
 branches:
   only:

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+v 1.4.0 Friday the 27th of January 2017
+
+* Moved officially to >= Ruby v2.0.0
+* Fixed the specs to work with RSpec 3.5 and thus Travis.
+* Added a lot more yard docs.
+* Removed the monkey patches.
+* Pruned a few internals here and there.
+
+----
+
+v.1.3.1 Tuesday the 24th of January 2017
+
+* Moved the licence file to its own file for clarity. Thanks to Chad Perrin for asking for this, it was definitely needed.
+
+----
+
 v1.3.0 Tuesday the 11th of September 2012
 
 * Quicker to get data out if you're not bothered about the demographic make up.

data/Gemfile

@@ -2,3 +2,16 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "pry-byebug"
+  gem "rake"
+  gem "yard"
+  gem "kramdown"
+end
+
+group :test do
+  gem "rspec-its"
+  gem "rspec-given"
+  gem "simplecov"
+end

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Iain Barnett
+
+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.markdown

@@ -264,7 +264,7 @@ If you need to check what's loaded, use `loaded_classes`
 
 		r.demographics["French"].loaded_classes
 
-> # => {:femalefirst=>"French_Female_First", :last=>"French_Last", :malefirst=>"French_Male_First"}
+    # => {:femalefirst=>"French_Female_First", :last=>"French_Last", :malefirst=>"French_Male_First"}
 
 Or, see all the demographics' loaded classes:
 
@@ -476,29 +476,11 @@ Special thanks to my agent, all the people at Marvel and DC for such fine comics
 
 ## LICENCE:
 
-It's an MIT Licence, I didn't take any code from the Perl one just names and a slight idea on how to structure things, so this ain't gonna be under the GPL. MIT is better anyway ;)
-
- Copyright (c) 2012 Iain Barnett
-
- 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:
+See the LICENCE file.
 
- 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.
+It's an MIT Licence, I didn't take any code from the Perl one just names and a slight idea on how to structure things, so this ain't gonna be under the GPL. MIT is better anyway ;)
 
-In other words, be good.
+Please, when using this code, be good.
 
 
 

data/Rakefile

@@ -15,5 +15,5 @@ require 'yard'
 
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']   # optional  
-  t.options = ['-odocs/', '--no-private'] # optional
+  t.options = ['-odoc/', '--no-private'] # optional
 end

data/lib/randomperson.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-
+# A library for generating random names
 module RandomPerson
 
   #require all the scaffolding
@@ -9,12 +9,6 @@ module RandomPerson
   require 'date'
   
   require_relative './randomperson/version.rb'
-  require_relative './randomperson/ext/array.rb'
-  require_relative './randomperson/ext/date.rb'
-  require_relative './randomperson/ext/enumerable.rb'
-  require_relative './randomperson/ext/hash.rb'
-  require_relative './randomperson/ext/kernel.rb'
-  require_relative './randomperson/ext/set.rb'
   
   require_relative './randomperson/demographic.rb'
   require_relative './randomperson/generator.rb'
@@ -22,7 +16,11 @@ module RandomPerson
   require_relative './randomperson/person.rb'
   #require_relative './randomperson/ratio.rb'
 
+
+  # A slightly modified Hash to keep track of loaded classes.
   class DemoHash < Hash
+
+    # @return [Hash]
     def loaded_classes
       if @loaded_classes.nil?
         @loaded_classes = Hash.new
@@ -33,16 +31,21 @@ module RandomPerson
       @loaded_classes
     end
 
-    alias :old_store :store
+
+    # @see Hash#store
     alias :"[]=" :store
 
+
+    # @see Hash#store
     def store( key, value )
       @loaded_classes ||= Hash.new
       @loaded_classes[key] = value
-      old_store key, value
+      old_store.bind(self).call key, value
     end
   end
 
+
+  # Wrapper for convenience.
   class Facade
 
     # @return [Hash{String => RandomPerson::Demographic}]
@@ -50,11 +53,13 @@ module RandomPerson
       @demos ||= DemoHash.new
     end
 
+
     # @return [Hash]
     def loaded_classes
       demographics.loaded_classes
     end
 
+
     #class instance variable to keep track of generators
     def generators
       @generators ||= {}
@@ -85,14 +90,15 @@ module RandomPerson
       @person = nil
       @last_demo_name = nil
     end
-    
+
+ 
     alias :reset :clear
     attr_accessor :last_demo_name
 
 
     # The last person generated.
     # If a demographic name is given that is different to the last then a new person is generated. If no name is given then the last is used.
-    # @param [String,Symbol,Integer] name The key for retrieving the demographic.
+    # @param [String,Symbol,Integer] demo_name The key for retrieving the demographic.
     # @param [#call] block Error handler for when a key is given that does not exist.
     # @return [RandomPerson::Person]
     def person( demo_name=nil, &block )
@@ -123,7 +129,10 @@ module RandomPerson
     end
 
     
-
+    # Generate a new demographic
+    # @param [#to_s] demo_name A name for the demographic.
+    # @param [#call] block
+    # @return [RandomPerson::Demographic]
     def generate( demo_name=nil, &block )
       ds = gen_new( demo_name, &block )
       ds.nil? ? nil : ds.first
@@ -135,29 +144,35 @@ module RandomPerson
     def generate_demo
       Demographic.load
       yesses = %w{prefix suffix female -male last}.map {|word|
-        Demographic.available_name_files.classify_true(word).to_a.sample
+        Demographic.classify_true(word).to_a.sample
       }
       demo = self.demographic
       demo.require_and_add yesses
       [demo.name, demo]
     end
 
+
+    # The default default error block :)
     DEFAULT_gen_new_BLOCK = ->(error) {
       warn error.message
     }
 
 
+    # This holds the default error block
     def self.default_error_block
       @default_gen_new_error_block ||= DEFAULT_gen_new_BLOCK
     end
 
+
+    # Set the default error block
+    # @param [#call] block
     def self.default_error_block=( block )
       @default_gen_new_error_block = block
     end
 
 
     # If not given a demographic's name then the *last demographic defined* will be used. If there is no demographic already defined a new one will be created. If a key is given but does not exist then the supplied block will be called. If no block is given an exception will be raised.
-    # @param [String,Symbol,Integer] name The key for retrieving the demographic.
+    # @param [String,Symbol,Integer] demo_name The key for retrieving the demographic.
     # @param [#call] block Default for when a key is given that does not exist.
     def gen_new( demo_name=nil, &block )
       block = self.class.default_error_block if block.nil?
@@ -192,6 +207,12 @@ module RandomPerson
 
 end
 
+# Convenience method.
+# @example
+#   require 'randomperson'
+#   r = RandomPerson() # don't forget the brackets!
+#   r.generate  # => each time this will generate a new person.
+# @return [RandomPerson::Facade]
 def RandomPerson
   RandomPerson::Facade.new
 end

data/lib/randomperson/demographic.rb

@@ -1,27 +1,10 @@
 # encoding: UTF-8
 
 require_relative "./loader.rb"
-require_relative "./ext/set.rb"
-
-
 
 module RandomPerson
-  class Constant < String
-      
-    def to_constant
-      names = split('::')
-      names.shift if names.empty? || names.first.empty?
-  
-      constant = Object
-      names.each do |name|
-        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-      end
-      constant
-    end
-
-  end
-
 
+  # Handles the demographics
   class Demographic
     include Loader
     
@@ -29,6 +12,7 @@ module RandomPerson
     attr_accessor :name
 
 
+    # A hash of all the loaded classes.
     def loaded_classes
       @loaded_classes ||= {}
     end
@@ -42,8 +26,22 @@ module RandomPerson
     alias :female_first :femalefirst
 
 
-    def self.available_name_files
-      @available_name_files ||= Set.new
+    class << self
+
+      # The available name files!
+      # @return [Set]
+      def available_name_files
+        @available_name_files ||= Set.new
+      end
+
+
+      # @todo handle failure
+      # @return [Set] The set for which the pattern matches.
+      def classify_true( pattern )
+        available_name_files.classify{|s|
+          true if s =~ %r{^.*/[^/]*#{pattern}[^/]*$}i
+        }[true]
+      end
     end
 
 
@@ -101,15 +99,17 @@ module RandomPerson
     end
 
 
+    # Requires the name files and adds them to the loaded file hash.
+    # @api private
     def require_and_add( yesses ) 
-      yesses.map {|file_name|
+      yesses.each {|file_name|
         require file_name
-        Constant.new( Demographic.translate file_name )
-      }.each do |klass|
+        klass = Kernel.const_get( Demographic.translate file_name )
         addklass klass
-      end
+      }
     end
-      
+
+
     # tribe, gender, position
     def method_missing( name, *args )
       return super( name, *args ) unless name.to_s =~ /^add/
@@ -117,17 +117,26 @@ module RandomPerson
       words = get_words( name )
       
       nots = get_nots( words ).map{|word|
-        Demographic.available_name_files.classify_true(word)
-      }.fold(:&)
+        self.class.classify_true word
+      }.inject(:&)
       
       yesses = get_yesses( words ).map{|word| 
-          Demographic.available_name_files.classify_true(word)
-      }.fold(:&)
+        self.class.classify_true word
+      }.inject(:&)
       
       require_and_add yesses
 
       self # just because
     end
+
+
+    # Be nice.
+    # @api private
+    def respond_to_missing?(name, include_private = false)
+      self.class.method_defined?(name) or
+      name.to_s =~ /^add/ or
+      super
+    end
     
     
   end

data/lib/randomperson/generator.rb

@@ -1,5 +1,7 @@
 module RandomPerson
 
+  # Handles the generation of a new person.
+  # It's not as fun as the way humans handle this :)
   module Generator
     
     require_relative './person.rb'
@@ -83,12 +85,16 @@ module RandomPerson
     def self.pick_dob( age=16 )
       year  = Time.now.year - age
       month = rand(12) + 1;
-      day   = rand( Date.days_in_month( year, month ) ) + 1 
+      day   = rand( days_in_month( year, month ) ) + 1
       Time.local( year, month, day )
     end
 
-
-  
+    # Convenience function
+    # @param [Integer] year
+    # @param [Integer] month
+    # @return [Integer]
+    def self.days_in_month( year, month )
+      ::Date.civil(year, month, -1).day
+    end
   end
-
 end

data/lib/randomperson/loader.rb

@@ -1,8 +1,5 @@
 # encoding: UTF-8
 
-require_relative "./ext/kernel.rb"
-
-
 module RandomPerson
   
   # This module is here to do the loading of data into a demographic class
@@ -10,9 +7,12 @@ module RandomPerson
   module Loader
   
 
+    # Class methods
+    # @api private
     module ClassMethods
       
-      
+      # Loads the names, unsurprisingly.
+      # @api private
       def load_names( opts={} )
         opts = { patterns: ['*.rb'], lib_dir: File.dirname(__FILE__) }.merge( opts )
         
@@ -31,27 +31,39 @@ module RandomPerson
     
       
     end # ClassMethods
-  
-  
+
+
+    # Instance methods
+    # @api private
     module InstanceMethods
 
       # The patterns are there to stop other files being added by accident.
       # and to load the right names into the right instance var
       # @todo remove evil
       # @param [#to_constant] klass
-      def addklass( klass, patterns=[["Male",'First'],["Female", "First"], ['Last'], ['Prefix'], ['Suffix']] )
-      
+      # @api private
+      def addklass( klass, patterns=nil )
+        patterns ||=  [
+                        ["Male",'First'],
+                        ["Female", "First"],
+                        ['Last'], ['Prefix'],
+                        ['Suffix']
+                      ]
         patterns.each do |ps|
-          if ps.all?{|p| klass =~ /#{p}/ }
-            instance_variable_set( "@#{ps.join.downcase}", klass.to_constant.new)
-            instance_variable_get( :@loaded_classes ).store ps.join.downcase.to_sym, klass.to_s.split("::").last.scan( /([A-Z][a-z]+)/ ).flatten.join("_")
+          if ps.all?{|p| klass.name =~ /#{p}/ }
+            send "#{ps.join.downcase}=", klass.new
+            loaded_classes.store ps.join.downcase.to_sym, klass.name.split("::").last.scan( /[A-Z][a-z]+/ ).flatten.join("_")
           end # if
         end
         klass
       end # addklass
 
     end # InstanceMethods
-  
+
+
+    # Classic hooking
+    # @param [Class] receiver
+    # @api private
     def self.included(receiver)
       receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods