oulipo 0.1.1 → 0.1.2

data/README.md

@@ -8,6 +8,8 @@ It's still young, and very much liable to change.
 
 The real [Oulipo](http://en.wikipedia.org/wiki/Oulipo) is a gathering of writers and mathmeticians who seek to create works using constrained writing techniques.
 
+Install with `gem install oulipo`.
+
 ## Lipograms and Pangrams
 
 Oulipo can detect lipograms and pangrams.
@@ -16,61 +18,89 @@ A lipogram willfully shuns one or more letters of the alphabet.
 
 In the following snippet of a poem, every letter of the alphabet except 'e' is used:
 
-    stanza = <<-GYLES_BRANDRETH
-  
-      Not work of man, nor sport of child
-      Finds Nassan on this mazy wild;
-      Lax grow his joints, limbs toil in vain--
-      Poor wight! why didst thou quit that plain?
-  
-    GYLES_BRANDRETH
-  
-    Oulipo.lipogram?(stanza)      # => true
-    Oulipo.absent_letters(stanza) # => ['e']
+```ruby
+stanza = <<-GYLES_BRANDRETH
+
+  Not work of man, nor sport of child
+  Finds Nassan on this mazy wild;
+  Lax grow his joints, limbs toil in vain--
+  Poor wight! why didst thou quit that plain?
+
+GYLES_BRANDRETH
+
+Oulipo.lipogram?(stanza)      # => true
+Oulipo.absent_letters(stanza) # => ['e']
+```
 
 In contrast, a pangram uses all the letters of the alphabet (often seen jumping lazy dogs):
 
-    sentence = 'Big fjords vex quick waltz nymph.'
-  
-    Oulipo.pangram?(sentence) # => true
+```ruby
+sentence = 'Big fjords vex quick waltz nymph.'
+
+Oulipo.pangram?(sentence) # => true
+```
 
 ## Univocalims
 
 A univocalism is a poem written using only one type of vowel.
 
-    poem = <<-POEM
-      No cool monsoons blow soft on Oxford dons,
-      Orthodox, jog-trot, book-worm Solomons
-    POEM
+```ruby
+poem = <<-POEM
 
-    Oulipo.univocalism?(poem) # => true
+  No cool monsoons blow soft on Oxford dons,
+  Orthodox, jog-trot, book-worm Solomons
+  
+POEM
+
+Oulipo.univocalism?(poem) # => true
+```
 
 ## Palindromes
 
 Palindromes read the same way, backwards or forwards:
 
-    Oulipo.palindrome?('Eva, can I stab bats in a cave?') # => true
+```ruby
+Oulipo.palindrome?('Eva, can I stab bats in a cave?') # => true
+```
 
 ## Chaterisms
 
-Oulipo knows about Chaterisms.
-
 A chaterism is a poem where either each successive word in the poem grows by one letter (also known as "snowball poem") or shrinks by one letter.
 
-    Oulipo.chaterism? 'Ruby loves poetry!'      # => true
-    Oulipo.chaterism? 'Poetry loves Ruby, too.' # => true
-  
-    poem = <<-WORDS  
-    
-      One
-      poem
-      grows,
-      author
-      watches,
-      helpless --
-      syllables
-      accumulate.
-    
-    WORDS
-  
-    Oulipo.snowball? poem # => true
+```ruby
+Oulipo.chaterism? 'Ruby loves poetry!'      # => true
+Oulipo.chaterism? 'Poetry loves Ruby, too.' # => true
+
+poem = <<-WORDS  
+
+  One
+  poem
+  grows,
+  author
+  watches,
+  helpless --
+  syllables
+  accumulate.
+
+WORDS
+
+Oulipo.snowball? poem # => true
+```
+
+## Alliteration
+
+Oulipo can tell you about alliterations.
+
+```ruby
+Oulipo.alliteration? 'ravenous Ruby relishes radical raconteurs'  # => true
+```
+
+Normal alliteration's a little harsh, so you can give it a threshold, too.
+
+```ruby
+phrase = 'quick queens quibble over quails'
+
+Oulipo.allitertivity(phrase) # => 0.8 (4/5 words start with 'q')
+Oulipo.alleration?(phrase, :threshold => 0.7) # => true 
+Oulipo.alleration?(phrase, :threshold => 0.9) # => false
+```

data/lib/oulipo.rb

@@ -46,4 +46,24 @@ class Oulipo
     sequence = phrase.downcase.gsub(/[^a-z]/, '')
     sequence.reverse == sequence
   end
+  
+  def self.alliteration?(phrase, options = {})
+    threshold = options.delete(:threshold) || 1
+    self.alliterativity(phrase) >= threshold
+  end
+  
+  # Calculate an alliteration score
+  def self.alliterativity(phrase)
+    words = phrase.downcase.gsub(/[^a-z\s]/, '').split
+    leading_letters = words.map(&:chr)
+    
+    leading_letter_counts = leading_letters.inject({}) do |result, letter|
+      result[letter] ||= 0
+      result[letter] += 1
+      result
+    end
+    
+    most_used_count = leading_letter_counts.max_by { |kv| kv.last }.pop
+    most_used_count.to_f / words.length
+  end
 end

data/oulipo.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name              = "oulipo"
-  s.version           = "0.1.1"
+  s.version           = "0.1.2"
   s.date              = Time.now.strftime('%Y-%m-%d')
   s.homepage          = "http://github.com/Aupajo/oulipo"
   s.email             = "pete@metanation.com"

data/spec/alliteration_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe "alliteration" do
+  
+  let(:performer) { Oulipo }
+  
+  let(:pure_alliteration) { 'spec step succeeds speedily' }
+  let(:mostly_alliterative) { 'quick queens quibble over quails' }
+  
+  it "detects pure alliteration" do
+    performer.alliteration?(pure_alliteration).should == true
+  end
+  
+  it "tells us the alliterativity of a phrase" do
+    performer.alliterativity(pure_alliteration).should   == 1.0
+    performer.alliterativity(mostly_alliterative).should == 0.8
+  end
+  
+  it "detects alliteration with a threshold" do
+    performer.alliteration?(mostly_alliterative).should == false
+    performer.alliteration?(mostly_alliterative, :threshold => 0.7).should == true
+    performer.alliteration?(mostly_alliterative, :threshold => 0.8).should == true
+    performer.alliteration?(mostly_alliterative, :threshold => 0.9).should == false
+  end
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: oulipo
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Pete Nicholls
@@ -30,6 +30,7 @@ files:
 - Rakefile
 - lib/oulipo.rb
 - oulipo.gemspec
+- spec/alliteration_spec.rb
 - spec/chaterisms_spec.rb
 - spec/lipograms_spec.rb
 - spec/palindromes_spec.rb
@@ -64,6 +65,7 @@ signing_key:
 specification_version: 3
 summary: Constrained writing with Ruby.
 test_files: 
+- spec/alliteration_spec.rb
 - spec/chaterisms_spec.rb
 - spec/lipograms_spec.rb
 - spec/palindromes_spec.rb