namey 0.0.2 → 0.0.5

data/Gemfile

@@ -1,4 +1,25 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Specify your gem's dependencies in namey.gemspec
 gemspec
+    
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'simplecov', :require => false, :group => :test
+
+  gem "shoulda", ">= 0"
+  gem "rspec"
+
+  gem "bundler", "~> 1.0.0"
+  gem "watchr"
+end
+
+#
+# couple extra gems for testing db connectivity
+#
+group :test do
+  gem "sequel"
+  gem "mysql"
+  gem "sqlite3"
+end

data/README.markdown

@@ -0,0 +1,105 @@
+Namey
+=====
+
+Namey is a ruby gem for auto-generating names.  It uses the [US Census
+Bureau database](http://www.census.gov/genealogy/names/) of first and last names to generate random
+names. Since the database itself specifies the frequency of each name,
+you can get specify whether you want a common name, rare name, etc.
+
+
+## Usage ##
+
+Using namey is pretty straightforward. 
+
+    require 'namey'
+    @generator = Namey::Generator.new
+
+    @generator.name
+     => "Maria Fisher" 
+
+Or, to get a particular frequency level, try one of these:
+
+    @generator.name(:common)
+     => "Michael Thomas" 
+
+	@generator.name(:rare)
+	 => "Deangelo Jotblad" 
+
+	@generator.name(:all)
+     => "Emanuel Boddorf" 
+
+You can also specify `male` or `female` to stick to one gender:
+
+    @generator.male
+     => "David Gonzales" 
+    @generator.female
+     => "Sharon Richardson" 
+
+	@generator.male(:rare)
+	=> "Son Plude" 
+
+	@generator.female(:rare)
+	=> "Blossom VanWie" 
+
+NOTE: All these methods default to returning common names unless you
+specify a different level.
+
+Finally, you can specify true/false as the second parameter to any
+call to specify if you want a surname:
+
+    @generator.male(:common, false)
+     => "Michael" 
+    @generator.male(:common, false)
+     => "William" 
+
+Finally, you can access the `generate` method directly and specify `min_freq`
+and `max_freq` to get a range of names:
+
+	# a somewhat rare name
+    @generator.generate(:type => :male, :with_surname => true, :min_freq => 80, :max_freq => 100)
+     => "Salvatore Billard" 
+
+	# a more rare name
+	@generator.generate(:type => :male, :with_surname => true, :min_freq => 90, :max_freq => 100)
+	=> "Broderick Burhanuddin" 
+
+	# a common name
+	@generator.generate(:type => :male, :with_surname => true, :min_freq => 0, :max_freq => 5)
+	=> "James Davis" 
+	
+	# another common name
+	@generator.generate(:type => :female, :with_surname => true, :min_freq => 0, :max_freq => 5)
+	=> "Linda Williams"
+
+## Data ##
+
+Namey comes with a pre-loaded SQLite database. However, you can
+specify a different datasource when initializing the gem:
+
+    @generator = Namey::Generator.new("mysql://username:passwrd@host/database")
+
+Namey uses Sequel to access data, and is tested with both MySQL and
+SQLite. It might need some tweaking to work with other engines.
+
+If you want to fiddle around with the data, you can check out
+Namey::Importer, or the `namey-load-data` script included with the
+gem, which will generate the database from the original source files.
+
+
+## Capitalization ##
+
+The data from the Census Bureau is in all caps, it looks a lot like
+this:
+
+	SMITH          1.006  1.006      1
+	JOHNSON        0.810  1.816      2
+	WILLIAMS       0.699  2.515      3
+	JONES          0.621  3.136      4
+	BROWN          0.621  3.757      5
+
+That's fine with basic names, but names with more than one capital in
+them are challenging.  The data is also stripped of apostrophes, so
+O'Brien is actually OBRIEN. The namey parser attempts to correct some
+of this, but it probably misses some.  If you find any glaring
+examples, just let me know.
+

data/Rakefile

@@ -1,2 +1,56 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+
+require "namey/version"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts = %w{--exclude .bundler,.rvm}
+  spec.rcov = true
+end
+
+task :default => :spec
+
+
+
+desc "Generate RDoc"
+task :doc => ['doc:generate']
+
+
+#
+# YARD task from http://stackoverflow.com/questions/2138427/can-i-get-my-readme-textile-into-my-rdoc-with-proper-formatting
+#
+namespace :doc do
+  project_root = File.expand_path(File.join(File.dirname(__FILE__)))
+  doc_destination = File.join(project_root, 'doc')
+
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+
+    YARD::Rake::YardocTask.new(:generate) do |yt|
+      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb'))
+      #+ 
+      #             [ File.join(project_root, 'README.markdown') ]
+      yt.options = ['--output-dir', doc_destination, '--readme', 'README.markdown']
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :generate do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_destination if File.exists?(doc_destination)
+  end
+
+end

data/api/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+source 'http://gemcutter.org'
+
+gem "sinatra"
+gem "mysql"
+gem "sequel"
+gem "redcarpet"
+gem "json"
+
+gem "namey", :path => "/home/colin/Projects/namey"

data/api/config.ru

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require './namey_app'
+#run NameyApp
+run Sinatra::Application

data/api/namey_app.rb

@@ -0,0 +1,50 @@
+require 'sinatra'
+require 'namey'
+require 'json'
+
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end
+
+before do
+  @generator = Namey::Generator.new("mysql://root@localhost/namey")
+end
+  
+get '/' do
+  # use index.haml for readme
+  erb :index #, :layout => :index
+end
+  
+get '/name.?:format?' do
+  opts = {
+    :frequency => :common
+  }.merge(params.symbolize_keys!)
+
+  opts[:with_surname] = true if params[:with_surname] == "true"
+
+  [:type, :frequency].each do |key|
+    opts[key] = opts[key].to_sym if opts.has_key?(key)
+  end
+
+  opts.delete(:type) if ! [:male, :female, :surname].include?(opts[:type])
+  #opts[:type] = "both" if ! [:male, :female, :surname].include?(opts[:type])
+  
+  count = (params.delete(:count) || 1).to_i
+  count = 10 if count > 10
+  
+  names = 1.upto(count).collect do
+    @generator.generate(opts)
+  end
+  
+  if params[:format] == "json"
+    content_type :json, 'charset' => 'utf-8'
+    JSON.pretty_generate names
+  else
+    ["<ul>", names.collect { |n| "<li>#{n}</li>" }.join(" "), "</ul>"].join("")
+  end
+end 

data/api/public/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/api/public/Makefile

@@ -0,0 +1,30 @@
+VERSION=1.4.0
+DATE=$(shell DATE)
+BOOTSTRAP = ./bootstrap.css
+BOOTSTRAP_MIN = ./bootstrap.min.css
+BOOTSTRAP_LESS = ./lib/bootstrap.less
+LESS_COMPRESSOR ?= `which lessc`
+WATCHR ?= `which watchr`
+
+build:
+	@@if test ! -z ${LESS_COMPRESSOR}; then \
+		sed -e 's/@VERSION/'"v${VERSION}"'/' -e 's/@DATE/'"${DATE}"'/' <${BOOTSTRAP_LESS} >${BOOTSTRAP_LESS}.tmp; \
+		lessc ${BOOTSTRAP_LESS}.tmp > ${BOOTSTRAP}; \
+		lessc ${BOOTSTRAP_LESS}.tmp > ${BOOTSTRAP_MIN} --compress; \
+		rm -f ${BOOTSTRAP_LESS}.tmp; \
+		echo "Bootstrap successfully built! - `date`"; \
+	else \
+		echo "You must have the LESS compiler installed in order to build Bootstrap."; \
+		echo "You can install it by running: npm install less -g"; \
+	fi
+
+watch:
+	@@if test ! -z ${WATCHR}; then \
+	  echo "Watching less files..."; \
+	  watchr -e "watch('lib/.*\.less') { system 'make' }"; \
+	else \
+		echo "You must have the watchr installed in order to watch Bootstrap less files."; \
+		echo "You can install it by running: gem install watchr"; \
+	fi
+
+.PHONY: build watch