beerdb 0.1.0 → 0.2.0

data/Manifest.txt

@@ -6,12 +6,15 @@ bin/beerdb
 lib/beerdb.rb
 lib/beerdb/cli/main.rb
 lib/beerdb/cli/opts.rb
+lib/beerdb/console.rb
 lib/beerdb/deleter.rb
 lib/beerdb/models/beer.rb
 lib/beerdb/models/brewery.rb
 lib/beerdb/models/city.rb
 lib/beerdb/models/country.rb
 lib/beerdb/models/forward.rb
+lib/beerdb/models/region.rb
+lib/beerdb/models/tag.rb
 lib/beerdb/reader.rb
 lib/beerdb/schema.rb
 lib/beerdb/stats.rb

data/Rakefile

@@ -67,7 +67,7 @@ namespace :beerdb do
     require 'beerdb'
     require 'logutils/db'
 
-    LogUtils::Logger.root.level = :info
+    LogUtils::Logger.root.level = :debug
 
     pp DB_CONFIG
     ActiveRecord::Base.establish_connection( DB_CONFIG )
@@ -85,7 +85,7 @@ namespace :beerdb do
   end
 
   task :importbeer => :env do
-    BeerDb.read_setup( 'setups/all', '../beer.db' )
+    BeerDb.read_setup( 'setups/at', '../beer.db' )
     BeerDb.tables
   end
 

data/lib/beerdb/console.rb

@@ -0,0 +1,79 @@
+## for use to run with interactive ruby (irb)
+##  e.g.  irb -r sportdb/console
+
+require 'beerdb'
+
+# some ruby stdlibs
+
+require 'logger'
+require 'pp'   # pretty printer
+require 'uri'
+require 'json'
+require 'yaml'
+
+
+## shortcuts for models
+
+Beer    = BeerDb::Models::Beer
+Brewery = BeerDb::Models::Brewery
+
+Tag       = WorldDb::Models::Tag
+Tagging   = WorldDb::Models::Tagging
+Continent = WorldDb::Models::Continent
+Country   = WorldDb::Models::Country
+Region    = WorldDb::Models::Region
+City      = WorldDb::Models::City
+Prop      = WorldDb::Models::Prop
+
+## connect to db
+
+DB_CONFIG = {
+  adapter:  'sqlite3',
+  database: 'beer.db'
+}
+
+pp DB_CONFIG
+ActiveRecord::Base.establish_connection( DB_CONFIG )
+
+## test drive
+
+puts "Welcome to beer.db, version #{BeerDb::VERSION} (world.db, version #{WorldDb::VERSION})!"
+
+BeerDb.tables
+
+puts "Ready."
+
+## add some predefined shortcuts
+
+##### some countries
+
+AT = Country.find_by_key( 'at' )
+DE = Country.find_by_key( 'de' )
+EN = Country.find_by_key( 'en' )
+
+US = Country.find_by_key( 'us' )
+MX = Country.find_by_key( 'mx' )
+
+### some cities
+
+WIEN = City.find_by_key( 'wien' )
+
+### some regions
+
+NO = Region.find_by_key_and_country_id( 'no', AT.id )  # at - niederoesterreich
+OO = Region.find_by_key_and_country_id( 'oo', AT.id )  # at - oberoesterreich
+
+#### some beers
+
+## to be done
+
+
+### some breweries
+
+OTTAKRINGER = Brewery.find_by_key( 'ottakringer' )
+SCHWECHAT   = Brewery.find_by_key( 'schwechat' )
+
+
+## turn on activerecord logging to console
+
+ActiveRecord::Base.logger = Logger.new( STDOUT )

data/lib/beerdb/models/beer.rb

@@ -3,8 +3,14 @@ module BeerDb::Models
 class Beer < ActiveRecord::Base
 
   belongs_to :country, :class_name => 'WorldDb::Models::Country', :foreign_key => 'country_id'
+  belongs_to :region,  :class_name => 'WorldDb::Models::Region',  :foreign_key => 'region_id'
   belongs_to :city,    :class_name => 'WorldDb::Models::City',    :foreign_key => 'city_id'
 
+  belongs_to :brewery, :class_name => 'BeerDb::Models::Brewery',  :foreign_key => 'brewery_id'
+
+  has_many :taggings, :as => :taggable, :class_name => 'WorldDb::Models::Tagging'
+  has_many :tags,  :through => :taggings, :class_name => 'WorldDb::Models::Tag'
+
 end # class Beer
 
 

data/lib/beerdb/models/brewery.rb

@@ -5,8 +5,14 @@ class Brewery < ActiveRecord::Base
   self.table_name = 'breweries'
 
   belongs_to :country, :class_name => 'WorldDb::Models::Country', :foreign_key => 'country_id'
+  belongs_to :region,  :class_name => 'WorldDb::Models::Region',  :foreign_key => 'region_id'
   belongs_to :city,    :class_name => 'WorldDb::Models::City',    :foreign_key => 'city_id'
 
+  has_many   :beers,   :class_name => 'BeerDb::Models::Beer',     :foreign_key => 'brewery_id'
+
+  has_many :taggings, :as => :taggable, :class_name => 'WorldDb::Models::Tagging'
+  has_many :tags,  :through => :taggings, :class_name => 'WorldDb::Models::Tag'
+
 end # class Brewery
 
 

data/lib/beerdb/models/city.rb

@@ -1,8 +1,8 @@
 module WorldDb::Models
 
 class City
-    has_many :beers,     :class_name => 'BeerDb::Models::Beer',    :foreign_key => 'country_id'
-    has_many :breweries, :class_name => 'BeerDb::Models::Brewery', :foreign_key => 'country_id'
+    has_many :beers,     :class_name => 'BeerDb::Models::Beer',    :foreign_key => 'city_id'
+    has_many :breweries, :class_name => 'BeerDb::Models::Brewery', :foreign_key => 'city_id'
 end # class Country
 
 end # module WorldDb::Models

data/lib/beerdb/models/forward.rb

@@ -9,6 +9,10 @@ module BeerDb::Models
   Country   = WorldDb::Models::Country
   Region    = WorldDb::Models::Region
   City      = WorldDb::Models::City
+
+  Tag       = WorldDb::Models::Tag
+  Tagging   = WorldDb::Models::Tagging
+
   Prop      = WorldDb::Models::Prop
 
   class Beer < ActiveRecord::Base ; end

data/lib/beerdb/models/region.rb

@@ -0,0 +1,9 @@
+
+module WorldDb::Models
+
+class Region
+    has_many :beers,     :class_name => 'BeerDb::Models::Beer',    :foreign_key => 'region_id'
+    has_many :breweries, :class_name => 'BeerDb::Models::Brewery', :foreign_key => 'region_id'
+end # class Region
+
+end # module WorldDb::Models

data/lib/beerdb/models/tag.rb

@@ -0,0 +1,9 @@
+
+module WorldDb::Models
+
+class Tag
+  has_many :beers,     :through => :taggings, :source => :taggable, :source_type => 'BeerDb::Models::Beer',    :class_name => 'BeerDb::Models::Beer'
+  has_many :breweries, :through => :taggings, :source => :taggable, :source_type => 'BeerDb::Models::Brewery', :class_name => 'BeerDb::Models::Brewery'
+end # class Country
+
+end # module WorldDb::Models

data/lib/beerdb/reader.rb

@@ -68,6 +68,9 @@ class Reader
     if name =~ /\/([a-z]{2})\/beers/
       ## auto-add required country code (from folder structure)
       load_beers( $1, name )
+    elsif name =~ /\/([a-z]{2})\/breweries/
+      ## auto-add required country code (from folder structure)
+      load_breweries( $1, name )
     else
       logger.error "unknown beer.db fixture type >#{name}<"
       # todo/fix: exit w/ error
@@ -86,15 +89,150 @@ class Reader
     logger.info "parsing data '#{name}' (#{path})..."
 
     reader = ValuesReader.new( path, more_values )
-    
+
     load_beers_worker( reader )
 
     Prop.create_from_fixture!( name, path )
   end
 
 
+  def load_breweries( country_key, name, more_values={} )
+    country = Country.find_by_key!( country_key )
+    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
+
+    more_values[ :country_id ] = country.id
+
+    path = "#{include_path}/#{name}.txt"
+
+    logger.info "parsing data '#{name}' (#{path})..."
+
+    reader = ValuesReader.new( path, more_values )
+
+    load_breweries_worker( reader )
+
+    Prop.create_from_fixture!( name, path )
+  end
+
+
 private
 
+  def load_breweries_worker( reader )
+
+    ## NB: assumes active activerecord db connection
+
+    reader.each_line do |attribs, values|
+  
+  
+      ### todo/fix: move this code to model (lets us reuse it)
+  
+      value_tag_keys    = []
+      
+      ### check for "default" tags - that is, if present attribs[:tags] remove from hash
+      
+      if attribs[:tags].present?
+        more_tag_keys = attribs[:tags].split('|')
+        attribs.delete(:tags)
+
+        ## unify; replace _ w/ space; remove leading n trailing whitespace
+        more_tag_keys = more_tag_keys.map do |key|
+          key = key.gsub( '_', ' ' )
+          key = key.strip
+          key
+        end
+
+        value_tag_keys += more_tag_keys
+      end
+
+
+      ## check for optional values
+      values.each_with_index do |value,index|
+        if value =~ /^country:/   ## country:
+          value_country_key = value[8..-1]  ## cut off country: prefix
+          value_country = Country.find_by_key!( value_country_key )
+          attribs[ :country_id ] = value_country.id
+        elsif value =~ /^region:/   ## region:
+          value_region_key = value[7..-1]  ## cut off region: prefix
+          value_region = Region.find_by_key_and_country_id!( value_region_key, attribs[:country_id] )
+          attribs[ :region_id ] = value_region.id
+        elsif value =~ /^[A-Z]{1,2}$/  ## assume region code e.g. TX or N
+          value_region = Region.find_by_key_and_country_id!( value.downcase, attribs[:country_id] )
+          attribs[ :region_id ] = value_region.id
+        elsif value =~ /^city:/   ## city:
+          value_city_key = value[5..-1]  ## cut off city: prefix
+          value_city = City.find_by_key( value_city_key )
+          if value_city.present?
+            attribs[ :city_id ] = value_city.id
+          else
+            ## todo/fix: add strict mode flag - fail w/ exit 1 in strict mode
+            logger.warn "city with key #{value_city_key} missing"
+          end
+
+          ## for easy queries: cache region_id (from city)
+          #  - check if city w/ region if yes, use it for brewery too
+          if value_city.present? && value_city.region.present?
+            attribs[ :region_id ] = value_city.region.id
+          end
+        elsif value =~ /^[0-9]{4}$/   # founded/established year e.g. 1776
+          attribs[ :founded ] = value.to_i
+        elsif value =~ /\/{2}/  # if value includes // assume address e.g. 3970 Weitra // Sparkasseplatz 160
+          attribs[ :address ] = value
+        elsif (values.size==(index+1)) && value =~ /^[a-z0-9\|_ ]+$/   # tags must be last entry
+
+          logger.debug "   found tags: >>#{value}<<"
+
+          tag_keys = value.split('|')
+  
+          ## unify; replace _ w/ space; remove leading n trailing whitespace
+          tag_keys = tag_keys.map do |key|
+            key = key.gsub( '_', ' ' )
+            key = key.strip
+            key
+          end
+          
+          value_tag_keys += tag_keys
+        else
+          # issue warning: unknown type for value
+          logger.warn "unknown type for value >#{value}<"
+        end
+      end # each value
+
+      rec = Brewery.find_by_key( attribs[ :key ] )
+
+      if rec.present?
+        logger.debug "update Brewery #{rec.id}-#{rec.key}:"
+      else
+        logger.debug "create Brewery:"
+        rec = Brewery.new
+      end
+      
+      logger.debug attribs.to_json
+
+      rec.update_attributes!( attribs )
+
+      ##################
+      ## add taggings 
+
+      if value_tag_keys.size > 0
+        
+          value_tag_keys.uniq!  # remove duplicates
+          logger.debug "   adding #{value_tag_keys.size} taggings: >>#{value_tag_keys.join('|')}<<..."
+
+          ### fix/todo: check tag_ids and only update diff (add/remove ids)
+
+          value_tag_keys.each do |key|
+            tag = Tag.find_by_key( key )
+            if tag.nil?  # create tag if it doesn't exit
+              logger.debug "   creating tag >#{key}<"
+              tag = Tag.create!( key: key )
+            end
+            rec.tags << tag
+          end
+      end
+
+    end # each_line
+            
+  end # method load_breweries_worker
+
 
   def load_beers_worker( reader )
 
@@ -102,6 +240,8 @@ private
     ##
 
     reader.each_line do |attribs, values|
+
+      ### todo/fix: move this code to model (lets us reuse it)
   
       value_tag_keys    = []
       
@@ -111,7 +251,7 @@ private
         more_tag_keys = attribs[:tags].split('|')
         attribs.delete(:tags)
 
-        ## unify; replace _w/ space; remove leading n trailing whitespace
+        ## unify; replace _ w/ space; remove leading n trailing whitespace
         more_tag_keys = more_tag_keys.map do |key|
           key = key.gsub( '_', ' ' )
           key = key.strip
@@ -128,17 +268,61 @@ private
           value_country_key = value[8..-1]  ## cut off country: prefix
           value_country = Country.find_by_key!( value_country_key )
           attribs[ :country_id ] = value_country.id
+        elsif value =~ /^region:/   ## region:
+          value_region_key = value[7..-1]  ## cut off region: prefix
+          value_region = Region.find_by_key_and_country_id!( value_region_key, attribs[:country_id] )
+          attribs[ :region_id ] = value_region.id
+        elsif value =~ /^[A-Z]{1,2}$/  ## assume region code e.g. TX or N
+          value_region = Region.find_by_key_and_country_id!( value.downcase, attribs[:country_id] )
+          attribs[ :region_id ] = value_region.id
         elsif value =~ /^city:/   ## city:
           value_city_key = value[5..-1]  ## cut off city: prefix
-          value_city = City.find_by_key!( value_city_key )
-          attribs[ :city_id ] = value_city.id
+          value_city = City.find_by_key( value_city_key )
+          if value_city.present?
+            attribs[ :city_id ] = value_city.id
+          else
+            ## todo/fix: add strict mode flag - fail w/ exit 1 in strict mode
+            logger.warn "city with key #{value_city_key} missing"
+          end
+        elsif value =~ /^by:/   ## by:  -brewed by/brewery
+          value_brewery_key = value[3..-1]  ## cut off by: prefix
+          value_brewery = Brewery.find_by_key!( value_brewery_key )
+          attribs[ :brewery_id ] = value_brewery.id
+
+          # for easy queries cache city and region ids
+          
+          # 1) check if brewery has city - if yes, use it for beer too
+          if value_brewery.city.present?
+            attribs[ :city_id ] = value_brewery.city.id
+          end
+
+          # 2) check if brewery has city w/ region if yes, use it for beer to
+          #   if not check for region for brewery
+          if value_brewery.city.present? && value_brewery.city.region.present?
+            attribs[ :region_id ] = value_brewery.city.region.id
+          elsif value_brewery.region.present?
+            attribs[ :region_id ] = value_brewery.region.id
+          end
+          
+        elsif value =~ /^<?\s*(\d+(?:\.\d+)?)\s*%$/  ## abv (alcohol by volumee)
+          ## nb: allow leading < e.g. <0.5%
+          value_abv_str = $1.dup   # convert to decimal? how? use float?
+          attribs[ :abv ] = value_abv_str
+        elsif value =~ /^(\d+(?:\.\d+)?)°$/  ## plato (stammwuerze/gravity?) e.g. 11.2°
+          ## nb: no whitespace allowed between ° and number e.g. 11.2°
+          value_plato_str = $1.dup   # convert to decimal? how? use float?
+          attribs[ :plato ] = value_plato_str
+        elsif value =~ /^(\d+(?:\.\d+)?)\s*kcal(?:\/100ml)?$/  ## kcal
+           ## nb: allow 44.4 kcal/100ml or 44.4 kcal or 44.4kcal
+          value_kcal_str = $1.dup   # convert to decimal? how? use float?
+          attribs[ :kcal ] = value_kcal_str
         elsif (values.size==(index+1)) && value =~ /^[a-z0-9\|_ ]+$/   # tags must be last entry
 
           logger.debug "   found tags: >>#{value}<<"
 
           tag_keys = value.split('|')
   
-          ## unify; replace _w/ space; remove leading n trailing whitespace
+          ## unify; replace _ w/ space; remove leading n trailing whitespace
           tag_keys = tag_keys.map do |key|
             key = key.gsub( '_', ' ' )
             key = key.strip
@@ -166,7 +350,6 @@ private
 
       rec.update_attributes!( attribs )
 
-=begin
       ##################
       ## add taggings 
 
@@ -186,8 +369,7 @@ private
             rec.tags << tag
           end
       end
-=end
-        
+
     end # each_line
             
   end # method load_beers_worker

data/lib/beerdb/schema.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 
 module BeerDb
 
@@ -7,9 +8,10 @@ class CreateDb < ActiveRecord::Migration
 def up
 
 create_table :beers do |t|
-  t.string  :title, :null => false
   t.string  :key,   :null => false   # import/export key
+  t.string  :title, :null => false
   t.string  :synonyms  # comma separated list of synonyms
+
   t.boolean  :bottle,  :null => false, :default => false # Flaschenbier
   t.boolean  :draft,   :null => false, :default => false # Fassbier
   ## todo: check seasonal is it proper english?
@@ -17,19 +19,52 @@ create_table :beers do |t|
   ## 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    :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 :country,  :null => false
-  t.references :city  # optional 
-  
+  t.references :region   # optional
+  t.references :city     # optional
+
   t.timestamps
 end
 
 
 create_table :breweries do |t|
-  t.string  :title
   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 :founded  # year founded/established
+
   t.references :country,   :null => false
-  t.references :city  # optional
+  t.references :region   # optional
+  t.references :city     # optional
   
   t.timestamps
 end

data/lib/beerdb/version.rb

@@ -1,4 +1,4 @@
 
 module BeerDb
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/beerdb.rb

@@ -27,7 +27,9 @@ require 'beerdb/version'
 
 require 'beerdb/models/forward'
 require 'beerdb/models/country'
+require 'beerdb/models/region'
 require 'beerdb/models/city'
+require 'beerdb/models/tag'
 require 'beerdb/models/beer'
 require 'beerdb/models/brewery'
 require 'beerdb/schema'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beerdb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &73327670 !ruby/object:Gem::Requirement
+  requirement: &83368970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *73327670
+  version_requirements: *83368970
 - !ruby/object:Gem::Dependency
   name: worlddb
-  requirement: &73327440 !ruby/object:Gem::Requirement
+  requirement: &83368740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *73327440
+  version_requirements: *83368740
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &73327210 !ruby/object:Gem::Requirement
+  requirement: &83368520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 4.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *73327210
+  version_requirements: *83368520
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &72898760 !ruby/object:Gem::Requirement
+  requirement: &83368300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *72898760
+  version_requirements: *83368300
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &72898510 !ruby/object:Gem::Requirement
+  requirement: &84239690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *72898510
+  version_requirements: *84239690
 description: beerdb - beer.db command line tool
 email: tobedone@googlegroups.com
 executables:
@@ -82,12 +82,15 @@ files:
 - lib/beerdb.rb
 - lib/beerdb/cli/main.rb
 - lib/beerdb/cli/opts.rb
+- lib/beerdb/console.rb
 - lib/beerdb/deleter.rb
 - lib/beerdb/models/beer.rb
 - lib/beerdb/models/brewery.rb
 - lib/beerdb/models/city.rb
 - lib/beerdb/models/country.rb
 - lib/beerdb/models/forward.rb
+- lib/beerdb/models/region.rb
+- lib/beerdb/models/tag.rb
 - lib/beerdb/reader.rb
 - lib/beerdb/schema.rb
 - lib/beerdb/stats.rb