fake_british_toponym 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92f720344f5905e03b9f365b6c29350deccb3b2
-  data.tar.gz: 8dd8b8ea66c5cfdd03929ee5a0e38f8282fa12a0
+  metadata.gz: d4a64ee31075c5aa867e9c17b4f02dc9ac0d5157
+  data.tar.gz: 343d8ba461b7d3ed614e4fe1b76193fb925cb7e6
 SHA512:
-  metadata.gz: 26e1c31165aafc0245325a6592db9b4978f3d2be72eac7328a4ece15753e19836ab58294d99e62b7aa1ca368b7c31c7c8aa982be3fb2f3ae8c7df62929a774fb
-  data.tar.gz: 0d712562fd6488aa05900e2b0e97a75dd62693d74e8d3e765c32304e274cdb87ef249f057ffe54936688bb275e82d9ea16ade96361f230b2837e2983f789102a
+  metadata.gz: 9ff7f640f02d13029a6869e78c4157c67bfebd65c189b83e302ad44bdc2ff91dfc5dcff7d385e25b5954d9b611347335df7c4adea0f699e905db35f3d3892383
+  data.tar.gz: 3d0ab9d548613f45499a763b19520f535f1245691e5077e2e21c2967ac2a7f86561e3a3628f3142bcfad1290c4b70bff2b4ab613170bc6c3f5317160d906c297

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gem "probability"
 
@@ -10,6 +10,7 @@ end
 
 group :development, :test do
   gem "pry"
+  gem "rspec", "~>3.1.0"
 end
 
 gemspec

data/README.md

@@ -26,14 +26,14 @@ Or install it yourself as:
     $ pry
     [0] main » require "fake_british_toponym"
     => true
-    [0] main » FakeBritishToponym.new
-    => "Dunkirkton"
-    [0] main » FakeBritishToponym.new
-    => "Midnocktondeen Crossing"
-    [0] main » FakeBritishToponym.new
-    => "Port Aberglentun"
-    [0] main » FakeBritishToponym.new
-    => "Lymetunmore Bight"
+    [0] main » Array.new(5) { FakeBritishToponym.new }
+    => ["Abercastercesholm",
+     "Lymekirktunforth",
+     "South Gloutonbeck",
+     "Intonwich",
+     "Port Shrewsbeckhamp"]
+    [0] main » FakeBritishToponym.new(min_syllables: 5)
+    => "Lancotherglennock Castle"
 
 ...that's all, folks!
 

data/fake_british_toponym.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/lib/fake_british_toponym.rb

@@ -1,92 +1,80 @@
 require "probability"
 
-class FakeBritishToponym < String
+require "fake_british_toponym/corpus"
 
-  ANTEFIXES = %w( east great little new north old port saint south west )
-  PREFIXES  = %w( aber avon ash bex birm blen brad bre burn car chef cul dal don dun ex gains glou hex hol in inver ips kil kings knock lan leigh lin lock lon long lough lyme man mannan mid middle mills moss new nor not oak ock old pad pen puds shrews stan stin sud sur swin tarn thorn tilly tre up wake wall well wey which wil win wor worth yar )
-  INFIXES   = %w( beck caster ces cester cot er folk ford glen ham hamp her ill ing kirk more ness nock ter tun ton wich )
-  SUFFIXES  = %w( bie borough bost born burgh bury bridge by carden cay chester church combe dale deen den don dun ey field firth fork forth frith garth gate head holm hop hurst inge keld lan land law leigh ley low minster moth mouth orth over pool rith rock sbury set shaw shep ship shire stead ster stone ter thorp tham thwait tyne well wich wold wick )
-  POSTFIXES = %w( bight castle crossing downs gate glen grove hall hamlet -in- marsh of -on- -on-the- river 's sands town -under- -upon- village water willow )
+class FakeBritishToponym < String
 
   def initialize(**args)
     args[:modifier] = true unless args.has_key? :modifier
     args[:min_syllables] ||= 2
 
-    @pieces = []
-
-    add_prefix
+    super build_name(args[:min_syllables], args[:modifier])
+  end
 
-    args[:min_syllables].times do
-      add_infix
-    end
+  private
 
-    add_suffix if @pieces.length == 1 || 3.in(10)
+  def build_name(min_syllables, use_modifier)
+    pieces = []
 
-    add_decoration if args[:modifier] && 1.in(2)
+    pieces.push CORPUS.random_prefix.capitalize
 
-    @name = join_pieces
+    min_syllables.times do
+      pieces.push pick_infix(pieces)
+    end
 
-    super @name # do some String-y things
-  end
+    add_suffix(pieces) if pieces.length == 1 || 3.in(10)
 
-  def to_str
-    @name.to_s
-  end
+    add_decoration(pieces) if use_modifier && 1.in(2)
 
-  private
+    name = pieces.join
 
-  def add_antefix
-    @pieces.unshift "#{random_antefix.capitalize} "
+    name
   end
 
-  def add_prefix
-    @pieces.push random_prefix.capitalize
+  def add_antefix(list)
+    list.unshift "#{CORPUS.random_antefix.capitalize} "
   end
 
-  def add_infix
-    @pieces.push pick_infix
+  def add_suffix(list)
+    list.push pick_suffix(list)
   end
 
-  def add_suffix
-    @pieces.push pick_suffix
-  end
-
-  def add_postfix
-    pick = random_postfix
+  def add_postfix(list)
+    pick = CORPUS.random_postfix
     case pick
     when /^-/ # "-on-the-", "-upon-", etc
-      @pieces.push pick
-      @pieces.push new_decoration_toponym
+      list.push pick
+      list.push new_decoration_toponym
     when "of"
-      @pieces.push " #{pick} "
-      @pieces.push new_decoration_toponym
+      list.push " #{pick} "
+      list.push new_decoration_toponym
     when "'s"
-      @pieces.push "#{pick} "
-      @pieces.push new_decoration_toponym
+      list.push "#{pick} "
+      list.push new_decoration_toponym
     else
-      @pieces.push " #{pick.capitalize}"
+      list.push " #{pick.capitalize}"
     end
   end
 
-  def add_decoration
+  def add_decoration(list)
     if 1.in(2)
-      add_antefix
+      add_antefix(list)
     else
-      add_postfix
+      add_postfix(list)
     end
   end
 
-  def pick_infix
+  def pick_infix(list)
     begin
-      pick = random_infix
-    end while pick == @pieces.last # try not to double up syllables
-    double_last_letter_if_needed pick
+      pick = CORPUS.random_infix
+    end while pick == list.last # try not to double up syllables
+    double_last_letter(list) if doubled_last_letter_needed?(list, pick)
     pick
   end
 
-  def pick_suffix
-    pick = random_suffix
-    double_last_letter_if_needed pick
+  def pick_suffix(list)
+    pick = CORPUS.random_suffix
+    double_last_letter(list) if doubled_last_letter_needed?(list, pick)
     pick
   end
 
@@ -94,21 +82,10 @@ class FakeBritishToponym < String
     self.class.new modifier: false
   end
 
-  %w(ante pre in suf post).each do |which|
-    define_method("random_#{which}fix") do
-      corpus = self.class.const_get("#{which.upcase}FIXES")
-      corpus.sample
-    end
-  end
-
-  def double_last_letter_if_needed(pick)
-    double_last_letter if doubled_last_letter_needed?(pick)
-  end
-
-  def doubled_last_letter_needed?(pick)
+  def doubled_last_letter_needed?(list, pick)
     return false unless begins_with_vowel? pick
-    return false if ends_with_vowel? @pieces.last
-    return false if ends_with_doubled_letters? @pieces.last
+    return false if ends_with_vowel? list.last
+    return false if ends_with_doubled_letters? list.last
     true
   end
 
@@ -124,13 +101,10 @@ class FakeBritishToponym < String
     word[-1] == word[-2]
   end
 
-  def double_last_letter
-    last_piece = @pieces.pop
-    @pieces.push last_piece + last_piece[-1]
-  end
-
-  def join_pieces
-    @pieces.join.to_s
+  def double_last_letter(list)
+    last_piece = list.pop
+    last_piece_doubled = last_piece + last_piece[-1]
+    list.push last_piece_doubled
   end
 
 end

data/lib/fake_british_toponym/corpus.rb

@@ -0,0 +1,229 @@
+class FakeBritishToponym < String
+  module CORPUS
+
+    def self.random_antefix
+      ANTEFIXES.sample
+    end
+
+    def self.random_prefix
+      PREFIXES.sample
+    end
+
+    def self.random_infix
+      INFIXES.sample
+    end
+
+    def self.random_suffix
+      SUFFIXES.sample
+    end
+
+    def self.random_postfix
+      POSTFIXES.sample
+    end
+
+    ANTEFIXES = %w(
+      east
+      great
+      little
+      new
+      north
+      old
+      port
+      saint
+      south
+      west
+    )
+
+    PREFIXES = %w(
+      aber
+      avon
+      ash
+      bex
+      birm
+      blen
+      brad
+      bre
+      burn
+      car
+      chef
+      cul
+      dal
+      don
+      dun
+      ex
+      gains
+      glou
+      hex
+      hol
+      in
+      inver
+      ips
+      kil
+      kings
+      knock
+      lan
+      leigh
+      lin
+      lock
+      lon
+      long
+      lough
+      lyme
+      man
+      mannan
+      mid
+      middle
+      mills
+      moss
+      new
+      nor
+      not
+      oak
+      ock
+      old
+      pad
+      pen
+      puds
+      shrews
+      stan
+      stin
+      sud
+      sur
+      swin
+      tarn
+      thorn
+      tilly
+      tre
+      up
+      wake
+      wall
+      well
+      wey
+      which
+      wil
+      win
+      wor
+      worth
+      yar
+    )
+
+    INFIXES = %w(
+      beck
+      caster
+      ces
+      cester
+      cot
+      er
+      folk
+      ford
+      glen
+      ham
+      hamp
+      her
+      ill
+      ing
+      kirk
+      more
+      ness
+      nock
+      ter
+      tun
+      ton
+      wich
+    )
+
+    SUFFIXES = %w(
+      bie
+      borough
+      bost
+      born
+      burgh
+      bury
+      bridge
+      by
+      carden
+      cay
+      chester
+      church
+      combe
+      dale
+      deen
+      den
+      don
+      dun
+      ey
+      field
+      firth
+      fork
+      forth
+      frith
+      garth
+      gate
+      head
+      holm
+      hop
+      hurst
+      inge
+      keld
+      lan
+      land
+      law
+      leigh
+      ley
+      low
+      minster
+      moth
+      mouth
+      orth
+      over
+      pool
+      rith
+      rock
+      sbury
+      set
+      shaw
+      shep
+      ship
+      shire
+      stead
+      ster
+      stone
+      ter
+      thorp
+      tham
+      thwait
+      tyne
+      well
+      wich
+      wold
+      wick
+    )
+
+    POSTFIXES = %w(
+      bight
+      castle
+      crossing
+      downs
+      gate
+      glen
+      grove
+      hall
+      hamlet
+      -in-
+      marsh
+      of
+      -on-
+      -on-the-
+      river
+      's
+      sands
+      town
+      -under-
+      -upon-
+      village
+      water
+      willow
+    )
+
+  end
+end

data/lib/fake_british_toponym/version.rb

@@ -1,3 +1,3 @@
 class FakeBritishToponym < String
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/fake_british_toponym_spec.rb

@@ -4,48 +4,75 @@ describe FakeBritishToponym do
 
   MANY = 10e3.to_i
 
-  it "should exist" do
-    expect(FakeBritishToponym).to be_truthy
+  describe "#initialize" do
+
+    subject { FakeBritishToponym.new }
+
+    it { is_expected.to be_a String }
+
   end
 
-  describe "options" do
+  describe "#initialize options" do
 
     describe "modifier" do
-      describe "when set to false" do
+
+      describe "false" do
+
+        subject { Array.new(MANY) { FakeBritishToponym.new(modifier: false) } }
+
         it "should never be more than one word or include punctuation" do
-          MANY.times do
-            toponym = FakeBritishToponym.new(modifier: false)
+          subject.each do |toponym|
             expect(toponym).to_not include " "
             expect(toponym).to_not include "-"
             expect(toponym).to_not include "'"
           end
         end
+
       end
 
-      it "should not contain obvious errors" do
-        DOUBLE_CAPITAL_REGEX = /{[A-Z]{2}/
-        DOUBLE_NONALPHA_REGEX = /[^[:alpha:]]{2}/
+      describe "true" do
+
+        subject { Array.new(MANY) { FakeBritishToponym.new(modifier: true) } }
 
-        MANY.times do
-          toponym = FakeBritishToponym.new(modifier: true)
-          [DOUBLE_CAPITAL_REGEX, DOUBLE_NONALPHA_REGEX].each do |regex|
-            expect(toponym).not_to match regex
+        it "should not have double capital letters" do
+          DOUBLE_CAPITAL_REGEX = /{[A-Z]{2}/
+          subject.each do |toponym|
+            expect(toponym).not_to match DOUBLE_CAPITAL_REGEX
           end
-          [" -", "- ", " '", "' "].each do |bad_char_sequence|
-            expect(toponym).not_to include bad_char_sequence
+        end
+
+        it "should not have double punctuation/spaces" do
+          DOUBLE_NONALPHA_REGEX = /[^[:alpha:]]{2}/
+          subject.each do |toponym|
+            expect(toponym).not_to match DOUBLE_NONALPHA_REGEX
           end
         end
+
+        it "should not have invalid character sequences" do
+          # little redundant with the nonalpha test
+          subject.each do |toponym|
+            [" -", "- ", " '", "' "].each do |bad_char_sequence|
+              expect(toponym).not_to include bad_char_sequence
+            end
+          end
+        end
+
       end
+
     end
 
     describe "min_syllables" do
+
+      length = rand(10)
+
+      subject { Array.new(MANY) { FakeBritishToponym.new(min_syllables: length) } }
+
       it "should return words of roughly appropriate length" do
-        MANY.times do
-          length = rand(10)
-          toponym = FakeBritishToponym.new(min_syllables: length)
+        subject.each do |toponym|
           expect(toponym.length).to be > length * 2
         end
       end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fake_british_toponym
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 description: Generate place names that sound sorta British
 email:
 - alxndr+gem@gmail.com
@@ -72,6 +72,7 @@ files:
 - Rakefile
 - fake_british_toponym.gemspec
 - lib/fake_british_toponym.rb
+- lib/fake_british_toponym/corpus.rb
 - lib/fake_british_toponym/version.rb
 - spec/fake_british_toponym_spec.rb
 - spec/spec_helper.rb
@@ -86,9 +87,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="