slide_hero 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ba41a9d72122a93c31a9aacb8b410f940ee8455
+  data.tar.gz: c878af46810347583ab517442e9e6d60bba35705
+SHA512:
+  metadata.gz: 826eb9577377c8b9a9e9030db14c4a662e1071c3b9a66da06785a5d7ff3e3866db33a220a98ed023bf9ead67b57a62d4463c8384eb0875e5341b8cc5e7469231
+  data.tar.gz: dcde6333cd24cfb2db0647fcd47f838b2bbed118bf5b287202140a56e1eeab5c99716c26c4fb4903be1adebb2a878f2815facc831b274a442409432d8f9f086c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slide_hero.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb})
+  # watch(%r{^lib/(.+)\.rb})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb})
+  # watch(%r{^test/test_helper\.rb}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Nunez
+
+MIT License
+
+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,161 @@
+# SlideHero
+
+SlideHero is a gem for creating presentations backed by reveal.js through a 
+Ruby DSL. 
+
+## Installation
+
+Requires Ruby 2.0.0
+
+Add this line to your application's Gemfile:
+
+    gem 'slide_hero'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slide_hero
+
+## Usage
+All features are accessible through the `slidehero` command.
+
+### Generator
+
+    slidehero new presentation_name
+    
+This creates a new folder named `presentation_name` in the current directory. Inside, there is a sample file called `presentation.rb`. 
+
+### Server
+
+    slidehero serve
+ 
+Call this in the same folder as your presentation to serve your files on port 9292. You can optionally pass in an alternate location for the presentation.rb file.
+
+    slidehero serve ../other/folder/presentation.rb
+    
+### Compilation
+
+    slidehero compile
+  
+Use this if you just want a folder with the markup files. A new `presentation` folder is created.
+
+### DSL
+
+The DSL for SlideHero was created to add expressibility to creating slides.
+
+**presentation**
+    
+    
+    presentation "My Presentation" do
+     
+    end
+
+`#presentation` indicates the beginning of a presentation. You can have one of these per file. The String passed is used as the title for the presentation.
+
+**slide**
+
+    presentation "My Presentation" do
+        slide "A slide" do
+          #…
+        end
+    end
+    
+`#slide` is used to create a new slide. The string is the headline of the slide. `#slide` can take an optional argument of `headline_size:`. Valid options are :small, :medium, :large. These create h3, h2, and h1 elements respectively.
+
+    presentation "My Presentation" do
+        slide "A slide", headline_size: :small do
+          #…
+        end
+    end
+    
+`#slide` can have transitions applied as well. Valid transitions are: :cube, :page, :concave, :zoom, :linear, :fade, :none, and :default
+
+    presentation "My Presentation" do
+        slide "A slide", transition: :slide do
+          #…
+        end
+    end
+    
+**points**
+
+    presentation "My Presentation" do
+      slide "A slide" do
+        point "An interesting Point"
+      end
+    end
+
+`#point` adds p tag wrapped text to your presentation
+
+**grouped_slides**
+
+    presentation "My Presentation" do
+        grouped_slides do
+          slide "Slide 1" do
+          end
+          slide "Slide 2" do
+          end
+        end
+    end
+    
+`#grouped_slides` lets you nest slides. In reveal, this translates into vertical slides.
+
+**lists**
+
+
+    presentation "My Presentation" do
+
+       slide "Slide 1" do
+         list do
+           point "An interesting point about monkeys"
+           point "An even more interesting point about nargles"
+         end
+       end
+       slide "Slide 2" do
+         list(:ordered) do
+            point "I should go first"
+            point "I'm ok going second"
+         end
+       end
+    end
+
+`#list` must be nested in a slide. It takes an optional argument of :ordered to 
+create an ordered list. List items are added by the `#point` method.
+
+**code**
+
+    presentation "My Presentation" do
+      slide "A slide" do
+        code(:ruby) do
+          "working_code.rb"  
+        end
+      end
+    end
+    
+`#code` must be nested in a slide. It loads any code file in the same directory as the file. 
+
+#### Animation
+
+Animation for points are supported.
+
+    #…
+    slide do 
+      point "My point", animation: "grow"
+      list do
+        point "My", animation: "step"
+        point "Staggered", animation: "step"
+        point "List", animation: "step"
+      end
+    end
+
+Supported animations are: step, grow, shrink, roll-in, fade-out, highlight-red, highlight-green, and highlight-blue  
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_spec.rb']
+end
+
+task :default => :test

data/bin/slidehero

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'slide_hero'
+require 'thor'
+require 'fileutils'
+
+class PresentationGenerator < Thor
+  include Thor::Actions
+  desc "new NAME", "Create a new presentation"
+  def new(name)
+    @name = name
+    template 'templates/new_presentation.tt', "#{name}/presentation.rb"
+  end
+
+  desc "compile PRESENTATION_NAME (defaults to presentation.rb", "Compile presentation"
+  def compile(name = 'presentation.rb')
+    directory 'vendor/reveal.js', 'presentation'
+    File.open('presentation/index.html', 'w+') do |f|
+      f.puts eval(File.read(name), SlideHero.get_binding)
+    end
+  end
+
+  desc "serve FILENAME", "starts a server running your presentation on port 9292"
+  def serve(name = 'presentation.rb')
+    directory 'vendor/reveal.js', '.tmp'
+    File.open('.tmp/index.html', 'w+') do |f|
+      f.puts eval(File.read(name), SlideHero.get_binding)
+    end
+    puts "Go checkout your awesome presentation at http://localhost:9292!"
+    system("rackup #{Gem.loaded_specs['slide_hero'].full_gem_path}/config.ru")
+  rescue Interrupt
+    remove_dir '.tmp'
+  end
+end
+
+PresentationGenerator.source_root(Gem.loaded_specs['slide_hero'].full_gem_path)
+PresentationGenerator.start ARGV

data/config.ru

@@ -0,0 +1,14 @@
+use Rack::Static, 
+  :urls => ["/images", "/js", "/css", "/lib", "/plugin"],
+  :root => ".tmp"
+
+run lambda { |env|
+  [
+    200, 
+    {
+      'Content-Type'  => 'text/html', 
+      'Cache-Control' => 'public, max-age=86400' 
+    },
+    File.open('.tmp/index.html', File::RDONLY)
+  ]
+}

data/lib/slide_hero/code.rb

@@ -0,0 +1,16 @@
+module SlideHero
+  class Code
+    def initialize(language, &code_file)
+      @language = language
+      @source = File.read("#{Dir.pwd}/#{code_file.call}")
+    rescue Errno::ENOENT 
+      abort "#{Dir.pwd}/#{code_file.call} not found"
+    end
+
+    def compile
+      Tilt::ERBTemplate.
+        new(File.join(Gem.loaded_specs['slide_hero'].full_gem_path, 
+                      'lib/slide_hero/views/code.html.erb')).render(self)
+    end
+  end
+end

data/lib/slide_hero/dsl.rb

@@ -0,0 +1,10 @@
+module SlideHero
+  module DSL
+    def presentation(title, &slide_block)
+      SlideHero::Presentation.new(title, &slide_block).compile
+    end
+  end
+end
+
+extend SlideHero::DSL
+Module.send(:include, SlideHero::DSL)

data/lib/slide_hero/grouped_slides.rb

@@ -0,0 +1,21 @@
+module SlideHero
+  class GroupedSlides
+    def initialize(&block)
+      instance_eval(&block)
+    end
+
+    def compile
+      Tilt::ERBTemplate.
+        new(File.join(Gem.loaded_specs['slide_hero'].full_gem_path, 
+                      'lib/slide_hero/views/grouped_slides.html.erb')).render(self)
+    end
+
+    def slide(headline, &block)
+      slides << Slide.new(headline, &block).compile
+    end
+
+    def slides
+      @slides ||= []
+    end
+  end
+end

data/lib/slide_hero/list.rb

@@ -0,0 +1,29 @@
+module SlideHero
+  class List
+    attr_reader :style
+
+    def initialize(style=:unordered, &block)
+      @style = style 
+      instance_eval(&block)
+    end
+
+    def compile
+      gem_path = Gem.loaded_specs['slide_hero'].full_gem_path
+      if style == :unordered
+        Tilt::ERBTemplate.new(File.join(gem_path, 
+                                        'lib/slide_hero/views/unordered_list.html.erb')).render(self)
+      else
+        Tilt::ERBTemplate.new(File.join(gem_path, 
+                                        'lib/slide_hero/views/ordered_list.html.erb')).render(self)
+      end
+    end
+
+    def point(text, animation: nil)
+      points << ListPoint.new(text, { animation: animation })
+    end
+
+    def points
+      @points ||= []
+    end
+  end
+end

data/lib/slide_hero/list_point.rb

@@ -0,0 +1,26 @@
+module SlideHero
+  class ListPoint
+    attr_reader :animation, :text
+    SUPPORTED_ANIMATIONS = %w{grow shrink roll-in fade-out 
+      highlight-red highlight-green highlight-blue}
+
+    def initialize(text, options={})
+      @text = text
+      @animation = options[:animation]
+    end
+
+    def to_s
+      text
+    end
+
+    def animation_class
+      if animation
+        animation_markup = ' class="fragment ' 
+        if SUPPORTED_ANIMATIONS.include? animation
+          animation_markup << animation 
+        end
+        animation_markup + "\""
+      end
+    end
+  end
+end

data/lib/slide_hero/point.rb

@@ -0,0 +1,27 @@
+module SlideHero
+  class Point
+    attr_reader :text
+    SUPPORTED_ANIMATIONS = %w{grow shrink roll-in fade-out 
+      highlight-red highlight-green highlight-blue}
+
+    def initialize(text, animation: nil)
+      @text = text
+      @animation = animation
+    end
+
+    def compile
+      "<p#{animation}>#{text}</p>"
+    end
+
+    private
+    def animation
+      if @animation
+        animation_markup = ' class="fragment ' 
+        if SUPPORTED_ANIMATIONS.include? @animation
+          animation_markup << @animation 
+        end
+        animation_markup + "\""
+      end
+    end
+  end
+end

data/lib/slide_hero/presentation.rb

@@ -0,0 +1,36 @@
+module SlideHero
+  require 'erb'
+  require 'tilt'
+  class Presentation
+    attr_reader :title
+    def initialize(title, &block)
+      @title = title
+      instance_eval(&block)
+    end
+
+    def compile
+      gem_path = Gem.loaded_specs['slide_hero'].full_gem_path
+      Tilt::ERBTemplate.new(File.join(gem_path, 
+                                      'lib/slide_hero/views/layout.html.erb')).
+                                      render(self) do 
+        collected_slides
+      end
+    end
+
+    def slide(title, **kwargs, &slide_block)
+      slides << Slide.new(title, **kwargs, &slide_block).compile
+    end
+
+    def grouped_slides(&block)
+      slides << GroupedSlides.new(&block).compile
+    end
+
+    def collected_slides
+      slides.join
+    end
+
+    def slides
+      @slides ||= []
+    end
+  end
+end

data/lib/slide_hero/slide.rb

@@ -0,0 +1,47 @@
+module SlideHero
+  class Slide
+    attr_reader :headline, :headline_size, :transition
+    def initialize(headline, headline_size: :large, transition: :default, &point_block)
+      @headline = headline
+      @headline_size = headline_size
+      @transition = transition
+      instance_eval(&point_block) if block_given?
+    end
+
+    def compile
+      gem_path = Gem.loaded_specs['slide_hero'].full_gem_path
+      Tilt::ERBTemplate.new(File.join(gem_path, 
+                                      'lib/slide_hero/views/slide.html.erb')).
+                                      render(self)
+    end
+
+    def point(text, animation: nil)
+      points << Point.new(text, animation: nil).compile
+    end
+
+    def list(style=:unordered, &block)
+      points << List.new(style, &block).compile
+    end
+
+    def code(language, &code)
+      points << Code.new(language, &code).compile
+    end
+
+    def points
+      @points ||= []
+    end
+
+    private
+    def size_to_markup
+      { 
+        large: :h1,
+        medium: :h2,
+        small: :h3
+      }[headline_size]
+    end
+
+    def data_attributes
+      "data-transition=\"#{transition}\""
+    end
+  end
+end

data/lib/slide_hero/version.rb

@@ -0,0 +1,3 @@
+module SlideHero
+  VERSION = "0.0.2"
+end

data/lib/slide_hero/views/code.html.erb

@@ -0,0 +1,3 @@
+<pre><code data-trim>
+  <%= @source %>
+</code></pre>

data/lib/slide_hero/views/empty.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <%= partial 'header', locals: title: title %>
+  <body>
+    <div class="reveal">
+      <div class="slides">
+        <%= yield %>
+      </div>
+    </div>
+    <%= partial 'footer' %>
+  </body>
+</html>

data/lib/slide_hero/views/grouped_slides.html.erb

@@ -0,0 +1,5 @@
+<section>
+  <% slides.each do |slide| %>
+    <%= slide %>
+  <% end %>
+</section>

data/lib/slide_hero/views/layout.html.erb

@@ -0,0 +1,54 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title><%= @title %></title>
+    <meta name="apple-mobile-web-app-capable" content="yes" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+    <link rel="stylesheet" href="css/reveal.min.css">
+    <link rel="stylesheet" href="css/theme/solarized.css" id="theme">
+    <link rel="stylesheet" href="lib/css/zenburn.css">
+    <script>
+      document.write( '<link rel="stylesheet" href="css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );
+    </script>
+    <!--[if lt IE 9]>
+    <script src="lib/js/html5shiv.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="reveal">
+      <div class="slides">
+        <%= yield %>
+      </div>
+    </div>
+    <script src="lib/js/head.min.js"></script>
+    <script src="js/reveal.min.js"></script>
+
+    <script>
+
+      // Full list of configuration options available here:
+      // https://github.com/hakimel/reveal.js#configuration
+      Reveal.initialize({
+        controls: true,
+        progress: true,
+        history: true,
+        center: true,
+
+        theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
+        transition: Reveal.getQueryHash().transition || 'default', // default/cube/page/concave/zoom/linear/fade/none
+
+        // Optional libraries used to extend on reveal.js
+        dependencies: [
+        { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
+        { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+        { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+        { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
+        { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },
+        { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }
+        ]
+      });
+
+    </script>
+  </body>
+</html>

data/lib/slide_hero/views/ordered_list.html.erb

@@ -0,0 +1,5 @@
+<ol> 
+  <% points.each do |point| %>
+    <li<%= point.animation_class %>><%= point %></li>
+  <% end %>
+</ol>

data/lib/slide_hero/views/slide.html.erb

@@ -0,0 +1,6 @@
+<section <%= data_attributes %>>
+  <<%= size_to_markup %>><%= headline %></<%= size_to_markup %>>
+  <% points.each do |point| %>
+    <%= point %>
+  <% end %>
+</section>

data/lib/slide_hero/views/unordered_list.html.erb

@@ -0,0 +1,5 @@
+<ul> 
+  <% points.each do |point| %>
+    <li<%= point.animation_class %>><%= point %></li>
+  <% end %>
+</ul>

data/lib/slide_hero.rb

@@ -0,0 +1,15 @@
+require_relative "slide_hero/version"
+require_relative "slide_hero/slide"
+require_relative "slide_hero/point"
+require_relative "slide_hero/list"
+require_relative "slide_hero/list_point"
+require_relative "slide_hero/grouped_slides"
+require_relative "slide_hero/code"
+require_relative "slide_hero/presentation"
+require_relative "slide_hero/dsl"
+
+module SlideHero
+  def self.get_binding
+    binding
+  end
+end