clean_words 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e21a8e581c088c6134cc3c12d99489e381cdec9f
+  data.tar.gz: 26940772316a30e2b53c06514018e2621b53b137
+SHA512:
+  metadata.gz: 9fc0620b64bea23d547f5462b38ac2dd79f9b303a268a59aef7e1523ef47013d98c9aef8d4719ace74b1b2a0a2837b51cf3945533abdbcc4e6c900f2f7fad47c
+  data.tar.gz: a2b0d728e53bda18a18e73d626d4a0e0580accf44a73fec75bcbc3cc0e5c700a20bca1abd626b73f767df8f663a8a52be2949326249dec9ecbef722aac9d1c28

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clean_words.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Foraker
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jake Sutton
+
+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,57 @@
+# CleanWords
+
+A clean (i.e. "kid friendly") random word generator.
+
+Currently the word list varies in size from 4 to 12 letters in length and consists mostly of words for animals, food, plants, and buildings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clean_words'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clean_words
+
+## Usage
+
+```Ruby
+words = CleanWords::Random.new
+
+# Fetch a random word
+words.fetch
+#=> 'aspen'
+
+# Fetch a number of random words
+words.fetch(nil, 3)
+#=> ['aspen', 'terrier', 'apple']
+
+# Fetch a random word of a particular size
+words.fetch(6)
+#=> 'arctic'
+
+# Fetch random words of an array of sizes
+words.fetch([4,6], 2)
+#=> ['arctic', 'fort']
+
+# Fetch random words of a range of sizes
+words.fetch((4..6), 4)
+#=> ['fort', 'gopher', 'arctic', 'maple']
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/foraker/clean_words/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+  - NOTE: If adding words to `data/words.txt`, please execute `ruby util/sanitize_list.rb` from the project root before commiting.
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/clean_words.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_words/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clean_words"
+  spec.version       = CleanWords::VERSION
+  spec.authors       = ["Jake Sutton"]
+  spec.email         = ["jcs@foraker.com"]
+  spec.summary       = %q{A clean (i.e. "kid friendly") random word generator.}
+  spec.description   = %q{A random word generator featuring only words that would not be considered inappropriate for children of all ages.}
+  spec.homepage      = "http://foraker.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/data/words.txt

@@ -0,0 +1,550 @@
+aardvark
+abalone
+abbey
+acorn
+aircraft
+airport
+albacore
+albatross
+alfalfa
+algae
+alligator
+almond
+alpaca
+amoeba
+amphibian
+angelfish
+animal
+anteater
+antelope
+apartment
+apple
+applesauce
+aqueduct
+arachnid
+arch
+arctic
+arena
+armadillo
+artichoke
+arugala
+asparagus
+aspen
+assembly
+avocado
+baboon
+bacon
+badger
+bagel
+bandicoot
+barley
+barn
+barnacle
+barracks
+barracuda
+bass
+basset
+beach
+beagle
+beans
+bear
+beetle
+beluga
+bighorn
+bird
+bison
+bisque
+bivalve
+blackbird
+bloodhound
+blowfish
+bluebird
+bluefin
+boathouse
+bobcat
+bongo
+bonobo
+border
+bowhead
+bowling
+boxer
+bread
+bridge
+brittle
+broccoli
+brown
+brownstone
+buffalo
+building
+bulldog
+bullfrog
+bumblebee
+bungalow
+bunkhouse
+buritto
+butterfly
+cabana
+cabbage
+cabin
+caiman
+cake
+camel
+canary
+capitol
+cardinal
+caribou
+carport
+carrot
+castle
+catamount
+caterpillar
+catfish
+cathedral
+cattle
+cedar
+celery
+centipede
+cereal
+chalet
+chameleon
+chapel
+cheese
+cheetah
+chickadee
+chicken
+chihuahua
+chinchilla
+chipmunk
+chips
+chocolate
+chowder
+church
+cicada
+cinema
+clownfish
+clubhouse
+cobra
+coffee
+college
+collie
+compound
+concert
+conch
+condominium
+conservatory
+cookie
+coral
+corn
+cottage
+cougar
+coyote
+crab
+crane
+crayfish
+cricket
+crocodile
+crow
+cupcake
+curry
+cuttlefish
+cutworm
+dalmatian
+dates
+deer
+depot
+diatom
+dingo
+dinosaur
+doberman
+dodo
+dogfish
+dolphin
+dome
+donkey
+donut
+dormitory
+double
+dove
+downy
+dragon
+dragonfly
+dromedary
+duck
+dugong
+dumpling
+duplex
+dwelling
+eagle
+earthworm
+earwig
+eastern
+egret
+electric
+elephant
+embassy
+emerald
+emperor
+ermine
+exposition
+factory
+falcon
+farm
+farmhouse
+ferret
+finch
+firefly
+firehouse
+fish
+flamingo
+flea
+flightless
+flounder
+flower
+flying
+forest
+forge
+fort
+fortress
+foundry
+fowl
+frilled
+frog
+fruit
+gallery
+garage
+garlic
+gazebo
+gazelle
+gecko
+gerbil
+giant
+gibbon
+giraffe
+gnat
+gnocchi
+goat
+golden
+goldfinch
+goldfish
+goose
+gopher
+gorilla
+granary
+granola
+grape
+grapes
+grasshopper
+great
+green
+greenhouse
+greyhound
+groundhog
+grouper
+grouse
+guinea
+gull
+gumbo
+gymnasium
+halibut
+hall
+hamburger
+hammerhead
+hamster
+hangar
+hare
+harlequin
+hawk
+headquarters
+hedgehog
+heron
+herring
+hickory
+highland
+honey
+hornet
+horse
+horseshoe
+hospital
+hotel
+hound
+house
+houseboat
+howler
+human
+hummingbird
+hyena
+igloo
+iguana
+impala
+insect
+jaguar
+jelly
+jellyfish
+joey
+juice
+junebug
+kabobs
+kale
+kangaroo
+ketchup
+kidney
+kiosk
+kiwi
+koala
+laboratory
+ladybug
+lamb
+larva
+lasagna
+laurel
+lemming
+lemon
+lemur
+leopard
+library
+lighthouse
+lightning
+lilac
+linguine
+lion
+lizard
+llama
+lobster
+locust
+lodge
+longhorn
+loon
+loris
+luminous
+lynx
+macaw
+mackerel
+magnolia
+mako
+malamute
+mall
+mallard
+mamba
+mammal
+mammoth
+manor
+manse
+mansion
+manta
+mantid
+mantis
+maple
+marbled
+marina
+marine
+market
+marmoset
+marmot
+marsupial
+mastiff
+mastodon
+meadowlark
+meerkat
+meeting
+mice
+midge
+migrate
+milk
+milkshake
+mill
+millipede
+minaret
+mink
+minnow
+mobile
+moccasin
+mockingbird
+mole
+mollusk
+monarch
+monastery
+mongoose
+monitor
+monkey
+monument
+moose
+moray
+mosque
+mosquito
+motel
+moth
+mountain
+mouse
+muffin
+museum
+mussels
+narwhal
+nautilus
+nest
+newt
+nightingale
+noodles
+northern
+nurse
+nymph
+observatory
+ocelot
+octopus
+office
+opera
+opossum
+orangutan
+oriole
+ostrich
+otter
+painted
+palace
+pancake
+panda
+panther
+parakeet
+parking
+parrot
+pavilion
+pelican
+penguin
+pigeon
+pika
+pine
+pizza
+plankton
+plant
+platypus
+polar
+poodle
+porcupine
+porpoise
+prairie
+puffin
+puma
+pyramid
+python
+quail
+queen
+quiche
+rabbit
+raccoon
+racer
+railway
+ranch
+reindeer
+reptile
+residence
+restaurant
+retriever
+reuben
+river
+roach
+roadrunner
+robin
+rodent
+rooster
+sailfish
+salamander
+salmon
+scallop
+scarlet
+school
+seahorse
+seal
+sealion
+shack
+shark
+shed
+sheep
+sheepdog
+shelter
+shepherd
+shopping
+shrew
+shrine
+skating
+skink
+skipper
+skunk
+skyscraper
+skyway
+snail
+snake
+snapper
+snapping
+snow
+spaghetti
+spaniel
+sparrow
+spider
+spinach
+spiny
+spire
+sponge
+spotted
+squash
+squid
+squirrel
+stable
+stadium
+starfish
+starling
+state
+station
+stingray
+store
+stork
+strider
+structure
+studio
+sunfish
+supermarket
+swan
+swift
+swordfish
+sycamore
+symphony
+tamarin
+tarpon
+tent
+terminal
+termite
+tern
+terrier
+theater
+tiger
+toast
+tortoise
+toucan
+tower
+townhouse
+treefrog
+treehouse
+trout
+trumpeter
+tundra
+turkey
+turtle
+university
+urchin
+valley
+veiled
+venison
+villa
+violet
+walnut
+warehouse
+water
+watermill
+western
+whippet
+wine
+wolf
+wolverine
+wombat
+woodchuck
+woodland
+workshop
+wren
+yogurt

data/lib/clean_words.rb

@@ -0,0 +1,45 @@
+require "clean_words/version"
+
+module CleanWords
+  class Random
+    def self.fetch(size=nil, count=1)
+      new(size, count).fetch
+    end
+
+    def fetch(size=nil, count=1)
+      @size = size
+      @count = count
+      @count > 1 ? @count.times.map { get_word } : get_word
+    end
+
+    private
+
+    def get_word
+      word_pool.shuffle.pop
+    end
+
+    def word_pool
+      @size.nil? ? words : words_for_size
+    end
+
+    def words
+      @words ||= File.new(file_path).readlines.map(&:chomp)
+    end
+
+    def file_path
+      File.dirname(__FILE__) + '/../data/words.txt'
+    end
+
+    def words_for_size
+      sizes.map { |size| words_by_length[size] }.flatten
+    end
+
+    def sizes
+      @size.respond_to?(:to_a) ? @size.to_a : [@size]
+    end
+
+    def words_by_length
+      @words_by_length ||= words.group_by(&:size)
+    end
+  end
+end

data/lib/clean_words/version.rb

@@ -0,0 +1,3 @@
+module CleanWords
+  VERSION = "0.0.1"
+end

data/spec/clean_words_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+module CleanWords
+  describe Random do
+    describe '#fetch' do
+      it 'calls fetch on a new instance' do
+        words = double(fetch: 'test')
+        allow(CleanWords::Random).to receive(:new).and_return(words)
+
+        expect(CleanWords::Random.fetch).to eq 'test'
+      end
+    end
+
+    describe '.fetch' do
+      it 'returns a word' do
+        words = CleanWords::Random.new
+        allow(words).to receive(:words).and_return(%w(test))
+
+        expect(words.fetch).to eq 'test'
+      end
+
+      it 'returns the specified number of words' do
+        words = CleanWords::Random.new.fetch(nil, 3)
+
+        expect(words.size).to eq 3
+      end
+
+      it 'returns a word of the specified size' do
+        word = CleanWords::Random.new.fetch(5)
+
+        expect(word.size).to eq 5
+      end
+
+      it 'returns words that match an array of size options' do
+        words = CleanWords::Random.new.fetch([5,7], 100)
+        sizes = words.map(&:size).uniq
+
+        expect(sizes).to match_array [5,7]
+      end
+
+      it 'returns words that match a range of sizes' do
+        words = CleanWords::Random.new.fetch((4..6), 100)
+        sizes = words.map(&:size).uniq
+
+        expect(sizes).to match_array [4,5,6]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'clean_words'

data/util/sanitize_list.rb

@@ -0,0 +1,4 @@
+require_relative './word_list_sanitizer'
+
+WordListSanitizer.new.run!
+puts "Done!"

data/util/word_list_sanitizer.rb

@@ -0,0 +1,23 @@
+class WordListSanitizer
+  def initialize
+    @words ||= File.new(file_path).readlines.map(&:chomp)
+  end
+
+  def run!
+    process_words
+    write_file
+  end
+
+  private
+  def file_path
+    File.dirname(__FILE__) + '/../data/words.txt'
+  end
+
+  def process_words
+    @processed = @words.reject { |w| w.match(/^\w+$/).nil? }.map(&:downcase).sort.uniq
+  end
+
+  def write_file
+    File.open(file_path, 'w') { |f| @processed.each { |w| f.puts(w) } }
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: clean_words
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jake Sutton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A random word generator featuring only words that would not be considered
+  inappropriate for children of all ages.
+email:
+- jcs@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- clean_words.gemspec
+- data/words.txt
+- lib/clean_words.rb
+- lib/clean_words/version.rb
+- spec/clean_words_spec.rb
+- spec/spec_helper.rb
+- util/sanitize_list.rb
+- util/word_list_sanitizer.rb
+homepage: http://foraker.com
+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 clean (i.e. "kid friendly") random word generator.
+test_files:
+- spec/clean_words_spec.rb
+- spec/spec_helper.rb