hybook 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 025a0e3edbb9f098e19a14d29ed4ebb6f1781eb2
+  data.tar.gz: 449d801c54f96935679c985fc85c2efb08134069
+SHA512:
+  metadata.gz: 69439953a99d3b653817ebb0fd9d95867a089fb95ea0b0dff5b96fdc9102b1278fed945ba53f5f5672d8eb97448ca0e047409c6cf9bdfc89f59e3f191968388d
+  data.tar.gz: 6097c65f219ba93e8be0414d6fc9f47af5441115a3eb0efdfa50ab39fe7343c30020b2809bb46fb0e51a59e690427622c4e1c60ea934488fc6e7fa6ba1f802c1

data/Manifest.txt

@@ -1,11 +1,14 @@
-History.md
+HISTORY.md
 Manifest.txt
 README.md
 Rakefile
 lib/hybook.rb
+lib/hybook/builder/album.rb
+lib/hybook/builder/book.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
+lib/hybook/writer/jekyll.rb
 templates/album.md

data/Rakefile

@@ -15,10 +15,21 @@ Hoe.spec 'hybook' do
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'History.md'
+  self.history_file = 'HISTORY.md'
 
   self.licenses = ['Public Domain']
 
+  self.extra_deps = [
+    ['props'],         # settings / prop(ertie)s / env / INI
+    ['logutils'],     # logging
+    ['textutils', '>= 0.9.4'], # e.g.  >= 0.6 && <= 1.0  ## will include logutils, props
+    ['markdown'],  # markdown helper (e.g. link_to etc.)
+
+     ## 3rd party
+    ['gli', '>= 2.9'],
+    ['activesupport'] 
+  ]
+
   self.spec_extras = {
    :required_ruby_version => '>= 1.9.2'
   }

data/lib/hybook.rb

@@ -25,6 +25,16 @@ require 'hybook/type/section'
 
 require 'hybook/std/album'
 
+## builders
+
+require 'hybook/builder/book'
+require 'hybook/builder/album'
+
+## writers
+
+require 'hybook/builder/jekyll'
+
+
 
 module HyBook
 

data/lib/hybook/builder/album.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+###
+# album builder
+
+
+class AlbumBuilder
+
+  ## move create_from_code from album here
+  #   keep types "clean" e.g. only data struture
+
+end
+

data/lib/hybook/builder/book.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+###
+# book builder
+#
+#  - fix: build book structure in memory only  (and use JekyllWriter to write/render to disk!!!)
+#  -- independent of jekyll (e.g. static site compiler)
+
+#
+#
+# -- fix: use our own Page model or better Part / Section / etc. !!!!
+#  -- do NOT use TextUtils::Page --> use in writer/render when content gets mapped!!!
+
+#
+#
+#  fix: remove jekyll specific stuff
+#   -- move to jekyll writer
+
+class BookBuilder
+
+  def inline?()   @inline;    end
+  def title()     @title;     end
+  def layout()    @layout;    end
+  def pages_dir() @pages_dir; end
+
+
+  def initialize( user_pages_dir, opts={} )
+    
+    #
+    #
+    #  fix: move user_pages_dir to opts ?? or remove
+    #    only use for writer/renderer later
+    
+    @pages_dir = user_pages_dir   # add user_ to avoid conflict w/ attrib
+
+    @inline    = opts[:inline ] == true ? true : false   # all-in-one page version or multi-page?
+
+    @title     = opts[:title]  || 'Book Title Here'
+    @layout    = opts[:layout] || 'book'
+
+
+    ## if @inline create all-in-one book(.html) page
+    if inline?
+      path = "#{pages_dir}/book.md"      
+      puts "[book] create all-in-one book page (#{path})"
+
+      ## add frontmatter
+
+      page_opts = { frontmatter: {
+                       layout: layout,
+                       title:  title,
+                       permalink: '/book.html' } }
+
+      TextUtils::Page.create( path, page_opts ) do |page|
+        ## do nothing for now
+      end
+    end
+  end
+
+
+  ### fix: change to part/chapter/section/etc. ??
+
+  def page( name, opts={} )
+
+    # add fallbacks/defaults
+    opts[:title] ||= 'Page Title Here'
+    opts[:id]    ||= TextUtils.slugify( @title )   ## add page/section counter to generated fallback id/anchor
+
+    if inline?
+      path = "#{pages_dir}/book.md"
+      puts "[book] update all-in-one book page -- #{name} (#{path})"
+
+      page_opts = {}.merge( opts )  ## for now pass along all opts; no built-in/auto-added opts -- in the future add page/section counter or similar, for example?
+      TextUtils::Page.update( path, page_opts ) do |page|
+        yield( page )
+      end
+    else
+      path = "#{pages_dir}/#{name}.md"
+      puts "[book] create page #{name} (#{path})"
+
+      page_opts = { frontmatter: {
+                       layout:    layout,                 # e.g. 'book'
+                       title:     opts[:title],            # e.g. 'The Free Beer Book'
+                       permalink: "/#{opts[:id]}.html"      # e.g. '/index.html'
+                  }}
+      page_opts = page_opts.merge( opts )   ## pass along all opts
+
+      TextUtils::Page.create( path, page_opts ) do |page|
+        yield( page )
+      end
+    end
+  end
+
+end  # class BookBuilder
+

data/lib/hybook/type/album.rb

@@ -12,6 +12,11 @@ class Album
     @sections  = []      # sections (for pictures)
   end
 
+
+  ###
+  ## fix: move to album builder
+  
+
   def self.create_from_folder( root, opts={} )
     dirs = Dir[ "#{root}/**/" ]  ## get all folders n subfolder
     ## pp dirs

data/lib/hybook/version.rb

@@ -1,6 +1,4 @@
 
 module HyBook
-   VERSION = '0.0.4'
+   VERSION = '0.1.0'
 end
-
-

data/lib/hybook/writer/jekyll.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+###
+# Jekyll book writer / renderer
+
+class JekyllWriter
+  
+  ## to be done
+  ##  see BookBuilder - split code
+  ##
+
+end  # class JekyllWriter
+

metadata

@@ -1,62 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: hybook
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: props
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: textutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &20929368 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *20929368
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &20928900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.6'
   type: :development
   prerelease: false
-  version_requirements: *20928900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: hybook - hypertext book generator
 email: webslideshow@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- History.md
+- HISTORY.md
 - Manifest.txt
 - README.md
 - templates/album.md
 files:
-- History.md
+- HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/hybook.rb
+- lib/hybook/builder/album.rb
+- lib/hybook/builder/book.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
+- lib/hybook/writer/jekyll.rb
 - templates/album.md
 homepage: https://github.com/hybook/hybook
 licenses:
 - Public Domain
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -64,21 +157,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: hybook
-rubygems_version: 1.8.16
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: hybook - hypertext book generator
 test_files: []