rhet-butler 0.5.0

data/lib/rhet-butler/arrangement.rb

@@ -0,0 +1,78 @@
+module RhetButler
+  class Arrangement
+    include Enumerable
+
+    def initialize(*args)
+      @slides = []
+      @slide_width = 1000
+      @slide_height = 1000
+    end
+
+    attr_accessor :slides, :slide_width, :slide_height
+
+    def previous_slide
+      @slides.last
+    end
+
+    def each
+      if block_given?
+        @slides.each{|slide| yield slide}
+      else
+        @slides.each
+      end
+    end
+
+    class << self
+      def register(name)
+        Arrangement.registry[name] = self
+      end
+
+      def registry
+        @registry ||= {}
+      end
+
+      def [](name)
+        @registry[name]
+      end
+    end
+  end
+
+  class Linear < Arrangement
+    register "linear"
+
+    def initialize(plus_x, plus_y)
+      super
+      @plus_x = plus_x
+      @plus_y = plus_y
+    end
+
+    def arrange(slideset)
+      slide = slideset.current_slide
+      slide.position.x = slideset.previous_slide.position.x + @plus_x
+      slide.position.y = slideset.previous_slide.position.y + @plus_y
+      return slide
+    end
+  end
+
+  class LinearDigression < Linear
+    register "digress-linear"
+    register "linear-digress"
+
+    def previous_slide
+      @preceeding
+    end
+
+    def arrange(slideset)
+      @preceeding ||= slideset.previous_slide
+      super
+    end
+  end
+
+  class Horizontal < Linear
+    register "horizontal"
+
+    def initialize
+      super(1000, 0)
+    end
+  end
+end

data/lib/rhet-butler/command-line.rb

@@ -0,0 +1,49 @@
+require 'thor'
+require 'valise'
+require 'rhet-butler/configuration'
+require 'rhet-butler/file-manager'
+
+module RhetButler
+  class CommandLine < ::Thor
+    def self.shared_options
+      method_option :sources, :type => :array
+      method_option :root_slide, :type => :string
+    end
+
+    desc "static", "Builds a static version of the presentation"
+    method_option :target, :type => :string
+    shared_options
+    def static
+      require 'rhet-butler/static-generator'
+
+      file_manager = FileManager.new(options)
+      generator = StaticGenerator.new(file_manager)
+
+      generator.go!
+    end
+
+    desc "check", "Load slide set to check syntax"
+    shared_options
+    def check
+      require 'rhet-butler/web/main-app'
+
+      file_manager = FileManager.new(options)
+      app = Web::MainApp.new(file_manager)
+
+      say "Slides loaded and parsed"
+      say "  #{app.viewer_app.slides.length} slides loaded"
+      say "  Serving slides and assets found in: #{app.slides}"
+    end
+
+    desc "serve", "Run the presentation server"
+    shared_options
+    def serve
+      require 'rhet-butler/web/main-app'
+
+      file_manager = FileManager.new(options)
+      app = Web::MainApp.new(file_manager)
+      app.check
+      app.start
+    end
+  end
+end

data/lib/rhet-butler/configuration.rb

@@ -0,0 +1,76 @@
+module RhetButler
+  #This class is used to manage application config throughout. Basically it
+  #wraps a hash loaded from the base fileset. Since the file search path can be
+  #configured from there, it would be overly complex to allow config.yaml files
+  #in a configured source path.
+  #
+  #Also, n.b. all access to configuration is through methods on this class, so
+  #it's easy to see what values are allowed
+  class Configuration
+    def initialize(files, overrides=nil)
+      @base_hash =
+        begin
+          files.find("config.yaml").contents rescue {}
+        rescue Object
+          {}
+        end
+      @base_hash.merge!(overrides) unless overrides.nil?
+    end
+
+    def root_slide_template
+      @base_hash['root_slide_template'] || 'presentation.html'
+    end
+
+    def username
+      @base_hash['username'] || 'judson'
+    end
+
+    def password
+      @base_hash['password'] || 'judsonr00tzme'
+    end
+
+    def author
+      @base_hash['author_name'] || "Judson Lester"
+    end
+
+    def title
+      @base_hash['presentation_title'] || 'Presentation'
+    end
+
+    def description
+      @base_hash['presentation_description'] || "A nifty presentation made with Rhet Butler"
+    end
+
+    def search_paths
+      @base_hash["sources"] || []
+    end
+
+    def static_target
+      @base_hash["static_target"] || "static"
+    end
+
+    def impress_config
+      @base_hash['impress-config'] || {}
+    end
+
+    def root_arrangement
+      @base_hash["arrangement"] || "horizontal"
+    end
+
+    def arrangement_blueprint
+      @base_hash["blueprint"] || {}
+    end
+
+    def serve_port
+      @base_hash["serve_port"] || 8081
+    end
+
+    def root_slide
+      @base_hash["root_slide"] || "slides.yaml"
+    end
+
+    def default_slide_type
+      @base_hash["default_slide_type"] || "textile"
+    end
+  end
+end

data/lib/rhet-butler/file-manager.rb

@@ -0,0 +1,126 @@
+require 'valise'
+require 'rhet-butler/configuration'
+
+module RhetButler
+  #All file handling is routed through this class.
+  #
+  #Basic configuration (including additional search paths for other configs and
+  #slides) can only come from the current directory or the "basic search path":
+  #* .rhet/
+  #* ~/.rhet/
+  #* /usr/share/rhet-butler/
+  #* /etc/rhet-butler/
+  #[the defaults provided by the gem]
+  #
+  #Other paths configured by --sources or sources: [] in base configs are added
+  #after the current directory and before that list.
+  #
+  #There are several subdirectories searched in these search paths, depending
+  #on context:
+  #
+  #* presenter/
+  #* viewer/
+  #* common/
+  #
+  #Presenter and viewer files are used for displaying the appropriate
+  #presentation, so that the presenter can have a different display (e.g. with
+  #notes and a timer) than the audience (e.g. nifty transitions etc.)
+  #
+  #Slide files are loaded without a sub-directory - they're always the same
+  #regardless of context.
+  #
+  #Presenter configs, templates, and assets are searched for in presenter, then
+  #common.
+  #
+  #Audience configs, templates and assets are searched for in viewer, then
+  #common.
+  #
+  class FileManager
+    def initialize(overrides = nil)
+      @overrides = overrides || {}
+      @cached_configs = {}
+      @cached_templates = {}
+    end
+
+    def base_config
+      @base_config ||= load_config(base_config_search_path)
+    end
+
+    def slide_files
+      all_files.sub_set("slides") + all_files
+    end
+
+    def base_assets
+      all_files.templates("assets")
+    end
+
+    def aspect_config(aspect_name)
+      @cached_configs[aspect_name] ||= load_config(aspect_search_path(aspect_name))
+    end
+
+    def aspect_templates(aspect)
+      @cached_templates[aspect] ||= aspect_search_path(aspect).templates
+    end
+
+
+    def load_config(files)
+      Configuration.new(files, @overrides)
+    end
+
+    def current_directory
+      Valise::Set.define do
+        rw "."
+        handle "config.yaml", :yaml, :hash_merge
+      end
+    end
+
+    def configured_search_path
+      base_config = self.base_config
+      Valise::Set.define do
+        base_config.search_paths.each do |path|
+          rw path
+        end
+      end
+    end
+
+    def base_config_set
+      @base_config_set ||=
+        Valise::Set.define do
+          rw [".rhet"]
+          rw ["~", ".rhet"]
+          rw ["", "usr", "share", "rhet-butler"]
+          rw ["", "etc", "rhet-butler"]
+          ro from_here(["..", "..", "..", "default-configuration"])
+
+          handle "config.yaml", :yaml, :hash_merge
+        end
+    end
+
+    def target_valise
+      @target_valise ||=
+        begin
+          target_directory = base_config.static_target
+          Valise::define do
+            rw target_directory
+          end
+        end
+    end
+
+    def all_files
+      current_directory + configured_search_path + base_config_set
+    end
+
+    def base_config_search_path
+      set = current_directory + base_config_set
+      set + set.sub_set("common")
+    end
+
+    def aspect_search_path(aspect)
+      aspect = aspect.to_s
+      set = all_files.sub_set(aspect)
+      set += all_files.sub_set("common")
+      set += all_files
+      return set
+    end
+  end
+end

data/lib/rhet-butler/html-generator.rb

@@ -0,0 +1,29 @@
+require 'tilt'
+require 'valise'
+
+module RhetButler
+  class HTMLGenerator
+    class Presentation
+      def initialize(configuration)
+        @author_name = configuration.author
+        @title = configuration.title
+        @description = configuration.description
+      end
+
+      attr_accessor :author_name, :title, :description
+    end
+
+    def initialize(configuration, templates)
+      @impress_config = configuration.impress_config
+      @templates = templates
+      @slides = []
+      @presentation = Presentation.new(configuration)
+    end
+
+    attr_accessor :slides, :presentation, :impress_config
+
+    def render(path, scope=nil, locals=nil)
+      @templates.find(path).contents.render(scope || self, locals || {})
+    end
+  end
+end

data/lib/rhet-butler/layout-rule.rb

@@ -0,0 +1,57 @@
+require 'rhet-butler/yaml-type'
+
+module RhetButler
+  class LayoutRule
+    include YamlType
+    def initialize
+      @match = {}
+      @layout_args = nil
+    end
+    attr_accessor :match, :layout_type, :layout_args
+
+    def self.optional_config
+      %w[match]
+    end
+
+    def self.required_config
+      %w[layout]
+    end
+
+    def init_with(coder)
+      @config_hash =
+        case coder.type
+        when :seq
+          { 'match' => coder.seq[0], 'layout' => coder.seq[1] }
+        when :map
+          coder.map
+        else
+          raise "Tried to configure a layout rule with non-sequence: #{coder.inspect}"
+        end
+
+      check_config_hash(@config_hash)
+
+      value_from_config("match") do |value|
+        if value == 'default'
+          @match = {}
+        else
+          @match = value
+        end
+      end
+
+      @layout_type, @layout_args = *@config_hash['layout']
+    end
+
+    def layout
+      Arrangement[@layout_type].new(*(@layout_args||[]))
+    end
+
+    def match?(group)
+      @match.all? do |key, value|
+        target = group.metadata.fetch(key)
+        value === target
+      end
+    rescue KeyError
+      false
+    end
+  end
+end

data/lib/rhet-butler/messaging.rb

@@ -0,0 +1,58 @@
+require 'thin'
+require 'rack/sockjs'
+
+module RhetButler
+  class FollowerSession < SockJS::Session
+    def initialize(connection)
+      super
+      @queue = connection.options[:queue]
+    end
+
+    def opened
+      @queue.subscribe(self)
+    end
+
+    def close(*args)
+      @queue.unsubscribe(self)
+      super
+    end
+  end
+
+  class LeaderSession < SockJS::Session
+    def initialize(connection)
+      super
+      @queue = connection.options[:queue]
+    end
+
+    def process_message(message)
+      @queue.current_slide = message
+      @queue.enqueue(message)
+    end
+  end
+
+  class SlideMessageQueue
+    attr_accessor :current_slide
+    def initialize
+      @listeners = {}
+    end
+
+    def inspect
+      "<<#{self.class.name} Listeners: #{@listeners.keys.length}>>"
+    end
+
+    def subscribe(session)
+      @listeners[session] = true
+      session.send(current_slide) unless current_slide.nil?
+    end
+
+    def unsubscribe(session)
+      @listeners.delete_key(session)
+    end
+
+    def enqueue(message)
+      @listeners.keys.each do |session|
+        session.send(message)
+      end
+    end
+  end
+end

data/lib/rhet-butler/slide-group.rb

@@ -0,0 +1,56 @@
+require 'rhet-butler/yaml-type'
+
+module RhetButler
+  class SlideGroup
+    include YamlType
+    include Enumerable
+
+    class <<self
+      def optional_config
+        %w[type slide_type]
+      end
+
+      def required_config
+        %w[slides]
+      end
+    end
+
+
+    def setup_defaults
+    end
+
+    def initialize
+      @slides = []
+      @metadata = {}
+    end
+    attr_accessor :slides
+    attr_reader :metadata
+
+    def each
+      if block_given?
+        @slides.each{|slide| yield(slide)}
+      else
+        @slides.each
+      end
+    end
+
+    def init_with(coder)
+      setup_defaults
+
+      @config_hash =
+        case coder.type
+        when :map
+          coder.map
+        when :scalar
+          raise "A slide group needs to at least be a list of slides"
+        when :seq
+          { 'slides' => coder.seq}
+        end
+
+      check_config_hash(@config_hash)
+
+      @slides = @config_hash.delete('slides')
+      @metadata = @config_hash
+    end
+  end
+end

data/lib/rhet-butler/slide-includer.rb

@@ -0,0 +1,34 @@
+module RhetButler
+  class Includer
+    include Enumerable
+
+
+    def initialize
+      @slides = []
+    end
+
+    def init_with(coder)
+      unless coder.type == :scalar
+        raise "!include with non-scalar - use a path string"
+      end
+      @path = coder.scalar
+    end
+
+    attr_accessor :path
+    attr_reader :slides
+
+    def each
+      if block_given?
+        @slides.each{|slide| yield slide}
+      else
+        @slides.each
+      end
+    end
+
+    def load(loader)
+      loader = loader.dup
+      @slides = loader.load_file(path)
+      loader
+    end
+  end
+end