beerdb-models 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81cbea581c2fdb972632982aa387c16ad9c8120c
+  data.tar.gz: 8865a095da2b63a7e11447452226d29af752d8d3
+SHA512:
+  metadata.gz: 541a57ed981411438c18a0e40f9d276c84e9922d3dbe084aec5c4b807ec425e72b502cd5d15598278200fd1e514b8d1574b08094a440a7dad67f69dbf3a650f1
+  data.tar.gz: e9cc5b27bb0e342ca75e70b052743b5fe23b9b5fff12c77081028476d59fd5d7433f25d6b07273375aae9dc414863ecaa5eebdefdce5501e4bee0f25417ce479

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2012-10-17
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,25 @@
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+lib/beerdb/deleter.rb
+lib/beerdb/models.rb
+lib/beerdb/models/beer.rb
+lib/beerdb/models/brand.rb
+lib/beerdb/models/brewery.rb
+lib/beerdb/models/forward.rb
+lib/beerdb/models/tag.rb
+lib/beerdb/models/world/city.rb
+lib/beerdb/models/world/country.rb
+lib/beerdb/models/world/region.rb
+lib/beerdb/reader.rb
+lib/beerdb/reader_file.rb
+lib/beerdb/reader_zip.rb
+lib/beerdb/schema.rb
+lib/beerdb/serializers/beer.rb
+lib/beerdb/serializers/brewery.rb
+lib/beerdb/stats.rb
+lib/beerdb/version.rb
+test/helper.rb
+test/test_fixture_matchers.rb
+test/test_values.rb

data/README.md

@@ -0,0 +1,97 @@
+# beerdb-models - beer.db schema 'n' models for easy (re)use
+
+
+* home  :: [github.com/beerkit/beer.db.models](https://github.com/beerkit/beer.db.models)
+* bugs  :: [github.com/beerkit/beer.db.models/issues](https://github.com/beerkit/beer.db.models/issues)
+* gem   :: [rubygems.org/gems/beerdb-models](https://rubygems.org/gems/beerdb-models)
+* rdoc  :: [rubydoc.info/gems/beerdb-models](http://rubydoc.info/gems/beerdb-models)
+* forum :: [groups.google.com/group/beerdb](https://groups.google.com/group/beerdb)
+
+
+## Usage Models
+
+Brewery Model
+
+```
+by = Brewery.find_by_key( 'guinness' )
+
+by.title
+=> 'St. James's Gate Brewery / Guinness Brewery'
+
+by.country.key
+=> 'ie'
+
+by.country.title
+=> 'Ireland'
+
+by.city.title
+=> 'Dublin'
+
+by.beers.first
+=> 'Guinness', 4.2
+
+...
+```
+
+
+Beer Model
+
+```
+b = Beer.find_by_key( 'guinness' )
+
+b.title
+=> 'Guinness'
+
+b.abv
+=> 4.2
+
+b.tags
+=> 'irish_dry_stout', 'dry_stout', 'stout'
+
+b.brewery.title
+=> 'St. James's Gate Brewery / Guinness Brewery'
+
+...
+```
+
+
+Country Model
+
+```
+at = Country.find_by_key( 'at' )
+
+at.beers
+=> 'Weitra Helles', 'Hadmar', 'Zwettler Original', ...
+
+at.breweries
+=> 'Weitra Bräu Bierwerkstatt', 'Zwettler Brauerei', ...
+
+...
+```
+
+
+City Model
+
+```
+wien = City.find_by_key( 'wien' )
+
+wien.beers
+=> 'Ottakringer Helles', 'Ottakringer (Gold Fassl) Zwickl', ...
+
+wien.breweries
+=> 'Ottakringer Brauerei'
+
+...
+```
+
+
+## License
+
+The `beerdb-models` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Send them along to the [Open Beer & Brewery Database Forum/Mailing List](http://groups.google.com/group/beerdb).
+Thanks!
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'hoe'
+require './lib/beerdb/version.rb'
+
+
+Hoe.spec 'beerdb-models' do
+  
+  self.version = BeerDb::VERSION
+  
+  self.summary = "beerdb-models - beer.db schema 'n' models for easy (re)use"
+  self.description = summary
+
+  self.urls    = ['https://github.com/beerkit/beer.db.models']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'beerdb@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.extra_deps = [
+    ['worlddb-models', '>= 2.2.0'],  # Note: worlddb-models pulls in all dependencies
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 1.9.2'
+  }
+
+end

data/lib/beerdb/deleter.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module BeerDb
+
+  class Deleter
+    
+    include Models
+
+    def run
+      # for now delete all tables
+
+      ### fix: use if defined? BeerDbNote or similar or/and check if table exist ??
+      ###      or move to beerdb-note ??
+
+      ## Bookmark.delete_all   # db model extension - move to its own addon?
+      ## Drink.delete_all      # db model extension - move to its own addon?
+      ## Note.delete_all       # db model extension - move to its own addon?
+      ## User.delete_all       # db model extension - move to its own addon?
+
+      Beer.delete_all
+      Brand.delete_all
+      Brewery.delete_all
+    end
+    
+  end # class Deleter
+
+end # module BeerDb

data/lib/beerdb/models.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+
+require 'worlddb/models'    # Note: pull in all required stdlibs n gems via worlddb/models
+
+
+# our own code
+
+require 'beerdb/version'   ## version always goes first
+
+require 'beerdb/models/forward'
+require 'beerdb/models/world/country'
+require 'beerdb/models/world/region'
+require 'beerdb/models/world/city'
+require 'beerdb/models/tag'
+require 'beerdb/models/beer'
+require 'beerdb/models/brand'
+require 'beerdb/models/brewery'
+
+
+require 'beerdb/serializers/beer'
+require 'beerdb/serializers/brewery'
+
+require 'beerdb/schema'
+require 'beerdb/reader'
+require 'beerdb/reader_file'
+require 'beerdb/reader_zip'
+require 'beerdb/deleter'
+require 'beerdb/stats'
+
+
+module BeerDb
+
+
+  def self.create
+    CreateDb.new.up
+
+    ### fix: make optional do NOT auto create here
+    ### fix: use if defined? BeerDbNote or similar or/and check if table exist ??
+    ###      or move to beerdb-note ??
+
+    # CreateDbExtrasUsers.new.up
+    # CreateDbExtrasBookmarks.new.up
+    # CreateDbExtrasDrinks.new.up
+    # CreateDbExtrasNotes.new.up
+
+    ConfDb::Model::Prop.create!( key: 'db.schema.beer.version', value: VERSION )
+  end
+
+  ## convenience helper for all-in-one create for tables
+  def self.create_all
+    LogDb.create
+    ConfDb.create
+    TagDb.create
+    WorldDb.create
+    BeerDb.create
+  end
+
+
+  def self.read( ary, include_path )
+    reader = Reader.new( include_path )
+    ary.each do |name|
+      reader.load( name )
+    end
+  end
+
+  def self.read_setup( setup, include_path, opts={} )
+    reader = Reader.new( include_path, opts )
+    reader.load_setup( setup )
+  end
+
+  def self.read_setup_from_zip( zip_name, setup, include_path, opts={} )  ## todo/check - use a better (shorter) name ??
+    reader = ZipReader.new( zip_name, include_path, opts )
+    reader.load_setup( setup )
+    reader.close
+  end
+
+  def self.read_all( include_path, opts={} )  # load all builtins (using plain text reader); helper for convenience
+    read_setup( 'setups/all', include_path, opts )
+  end # method read_all
+
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting beer table records/data...'
+    Deleter.new.run
+  end # method delete!
+
+  def self.delete_all!( opts={} )
+    # to be done
+  end
+
+  def self.tables
+    Stats.new.tables
+  end
+
+
+end  # module BeerDb
+
+
+
+# say hello
+puts BeerDb.banner  if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)

data/lib/beerdb/models/beer.rb

@@ -0,0 +1,201 @@
+# encoding: UTF-8
+
+module BeerDb
+  module Model
+
+class Beer < 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?, self.is_address?, is_taglist? etc.
+
+  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'
+
+  belongs_to :brand,   :class_name => 'BeerDb::Model::Brewery',  :foreign_key => 'brand_id'
+  belongs_to :brewery, :class_name => 'BeerDb::Model::Brewery',  :foreign_key => 'brewery_id'
+
+
+  has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
+  has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
+
+
+  ## fix/todo: move to regex to patterns; see worlddb
+  validates :key, :format => { :with => /\A[a-z][a-z0-9]+\z/, :message => 'expected two or more lowercase letters a-z or 0-9 digits' }
+
+
+########################
+# begin extras/extension drink/bookmar/user
+
+  has_many :drinks ## :class_name => 'Drink'
+  has_many :notes  ## :class_name => 'Note'
+  has_many :bookmarks, :as => :bookmarkable
+
+# end extensions
+########
+
+
+  ### support old names (read-only) for now  (remove later)
+
+  def color()  puts "*** depreceated fn api - use srm"; srm;  end
+  def plato()  puts "*** depreceated fn api - use og";  og;   end
+
+  def color=(value)
+    puts "*** depreceated fn api - use srm="
+    self.srm = value
+  end
+
+  def plato=(value)
+    puts "*** depreceated fn api - use og="
+    self.og = value
+  end
+
+
+  def as_json_v2( opts={} )
+    # NB: do NOT overwrite "default" / builtin as_json, thus, lets use as_json_v2
+    BeerSerializer.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
+    Beer.create_or_update_from_attribs( attribs, more_values )
+  end
+
+
+  def self.create_or_update_from_attribs( attribs, values )
+
+    # fix: add/configure logger for ActiveRecord!!!
+    logger = LogKernel::Logger.root
+    
+    value_tag_keys    = []
+     
+    ## check for grades (e.g. ***/**/*) in titles (will add attribs[:grade] to hash)
+    ## if grade missing; set default to 4; lets us update overwrite 1,2,3 values on update
+    attribs[ :grade ] ||= 4
+    
+    ### check for "default" tags - that is, if present attribs[:tags] remove from hash
+    value_tag_keys += find_tags_in_attribs!( attribs )
+    
+    ## check for optional values
+    values.each_with_index do |value,index|
+      if match_country(value) do |country|
+           attribs[ :country_id ] = country.id
+         end
+      elsif match_region_for_country(value, attribs[:country_id]) do |region|
+              attribs[ :region_id ] = region.id
+            end
+      elsif match_city(value) do |city|
+              if city.present?
+                attribs[ :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 beer #{attribs[:key]}"
+              end
+            end
+      elsif match_brewery(value) do |brewery|
+              attribs[ :brewery_id ] = brewery.id
+
+              # for easy queries cache city and region ids
+          
+              # 1) check if brewery has city - if yes, use it for beer too
+              if brewery.city.present?
+                attribs[ :city_id ] = 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 brewery.city.present? && brewery.city.region.present?
+                attribs[ :region_id ] = brewery.city.region.id
+              elsif brewery.region.present?
+                attribs[ :region_id ] = brewery.region.id
+              end
+            end
+      elsif match_year( value ) do |num|  # founded/established year e.g. 1776
+              attribs[ :since ] = num
+            end
+      elsif match_website( value ) do |website|  # check for url/internet address e.g. www.ottakringer.at
+              attribs[ :web ] = website
+            end
+      elsif match_abv( value ) do |num|   # abv (alcohol by volume)
+              # nb: also allows leading < e.g. <0.5%
+              attribs[ :abv ] = num
+            end
+      elsif match_og( value ) do |num|  # plato (stammwuerze/gravity?) e.g. 11.2°
+              # nb: no whitespace allowed between ° and number e.g. 11.2°
+              attribs[ :og ] = num
+            end
+      elsif match_kcal( value ) do |num| # kcal
+              # nb: allow 44.4 kcal/100ml or 44.4 kcal or 44.4kcal
+              attribs[ :kcal ] = num
+            end
+      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 #{attribs[:key]}"
+      end
+    end # each value
+
+    #  rec = Beer.find_by_key_and_country_id( attribs[ :key ], attribs[ :country_id] )
+    rec = Beer.find_by_key( attribs[ :key ] )
+
+    if rec.present?
+      logger.debug "update Beer #{rec.id}-#{rec.key}:"
+    else
+      logger.debug "create Beer:"
+      rec = Beer.new
+    end
+      
+    logger.debug attribs.to_json
+
+    rec.update_attributes!( attribs )
+
+    ##################
+    # add taggings 
+
+##
+##  fix: delete all tags first or only add diff?
+##  fix e.g.
+##
+## [debug] update Beer 1340-opatsvetlevycepni:
+## [debug] {"title":"Opat Světlé Výčepní","key":"opatsvetlevycepni","country_id":130,"txt":"cz-czech-republic!/beers","grade":4,"brewery_id":839,"city_id":1154,"region_id":241,"abv":4.2,"og":11.0}
+## [debug]    adding 1 taggings: >>pale lager<<...
+## 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 (?, ?, ?, ?, ?)
+
+=begin
+    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
+
+    rec # NB: return created or updated obj
+
+  end # method create_or_update_from_values
+
+end # class Beer
+
+  end # module Model
+end # module BeerDb