eleanor 1.0.0

data/Rakefile

@@ -0,0 +1,88 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+NAME      = 'Eleanor'
+UNIX_NAME = NAME.downcase
+VER       = '1.0.0'
+
+NONLIB_RDOC_FILES = %w[CHANGELOG INSTALL LICENSE README src/ragel/parser.rl]
+
+RDOC_FILES        = NONLIB_RDOC_FILES +
+                    %w[lib/eleanor.rb
+                       lib/eleanor/hpdfpaper.rb
+                       lib/eleanor/length.rb]
+
+RDOC_OPTS         = ['--inline-source',
+                     '--extension', 'rl=rb',
+                     '--exclude', 'lib/eleanor/parser.rb',
+                     '--title', "#{NAME} #{VER} Reference",
+                     '--main', 'README']
+
+
+PKG_FILES = FileList['CHANGELOG', 'INSTALL', 'LICENSE', 'README',
+                     'Rakefile', 'setup.rb',
+                     'bin/*', 'data/**/*', 'examples/*.txt',
+                     'lib/*', 'lib/**/*', 'src/**/*']
+
+CLEAN.include %w[.config InstalledFiles doc examples/*.pdf pkg]
+
+GEMSPEC=
+  Gem::Specification.new do |s|
+    s.name= UNIX_NAME
+    s.version= VER
+    s.has_rdoc= true
+    s.rdoc_options += RDOC_OPTS
+    s.extra_rdoc_files= NONLIB_RDOC_FILES
+    s.summary= 'Formats speculative screenplays'
+    s.description= <<-EOF
+      Eleanor is a Ruby script and accompanying library for formatting
+      speculative screenplays.  It parses plain text written in a simple format
+      and outputs pretty PDF that conforms to standard rules of screenplay
+      layout.  Eleanor's primary goal is to create PDF that is indistinguishable
+      from PDF produced by professional screenwriting software such as Final
+      Draft.
+    EOF
+    s.author= 'chiisaitsu'
+    s.email= 'chiisaitsu@gmail.com'
+    s.homepage= 'http://rubyforge.org/projects/eleanor'
+    s.files= PKG_FILES
+    s.executables= ['eleanor']
+    s.requirements << 'libHaru Free PDF Library: http://libharu.org'    
+    s.rubyforge_project= 'eleanor'
+  end
+
+desc 'rake build'
+task :default => [:build]
+
+desc 'Build the parser with Ragel'
+task :build do
+  sh "ragel -R -o lib/eleanor/parser.rb src/ragel/parser.rl"
+end
+
+desc 'Build the examples'
+task :examples do
+  Dir.glob('examples/*.txt') do |fname|
+    sh "ruby -I./lib bin/eleanor -c data/eleanor/eleanor.yaml #{fname}"
+  end
+end
+
+desc 'Install to site_ruby'
+task :install do
+  sh "ruby setup.rb"
+end
+
+task :package => [:clean]
+
+Rake::GemPackageTask.new(GEMSPEC) do |t|
+  t.need_tar_gz= true
+  t.need_zip= true
+  t.gem_spec= GEMSPEC
+end
+
+Rake::RDocTask.new do |t|
+  t.options= RDOC_OPTS
+  t.rdoc_dir= 'doc/rdoc'
+  t.rdoc_files= RDOC_FILES
+end

data/bin/eleanor

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2008 chiisaitsu <chiisaitsu@gmail.com>
+#
+# 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.
+
+begin
+  require 'eleanor'
+rescue LoadError
+  $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'eleanor'
+end
+
+require 'optparse'
+
+usr_config_fn= File.join(ENV['HOME'] || '', '.eleanorrc')
+sys_config_fn= File.join(Config::CONFIG['datadir'], 'eleanor', 'eleanor.yaml')
+rel_config_fn= File.expand_path(File.join(File.dirname(__FILE__), '..',
+                                          'data', 'eleanor', 'eleanor.yaml'))
+
+conf= {
+  :paper  => 'eleanor/hpdfpaper',
+  :config => if File.exist? usr_config_fn
+               usr_config_fn
+             elsif File.exist? sys_config_fn
+               sys_config_fn
+             elsif File.exist? rel_config_fn
+               rel_config_fn
+             else
+               nil
+             end
+}
+
+options= OptionParser.new do |opts|
+  opts.banner= "usage: #{File.basename($0)} [options] screenplay.txt"
+  opts.separator('')
+  opts.separator('  Options:')
+  opts.on('-c', '--config FILE',
+          'Load configuration from FILE',
+          "(default: #{conf[:config] || 'none'})") do |val|
+    conf[:config]= val
+  end
+  opts.on('-d', '--dump-pages', 'Print paginated screenplay to stdout') do |val|
+    conf[:dump_pages]= val
+  end
+  opts.on('--dump-paras', 'Print non-paginated paragraphs to stdout') do |val|
+    conf[:dump_paras]= val
+  end
+  opts.on('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+  opts.on('-o', '--output FILE',
+          'Set output FILE (default: screenplay.pdf)') do |val|
+    conf[:outfile]= val
+  end
+  opts.on('--paginate', 'Stop after pagination') do |val|
+    conf[:paginate]= val
+  end
+  opts.on('--paper  FILE',
+          'Set backend to FILE', "(default: #{conf[:paper]})") do |val|
+    conf[:paper]= val
+  end
+  opts.on('--parse', 'Stop after parsing') do |val|
+    conf[:parse]= val
+  end
+  opts.on('-v', '--verbose', 'Print working info to stderr') do |val|
+    conf[:verbose]= val
+  end
+  opts.on_tail('')
+  opts.on_tail('  Examples:',
+               "    #{File.basename($0)} screenplay.txt",
+               "    #{File.basename($0)} -o finaldraft.pdf screenplay.txt")
+end
+
+begin
+  options.parse!
+  raise OptionParser::ParseError unless ARGV.size == 1
+rescue OptionParser::ParseError
+  puts options
+  exit
+end
+
+if conf[:config].nil?
+  abort "error: No configuration file found.  Reinstall #{Eleanor::NAME} " \
+        "or load a configuration file with --config."
+end
+
+begin
+  require conf[:paper]
+rescue LoadError
+  abort "error: Could not load backend.  The string you specify will be " \
+        "passed to 'require'."
+end
+Eleanor.load_config(conf[:config])
+infile= ARGV.shift
+screenplay= Eleanor.parse(infile)
+
+if screenplay
+  $stderr.puts "parsing complete" if conf[:verbose]
+  puts screenplay.to_s(false) if conf[:dump_paras]
+  exit if conf[:parse]
+  screenplay.paginate!
+  $stderr.puts "pagination complete" if conf[:verbose]
+  puts screenplay if conf[:dump_pages]
+  exit if conf[:paginate]
+  screenplay.write_to_paper!
+  screenplay.save_paper(conf[:outfile], infile)
+else
+  abort 'error: parsing failed'
+end

data/data/eleanor/eleanor.yaml

@@ -0,0 +1,165 @@
+# This is Eleanor's default configuration file.  It's written in YAML.
+# You shouldn't modify it.  Instead, pass your own to Eleanor's command line
+# with the --config option.  Or, for a more permanent solution, create your own
+# file $HOME/.eleanorrc, where $HOME is the output of
+#
+#   ruby -e "p ENV['HOME']"
+#
+# Eleanor will use that file instead.
+
+---
+Screenplay:
+  char_spacing:                 -0.195.points
+  font:                         Courier
+  font_size:                    12.points
+  line_height_points:           12
+
+Page:
+  header:                       |
+    @page_no == 1 ? @screenplay.title : nil
+  header_margin_top:            0.5.inches
+  height:                       11.inches
+  margin_bottom:                1.inches
+  margin_top:                   1.inches
+  page_number_display:          |
+    @page_no > 1 ? "#@page_no." : nil
+  page_number_margin_right:     1.25.inches
+  page_number_margin_top:       0.5.inches
+  width:                        8.5.inches
+
+TitlePage:
+  margin_bottom:                1.5.inches
+  margin_left:                  1.inches
+  margin_top:                   2.5.inches
+
+Paragraph:
+  can_break_across_pages:       false
+  align:                        left
+  keep_with_nexts:              []
+  min_orphan_lines_allowed:     2
+  min_orphan_sentences_allowed: 2
+  min_widow_lines_allowed:      2
+  min_widow_sentences_allowed:  2
+
+Action:
+  can_break_across_pages:       true
+  keep_with_nexts:              [Insert]
+  limit_to_one_line:            false
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_top:                   |
+    if @is_first_on_page
+      (@split_state == :widow ? -1 : 0).lines
+    else
+      1.lines
+    end
+  width:                        6.inches
+
+CharacterCue:
+  continuation_modifier:        CONT'D
+  keep_with_nexts:              [Dialog, Parenthetical]
+  limit_to_one_line:            true
+  margin_bottom:                0.lines
+  margin_left:                  3.5.inches
+  margin_top:                   |
+    if @is_first_on_page
+      (@split_state == :widow ? -1 : 0).lines
+    else
+      1.lines
+    end
+  widow_modifier:               CONT'D
+  width:                        3.75.inches
+
+Dialog:
+  can_break_across_pages:       true
+  keep_with_nexts:              |
+    next_para.is_a?(Parenthetical) && @sentences.size == 1
+  limit_to_one_line:            false
+  margin_bottom:                0.lines
+  margin_left:                  2.5.inches
+  margin_top:                   0.lines
+  width:                        3.5.inches
+
+Insert:
+  limit_to_one_line:            false
+  margin_bottom:                1.lines
+  margin_left:                  2.5.inches
+  margin_top:                   1.lines
+  width:                        3.5.inches
+
+MontageHeading:
+  keep_with_nexts:              [MontageItem]
+  limit_to_one_line:            true
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_top:                   |
+    (@is_first_on_page ? 0 : 2).lines
+  width:                        6.inches
+
+MontageItem:
+  limit_to_one_line:            false
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_top:                   |
+    (@is_first_on_page ? 0 : 1).lines
+  width:                        6.inches
+
+More:
+  limit_to_one_line:            true
+  margin_bottom:                0.lines
+  margin_left:                  3.5.inches
+  margin_top:                   0.lines
+  text:                         (MORE)
+  width:                        2.5.inches
+
+Parenthetical:
+  keep_with_nexts:              [Dialog]
+  limit_to_one_line:            false
+  margin_bottom:                0.lines
+  margin_left:                  2.9.inches
+  margin_top:                   0.lines
+  width:                        2.5.inches
+
+SceneHeading:
+  keep_with_nexts:              [Action, CharacterCue]
+  limit_to_one_line:            true
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_top:                   |
+    if defined?(prev_para) &&
+       (prev_para.is_a?(Transition) ||
+        (prev_para.is_a?(SlugLine) &&
+         /BEGIN FLASHBACK/i =~ prev_para.input_line))
+      1.lines
+    else
+      (@is_first_on_page ? 0 : 2).lines
+    end
+  width:                        6.inches
+
+SlugLine:
+  keep_with_nexts:              |
+    case next_para
+    when Action, Insert
+      true
+    when SceneHeading
+      /BEGIN FLASHBACK/i =~ @input_line ? true : false
+    else
+      false
+    end
+  limit_to_one_line:            true
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_top:                   |
+    (@is_first_on_page ? 0 : 1).lines
+  width:                        6.inches
+
+Transition:
+  align:                        |
+    /FADE IN/i =~ @input_line ? 'left' : 'right'
+  limit_to_one_line:            true
+  margin_bottom:                1.lines
+  margin_left:                  1.5.inches
+  margin_right:                 1.25.inches
+  margin_top:                   |
+    (@is_first_on_page ? 0 : 1).lines
+  width:                        1.63.inches

data/examples/example.txt

@@ -0,0 +1,167 @@
+
+                             _A TALE OF NON SEQUITURS_
+                             Fenwick Stufflebeam
+                             123 Millicent Kenton Lane
+                             Hollywood, CA  90210
+                             (555) 555-1337
+                             fstufflebeam@hmail.com
+
+    FADE IN:
+
+EXT. FOREST CLEARING - NIGHT
+
+A clear, starry night.  A milky full moon hangs high in the sky.  Somewhere an owl hoots.
+
+The bushes rustle.  A dirtied girl pushes her way through the greenery, leaves and twigs slapping her face.  Her name is ELEANOR.  She carries a laptop computer under her arm.
+
+                               ELEANOR
+                          (calling)
+                      Why!  _Oh, why_!
+
+Crickets.  Eleanor sits on a nearby tree stump, head on hands.
+
+Suddenly a tiny little man with shoulder-length brown hair scampers out of the trees.  He is WHY THE LUCKY STIFF.  He has a high-pitched voice, as if he has been inhaling helium.
+
+                               WHY THE LUCKY STIFF
+                      Here I am!
+
+                               ELEANOR
+                      Oh, thank God.
+
+Why the Lucky Stiff jumps up on Eleanor's knee and produces a tiny flute.  He plays a tune as he dances a little jig.
+
+                               WHY THE LUCKY STIFF
+                      Reese's Pieces and Old Navy fleeces!  Norway has rakfisk but Finland has cheeses!
+
+                               ELEANOR
+                      Uh, OK.
+                          (opening her laptop)
+                      Listen, could you tell me how to use this thing?
+
+                               WHY THE LUCKY STIFF
+                      Ding dong!
+
+He scurries to a tree and beckons Eleanor to follow.
+
+                                WHY THE LUCKY STIFF
+                          (pointing at tree)
+                      _Rules_ here there be!
+
+                               ELEANOR
+                      Are you going to keep talking like that?
+
+    WHY THE LUCKY STIFF
+    Creamy ground beef!
+
+With his little hand he pulls back a bough to reveal a carving on the trunk that reads:
+
+    "Two blank lines before scene headings and montages.  One blank line before all else except dialogs and parentheticals.  Spaces before character cues, dialog, parentheticals, transitions, inserts.  No newlines in paragraphs.  Two spaces between sentences."
+
+    ELEANOR
+    I don't understand.
+
+    WHY THE LUCKY STIFF
+    Plain text!  Whoozits.
+
+    ELEANOR
+    What?
+
+    WHY THE LUCKY STIFF
+    You type, you type.  The words flow like a sinking sun in a bathtub full of green jell-o.
+
+He hops onto Eleanor's computer and by dancing on its keys types all that has transpired before this moment, in the format prescribed by the tree.  Then he runs the command:
+
+    "ruby eleanor example.txt"
+
+A beautiful PDF appears on Eleanor's computer.
+
+    ELEANOR
+    Oh!
+
+SUDDENLY, WHY THE LUCKY STIFF
+
+turns on his heels and sprints into the trees.
+
+ELEANOR
+
+drops her laptop in the commotion but picks it up and follows in hot pursuit deep into the woods.
+
+ELEANOR'S P.O.V. - TREE BRANCHES
+
+slap her in the face.
+
+    ELEANOR
+    (calling)
+    I'm not writing an action movie!  This is supposed to be a quirky independent!
+
+
+SERIES OF SHOTS - ELEANOR CHASES WHY THE LUCKY STIFF
+
+A) Dodging branches and roots in the forest.
+
+B) Trudging through a thick swamp.
+
+C) Jumping across rooftops in a large city as cars sit stuck in traffic below.
+
+D) Back into the dark forest.
+
+    DISSOLVE TO:
+
+
+INT. HOLLOW TREE - NIGHT
+
+A storybook gnomish home.  Eleanor stumbles in, out of breath.  Why the Lucky Stiff sits in a tiny rocking chair next to the fireplace, smoking a long pipe.
+
+    ELEANOR
+    (wheezing)
+    Jesus.
+    (pausing to look around)
+    So this is where you live.
+
+    WHY THE LUCKY STIFF
+    Here I be.  Tinkle tops and lemon drops.
+
+    ELEANOR
+    Look, I have more questions.
+
+    WHY THE LUCKY STIFF
+    Let me tell you a story.
+
+BEGIN FLASHBACK:
+
+
+INT. PIGGLY WIGGLY - DAY
+
+Why the Lucky Stiff pushes a diminutive shopping cart.
+
+    WHY THE LUCKY STIFF
+    (to himself)
+    Crackers.  Soy beans.  Hamburger patties.  Sunshine rainbows and kitty cat kisses.  Red-letter bibles and hose for the missus.  Hey ho, yeah?  What's all this, now?  Bean sprouts from China and milk from a cow.
+
+END FLASHBACK.
+
+
+INT. HOLLOW TREE - NIGHT
+
+Eleanor is exasperated.
+
+    ELEANOR
+    You're a nice guy, and you sure do know a lot, but I can't understand anything you say.
+
+    WHY THE LUCKY STIFF
+    Hey, but look!  My dialog was split in twain!
+
+    ELEANOR
+    No, it wasn't.
+
+    WHY THE LUCKY STIFF
+    No, no, no, not in the plain text.  In the PDF, yo!
+
+    ELEANOR
+    But I haven't written anything.
+
+Why the Lucky Stiff pads over to Eleanor, who places her computer on the ground.  He types in everything that has transpired so far except for what he had typed previously.
+
+INSERT - ELEANOR'S COMPUTER SCREEN, A BEAUTIFUL PDF
+
+    FADE OUT.