slideshow-models 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0410851655f8b99345b952432a375cc8061fb22f
-  data.tar.gz: 4580e4340a62000f9bd0bb196516dd850a5c4c7d
+  metadata.gz: 9bff401667556357fa77a5b0053d5f8d33a61f8b
+  data.tar.gz: d07a675f210ddc960b4c41d1f772f5a986d3c404
 SHA512:
-  metadata.gz: 846cca595221a0dd9298238f2627f89bb381df10d408033eab4f3fdb0b22692693d7631c3879c8305ab7ca0ba97c0d925aceec78200c944764b21baa2e42d3c5
-  data.tar.gz: b19adf9a7a3e0c1da89087970e565c1c47c6209b560c553a616b62d777cb4a381f1503bbd7bad00cc69d9076f5b2d6274a80dc2245eff31c9fea517c5ae2acd4
+  metadata.gz: 4a941abe7d2db3333e82d49e9b8f7b4712a5f3926c2a6049ed186e06614a155366fc8e86d3aa1333cbf50e0c7d83633c8cf306186d9873e516b8ec10a1dc6d01
+  data.tar.gz: 34d10b6271177fa5d7fde0d125ead19ceabdd1aa1006296c8dae5c0ca75ca90b76d299e71ebbb25b2c732c6cced66a58b8a0685a4a5e2d25773fbf4d6d3d8db5

data/Manifest.txt

@@ -1,37 +1,45 @@
-HISTORY.md
-Manifest.txt
-README.md
-Rakefile
-config/slideshow.builtin.yml
-config/slideshow.index.yml
-config/slideshow.yml
-lib/slideshow/commands/fetch.rb
-lib/slideshow/commands/gen.rb
-lib/slideshow/commands/list.rb
-lib/slideshow/commands/plugins.rb
-lib/slideshow/commands/quick.rb
-lib/slideshow/config.rb
-lib/slideshow/filters/debug_filter.rb
-lib/slideshow/filters/headers_filter.rb
-lib/slideshow/filters/slide_filter.rb
-lib/slideshow/filters/text_filter.rb
-lib/slideshow/headers.rb
-lib/slideshow/helpers/background_helper.rb
-lib/slideshow/helpers/capture_helper.rb
-lib/slideshow/helpers/directive_helper.rb
-lib/slideshow/helpers/markdown_helper.rb
-lib/slideshow/helpers/source_helper.rb
-lib/slideshow/helpers/step_helper.rb
-lib/slideshow/helpers/syntax/coderay_helper.rb
-lib/slideshow/helpers/syntax/sh_helper.rb
-lib/slideshow/helpers/syntax/uv_helper.rb
-lib/slideshow/helpers/text_helper.rb
-lib/slideshow/manifest_helpers.rb
-lib/slideshow/markup/markdown.rb
-lib/slideshow/markup/mediawiki.rb
-lib/slideshow/markup/rest.rb
-lib/slideshow/markup/textile.rb
-lib/slideshow/models.rb
-lib/slideshow/plugin_helpers.rb
-lib/slideshow/slide.rb
-lib/slideshow/version.rb
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+config/slideshow.builtin.yml
+config/slideshow.index.yml
+config/slideshow.yml
+lib/slideshow/commands/fetch.rb
+lib/slideshow/commands/gen.rb
+lib/slideshow/commands/list.rb
+lib/slideshow/commands/plugins.rb
+lib/slideshow/commands/quick.rb
+lib/slideshow/config.rb
+lib/slideshow/drops.rb
+lib/slideshow/filters/debug_filter.rb
+lib/slideshow/filters/headers_filter.rb
+lib/slideshow/filters/slide_filter.rb
+lib/slideshow/filters/text_filter.rb
+lib/slideshow/headers.rb
+lib/slideshow/helpers/background_helper.rb
+lib/slideshow/helpers/capture_helper.rb
+lib/slideshow/helpers/directive_helper.rb
+lib/slideshow/helpers/source_helper.rb
+lib/slideshow/helpers/step_helper.rb
+lib/slideshow/helpers/syntax/coderay_helper.rb
+lib/slideshow/helpers/syntax/sh_helper.rb
+lib/slideshow/helpers/syntax/uv_helper.rb
+lib/slideshow/helpers/text_helper.rb
+lib/slideshow/manifest_helpers.rb
+lib/slideshow/markdown.rb
+lib/slideshow/models.rb
+lib/slideshow/models/deck.rb
+lib/slideshow/models/slide.rb
+lib/slideshow/opts.rb
+lib/slideshow/plugin_helpers.rb
+lib/slideshow/version.rb
+test/helper.rb
+test/samples/test.md
+test/samples/test_content_for.md
+test/templates/test/test.html
+test/templates/test/test.txt
+test/test_gen.rb
+test/test_kramdown.rb
+test/test_slide.rb
+test/test_version.rb

data/README.md

@@ -4,7 +4,7 @@
 * bugs   :: [github.com/slideshow-s9/slideshow-models/issues](https://github.com/slideshow-s9/slideshow-models/issues)
 * gem    :: [rubygems.org/gems/slideshow-models](https://rubygems.org/gems/slideshow-models)
 * rdoc   :: [rubydoc.info/gems/slideshow-models](http://rubydoc.info/gems/slideshow-models)
-* forum  :: [groups.google.com/group/webslideshow](http://groups.google.com/group/webslideshow)
+* forum  :: [groups.google.com/group/wwwmake](http://groups.google.com/group/wwwmake)
 
 ## USAGE
 
@@ -19,5 +19,6 @@ Use it as you please with no restrictions whatsoever.
 
 ## QUESTION? COMMENTS?
 
-Send them along to the [Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List](http://groups.google.com/group/webslideshow).
+Send them along to the [wwwmake forum/mailing list](http://groups.google.com/group/wwwmake).
 Thanks!
+

data/Rakefile

@@ -11,17 +11,15 @@ Hoe.spec 'slideshow-models' do
   self.urls     = ['https://github.com/slideshow-s9/slideshow-models']
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'wwwmake@googlegroups.com'
 
   self.extra_deps = [
     ['props',     '>= 1.1.2'],
     ['logutils',  '>= 0.6.1'],
-    ['markdown',  '>= 1.2.0'],
+    ['kramdown',  '>= 1.10.0'],
     ['textutils', '>= 0.10.0'],
-    ['pakman',    '>= 0.5.0'],
+    ['pakman',    '>= 0.6.0'],
     ['activesupport'],
-    ## ['wikicloth', '>= 0.8.0']  make it a soft dependency   # mediawiki markup engine
-    ## ['RedCloth','>= 4.2.9']    make it a soft dependency   # textile markup engine
   ]
 
   # switch extension to .markdown for gihub formatting

data/config/slideshow.yml

@@ -45,9 +45,15 @@ analytics:
 
 
 ########################################################3
-### text/markup (textile, markdown) processing config
+### text/markup/markdown processing config
 
 # filters to run before markup processing
+
+##
+#  check: use _ or -  (can use both?)
+#  document here (if auto-converter)
+#  note: ruby names CANNOT use dash (-) e.g. must be converted to underscore (_)
+
 filters:
   - skip-end-directive
   - directives_bang_style_to_percent_style
@@ -58,19 +64,6 @@ filters:
   - erb-rename-helper-hack
   - dump_content_to_file_debug_text_erb
   - erb
-  - code-block-curly-style
   - dump_content_to_file_debug_text
 
 
-# markup (textile, markdown, rest) config
-
-textile:
-  extnames: [ .textile, .t ]
-
-rest:
-  extnames: [ .rst, .rest ]
-
-mediawiki:
-  extnames: [ .wiki, .mediawiki, .mw ]
-
-# NB: markdown now configured in markdown.yml (using markdown gem)

data/lib/slideshow/commands/fetch.rb

@@ -4,16 +4,14 @@ module Slideshow
 
 class Fetch
 
-### fix: remove opts, use config (wrapped!!)
   
   include LogUtils::Logging
   
-  def initialize( opts, config )
-    @opts    = opts
+  def initialize( config )
     @config  = config
   end
 
-  attr_reader :opts, :config
+  attr_reader :config
 
 
   def fetch_all

data/lib/slideshow/commands/gen.rb

@@ -11,13 +11,11 @@ class Gen     ## todo: rename command to build
 
   include ManifestHelper
 
-### fix: remove opts, use config (wrapped!!)
 
-  def initialize( opts, config, headers )
-    @opts    = opts
+  def initialize( config )
     @config  = config
-    @headers = headers
-    
+    @headers = Headers.new( config )    
+
     ## todo: check if we need to use expand_path - Dir.pwd always absolute (check ~/user etc.)
     @usrdir = File.expand_path( Dir.pwd )  # save original (current) working directory 
   end
@@ -26,164 +24,41 @@ class Gen     ## todo: rename command to build
   attr_reader :srcdir, :outdir, :pakdir    # NB: "initalized" in create_slideshow
 
 
-  attr_reader :opts, :config, :headers
+  attr_reader :config, :headers
   attr_reader :session      # give helpers/plugins a session-like hash
 
-  attr_reader :markup_type  # :textile, :markdown, :mediawiki, :rest
-
-  # uses configured markup processor (textile,markdown,rest,mediawiki) to generate html
-  def text_to_html( content )
-    content = case @markup_type
-      when :markdown
-        markdown_to_html( content )
-      when :textile
-        textile_to_html( content )
-      when :mediawiki
-        mediawiki_to_html( content )
-      when :rest
-        rest_to_html( content )
-    end
-    content
-  end
  
   def guard_text( text )
-    # todo/fix 2: note for Textile we need to differentiate between blocks and inline
+    # todo/fix 2: note we need to differentiate between blocks and inline
     #   thus, to avoid runs - use guard_block (add a leading newline to avoid getting include in block that goes before)
     
     # todo/fix: remove wrap_markup; replace w/ guard_text
     #   why: text might be css, js, not just html
     
+    ###  !!!!!!!!!!!!
     ## todo: add print depreciation warning
     
     wrap_markup( text )
   end
 
-  def guard_block( text )
-    if markup_type == :textile
-      # saveguard with notextile wrapper etc./no further processing needed
-      # note: add leading newlines to avoid block-runons
-      "\n\n<notextile>\n#{text}\n</notextile>\n"
-    elsif markup_type == :markdown
-      # wrap in newlines to avoid runons
-      "\n\n#{text}\n\n"
-    elsif markup_type == :mediawiki
-      "\n\n<nowiki>\n#{text}\n</nowiki>\n"
-    else
-      text
-    end
+  def guard_block( text )   ## use/rename to guard_text_block - why? why not?
+    # wrap in newlines to avoid runons
+    "\n\n#{text}\n\n"
   end
   
-  def guard_inline( text )
+  def guard_inline( text )   ## use/rename to guard_text_inline - why? why not?
     wrap_markup( text )
   end
-  
    
   def wrap_markup( text )
-    if markup_type == :textile
-      # saveguard with notextile wrapper etc./no further processing needed
-      "<notextile>\n#{text}\n</notextile>"
-    else
-      text
-    end
-  end
-
-
-  # move into a filter??
-  def post_processing_slides( content )
-    
-    # 1) add slide breaks
-  
-    if config.slide?  # only allow !SLIDE directives fo slide breaks?
-       # do nothing (no extra automagic slide breaks wanted)
-    else  
-      if (@markup_type == :markdown && Markdown.lib == 'pandoc-ruby') || @markup_type == :rest
-        content = add_slide_directive_before_div_h1( content )
-      else
-        if config.header_level == 2
-          content = add_slide_directive_before_h2( content )
-        else # assume level 1
-          content = add_slide_directive_before_h1( content )
-        end
-      end
-    end
-
-
-    dump_content_to_file_debug_html( content )
-
-    # 2) use generic slide break processing instruction to
-    #   split content into slides
-
-    slide_counter = 0
-
-    slides       = []
-    slide_buf = ""
-     
-    content.each_line do |line|
-       if line.include?( '<!-- _S9SLIDE_' )
-          if slide_counter > 0   # found start of new slide (and, thus, end of last slide)
-            slides   << slide_buf  # add slide to slide stack
-            slide_buf = ""         # reset slide source buffer
-          else  # slide_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 slide_buf.gsub(/<!--.*?-->/m, '').gsub( /[\n\r\t ]/, '').length > 0
-              logger.debug "add slide with missing leading slide directive >#{slide_buf}< with slide_counter == 0"
-              slides    << slide_buf
-              slide_buf = ""
-            else
-              logger.debug "skipping slide_buf >#{slide_buf}< with slide_counter == 0"
-            end
-          end
-          slide_counter += 1
-       end
-       slide_buf  << line
-    end
-  
-    if slide_counter > 0
-      slides   << slide_buf     # add slide to slide stack
-      slide_buf = ""            # reset slide source buffer 
-    end
-
-
-    slides2 = []
-    slides.each do |source|
-      slides2 << Slide.new( source, config )
-    end
-
-
-    puts "#{slides2.size} slides found:"
-    
-    slides2.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
-   
-   
-    # make content2 and slide2 available to erb template
-    # -- todo: cleanup variable names and use attr_readers for content and slide
-
-    ### fix: use class SlideDeck or Deck?? for slides array?
-    
-    content2 = ""
-    slides2.each do |slide|
-      content2 << slide.to_classic_html
-    end
-  
-    @content  = content2
-    @slides   = slides2     # strutured content
+    # saveguard with wrapper etc./no further processing needed - check how to do in markdown
+    text
   end
 
 
   def create_slideshow( fn )
 
-    manifest_path_or_name = opts.manifest
+    manifest_path_or_name = config.manifest
     
     # add .txt file extension if missing (for convenience)
     if manifest_path_or_name.downcase.ends_with?( '.txt' ) == false
@@ -216,7 +91,7 @@ class Gen     ## todo: rename command to build
     manifestsrc = File.expand_path( manifestsrc, usrdir )
 
     # expand output path in current dir and make sure output path exists
-    @outdir = File.expand_path( opts.output_path, usrdir )
+    @outdir = File.expand_path( config.output_path, usrdir )
     logger.debug "setting outdir to >#{outdir}<"
     FileUtils.makedirs( outdir ) unless File.directory? outdir
 
@@ -238,16 +113,9 @@ class Gen     ## todo: rename command to build
 
     puts "Preparing slideshow '#{basename}'..."
    
-  if config.known_textile_extnames.include?( extname )
-    @markup_type = :textile
-  elsif config.known_rest_extnames.include?( extname )
-    @markup_type = :rest
-  elsif config.known_mediawiki_extnames.include?( extname )
-    @markup_type = :mediawiki
-  else  # default/fallback use markdown
-    @markup_type = :markdown
-  end
-  
+  ###  todo/fix:
+  ##  reset headers too - why? why not?
+     
   # shared variables for templates (binding)
   @content_for = {}  # reset content_for hash
 
@@ -266,6 +134,7 @@ class Gen     ## todo: rename command to build
   
   config.text_filters.each do |filter|
     mn = filter.tr( '-', '_' ).to_sym  # construct method name (mn)
+    puts "  run filter #{mn}..."
     content = send( mn, content )   # call filter e.g.  include_helper_hack( content )  
   end
 
@@ -277,20 +146,17 @@ class Gen     ## todo: rename command to build
 
   # convert light-weight markup to hypertext
 
-  content = text_to_html( content )
+  content = markdown_to_html( content )
+
 
   # post-processing
+  deck = Deck.new( content, header_level: config.header_level,
+                            use_slide:    config.slide? )
 
-  # make content2 and slide2 available to erb template
-    # -- todo: cleanup variable names and use attr_readers for content and slide
-  
-  if @markup_type == :markdown && config.markdown_post_processing?( Markdown.lib ) == false
-    puts "  Skipping post-processing (passing content through as is)..."
-    @content = content  # content all-in-one - make it available in erb templates
-  else
-    # sets @content (all-in-one string) and @slides (structured content; split into slides)
-    post_processing_slides( content )
-  end
+
+  ### todo/fix: move merge to its own
+  ##     class e.g. commands/merge.rb or something
+  ##     or use Merger - why? why not?
 
 
   #### pak merge
@@ -310,7 +176,37 @@ class Gen     ## todo: rename command to build
 
   logger.debug( "manifestsrc >#{manifestsrc}<, pakpath >#{pakpath}<" )
 
-  Pakman::Templater.new.merge_pak( manifestsrc, pakpath, binding, basename )
+  ###########################################
+  ## fix: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+  ## todo: setup hash for binding
+  ctx = { 'name'    => @name,
+          'headers' => HeadersDrop.new( @headers ), 
+          'content' => deck.content,
+          'slides'  => deck.slides.map { |slide| SlideDrop.new(slide) },  # strutured content - use LiquidDrop - why? why not?
+          ## todo/fix: add content_for hash
+          ## and some more -- ??
+        }
+  
+  ## add content_for entries e.g.
+  ##    content_for :js  =>  more_content_for_js or content_for_js or extra_js etc.
+  ##  for now allow all three aliases
+
+  puts "content_for:"
+  pp @content_for
+
+  @content_for.each do |k,v|
+    puts "  (auto-)add content_for >#{k.to_s}< to ctx:"
+    puts v
+    ctx[ "more_content_for_#{k}"] = v
+    ctx[ "content_for_#{k}" ] = v
+    ctx[ "extra_#{k}" ] = v
+  end
+  
+  puts "ctx:"
+  pp ctx
+
+
+  Pakman::LiquidTemplater.new.merge_pak( manifestsrc, pakpath, ctx, basename )
 
   logger.debug "restoring cwd to src - new >#{srcdir}<, old >#{Dir.pwd}<"
   Dir.chdir( srcdir )