hybook 0.0.1 → 0.0.2

data/Manifest.txt

@@ -3,4 +3,9 @@ Manifest.txt
 README.md
 Rakefile
 lib/hybook.rb
+lib/hybook/std/album.rb
+lib/hybook/type/album.rb
+lib/hybook/type/picture.rb
+lib/hybook/type/section.rb
 lib/hybook/version.rb
+templates/album.md

data/README.md

@@ -1,26 +1,114 @@
-# hybook
+# hybook - Hyper Book (H8)
 
 hybook gem - hypertext book generator
 
-* home  :: [github.com/rubylibs/hybook](https://github.com/rubylibs/hybook)
-* bugs  :: [github.com/rubylibs/hybook/issues](https://github.com/rubylibs/hybook/issues)
+* home  :: [github.com/hybook/hybook](https://github.com/hybook/hybook)
+* bugs  :: [github.com/hybook/hybook/issues](https://github.com/hybook/hybook/issues)
 * gem   :: [rubygems.org/gems/hybook](https://rubygems.org/gems/hybook)
 * rdoc  :: [rubydoc.info/gems/hybook](http://rubydoc.info/gems/hybook)
 
+
 ## Usage
 
-TBD
+Hyper Book (H8) generates pages from plain text wiki-style templates
+for a hypertext book in two versions,
+that is, a single-page version and a multi-page version.
+
+
+## Goals
+
+- Hyper Book offers book models / structs
+(e.g. Book, Part, Chapter, Appendix)
+and types
+(Album, Slide Show, etc.).
+
+- Hyper Book offers template packs and plugins.
+
+- Hyper Book offers a template pack and plugin manager
+(e.g. `hybook install almanac`, `hybook install table`, etc.).
+
+
+
+## Non-Goals
+
+- Hyper Book is **NOT** a static site generator / server.
+  => Use your static site generator of choice (e.g. Jekyll and friends)
+  to convert the generated pages into a complete hypertext book or web site.
+
+- Hyper Book is **NOT** a HTML to PDF converter.
+  => Use your HTML to PDF converter of choice (e.g. print ot PDF, `wkhtmltopdf`, etc.).
+
+- Hyper Book is **NOT** a EPUB generator or checker.
+  => Use your EPUB generator or checker of choice.
+
+- Hyper Book is **NOT** a MOBI generator.
+  => Use your MOBI generator of choice (e.g. `kindlegen`, etc.).
+
+
+
+## Building Blocks
+
+- [`textutils` gem](https://github.com/rubylibs/textutils) -- Text filters n helpers
+- [`markdown` gem](https://github.com/rubylibs/markdown) -- Markdown helpers
+- [`pakman` gem](https://github.com/rubylibs/pakman)  -- Template Pack(age) manager
+- [`props` gem](https://github.com/rubylibs/props) -- Setting Hierachies (Commandline, User, Home, Defaults, etc.)
+
+
+<!-- more -->
+
+- Jekyll -- static site generator
+- `kramdown` -- Markdown converter
+
+
+## Hypertext Markup (HTML) to PDF Conversion Options
+
+- Use Google Chrome (Print to PDF)
+- `wkhtmltopdf`
+- `phantom.js` Renderer
+
+
+## Real World Book Examples
+
+- [The Free World Football Almanac](https://github.com/openfootball/book)
+- [The Free World Beer Book](https://github.com/openbeer/book)
+- [The Free World Fact Book](https://github.com/openmundi/book)
+
 
 ## Alternatives
 
-### EPub, Mobi Kindle Book Generator
+### EPUB, MOBI (Kindle) Book Generator
 
-- [Kitabu](https://github.com/fnando/kitabu)
-- [Bookshop](https://github.com/blueheadpublishing/bookshop)
+#### Ruby
 
+- [kitabu gem](https://github.com/fnando/kitabu)  - EPUB, MOBI, PDF
+- [bookshop gem](https://github.com/blueheadpublishing/bookshop)  - EPUB, MOBI, PDF
+- [eeepub, eeepub-with-cover-support ](https://github.com/jugyo/eeepub) - by jugyo
+- [git-scribe](https://github.com/schacon/git-scribe) - by Scott Chacon (aka schacon)
+- [review](https://github.com/kmuto/review) - by Kenshi Muto (aka kmuto)
+- [gepub](https://github.com/skoji/gepub) - by Satoshi Kojima (aka skoji)
+- [peregrin](https://github.com/joseph/peregrin) - by Joseph Pearson
+
+<!-- experimental
+  -->
+
+- [bookie gem](https://github.com/sandal/bookie) - by Gregory Brown (aka sandal); experimental
+- [penny](https://github.com/peterc/penny) - by Peter Cooper (aka peterc); experimental
+- [eeepub3](https://github.com/bubaz/eeepub3) - by Sergey (aka bubaz)
+
+
+#### Haskell
+
+- [Pandoc](http://johnmacfarlane.net/pandoc)
 
 
 ## License
 
 The `hybook` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
+
+
+## Questions? 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).
+Thanks!

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'hybook' do
 
   self.version = HyBook::VERSION
 
-  self.summary = 'hybook - hypertext boook generator'
+  self.summary = 'hybook - hypertext book generator'
   self.description = summary
 
   self.urls    = ['https://github.com/hybook/hybook']
@@ -23,5 +23,4 @@ Hoe.spec 'hybook' do
    :required_ruby_version => '>= 1.9.2'
   }
 
-
 end

data/lib/hybook/std/album.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module HyBook
+  module AlbumHelper
+
+    def render_pictures( pics, opts )
+      buf = ''
+      buf << 'I '      # NOTE: cannot use | used by markdown for tables (or just escape???)
+      pics.each do |pic|
+        buf << render_picture( pic, opts )
+        buf << ' I '
+      end
+      buf
+    end
+
+    def render_picture( pic, opts )
+
+      ## FIX: add pics_root or assets_root or similar as opt !!!!!!!
+      ##   do NOT hard code
+
+      size = opts[:size]
+      ## puts "[picture] size=#{size}"    # NOTE: opts[:size] required for now!!!
+
+      extname      = File.extname( pic.path )
+      basename_in  = File.basename( pic.path, extname )   # NB: remove extname (that is, suffix e.g. .png,.jpg,.gif etc.)
+
+      # strip leading 1-west-  (optional for organizing logos)
+      #  e.g. 3-west-austrias  becomes austrias
+      basename_out = basename_in.gsub( /[0-9a-z]+-/, '' )
+
+      ## puts "path: #{path}, basename_in: #{basename_in}, basename_out: #{basename_out}, extname: #{extname}"
+
+      path  = "vendor/assets/images/logos/#{size}x#{size}/#{basename_out}.png"
+
+      buf = ''
+      buf << "_#{pic.title}_{: .key} "
+      buf << "![#{pic.title}](#{path})"
+      buf
+    end
+
+    def render_album( album, opts )
+      ###
+      ## TODO/FIX:
+      ##  use TextUtils::PageTemplate.read( path ).render( binding ) - one line
+
+      tmpl = File.read_utf8( "#{HyBook.templates_path}/album.md" )
+      TextUtils::PageTemplate.new( tmpl ).render( binding )
+    end
+
+  end # module AblumHelper
+
+
+  # make helpers available as class methods for now e.g. HyBook.render_album etc.
+  extend AlbumHelper
+end # module HyBook

data/lib/hybook/type/album.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module HyBook
+
+
+class Album
+  attr_accessor :title
+  attr_accessor :sections
+
+  def initialize( title )
+    @title      = title
+    @sections  = []      # sections (for pictures)
+  end
+
+  def self.create_from_folder( root, opts={} )
+    dirs = Dir[ "#{root}/**/" ]  ## get all folders n subfolder
+    ## pp dirs
+
+    title = opts[:title ] || 'Untitled'
+
+    album = Album.new( title )
+
+    dirs.each do |dir|
+      section_title =  dir[ root.length+1..-2 ]  # cut off ROOT_DIR plus leading and trailing /
+      files = Dir[ "#{dir}/*.{png,gif,jpg}" ]
+
+      ## fix: use logger
+      puts "dir: #{dir}, title: #{section_title}, files: #{files.size}"
+      next if files.size == 0   # skip if no image files in folder
+    
+      section = Section.new( section_title )
+      album.sections << section
+
+      ## puts "files:"
+      ## pp files
+
+      files.each do |filename|
+        extname      = File.extname( filename )
+        basename     = File.basename( filename, extname )   # NB: remove extname (that is, suffix e.g. .png,.jpg,.gif etc.)
+
+        picture_title = basename   # use basename
+        picture_path  = filename   # TODO/FIX: strip off leading root path ?? why? why not???
+        ### rename path to source or src or file or filename - why? why not??
+
+
+        picture = Picture.new( picture_title, picture_path )
+        section.pictures << picture
+      end
+    end
+    album   # return album struct
+  end
+
+
+end  # class Album
+
+
+end # module HyBook

data/lib/hybook/type/picture.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module HyBook
+
+
+class Picture
+  attr_accessor :title
+  attr_accessor :path
+
+  def initialize( title, path )
+    @title      = title
+    @path       = path
+  end
+end
+
+
+end # module HyBook

data/lib/hybook/type/section.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module HyBook
+
+
+class Section
+  attr_accessor :title
+  attr_accessor :pictures
+  
+  def initialize( title )
+    @title      = title
+    @pictures   = []  # pictures (images/logos/etec.)
+  end
+end
+
+
+end # module HyBook

data/lib/hybook/version.rb

@@ -1,6 +1,6 @@
 
 module HyBook
-   VERSION = '0.0.1'
+   VERSION = '0.0.2'
 end
 
 

data/lib/hybook.rb

@@ -1,7 +1,30 @@
 
+############
+# stdlibs
+
+require 'pp'
+
+
+###################
+# 3rd party libs
+
+require 'textutils'
+
+
+####################3
+# our own code
 
 require 'hybook/version'  # let it always go first
 
+require 'hybook/type/album'
+require 'hybook/type/picture'
+require 'hybook/type/section'
+
+##############################################
+# builtin std helpers, renderers n builders
+
+require 'hybook/std/album'
+
 
 module HyBook
 
@@ -12,9 +35,15 @@ module HyBook
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
   end
+  
+  def self.templates_path
+    "#{root}/templates"
+  end
 
 end  # module HyBook
 
 
 puts HyBook.banner    # say hello
+puts "[hybook] root: #{HyBook.root}"
+puts "[hybook] templates_path: #{HyBook.templates_path}"
 

data/templates/album.md

@@ -0,0 +1,9 @@
+
+## {{ album.title }}
+
+{% album.sections.each do |section| %}
+
+#### {{ section.title }} ({{ section.pictures.size }})
+
+  {{ render_pictures( section.pictures, opts ) }}
+{% end %}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hybook
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21243936 !ruby/object:Gem::Requirement
+  requirement: &21453732 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *21243936
+  version_requirements: *21453732
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &21243576 !ruby/object:Gem::Requirement
+  requirement: &21453348 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,8 +32,8 @@ dependencies:
         version: '3.7'
   type: :development
   prerelease: false
-  version_requirements: *21243576
-description: hybook - hypertext boook generator
+  version_requirements: *21453348
+description: hybook - hypertext book generator
 email: webslideshow@googlegroups.com
 executables: []
 extensions: []
@@ -41,13 +41,19 @@ extra_rdoc_files:
 - History.md
 - Manifest.txt
 - README.md
+- templates/album.md
 files:
 - History.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/hybook.rb
+- lib/hybook/std/album.rb
+- lib/hybook/type/album.rb
+- lib/hybook/type/picture.rb
+- lib/hybook/type/section.rb
 - lib/hybook/version.rb
+- templates/album.md
 homepage: https://github.com/hybook/hybook
 licenses:
 - Public Domain
@@ -74,5 +80,5 @@ rubyforge_project: hybook
 rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: hybook - hypertext boook generator
+summary: hybook - hypertext book generator
 test_files: []