beerdb-models 0.10.0

data/lib/beerdb/reader_file.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module BeerDb
+
+## todo: "old" classic reader - rename to FileReader ?? why? why not?
+
+class Reader < ReaderBase  
+
+  def initialize( include_path, opts = {} )
+    @include_path = include_path
+  end
+
+  def create_fixture_reader( name )
+    path = "#{@include_path}/#{name}.txt"
+
+    logger.info "parsing data (setup) '#{name}' (#{path})..."
+
+    FixtureReader.from_file( path )
+  end
+
+  def create_beers_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (beers) '#{name}' (#{path})..."
+
+    ValuesReader.from_file( path, more_attribs )
+    ## ValuesReaderV2.new( name, @include_path, more_attribs )
+  end
+
+  def create_breweries_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (breweries) '#{name}' (#{path})..."
+
+    ValuesReader.from_file( path, more_attribs )
+    ## ValuesReaderV2.new( name, @include_path, more_attribs )
+  end
+
+private
+
+  def name_to_real_name( name )
+    # map name to real_name path
+    # name might include !/ for virtual path (gets cut off)
+    # e.g. at-austria!/w-wien/beers becomse w-wien/beers
+    pos = name.index( '!/')
+    if pos.nil?
+      name # not found; real path is the same as name
+    else
+      # cut off everything until !/ e.g.
+      # at-austria!/w-wien/beers becomes
+      # w-wien/beers
+      name[ (pos+2)..-1 ]
+    end
+  end
+
+end # class Reader
+end # module BeerDb
+

data/lib/beerdb/reader_zip.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+
+module BeerDb
+
+
+class ZipReader < ReaderBase
+
+  def initialize( name, include_path, opts = {} )
+
+    ## todo/fix: make include_path an opts (included in opts?) - why? why not??
+
+    path = "#{include_path}/#{name}.zip"
+    ## todo: check if zip exists
+
+    @zip_file = Zip::File.open( path )   ## NOTE: do NOT create if file is missing; let it crash
+    
+    ### allow prefix (path) in name
+    ###    e.g. assume all files relative to setup manifest
+    ## e.g. at-austria-master/setups/all.txt or
+    ##      be-belgium-master/setups/all.txt
+    ##  for
+    ##    setups/all.txt
+    ###
+    ##  will get (re)set w/ fixture/setup reader
+    ##
+    ## todo/fix: change/rename to @relative_path ?? - why? why not? 
+    @zip_prefix = ''
+  end
+
+
+  def close
+    ## todo/check: add a close method - why? why not ???
+    @zip_file.close
+  end
+
+
+  def create_fixture_reader( name )
+    ## e.g. pass in =>  setups/all  or setups/test etc.  e.g. w/o .txt extension
+    query = "**/#{name}.txt"
+
+    ## note: returns an array of Zip::Entry
+    candidates = @zip_file.glob( query )
+    pp candidates
+
+    ## use first candidates entry as match
+    ## todo/fix: issue warning if more than one entries/matches!!
+
+    ## get fullpath e.g. at-austria-master/setups/all.txt
+    path = candidates[0].name
+    logger.debug "  zip entry path >>#{path}<<"
+
+    ## cut-off at-austria-master/    NOTE: includes trailing slash (if present)
+    ## logger.debug "  path.size #{path.size} >>#{path}<<"
+    ## logger.debug "  name.size #{name.size+4} >>#{name}<<"
+
+    ## note: add +4 for extension (.txt)
+    @zip_prefix = path[ 0...(path.size-(name.size+4)) ]
+    logger.debug "  zip entry prefix >>#{@zip_prefix}<<"
+
+    logger.info "parsing data in zip '#{name}' (#{path})..."
+
+    FixtureReader.from_zip( @zip_file, path )
+  end
+
+
+  def create_beers_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.debug "parsing data (beers) in zip '#{name}' (#{path})..."
+
+    ValuesReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_breweries_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.debug "parsing data (breweries) in zip '#{name}' (#{path})..."
+
+    ValuesReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+private
+
+  def path_to_real_path( path )
+    # map name to name_real_path
+    # name might include !/ for virtual path (gets cut off)
+    # e.g. at-austria!/w-wien/beers becomse w-wien/beers
+    pos = path.index( '!/')
+    if pos.nil?
+      path # not found; real path is the same as name
+    else
+      # cut off everything until !/ e.g.
+      # at-austria!/w-wien/beers becomes
+      # w-wien/beers
+      path[ (pos+2)..-1 ]
+    end
+  end
+
+  def name_to_zip_entry_path( name )
+    path = "#{name}.txt"
+
+    real_path = path_to_real_path( path )
+
+    # NOTE: add possible zip entry prefix path
+    #          (if present includes trailing slash e.g. /)
+    entry_path = "#{@zip_prefix}#{real_path}"
+    entry_path
+  end
+
+
+end # class ZipReader
+end # module BeerDb

data/lib/beerdb/schema.rb

@@ -0,0 +1,195 @@
+# encoding: UTF-8
+
+module BeerDb
+
+
+class CreateDb < ActiveRecord::Migration
+
+def up
+
+create_table :beers do |t|
+  t.string  :key,   :null => false   # import/export key
+  t.string  :title, :null => false
+  t.string  :synonyms  # comma separated list of synonyms
+
+  t.string  :web    # optional url link (e.g. )
+  t.integer :since  # optional year (e.g. 1896)
+
+  # t.boolean  :bottle,  :null => false, :default => false # Flaschenbier
+  # t.boolean  :draft,   :null => false, :default => false # Fassbier
+  ## todo: check seasonal is it proper english?
+  t.boolean  :seasonal, :null => false, :default => false # all year or just eg. Festbier/Oktoberfest Special
+  t.boolean  :limited, :null => false, :default => false   # one year or season only
+  ## todo: add microbrew/brewpub flag?
+  #### t.boolean  :brewpub, :null => false, :default => false
+  
+  ## add t.boolean :lite  flag ??
+  t.decimal    :kcal    # kcal/100ml e.g. 45.0 kcal/100ml
+
+  ## check: why decimal and not float? 
+  t.decimal    :abv    # Alcohol by volume (abbreviated as ABV, abv, or alc/vol) e.g. 4.9 %
+  t.decimal    :og     # malt extract (original gravity) in plato
+  t.integer    :srm    # color in srm
+  t.integer    :ibu    # bitterness in ibu
+
+  ### fix/todo: add bitterness field
+
+  # renamed - old field names
+  ## t.decimal    :plato  # stammwuerze / gravity in plato scale (e.g. °P) e.g. 12.6°   - todo: use a different field name e.g. just p or gravity?
+  ## t.integer    :color  # beer color in Standard Reference Method (SRM)
+
+# see en.wikipedia.org/wiki/Plato_scale#Colour
+
+# SRM/Lovibond  | Example  | Beer color  | EBC
+# ---------------------------------------------------------------
+# 2  | Pale lager, Witbier, Pilsener, Berliner Weisse  | #F8F753 | 4
+# 3  | Maibock, Blonde Ale                             | #F6F513 | 6
+# 4  | Weissbier                                       | #ECE61A | 8
+# 6  | American Pale Ale, India Pale Ale               | #D5BC26 | 12
+# 8  | Weissbier, Saison                               | #BF923B | 16
+# 10  | English Bitter, ESB                            | #BF813A | 20
+# 13  | Biere de Garde, Double IPA                     | #BC6733 | 26
+# 17  | Dark lager, Vienna lager, Marzen, Amber Ale    | #8D4C32 | 33
+# 20  | Brown Ale, Bock, Dunkel, Dunkelweizen          | #5D341A | 39
+# 24  | Irish Dry Stout, Doppelbock, Porter            | #261716 | 47
+# 29  | Stout                                          | #0F0B0A | 57
+# 35  | Foreign Stout, Baltic Porter                   | #080707 | 69
+# 40+  | Imperial Stout                                | #030403 | 79
+
+  t.references :brewery   # optional (for now)
+  t.references :brand     # optional (for now)
+
+
+  ## todo: add categories e.g. (A/B/C, 1/2/3, main/major/minor ??)
+  # - A-grade /1st class/ tier1 / main beer brand/bestseller/flagship ?
+  # - B-grade /2nd class/ tier2 / regular, major,   - todo: find better names?
+  # - C-grade /3nd class/ tier3/ / speciality, minor ?
+
+  # use stars in .txt e.g. # ***/**/*/- => 1/2/3/4
+  t.integer :grade, :null => false, :default => 4
+
+  t.string  :txt            # source ref
+  t.boolean :txt_auto, :null => false, :default => false     # inline? got auto-added?
+
+
+  t.references :country,  :null => false
+  t.references :region   # optional
+  t.references :city     # optional
+
+  t.timestamps
+end
+
+
+create_table :brands do |t|   # beer families (sharing same name e.g. brand)
+  t.string  :key,   :null => false   # import/export key
+  t.string  :title, :null => false
+  t.string  :synonyms  # comma separated list of synonyms
+  t.string  :web   # optional web page (e.g. www.ottakringer.at)
+  t.string  :wiki  # optional wiki(pedia page)
+  t.integer :since
+
+  ## scope of brand (global/intern'l/national/regional/local) ??
+  t.boolean :global,     :null => false, :default => false 
+  t.boolean :internl,    :null => false, :default => false
+  t.boolean :national,   :null => false, :default => false
+  t.boolean :regional,   :null => false, :default => false
+  t.boolean :local,      :null => false, :default => false
+
+  # t.integer :brand_grade   # 1/2/3/4/5  (global/intern'l/national/regional/local)
+
+  # use stars in .txt e.g. # ***/**/*/- => 1/2/3/4
+  t.integer :grade, :null => false, :default => 4
+  #   -- todo: add plus 1 for brewery w/ *** ??
+
+  t.string  :txt            # source ref
+  t.boolean :txt_auto, :null => false, :default => false     # inline? got auto-added?
+
+
+  t.references :brewery   # optional (for now)
+
+  t.references :country,   :null => false
+  t.references :region   # optional
+  t.references :city     # optional
+
+  t.timestamps
+end
+
+create_table :breweries do |t|
+  t.string  :key,   :null => false   # import/export key
+  t.string  :title, :null => false
+  t.string  :synonyms  # comma separated list of synonyms
+  t.string  :address
+  t.integer :since
+  ### fix: rename back to founded or use opened/closed
+  ## fix: add flag for  ca./about  boolean opened_guess / opened_est / opened_??
+  ##   ca. / about  1010  marker   e.g  t.boolean : opened_est (for estimate) or similar!!!
+  ## renamed to founded to since
+  ## t.integer :founded  # year founded/established    - todo/fix: rename to since? 
+  t.integer :closed  # optional;  year brewery closed
+
+## todo: add optional parent brewery (owned_by)  ???
+
+  t.boolean  :brewpub, :null => false, :default => false
+  t.boolean  :prod_m,  :null => false, :default => false   # prod medium  (mid-size/regional brewery)
+                       #   e.g. > 15_000 barrels (us)
+  t.boolean  :prod_l,  :null => false, :default => false   # prod large
+                       #   e.g. > 500_000 hl (at), > 6_000_000 barrels (us)
+
+  t.integer :prod  # (estimated) annual production/capacity in hl (1hl=100l) e.g. megabrewery 2_000_000, microbrewery 1_000 hl; brewbup 500 hl etc.
+  t.integer :prod_grade   # 1/2/3/4/5/6/7/8/9/10/11
+
+  # grade - classified using annual production (capacity) in hl
+  # <     1_000 hl  => 11
+  # <     3_000 hl  => 10
+  # <     5_000 hl  => 9
+  # <    10_000 hl  => 8
+  # <    50_000 hl  => 7
+  # <   100_000 hl  => 6
+  # <   200_000 hl  => 5
+  # <   500_000 hl  => 4
+  # < 1_000_000 hl  => 3
+  # < 2_000_000 hl  => 2
+  # > 2_000_000 hl  => 1
+
+
+  # use stars in .txt e.g. # ***/**/*/- => 1/2/3/4
+  t.integer :grade, :null => false, :default => 4
+
+
+  t.string  :txt            # source ref
+  t.boolean :txt_auto, :null => false, :default => false     # inline? got auto-added?
+
+  t.string  :web        # optional web page (e.g. www.ottakringer.at)
+  t.string  :wikipedia  # optional wiki(pedia page)
+
+  t.boolean :indie    # independent brewery (flag)
+
+  # for convenience (easy queries) use flags for top beer multinationals (-- later use just tags? more flexible)
+  t.boolean :abinbev     # owned by AB InBev / Anheuser-Busch InBev (and Grupo Modelo)
+  t.boolean :sabmiller   # owned by SAB Miller (in US cooperates w/ Molson Coors using MillerCoors venture)
+  t.boolean :heineken    # owned by Heineken
+  t.boolean :carlsberg   # owned by Carlsberg
+  t.boolean :molsoncoors  # owned by Molson Coors
+  t.boolean :diageo       # owned by Diageo (e.g. Guiness, Kilkenny,...)
+
+
+  # todo: add t.references :parent  # for parent brewery
+  # (or better use has many parents w/ percentage of ownership; might not be 100%)
+
+  t.references :country,   :null => false
+  t.references :region   # optional
+  t.references :city     # optional
+  
+  t.timestamps
+end
+
+end # method up
+
+def down
+  raise ActiveRecord::IrreversibleMigration
+end
+
+
+end # class CreateDb
+
+end # module BeerDb

data/lib/beerdb/serializers/beer.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+module BeerDb::Model
+
+  class BeerSerializer
+
+    def initialize( beer )
+      @beer = beer
+    end
+    
+    attr_reader :beer
+    
+    def as_json
+      brewery = {}
+      if beer.brewery.present?
+        brewery = { key: beer.brewery.key,
+                    title: beer.brewery.title }
+      end
+
+      tags = []
+      if beer.tags.present?
+        beer.tags.each { |tag| tags << tag.key }
+      end
+
+      country = {
+        key:   beer.country.key,
+        title: beer.country.title
+      }
+
+      data = { key:      beer.key,
+               title:    beer.title,
+               synonyms: beer.synonyms,
+               abv:      beer.abv,
+               srm:      beer.srm,
+               og:       beer.og,
+               tags:     tags,
+               brewery: brewery,
+               country: country }
+      
+      data.to_json
+    end
+
+  end # class BeerSerializer
+
+end # module BeerDb::Model

data/lib/beerdb/serializers/brewery.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+module BeerDb::Model
+
+  class BrewerySerializer
+
+    def initialize( brewery )
+      @brewery = brewery
+    end
+    
+    attr_reader :brewery
+    
+    def as_json
+
+      beers = []
+      brewery.beers.each do |b|
+        beers << { key: b.key, title: b.title }
+      end
+
+      tags = []
+      if brewery.tags.present?
+        brewery.tags.each { |tag| tags << tag.key }
+      end
+
+      country = {
+        key:   brewery.country.key,
+        title: brewery.country.title
+      }
+
+      data = { key:      brewery.key,
+               title:    brewery.title,
+               synonyms: brewery.synonyms,
+               since:    brewery.since,
+               address:  brewery.address,
+               web:      brewery.web,
+               prod:     brewery.prod,  # (estimated) annual production in hl e.g. 2_000 hl
+               tags:     tags,
+               beers:    beers,
+               country:  country }
+
+      data.to_json
+    end
+
+  end # class BrewerySerializer
+
+end # module BeerDb::Model