reveal.rb 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9c629a7c0198b72125183beb642d6028c0313cb
-  data.tar.gz: 3f6e6f6e8f645f304ea9f1fd8e8b60af07d4669d
+  metadata.gz: 198dbe4ca1f44f2451805ae003e8d3b28a226e7a
+  data.tar.gz: 5e975881ed302587d4865ed8c39ad842b1861dd1
 SHA512:
-  metadata.gz: 5f30a0915337b37035584d58700645cf0445ece76d10200d3cc43e8507ed2b2a916714fbf3976f55a3a321cdd6af9f2acdee0b7686cad9df3b965523a4ef0cc0
-  data.tar.gz: cfdc3e378f138f65375193fa4bce09a164d3561605c37cdf023a7997a158ab1b86f76075a30df115791c3fa087b39a1b4e9b92fda3c91d8fef8c8d3402b02c94
+  metadata.gz: 5f2b54d533b7057c14b94738649be8b1fe4c6e51a469a979969a2458729d935a4f9a2fe53bf8aa7ee8fea9cac40543627347395fa271f74ae5ef12282aae5d05
+  data.tar.gz: 0d3a46938807a1c055ea9a78687753ca1518c632e74bece5837676dd11d15218ebb4108857c95938767f9191cab102d5d35c6e8b9fa1a397faf0862d2ac3e1a5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reveal.rb (0.1.1)
+    reveal.rb (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -23,3 +23,21 @@ Simply install the gem:
     reveal generate
 
 That's it! Now open `output/index.html` to watch your presentation.
+
+## Configuration
+
+All currently supported configurations are made through `reveal.yml` file.
+
+### Slides order
+
+There are two ways to order your slides:
+
+* **Manual order**: set `order` parameter to `manual` and list your slide names in `slides` parameter. This is the default configuration, and it's automatically done for you with `reveal add-slide` command;
+* **Alphabetical order**: if you omit `order` parameter (or set it to anything other than `manual`), slides will be orderer alphabetically.
+
+### reveal.js configurations
+
+`reveal create` command adds a `template.html` file to your
+presentation, with reveal.js default configurations. If you want to
+change some configuration, just edit this file before running `reveal
+generate`.

data/lib/reveal/cli.rb

@@ -1,9 +1,11 @@
 require 'fileutils'
+require 'yaml'
 
 module Reveal
   SOURCE_DIR = "source"
   OUTPUT_DIR = "output"
   TEMPLATE_FILENAME = "template.html"
+  CONFIG_FILENAME = "reveal.yml"
   SLIDES_TAG = "<slides>"
 
   module Cli
@@ -16,7 +18,7 @@ module Reveal
     def create args
       name = args.first
 
-      if Dir.exists?(name)
+      if File.exists?(name)
         puts "#{name} already exists."
         exit 1
       end
@@ -24,19 +26,25 @@ module Reveal
       FileUtils.mkdir_p(File.join(name, SOURCE_DIR))
       FileUtils.mkdir_p(File.join(name, OUTPUT_DIR))
       FileUtils.cp(File.join(templates_path, TEMPLATE_FILENAME), name)
+      FileUtils.cp(File.join(templates_path, CONFIG_FILENAME), name)
       FileUtils.cp_r(File.join(templates_path, "revealjs", "."), File.join(name, OUTPUT_DIR))
 
-      puts "#{name} presentation created."
+      puts "Presentation '#{name}' created."
     end
 
     def add_slide args
       check_if_presentation_exists
 
+      config["slides"] ||= []
+
       args.each do |slide_name|
         filepath = File.join(SOURCE_DIR, "#{slide_name}.md")
         FileUtils.touch(filepath)
-        puts "#{filepath} created."
+        config["slides"] << slide_name
+        puts "Slide '#{filepath}' created."
       end
+
+      write_config
     end
 
     def generate args
@@ -44,7 +52,7 @@ module Reveal
 
       source_content = ""
 
-      Dir.glob(File.join(SOURCE_DIR, "*.md")).each do |filename|
+      ordered_slide_names.each do |filename|
         source_content << <<-SLIDE
       <section data-markdown>
         <script type="text/template">
@@ -52,7 +60,7 @@ module Reveal
         </script>
       </section>
 
-      SLIDE
+        SLIDE
       end
 
       template = File.read(TEMPLATE_FILENAME)
@@ -61,7 +69,7 @@ module Reveal
         file.write(template.gsub(SLIDES_TAG, source_content))
       end
 
-      puts "#{compiled_filename} presentation generated."
+      puts "#{compiled_filename} presentation file generated."
     end
 
     private
@@ -81,5 +89,23 @@ module Reveal
         ].select { |item| File.readable?(item) }.first
       end
     end
+
+    def ordered_slide_names
+      if config && config["order"] == "manual" && config["slides"]
+        config["slides"].
+          map { |slide_name| File.join(SOURCE_DIR, "#{slide_name}.md") }.
+          select { |filepath| File.readable?(filepath) }
+      else
+        Dir.glob(File.join(SOURCE_DIR, "*.md"))
+      end
+    end
+
+    def config
+      @config ||= YAML.load(File.read(CONFIG_FILENAME))
+    end
+
+    def write_config
+      File.write(CONFIG_FILENAME, config.to_yaml)
+    end
   end
 end

data/lib/reveal/templates/reveal.yml

@@ -0,0 +1,2 @@
+---
+order: manual

data/lib/reveal/version.rb

@@ -1,3 +1,3 @@
 module Reveal
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reveal.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Guilherme Garnier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies: []
 description: Generates presentations using reveal.js
 email:
@@ -27,6 +27,7 @@ files:
 - bin/reveal
 - lib/reveal.rb
 - lib/reveal/cli.rb
+- lib/reveal/templates/reveal.yml
 - lib/reveal/templates/revealjs/css/print/pdf.css
 - lib/reveal/templates/revealjs/css/reveal.min.css
 - lib/reveal/templates/revealjs/css/theme/default.css