roman-name-generator 0.1.1 → 0.1.2

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md LICENSE *.gemspec Rakefile Gemfile

data/Rakefile

@@ -5,12 +5,5 @@ require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 
-
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
-
+Dir.glob('lib/tasks/*.rake').each { |file| import file }
 task :default => :test

data/lib/roman_name_generator.rb

@@ -3,28 +3,47 @@ require "version"
 
 $:.unshift(File.dirname(__FILE__)+'/lib')
 
+# The gems' namespace
 module RomanNameGenerator
+  # The Generator class handles the loading and randomizing the json
+  # data store containing the roman name stub json. By default you only
+  # need to call the initializer, and as soon as it is instantiated, 
+  # it builds a random roman name based on the gender given.
+  #
+  # To get a new name, either initialize a new generator, or call
+  # #regenerate
+  #
+  # Example:
+  #   full_name = RomanNameGenerator::Generator.new("male").result
   class Generator
 
-    def self.version
-      "0.1.0"
-    end
-
-    attr_accessor :name_data, :gender, :result, :type
+    attr_accessor :name_data, :gender, :result
 
-    def initialize(gender)
+    # Generates a random name and assigns it to #result
+    # @param [String] gender the name's gender, `male` or `female`, defaults to `male`
+    def initialize(gender="male")
       self.gender = gender
-      self.result = random_name.strip
+      generate
+    end
+    
+    # Gives another random roman name based on the gender given in the
+    # constructor, assigns it to #result, and then returns #result
+    def regenerate
+      generate
     end
 
   private
+  
+    def generate
+      self.result = random_name.strip
+    end
 
-    def random_name # :nodoc:
+    def random_name
       load_name_data if self.name_data.nil?
       [random_first_name, random_middle_name, random_last_name].join(" ")
     end
 
-    def random_first_name # :nodoc:
+    def random_first_name
       case self.gender
       when "male"
         data = self.name_data['praenomens']
@@ -35,7 +54,7 @@ module RomanNameGenerator
       end
     end
 
-    def random_middle_name # :nodoc:
+    def random_middle_name
       case self.gender
       when "male"
         data = self.name_data['nomens']['male']
@@ -45,7 +64,7 @@ module RomanNameGenerator
       end
     end
 
-    def random_last_name # :nodoc:
+    def random_last_name
       case self.gender
       when "male"
         data = self.name_data['cognomens']['male']
@@ -56,7 +75,7 @@ module RomanNameGenerator
       end
     end
 
-    def load_name_data # :nodoc:
+    def load_name_data
       self.name_data = JSON(
         File.open(
           File.expand_path("../data/names.json", __FILE__)

data/lib/tasks/doc.rake

@@ -0,0 +1,4 @@
+desc "Generate YARD"
+task :doc do
+  sh "yardoc --no-private --protected lib/**/*.rb - README.md LICENSE *.gemspec Rakefile Gemfile Gemfile.lock"
+end

data/lib/tasks/test.rake

@@ -0,0 +1,6 @@
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module RomanNameGenerator
-  VERSION = "0.1.1"
+  VERSION = "0.1.2" # :nodoc:
 end

data/roman-name-generator.gemspec

@@ -14,7 +14,10 @@ Gem::Specification.new do |gem|
   gem.name          = "roman-name-generator"
   gem.require_paths = ["lib"]
   gem.version       = RomanNameGenerator::VERSION
+  gem.has_rdoc      = 'yard'
   
+  gem.add_development_dependency('yard')
+  gem.add_development_dependency('redcarpet')
   gem.add_development_dependency('minitest')
   gem.add_development_dependency('mocha')
   gem.add_development_dependency('turn')

data/test/minitest_helper.rb

@@ -40,7 +40,7 @@ Turn.config do |c|
  # :pretty   - new pretty reporter
  # :marshal  - dump output as YAML (normal run mode only)
  # :cue      - interactive testing
- c.format  = :outline
+ c.format  = :cue
  # turn on invoke/execute tracing, enable full backtrace
  c.trace   = true
  # use humanized test names (works only with :outline format)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roman-name-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,9 +11,31 @@ bindir: bin
 cert_chain: []
 date: 2012-03-16 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2161015480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161015480
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2161015060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161015060
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2156763280 !ruby/object:Gem::Requirement
+  requirement: &2161014640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156763280
+  version_requirements: *2161014640
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2164612840 !ruby/object:Gem::Requirement
+  requirement: &2161014220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164612840
+  version_requirements: *2161014220
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &2164612420 !ruby/object:Gem::Requirement
+  requirement: &2161013800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164612420
+  version_requirements: *2161013800
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2164612000 !ruby/object:Gem::Requirement
+  requirement: &2161013380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164612000
+  version_requirements: *2161013380
 description: A fun generator to generate ancient roman names
 email:
 - james@rubyloves.me
@@ -63,13 +85,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/data/names.json
 - lib/roman_name_generator.rb
-- lib/tasks/console.rb
+- lib/tasks/console.rake
+- lib/tasks/doc.rake
+- lib/tasks/test.rake
 - lib/version.rb
 - roman-name-generator.gemspec
 - test/_shared_examples/male_roman_name_test.rb
@@ -105,3 +130,4 @@ test_files:
 - test/lib/roman_name_generator_test.rb
 - test/lib/version_test.rb
 - test/minitest_helper.rb
+has_rdoc: yard