tagutils 0.2.0 → 0.2.1

data/Manifest.txt

@@ -3,13 +3,21 @@ Manifest.txt
 README.md
 Rakefile
 lib/tagutils.rb
-lib/tagutils/active_record.rb
-lib/tagutils/models/categorization.rb
-lib/tagutils/models/category.rb
-lib/tagutils/models/tag.rb
-lib/tagutils/models/tagging.rb
-lib/tagutils/schema_categories.rb
-lib/tagutils/schema_tags.rb
+lib/tagutils/categories.rb
+lib/tagutils/categories/active_record.rb
+lib/tagutils/categories/models/categorization.rb
+lib/tagutils/categories/models/category.rb
+lib/tagutils/categories/models/category_comp.rb
+lib/tagutils/categories/schema.rb
+lib/tagutils/tags.rb
+lib/tagutils/tags/active_record.rb
+lib/tagutils/tags/models/tag.rb
+lib/tagutils/tags/models/tag_comp.rb
+lib/tagutils/tags/models/tagging.rb
+lib/tagutils/tags/readers/tag.rb
+lib/tagutils/tags/schema.rb
 lib/tagutils/version.rb
 test/helper.rb
+test/tags.1.yml
 test/test_models.rb
+test/test_tag_reader.rb

data/README.md

@@ -67,6 +67,31 @@ Movie.with_category( 'doc' )
 # e.g. scope :with_category, ->(category_key){ joins(:categories).where('categories.key' => category_key) }
 ~~~
 
+### Reader
+
+The `TagReader` lets you read plain text fixtures (data sets). Example:
+
+~~~
+tags.1.yml:
+-----------
+
+# organizations
+
+orgs: un, g5, g8, g20, eu, commonwealth, mercosur, nafta
+football: fifa, uefa, afc, ofc, caf, csf, concacaf
+
+# national regions
+
+brasil: s|South, se|Southeast, co|Centerwest, ne|Northeast, n|North
+~~~
+
+To read the tags use:
+
+~~~
+TagReader.new( <include_path>).read( `tags.1` )
+~~~
+
+
 
 ## Real World Usage
 

data/lib/tagutils.rb

@@ -2,24 +2,44 @@
 # 3rd party gems / libs
 
 require 'active_record'   ## todo: add sqlite3? etc.
+
+require 'props'
+require 'props/db'  # note: also use ConfDb (ConfDb::Model::Prop etc.)
 require 'logutils'
+require 'textutils'
+
+#########
+# fix/todo:
+#   move props/db  - Props.create_from_fixture! to textutils/db
+#    require 'textutils/db'
+
+#######################
+# fix/remove once removed from HashReaderV2
+
+module WorldDb
+  module Model
+    Prop = ConfDb::Model::Prop
+  end
+  Models = Model
+end
+
 
 
 # our own code
 
 require 'tagutils/version'  # let it always go first
 
-require 'tagutils/schema_tags'
-require 'tagutils/models/tag'
-require 'tagutils/models/tagging'
-
-require 'tagutils/schema_categories'
-require 'tagutils/models/category'
-require 'tagutils/models/categorization'
+require 'tagutils/tags'
+require 'tagutils/categories'
 
 
-require 'tagutils/active_record'   # -- adds has_many_tags, has_many_categories class macros
 
+####
+# use shared/common module/namespace ?
+#   e.g.
+#   - ClassificationDb, ClassiDb ??
+#   - TaxonomyDb, TaxonDb, TaxyDb ??? 
+#   - TopicDb, KeywordDb ??  --  why? why not??
 
 module TagUtils
 
@@ -34,67 +54,4 @@ module TagUtils
 end  # module TagUtils
 
 
-
-module TagDb
-
-  #####
-  # add convenience module alias in plural
-  #   e.g. lets you use include TagDb::Models
-  Models = Model
-
-  def self.create
-    CreateDb.new.up
-    ## WorldDb::Model::Prop.create!( key: 'db.schema.world.version', value: VERSION )
-  end
-
-  # delete ALL records (use with care!)
-  def self.delete!
-    puts '*** deleting tag/tagging table records/data...'
-    Model::Tagging.delete_all
-    Model::Tag.delete_all
-  end
-
-  def self.tables
-    puts "#{Model::Tag.count} tags"
-    puts "#{Model::Tagging.count} taggings"
-  end
-
-end # module TagDb
-
-
-module CategoryDb
-  #####
-  # add convenience module alias in plural
-  #   e.g. lets you use include CategoryDb::Models
-  Models = Model
-
-  def self.create
-    CreateDb.new.up
-    ## WorldDb::Model::Prop.create!( key: 'db.schema.world.version', value: VERSION )
-  end
-
-  # delete ALL records (use with care!)
-  def self.delete!
-    puts '*** deleting category/categorization table records/data...'
-    Model::Categorization.delete_all
-    Model::Category.delete_all
-  end
-
-  def self.tables
-    puts "#{Model::Category.count} categories"
-    puts "#{Model::Categorization.count} categorizations"
-  end
-end # module CategoryDb
-
-CatDb = CategoryDb  # for conveniene add alias for CatDb
-
-
-####
-# use shared/common module/namespace ?
-#   e.g.
-#   - ClassificationDb, ClassiDb ??
-#   - TaxonomyDb, TaxonDb, TaxyDb ??? 
-#   - TopicDb, KeywordDb ??  --  why? why not??
-
-
 puts TagUtils.banner    # say hello

data/lib/tagutils/categories.rb

@@ -0,0 +1,31 @@
+
+
+require 'tagutils/categories/schema'
+require 'tagutils/categories/models/category'
+require 'tagutils/categories/models/category_comp'
+require 'tagutils/categories/models/categorization'
+
+require 'tagutils/categories/active_record'   # -- adds has_many_tags, has_many_categories class macros
+
+
+module CategoryDb
+  VERSION = TagUtils::VERSION
+
+  def self.create
+    CreateDb.new.up
+    ConfDb::Model::Prop.create!( key: 'db.schema.category.version', value: VERSION )
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting category/categorization table records/data...'
+    Model::Categorization.delete_all
+    Model::Category.delete_all
+  end
+
+  def self.tables
+    puts "  #{Model::Category.count} categories"
+    puts "  #{Model::Categorization.count} categorizations"
+  end
+end # module CategoryDb
+

data/lib/tagutils/categories/active_record.rb

@@ -0,0 +1,27 @@
+
+module CategoryDb
+  module ClassMacros
+    def has_many_categories( opts={} )
+      puts "  [CategoryDb.has_many_categories] adding categorizations n category has_many assocs to model >#{name}<"
+
+      has_many :categorizations, class_name: 'CategoryDb::Model::Categorization', :as      => :categorizable
+      has_many :categories,      class_name: 'CategoryDb::Model::Category',       :through => :categorizations
+
+      ### check: use category_name instead of category_key  ???
+      scope :with_category, ->(category_key){ joins(:categories).where('categories.key' => category_key) }
+    end
+
+    ## same as scope above
+    ## def with_category( category_key )
+    ##  joins(:categories).where( 'categories.key' => category_key )
+    ## end
+  end
+end
+
+
+module ActiveRecord
+  class Base
+    extend CategoryDb::ClassMacros
+  end # class Base
+end # module ActiveRecord
+

data/lib/tagutils/{models → categories/models}/category.rb

@@ -23,22 +23,18 @@ class Category < ActiveRecord::Base
   before_save :on_before_save
 
   def on_before_save
-    # replace space with dash e.g. north america becomes north-america and so on
-    self.slug = key.gsub( ' ', '-' )
+    # replace space with dash e.g. north america becomes north_america and so on
+    self.slug = key.gsub( ' ', '_' )
   end
 
-
-  ############################################################################
-  # alias for name (remove! add depreciated api call) ?? why? why not??
-
-  def title()       name;              end
-  def title=(value) self.name = value; end
-  
-  scope :by_title, -> { order( 'name desc' ) }  ### depreciated ??? - use by_name
+end   # class Category
 
 
-end   # class Category
+  end # module Model
 
+  #####
+  # add convenience module alias in plural
+  #   e.g. lets you use include CategoryDb::Models
+  Models = Model
 
-  end # module CategoryDb
-end # module Model
+end # module CategoryDb

data/lib/tagutils/categories/models/category_comp.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module CategoryDb
+  module Model
+
+class Category
+
+  ##############################################
+  # alias for name (depreciated api calls)
+
+  def title()       name;              end
+  def title=(value) self.name = value; end
+  
+  scope :by_title, -> { order( 'name desc' ) }
+
+end   # class Category
+
+
+  end # module CategoryDb
+end # module Model

data/lib/tagutils/tags.rb

@@ -0,0 +1,34 @@
+
+
+require 'tagutils/tags/schema'
+require 'tagutils/tags/models/tag'
+require 'tagutils/tags/models/tag_comp'
+require 'tagutils/tags/models/tagging'
+
+require 'tagutils/tags/active_record'   # -- adds has_many_tags, has_many_categories class macros
+require 'tagutils/tags/readers/tag'
+
+
+
+module TagDb
+  VERSION = TagUtils::VERSION
+
+  def self.create
+    CreateDb.new.up
+    ConfDb::Model::Prop.create!( key: 'db.schema.tag.version', value: VERSION )
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting tag/tagging table records/data...'
+    Model::Tagging.delete_all
+    Model::Tag.delete_all
+  end
+
+  def self.tables
+    puts "  #{Model::Tag.count} tags"
+    puts "  #{Model::Tagging.count} taggings"
+  end
+
+end # module TagDb
+

data/lib/tagutils/{active_record.rb → tags/active_record.rb}

@@ -19,30 +19,11 @@ module TagDb
 end
 
 
-module CategoryDb
-  module ClassMacros
-    def has_many_categories( opts={} )
-      puts "  [CategoryDb.has_many_categories] adding categorizations n category has_many assocs to model >#{name}<"
-
-      has_many :categorizations, class_name: 'CategoryDb::Model::Categorization', :as      => :categorizable
-      has_many :categories,      class_name: 'CategoryDb::Model::Category',       :through => :categorizations
-
-      ### check: use category_name instead of category_key  ???
-      scope :with_category, ->(category_key){ joins(:categories).where('categories.key' => category_key) }
-    end
-
-    ## same as scope above
-    ## def with_category( category_key )
-    ##  joins(:categories).where( 'categories.key' => category_key )
-    ## end
-  end
-end
 
 
 module ActiveRecord
   class Base
     extend TagDb::ClassMacros
-    extend CategoryDb::ClassMacros
   end # class Base
 end # module ActiveRecord
 

data/lib/tagutils/{models → tags/models}/tag.rb

@@ -20,25 +20,20 @@ class Tag < ActiveRecord::Base
     before_save :on_before_save
 
     def on_before_save
-      # replace space with dash e.g. north america becomes north-america and so on
-      self.slug = key.gsub( ' ', '-' )
- 
+      # replace space with dash e.g. north america becomes north_america and so on
+      self.slug = key.gsub( ' ', '_' )
+
       ## if name is empty auto fill w/ key
       self.name = key   if name.blank?
     end
 
-
-  ############################################################################
-  # alias for name (remove! add depreciated api call) ?? why? why not??
-
-  def title()       name;              end
-  def title=(value) self.name = value; end
-  
-  scope :by_title,  -> { order( 'name desc' ) }  ### depreciated ??? - use by_name
-
-
 end   # class Tag
 
+  end # module Model
+
+  #####
+  # add convenience module alias in plural
+  #   e.g. lets you use include TagDb::Models
+  Models = Model
 
-  end # module TagDb
-end # module Model
+end # module TagDb

data/lib/tagutils/tags/models/tag_comp.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module TagDb
+  module Model
+
+class Tag
+
+  ##################################################
+  # alias for name (depreciated api calls)
+
+  def title()       name;              end
+  def title=(value) self.name = value; end
+
+  scope :by_title,  -> { order( 'name desc' ) }
+
+end   # class Tag
+
+
+  end # module TagDb
+end # module Model

data/lib/tagutils/tags/readers/tag.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+
+### use TagUtils - why? why not??
+module TagDb
+
+
+class TagReader
+
+  include LogUtils::Logging
+
+## make models available by default with namespace
+#  e.g. lets you use Tag instead of Model::Tag
+  include Models
+
+## value helpers e.g. is_year?, is_taglist? etc.
+  include TextUtils::ValueHelper
+
+
+  attr_reader :include_path
+
+  def strict?()      @strict == true;     end
+
+  def initialize( include_path, opts = {} )
+    
+    @include_path = include_path
+    
+    ## option: for now issue warning on update, that is, if key/record (country,region,city) already exists
+    @strict    =  opts[:strict].present? ? true : false
+  end
+
+
+  def read( name )
+    ## check for grade in name e.g. tag.1, tag.2 etc.
+
+    if name =~ /^tag.*\.(\d)$/
+       read_worker( name, :grade => $1.to_i )
+    else
+       read_worker( name )
+    end
+  end
+
+
+  def read_worker( name, more_attribs={} )
+
+      reader = HashReaderV2.new( name, include_path )
+
+      grade = 1
+    
+      if more_attribs[:grade].present?
+        grade = more_attribs[:grade].to_i
+      end
+
+      reader.each do |key, value|
+       
+         ### fix/todo: move to Tag.read method for reuse !!!! 
+        
+        
+        ### split value by comma (e.g. northern america,southern america, etc.)
+        logger.debug "adding grade #{grade} tags >>#{key}<< >>#{value}<<..."
+        tag_pairs = value.split(',')
+        tag_pairs.each do |pair|
+        ## split key|name
+          values = pair.split('|')
+        
+          key   = values[0]
+          ### remove (optional comment) from key (e.g. carribean (islands))
+          key = key.gsub( /\(.+\)/, '' )
+          ## remove leading n trailing space
+          key = key.strip
+          
+          name = values[1] || ''  # nb: name might be empty/missing
+          name = name.strip
+
+          tag_attribs = {}
+        
+          ## check if it exists
+          ## todo/fix: add country_id for lookup?
+          tag = Tag.find_by_key( key )
+          if tag.present?
+            logger.debug "update tag #{tag.id}-#{tag.key}:"
+          else
+            logger.debug "create tag:"
+            tag = Tag.new
+            tag_attribs[ :key ] = key
+          end
+
+          tag_attribs[ :name  ] = name
+          tag_attribs[ :grade ] = grade
+
+          logger.debug tag_attribs.to_json
+
+          tag.update_attributes!( tag_attribs )
+        end
+    end # each key,value
+
+  end # method read_worker
+
+
+end # class TagReader
+end # module TagDb

data/lib/tagutils/version.rb

@@ -1,4 +1,4 @@
 
 module TagUtils
-   VERSION = '0.2.0'
+   VERSION = '0.2.1'
 end

data/test/helper.rb

@@ -20,6 +20,7 @@ require 'logger'
 
 require 'active_record'
 
+
 # our own code
 
 require 'tagutils'
@@ -78,10 +79,11 @@ def setup_in_memory_db
   ## build schema
 
   LogDb.create
+  ConfDb.create
+
   TagDb.create
   CategoryDb.create
   CreateMovieDb.new.up
-
 end
 
 

data/test/tags.1.yml

@@ -0,0 +1,35 @@
+### setup some grade 1 tags
+
+## some tags
+
+continents: africa, america, asia, europe, oceania
+
+####################
+# geo regions
+africa: northern africa, western africa, central africa, eastern africa, southern africa
+
+americas: north america, south america, central america, caribbean (islands)
+
+## check if yaml can handle key w/ space??
+south_america: andean states, southern cone
+
+europe: northern europe, southern europe, western europe, central europe, eastern europe, southeastern europe
+
+## more regions
+europe2: baltic (states), scandinavia, nordic (countries), balkans
+
+
+## get used for more than one continent
+more: middle east, indian ocean, atlantic ocean
+
+# orgs
+
+orgs: un, g5, g8, g20, eu, commonwealth, mercosur, nafta
+football: fifa, uefa, afc, ofc, caf, csf, concacaf
+
+europe3: benelux, euro, schengen
+
+misc: microstate
+
+# national regions
+brasil: s|South, se|Southeast, co|Centerwest, ne|Northeast, n|North

data/test/test_tag_reader.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestTagReader < MiniTest::Unit::TestCase
+
+  def setup
+    TagDb.delete!
+    CategoryDb.delete!
+
+    Movie.delete_all
+  end
+
+  def test_read
+    include_path = "#{TagUtils.root}/test"
+    puts "[TestTagReader.test_read] include_path: #{include_path}"
+    
+    reader = TagDb::TagReader.new( include_path )
+    reader.read( 'tags.1' )
+  end
+
+
+end # class TestTagReader

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagutils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &85193010 !ruby/object:Gem::Requirement
+  requirement: &86092400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85193010
+  version_requirements: *86092400
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &85192530 !ruby/object:Gem::Requirement
+  requirement: &86091990 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *85192530
+  version_requirements: *86091990
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &85191800 !ruby/object:Gem::Requirement
+  requirement: &86091650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *85191800
+  version_requirements: *86091650
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &85191060 !ruby/object:Gem::Requirement
+  requirement: &86091280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *85191060
+  version_requirements: *86091280
 description: tagutils - tag utilities (tag, taggings, tag list, etc.)
 email: openmundi@googlegroups.com
 executables: []
@@ -67,16 +67,24 @@ files:
 - README.md
 - Rakefile
 - lib/tagutils.rb
-- lib/tagutils/active_record.rb
-- lib/tagutils/models/categorization.rb
-- lib/tagutils/models/category.rb
-- lib/tagutils/models/tag.rb
-- lib/tagutils/models/tagging.rb
-- lib/tagutils/schema_categories.rb
-- lib/tagutils/schema_tags.rb
+- lib/tagutils/categories.rb
+- lib/tagutils/categories/active_record.rb
+- lib/tagutils/categories/models/categorization.rb
+- lib/tagutils/categories/models/category.rb
+- lib/tagutils/categories/models/category_comp.rb
+- lib/tagutils/categories/schema.rb
+- lib/tagutils/tags.rb
+- lib/tagutils/tags/active_record.rb
+- lib/tagutils/tags/models/tag.rb
+- lib/tagutils/tags/models/tag_comp.rb
+- lib/tagutils/tags/models/tagging.rb
+- lib/tagutils/tags/readers/tag.rb
+- lib/tagutils/tags/schema.rb
 - lib/tagutils/version.rb
 - test/helper.rb
+- test/tags.1.yml
 - test/test_models.rb
+- test/test_tag_reader.rb
 - .gemtest
 homepage: https://github.com/rubylibs/tagutils
 licenses:
@@ -107,3 +115,4 @@ specification_version: 3
 summary: tagutils - tag utilities (tag, taggings, tag list, etc.)
 test_files:
 - test/test_models.rb
+- test/test_tag_reader.rb