slideshow-models 2.5.0 → 3.0.0

data/lib/slideshow/models/deck.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+
+module Slideshow
+
+
+module DeckFilter
+
+# add slide directive before h1 (tells slideshow gem where to break slides)
+#
+# e.g. changes:
+# <h1 id='optional' class='optional'>
+#  to
+#  html comment -> _S9SLIDE_ (note: rdoc can't handle html comments?) 
+# <h1 id='optional' class='optional'>
+
+def add_slide_directive_before_h1( content )
+
+  # mark h1 for getting wrapped into slide divs
+  # note: use just <h1 since some processors add ids e.g. <h1 id='x'>
+
+  slide_count = 0
+
+  content = content.gsub( /<h1/ ) do |match|
+    slide_count += 1
+    "\n<!-- _S9SLIDE_ -->\n#{Regexp.last_match(0)}"
+  end
+  
+  puts "  Adding #{slide_count} slide breaks (using h1 rule)..."
+  
+  content
+end
+
+def add_slide_directive_before_h2( content )
+
+  slide_count = 0
+
+  content = content.gsub( /<h2/ ) do |match|
+    slide_count += 1
+    "\n<!-- _S9SLIDE_ -->\n#{Regexp.last_match(0)}"
+  end
+  
+  puts "  Adding #{slide_count} slide breaks (using h2 rule)..."
+  
+  content
+end
+
+
+
+# add slide directive before div h1 (for pandoc-generated html)
+#
+# e.g. changes:
+# <div id='header'>
+# <h1 id='optional' class='optional'>
+#  to
+#  html comment -> _S9SLIDE_ 
+# <div id='header'>
+# <h1 id='optional' class='optional'>
+
+
+def add_slide_directive_before_div_h1( content )
+
+  slide_count = 0
+
+  content = content.gsub( /<div[^>]*>\s*<h1/ ) do |match|
+    slide_count += 1
+    "\n<!-- _S9SLIDE_ -->\n#{Regexp.last_match(0)}" 
+  end
+
+  puts "  Adding #{slide_count} slide breaks (using div_h1 rule)..."
+
+  content
+end
+    
+end # module DeckFilter
+
+
+
+class Deck
+
+  include LogUtils::Logging
+  include DeckFilter     # e.g. add_slide_directive_before_h1
+
+
+  attr_accessor :content     ## all-in-one content (that is, incl. all slides )
+  attr_accessor :slides
+  
+
+  def initialize( source, header_level: 1, use_slide: false )
+    @source = source  ## keep a copy of the original source (input)
+
+    @header_level = header_level   # e.g. 1 or 2   -- todo/fix: allow more options e.g. 1..2 etc.
+    @use_slide    = use_slide      # e.g. opts.slide? -- only allow !SLIDE directives fo slide breaks?
+
+    @slides  = []
+    @content = ''  # note: gets (re)build from slides in parse 
+
+    parse()
+  end
+
+
+  def parse
+    #############################
+    # step 1 - add slide breaks
+  
+    @content = @source
+  
+    if @use_slide  # only allow !SLIDE directives fo slide breaks?
+       # do nothing (no extra automagic slide breaks wanted)
+    else  
+      if @header_level == 2
+        @content = add_slide_directive_before_h2( @content )
+      else # assume level 1
+        @content = add_slide_directive_before_h1( @content )
+      end
+    end
+
+
+    ### todo/fix: add back dump to file (requires @name and outpath !!!!)
+    ### dump_content_to_file_debug_html( content )
+
+
+    #############################################################
+    # step 2 -  use generic slide break processing instruction to
+    #   split content into slides
+
+    counter = 0
+    chunks = []
+    buf = ""
+
+     
+    @content.each_line do |line|
+       if line.include?( '<!-- _S9SLIDE_' ) || line.include?( '<!-- @SLIDE' )  ## add new format  
+          if counter > 0   # found start of new slide (and, thus, end of last slide)
+            chunks << buf  # add slide to slide stack
+            buf = ""         # reset slide source buffer
+          else  # counter == 0
+            # check for first slide with missing leading SLIDE directive (possible/allowed in takahashi, for example)
+            ##  remove html comments and whitspaces (still any content?)
+            ### more than just whitespace? assume its  a slide
+            if buf.gsub(/<!--.*?-->/m, '').gsub( /[\n\r\t ]/, '').length > 0
+              logger.debug "add slide with missing leading slide directive >#{buf}< with slide_counter == 0"
+              chunks << buf
+              buf = ""
+            else
+              logger.debug "** note: skipping slide >#{buf}< with counter == 0"
+            end
+          end
+          counter += 1
+       end
+       buf << line
+    end
+  
+    if counter > 0
+      chunks << buf     # add slide to slide stack
+      buf = ""            # reset slide source buffer 
+    end
+
+
+    @slides = []
+    chunks.each do |chunk|
+      @slides << Slide.new( chunk, header_level: @header_level )
+    end
+
+
+    puts "#{@slides.size} slides found:"
+    
+    @slides.each_with_index do |slide,i|
+      print "  [#{i+1}] "
+      if slide.header.present?
+        print slide.header
+      else
+        # remove html comments
+        print "-- no header -- | #{slide.content.gsub(/<!--.*?-->/m, '').gsub(/\n/,'$')[0..40]}"
+      end
+      puts
+    end
+
+    ## rebuild all-in-one content (incl. all slides)       
+    @content = ""
+    @slides.each do |slide|
+      @content << slide.to_classic_html
+    end  
+  end  # method parse
+
+
+end # class Deck
+
+end # class Slideshow

data/lib/slideshow/{slide.rb → models/slide.rb}

@@ -4,7 +4,7 @@ module Slideshow
 
   class Slide
 
-    attr_accessor :logger
+    include LogUtils::Logging
 
     # NB: unparsed html source (use content_without_header
     #  for content without option header)
@@ -14,9 +14,12 @@ module Slideshow
     attr_accessor :header
     attr_accessor :classes
   
-    def initialize( content, options )
-      @logger       = options.logger
-      @header_level = options.header_level
+     
+    ### def to_drop() SlideDrop.new( self ); end  -- add - why? why not??
+  
+    def initialize( content, header_level: 1 )
+      ## options
+      @header_level = header_level
       
       @content = content
       
@@ -82,6 +85,8 @@ module Slideshow
 
 
     def data_attributes
+      return nil if @data.empty?   ## note: return nil for empty hash
+      
       buf = ""
       @data.each do | key,value |
         buf << "data-#{key}='#{value}' "

data/lib/slideshow/opts.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+module Slideshow
+
+
+class Opts
+
+  def header_level=(value)
+    @header_level = value.to_i
+  end
+  
+  def header_level
+    ## todo: check   0 is not nil?
+    @header_level || 1
+  end
+
+  def slide=(boolean)
+    @slide = boolean
+  end
+
+  def slide?
+    return false if @slide.nil?   # default slide flag is false
+    @slide == true
+  end
+
+  def takahashi=(boolean)
+    @takahashi = boolean
+  end
+
+  def takahashi?
+    return false if @takahashi.nil?   # default takahashi flag is false
+    @takahashi == true
+  end
+
+  def verbose=(boolean)   # add: alias for debug ??
+    @verbose = boolean
+  end
+  
+  def verbose?
+    return false if @verbose.nil?   # default verbose/debug flag is false
+    @verbose == true
+  end
+
+
+  def test=(boolean)
+    @test = boolean
+  end
+
+  def test?
+    return false if @test.nil?   # default verbose/debug flag is false
+    @test == true
+  end
+
+
+  def quick_manifest=(value)
+    @quick_manifest = value
+  end
+  
+  def quick_manifest
+    @quick_manifest || 'welcome'
+  end
+
+
+
+  def fetch_all=(boolean)
+    @fetch_all = boolean
+  end
+
+  def fetch_all?
+    return false if @fetch_all.nil?  # default fetch all flag is false
+    @fetch_all == true
+  end
+
+
+
+  def includes=(value)
+    @includes = value
+  end
+
+  def includes
+    # fix: use os-agnostic delimiter (use : for Mac/Unix?)
+    @includes.nil? ? [] : @includes.split( ';' )
+  end
+  
+  def has_includes?
+    @includes.nil? ? false : true
+  end
+
+
+  def manifest=(value)
+    @manifest = value
+  end
+    
+  def manifest
+    @manifest || 's6'
+  end
+
+
+  def config_path=(value)
+    @config_path = value
+  end
+    
+  def config_path
+    @config_path || File.join( Env.home, '.slideshow' )
+  end
+
+  def output_path=(value)
+    @output_path = value
+  end
+
+  def output_path
+    @output_path || '.'
+  end
+
+end # class Opts
+
+end # module Slideshow

data/lib/slideshow/version.rb

@@ -2,8 +2,8 @@
 
 module Slideshow
 
-  MAJOR = 2
-  MINOR = 5
+  MAJOR = 3
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'slideshow/models'
+

data/test/samples/test.md

@@ -0,0 +1,29 @@
+title: test title
+author: test author
+
+
+# test header 1
+
+test content 1
+
+
+# test header 2
+
+test content 2
+
+
+# test header 3
+
+test content 3 with some code
+
+```
+puts 'hello'
+```
+
+# test header 4
+
+test content 4 with syntax highlighter
+
+```ruby
+puts 'hello'
+```

data/test/samples/test_content_for.md

@@ -0,0 +1,25 @@
+title: test title
+author: test author
+
+
+<% content_for :css do %>
+  body { color: red}
+<% end %>
+
+<% content_for :js do %>
+   console.log( "hello, js" )
+<% end %>
+
+
+# test header 1
+
+test content 1
+
+<% content_for :css do %>
+    .slide1 { color: green }
+<% end %>
+
+
+# test header 2
+
+test content 2

data/test/templates/test/test.html

@@ -0,0 +1,52 @@
+---
+---
+
+<html>
+  <head>
+    <title>pakman Test Template</title>
+    {{ more_content_for_head }}
+    
+    <style>
+       {{ more_content_for_css }}
+       {{ content_for_css }}
+       {{ extra_css }}
+    </style>
+  </head>
+  <body>
+    
+   <h1>Hello pakman</h1>    
+
+   <h3>Headers</h3>
+   
+   <ul>
+    <li>author: {{ headers.author }}</li>
+    <li>title:  {{ headers.title }}</li>
+    <li>email:  {{ headers.email }}</li>
+    <li>footer:     {{ headers.footer }}</li>
+    <li>subfooter:  {{ headers.subfooter }}</li>
+    <li>authorxxx: {{ headers.authorxxx }}</li>  <!-- check missing keys too -->
+   </ul>
+
+  <ul>
+    <li>author: {{ headers['author'] }}</li>
+    <li>title:  {{ headers['title'] }}</li>
+    <li>authorxxx: {{ headers['authorxxx'] }}</li>  <!-- check missing keys too -->
+  </ul>
+
+  <h3>Slides</h3>   
+      
+   {% for slide in slides %}
+     <div>{{ slide.header }}</div>       
+     <div>{{ slide.content_without_header }}</div>
+   {% endfor %}
+    
+   <!-- begin (all-in-one) content -->
+     {{ content }}
+   <!-- end (all-in-one) content -->
+
+    <script>
+       {{ more_content_for_js }}
+    </script>
+    
+  </body>
+</html>