dingo 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 138af0bccfe5408b5cb7250b3baf3428436eb700
-  data.tar.gz: 1767c1d81f744208dc971bbdf4b37111188570bd
+  metadata.gz: 791e347a5215563bf184acb17e3665d94eb345ea
+  data.tar.gz: 58ab9254421822c6cf8d361b140061b1fc647262
 SHA512:
-  metadata.gz: 3d7f7f7bd721af4b7f67fde0732ae756ee194b0930f640093c824b7876ac8a427456ba78331274d372f1a8bc54c5e72d55695ae97b9892fe667128b49c413430
-  data.tar.gz: 93acd2a5748c2e6cfba5b68441815f430fef9f45fcc508a1fa8cef77013b84de455d9c7c76e7969768ec70fa1dbabe65cc7cf3df91d943488181962c0baee35d
+  metadata.gz: 6f3a6ae956dfd3b256b5a6a3d4a010be61093f19639b0658ea64ead3315f7f369390896918bc38c776131e992214fe223226d17ccad1d38c656153b8c24b5be2
+  data.tar.gz: 9dbea39d999cef2b1b64483bd42b518c690144b81b73b0e5f0e9f232d8a397b70577a084ee119badeee578e1c26ad5b180d1194264656dfafd50a0ba6017c92f

data/README.md

@@ -1,21 +1,52 @@
-Dingo
---
+# Dingo
 
 Dingo generates copy. Because you're a real aussie and are too lazy to write
 your own.
 
+It works by generating an infinite sequences of Australian flavoured copy.
+
+## API
+
 ```
-Dingo.words.take(4)
+dingo = Dingo.new
+
+dingo.words.take(4)
 => ["mateship", "Woolies", "marbo", "sicky"]
 
-Dingo.sentences.take(1)
+dingo.sentences.take(1)
 => ["Acca dacca wranga red hot go herald sun mullet qantas."]
 
+dingo.paragraphs.take(1)
+=> ["Underdog roy & hg sam newman slow internet sunburn 52 beers in one flight.
+    Little people riding horses richie benaud true blue battered sav doll bludger qantas.
+    Grand final the 7 30 report liking soccer when we're in the world cup shaun micaleff bruce mcavaney cobber.
+    Don burke's beard one hand one bounce woolies burke & wills reversing the ute one handed roy & hg."]
+
+dingo.people.take(4)
+=> ["eddie mcguire", "bruce mcavaney", "thorpey", "shaun micaleff", "tony"]
+
+dingo.emails.take(2)
+=> ["adam.hills@sunburn.com.au", "gough.whitlam@pavlova.com.au"]
+```
+
+all of the above can also be called as class methods.
+
+```
+Dingo.words.take(1)
+Dingo.sentences.take(1)
 Dingo.paragraphs.take(1)
-=> [
-  "Underdog roy & hg sam newman slow internet sunburn 52 beers in one flight.
-   Little people riding horses richie benaud true blue battered sav doll bludger qantas.
-   Grand final the 7 30 report liking soccer when we're in the world cup shaun micaleff bruce mcavaney cobber.
-   Don burke's beard one hand one bounce woolies burke & wills reversing the ute one handed roy & hg."
-   ]
+Dingo.people.take(1)
+Dingo.emails.take(1)
+```
+
+## Configurables
+
+```
+Dingo.new(
+  random: 12,
+  source_words: ["Bush fires", "Resenting the monarchy"],
+  source_people: ["Matey Cobber-Sheep", "Ragey McSportsdad"],
+  sentence_length: 7,
+  paragraph_length: 3
+)
 ```

data/lib/dingo.rb

@@ -1,54 +1,80 @@
 require 'enumerator'
+require 'forwardable'
 
 class Dingo
-  DEFAULT_WORD_PATH = File.expand_path("../../dingo.txt", __FILE__)
-  SENTENCE_LENGTH   = 6
+  extend SingleForwardable
 
-  class << self
-    def words(random: Random.new, source_words: aussie_copy)
-      infinite_sequence { aussie_word(source_words, random) }
-    end
+  dir = "../../word_lists/"
+  DEFAULT_WORD_PATH   = File.expand_path(dir + "dingo.txt", __FILE__)
+  DEFAULT_PEOPLE_PATH = File.expand_path(dir + "people.txt", __FILE__)
 
-    def sentences(random: Random.new, source_words: aussie_copy)
-      infinite_sequence { aussie_sentence(source_words, random) }
-    end
+  def_delegators :dingo, :words, :sentences, :paragraphs, :people, :emails
 
-    def paragraphs(random: Random.new, source_words: aussie_copy)
-      infinite_sequence { aussie_paragraph(source_words, random) }
-    end
+  def initialize(
+    random:           Random.new,
+    source_words:     read_file(DEFAULT_WORD_PATH),
+    source_people:    read_file(DEFAULT_PEOPLE_PATH),
+    sentence_length:  6,
+    paragraph_length: 4
+  )
 
-    def reset
-      @aussie_copy = nil
-      @source_words = nil
-    end
+    @random           = random
+    @source_words     = source_words.select { |w| !w.include?(" ") }
+    @source_people    = source_people
+    @all_words        = source_words + source_people
+    @sentence_length  = sentence_length
+    @paragraph_length = paragraph_length
+  end
 
-    private
+  def words;      infinite_sequence { word } end
+  def sentences;  infinite_sequence { sentence } end
+  def paragraphs; infinite_sequence { paragraph } end
+  def people;     infinite_sequence { person } end
+  def emails;     infinite_sequence { email } end
+
+  private
+
+  def read_file(file_path)
+    File.read(file_path).lines.map(&:chomp)
+  end
 
-    def infinite_sequence(&block)
-      Enumerator.new do |y|
-        loop do
-          y.yield block.call
-        end
+  def infinite_sequence(&block)
+    Enumerator.new do |y|
+      loop do
+        y.yield block.call
       end
     end
+  end
 
-    def aussie_copy
-      @aussie_copy ||= File.read(DEFAULT_WORD_PATH).lines.map(&:chomp)
-    end
+  def word
+    @source_words.sample(random: @random)
+  end
 
-    def aussie_word(source_words, random)
-      @source_words ||= source_words.select { |w| !w.include?(" ") }
-      @source_words.sample(random: random)
-    end
+  def sentence
+    sentence = @all_words.
+      sample(@sentence_length, random: @random).
+      join(" ") + "."
+    sentence.capitalize!
+    sentence
+  end
 
-    def aussie_sentence(source_words, random)
-      sentence = source_words.sample(SENTENCE_LENGTH, random: random).join(" ") + "."
-      sentence.capitalize!
-      sentence
-    end
+  def paragraph
+    sentences.take(@paragraph_length).join(" ")
+  end
+
+  def person
+    @source_people.sample(random: @random)
+  end
+
+  def email
+    people.take(1)[0].gsub(" ", ".") + "@" + words.take(1)[0] + ".com.au"
+  end
+
+  class << self
+    private
 
-    def aussie_paragraph(source_words, random)
-      sentences.take(4).join(" ")
+    def dingo(random: Random.new)
+      @@dingo ||= Dingo.new(random: random)
     end
   end
 end

data/test/dingo_test.rb

@@ -1,33 +1,67 @@
 require 'minitest/autorun'
-
 require 'dingo'
 
 class DingoTest < MiniTest::Unit::TestCase
   def test_skeleton
-    assert_equal 4, Dingo.words.take(4).length
+    assert_equal 4, dingo.words.take(4).length
   end
 
   def test_makes_a_lot_of_words
-    assert_equal 40, Dingo.words.take(40).length
-  end
-
-  def test_makes_only_words
-    assert_equal [nil], Dingo.words(source_words: ["more than one word"]).take(1)
+    assert_equal 40, dingo.words.take(40).length
   end
 
   def test_makes_sentences_with_full_stops
-    assert_equal ".", Dingo.sentences.take(1).first[-1]
+    assert_equal ".", dingo.sentences.take(1).first[-1]
   end
 
   def test_makes_sentences_with_capital_letters
-    assert_equal "A", Dingo.sentences(source_words: ["abcdef"]).take(1).first[0]
+    dingo = dingo(source_words: ["abcdef"], source_people: [])
+    assert_equal "A", dingo.sentences.take(1).first[0]
   end
 
   def test_makes_paragraphs
-    assert_equal true, !Dingo.paragraphs.take(1)[0].match(/(.*\..*){4}/)[0].empty?
+    assert_equal true, !!(dingo.paragraphs.take(1)[0].match(/(.*\..*){4}/)[0])
+  end
+
+  def test_makes_people
+    dingo = dingo(source_people: ["naul pewman"])
+    assert_equal ["naul pewman"], dingo.people.take(1)
+  end
+
+  def test_makes_email_addresses
+    assert_equal true, !!(dingo.emails.take(1)[0].match(/.*@.*/)[0])
+  end
+
+  def test_removes_spaces_from_email_addresses
+    dingo = dingo(source_words: ["domain"], source_people: ["san holo"])
+    assert_equal ["san.holo@domain.com.au"], dingo.emails.take(1)
+  end
+
+  def test_configurable_sentence_length
+    dingo = dingo(
+      sentence_length: 2,
+      source_words: ["a", "b", "c"],
+      source_people: []
+    )
+
+    # length 4 to account for a space and fullstop
+    assert_equal 4, dingo.sentences.take(1)[0].length
+  end
+
+  def test_configurable_paragraph_length
+    dingo = dingo(paragraph_length: 2)
+    assert_equal true, !!(dingo.paragraphs.take(1)[0].match(/(.*\..*){2}/)[0])
+  end
+
+  def test_class_api
+    assert Dingo.words.take(1)
+    assert Dingo.sentences.take(1)
+    assert Dingo.paragraphs.take(1)
+    assert Dingo.people.take(1)
+    assert Dingo.emails.take(1)
   end
 
-  def setup
-    Dingo.reset
+  def dingo(opts = {})
+    Dingo.new(opts)
   end
 end

data/{dingo.txt → word_lists/dingo.txt}

@@ -1,29 +1,16 @@
-daryl somers
 herald sun
 sausage roll
 footy
 speccy
-Ernie Dingo
-bruce mcavaney
-cathy freeman
 mate
 cobber
 4 and 20
 true blue
 mateship
 quintessentially australian
-julia gillard
-mad monk
-bob hawke
-warney
-gillie
-merv hughes
-richie benaud
 australian gold
 canary yellow
 green and gold
-dawn fraser
-thorpey
 vb
 xxxx
 holding the ball!
@@ -35,8 +22,6 @@ southern cross
 bondi beach
 great southern land
 land down under
-ned kelly
-paul kelly
 dog on the tucker box
 'burbs
 holden
@@ -45,19 +30,13 @@ bogan
 ACDC
 un-australian
 swing the willow at it
-lleyton hewitt
-pat rafter
 bonds
 vegemite
 sicky
-pharlap
-sam newman
-eddie mcguire
 great australian hero
 too right
 strewth!
 crikey!
-agro
 nullarbor
 uluru
 woolies
@@ -66,10 +45,6 @@ wranga
 tomato sauce
 heinz
 mullet
-kath & kim
-glen robbins
-rove
-adam hills
 harsh but fair
 yeah nah
 reversing the ute one handed
@@ -106,31 +81,20 @@ don burke's beard
 tin shed
 bundy
 taking the kids to sea world
-steve irwin
 battered sav
-nikki webster
 liking soccer when we're in the world cup
 fish and chips
-roy & hG
 little people riding horses
 having a punt
 sportsbet
 slow internet
-tony
 you're terrible muriel
 scooped it outta the punnet
 marbo
-Shaun Micaleff
 52 beers in one flight
-boonie
 smuggling budgies
 stealing land
 getting inappropriately drunk in Bali
-tony Lockett
-wayne carey
-gary ablett
-shane crawford
-burke & wills
 blue-ringed octopus
 sting ray
 grand final
@@ -144,25 +108,16 @@ scones
 v8
 cashed up bogans buying fluoro work cars
 vomitting your kebab into a taxi
-skippy
-paul hogan
-crocodile dundee
 charlie the wonder dog
 brendan fevola
+crocodile dundee
 sizzler
-harold holt
 undeserved gold at the winter olympics
-gough whitlam
 today tonight
 a current affair
 the 7 30 report
-ray martin
-humphrey b bear
 great white shark
 greg norman
-schapelle corby
-john horward
-jeff kennet
 qantas
 ansett
 royal flying doctor service
@@ -170,5 +125,4 @@ one hand one bounce
 cricket
 waltzing matilda
 advance australia fair
-jimmy barnes
 eating our national animal

data/word_lists/people.txt

@@ -0,0 +1,46 @@
+daryl somers
+ernie dingo
+bruce mcavaney
+cathy freeman
+julia gillard
+mad monk
+bob hawke
+warney
+gillie
+merv hughes
+richie benaud
+dawn fraser
+ned kelly
+paul kelly
+thorpey
+lleyton hewitt
+pat rafter
+pharlap
+sam newman
+eddie mcguire
+agro
+glen robbins
+kath and kim
+steve irwin
+nikki webster
+roy and hg
+tony
+shaun micaleff
+boonie
+tony Lockett
+burke and wills
+wayne carey
+skippy
+paul hogan
+gary ablett
+harold holt
+gough whitlam
+ray martin
+humphrey b bear
+schapelle corby
+jimmy barnes
+john horward
+jeff kennet
+shane crawford
+rove
+adam hills

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dingo
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - JaredShay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies: []
 description: Generate true blue copy
 email:
@@ -19,8 +19,9 @@ extra_rdoc_files: []
 files:
 - lib/dingo.rb
 - test/dingo_test.rb
+- word_lists/dingo.txt
+- word_lists/people.txt
 - README.md
-- dingo.txt
 homepage: https://github.com/jaredshay/dingo
 licenses: []
 metadata: {}