rhet-butler 0.5.0

data/lib/rhet-butler/web/main-app.rb

@@ -0,0 +1,139 @@
+require 'rack/builder'
+require 'rack/handler'
+require 'thin'
+require 'rhet-butler/web/presentation-app'
+require 'rhet-butler/web/assets-app'
+require 'rhet-butler/web/qr-display-app'
+require 'rhet-butler/file-manager'
+require 'rhet-butler/messaging'
+
+
+module RhetButler
+  module Web
+    class SelectiveAuth < Rack::Auth::Basic
+      def call(env)
+        #XXX This is to work around a Chrome bug:
+        #https://code.google.com/p/chromium/issues/detail?id=123862 #ok
+        #When fixed upstream, this'll come out and we'll stop supporting old
+        #versions of Chrome.
+        #As is, under SSL this is kinda secure (i.e. not at all) because the
+        #WS details are secret
+        if /^http/ =~ env["rack.url_scheme"] and env["HTTP_UPGRADE"] != "websocket"
+          super
+        else
+          @app.call(env)
+        end
+      end
+    end
+
+    class MainApp
+      def initialize(file_manager)
+        @file_manager = file_manager
+      end
+
+      # Notes re filesets config and slides:
+      # All PresentationApps need the same slides but different configs
+      # (including templates, etc.)
+      #
+      # So: there need to be TWO valises:
+      #
+      # 1) The slides valise - including slidesets that might get included -
+      # this one is common between all Apps
+      #
+      # 2) The config valise - there should be a "common" base to this, and a
+      # role specific variation.  Built special, because the /viewer app should
+      # allow for config in the root of the project etc, while the /presenter
+      # version should require special config (since I'm assuming a boring
+      # presentation view)
+      #
+      def slides
+        @file_manager.slide_files
+      end
+
+      #Simply renders the bodies of the viewer and presenter apps to make sure
+      #there aren't any exceptions
+      def check
+        viewer_app = PresentationApp.new(:viewer, @file_manager)
+        presenter_app = PresentationApp.new(:presenter, @file_manager)
+        viewer_app.body
+        presenter_app.body
+        #XXX static generator "populate assets" - make sure all the assets
+        #render as well
+      end
+
+      def build_authentication_block(creds_config)
+        return (proc do |user, pass|
+          creds_config.username == user &&
+            creds_config.password == pass
+        end)
+      end
+
+      def app
+        sockjs_options = {
+          :sockjs_url => "/assets/javascript/sockjs-0.2.1.js",
+          :queue => SlideMessageQueue.new
+        }
+
+        viewer_app = PresentationApp.new(:viewer, @file_manager)
+        presenter_app = PresentationApp.new(:presenter, @file_manager)
+        assets_app = AssetsApp.new(@file_manager)
+        qr_app = QrDisplayApp.new(@file_manager, "/presenter")
+        presenter_config = presenter_app.configuration
+        auth_validation = build_authentication_block(presenter_config)
+
+        Rack::Builder.new do
+          #SockJS.debug!
+
+          map "/live/follower" do
+            run Rack::SockJS.new(FollowerSession, sockjs_options)
+          end
+
+          map "/live/leader" do
+            use SelectiveAuth, "Rhet Butler Presenter", &auth_validation
+            run Rack::SockJS.new(LeaderSession, sockjs_options)
+          end
+
+          use Rack::ShowExceptions
+
+          map "/assets" do
+            run assets_app
+          end
+
+          map "/qr" do
+            run qr_app
+          end
+
+          map "/presenter" do
+            use SelectiveAuth, "Rhet Butler Presenter", &auth_validation
+            run presenter_app
+          end
+
+          run lambda{|env|
+            if env["PATH_INFO"] == "/"
+              viewer_app.call(env)
+            else
+              assets_app.call(env)
+            end
+          }
+        end
+      end
+
+      def start
+        configuration = @file_manager.base_config
+
+        puts "Starting server. Try one of these:"
+        require 'system/getifaddrs'
+        System.get_all_ifaddrs.each do |interface|
+          puts "  http://#{interface[:inet_addr].to_s}:#{configuration.serve_port}/"
+          puts "  http://#{interface[:inet_addr].to_s}:#{configuration.serve_port}/qr"
+        end
+        EM.run do
+          thin = Rack::Handler.get("thin")
+          thin.run(app.to_app, :Host => "0.0.0.0", :Port => configuration.serve_port) do |server|
+            server.threaded = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rhet-butler/web/presentation-app.rb

@@ -0,0 +1,50 @@
+require 'rhet-butler/html-generator'
+require 'rhet-butler/slide-loader'
+
+module RhetButler
+  module Web
+    class PresentationApp
+      def initialize(aspect, file_manager)
+        @file_manager = file_manager
+        @aspect = aspect
+      end
+
+      def configuration
+        @file_manager.aspect_config(@aspect)
+      end
+
+      def template_handler
+        @file_manager.aspect_templates(@aspect)
+      end
+
+      def slides_valise
+        @file_manager.slide_files
+      end
+
+      def slides
+        @slides ||=
+          begin
+            slide_loader = SlideLoader.new(slides_valise, configuration)
+            slide_loader.load_slides
+          end
+      end
+
+      def html_generator
+        @html_generator ||=
+          begin
+            generator = HTMLGenerator.new(configuration, template_handler)
+            generator.slides = slides
+            generator
+          end
+      end
+
+      def body
+        @body ||= html_generator.render(configuration.root_slide_template)
+      end
+
+      def call(env)
+        [200, {'Content-Type' => "text/html"}, [body]]
+      end
+    end
+  end
+end

data/lib/rhet-butler/web/qr-display-app.rb

@@ -0,0 +1,37 @@
+require 'rqrcode'
+
+module RhetButler
+  module Web
+    class QrDisplayApp
+      def initialize(files, path)
+        @config = files.aspect_config(:presenter)
+        @templates = files.aspect_templates(:presenter)
+        @path = path
+      end
+
+      attr_reader :template_handler
+
+      def call(env)
+        url = [env["rack.url_scheme"], "://"]
+        if env["HTTP_HOST"].nil? or env["HTTP_HOST"].empty?
+          url << env["SERVER_NAME"]
+          url << ":"
+          url << env["SERVER_PORT"]
+        else
+          url << env["HTTP_HOST"]
+        end
+        view_url = url.join("") + "/"
+
+        url << @path
+        url = url.join("")
+        qr = RQRCode::QRCode.new(url, :size => 5)
+
+        mime_type = "text/html"
+        generator = HTMLGenerator.new(@config, @templates)
+        [200, {'Content-Type' => mime_type}, [
+          generator.render("presenter-qr.html", qr, :view_url => view_url, :presenter_url => url)
+        ]]
+      end
+    end
+  end
+end

data/lib/rhet-butler/yaml-schema.rb

@@ -0,0 +1,9 @@
+require 'rhet-butler/slide'
+require 'rhet-butler/slide-group'
+require 'rhet-butler/slide-includer'
+require 'rhet-butler/layout-rule'
+
+YAML.add_tag('!slide', RhetButler::Slide)
+YAML.add_tag('!group', RhetButler::SlideGroup)
+YAML.add_tag('!include', RhetButler::Includer)
+YAML.add_tag('!layout-rule', RhetButler::LayoutRule)

data/lib/rhet-butler/yaml-type.rb

@@ -0,0 +1,23 @@
+module RhetButler
+  module YamlType
+    def check_config_hash(config_hash)
+      expected_keys = self.class.required_config + self.class.optional_config
+      weird_keys = config_hash.keys.find_all{|key| !expected_keys.include?(key)}
+      missing_keys = self.class.required_config.find_all{|key|
+        !config_hash.has_key?(key)
+      }
+      unless weird_keys.empty?
+        warn "Found weird keys: #{weird_keys.inspect} in #{config_hash.inspect}"
+      end
+      unless missing_keys.empty?
+        raise "Missing required keys: #{missing_keys.inspect} in #{config_hash.inspect}"
+      end
+    end
+
+    def value_from_config(name)
+      if @config_hash.has_key?(name)
+        yield(@config_hash[name])
+      end
+    end
+  end
+end

data/lib/rhet-butler.rb

@@ -0,0 +1,2 @@
+module RhetButler
+end

data/spec/arrangements.rb

@@ -0,0 +1,76 @@
+require 'rhet-butler/arrangement'
+require 'rhet-butler/slide'
+require 'rhet-butler/slide-loader'
+
+describe RhetButler::Arrangement do
+  let :slides do
+    (1..5).map do |num|
+      RhetButler::Slide.new.tap do |slide|
+        slide.content = "Slide ##{num}"
+      end
+    end
+  end
+
+  let :arranger do
+    arranger = RhetButler::SlideArranger.new
+    arranger.root_arrangement = arrangement
+    arranger
+  end
+
+  let :arranged do
+    arranger.traverse
+    arranger.slides
+  end
+
+  describe "digression" do
+    let :arrangement do
+      arrangement = RhetButler::Arrangement["linear"].new(1000, 0)
+      digression = RhetButler::Arrangement["linear-digress"].new(0, 1000)
+      digression.slides = (1..3).map do |num|
+        RhetButler::Slide.new.tap do |slide|
+          slide.content = "Aside ##{num}"
+        end
+      end
+      arrangement.slides = slides
+      arrangement.slides.insert(4, digression)
+      arrangement
+    end
+
+    it "should still last slide a 5000,0" do
+      arranged.last.position.x.should == 5000
+      arranged.last.position.y.should == 0
+    end
+
+    it "should have 8 slides" do
+      arranged.should have(8).slides
+    end
+
+    it "should put the last digression slide at 4000,3000" do
+      arranged[6].position.x.should == 4000
+      arranged[6].position.y.should == 3000
+    end
+  end
+
+  describe "horizontal" do
+    let :arrangement do
+      arrangement = RhetButler::Arrangement["horizontal"].new
+      arrangement.slides = slides
+      arrangement
+    end
+
+    it "should all at the same y position" do
+      arranged.map do |slide|
+        slide.position.y
+      end.uniq.should have(1).value
+    end
+
+    it "should monotonically increase x position" do
+      arranged.each_cons(2).map do |left, right|
+        right.position.x - left.position.x
+      end.each do |difference|
+        difference.should > 0
+      end
+    end
+
+  end
+end

data/spec/html-generation.rb

@@ -0,0 +1,48 @@
+require 'rhet-butler/html-generator'
+require 'rhet-butler/file-manager'
+require 'rhet-butler/slide'
+require 'rhet-butler/configuration'
+
+describe RhetButler::HTMLGenerator do
+  let :slides do
+    one = RhetButler::Slide.new
+    one.content = "A test slide"
+    [ one ]
+  end
+
+  let :files do
+    manager = RhetButler::FileManager.new
+  end
+
+  let :template_handler do
+    files.aspect_templates(:viewer)
+  end
+
+  let :configuration do
+    files.aspect_config(:viewer)
+  end
+
+  let :generator do
+    described_class.new(configuration, template_handler).tap do |gen|
+      gen.slides = slides
+    end
+  end
+
+  let :root_template do
+    "presentation.html"
+  end
+
+  let :html do
+    generator.render(root_template)
+  end
+
+  it "should produce text from slides" do
+    html.should be_a(String)
+  end
+
+  it "should produce good HTML" do
+    expect do
+      Nokogiri::HTML::Document.parse(html, nil, nil, Nokogiri::XML::ParseOptions::DEFAULT_XML)
+    end.to_not raise_error
+  end
+end

data/spec/presentation-view.rb

@@ -0,0 +1,72 @@
+require 'rhet-butler/web/main-app'
+require 'rhet-butler/file-manager'
+require 'rhet-butler/configuration'
+require 'rack/test'
+
+describe RhetButler::Web::MainApp do
+  describe "presentation view" do
+    include Rack::Test::Methods
+
+    let :files do
+      RhetButler::FileManager.new
+    end
+
+    let :app do
+      described_class.new(files).app
+    end
+
+    describe "/" do
+      before :each do
+        get "/"
+      end
+
+      it "should serve a presentation" do
+        last_response.should be_ok
+      end
+
+      it "should have a script tag for impress.js" do
+        doc = Nokogiri::HTML(last_response.body)
+        doc.xpath("//script[contains(@src, 'impress.js')]").should_not be_empty
+      end
+    end
+
+    describe "/javascript/impress.js" do
+      before :each do
+        get "/javascript/impress.js"
+      end
+
+      it "should serve the javascript" do
+        last_response.should be_ok
+      end
+
+      it "should serve as application/javascript" do
+        last_response.headers["Content-Type"].should == "application/javascript"
+      end
+
+    end
+
+    describe "/assets/javascript/impress.js" do
+      before :each do
+        get "/assets/javascript/impress.js"
+      end
+
+      it "should serve the javascript" do
+        last_response.should be_ok
+      end
+
+      it "should serve as application/javascript" do
+        last_response.headers["Content-Type"].should == "application/javascript"
+      end
+
+    end
+
+
+    it "should have get WebSocket commands to sync with presenter"
+
+    it "should be able to split from presenter"
+
+    it "should be able to resync with presenter"
+
+    it "should have a resource for the current presenter's slide"
+  end
+end

data/spec/rhet-butler.rb

@@ -0,0 +1,59 @@
+require 'rhet-butler'
+
+describe RhetButler do
+  describe "web server" do
+    describe "presentation view" do
+      it "should serve a presentation"
+
+      it "should include impress.js"
+
+      it "should have get WebSocket commands to sync with presenter"
+
+      it "should be able to split from presenter"
+
+      it "should be able to resync with presenter"
+
+      it "should have a resource for the current presenter's slide"
+    end
+
+    describe "passive view" do
+      it "should serve the presentation"
+
+      it "should not respond to key press events"
+    end
+
+    describe "presenter's view" do
+      it "should serve a presenter's view"
+
+      it "should include a link to the presentation"
+
+      it "should include the live presentation in an iframe"
+
+      it "should use a different arrangement for the presentation"
+    end
+
+    describe "review view" do
+      it "should update the slides automatically when the files change"
+
+      it "should update processed assets automatically"
+    end
+  end
+
+  describe "slide processing" do
+    describe "text processing" do
+      it "should process slide text as directed"
+
+      it "should transform Markdown to HTML"
+
+      it "should transform asset macros"
+
+      it "should insert slides from set references"
+
+      it "should nest slides from set references"
+    end
+
+    describe "asset handling" do
+      it "should process SASS files and provide CSS links"
+    end
+  end
+end

data/spec/slide-loader.rb

@@ -0,0 +1,51 @@
+require 'valise'
+require 'rhet-butler/configuration'
+require 'rhet-butler/slide-loader'
+
+describe RhetButler::SlideLoader do
+  let :files do
+    Valise::Set.define do
+      stemmed("slides") do
+        rw 'spec_support/fixtures/project'
+      end
+      rw 'spec_support/fixtures/project'
+
+      handle "config.yaml", :yaml, :hash_merge
+    end
+  end
+
+  let :configuration do
+    RhetButler::Configuration.new(files)
+  end
+
+  let :loader do
+    described_class.new(files, configuration)
+  end
+
+  let :slides do
+    loader.load_slides
+  end
+
+  it "should parse YAML for the configs" do
+    slides.should have_at_least(1).slides
+    slides.should be_all{|slide| RhetButler::Slide === slide}
+  end
+
+  it "should have the included slide" do
+    slides.find do |slide|
+      slide.content =~ /included/
+    end.should_not be_nil
+  end
+
+  it "should have the slide group" do
+    slides.find do |slide|
+      slide.content =~ /grouped/
+    end.should_not be_nil
+  end
+
+  it "should allow sibling inclusions" do
+    expect do
+      slides
+    end.not_to raise_error
+  end
+end

data/spec/slide-processing.rb

@@ -0,0 +1,73 @@
+require 'rhet-butler/slide-loader'
+
+describe RhetButler::SlideProcessor do
+  def slide(content)
+    slide = RhetButler::Slide.new
+    slide.content = content
+    slide
+  end
+
+  def group(*slides)
+    group = RhetButler::SlideGroup.new
+    group.slides = slides
+    group
+  end
+
+  let :slides do
+    [
+      slide("A"),
+      slide("B"),
+      group(slide("C"), slide("D"), slide("E"))
+    ]
+  end
+
+  let :root_group do
+    group(*slides)
+  end
+
+  let :root_arrangement do
+    RhetButler::Arrangement['horizontal'].new
+  end
+
+  let :blueprint do
+    [
+      RhetButler::LayoutRule.new.tap do |rule|
+        rule.layout_type = 'horizontal'
+      end
+    ]
+  end
+
+  let :default_slide_type do
+    "textile"
+  end
+
+  let :processor do
+    processor = RhetButler::SlideProcessor.new
+    processor.root_group = root_group
+    processor.blueprint = blueprint
+    processor.default_slide_type = default_slide_type
+    processor
+  end
+
+  let :result do
+    processor.process
+    processor.slides
+  end
+
+  it "should produce slides" do
+    result.each do |slide|
+      slide.should be_a_kind_of(RhetButler::Slide)
+    end
+  end
+
+  it "should have five slides" do
+    result.should have(5).slides
+
+  end
+
+  it "should put all the slides in order" do
+    result.map do |slide|
+      slide.content
+    end.should == %w{A B C D E}.map{|str| "<p>#{str}</p>"}
+  end
+end

data/spec_support/gem_test_suite.rb

@@ -0,0 +1,17 @@
+puts Dir::pwd
+require 'test/unit'
+begin
+  require 'spec'
+rescue LoadError
+  false
+end
+
+class RSpecTest < Test::Unit::TestCase
+  def test_that_rspec_is_available
+    assert_nothing_raised("\n\n *  RSpec isn't available - please run: gem install rspec  *\n\n"){ ::Spec }
+  end
+
+  def test_that_specs_pass
+    assert(system(*%w{spec -f e -p **/*.rb spec}),"\n\n *  Specs failed  *\n\n")
+  end
+end