oulipo 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Pete Nicholls
+
+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,76 @@
+# Oulipo
+
+_String and dance._
+
+Oulipo gives you tools to write constrained stories and poems with Ruby.
+
+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.
+
+## Lipograms and Pangrams
+
+Oulipo can detect lipograms and pangrams.
+
+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']
+
+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
+
+## 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
+
+    Oulipo.univocalism?(poem) # => true
+
+## Palindromes
+
+Palindromes read the same way, backwards or forwards:
+
+    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

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :spec
+task :test    => :spec
+
+desc "Run specs"
+task :spec do
+  exec "rspec spec"
+end

data/lib/oulipo.rb

@@ -0,0 +1,49 @@
+class Oulipo
+  ALPHABET = 'a'..'z'
+  VOWELS = %w{ a e i o u }
+  
+  def self.absent_letters(work)
+    present_letters = work.downcase.split('').uniq
+    missing_letters = ALPHABET.to_a - present_letters
+    missing_letters.empty? ? nil : missing_letters
+  end
+  
+  # A pangram uses all letters
+  def self.pangram?(work)
+    self.absent_letters(work).nil?
+  end
+  
+  # A lipogram has missing letters
+  def self.lipogram?(work)
+    !self.pangram?(work)
+  end
+  
+  # In a chaterism, each successive word is larger than the last or vice versa
+  def self.chaterism?(poem)
+    # Discard the punctuation, split into words
+    words = poem.gsub(/[^a-z\s]/i, '').split
+    
+    # Find the direction we're traveling
+    flen, llen = words.first.length, words.last.length
+    direction = flen > llen ? :downto : :upto
+    
+    # "The tree sings".map(&:length) # => [3, 4, 5] 
+    # [3, 4, 5] == 3.upto(5).to_a # => true
+    words.map(&:length) == flen.send(direction, llen).to_a
+  end
+  
+  def self.univocalism?(poem)
+    present_letters = poem.downcase.split('').uniq
+    (VOWELS - present_letters).length == 4
+  end
+  
+  def self.snowball?(poem)
+    words = poem.split
+    self.chaterism?(poem) && words.first.length < words.last.length
+  end
+  
+  def self.palindrome?(phrase)
+    sequence = phrase.downcase.gsub(/[^a-z]/, '')
+    sequence.reverse == sequence
+  end
+end

data/spec/chaterisms_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe "chaterisms" do
+  
+  # For easy switching
+  let(:performer) { Oulipo }
+  
+  let(:snowball_poem) do
+    <<-POEM
+      The
+      Dark
+      Sings
+      Softly
+    POEM
+  end
+  
+  let(:diminishing_poem) do
+    <<-POEM
+      Light's
+      Songs
+      Need
+      Not
+    POEM
+  end
+  
+  let(:regular_poem) {
+    <<-POEM
+      Yet if hope has flown away
+      In a night, or in a day,
+      In a vision, or in none,
+      Is it therefore the less gone?
+    POEM
+  }
+  
+  it "can detect both diminishing and growing chaterisms" do
+    performer.chaterism?(snowball_poem).should == true
+    performer.chaterism?(diminishing_poem).should == true
+    performer.chaterism?(regular_poem).should == false
+  end
+  
+  it "detects a snowball poem" do
+    performer.snowball?(snowball_poem).should == true
+    performer.snowball?(diminishing_poem).should == false
+    performer.snowball?(regular_poem).should == false
+  end
+  
+end

data/spec/lipograms_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "lipograms and pangrams" do
+  
+  # Easy to switch class, if refactored
+  let(:performer) { Oulipo }
+  
+  let(:pangram) { 'The quick brown fox jumps over a lazy god' }
+  let(:lipogram) { 'The quick grey fox jumps over lazy gods' }
+  
+  it "shows absent letters" do
+    performer.absent_letters(pangram).should == nil
+    performer.absent_letters(lipogram).should == %w{ b n w }
+  end
+  
+  it "can tell a pangram from a lipogram" do
+    performer.lipogram?(lipogram).should == true
+    performer.lipogram?(pangram).should == false
+    
+    performer.pangram?(pangram).should == true
+    performer.pangram?(lipogram).should == false
+  end
+  
+end

data/spec/palindromes_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "palindromes" do
+  
+  let(:performer) { Oulipo }
+  
+  it "detects palindromes" do
+    performer.palindrome?('Mr. Owl ate my metal worm').should == true
+    performer.palindrome?('Carelessness is a dish best served drunk').should == false
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'oulipo'

data/spec/univocalisms_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe "univocalisms" do
+  
+  let(:performer) { Oulipo }
+  
+  let(:univocalism) {
+    <<-POEM
+      No cool monsoons blow soft on Oxford dons,
+      Orthodox, jog-trot, book-worm Solomons
+    POEM
+  }
+  
+  let (:regular_poem) {
+    <<-POEM
+      And fortune, on his damned quarrel smiling,
+      Showed like a rebel's whore
+      But all's too weak, for brave Macbeth --
+      Well he deserves that name --
+      Disdaining fortune, with his brandished steel,
+      Which smoked with bloody execution
+    POEM
+  }
+  
+  it "detects a univocalism" do
+    performer.univocalism?(univocalism).should == true
+    performer.univocalism?(regular_poem).should == false
+  end
+  
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: oulipo
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Nicholls
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-28 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: Oulipo gives you tools to write constrained stories and poems with Ruby.
+email: pete@metanation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/oulipo.rb
+- spec/chaterisms_spec.rb
+- spec/lipograms_spec.rb
+- spec/palindromes_spec.rb
+- spec/spec_helper.rb
+- spec/univocalisms_spec.rb
+has_rdoc: true
+homepage: http://github.com/Aupajo/oulipo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Constrained writing with Ruby.
+test_files: []
+