beerdb 0.9.13 → 0.10.0

data/lib/beerdb/models/brewery.rb

@@ -1,256 +0,0 @@
-# encoding: UTF-8
-
-module BeerDb
-  module Model
-
-class Brewery < ActiveRecord::Base
-
-  extend TextUtils::TagHelper  # will add self.find_tags, self.find_tags_in_attribs!, etc.
-
-  # NB: use extend - is_<type>? become class methods e.g. self.is_<type>? for use in
-  #   self.create_or_update_from_values
-  extend TextUtils::ValueHelper  # e.g. self.is_year?, self.is_region?, is_address?, is_taglist? etc.
-  extend TextUtils::AddressHelper  # e.g self.normalize_addr, self.find_city_in_addr, etc.
-
-  self.table_name = 'breweries'
-
-  belongs_to :country, :class_name => 'WorldDb::Model::Country', :foreign_key => 'country_id'
-  belongs_to :region,  :class_name => 'WorldDb::Model::Region',  :foreign_key => 'region_id'
-  belongs_to :city,    :class_name => 'WorldDb::Model::City',    :foreign_key => 'city_id'
-
-  has_many   :beers,   :class_name => 'BeerDb::Model::Beer',     :foreign_key => 'brewery_id'
-  has_many   :brands,  :class_name => 'BeerDb::Model::Brand',    :foreign_key => 'brand_id'
-
-  has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
-  has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
-
-
-  validates :key, :format => { :with => /\A[a-z][a-z0-9]+\z/, :message => 'expected two or more lowercase letters a-z or 0-9 digits' }
-
-
-  ### support old names (read-only) for now  (remove later ??)
-
-  def founded()        since;  end
-  def founded=(value)  self.since = value; end
-
-  def opened()        since;  end
-  def openend=(value)  self.since = value; end
-
-  def m?()  prod_m == true;  end
-  def l?()  prod_l == true;  end
-  
-  ## TODO: activerecord supplies brewpub? already? same as attrib; check w/ test case (and remove here)
-  def brewpub?()  brewpub == true;  end   
-
-
-
-  def as_json_v2( opts={} )
-    # NB: do NOT overwrite "default" / builtin as_json, thus, lets use as_json_v2
-    BrewerySerializer.new( self ).as_json
-  end
-
-
-
-  def self.create_or_update_from_values( values, more_attribs={} )
-    attribs, more_values = find_key_n_title( values )
-    attribs = attribs.merge( more_attribs )
-
-    # check for optional values
-    Brewery.create_or_update_from_attribs( attribs, more_values )
-  end
-
-
-  def self.create_or_update_from_attribs( new_attributes, values )
-
-    ## fix: add/configure logger for ActiveRecord!!!
-    logger = LogKernel::Logger.root
-
-    value_tag_keys    = []
-    value_brands      = ''
-
-    ## check for grades (e.g. ***/**/*) in titles (will add new_attributes[:grade] to hash)
-    ## if grade missing; set default to 4; lets us update overwrite 1,2,3 values on update
-    new_attributes[ :grade ] ||= 4
-
-    ### check for "default" tags - that is, if present new_attributes[:tags] remove from hash
-    value_tag_keys += find_tags_in_attribs!( new_attributes )
-
-    ## check for optional values
-    values.each_with_index do |value,index|
-      if match_country(value) do |country|
-           new_attributes[ :country_id ] = country.id
-         end
-      elsif match_region_for_country(value,new_attributes[:country_id]) do |region|
-              new_attributes[ :region_id ] = region.id
-            end
-      elsif match_city(value) do |city|
-              if city.present?
-                new_attributes[ :city_id ] = city.id
-              else
-                ## todo/fix: add strict mode flag - fail w/ exit 1 in strict mode
-                logger.warn "city with key #{value[5..-1]} missing - for brewery #{new_attributes[:key]}"
-              end
-
-              ## for easy queries: cache region_id (from city)
-              #  - check if city w/ region if yes, use it for brewery too
-              if city.present? && city.region.present?
-                new_attributes[ :region_id ] = city.region.id
-              end
-            end
-      elsif match_year( value ) do |num|  # founded/established year e.g. 1776
-              new_attributes[ :since ] = num
-            end
-      elsif match_hl( value ) do |num|  # e.g. 20_000 hl or 50hl etc.
-              new_attributes[ :prod ] = num
-            end
-      elsif match_website( value ) do |website|  # check for url/internet address e.g. www.ottakringer.at
-              # fix: support more url format (e.g. w/o www. - look for .com .country code etc.)
-              new_attributes[ :web ] = website
-            end
-      elsif is_address?( value ) # if value includes // assume address e.g. 3970 Weitra // Sparkasseplatz 160
-        new_attributes[ :address ] = normalize_addr( value )
-      elsif value =~ /^brands:/   # brands:
-        value_brands = value[7..-1]  ## cut off brands: prefix
-        value_brands = value_brands.strip  # remove leading and trailing spaces
-        # NB: brands get processed after record gets created (see below)
-      elsif (values.size==(index+1)) && is_taglist?( value ) # tags must be last entry
-        logger.debug "   found tags: >>#{value}<<"
-        value_tag_keys += find_tags( value )
-      else
-        # issue warning: unknown type for value
-        logger.warn "unknown type for value >#{value}< - key #{new_attributes[:key]}"
-      end
-    end # each value
-
-    ## todo: check better style using self.find_by_key?? why? why not?
-    rec = Brewery.find_by_key( new_attributes[ :key ] )
-
-    if rec.present?
-      logger.debug "update Brewery #{rec.id}-#{rec.key}:"
-    else
-      logger.debug "create Brewery:"
-      rec = Brewery.new
-    end
-      
-    logger.debug new_attributes.to_json
-
-    rec.update_attributes!( new_attributes )
-
-
-    ##############################
-    # auto-add city if not present and country n region present
-    
-    if new_attributes[:city_id].blank? &&
-       new_attributes[:country_id].present? &&
-       new_attributes[:region_id].present?
-       
-      country_key = rec.country.key
-
-      ###
-      ## see  textutils/helper/address_helper for details about countries supported e.g.
-      ##   github.com/rubylibs/textutils/blob/master/lib/textutils/helper/address_helper.rb
-
-      if country_key == 'be' || country_key == 'at' ||
-         country_key == 'de' ||
-         country_key == 'cz' || country_key == 'sk' ||
-         country_key == 'us'
-
-        ## todo: how to handle nil/empty address lines?
-
-        city_title = find_city_in_addr( new_attributes[:address], country_key )
-        
-        if city_title.present?
-          
-          ## for czech  - some cleanup
-          ##   remove any (remaining) digits in city title
-          city_title = city_title.gsub( /[0-9]/, '' ).strip
-
-          city_values = [city_title]
-          city_attributes = {
-            country_id: rec.country_id,
-            region_id:  rec.region_id
-          }
-          # todo: add convenience helper create_or_update_from_title
-          city = City.create_or_update_from_values( city_values, city_attributes )
-
-          ### fix/todo: set new autoadd flag too?
-          ##  e.g. check if updated? e.g. timestamp created <> updated otherwise assume created?
-
-          ## now at last add city_id to brewery!
-          rec.city_id = city.id
-          rec.save!
-        else
-          logger.warn "auto-add city for #{new_attributes[:key]} (#{country_key}) >>#{new_attributes[:address]}<< failed; no city title found"
-        end
-      end
-    end
-
-
-    ###################
-    # auto-add brands if presents
-
-    if value_brands.present?
-      logger.debug " auto-adding brands >#{value_brands}<"
-
-      ## todo/fix: use strip_inline_comments (e.g #() or (()) - why?? why not??)
-      #   - allows titles as usual (use new syntax for inline comments e.g. #() or (()) for example)
-      
-      # remove optional longer title part in () e.g. Las Palmas (de Gran Canaria), Palma (de Mallorca)
-      value_brands = TextUtils.strip_subtitles( value_brands )
-
-      brand_titles = value_brands.split( ',' )
-
-      # pass 1) remove leading n trailing spaces
-      brand_titles = brand_titles.map { |value| value.strip }
-
-      brand_attribs = {
-        brewery_id: rec.id,
-        country_id: rec.country_id,
-        region_id:  rec.region_id,
-        city_id:    rec.city_id
-      }
-
-      brand_titles.each do |brand_title|
-        Brand.create_or_update_from_title( brand_title, brand_attribs )
-      end
-    end
-
-    ##################
-    ## add taggings
-
-##
-##  fix: delete all tags first or only add diff?
-##  fix e.g.
-##
-# [debug]    adding 1 taggings: >>trappist<<...
-# rake aborted!
-# ActiveRecord::RecordNotUnique: SQLite3::ConstraintException: columns taggable_id, taggable_type, tag_id are not unique: INSERT INTO "taggings" ("created_at", "tag_id", "taggable_id", "taggable_type", "updated_at") VALUES (?, ?, ?, ?, ?)
-#    if value_tag_keys.size > 0
-
-=begin
-      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
-
-    rec # NB: return created or updated obj
-
-  end # method create_or_update_from_values
-
-
-end # class Brewery
-
-  end # module Model
-end # module BeerDb
-

data/lib/beerdb/models/forward.rb

@@ -1,46 +0,0 @@
-# encoding: UTF-8
-
-
-### forward references
-##   require first to resolve circular references
-
-
-module BeerDb
-  module Model
-
-  ## todo: why? why not use include WorldDb::Models here???
-
-  Continent = WorldDb::Model::Continent
-  Country   = WorldDb::Model::Country
-  Region    = WorldDb::Model::Region
-  City      = WorldDb::Model::City
-
-  Tag       = TagDb::Model::Tag
-  Tagging   = TagDb::Model::Tagging
-
-  Prop      = ConfDb::Model::Prop
-
-  class Beer < ActiveRecord::Base ; end
-  class Brand < ActiveRecord::Base ; end
-  class Brewery < ActiveRecord::Base ; end
-
-  end # module Model
-
-  ## convenience alias (for better english ;-) )
-  ##   lets you use =>  include Models  (instead of include Model)
-  Models = Model
-  
-end # module BeerDb
-
-
-
-module WorldDb
-  module Model
-
-  Beer    = BeerDb::Model::Beer
-  Brand   = BeerDb::Model::Brand
-  Brewery = BeerDb::Model::Brewery
-
-  end # module Model
-end # module WorldDb
-

data/lib/beerdb/models/tag.rb

@@ -1,13 +0,0 @@
-# encoding: UTF-8
-
-module TagDb
-  module Model
-
-class Tag
-  has_many :beers,     :through => :taggings, :source => :taggable, :source_type => 'BeerDb::Model::Beer',    :class_name => 'BeerDb::Model::Beer'
-  has_many :breweries, :through => :taggings, :source => :taggable, :source_type => 'BeerDb::Model::Brewery', :class_name => 'BeerDb::Model::Brewery'
-end # class Country
-
-  end # module Model
-end # module TagDb
-

data/lib/beerdb/models/world/city.rb

@@ -1,14 +0,0 @@
-# encoding: UTF-8
-
-module WorldDb
-  module Model
-
-class City
-  has_many :beers,     :class_name => 'BeerDb::Model::Beer',    :foreign_key => 'city_id'
-  has_many :brands,    :class_name => 'BeerDb::Model::Brand',   :foreign_key => 'city_id'
-  has_many :breweries, :class_name => 'BeerDb::Model::Brewery', :foreign_key => 'city_id'
-end # class Country
-
-  end # module Model
-end # module WorldDb
-

data/lib/beerdb/models/world/country.rb

@@ -1,14 +0,0 @@
-# encoding: UTF-8
-
-module WorldDb
-  module Model
-
-class Country
-  has_many :beers,     :class_name => 'BeerDb::Model::Beer',    :foreign_key => 'country_id'
-  has_many :brands,    :class_name => 'BeerDb::Model::Brand',   :foreign_key => 'country_id'
-  has_many :breweries, :class_name => 'BeerDb::Model::Brewery', :foreign_key => 'country_id'
-end # class Country
-
-  end # module Model
-end # module WorldDb
-

data/lib/beerdb/models/world/region.rb

@@ -1,14 +0,0 @@
-# encoding: UTF-8
-
-module WorldDb
-  module Model
-
-class Region
-  has_many :beers,     :class_name => 'BeerDb::Model::Beer',    :foreign_key => 'region_id'
-  has_many :brands,    :class_name => 'BeerDb::Model::Brand',   :foreign_key => 'region_id'
-  has_many :breweries, :class_name => 'BeerDb::Model::Brewery', :foreign_key => 'region_id'
-end # class Region
-
-  end # module Model
-end # module WorldDb
-

data/lib/beerdb/reader.rb

@@ -1,219 +0,0 @@
-# encoding: UTF-8
-
-module BeerDb
-
-
-module Matcher
-
-  def match_beers_for_country( name, &blk )
-    match_xxx_for_country( name, 'beers', &blk )
-  end
-
-  def match_beers_for_country_n_region( name, &blk )
-    match_xxx_for_country_n_region( name, 'beers', &blk )
-  end
-
-  def match_breweries_for_country( name, &blk )
-    match_xxx_for_country( name, 'breweries', &blk )
-  end
-
-  def match_breweries_for_country_n_region( name, &blk )
-    match_xxx_for_country_n_region( name, 'breweries', &blk )
-  end
-
-  def match_brewpubs_for_country( name, &blk )
-    match_xxx_for_country( name, 'brewpubs', &blk )
-  end
-
-  def match_brewpubs_for_country_n_region( name, &blk )
-    match_xxx_for_country_n_region( name, 'brewpubs', &blk )
-  end
-
-
-end # module Matcher
-
-
-class ReaderBase
-
-  include LogUtils::Logging
-
-  include BeerDb::Models
-
-  include WorldDb::Matcher   ## fix: move to BeerDb::Matcher module ??? - cleaner?? why? why not?
-  include BeerDb::Matcher # lets us use match_teams_for_country etc.
-
-
-  def load_setup( name )
-    reader = create_fixture_reader( name )   ### "virtual" method - required by concrete class
-
-    reader.each do |fixture_name|
-      load( fixture_name )
-    end
-  end # method load_setup
-
-
-
-  def load( name )
-
-    if match_beers_for_country_n_region( name ) do |country_key, region_key|
-            load_beers_for_country_n_region( country_key, region_key, name )
-          end
-    elsif match_beers_for_country( name ) do |country_key|
-            load_beers_for_country( country_key, name )
-          end
-    elsif match_breweries_for_country_n_region( name ) do |country_key, region_key|
-            load_breweries_for_country_n_region( country_key, region_key, name )
-          end
-    elsif match_breweries_for_country( name ) do |country_key|
-            load_breweries_for_country( country_key, name )
-          end
-    elsif match_brewpubs_for_country_n_region( name ) do |country_key, region_key|
-            load_breweries_for_country_n_region( country_key, region_key, name, brewpub: true )
-          end
-    elsif match_brewpubs_for_country( name ) do |country_key|
-            load_breweries_for_country( country_key, name, brewpub: true )
-          end
-    else
-      logger.error "unknown beer.db fixture type >#{name}<"
-      # todo/fix: exit w/ error
-    end
-  end
-
-
-  def load_beers_for_country_n_region( country_key, region_key, name, more_attribs={} )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-    more_attribs[ :country_id ] = country.id
-
-    # NB: region lookup requires country id (region key only unique for country)
-    region  = Region.find_by_key_and_country_id( region_key, country.id )
-    if region.nil?
-      # note: allow unknown region keys; issue warning n skip region
-      logger.warn "Region w/ key >#{region_key}< not found; skip adding region"
-    else
-      logger.debug "Region #{region.key} >#{region.title}<"
-      more_attribs[ :region_id  ] = region.id
-    end
-
-    more_attribs[ :txt ] = name  # store source ref
-
-    load_beers_worker( name, more_attribs )
-  end
-
-  def load_beers_for_country( country_key, name, more_attribs={} )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-
-    more_attribs[ :country_id ] = country.id
-
-    more_attribs[ :txt ] = name  # store source ref
-
-    load_beers_worker( name, more_attribs )
-  end
-
-
-  def load_beers_worker( name, more_attribs={} )
-
-    reader = create_beers_reader( name, more_attribs )  ### "virtual" method - required by concrete class
-
-    ### todo: cleanup - check if [] works for build_title...
-    #     better cleaner way ???
-    if more_attribs[:region_id].present?
-      known_breweries_source = Brewery.where( region_id:  more_attribs[:region_id] )
-    elsif more_attribs[:country_id].present?
-      known_breweries_source = Brewery.where( country_id: more_attribs[:country_id] )
-    else
-      logger.warn "no region or country specified; use empty brewery ary for header mapper"
-      known_breweries_source = []
-    end
-
-    known_breweries  = TextUtils.build_title_table_for( known_breweries_source )
-
-
-    reader.each_line do |new_attributes, values|
-
-      ## note: check for header attrib; if present remove
-      ### todo: cleanup code later
-      ## fix: add to new_attributes hash instead of values ary
-      ##   - fix: match_brewery()   move region,city code out of values loop for reuse at the end
-      if new_attributes[:header].present?
-        brewery_line = new_attributes[:header].dup   # note: make sure we make a copy; will use in-place string ops
-        new_attributes.delete(:header)   ## note: do NOT forget to remove from hash!
-
-        logger.debug "  trying to find brewery in line >#{brewery_line}<"
-        ## todo: check what map_titles_for! returns (nothing ???)
-        TextUtils.map_titles_for!( 'brewery', brewery_line, known_breweries )
-        brewery_key = TextUtils.find_key_for!( 'brewery', brewery_line )
-        logger.debug "  brewery_key = >#{brewery_key}<"
-        unless brewery_key.nil?
-          ## bingo! add brewery_id upfront, that is, as first value in ary
-          values = values.unshift "by:#{brewery_key}"
-        end
-      end
-
-      Beer.create_or_update_from_attribs( new_attributes, values )
-    end # each_line
-  end
-
-
-  def load_breweries_for_country_n_region( country_key, region_key, name, more_attribs={} )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-
-    more_attribs[ :country_id ] = country.id
-
-    # note: region lookup requires country id (region key only unique for country)
-    region  = Region.find_by_key_and_country_id( region_key, country.id )
-    if region.nil?
-      # note: allow unknown region keys; issue warning n skip region
-      logger.warn "Region w/ key >#{region_key}< not found; skip adding region"
-    else
-      logger.debug "Region #{region.key} >#{region.title}<"
-      more_attribs[ :region_id  ] = region.id
-    end
-
-    more_attribs[ :txt ] = name  # store source ref
-
-    load_breweries_worker( name, more_attribs )
-  end
-
-  def load_breweries_for_country( country_key, name, more_attribs={} )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-
-    more_attribs[ :country_id ] = country.id
-
-    more_attribs[ :txt ] = name  # store source ref
-
-    load_breweries_worker( name, more_attribs )
-  end
-
-  def load_breweries_worker( name, more_attribs={} )
-    
-    if name =~ /\(m\)/     # check for (m) mid-size/medium marker -todo- use $?? must be last?
-       more_attribs[ :prod_m ] = true
-    elsif name =~ /\(l\)/  # check for (l) large marker - todo - use $?? must be last?
-       more_attribs[ :prod_l ] = true
-    else
-      ## no marker; do nothing
-    end
-
-    reader = create_breweries_reader( name, more_attribs ) ### "virtual" method - required by concrete class
-
-    reader.each_line do |new_attributes, values|
-      
-      #######
-      # fix: move to (inside)
-      #    Brewery.create_or_update_from_attribs ||||
-      ## note: group header not used for now; do NOT forget to remove from hash!
-      if new_attributes[:header].present?
-        logger.warn "removing unused group header #{new_attributes[:header]}"
-        new_attributes.delete(:header)   ## note: do NOT forget to remove from hash!
-      end
-      
-      Brewery.create_or_update_from_attribs( new_attributes, values )
-    end # each_line
-  end
-
-end # class ReaderBase
-end # module BeerDb

data/lib/beerdb/reader_file.rb

@@ -1,62 +0,0 @@
-# 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
-