bookfile 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e627081c49ba840795a25e2b2aeda693727563a
-  data.tar.gz: 9fa61a19d841748e24db5b8ae1184f2b32254b3f
+  metadata.gz: 4311caaae87c30b6ac285adb85a3495ddd177eaa
+  data.tar.gz: 4645efcb233160f0078bcc2d8919cda290d3c981
 SHA512:
-  metadata.gz: 7f90ddbe193fab0612db0c3e8450a8615a6e188f8165dfeeb6c22a29191187af7c67bbd8db7adb6f0bb9956f1f2633c383bf0f24dfb0597ad0aacde99243b6b6
-  data.tar.gz: 32cab29944e3f8da39666f205c8c7918c4b0f05479a44aabcabf4be7d1a7806b262842644266f0353103f6f8a65fa6132ebe9f66b6e89127667c42145b43fb1c
+  metadata.gz: c575efd458e00c39081e84ea811300de44736b5f79e7a44599438ceac6323f597fe10fbbdd468f06592244cdfe757eab6fb48e45b96be909d58388a02c55969c
+  data.tar.gz: b1df8f6c2766d0db1b51363c89ee8df6708d077fa28559a6f9eef674f18a781dfec4cd806dc8669500e9c68a04a251877f6718e4790fd354a8eaef82396a9438

data/Manifest.txt

@@ -12,7 +12,9 @@ lib/bookfile/helpers/markdown.rb
 lib/bookfile/helpers/misc.rb
 lib/bookfile/package/package.rb
 lib/bookfile/version.rb
+test/bookfile/beer.rb
 test/bookfile/world.rb
 test/helper.rb
+test/test_beer.rb
 test/test_world.rb
 test/test_world_templates.rb

data/lib/bookfile.rb

@@ -9,6 +9,10 @@ require 'ostruct'
 ##############
 # 3rd party gems
 
+require 'logutils'     # uses Logging etc.
+require 'textutils'    # uses File.read_utf8
+
+
 require 'fetcher'
 require 'zip'        # use $ gem install rubyzip
 require 'hybook'     # todo/fix: check if hybook required/needed for now??

data/lib/bookfile/bookfile.rb

@@ -4,7 +4,25 @@ module Bookfile
 
 class Bookfile
 
-  ## include LogUtils::Logging
+  include LogUtils::Logging
+
+  ## convenience method - use like Bookfile.load_file()
+  def self.load_file( path='./Bookfile' )
+    # Note: return datafile (of course, NOT the builder)
+    # if you want a builder use Bookfile::Builder ;-)
+    builder = Builder.load_file( path )
+    builder.bookfile
+  end
+
+  ## another convenience method - use like Bookfile.load()
+  def self.load( code )
+    # Note: return datafile (of course, NOT the builder)
+    # if you want a builder use Bookfile::Builder ;-)
+    builder = Builder.load( code )
+    builder.bookfile
+  end
+
+
 
   attr_reader :packages
   attr_reader :databases

data/lib/bookfile/builder.rb

@@ -5,10 +5,10 @@ module Bookfile
 
 class Builder
 
-  ## include LogUtils::Logging
+  include LogUtils::Logging
 
   def self.load_file( path )
-    code = File.read( path )
+    code = File.read_utf8( path )
     self.load( code )
   end
 
@@ -32,11 +32,20 @@ class Builder
     @bookfile.packages << BookPackage.new( name, opts )
   end
 
+  ## database options
   def world( opts={} )
     puts "world opts: #{opts.inspect}"
-    @bookfile.databases << World.new( opts )
+    @bookfile.databases << WorldDef.new( opts )
   end
 
+  def beer( opts={} )
+    puts "beer opts: #{opts.inspect}"
+    ## todo: to avoid name class use BeerDef, WorldDef ?? etc.
+    @bookfile.databases << BeerDef.new( opts )
+  end
+
+
+
   def book( opts={}, &block )
     puts "book opts: #{opts.inspect}"
     @bookfile.books << BookDef.new( opts, block )

data/lib/bookfile/database/database.rb

@@ -7,10 +7,22 @@ class Database
   def initialize( db_config )
     @db_config = db_config
   end
+
+  def connect
+    print "  connecting..."
+    ActiveRecord::Base.establish_connection( @db_config )
+    puts "OK"
+  end
+
+  def setup   ## use connect/prepare - why, why not??
+    prepare   # step 1: prepare - require and include models
+    connect   # step 2: connect
+  end
 end
 
 
-class World < Database   ## change to WorldDatabase or DatabaseWorld - why, why not???
+
+class WorldDef < Database   ## change to WorldDatabase or DatabaseWorld - why, why not???
   def initialize( db_config )  ## check - if it works by default (no initialze specfied)
     super
   end
@@ -19,35 +31,59 @@ class World < Database   ## change to WorldDatabase or DatabaseWorld - why, why
     puts "setup world: #{@db_config.inspect}"
 
     res = require 'worlddb/models'
-    if res
-      puts "  include WorldDb::Models"
-
-      ### check/fix: include as globals/top-level!!! how? possible???
-      Builder.send      :include, WorldDb::Models
-      PageCtx.send      :include, WorldDb::Models
-      HybookHelper.send :include, WorldDb::Models ## constants not accesible (include in module too)
-      ## BookCtx.send :include, WorldDb::Models   -- needed for Book context too?? why, why not??
 
       ## also add to xxxx ???
       ## (possible to include as globals ???? how - Object.send :include ???) or
       ##   Module.send :include ??
-    else
       ## find a better check - check for constants defined??? if not define???
       ##  or use constant_missing handler???
-      puts "  assume WorldDb::Models already included ??"
+
+    if res == false
+      puts "  todo/fix: WorldDb::Models already included ??"
     end
-  end
+    
+    puts "include WorldDb::Models"
 
-  def connect
-    print "  connecting..."
-    ActiveRecord::Base.establish_connection( @db_config )
-    puts "OK"
-  end
+    ### check/fix: include as globals/top-level!!! how? possible???
+    Builder.send      :include, WorldDb::Models
+    PageCtx.send      :include, WorldDb::Models
+    HybookHelper.send :include, WorldDb::Models ## constants not accesible (include in module too)
+    ## BookCtx.send :include, WorldDb::Models   -- needed for Book context too?? why, why not??
+  end # method prepare
+end  # class WorldDef
 
-  def setup   ## use connect/prepare - why, why not??
-    prepare   # step 1: prepare - require and include models
-    connect   # step 2: connect
+
+class BeerDef < Database   ## change to BeerDatabase or DatabaseBeer - why, why not???
+  def initialize( db_config )  ## check - if it works by default (no initialze specfied)
+    super
   end
-end  # class World
+
+  def prepare   ## change to require - why, why not??
+    puts "setup beer: #{@db_config.inspect}"
+
+    res = require 'beerdb/models'
+
+    ## also add to xxxx ???
+    ## (possible to include as globals ???? how - Object.send :include ???) or
+    ##   Module.send :include ??
+
+    if res == false
+      ## find a better check - check for constants defined??? if not define???
+      ##  or use constant_missing handler???
+      puts "  todo/fix: BeerDb::Models already included ??"
+    end
+
+    ## for now always include
+    puts "  include BeerDb::Models"
+
+    ### check/fix: include as globals/top-level!!! how? possible???
+    Builder.send      :include, BeerDb::Models
+    PageCtx.send      :include, BeerDb::Models
+    HybookHelper.send :include, BeerDb::Models ## constants not accesible (include in module too)
+
+
+  end # method prepare
+end  # class BeerDef
+
 
 end # module Bookfile

data/lib/bookfile/version.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Bookfile
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end
 
 ## add module alias

data/test/bookfile/beer.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+
+package 'book-templates/beer'
+
+
+beer adapter: 'sqlite3', database: './beer.db'
+
+
+book do |b|
+
+  ### generate what's news in 2014
+
+  years = [2014,2013,2012,2011,2010]
+  years.each do |year|
+    b.page( "#{year}", title:  "What's News in #{year}?",
+                       id: "#{year}" ) do |page|
+      page.write render_whats_news_in_year( year, opts )
+    end
+  end
+
+
+  ### generate breweries index
+
+  b.page( 'breweries', title: 'Breweries Index',
+                        id: 'breweries' ) do |page|
+    page.write render_breweries_idx( opts )
+  end
+
+  ### generate beers index
+
+  b.page( 'beers', title: 'Beers Index',
+                   id: 'beers' ) do |page|
+    page.write render_beers_idx( opts )
+  end
+
+  ### generate brands index
+
+  b.page( 'brands', title: 'Brands Index',
+                    id: 'brands' ) do |page|
+    page.write render_brands_idx( opts )
+  end
+
+
+  ### generate table of contents (toc)
+
+  b.page( 'index', title: 'Contents',
+                   id: 'index' ) do |page|
+    page.write render_toc( opts )
+  end
+
+
+  ### generate pages for countries
+
+  country_count=0
+  # Country.where( "key in ('at','mx','hr', 'de', 'be', 'nl', 'cz')" ).each do |country|
+  Country.order(:id).each do |country|
+    beers_count     = country.beers.count
+    breweries_count = country.breweries.count
+    next if beers_count == 0 && breweries_count == 0
+  
+    country_count += 1
+    puts "build country page #{country.key}..."
+
+    path = country.to_path
+    puts "path=#{path}"
+    b.page( path, title: "#{country.title} (#{country.code})",
+                  id:    "#{country.key}" ) do |page|
+      page.write render_country( country, opts )
+    end
+
+    ## todo - add  b.divider() - for inline version - why, why not ????
+
+    ## break if country_count == 3    # note: for testing only build three country pages
+  end
+end
+
+
+=begin
+###
+## todo: move to its own bookfile
+##   - how to pass in country parameter ???
+
+def build_book_for_country( country_code, opts={} )
+
+  country = Country.find_by_key!( country_code )
+
+  b = BookBuilder.new( PAGES_DIR, opts )
+
+### generate breweries index
+
+  b.page( "#{country.key}-breweries", title: 'Breweries Index',
+                                      id: "/#{country.key}-breweries" ) do |page|
+    page.write render_breweries_idx( opts )
+  end
+
+  ### generate pages for countries
+  
+  puts "build country page #{country.key}..."
+
+  path = country.to_path
+  puts "path=#{path}"
+  b.page( path,   title: "#{country.title} (#{country.code})",
+                  id:    "#{country.key}" ) do |page|
+    page.write render_country( country, opts )
+  end
+
+  b.page( "#{country.key}-mini", title: "#{country.title} (#{country.code}) - Mini",
+                                 id:    "#{country.key}-mini" ) do |page|
+    page.write render_country_mini( country, opts )
+  end
+
+  b.page( "#{country.key}-stats", title: "#{country.title} (#{country.code}) - Stats",
+                                  id:    "#{country.key}-stats.html" ) do |page|
+    page.write render_country_stats( country, opts )
+  end
+
+end
+=end
+

data/test/bookfile/world.rb

@@ -39,17 +39,17 @@ book do |b|
   puts "self.class.name (in book block): #{self.class.name}"
  
   b.page 'index', title: 'Contents',
-                  id:    'index'   do |p|
+                  id:    'index'   do |page|
     puts "enter index"
-    p.write "render_toc()" ## render_toc() ## render_toc( opts )
-    p.write "render_toc() 2x"
-    p.write "render_toc() 3x"
-    
-    p.render_toc( {} )
+    page.write "render_toc()" ## render_toc() ## render_toc( opts )
+    page.write "render_toc() 2x"
+    page.write "render_toc() 3x"
+
+    page.render_toc( {} )
     ## render :toc   -- auto includes opts???
 
     puts "self.class.name (in page block): #{self.class.name}"
-    p.write "continent.count: #{Continent.count}"
+    page.write "continent.count: #{Continent.count}"
     puts "leave index"
   
    puts "continent.count: #{Continent.count}"
@@ -67,9 +67,9 @@ book do |b|
       puts "path=#{path}"
     
       b.page path, title: "#{country.name} (#{country.code})",
-               id:    country.key do |p|
-        p.write "render_country(#{country.name})"  ## render_country( country )  ## render_country( country, opts )
-        p.render_country( country, {} )  ### fix: auto-include opts in render - how??
+               id:    country.key do |page|
+        page.write "render_country(#{country.name})"  ## render_country( country )  ## render_country( country, opts )
+        page.render_country( country, {} )  ### fix: auto-include opts in render - how??
       end
     end
   end

data/test/test_beer.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_beer.rb
+
+
+require 'helper'
+
+class TestBeer < MiniTest::Test
+
+  def test_beer
+    book_templates_unzip_dir = './tmp/book-beer'
+
+    bookfile = Bookfile::Bookfile.load_file( './test/bookfile/beer.rb' )
+
+    bookfile.download   # download book packages (templates n scripts)
+    bookfile.unzip( book_templates_unzip_dir ) 
+
+    bookfile.prepare( book_templates_unzip_dir )
+    bookfile.connect
+
+    bookfile.build( book_templates_unzip_dir )
+
+    assert true  # if we get here - test success
+  end
+
+end # class TestWorld
+

data/test/test_world.rb

@@ -10,13 +10,12 @@ require 'helper'
 class TestWorld < MiniTest::Test
 
   def test_world
-    book_templates_unzip_dir = './tmp/book'
+    book_templates_unzip_dir = './tmp/book-world'
 
-    builder = Bookfile::Builder.load_file( './test/bookfile/world.rb' )
-    bookfile = builder.bookfile
+    bookfile = Bookfile::Bookfile.load_file( './test/bookfile/world.rb' )
 
 #    bookfile.download   # download book packages (templates n scripts)
-#    bookfile.unzip( book_templates_unzip_dir ) 
+    bookfile.unzip( book_templates_unzip_dir ) 
 
     bookfile.prepare( book_templates_unzip_dir )
     bookfile.connect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookfile
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: props
@@ -146,8 +146,10 @@ files:
 - lib/bookfile/helpers/misc.rb
 - lib/bookfile/package/package.rb
 - lib/bookfile/version.rb
+- test/bookfile/beer.rb
 - test/bookfile/world.rb
 - test/helper.rb
+- test/test_beer.rb
 - test/test_world.rb
 - test/test_world_templates.rb
 homepage: https://github.com/hybook/bookfile
@@ -177,5 +179,6 @@ signing_key:
 specification_version: 4
 summary: bookfile - builder for books
 test_files:
+- test/test_beer.rb
 - test/test_world.rb
 - test/test_world_templates.rb