bookman 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db792b49944fae5b0ecaf4c3c1c810f43dc97df0
-  data.tar.gz: 9d9f7477a68f3c12941fa88ccfe7dfa1af33535d
+  metadata.gz: 696312d864a28426c5e9920c377f7629f4d5735f
+  data.tar.gz: 4f673ba443afa10f43ed98e84c378d3ae3443bc6
 SHA512:
-  metadata.gz: c7fed455ecf278b4380c6e8dded7fc86477e0a57de66b4074e0f6a7ba7308c1a6903606a4a991a5a22626d3e876151f234d4592cc5cb5a4b1d8179b82c0ddeac
-  data.tar.gz: c886fe2c7cbf24985e53ac49444df546d72b61b4a663c1c6bcb2ff7f2779ea71f618229adbc3427a7fcc84cfd6da0540aee1a3caa6af37541dcc0c175b8bfd57
+  metadata.gz: 26644a52e34f235d2fba10517871fbb13dd198ac9334014f5d4f6d486d0949b1cb77b7f4d6b7c357b0cfe947b2df609637ccc2db11aaed4b4281949760807189
+  data.tar.gz: 714c40b722463d91c0ca8cd4e9066506cb7295920ecb953d93ec6eaaa9b0ad719f856d86a6395e52a9bc6ae1a95d46310e4920e537ef9263ee4e208bb131af1f

data/Manifest.txt

@@ -3,4 +3,11 @@ Manifest.txt
 README.md
 Rakefile
 lib/bookman.rb
+lib/bookman/beer.rb
+lib/bookman/bookman.rb
+lib/bookman/config.rb
+lib/bookman/football.rb
 lib/bookman/version.rb
+lib/bookman/world.rb
+test/helper.rb
+test/test_basics.rb

data/lib/bookman.rb

@@ -1,11 +1,23 @@
 # encoding: utf-8
 
 
+###
+# todo: add dependencies
+##  - hybook ??
+##  - datafile, bookfile ??
+
+
 ####################
 # our own code
 
 require 'bookman/version'  # let it always go first
 
+require 'bookman/bookman'
+require 'bookman/config'
+require 'bookman/world'
+require 'bookman/football'
+require 'bookman/beer'
+
 
 
 # say hello

data/lib/bookman/beer.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Bookman
+
+  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 Bookman
+    def self.create_beer_book_for( setup, opts={} )
+      config = BeerConfig.new( setup: setup )
+      Bookman.new( config )
+    end
+  end  # class Bookman
+
+end # module Bookman

data/lib/bookman/bookman.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+
+module Bookman
+
+class Bookman
+
+  ## todo: add logutils/logger here
+
+  def initialize( config )
+    @config = config
+
+    ## for debugging dump main config settings
+    puts "dataset:"
+    puts "  - collection: #{@config.collection}"
+    puts "  - setup:      #{@config.setup}"
+    ## todo: add db_path - why, why not???
+
+    puts "datafile:"
+    puts "  - datafile_url  (remote):  #{@config.datafile_url}"
+    puts "  - datafile_dir  (local):   #{@config.datafile_dir}"
+    puts "  - datafile_path (local):   #{@config.datafile_path}"
+
+    puts "bookfile:"
+    puts "  - bookfile_url  (remote):  #{@config.bookfile_url}"
+    puts "  - bookfile_dir  (local):   #{@config.bookfile_dir}"
+    puts "  - bookfile_path (local):   #{@config.bookfile_path}"
+    ## todo: add bookfile_unzip_path - why, why not???
+  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
+
+    ## set "global" logger to debug
+    LogUtils::Logger.root.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): #{FileUtils.pwd}"
+    FileUtils.cd( @config.book_templates_unzip_dir )
+    puts "cwd (after): #{FileUtils.pwd}"
+
+    ## 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 Bookman
+
+end # module Bookman

data/lib/bookman/config.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Bookman
+
+  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 Bookman
+

data/lib/bookman/football.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Bookman
+
+  class FootballConfig < Config
+
+    def initialize( hash ) super; end
+
+    def collection() 'football'; end
+
+    ############
+    # Bookfile
+    # -- remote
+    def bookfile_url()
+      ## note: for now always return football.rb
+      ##   use setup/layout-specific bookfiles??   allow selection of package,how?? why,why not??
+      "http://github.com/book-templates/bookfile/raw/master/football.rb"
+    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 Bookman
+    def self.create_football_book_for( setup, opts={} )
+      config = FootballConfig.new( setup: setup )
+      Bookman.new( config )
+    end
+  end  # class Bookman
+
+end # module Bookman

data/lib/bookman/version.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Bookman
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 
   def self.banner
     "bookman/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"

data/lib/bookman/world.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Bookman
+
+  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 Bookman
+    def self.create_world_book_for( setup, opts={} )
+      config = WorldConfig.new( setup: setup )
+      Bookman.new( config )
+    end
+  end  # class Bookman
+
+end # module Bookman

data/test/helper.rb

@@ -0,0 +1,11 @@
+#encoding: utf-8
+
+## minitest setup
+require 'minitest/autorun'
+
+## extra  stdlibs
+require 'pp'
+
+## our own code
+require 'bookman'
+

data/test/test_basics.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_basics.rb
+
+require 'helper'
+
+class TestBasics < MiniTest::Test
+
+  def test_banner
+
+    banner = "bookman/#{Bookman::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+
+    assert_equal banner, Bookman.banner
+    assert_equal banner, BookMan.banner   ## check module alias
+  end
+
+  def test_football_config
+    cfg = Bookman::FootballConfig.new( setup: 'at' )
+    pp cfg
+    assert true
+  end
+
+  def test_football_builder
+    b = Bookman::Bookman.create_football_book_for( 'at' )
+    assert true
+  end
+
+  def test_world_builder
+    b = Bookman::Bookman.create_world_book_for( 'at' )
+    assert true
+  end
+
+  def test_beer_builder
+    b = Bookman::Bookman.create_beer_book_for( 'at' )
+    assert true
+  end
+
+end # class Basics

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -103,12 +103,20 @@ extra_rdoc_files:
 - Manifest.txt
 - README.md
 files:
+- ".gemtest"
 - HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/bookman.rb
+- lib/bookman/beer.rb
+- lib/bookman/bookman.rb
+- lib/bookman/config.rb
+- lib/bookman/football.rb
 - lib/bookman/version.rb
+- lib/bookman/world.rb
+- test/helper.rb
+- test/test_basics.rb
 homepage: https://github.com/hybook/bookman
 licenses:
 - Public Domain
@@ -135,4 +143,5 @@ rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: bookman - yet another builder for books
-test_files: []
+test_files:
+- test/test_basics.rb