wingtips 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd5429f39cdabf82c98b720de0920b7a6fedd089
+  data.tar.gz: b5d697a68077b2b9c887d3f516fca620ccfcdedc
+SHA512:
+  metadata.gz: de4609a436f831be9af71febdff06fc086d2cc7a901c84137e65fe787aeba00237b5021ebc81365664af3bf753da4674ec50e7d65a2f3917d210a0ded9d1e640
+  data.tar.gz: dc4b09eae42b9a318c13e79bad2358e5870071c29c98b1b5086bf88c69475a7c596dd8f38780e2fa3ab733b2e39dffdf9f82b95383109b021b1a8fde2c3e77c8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+
+Gemfile.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+wingtips

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.19

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 Tobias Pfeiffer, Jason R. Clark
+
+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,94 @@
+# Wingtips
+
+A presentation tool written in ruby - write your slides in Ruby!
+
+## Installation
+
+Ensure that [JRuby](jruby.org) is installed.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wingtips'
+```
+
+Or to grab it straight from github
+
+```ruby
+gem 'wingtips', github: 'PragTob/wingtips'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wingtips
+
+## Usage
+
+A `wingtips` presentation expects this layout:
+
+```
+presentation_folder/
+  code/*.rb
+  images/*.*
+  slides/*.rb
+  config.rb
+```
+
+And a basic slide looks like this:
+
+```ruby
+class Bullets < Wingtips::Slide
+  def content
+    headline 'Use bullet points, would you?'
+
+    bullet "It's easy isn't it?"
+    bullet 'Just keep on'
+    bullet 'with ease!'
+  end
+end
+```
+
+You can express the same slide an even more fluent DSL like this:
+
+```ruby
+slide do
+  headline 'Use bullet points, would you?'
+
+  bullet "It's easy isn't it?"
+  bullet 'Just keep on'
+  bullet 'with ease!'
+end
+```
+
+For more examples please refer to the `samples` directory!
+
+### OS X
+
+You need need a special flag to start the presentation as it is needed by the JVM. You need to add `JRUBY_OPTS=-J-XstartOnFirstThread` when trying to launch a presentation. So to launch the sample you need to type:
+
+```
+JRUBY_OPTS=-J-XstartOnFirstThread bin/wingtips samples/wingtips_introduction
+```
+
+Otherwise without the JRUBYY_OPTS, you will encounter the following error on Mac OSX:
+
+
+```bash
+Presenting 12 slides
+***WARNING: Display must be created on main thread due to Cocoa restrictions.
+LoadError: Couldn't load backend Shoes::Swt'. Error: load error: shoes/swt -- org.eclipse.swt.SWTException: Invalid thread access
+org/jruby/RubyKernel.java:1065:in `require'
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wingtips/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/wingtips

@@ -0,0 +1,24 @@
+#! /usr/bin/env jruby
+
+require 'bundler/setup'
+Bundler.require
+
+require 'wingtips/presentation'
+require 'wingtips/configuration'
+
+if ARGV.empty?
+  config_path = File.expand_path("./config.rb")
+else
+  config_path = File.expand_path(ARGV[0])
+  config_path = File.join(config_path, "config.rb") if File.directory?(config_path)
+end
+
+if File.exists?(config_path)
+  Dir.chdir(File.dirname(config_path))
+
+  config = Wingtips::Configuration.new(config_path)
+  Wingtips::Presentation.start(config)
+else
+  puts "Whoops, don't have a config file at #{config_path}"
+end
+

data/lib/wingtips.rb

@@ -0,0 +1,11 @@
+require 'shoes'
+require 'shoes/highlighter'
+
+require 'wingtips/version'
+require 'wingtips/slide'
+require 'wingtips/presentation'
+require 'wingtips/dsl'
+
+module Wingtips
+  # Your code goes here...
+end

data/lib/wingtips/configuration.rb

@@ -0,0 +1,59 @@
+module Wingtips
+  class Configuration
+    include DSL
+
+    attr_reader :slide_classes, :app_options
+
+    def initialize(path)
+      self.class.current = self
+      @app_options = {
+        title:      'Presentation',
+        fullscreen: true
+      }
+
+      full_path = File.expand_path(path)
+      load_templates full_path
+      load_named_slides full_path
+
+      # the empty slide at the start is needed as otherwise the dimensions
+      # of the first slide are most likely messed up
+      @slide_classes = [Wingtips::Slide]
+
+      self.instance_eval(File.read(full_path))
+    end
+
+    def startup_options(opts={})
+      @app_options.merge!(opts)
+    end
+
+    def slides(*slide_classes)
+      @slide_classes.concat(slide_classes)
+    end
+
+    def unnamed_slides_allowed?
+      @allow_unnamed_slides
+    end
+
+    class << self
+      attr_accessor :current
+    end
+
+    private
+    def load_templates(full_path)
+      load_in_dir(full_path, "templates/*.rb")
+    end
+
+    def load_named_slides(full_path)
+      @allow_unnamed_slides = false
+      load_in_dir(full_path, "slides/*.rb")
+      @allow_unnamed_slides = true
+    end
+
+    def load_in_dir(full_path, pattern)
+      dir = File.dirname(full_path)
+      Dir[File.join(dir, pattern)].each do |file|
+        require file unless file == full_path
+      end
+    end
+  end
+end

data/lib/wingtips/dsl.rb

@@ -0,0 +1,40 @@
+module Wingtips
+  module DSL
+    def slide(title=nil, &content)
+      clazz = create_slide_class content
+      publish_slide_class clazz, title
+    end
+    
+    private
+    def create_slide_class(content)
+      clazz = Class.new(Wingtips::Slide)
+      clazz.class_eval do
+        define_method(:content, &content)
+      end
+      clazz
+    end
+    
+    def publish_slide_class(clazz, title)
+      if unnamed_slides_allowed? && title.nil?
+        @slide_classes << clazz
+      elsif title.nil?
+        raise "Unnamed calls to `slide do` aren't allowed in the slides subdirectory.\n" \
+              "Try `slide \"MySlide\" do` so you can reference it in config."
+      else
+        Object.const_set(title, clazz)
+      end
+    end
+    
+    def configuration
+      Wingtips::Configuration.current
+    end
+    
+    def unnamed_slides_allowed?
+      configuration.unnamed_slides_allowed?    
+    end
+  end
+end
+
+
+# extending the main object (doesn't touch the Object class)
+extend Wingtips::DSL

data/lib/wingtips/presentation.rb

@@ -0,0 +1,80 @@
+module Wingtips
+  module Presentation
+    NEXT_KEYS     = [:right, :page_down, " "]
+    PREVIOUS_KEYS = [:left,  :page_up, :backspace]
+
+    def self.start(config)
+      slides = config.slide_classes
+      puts "Presenting #{slides.size} slides"
+
+      Shoes.app(config.app_options) do
+        @slides = slides
+
+        def start
+          setup_controls
+          go_to_slide(0)
+        end
+
+        def on_slide_change(&block)
+          @on_slide_change_block = block
+        end
+
+        def slide_changing
+          @on_slide_change_block.call if @on_slide_change_block
+        end
+
+        def go_to_slide(number)
+          clear
+          @current_slide.slide_changing if @current_slide
+
+          @current_slide_number = number.to_i
+          slide_class = @slides[@current_slide_number]
+          @current_slide = slide_class.new(app)
+          @current_slide.show
+        end
+
+        def next_slide
+          if @current_slide_number <= @slides.size - 2
+            go_to_slide @current_slide_number + 1
+          else
+            exit
+          end
+        end
+
+        def previous_slide
+          if @current_slide_number > 0
+            go_to_slide @current_slide_number - 1
+          end
+        end
+
+        def setup_controls
+          keypress do |key|
+            slide_controls key
+            fullscreen_controls key
+          end
+        end
+
+        def slide_controls(key)
+          if NEXT_KEYS.include? key
+            if @current_slide.effects_left?
+              @current_slide.trigger_effect
+            else
+              next_slide
+            end
+          end
+          previous_slide if PREVIOUS_KEYS.include? key
+        end
+
+        def fullscreen_controls(key)
+          toggle_fullscreen if key == :f11 || key == "f"
+        end
+
+        def toggle_fullscreen
+          self.fullscreen = !fullscreen
+        end
+
+        start
+      end
+    end
+  end
+end

data/lib/wingtips/slide.rb

@@ -0,0 +1,202 @@
+# encoding: UTF-8
+
+module Wingtips
+  PHOTO_CREDIT_SIZE = 18
+  CODE_SIZE = 30
+  BULLET_POINT_SIZE = 40
+  HEADLINE_SIZE = 65
+  VERY_BIG_SIZE = 80
+  ENORMOUS_SIZE = 140
+
+  class Slide
+    include Shoes::Highlighter::Markup
+
+    IMAGES_DIRECTORY  = 'images/'
+    CODE_DIRECTORY    = 'code/'
+
+    attr_reader :app
+
+    def initialize(app)
+      @app = app
+      @effects = []
+      after_initialize
+    end
+
+    def content
+      # implemented by subclasses
+    end
+
+    def show
+      @main_slot = stack height: app.height do
+        content
+      end
+    end
+
+    def append(&blk)
+      @main_slot.append &blk
+    end
+
+    # copied from the URL implementation... weird but I want to have
+    # classes not methods for this
+    def method_missing(method, *args, &blk)
+      if app_should_handle_method? method
+        app.send(method, *args, &blk)
+      else
+        super
+      end
+    end
+
+    def code(string, demo_as_effect = false, &block)
+      source = source_from string
+      source = source.split("\n").map{|line| '     ' + line}.join("\n")
+      highlighted_code = para *highlight(source), size: CODE_SIZE
+      add_demo_as_effect(source, &block) if demo_as_effect
+      highlighted_code
+    end
+
+    def demo(string, &block)
+      source = source_from string
+      eval source
+
+      last_app = Shoes.apps.last
+      last_app.keypress do |key|
+        last_app.quit if key == :control_w
+      end
+
+      yield last_app if block_given?
+    end
+
+    def source_from(string)
+      file_path = find_file_in(string, [CODE_DIRECTORY])
+
+      if file_path
+        File.read file_path
+      else
+        string
+      end
+    end
+
+    def add_demo_as_effect(string, &block)
+      add_effect do demo(string, &block) end
+    end
+
+    def add_effect(&effect)
+      @effects << effect
+    end
+
+    def headline(string)
+      text = title '  ' + string, size: HEADLINE_SIZE
+      empty_line
+      text
+    end
+
+    def bullet(string)
+      para '    • ' + string, size: BULLET_POINT_SIZE
+    end
+
+    def empty_line
+      para ' ', size: BULLET_POINT_SIZE
+    end
+
+    def image(path, *args)
+      app.image(image_path(path), *args)
+    end
+
+    def image_path(path)
+      path = find_file_in(path, [IMAGES_DIRECTORY])
+      File.expand_path(path)
+    end
+
+    def fullscreen_image(path)
+      img = image path
+      height_ratio = height.to_r/img.height
+      width_ratio = width.to_r/img.width
+      scale_image_by img, [width_ratio, height_ratio].max
+      img
+    end
+
+    def fully_shown_image(path, additional_height = 0)
+      img = image path
+      height_ratio = (height - additional_height).to_r/img.height
+      width_ratio = width.to_r/img.width
+      scale_image_by img, [width_ratio, height_ratio].min
+      img
+    end
+
+    def scale_image_by(img, ratio)
+      img.width = (img.width * ratio).to_i
+      img.height = (img.height * ratio).to_i
+    end
+
+    def centered_title(string, opts={})
+      para string, defaulted_options(opts,
+                                     align: 'center',
+                                     size: VERY_BIG_SIZE,
+                                     margin_top: 50)
+    end
+
+    def centered_subtitle(string, opts={})
+      para string, defaulted_options(opts,
+                                     align: 'center',
+                                     size: BULLET_POINT_SIZE,
+                                     margin_top: 50)
+    end
+
+    def centered_huge_text(string, opts={})
+      para string, defaulted_options(opts,
+                                     align: 'center',
+                                     size: VERY_BIG_SIZE,
+                                     margin_top: 50)
+    end
+
+    def centered_enormous_text(string, opts={})
+      para string, defaulted_options(opts,
+                                     align: 'center',
+                                     size: ENORMOUS_SIZE,
+                                     margin_top: 50)
+    end
+
+    def center_horizontally(element)
+      element.left = @app.width / 2 - element.width / 2
+    end
+
+    def defaulted_options(passed, defaults={})
+      results = defaults.merge(passed)
+      if results[:vertical_align] == 'center'
+        results[:margin_top] = height/2 - 100
+      end
+      results
+    end
+
+    def after_initialize
+      # subclasses if an after hook is needed
+    end
+
+    def effects_left?
+      !@effects.empty?
+    end
+
+    def trigger_effect
+      effect = @effects.shift
+      @main_slot.append &effect
+    end
+
+    private
+    def find_file_in(file_path, locations)
+      candidate_locations = locations.map {|location| location + file_path}
+      candidate_locations << file_path
+      candidate_locations.find do |candidate_path|
+        is_file_path? candidate_path
+      end
+    end
+
+    def is_file_path?(file_path)
+      File.exist? file_path
+    end
+
+    def app_should_handle_method? method_name
+      !self.respond_to?(method_name) && app.respond_to?(method_name)
+    end
+
+  end
+end

data/lib/wingtips/version.rb

@@ -0,0 +1,3 @@
+module Wingtips
+  VERSION = "0.1.0"
+end

data/samples/wingtips_introduction/code/demo_code.rb

@@ -0,0 +1,9 @@
+class MyDemoClass
+  def initialize
+    magic!
+  end
+
+  def magic!
+    # magic happens
+  end
+end

data/samples/wingtips_introduction/config.rb

@@ -0,0 +1,17 @@
+# Arrange the order of your slides here
+slides Hello, Bullets, DSLSlide, Images, FullScreenImage, FullyShownImage, Code,
+       CodeExecute, HowDoesThisWork
+       
+slide do
+  headline 'Fancy DSLs can even be unnamed'
+end
+
+code = <<-CODE
+class MyClass
+  def fancy_method
+    magic!
+  end
+end
+CODE
+
+code_slide 'Template methods', code

data/samples/wingtips_introduction/slides/how_does_this_work.rb

@@ -0,0 +1,8 @@
+class HowDoesThisWork < Wingtips::Slide
+  def content
+    headline 'How does this work?'
+    bullet 'see the code of this slide: '
+    empty_line
+    code __FILE__
+  end
+end

data/samples/wingtips_introduction/slides/my_slides.rb

@@ -0,0 +1,64 @@
+# You can write multiple files with slides or just put them all in one file
+
+class Hello < Wingtips::Slide
+  def content
+    centered_huge_text 'Welcome to Wingtips!'
+  end
+end
+
+class Bullets < Wingtips::Slide
+  def content
+    headline 'Use bullet points, would you?'
+
+    bullet "It's easy isn't it?"
+    bullet 'Just keep on'
+    bullet 'with ease!'
+  end
+end
+
+slide 'DSLSlide' do
+  headline 'Using the fancier DSL'
+end
+
+class Images < Wingtips::Slide
+  def content
+    headline 'Embed images and shoes easily!'
+
+    image 'shoes-icon.png'
+    para 'standard shoes methods like para are of course okay as well!'
+    subtitle 'Or some drawing'
+    rect 300, 400, 200, 300, fill: lime
+  end
+end
+
+class FullScreenImage < Wingtips::Slide
+  def content
+    # learning photo - Creative Commons Attribution-ShareAlike 2.0 http://www.flickr.com/photos/83633410@N07/7658165122/in/photostream/
+    fullscreen_image 'learning.jpg'
+  end
+end
+
+class FullyShownImage < Wingtips::Slide
+  def content
+    # learning photo - Creative Commons Attribution-ShareAlike 2.0 http://www.flickr.com/photos/83633410@N07/7658165122/in/photostream/
+    fully_shown_image 'learning.jpg'
+  end
+end
+
+class Code < Wingtips::Slide
+  def content
+    subtitle 'Show code from a string...'
+    code 'puts "Hello wingtips!"'
+    empty_line
+    subtitle 'Or a file'
+    code 'demo_code.rb'
+  end
+end
+
+class CodeExecute < Wingtips::Slide
+  def content
+    headline 'Code and execute'
+
+    code 'alert "Surprse!"', true
+  end
+end

data/samples/wingtips_introduction/templates/code_template.rb

@@ -0,0 +1,7 @@
+def code_slide(headline, code)
+  slide do
+    headline headline
+    empty_line
+    code code
+  end
+end

data/wingtips.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wingtips/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wingtips"
+  spec.version       = Wingtips::VERSION
+  spec.authors       = ['Tobias Pfiffer', 'Jason R. Clark']
+  spec.email         = ['pragtob@gmail.com', 'jason@jasonrclark.net']
+  spec.summary       = %q{Presentation software for Shoes}
+  spec.description   = %q{Put your best foot forward, present with Shoes!}
+  spec.homepage      = "https://github.com/PragTob/wingtips"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shoes", "~> 4.0.0.pre3"
+  spec.add_dependency "shoes-highlighter", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "pry",     "~> 0.10.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: wingtips
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Pfiffer
+- Jason R. Clark
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoes
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.pre3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.pre3
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: shoes-highlighter
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  prerelease: false
+  type: :development
+description: Put your best foot forward, present with Shoes!
+email:
+- pragtob@gmail.com
+- jason@jasonrclark.net
+executables:
+- wingtips
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/wingtips
+- lib/wingtips.rb
+- lib/wingtips/configuration.rb
+- lib/wingtips/dsl.rb
+- lib/wingtips/presentation.rb
+- lib/wingtips/slide.rb
+- lib/wingtips/version.rb
+- samples/wingtips_introduction/code/demo_code.rb
+- samples/wingtips_introduction/config.rb
+- samples/wingtips_introduction/images/learning.jpg
+- samples/wingtips_introduction/images/shoes-icon.png
+- samples/wingtips_introduction/slides/how_does_this_work.rb
+- samples/wingtips_introduction/slides/my_slides.rb
+- samples/wingtips_introduction/templates/code_template.rb
+- wingtips.gemspec
+homepage: https://github.com/PragTob/wingtips
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Presentation software for Shoes
+test_files: []