fake_british_toponym 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e92f720344f5905e03b9f365b6c29350deccb3b2
+  data.tar.gz: 8dd8b8ea66c5cfdd03929ee5a0e38f8282fa12a0
+SHA512:
+  metadata.gz: 26e1c31165aafc0245325a6592db9b4978f3d2be72eac7328a4ece15753e19836ab58294d99e62b7aa1ca368b7c31c7c8aa982be3fb2f3ae8c7df62929a774fb
+  data.tar.gz: 0d712562fd6488aa05900e2b0e97a75dd62693d74e8d3e765c32304e274cdb87ef249f057ffe54936688bb275e82d9ea16ade96361f230b2837e2983f789102a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.ruby-gemset

@@ -0,0 +1 @@
+fake-british-toponyms

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem "probability"
+
+group :development do
+  gem "codeclimate-test-reporter", require: false
+  gem "guard"
+  gem "guard-rspec", require: false
+end
+
+group :development, :test do
+  gem "pry"
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+  watch("Gemfile.lock")         { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander
+
+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,46 @@
+# FakeBritishToponym
+
+[![Build Status](https://travis-ci.org/alxndr/fake_british_toponym.svg?branch=master)](https://travis-ci.org/alxndr/fake_british_toponym)
+[![Dependency Status](https://gemnasium.com/alxndr/fake_british_toponym.svg)](https://gemnasium.com/alxndr/fake_british_toponym)
+[![Code Climate](https://codeclimate.com/github/alxndr/fake_british_toponym/badges/gpa.svg)](https://codeclimate.com/github/alxndr/fake_british_toponym)
+[![Test Coverage](https://codeclimate.com/github/alxndr/fake_british_toponym/badges/coverage.svg)](https://codeclimate.com/github/alxndr/fake_british_toponym)
+
+Generate names of places that sound sorta British.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "fake_british_toponym"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake_british_toponym
+
+## Usage
+
+    $ 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"
+
+...that's all, folks!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob("tasks/**/*.rake").each(&method(:import))
+
+task default: %i(spec)

data/fake_british_toponym.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include? lib
+require 'fake_british_toponym/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_british_toponym"
+  spec.version       = FakeBritishToponym::VERSION
+  spec.authors       = ["Alexander"]
+  spec.email         = ["alxndr+gem@gmail.com"]
+  spec.description   = "Generate place names that sound sorta British"
+  spec.summary       = "A basic class which creates a string that sounds like it could be a town in the British Isles."
+  spec.homepage      = "https://github.com/alxndr/fake_british_toponym"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fake_british_toponym/version.rb

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

data/lib/fake_british_toponym.rb

@@ -0,0 +1,136 @@
+require "probability"
+
+class FakeBritishToponym < String
+
+  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 )
+
+  def initialize(**args)
+    args[:modifier] = true unless args.has_key? :modifier
+    args[:min_syllables] ||= 2
+
+    @pieces = []
+
+    add_prefix
+
+    args[:min_syllables].times do
+      add_infix
+    end
+
+    add_suffix if @pieces.length == 1 || 3.in(10)
+
+    add_decoration if args[:modifier] && 1.in(2)
+
+    @name = join_pieces
+
+    super @name # do some String-y things
+  end
+
+  def to_str
+    @name.to_s
+  end
+
+  private
+
+  def add_antefix
+    @pieces.unshift "#{random_antefix.capitalize} "
+  end
+
+  def add_prefix
+    @pieces.push random_prefix.capitalize
+  end
+
+  def add_infix
+    @pieces.push pick_infix
+  end
+
+  def add_suffix
+    @pieces.push pick_suffix
+  end
+
+  def add_postfix
+    pick = random_postfix
+    case pick
+    when /^-/ # "-on-the-", "-upon-", etc
+      @pieces.push pick
+      @pieces.push new_decoration_toponym
+    when "of"
+      @pieces.push " #{pick} "
+      @pieces.push new_decoration_toponym
+    when "'s"
+      @pieces.push "#{pick} "
+      @pieces.push new_decoration_toponym
+    else
+      @pieces.push " #{pick.capitalize}"
+    end
+  end
+
+  def add_decoration
+    if 1.in(2)
+      add_antefix
+    else
+      add_postfix
+    end
+  end
+
+  def pick_infix
+    begin
+      pick = random_infix
+    end while pick == @pieces.last # try not to double up syllables
+    double_last_letter_if_needed pick
+    pick
+  end
+
+  def pick_suffix
+    pick = random_suffix
+    double_last_letter_if_needed pick
+    pick
+  end
+
+  def new_decoration_toponym
+    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)
+    return false unless begins_with_vowel? pick
+    return false if ends_with_vowel? @pieces.last
+    return false if ends_with_doubled_letters? @pieces.last
+    true
+  end
+
+  def begins_with_vowel?(word)
+    word.match(/^[aeiou]/)
+  end
+
+  def ends_with_vowel?(word)
+    word.match(/[aeiou]$/)
+  end
+
+  def ends_with_doubled_letters?(word)
+    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
+  end
+
+end

data/spec/fake_british_toponym_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe FakeBritishToponym do
+
+  MANY = 10e3.to_i
+
+  it "should exist" do
+    expect(FakeBritishToponym).to be_truthy
+  end
+
+  describe "options" do
+
+    describe "modifier" do
+      describe "when set to false" do
+        it "should never be more than one word or include punctuation" do
+          MANY.times do
+            toponym = FakeBritishToponym.new(modifier: false)
+            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}/
+
+        MANY.times do
+          toponym = FakeBritishToponym.new(modifier: true)
+          [DOUBLE_CAPITAL_REGEX, DOUBLE_NONALPHA_REGEX].each do |regex|
+            expect(toponym).not_to match regex
+          end
+          [" -", "- ", " '", "' "].each do |bad_char_sequence|
+            expect(toponym).not_to include bad_char_sequence
+          end
+        end
+      end
+    end
+
+    describe "min_syllables" do
+      it "should return words of roughly appropriate length" do
+        MANY.times do
+          length = rand(10)
+          toponym = FakeBritishToponym.new(min_syllables: length)
+          expect(toponym.length).to be > length * 2
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "fake_british_toponym"

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: fake_british_toponym
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate place names that sound sorta British
+email:
+- alxndr+gem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fake_british_toponym.gemspec
+- lib/fake_british_toponym.rb
+- lib/fake_british_toponym/version.rb
+- spec/fake_british_toponym_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/alxndr/fake_british_toponym
+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: A basic class which creates a string that sounds like it could be a town
+  in the British Isles.
+test_files:
+- spec/fake_british_toponym_spec.rb
+- spec/spec_helper.rb