slide_hero 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11f150c4e85602a1f8379dd4614263956fb0ce5a
-  data.tar.gz: 11507fc11afd7da1ceaa79e9de62739934a64755
+  metadata.gz: d6944cd321adb4a9061916b686951183ea789005
+  data.tar.gz: f1e0c3edc888475de5b28c7424fe0f70185d4bfd
 SHA512:
-  metadata.gz: 37eac03dbdc05d82ad0a0aa9be799a55b6e0d9480e81a7ced9db6fcab832685685fae7ce5177df00d36d0458dfdd7f243df6d4ec1eb5353a0bbc77d9961c1736
-  data.tar.gz: a0e51f35504d3507b644ce9798d33f2b2469d28c1c38f9dcd50be5eea29920d933bd9993a78c315eff4ec5af20e015bec1974e9c1b62dc76fbd4f1e794e607bc
+  metadata.gz: 43223d3b4efebd824053b358e1ecaabb691b332bfd69fe57d7d87298e8b289aa89f131a7d14e9f2afff851fe5b76ad16423adde2dd23b5fa92b3fe5ccabc4275
+  data.tar.gz: 07c0c381219efd26ea52b29524e3ef1c666ac5c463a389c7ba42d1e0e8403aa51d1f3efef297f317a1d826b1ded61f3eae853c8be53ea81ea7a972c5910430cd

data/README.md

@@ -52,7 +52,6 @@ The DSL for SlideHero was created to add expressibility to creating slides.
     
 ```ruby
 presentation "My Presentation" do
- 
 end
 ```
 
@@ -87,6 +86,19 @@ presentation "My Presentation" do
   end
 end
 ```
+
+`#slide` can have a background color applied. This will only add the color to
+this one slide. Any css color will work.
+
+```ruby
+presentation "My Presentation" do
+  slide "A slide", background_color: 'blue' do
+    #…
+  end
+end
+```
+
+
 **defaults**
 
 ```ruby
@@ -104,6 +116,36 @@ end
 ```
 
 You can set slide defaults for `headline_size` or `transition` by using `#defaults`. A slide default applies to all slides unless an individual slide overrides it.
+The theme is set to Default.  to change this, use the `set_theme` method in the
+presentation block.
+
+``` ruby
+presentation "My Presentation" do
+  set_theme 'solarized'
+end
+```
+
+Valid theme options are: default, sky, beige, simple, serif, night, moon, solarized
+
+**plugins**
+
+You can activate revealjs plugins by passing a symbol array to the
+`set_plugins` method. 
+
+``` ruby
+presentation "My Presentation" do
+  set_plugins :class_list, :remote, :leap
+end
+```
+
+Currently supported plugins are `:class_list`, `:markdown`, `:highlight`, `:zoom`,
+`:notes`, `:remote`, and `:leap`.
+
+`:class_list`, `:hightlight`, and `:notes` are used if `set_plugins` is
+not called.
+
+See Reveal.js [documentation](https://github.com/hakimel/reveal.js/#dependencies) for more info on these plugins.
+
 
 **points**
 
@@ -146,6 +188,9 @@ presentation "My Presentation" do
     list(:ordered) do
       point "I should go first"
       point "I'm ok going second"
+      list do
+        point "I'm in a nested list"
+      end
     end
   end
 end

data/lib/slide_hero/plugins.rb

@@ -0,0 +1,20 @@
+module SlideHero
+  module Plugins
+    def self.reveal
+      {
+        class_list:  "{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }",
+        markdown:  "{ src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+                  { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }",
+        highlight:  "{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }",
+        zoom:  "{ src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } }",
+        notes:  "{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }",
+        remote:  "{ src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }",
+        leap: "{ src: 'plugin/leap/leap.js', async: true }"
+      }
+    end
+
+    def self.reveal_list
+      reveal.keys
+    end
+  end
+end

data/lib/slide_hero/presentation.rb

@@ -2,31 +2,59 @@ module SlideHero
   require 'erb'
   require 'tilt'
   class Presentation
-    attr_reader :title
+    attr_reader :title, :slide_defaults
     def initialize(title, &block)
       @title = title
       @slide_defaults = {}
       instance_eval(&block)
     end
 
+    def set_plugins(*plugin_list)
+      if plugin_list.empty?
+        defaults = %i{class_list highlight notes}
+        plugin_list = defaults
+      end
+
+      plugin_list.each do |plugin|
+        if Plugins.reveal_list.include? plugin
+          plugins <<  "#{Plugins.reveal[plugin]},"
+        end
+      end
+
+      plugins.chop
+    end
+
+    def plugins
+      @plugins ||= ""
+    end
+
     def compile
+      set_plugins if plugins.empty?
       Tilt::ERBTemplate.new(File.join(SlideHero.template_path, 
                                       'lib/slide_hero/views/layout.html.erb')).
                                       render(self) do 
-        collected_slides
-      end
+                                        collected_slides
+                                      end
     end
 
     def defaults(args)
       @slide_defaults = args
     end
 
+    def theme
+      @theme ||= 'default'
+    end
+
+    def set_theme(theme)
+      @theme = theme
+    end
+
     def slide(title, **kwargs, &slide_block)
-      slides << Slide.new(title, @slide_defaults.merge(**kwargs), &slide_block).compile
+      slides << Slide.new(title, slide_defaults.merge(**kwargs), &slide_block).compile
     end
 
     def grouped_slides(&block)
-      slides << GroupedSlides.new(@slide_defaults, &block).compile
+      slides << GroupedSlides.new(slide_defaults, &block).compile
     end
 
     def collected_slides

data/lib/slide_hero/slide.rb

@@ -1,10 +1,12 @@
 module SlideHero
   class Slide
-    attr_reader :headline, :headline_size, :transition
-    def initialize(headline, headline_size: :large, transition: :default, &point_block)
+    attr_reader :headline, :headline_size, :transition, :background_color
+    def initialize(headline=nil, headline_size: :medium, transition: :default, background_color: nil, &point_block)
       @headline = headline
       @headline_size = headline_size
       @transition = transition
+
+      @background_color = background_color
       instance_eval(&point_block) if block_given?
     end
 
@@ -52,7 +54,11 @@ module SlideHero
     end
 
     def data_attributes
-      "data-transition=\"#{transition}\""
+      "data-transition=\"#{transition}\"".tap do |attr|
+        if background_color
+          attr << " data-background=\"#{background_color}\""
+        end
+      end
     end
   end
 end

data/lib/slide_hero/version.rb

@@ -1,3 +1,3 @@
 module SlideHero
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

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

@@ -7,7 +7,7 @@
     <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="css/theme/<%= theme %>.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">' );
@@ -45,14 +45,7 @@
 
         // 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; } },
-        { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } },
-        { src: 'plugin/leap/leap.js', async: true }
+        <%= plugins %>
         ]
       });
 

data/lib/slide_hero.rb

@@ -1,4 +1,5 @@
 require_relative "slide_hero/version"
+require_relative "slide_hero/plugins"
 require_relative "slide_hero/slide"
 require_relative "slide_hero/point"
 require_relative "slide_hero/list"

data/test/minitest_helper.rb

@@ -3,6 +3,7 @@ require 'slide_hero'
 
 require 'minitest/autorun'
 require 'minitest/spec'
+
 def assert_dom_match(expected, actual)
   dom_clean(actual).must_equal(
     dom_clean(expected))

data/test/slide_hero/grouped_slides_spec.rb

@@ -15,11 +15,11 @@ module SlideHero
 
         assert_dom_match grouped_slides.compile, "<section>" +
           "<section data-transition=\"default\">" +
-          "<h1>banana</h1>" +
+          "<h2>banana</h2>" +
           "<p>High in potassium</p>" +
           "</section>" +
           "<section data-transition=\"default\">" +
-          "<h1>apple</h1>" +
+          "<h2>apple</h2>" +
           "<p>Good if you hate doctors</p>" +
           "</section>" +
           "</section>" 

data/test/slide_hero/plugins_spec.rb

@@ -0,0 +1,15 @@
+require 'minitest_helper'
+
+module SlideHero
+  describe Plugins do
+    it "contains configuration values for reveal plugins" do
+        Plugins.reveal[:class_list].must_equal  "{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }"
+        Plugins.reveal[:markdown].squeeze(' ').delete!("\n").must_equal  "{ src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }"
+        Plugins.reveal[:highlight].must_equal  "{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }"
+        Plugins.reveal[:zoom].must_equal  "{ src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } }"
+        Plugins.reveal[:notes].must_equal  "{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }"
+        Plugins.reveal[:remote].must_equal  "{ src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }"
+        Plugins.reveal[:leap].must_equal "{ src: 'plugin/leap/leap.js', async: true }"
+    end
+  end
+end

data/test/slide_hero/presentation_spec.rb

@@ -72,7 +72,44 @@ module SlideHero
         end
       end
 
-      assert_dom_includes("<section data-transition=\"default\"><h1>Nesting!</h1><p>Woot!</p></section>", pres.compile)
+      assert_dom_includes("<section data-transition=\"default\"><h2>Nesting!</h2><p>Woot!</p></section>", pres.compile)
+    end
+
+    it "can have a theme set" do
+      pres = Presentation.new("New stuff") do
+        set_theme 'sky'
+      end
+
+      assert pres.compile.include? "<link rel=\"stylesheet\" href=\"css/theme/sky.css\" id=\"theme\">"
+    end
+
+    it "sets the default theme to 'default'" do
+      pres = Presentation.new("New stuff") {}
+
+      assert pres.compile.include? "<link rel=\"stylesheet\" href=\"css/theme/default.css\" id=\"theme\">"
+    end
+
+    it "allows plugins to be set" do
+      pres = Presentation.new("New stuff") do
+        set_plugins :markdown, :highlight
+      end
+
+      assert pres.compile.include?("{ 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(); } }"), pres.compile
+    end
+
+    it "sets default plugins if not provided" do
+      pres = Presentation.new("New stuff") {}
+      assert pres.compile.include?("{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }"), pres.compile
+    end
+
+    it "ignores invalid plugins" do
+      pres = Presentation.new("New stuff") do
+        set_plugins :markdown, :totally_fake, :highlight
+      end
+
+      assert pres.compile.include?("{ 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(); } }"), pres.compile
     end
   end
 end

data/test/slide_hero/slide_spec.rb

@@ -8,6 +8,11 @@ module SlideHero
         slide.headline.must_equal "Badgers learn knitting"
       end
 
+      it "can be initialized with no title" do
+        slide = Slide.new
+        slide.headline.must_equal nil
+      end
+
       it "can take an optional side directive" do
         slide = Slide.new("Badgers learn knitting", headline_size: :large)
         slide.headline_size.must_equal :large
@@ -15,13 +20,18 @@ module SlideHero
         slide = Slide.new("Snacks lead to revolution in food care", headline_size: :medium)
         slide.headline_size.must_equal :medium
       end
+
+      it "can take a background color" do
+        slide = Slide.new("Badgers learn knitting", background_color: 'blue')
+        slide.background_color.must_equal 'blue'
+      end
     end
 
     describe "compilation" do
       it "outputs object to html" do
         slide = Slide.new("To Markup!")
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>To Markup!</h1> " +
+          "<h2>To Markup!</h2> " +
           "</section>"
       end
 
@@ -36,7 +46,16 @@ module SlideHero
         slide = Slide.new("transitions", transition: :zoom) do
         end
         assert_dom_match slide.compile, '<section data-transition="zoom">' +
-          '<h1>transitions</h1>' +
+          '<h2>transitions</h2>' +
+          '</section>'
+      end
+
+      it "takes a background_color" do
+        slide = Slide.new("background_color", background_color: 'blue') do
+        end
+        assert_dom_match slide.compile, '<section data-transition="default" ' +
+         'data-background="blue">' +
+          '<h2>background_color</h2>' +
           '</section>'
       end
     end
@@ -48,7 +67,7 @@ module SlideHero
         end
 
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Embedding</h1>" +
+          "<h2>Embedding</h2>" +
           "<p>I'm embedded!</p>" +
           "</section>"
       end
@@ -59,7 +78,7 @@ module SlideHero
         end
 
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Embedding</h1>" + 
+          "<h2>Embedding</h2>" + 
           "<p><small>I'm embedded!</small></p>" +
           "</section>"
       end
@@ -71,7 +90,7 @@ module SlideHero
         end
 
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Embedding</h1>" + 
+          "<h2>Embedding</h2>" + 
           "<p>I'm embedded!</p>" +
           "<p>Me too!</p>" +
           "</section>"
@@ -83,7 +102,7 @@ module SlideHero
         end
 
         assert_dom_match slide.compile, "<section data-transition=\"default\">"+
-          "<h1>Animation</h1>" + 
+          "<h2>Animation</h2>" + 
           "<p class=\"fragment \">I'm animated!</p>" +
           "</section>"
 
@@ -99,7 +118,7 @@ module SlideHero
           end
         end
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Lists</h1>" +
+          "<h2>Lists</h2>" +
           "<ul>" +
           "<li>Bullet Points</li>" +
           "<li>Another Point</li>" +
@@ -115,7 +134,7 @@ module SlideHero
           end
         end
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Lists</h1>" +
+          "<h2>Lists</h2>" +
           "<ol>" +
           "<li>Ordered!</li>" +
           "<li>Also ordered!</li>" +
@@ -132,7 +151,7 @@ module SlideHero
         end
 
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Code</h1>" +
+          "<h2>Code</h2>" +
           "<pre><code data-trim class=\"ruby\">
   class Working
   def some_method
@@ -150,7 +169,7 @@ end
           note "Don't forget to bring a towel"
         end
         assert_dom_match slide.compile, "<section data-transition=\"default\">" +
-          "<h1>Note</h1>" +
+          "<h2>Note</h2>" +
           "<aside class=\"notes\">Don't forget to bring a towel</aside>" +
           "</section>"
       end

data/test/slide_hero_spec.rb

@@ -10,6 +10,7 @@ require_relative 'slide_hero/dsl_spec'
 require_relative 'slide_hero/note_spec'
 require_relative 'slide_hero/image_spec'
 require_relative 'slide_hero/media_spec'
+require_relative 'slide_hero/plugins_spec'
 
 describe ::SlideHero do
   it "has a version" do

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: slide_hero
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Steven Nunez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.2'
 description: Used for creating slide decks backed by reveal.js
@@ -130,10 +130,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -150,6 +150,7 @@ files:
 - lib/slide_hero/list_point.rb
 - lib/slide_hero/media.rb
 - lib/slide_hero/note.rb
+- lib/slide_hero/plugins.rb
 - lib/slide_hero/point.rb
 - lib/slide_hero/presentation.rb
 - lib/slide_hero/slide.rb
@@ -175,6 +176,7 @@ files:
 - test/slide_hero/list_spec.rb
 - test/slide_hero/media_spec.rb
 - test/slide_hero/note_spec.rb
+- test/slide_hero/plugins_spec.rb
 - test/slide_hero/point_spec.rb
 - test/slide_hero/presentation_spec.rb
 - test/slide_hero/slide_spec.rb
@@ -270,17 +272,17 @@ 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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Used for creating slide decks backed by reveal.js
@@ -295,6 +297,7 @@ test_files:
 - test/slide_hero/list_spec.rb
 - test/slide_hero/media_spec.rb
 - test/slide_hero/note_spec.rb
+- test/slide_hero/plugins_spec.rb
 - test/slide_hero/point_spec.rb
 - test/slide_hero/presentation_spec.rb
 - test/slide_hero/slide_spec.rb