reveal.rb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa51e087315e2a6fe1b291e91648cf39a6944445
-  data.tar.gz: 2b7eb436b89b40a03dad5a169fd62de49259c261
+  metadata.gz: aeddfdafa8a8712ac291c0450ae335e32b21e895
+  data.tar.gz: 618130631940cf2a6aaa464045eb93cac66f18b7
 SHA512:
-  metadata.gz: 57f2513a02b11075b09a029d4f154734108ea7eb8625c3ce56978fc29f15de17817b87d7f72d2848f918c7f4b6751fd4bad8f29e4a64ba20553c8fa63de376c1
-  data.tar.gz: d0484008b4f5c8f6acf1662518541d19f1762aa50a0836d1e5f7b1335f6695c4cfee6f1b3f82a8ee000fd0be904042a6e330313bc9d9317c5f1f3669829aa87f
+  metadata.gz: c43a12a10adc8869ee97bacc1be19539d9449084e3daa28b2845d5648dcb13b25db6ed7bfe673235cee911a4ab43283eb54bdef1e12b15c4b3488e11c6260672
+  data.tar.gz: a0d3306ccd4bcf3dfe94e3846aabaf6501b7b7531a83a3e9d752e91a30e93621cc49cb7966dcfb92a77ec6330bc0e8117fa7027fc55f4dffb9f2e2c7e2067194

data/.travis.yml

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

data/Gemfile.lock

@@ -1,14 +1,28 @@
 PATH
   remote: .
   specs:
-    reveal.rb (0.3.0)
+    reveal.rb (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (3.4.0)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    m (1.3.2)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.8.2)
+    rake (0.9.6)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
+  m
   reveal.rb!

data/README.md

@@ -1,8 +1,13 @@
 # reveal.rb
 
+[![Code Climate](https://codeclimate.com/github/ggarnier/reveal.rb/badges/gpa.svg)](https://codeclimate.com/github/ggarnier/reveal.rb)
+[![Build Status](https://travis-ci.org/ggarnier/reveal.rb.svg)](https://travis-ci.org/ggarnier/reveal.rb)
+[![Dependency Status](https://gemnasium.com/ggarnier/reveal.rb.png)](https://gemnasium.com/ggarnier/reveal.rb)
+[![Analytics](https://ga-beacon.appspot.com/UA-25495907-3/github/reveal.rb)](https://github.com/igrigorik/ga-beacon)
+
 [reveal.js](https://github.com/hakimel/reveal.js) presentation generator.
 
-Current version uses reveal.js 2.6.2
+Current version uses reveal.js 3.1.0
 
 ## Installation
 
@@ -34,12 +39,14 @@ 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. Any slide file created inside `source` directory but not included in the configuration file will be ignored. Example:
 
+<pre>
     ---
     order: manual
     slides:
     - slide1
     - slide2
     - slide3
+</pre>
 
 * **Alphabetical order**: if you omit `order` parameter (or set it to anything other than `manual`), `reveal generate` command will add all slide files inside `source`, in alphabetical order.
 

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/reveal/cli.rb

@@ -1,111 +1,29 @@
-require 'fileutils'
-require 'yaml'
+require 'logger'
 
 module Reveal
-  SOURCE_DIR = "source"
-  OUTPUT_DIR = "output"
-  TEMPLATE_FILENAME = "template.html"
-  CONFIG_FILENAME = "reveal.yml"
-  SLIDES_TAG = "<slides>"
-
   module Cli
     extend self
 
-    def process args
-      self.send(args.first.gsub("-", "_"), args[1..-1])
-    end
-
-    def create args
-      name = args.first
-
-      if File.exists?(name)
-        puts "#{name} already exists."
-        exit 1
-      end
-
-      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 "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)
-        config["slides"] << slide_name
-        puts "Slide '#{filepath}' created."
-      end
-
-      write_config
-    end
-
-    def generate args
-      check_if_presentation_exists
-
-      source_content = ""
-
-      ordered_slide_names.each do |filename|
-        source_content << <<-SLIDE
-      <section data-markdown>
-        <script type="text/template">
-          #{File.read(filename)}
-        </script>
-      </section>
-
-        SLIDE
-      end
-
-      template = File.read(TEMPLATE_FILENAME)
-      compiled_filename = File.join(OUTPUT_DIR, "index.html")
-      File.open(compiled_filename, "w") do |file|
-        file.write(template.gsub(SLIDES_TAG, source_content))
-      end
-
-      puts "#{compiled_filename} presentation file generated."
+    def process(args)
+      command_name = args.first.gsub('-', '_')
+      command_args = args[1..-1]
+      Reveal::Command.new(logger).send(command_name, command_args)
+    rescue Exception => e
+      puts e.message
+      exit 1
     end
 
     private
-    def check_if_presentation_exists
-      unless File.exists?(TEMPLATE_FILENAME) && Dir.exists?(SOURCE_DIR) && Dir.exists?(OUTPUT_DIR)
-        puts "Error: The current working directory does not seem to have a reveal.rb presentation."
-        puts "Create one with 'reveal create <presentation name>'."
-        exit 1
-      end
-    end
 
-    def templates_path
-      @templates_path ||= begin
-        [
-          File.join(File.dirname(File.expand_path($0)), "..", "lib", "reveal", "templates"),
-          File.join(Gem.dir, "gems", "reveal.rb-#{Reveal::VERSION}", "lib", "reveal", "templates")
-        ].select { |item| File.readable?(item) }.first
-      end
-    end
+    def logger
+      @logger ||= begin
+        logger = ::Logger.new(STDOUT)
+        logger.formatter = proc do |_, _, _, msg|
+          "#{msg}\n"
+        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"))
+        logger
       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/command.rb

@@ -0,0 +1,109 @@
+require 'fileutils'
+require 'yaml'
+require 'logger'
+
+module Reveal
+  SOURCE_DIR = 'source'
+  OUTPUT_DIR = 'output'
+  TEMPLATE_FILENAME = 'template.html'
+  CONFIG_FILENAME = 'reveal.yml'
+  SLIDES_TAG = '<slides>'
+
+  class Command
+    def initialize(logger = ::Logger.new(STDOUT))
+      @logger = logger
+    end
+
+    def create(args)
+      name = Array(args).first
+
+      if File.exist?(name)
+        raise "ERROR: #{name} already exists."
+      end
+
+      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))
+
+      @logger.info("Presentation '#{name}' created.")
+    end
+
+    def add_slide(args)
+      check_if_presentation_exists
+
+      config['slides'] ||= []
+
+      Array(args).each do |slide_name|
+        filepath = File.join(SOURCE_DIR, "#{slide_name}.md")
+        FileUtils.touch(filepath)
+        config['slides'] << slide_name
+        @logger.info("Slide '#{filepath}' created.")
+      end
+
+      write_config
+    end
+
+    def generate(_ = nil)
+      check_if_presentation_exists
+
+      source_content = ''
+
+      ordered_slide_names.each do |filename|
+        source_content << <<-SLIDE
+      <section data-markdown>
+        <script type="text/template">
+          #{File.read(filename)}
+        </script>
+      </section>
+
+        SLIDE
+      end
+
+      template = File.read(TEMPLATE_FILENAME)
+      compiled_filename = File.join(OUTPUT_DIR, 'index.html')
+      File.open(compiled_filename, 'w') do |file|
+        file.write(template.gsub(SLIDES_TAG, source_content))
+      end
+
+      @logger.info("'#{compiled_filename}' presentation file generated.")
+    end
+
+    private
+
+    def check_if_presentation_exists
+      unless File.exist?(TEMPLATE_FILENAME) && File.exist?(CONFIG_FILENAME) && Dir.exist?(SOURCE_DIR) && Dir.exist?(OUTPUT_DIR)
+        raise "ERROR: The current working directory does not seem to have a reveal.rb presentation.\nCreate one with 'reveal create <presentation name>'."
+      end
+    end
+
+    def templates_path
+      @templates_path ||= begin
+        [
+          File.join(File.dirname(File.expand_path($0)), '..', 'lib', 'reveal', 'templates'),
+          File.join(Gem.dir, 'gems', "reveal.rb-#{Reveal::VERSION}", 'lib', 'reveal', 'templates')
+        ].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