reveal-ck 0.1.6 → 0.1.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjdkMTYxMjE5OGFhMDQ5ZmNiMzdhYWQwZGYwOGM3NTQ4NmNhYmYzOA==
+    NmVmNmUyNjhkZjI2MjM3ODBhZTQ2MzJhMDY1YTYyZWM3NjE3ZjFjOA==
   data.tar.gz: !binary |-
-    NTU5OTMwZGI1NTc5OTJjNDc1MDk4YTFlNjY4NjA1ZWJhZGRkZjI2YQ==
+    NDdlZGYyMGRjZmMxYTliMTY3ODg0MmZlZWY3YzQ4MGY3Y2U3ZWE2OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    M2E1N2FlMzVhM2JmMWU0M2YzYmMwYzIwNGZjMzYxY2U3NGY0MWQzYWM0NmVh
-    M2RiOTE0NTRiYjJiMzRmYWUwOWE1Y2IyMDI1ZmE4ZDQyODA4OTQzZjRhOTg3
-    ZmEzNmU5OTJiYTFhZjRiNTNjMDA3ZjViZjg2YmQzZGU2NTJjYmE=
+    ZTQ4MjA3M2U3ZDQ0MWJhMWZiOGI2NTA1ZDJmY2M0ZTczYmQ5MDE1MThmMDZj
+    ZmU2YThkOTM4YzE4YmQzNDgzNzZhMDVkYTQ4ZDRiMjQ0MGNmZDY0NzM2MTFk
+    Y2M4NjIwYTAzNTEwODBkMjU4YTJlNWJjNzFkZGFhZjZiODc1MTM=
   data.tar.gz: !binary |-
-    ZTNiOTVhZDNhOGE5ZWExYmUzM2Y2MTM5Njk2YjhiZWM5OTVkZjYyZDNkOWJl
-    MmE0OGQ4NjFhOWQwNDg2NzBjOTZjOTA5YWRiZDk5NGUyYjcwMmQ3MTdiM2Zm
-    YmY5MjUwMTJlOTY0NzVmOGIwNjlkZTMwZjQ0ODI2ZWJmM2I1NTE=
+    ZjcwODAyYzA3ZWQ5MGVlMzEzYmI0MmRhMjlmYmY5ZDYxZjcyZjhkZDQ0OWEy
+    MmMxNzhjYTUzNjk2N2IwZWI0MTYwYzkwZjQ5MjZkMDgzNDU1OWFhZDIwMzRm
+    NTFmM2FkNmZmYWIyZTc3MzRiMWIwMGE5NGMyZGM3NjFiNzRlNDg=

data/bin/reveal-ck

@@ -10,28 +10,34 @@ version RevealCK::VERSION
 
 desc 'Generate reveal.js slides'
 command :generate do |c|
+
+  # Where is the slides file?
+  default_file = 'slides.haml' if File.exists? 'slides.haml'
+  default_file = 'slides.slim' if File.exists? 'slides.slim'
+  default_file = 'slides.rb'   if File.exists? 'slides.rb'
+  c.desc 'The file containing your slides'
+  c.flag [:f, :file], default_value: default_file
+
   c.action do |global_options,options,args|
+    slides_file = options[:file]
 
     require 'rake' # for FileList
-
     image_files = FileList["images/**/*"]
 
     output_dir = 'slides'
 
-    slides_file = 'slides.haml' if File.exists? 'slides.haml'
-    slides_file = 'slides.slim' if File.exists? 'slides.slim'
-    slides_file = 'slides.rb' if File.exists? 'slides.rb'
+    presentation = RevealCK::Presentation.load slides_file
 
-    config = RevealCK::Config.new config_file: 'config.toml'
+    if File.exists? 'config.toml'
+      presentation.merge_config file: 'config.toml'
+    end
 
-    builder = RevealCK::PresentationBuilder.new({
-                                                  image_files: image_files,
-                                                  output_dir: output_dir,
-                                                  slides_file: slides_file,
-                                                  config: config
-                                                })
+    builder = RevealCK::Builders::PackagedSlides.new({
+                                                       image_files: image_files,
+                                                       output_dir: output_dir,
+                                                       presentation: presentation
+                                                     })
     builder.build!
-
   end
 end
 

data/lib/reveal-ck.rb

@@ -1,18 +1,11 @@
 require_relative 'reveal-ck/version'
 require_relative 'reveal-ck/config'
-require_relative 'reveal-ck/file_string_replacer'
-require_relative 'reveal-ck/file_slicer'
-require_relative 'reveal-ck/file_splicer'
-require_relative 'reveal-ck/template_finder'
-require_relative 'reveal-ck/template_processor'
 require_relative 'reveal-ck/slide'
 require_relative 'reveal-ck/presentation'
-require_relative 'reveal-ck/build_task'
-require_relative 'reveal-ck/builder'
-require_relative 'reveal-ck/slides_html_builder'
-require_relative 'reveal-ck/slide_builder'
-require_relative 'reveal-ck/presentation_builder'
 require_relative 'reveal-ck/presentation_dsl'
+require_relative 'reveal-ck/templates'
+require_relative 'reveal-ck/changers'
+require_relative 'reveal-ck/builders'
 
 # RevealCK::LOCATION is the path where reveal-ck is residing on your
 # system as a gem.

data/lib/reveal-ck/builders.rb

@@ -0,0 +1,4 @@
+require_relative 'builders/build_task'
+require_relative 'builders/builder'
+require_relative 'builders/index_html'
+require_relative 'builders/packaged_slides'

data/lib/reveal-ck/builders/build_task.rb

@@ -0,0 +1,21 @@
+module RevealCK
+  module Builders
+    #
+    # Public: A BuildTask couple a written description (in the form of a
+    # string) with an action in (the form of a proc). It executes the
+    # proc on demand via go!
+    #
+    class BuildTask
+
+      def initialize(description, action)
+        @description = description
+        @action = action
+      end
+
+      def go
+        @action.call
+      end
+    end
+
+  end
+end

data/lib/reveal-ck/builders/builder.rb

@@ -0,0 +1,27 @@
+module RevealCK
+  module Builders
+    #
+    # Public: A Builder knows how to execute BuildTasks. These are added
+    # via add_task, and executed via build!
+    #
+    # It is expected to be subclassed, and the subclass must override
+    # register_tasks.
+    #
+    class Builder
+
+      def register_tasks
+        raise 'Subclasses must implement register_tasks'
+      end
+
+      def add_task(description, &action)
+        @tasks << BuildTask.new(description, action)
+      end
+
+      def build!
+        register_tasks unless @tasks
+        @tasks.each { |task| task.go }
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/builders/index_html.rb

@@ -0,0 +1,85 @@
+module RevealCK
+  module Builders
+    #
+    # Public: An IndexHtml knows how to build the index.html file (the
+    # core slides) within a reveal.js presentation.
+    #
+    class IndexHtml < Builder
+
+      attr_reader :user_slides, :reveal_slides
+
+      attr_reader :tasks
+
+      attr_reader :config
+
+      def initialize(args)
+        @user_slides = args[:user_slides]
+        @reveal_slides = args[:reveal_slides]
+        @config = args[:config]
+      end
+
+      private
+
+      def register_tasks
+
+        @tasks = []
+
+        remove_default_content reveal_slides
+        add_user_content reveal_slides, user_slides
+        replace_title reveal_slides, config.title
+        replace_author reveal_slides, config.author
+        replace_theme reveal_slides, config.theme
+        replace_transition reveal_slides, config.transition
+      end
+
+      def remove_default_content(file)
+        add_task 'Slicing out reveal.js default slides' do
+          begin_line_num = 38 # Line where I see <div class="slides">
+          end_line_num = 346 # Closing <div>
+          default_slides = begin_line_num..end_line_num
+          Changers::Slicer.remove! file, default_slides
+        end
+      end
+
+      def add_user_content(file, user_slides)
+        add_task "Splicing in slides from #{user_slides}" do
+          Changers::Splicer.insert!(user_slides,
+                                    into: file,
+                                    after: '<div class="slides">')
+        end
+      end
+
+      def replace_title(file, title)
+        old = 'reveal.js - The HTML Presentation Framework'
+        new = title
+        add_task 'Replacing the <title>' do
+          Changers::StringReplacer.replace! file, old: old, new: new
+        end
+      end
+
+      def replace_author(file, author)
+        old = 'name="author" content="Hakim El Hattab"'
+        new = 'name="author" content="' + author + '"'
+        add_task "Replacing the <meta name='author'>" do
+          Changers::StringReplacer.replace! file, old: old, new: new
+        end
+      end
+
+      def replace_theme(file, theme)
+        old = 'href="css/theme/default.css" id="theme"'
+        new = 'href="css/theme/' + theme + '.css" id="theme"'
+        add_task 'Replacing the core theme' do
+          Changers::StringReplacer.replace! file, old: old, new: new
+        end
+      end
+
+      def replace_transition(file, transition)
+        old = "Reveal.getQueryHash().transition || 'default'"
+        new = "Reveal.getQueryHash().transition || '#{transition}'"
+        add_task 'Replacing the core transition' do
+          Changers::StringReplacer.replace! file, old: old, new: new
+        end
+      end
+    end
+  end
+end

data/lib/reveal-ck/builders/packaged_slides.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+
+module RevealCK
+  module Builders
+    #
+    # Public: A PackagedSlides knows how to bundle together all of the
+    # various files that makeup a reveal.js presentation.
+    #
+    class PackagedSlides < Builder
+
+      attr_reader :image_files, :tasks
+
+      def initialize(args)
+        @presentation =
+          args[:presentation] || raise(':presentation is required')
+        @image_files = args[:image_files]
+        @output_dir = args[:output_dir]
+      end
+
+      def output_dir(child = nil)
+        if child
+          File.join(@output_dir, child)
+        else
+          @output_dir
+        end
+      end
+
+      private
+
+      def register_tasks
+        @tasks = []
+        slides_html = output_dir 'slides.html'
+        create_dir output_dir
+        write_slides_html @presentation, slides_html
+        bundle_revealjs output_dir
+        bundle_image_files image_files, output_dir('images')
+        create_index_html slides_html, output_dir('index.html'), @presentation
+      end
+
+      def create_dir(dir)
+        add_task "Ensuring #{dir}/ exists" do
+          FileUtils.mkdir_p dir, verbose: false
+        end
+      end
+
+      def write_slides_html(presentation, slides_html)
+        add_task "Writing Presentation to '#{slides_html}'" do
+          File.open(slides_html, 'w') { |file| file << presentation.html }
+        end
+      end
+
+      def bundle_revealjs(output_dir)
+        add_task "Bundling up the revealjs stuff into #{output_dir}/" do
+          FileUtils.cp_r(RevealCK::REVEALJS_FILES,
+                         output_dir,
+                         verbose: false)
+        end
+      end
+
+      def bundle_image_files(image_files, image_output_dir)
+        if image_files
+          add_task "Copying in images into '#{image_output_dir}'" do
+            FileUtils.mkdir_p(image_output_dir, verbose: false)
+            FileUtils.cp_r(image_files,
+                           image_output_dir,
+                           verbose: false)
+          end
+        end
+      end
+
+      def create_index_html(slides_html, index_html, config)
+        add_task 'Creating slides/index.html' do
+          slide_builder =
+            IndexHtml.new({
+                            user_slides: slides_html,
+                            reveal_slides: index_html,
+                            config: config
+                          })
+          slide_builder.build!
+        end
+      end
+    end
+  end
+end

data/lib/reveal-ck/changers.rb

@@ -0,0 +1,3 @@
+require_relative 'changers/string_replacer'
+require_relative 'changers/slicer'
+require_relative 'changers/splicer'

data/lib/reveal-ck/changers/slicer.rb

@@ -0,0 +1,25 @@
+module RevealCK
+  module Changers
+    #
+    # Public: A Slicer knows how to remove a section of a file.
+    #
+    class Slicer
+
+      def self.remove!(slice_file, range)
+        lines = File.open(slice_file).readlines
+        slicer = Slicer.new lines
+        sliced_lines = slicer.remove range
+        File.open(slice_file, 'w') { |file| file << sliced_lines.join }
+      end
+
+      def initialize(lines)
+        @lines = lines
+      end
+
+      def remove(range)
+        @lines.select.with_index { |line, index| ! range.cover? index }
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/changers/splicer.rb

@@ -0,0 +1,37 @@
+module RevealCK
+  module Changers
+    #
+    # Public: A Splicer knows how to insert a list of lines into a file.
+    #
+    class Splicer
+
+      def initialize(lines)
+        @lines = lines
+      end
+
+      def insert(new_lines, opts)
+        index = @lines.each.with_index do |line, i|
+          break i + 1 if line.include? opts[:after]
+        end
+        @lines.insert(index, new_lines).flatten
+      end
+
+      def self.insert!(to_insert, opts)
+        to_insert_lines = readlines to_insert
+        insert_into_file = opts[:into]
+        insert_into_lines = readlines insert_into_file
+
+        splicer = Splicer.new insert_into_lines
+        spliced_lines = splicer.insert to_insert_lines, after: opts[:after]
+        File.open(insert_into_file, 'w') { |file| file << spliced_lines.join }
+      end
+
+      private
+
+      def self.readlines(file)
+        File.open(file).readlines
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/changers/string_replacer.rb

@@ -0,0 +1,18 @@
+module RevealCK
+  module Changers
+    #
+    # Public: A StringReplacer knows how to replace one string in a file
+    # with another.
+    #
+    class StringReplacer
+
+      def self.replace!(file, args)
+        old, new = args[:old], args[:new]
+        lines = File.open(file).read
+        lines = lines.sub old, new
+        File.open(file, 'w') { |file| file << lines }
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/config.rb

@@ -2,47 +2,75 @@ require 'toml'
 
 module RevealCK
   #
-  # Public: A Config knows about the core configuration values of a
-  # RevealCK Presentation: title, author, theme, etc. It knows about
-  # sensible defaults, and it can read these from a toml file.
+  # Public: The Config module supports the core metadata surrounding a
+  # RevealCK Presentation: title, author, theme, and transition.
   #
-  class Config
+  module Config
 
-    def initialize(args = {})
-      config_file = args[:config_file]
-      @config = load_config config_file
+    def author
+      @author || DEFAULTS['author']
+    end
+
+    def author=(author)
+      @author = author
     end
 
     def title
-      @config['title']
+      @title || DEFAULTS['title']
     end
 
-    def author
-      @config['author']
+    def title=(title)
+      @title = title
     end
 
     def theme
-      @config['presentation']['theme']
+      @theme || DEFAULTS['theme']
     end
 
-    private
+    def theme=(theme)
+      @theme = theme
+    end
+
+    def transition
+      @transition || DEFAULTS['transition']
+    end
+
+    def transition=(transition)
+      @transition = transition
+    end
 
     DEFAULTS = {
-      'title' => 'Slides',
-      'author' => 'Hakim El Hattab',
-      'presentation' => {
-        'theme' => 'default'
-      }
+      'title'      => 'Slides',
+      'author'     => '',
+      'theme'      => 'default',
+      'transition' => 'default'
     }
 
-    def load_config(config_file)
-      config = DEFAULTS.dup
-      if config_file && File.exists?(config_file)
-        file_config = TOML.load_file config_file
-        config.merge! file_config
+    def merge_config(args)
+      file = args[:file] || raise(':file is required')
+      config = TOML.load_file file
+
+      if config['author']
+        @author = config['author'] unless @author
+      end
+
+      if config['title']
+        @title = config['title'] unless @title
+      end
+
+      if config['presentation']
+        presentation = config['presentation']
+        if presentation['theme']
+          @theme = presentation['theme'] unless @theme
+        end
+
+        if presentation['transition']
+          @transition = presentation['transition'] unless @transition
+        end
       end
-      config
+
     end
 
   end
+
 end