hybook 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e90a3a0d5c586e8cd229e3ff2f485af396906bef
-  data.tar.gz: 5fd830e2d1218185f9b6f58feb8ad80c092dce97
+  metadata.gz: 9b878421b3474bc82e8586c68f84d4c34adaf5e2
+  data.tar.gz: de54ebb90f480d931d0fb35ad258c153bbd5a242
 SHA512:
-  metadata.gz: b38c2dcffbfd5da0d90351bdca66bc884c5f4ffb7274f851b39d0901295f383d6099146e14291dc6209cf43fb80d992e2dbbc4478da30c7c618f506358f3d9b8
-  data.tar.gz: 1176109a861ca40a4654c1f962f5cf442070deea84c4fc16fcee461ca81fe4f4e2fef50e21f1a8cd91ccb6dfeef6f9b7ece40f468bdc9a1ebb11adef4392a2fe
+  metadata.gz: 1bb70427653c97cdf8713b007dd361dae41fd1263ac7541bbfa4ff7d38765fa0bc7608cee5c356ace22acb2e93ccdf389a0449c235803943ee209102ae14868e
+  data.tar.gz: 05ecd1f22fd8fb07bb1af99e7848fed44a3355f31f3068cb38dbe28d0486dfa42197d4365d30f5344c06d9657782dc113e7b6d0ab05a93b14a106097643d7c51

data/Manifest.txt

@@ -5,6 +5,13 @@ Rakefile
 lib/hybook.rb
 lib/hybook/builder/album.rb
 lib/hybook/builder/book.rb
+lib/hybook/helpers/markdown.rb
+lib/hybook/helpers/misc.rb
+lib/hybook/press/beer.rb
+lib/hybook/press/config.rb
+lib/hybook/press/football.rb
+lib/hybook/press/press.rb
+lib/hybook/press/world.rb
 lib/hybook/std/album.rb
 lib/hybook/type/album.rb
 lib/hybook/type/picture.rb

data/Rakefile

@@ -3,7 +3,7 @@ require './lib/hybook/version.rb'
 
 Hoe.spec 'hybook' do
 
-  self.version = HyBook::VERSION
+  self.version = Hybook::VERSION
 
   self.summary = 'hybook - hypertext book generator'
   self.description = summary
@@ -24,6 +24,8 @@ Hoe.spec 'hybook' do
     ['logutils'],     # logging
     ['textutils'],    # e.g.  >= 0.6 && <= 1.0  ## will include logutils, props
     ['markdown'],  # markdown helper (e.g. link_to etc.)
+    ['bookfile'],   ## used by (book)press
+    ['datafile'],   ## used by (book)press
 
     ## 3rd party
     ['gli'],

data/lib/hybook.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 
 ############
 # stdlibs
@@ -11,7 +13,7 @@ require 'pp'
 require 'textutils'
 
 
-####################3
+#####################
 # our own code
 
 require 'hybook/version'  # let it always go first
@@ -24,6 +26,8 @@ require 'hybook/type/section'
 # builtin std helpers, renderers n builders
 
 require 'hybook/std/album'
+require 'hybook/helpers/markdown'
+require 'hybook/helpers/misc'
 
 ## builders
 
@@ -34,26 +38,20 @@ require 'hybook/builder/album'
 
 require 'hybook/writer/jekyll'
 
+## (book)press
+require 'hybook/press/press'
+require 'hybook/press/config'
+require 'hybook/press/world'
+require 'hybook/press/football'
+require 'hybook/press/beer'
 
 
-module HyBook
-
-  def self.banner
-    "hybook #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-  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}"
 
+# say hello
+if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)
+  puts Hybook.banner
+  puts "[hybook] root: #{Hybook.root}"
+  puts "[hybook] templates_path: #{Hybook.templates_path}"
+end

data/lib/hybook/helpers/markdown.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+
+###
+## todo: change to Hybook::MarkdownHelper -- why, why not????
+
+
+module HybookHelper
+
+###########################
+# markdown helpers
+
+###
+#  fix: move to Markdown gem
+#   add to new module
+#  MarkdownHelper or Markdown::Helper ???
+
+
+def link_to( title, link )
+  "[#{title}](#{link})"
+end
+
+
+def columns_begin( opts={} )
+  # note: will add  columns2 or columns3 etc. depending on columns option passed in
+
+  ## note: default was 2 (columns) for world.db, 300 (px) for beer.db
+  columns = opts[:columns] || 300
+
+  "\n<div class='columns#{columns}' markdown='1'>\n\n"
+end
+
+def columns_end
+  "\n</div>\n\n"
+end
+
+### todo: check if we can use columns simply w/ yield for body ??
+
+
+end # module HybookHelper

data/lib/hybook/helpers/misc.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+###
+## todo: change to Hybook::NumberHelper  - why? why not??
+
+module HybookHelper
+
+### todo:
+##  add to textutils ?? why? why not??
+def number_with_delimiter( num )
+  delimiter = '.'
+  num.to_s.reverse.gsub( /(\d{3})(?=\d)/, "\\1#{delimiter}").reverse
+end
+
+
+end # module HybookHelper

data/lib/hybook/press/beer.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Hybook
+
+  class BeerConfig < Config
+
+    def initialize( hash ) super; end
+
+    def collection() 'beer'; end
+
+    ############
+    # Bookfile
+    # -- remote
+    def bookfile_url()
+      ## note: for now always return beer.rb
+      ##   use setup/layout-specific bookfiles??   allow selection of package,how?? why,why not??
+      "http://github.com/book-templates/bookfile/raw/master/beer.rb"
+    end
+
+    ########
+    # Datafile
+    # -- remote
+    def datafile_url() "http://github.com/openbeer/datafile/raw/master/#{setup}.rb"; end
+
+    #######
+    # Database
+    def db_path() "#{build_dir}/#{collection}/#{setup}/#{collection}.db"; end
+    def create_db!()  BeerDb.create_all;  end
+
+    ####
+    # Book Templates
+    ## rename to book_dir ?? why, why not? - split zip into book_dir and book_templates_dir why? why not?
+    def book_templates_unzip_dir()  "#{build_dir}/#{collection}/#{setup}/book";  end
+
+  end # class BeerConfig
+
+
+  class BookPress
+    def self.create_beer_book_for( setup, opts={} )
+      config = BeerConfig.new( setup: setup )
+      BookPress.new( config )
+    end
+  end  # class BookPress
+
+end # module Hybook

data/lib/hybook/press/config.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Hybook
+
+  class Config
+
+    def initialize( hash )
+      @hash = hash
+
+### add source_url  e.g. https://github.com ?? - why, why not???
+
+      @build_dir  = hash[:build_dir] || './build'  ## note: defaults to ./build
+      @setup      = hash[:setup]
+    end
+
+    def build_dir()  @build_dir;   end
+    def setup()      @setup;       end   ## e.g. at, franken, worldcup, etc.
+
+    ######
+    # Datafile
+    # -- local
+    def datafile_dir()  "#{build_dir}/#{collection}/#{setup}";  end
+    def datafile_path() "#{datafile_dir}/Datafile";  end
+
+    ######
+    # Bookfile    -- allow multiple (more than one) bookfiles - how? why, why not???
+    # -- local
+    #
+    # todo: move bookfile_dir to unzip dir (e.g. move Bookfile into /book) - why, why not???
+    def bookfile_dir()  "#{build_dir}/#{collection}/#{setup}";  end
+    def bookfile_path() "#{bookfile_dir}/Bookfile";  end
+  end
+
+end # module Hybook
+

data/lib/hybook/press/football.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Hybook
+
+  class FootballConfig < Config
+
+    def initialize( hash ) super; end
+
+    def collection() 'football'; end
+
+    ########
+    # Datafile
+    # -- remote
+    def datafile_url() "http://github.com/openfootball/datafile/raw/master/#{setup}.rb"; end
+
+    #######
+    # Database
+    def db_path() "#{build_dir}/#{collection}/#{setup}/#{collection}.db"; end
+
+    def create_db!()
+      SportDb.create_all
+      SportDb.read_builtin   ## note: load built-in datasets (e.g. seasons etc.)
+    end
+
+    ####
+    # Book Templates
+    ## rename to book_dir ?? why, why not? - split zip into book_dir and book_templates_dir why? why not?
+    def book_templates_unzip_dir()  "#{build_dir}/#{collection}/#{setup}/book";  end
+
+  end # class FootballConfig
+
+
+  class BookPress
+    def self.create_football_book_for( setup, opts={} )
+      config = FootballConfig.new( setup: setup )
+      BookPress.new( config )
+    end
+  end  # class BookPress
+
+end # module Hybook

data/lib/hybook/press/press.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+
+module Hybook
+
+##
+# todo: change/rename class to Press from BookPress - why, why not??
+
+class BookPress
+
+  def initialize( config )
+    @config = config
+  end
+
+
+  def dl_datasets
+    ## fetch Datafile
+    datafile_dir  = @config.datafile_dir
+    datafile_path = @config.datafile_path
+
+    ## check if folders exists? if not create folder in path
+    FileUtils.mkdir_p( datafile_dir )  unless Dir.exists?( datafile_dir )
+
+    ## note: lets use http:// instead of https:// for now - lets us use person proxy (NOT working w/ https for now)
+    src = @config.datafile_url
+    ## dest will be something like './Datafile'
+
+    fetch_datafile( src, datafile_path )
+
+    datafile = Datafile::Datafile.load_file( datafile_path )
+    datafile.dump        ## for debugging
+    datafile.download    ## datafile step 1 - download all datasets/zips 
+  end
+
+
+  def dl_book_templates
+    ## fetch Bookfile
+    bookfile_dir  = @config.bookfile_dir
+    bookfile_path = @config.bookfile_path
+
+    ## check if folders exists? if not create folder in path
+    FileUtils.mkdir_p( bookfile_dir )  unless Dir.exists?( bookfile_dir )
+
+    ## note: lets use http:// instead of https:// for now - lets us use person proxy (NOT working w/ https for now)
+    src = @config.bookfile_url
+    ## dest will be something like './Bookfile'
+
+    fetch_bookfile( src, bookfile_path )
+
+
+    bookfile = Bookfile::Bookfile.load_file( bookfile_path )
+
+    bookfile.dump        ## for debugging
+    bookfile.download    ## bookfile step 1 - download all packages/zips (defaults to ./tmp) 
+    
+    ## todo/check: already checked in unzip if folder exists???
+    dest_unzip = @config.book_templates_unzip_dir
+    FileUtils.mkdir_p( dest_unzip )  unless Dir.exists?( dest_unzip )
+
+    bookfile.unzip( dest_unzip )   ## bookfile step 2 - unzip book templates 
+  end
+
+
+  def connect
+    db_path = @config.db_path
+
+    db_config = {
+     adapter:  'sqlite3',
+     database: db_path
+    }
+
+    pp db_config
+    ActiveRecord::Base.establish_connection( db_config )
+
+    c = ActiveRecord::Base.connection
+
+    ## try to speed up sqlite
+    ## see http://www.sqlite.org/pragma.html
+    c.execute( 'PRAGMA synchronous=OFF;' )
+    c.execute( 'PRAGMA journal_mode=OFF;' )
+    ## c.execute( 'PRAGMA journal_mode=MEMORY;' )
+    c.execute( 'PRAGMA temp_store=MEMORY;' )
+  end
+
+
+  def build_db
+    ## clean; remove db if exits
+
+    db_path = @config.db_path
+    FileUtils.rm( db_path )  if File.exists?( db_path )
+
+    connect()
+    @config.create_db!
+
+    datafile_path = @config.datafile_path
+    pp datafile_path
+
+
+    ### hack/quick fix for at,de - "standalone quick test": todo
+    ##   - find something better
+    if datafile_path.end_with?( 'at.rb' ) ||
+       datafile_path.end_with?( '/at/Datafile' )
+      ## standalone austria for debugging add country
+      WorldDb::Model::Country.create!( key: 'at',
+                                name: 'Austria',
+                                code: 'AUT',
+                                pop: 0,
+                                area: 0 )
+    elsif datafile_path.end_with?( 'de.rb' ) ||
+          datafile_path.end_with?( '/de/Datafile' )
+      WorldDb::Model::Country.create!( key: 'de',
+                                name: 'Germany',
+                                code: 'GER',
+                                pop: 0,
+                                area: 0 )
+    else
+      # no special case; continue
+      puts "[debug] - no special world archive case w/ start script; continue"
+    end
+
+
+    datafile = Datafile::Datafile.load_file( datafile_path )
+    datafile.dump    ## for debugging
+
+    logger = LogUtils::Logger.root
+    logger.level = :debug
+
+    datafile.read    ## datafile step 2 - read all datasets 
+  end
+
+
+  def build_book
+    connect()
+
+    bookfile_path = @config.bookfile_path
+
+    bookfile = Bookfile::Bookfile.load_file( bookfile_path )
+    bookfile.dump        ## for debugging
+
+    ### fix:
+    ###     assume WorldDb::Models already included ??
+    ## - for now always include on prepare
+    bookfile.prepare( @config.book_templates_unzip_dir )
+
+    puts "  contintents: #{WorldDb::Model::Continent.count}"   ## for debugging
+
+    bookfile.build( @config.book_templates_unzip_dir )
+
+    puts 'Done.'
+  end
+
+
+  def run_jekyll
+    # change cwd folder
+    cwd = FileUtils.pwd
+    puts "cwd (before): #{cwd}"
+    FileUtils.cd( @config.book_templates_unzip_dir )
+    puts "cwd (after): #{cwd}"
+
+    ## use `cd #{book_dir}; jekyll build`  -- why, why not???
+    puts `jekyll build`
+
+    # restore cwd folder
+    FileUtils.cd( cwd )
+  end
+
+
+  def build
+    ## all-in-one; do everything; complete all steps
+    dl_datasets
+    dl_book_templates
+
+    build_db
+    build_book
+    run_jekyll
+  end
+
+
+private
+
+  def fetch_datafile( src, dest )
+    worker = Fetcher::Worker.new
+    worker.copy( src, dest )
+  end
+
+  def fetch_bookfile( src, dest )
+    worker = Fetcher::Worker.new
+    worker.copy( src, dest )
+  end
+
+end  # class BookPress
+
+end # module Hybook

data/lib/hybook/press/world.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Hybook
+
+  class WorldConfig < Config
+
+    def initialize( hash ) super; end
+
+    def collection() 'world'; end
+
+    ############
+    # Bookfile
+    # -- remote
+    def bookfile_url()
+      ## note: for now always return world.rb
+      ##   use country specific bookfiles ??   allow selection of package,how?? why,why not??
+      "https://github.com/book-templates/bookfile/raw/master/world.rb"
+    end
+
+    ########
+    # Datafile
+    # -- remote
+    def datafile_url() "https://github.com/openmundi/datafile/raw/master/#{setup}.rb"; end
+
+    #######
+    # Database
+    def db_path() "#{build_dir}/#{collection}/#{setup}/#{collection}.db"; end
+    def create_db!()  WorldDb.create_all;  end
+
+
+    ######################
+    ## rename to book_dir ?? why, why not? - split zip into book_dir and book_templates_dir why? why not?
+    def book_templates_unzip_dir()  "#{build_dir}/#{collection}/#{setup}/book";  end
+
+  end # class WorldConfig
+
+
+  class BookPress
+    def self.create_world_book_for( setup, opts={} )
+      config = WorldConfig.new( setup: setup )
+      BookPress.new( config )
+    end
+  end  # class BookPress
+
+end # module Hybook

data/lib/hybook/std/album.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module HyBook
+module Hybook
   module AlbumHelper
 
     def render_pictures( pics, opts )
@@ -49,13 +49,13 @@ module HyBook
       ## TODO/FIX:
       ##  use TextUtils::PageTemplate.read( path ).render( binding ) - one line
 
-      tmpl = File.read_utf8( "#{HyBook.templates_path}/album.md" )
+      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.
+  # make helpers available as class methods for now e.g. Hybook.render_album etc.
   extend AlbumHelper
-end # module HyBook
+end # module Hybook

data/lib/hybook/type/album.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module HyBook
+module Hybook
 
 
 class Album
@@ -59,4 +59,4 @@ class Album
 end  # class Album
 
 
-end # module HyBook
+end # module Hybook

data/lib/hybook/type/picture.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module HyBook
+module Hybook
 
 
 class Picture
@@ -14,4 +14,4 @@ class Picture
 end
 
 
-end # module HyBook
+end # module Hybook

data/lib/hybook/type/section.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module HyBook
+module Hybook
 
 
 class Section
@@ -14,4 +14,4 @@ class Section
 end
 
 
-end # module HyBook
+end # module Hybook

data/lib/hybook/version.rb

@@ -1,8 +1,24 @@
+# encoding: utf-8
+
+
+module Hybook
+  VERSION = '0.2.0'
+
+  def self.banner
+    "hybook #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+  def self.templates_path
+    "#{root}/templates"
+  end
 
-module HyBook
-  VERSION = '0.1.2'
 end
 
 ## add module alias
 
-Hybook = HyBook
+HyBook = Hybook
+

data/test/helper.rb

@@ -2,18 +2,9 @@
 
 ## minitest setup
 
-# require 'minitest/unit'
 require 'minitest/autorun'
 
-# include MiniTest::Unit  # lets us use TestCase instead of MiniTest::Unit::TestCase
-
-
-# ruby stdlibs
-
-require 'json'
-require 'uri'
-require 'pp'
-
 
+### our own code
 require 'hybook'
 

data/test/test_basics.rb

@@ -3,14 +3,14 @@
 
 require 'helper'
 
-class TestBasics  < MiniTest::Unit::TestCase
+class TestBasics < MiniTest::Test
 
   def test_banner
 
-    banner = "hybook #{HyBook::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-    
-    assert_equal banner, HyBook.banner
-    assert_equal banner, Hybook.banner   ## check module alias
+    banner = "hybook #{Hybook::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+
+    assert_equal banner, Hybook.banner
+    assert_equal banner, HyBook.banner   ## check module alias
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hybook
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: props
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bookfile
+  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: datafile
+  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
@@ -140,6 +168,13 @@ files:
 - lib/hybook.rb
 - lib/hybook/builder/album.rb
 - lib/hybook/builder/book.rb
+- lib/hybook/helpers/markdown.rb
+- lib/hybook/helpers/misc.rb
+- lib/hybook/press/beer.rb
+- lib/hybook/press/config.rb
+- lib/hybook/press/football.rb
+- lib/hybook/press/press.rb
+- lib/hybook/press/world.rb
 - lib/hybook/std/album.rb
 - lib/hybook/type/album.rb
 - lib/hybook/type/picture.rb