rmsgen 0.0.3

data/lib/rmsgen/fs_polnote_group.rb

@@ -0,0 +1,12 @@
+module Rmsgen
+  class FsPolnoteGroup
+    def initialize(dir=nil)
+      splat_dir = "#{dir}/*"
+      @raw_notes = Dir[splat_dir].map { |f| File.read(f) }
+      @notes = @raw_notes.map { |note| Rmsgen::Polnote.new(note) }
+    end
+    def all
+      @notes
+    end
+  end
+end

data/lib/rmsgen/imap_polnote_group.rb

@@ -0,0 +1,66 @@
+module Rmsgen
+  class IMAPPolnoteGroup
+    require 'net/imap'
+
+    def initialize(imap, options={})
+      @imap = imap
+      @login  = options['imap_login']
+      @password = options['imap_password']
+    end
+
+    def fetch_notes
+      authenticate
+      follow_inbox
+      find_all_from_rms
+    end
+
+    def note_ids
+      authenticate
+      follow_inbox
+      @imap.search(["FROM", 'rms@gnu.org'])
+    end
+
+    def find(id)
+      follow_inbox
+      fetch_message_body(id)
+    end
+
+    def archive_polnote(id)
+      authenticate
+      follow_inbox
+      archived = false
+      @imap.search(["FROM", 'rms@gnu.org']).each do |note_id|
+        if note_id.to_i == id.to_i
+          @imap.copy id.to_i, 'INBOX.old-messages' 
+          @imap.store(id.to_i, "+FLAGS", [:Deleted])
+          @imap.expunge
+          archived = true
+        end
+      end
+      archived
+    end
+
+    private
+
+    def authenticate
+      @imap.authenticate 'LOGIN', @login, @password 
+    end
+
+    def follow_inbox
+      @imap.select 'INBOX' 
+    end
+
+    def find_all_from_rms
+      if note_ids && note_ids.any?
+        note_ids.map { |id| fetch_message_body(id) }
+      end
+    end
+
+    def fetch_message_body(id)
+      fetch_result = @imap.fetch id, 'BODY[TEXT]' 
+      if fetch_result && fetch_result.any?
+        fetch_result[0].attr['BODY[TEXT]']
+      end
+    end
+  end
+end

data/lib/rmsgen/inquirer.rb

@@ -0,0 +1,90 @@
+module Rmsgen
+  class Inquirer
+    PARTS = { :url => /^http/, 
+      :note =>/\[Link/,
+        :duration => /^For.*week.*$/,
+        :indendation => /^   / 
+    }
+
+    attr_reader :polnote
+
+    def initialize polnote, stdout=$stdout, answers=nil
+      @parts_seen = []
+      @polnote    = polnote
+      @parts      = @polnote.parts
+      @stdout     = stdout
+      @script     = Script.new(stdout)
+      @answers    = answers ||= []
+      run!
+    end
+
+    def body
+      @parts_seen.join PartGroup::DELIMETER 
+    end
+
+    def self.inquire_about_note(note, stdout=$stdout)
+      stdout.puts note.body
+      stdout.puts
+      note.titleize
+      note.inquire
+      stdout.puts
+      note
+    end
+
+    private
+
+    def run!
+      @parts.each do |part|
+        if part =~ PARTS[:duration]
+          inquire_about_expiration
+        elsif part =~ PARTS[:url]
+          inquire_about_link part 
+        elsif part =~ PARTS[:note]
+          inquire_about_polnote_link part  
+        elsif part =~ PARTS[:indendation]
+          append_to_previous_paragraph part 
+        else
+          @parts_seen << part
+        end
+      end
+    end
+
+    def inquire_about_link url 
+      if @answers.empty?
+        @script.announce current_part
+        text = @script.prompt_for_text
+      else
+        text = @answers.shift
+      end
+      if text && !text.empty?
+        link = Link.new text, url
+        current_part.gsub! text, link.to_s 
+      end
+    end
+
+    def inquire_about_expiration
+      @polnote.expires_on = @script.prompt_for_expiry_date
+    end
+
+    def append_to_previous_paragraph part 
+      current_part << " #{part.strip}#{PartGroup::DELIMETER}"
+    end
+
+    def current_part
+      @parts_seen.last
+    end
+
+    def inquire_about_polnote_link part 
+      if @answers.any?
+        href = @answers.shift
+        text = @answers.shift
+      else
+        href = @script.prompt_for_polnote_link part 
+        @script.announce current_part
+        text = @script.prompt_for_text
+      end
+      link = Link.new text, href 
+      current_part.gsub! text, link.to_s
+    end
+  end
+end

data/lib/rmsgen/link.rb

@@ -0,0 +1,12 @@
+module Rmsgen
+  class Link
+    def initialize(text, href)
+      @text = text
+      @href = href
+    end
+
+    def to_s
+      %{<a href='#{@href}'>#{@text}</a>}
+    end
+  end
+end

data/lib/rmsgen/part_group.rb

@@ -0,0 +1,23 @@
+class PartGroup < Array
+  attr_reader :text
+
+  DELIMETER = "\n\n"
+
+  def initialize(text)
+    @text = text
+    assign_parts!
+  end
+
+  def assign_parts!
+    if @text.match /\r\n\r\n/
+      @text.gsub!(/\r\n\r\n/, "\n\n")
+      @text.gsub!(/\r\n/, " ")
+      @text.gsub!(/\n\n\n\n/, "")
+    else
+      @text.gsub!(/\n\n/, '[newline]')
+      @text.gsub!(/\n/, ' ')
+      @text.gsub!('[newline]', "\n\n")
+    end
+    @text.split(DELIMETER).delete_if(&:empty?).each { |p| self << p }
+  end
+end

data/lib/rmsgen/polnote.rb

@@ -0,0 +1,41 @@
+module Rmsgen
+  class Polnote
+    attr_accessor :id, :title, :body, :expires_on
+
+    URGENT_SUBJECT = 'Subject: Urgent note'
+    TEMPLATE = File.join(File.dirname(__FILE__), '..', 'templates', 'polnote.erb')
+
+    def initialize(source, options={})
+      @body   = source.dup
+      @urgent = source.include? URGENT_SUBJECT
+      @id     = options[:id]
+      compress!
+    end
+
+    def urgent?
+      @urgent
+    end
+
+    def titleize
+      @title = Titleizer.new(self).body
+    end
+
+    def inquire
+      @body = Inquirer.new(self).body
+    end
+
+    def parts
+      PartGroup.new(@body)
+    end
+
+    def to_html
+      ERB.new(File.read(TEMPLATE)).result(binding)
+    end
+
+    private
+
+    def compress!
+      @body = Compresser.new(self).body
+    end
+  end
+end

data/lib/rmsgen/runtime.rb

@@ -0,0 +1,56 @@
+module Rmsgen
+  class Runtime
+    def initialize(config)
+      @config = config
+      raise "Ensure you have populated a config file" unless @config
+      @output = @config['output_file']
+      @notes = fetch_notes 
+      run!
+    end
+
+    def run!
+      if @notes
+        @notes.each do |note|
+          system('clear')
+          polnote = Rmsgen::Inquirer.inquire_about_note(note)
+          write(polnote)
+        end
+      else
+        puts 'no polnotes in queue'
+      end
+    end
+
+    private
+
+    def write(note)
+      if @output
+        File.open(@output, 'a') do |file|
+          file.puts note.to_html
+        end
+      else
+        puts note.to_html
+        puts
+      end
+    end
+
+    def fetch_notes
+      if @config['email_dir']
+        notes = Dir["#{@config['email_dir']}/*"].map { |f| File.read(f) }
+      else
+        notes = fetch_notes_from_imap
+      end
+      notes.map { |note| Rmsgen::Polnote.new(note) } if notes
+    end
+
+    def fetch_notes_from_imap
+      options = { 
+        'imap_login' => @config['imap_login'],
+        'imap_password' => @config['imap_password'] 
+      }
+
+      imap = Net::IMAP.new(@config['imap_server'])
+      Rmsgen::IMAPPolnoteGroup.new(imap, options).fetch_notes
+    end
+
+  end
+end

data/lib/rmsgen/script.rb

@@ -0,0 +1,38 @@
+module Rmsgen
+  class Script
+    def initialize(stdout=$stdout)
+      @stdout = stdout
+    end
+
+    def prompt_for_expiry_date
+      prompt "What day does it expire? ex) 08 July 2011:\n "
+    end
+
+    def prompt_for_text
+      prompt "What is the text?"
+    end
+
+    def prompt_for_polnote_link part 
+      label = part[1..-2] + "?:\n"
+      prompt("What is the #{label}")
+    end
+
+    def prompt_for_title
+      prompt "Type title:"
+    end
+
+    def announce message 
+      @stdout.puts message
+      @stdout.puts
+    end
+
+    private
+
+    def prompt(label)
+      announce label
+      input = $stdin.gets.chomp
+      @stdout.puts
+      input
+    end
+  end
+end

data/lib/rmsgen/titleizer.rb

@@ -0,0 +1,43 @@
+module Rmsgen
+  class Titleizer
+    TEMPLATE = File.join(File.dirname(__FILE__), '..', 'templates', 'title.erb')
+
+    attr_reader :title
+
+    def initialize(polnote, options={})
+      @body = polnote.body
+      @title = options[:title]
+
+      @script = Script.new($stdout)
+      run!
+    end
+
+    def body
+      ERB.new(File.read(TEMPLATE)).result(binding)
+    end
+
+    def today_format
+      Date.today.strftime('%d %B %Y')
+    end
+
+    def today_underscore
+      today_format.gsub(' ', '_')
+    end
+
+    def title_underscore
+      @title.gsub(' ', '_')
+    end
+
+    def to_html
+      body
+    end
+
+    private
+    
+    def run!
+      @title = @script.prompt_for_title unless @title
+      body
+    end
+
+  end
+end

data/lib/rmsgen/version.rb

@@ -0,0 +1,3 @@
+module Rmsgen
+  VERSION = "0.0.3"
+end

data/lib/rmsgen.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require 'erb'
+
+module Rmsgen
+  %w{ part_group
+      polnote
+      titleizer
+      compresser
+      script
+      inquirer
+      runtime
+      link
+      imap_polnote_group
+      fs_polnote_group
+  }.each do |fname|
+    require File.join(File.dirname(__FILE__), 'rmsgen', fname)
+  end
+end
+
+
+

data/lib/templates/polnote.erb

@@ -0,0 +1,2 @@
+<%= "<!-- Expires #{@expires_on} -->" if @expires_on %><%= @title %><% parts.map do |part| %><% if part =~ /<!--/ %><%= part %><% else %><p><%= part %></p><% end %>
+<% end %>

data/lib/templates/title.erb

@@ -0,0 +1 @@
+<p><li><a name='<%= today_underscore %>_(<%= title_underscore %>)' /><%= today_format %> (<a class='titlelink' href='#<%= today_underscore %>_(<%= title_underscore %>)'><%= title %></a>)</p>

data/rmsgen.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rmsgen/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rmsgen"
+  s.version     = Rmsgen::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lake Denman"]
+  s.email       = ["lake@lakedenman.com"]
+  s.homepage    = ""
+  s.summary     = %q{A library to help generate html markup from RMS emails}
+  s.description = %q{A library to help generate html markup from RMS emails}
+
+  s.rubyforge_project = "rmsgen"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/fake_gets.rb

@@ -0,0 +1,25 @@
+class FakeGet
+  def initialize(input)
+    @in = input
+  end
+  def gets
+    @in
+  end
+end
+
+class FakeGetMany 
+  attr_reader :answers
+  
+  def initialize(*answers)
+    @answers = answers
+  end
+
+  def answer
+    @answers.shift
+  end
+
+  def gets
+    answer
+  end
+end
+

data/spec/fixtures/imap_note

@@ -0,0 +1,3 @@
+hello
+
+world

data/spec/fixtures/link_to_polnote

@@ -0,0 +1,7 @@
+Somewhere over the rainbow.
+
+http://rainbow.org
+
+Skys are blue.
+
+[Link to pol note]

data/spec/fixtures/multiline_note

@@ -0,0 +1,9 @@
+
+Somewhere over the rainbow
+skies are blue
+
+http://unicorns.org
+
+Candy is sweet
+and unicorns are too
+

data/spec/fixtures/urgent_note

@@ -0,0 +1,39 @@
+Return-Path: <rms@gnu.org>
+X-Original-To: stallman-helpers@netpurgatory.com
+Delivered-To: x12197960@homiemail-mx23.g.dreamhost.com
+Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10])
+	(using TLSv1 with cipher AES256-SHA (256/256 bits))
+	(No client certificate requested)
+	by homiemail-mx23.g.dreamhost.com (Postfix) with ESMTPS id BF11A3E04EC;
+	Thu, 30 Jun 2011 17:18:49 -0700 (PDT)
+Received: from rms by fencepost.gnu.org with local (Exim 4.71)
+	(envelope-from <rms@gnu.org>)
+	id 1QcRRV-0006Q7-4B; Thu, 30 Jun 2011 20:18:45 -0400
+Date: Thu, 30 Jun 2011 20:18:45 -0400
+Message-Id: <E1QcRRV-0006Q7-4B@fencepost.gnu.org>
+Content-Type: text/plain; charset=ISO-8859-15
+From: Richard Stallman <rms@gnu.org>
+To: stallman-org@gnu.org
+Subject: Urgent note
+Reply-to: rms@gnu.org
+Content-Length: 519
+
+For one week:
+
+US citizens: tell Obama to stand firm against Republican demands
+for raising the debt ceiling.
+
+http://
+
+Once in a while, when enough people demand it, Obama does what he
+ought to do.
+
+-- 
+Dr Richard Stallman
+President, Free Software Foundation
+51 Franklin St
+Boston MA 02110
+USA
+www.fsf.org  www.gnu.org
+Skype: No way! That's nonfree (freedom-denying) software.
+  Use free telephony http://directory.fsf.org/category/tel/

data/spec/fs_polnote_group_spec.rb

@@ -0,0 +1,37 @@
+require 'rmsgen'
+
+describe Rmsgen::FsPolnoteGroup do
+  context '.all' do
+    context 'when zero polnotes are in the directory' do
+      it 'returns an empty collection' do
+        empty_dir = 'empty-dir'
+        splat_dir = "#{empty_dir}/*"
+        Dir.should_receive(:[]).with(splat_dir).and_return([])
+        group = Rmsgen::FsPolnoteGroup.new(empty_dir)
+        result = group.all
+        result.should be_empty
+      end
+    end
+
+    context 'when one polnote is in the directory' do
+      let(:dir) { '/home/foo/dir' }
+      let(:splat_dir) { "#{dir}/*" }
+      let(:notes) { ['/home/foo/dir/polnote'] }
+
+      before do
+        Dir.should_receive(:[]).with(splat_dir).and_return(notes)
+        File.should_receive(:read).with(notes.first).and_return("hello world")
+        group = Rmsgen::FsPolnoteGroup.new(dir)
+        @result = group.all
+      end
+
+      it 'returns one element' do
+        @result.size.should == 1
+      end
+
+      it 'returns a polnote element' do
+        @result.first.should be_instance_of(Rmsgen::Polnote)
+      end
+    end
+  end
+end

data/spec/imap_polnote_group_spec.rb

@@ -0,0 +1,43 @@
+require 'rmsgen'
+
+describe Rmsgen::IMAPPolnoteGroup do
+  context 'fetching notes' do
+    let(:imap) { double('imap') }
+    let(:options) do { 
+        'imap_login'  => 'login',
+        'imap_password' => 'password'} 
+    end
+
+    let(:do_fetch) do
+      imap.should_receive(:search).any_number_of_times
+      imap.should_receive(:authenticate).any_number_of_times
+      imap.should_receive(:select).any_number_of_times
+      Rmsgen::IMAPPolnoteGroup.new(imap, options).fetch_notes
+    end
+
+    it 'authenticates with imap server' do
+      imap.should_receive(:authenticate).any_number_of_times.with('LOGIN', 'login', 'password')
+      do_fetch
+    end
+
+    it 'selects the inbox folder' do
+      imap.should_receive(:select).any_number_of_times.with('INBOX')
+      do_fetch
+    end
+
+    it 'searches for messages from rms' do
+      imap.should_receive(:search).once.with(["FROM", 'rms@gnu.org'])
+      do_fetch
+    end
+
+    it 'fetches each message' do
+      message_id = double('message_id')
+      search_result = [message_id] 
+
+      imap.stub(:search) { search_result }
+
+      imap.should_receive(:fetch).with(message_id, 'BODY[TEXT]')
+      do_fetch
+    end
+  end
+end

data/spec/inqirer_spec.rb

@@ -0,0 +1,55 @@
+require 'rmsgen'
+require 'fake_gets'
+require 'rspec'
+require 'stringio'
+
+describe Rmsgen::Inquirer do
+  let(:stdout) { StringIO.new }
+
+  describe "inquires about a note which is indented" do
+    let(:note) { Rmsgen::Polnote.new("foo\n\nhttp://\n\n   bar") }
+
+    subject { Rmsgen::Inquirer.new(note, stdout) }
+
+    before do
+      $stdin = FakeGetMany.new("foo")
+    end
+
+    it "merges the url" do
+      exp = "<a href='http://'>foo</a> bar\n\n"
+      subject.body.should == exp
+    end
+  end
+
+  describe "it inquires about each link in a note" do
+    let(:note) { Rmsgen::Polnote.new("foo\n\nhttp://\n\nbar\n\nhttp://") }
+    subject { Rmsgen::Inquirer.new(note, stdout) }
+
+    before do
+      $stdin = FakeGetMany.new("foo", "bar")
+    end
+
+    it "inquires about each url" do
+      exp = "<a href='http://'>foo</a>\n\n<a href='http://'>bar</a>"
+      subject.body.should == exp 
+    end
+  end
+
+  describe "inquiring about a duration" do
+    it "asks for the end date of the duration" do
+      note = Rmsgen::Polnote.new("For one week:\n\nUrgent: blah blah blah")
+      $stdin = FakeGetMany.new("July 1")
+      Rmsgen::Inquirer.new(note, stdout)
+      note.expires_on.should be == "July 1"
+    end
+  end
+
+  describe 'when a blank answer is given' do
+    it 'returns the polnote text without links' do
+      note = Rmsgen::Polnote.new("foo bar\n\nhttp://")
+      $stdin = FakeGetMany.new("")
+      inquirer = Rmsgen::Inquirer.new(note, stdout)
+      inquirer.body.should be == "foo bar"
+    end
+  end
+end

data/spec/part_group_spec.rb

@@ -0,0 +1,21 @@
+require 'rmsgen'
+
+describe PartGroup do
+  it "accepts text as input" do
+    input = "hello\n\nworld"
+    p = PartGroup.new(input)
+    p.text.should be == input
+  end
+
+  it "output list of parts ordered by appearance" do
+    input = "\n\n\n\n1\n\n2\n\n3\n\n4"
+    p = PartGroup.new(input)
+    p.should == ['1', '2', '3', '4']
+  end
+
+  it "splits input into parts based on carriage return and newline" do
+    input = "1\r\n\r\n2\r\n\r\n3\r\n\r\n4"
+    p = PartGroup.new(input)
+    p.should == ['1', '2', '3', '4']
+  end
+end