tagutils 0.1.1 → 0.2.0

data/Manifest.txt

@@ -4,9 +4,12 @@ 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.rb
+lib/tagutils/schema_categories.rb
+lib/tagutils/schema_tags.rb
 lib/tagutils/version.rb
 test/helper.rb
 test/test_models.rb

data/README.md

@@ -10,21 +10,63 @@ tagutils gems - tag utilities (tag, taggings, tag list, etc.)
 
 ## Usage
 
+### Schema / Tables
+
+Use `TagDb.create` to build the `tags` and `taggings` tables
+and `CategoryDb.create` to build the `categories` and `categorizations` tables.
+Example:
+
 ~~~
-class Country < ActiveRecord::Base
+# ...
+TagDb.create
+# ...
+CategoryDb.create
+# ...
+~~~
+
+
+### Models
+
+Add the associations yourself with the standard `has_many` class macro:
+
+~~~
+class Movie < ActiveRecord::Base
+  # ...
   has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
   has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
+  # ...
+  has_many :categorizations, class_name: 'CategoryDb::Model::Categorizations', :as      => :categorizable
+  has_many :categories,      class_name: 'CategoryDb::Model::Category',        :through => :categorizations
+  # ...
 end
 ~~~
 
-or
+or use the built-in class macro shortcuts:
 
 ~~~
-class Country < ActiveRecord::Base
+class Movie < ActiveRecord::Base
+  # ...
   has_many_tags
+  # ...
+  has_many_categories
+  # ...
 end
 ~~~
 
+The `has_many_tags` also adds the following methods:
+
+~~~
+Movie.with_tag( 'doc' )
+# e.g. scope :with_tag, ->(tag_key){ joins(:tags).where('tags.key' => tag_key) }
+~~~
+
+The `has_many_categories` also adds the following methods:
+
+~~~
+Movie.with_category( 'doc' )
+# e.g. scope :with_category, ->(category_key){ joins(:categories).where('categories.key' => category_key) }
+~~~
+
 
 ## Real World Usage
 
@@ -186,6 +228,21 @@ create_table :categoryz3_child_items do |t|
 end
 ~~~
 
+- [categorizable](https://github.com/boof/categorizable)
+
+~~~
+create_table :categories do |t|
+  t.string     :name, null: false
+  t.timestamps
+end
+
+create_table :categorizations do |t|
+  t.references :category,      null: false
+  t.references :categorizable, null: false, :polymorphic: true
+  t.timestamps
+end
+~~~
+
 - [acts_as_category](https://github.com/wuwx/acts_as_category)
 
 

data/lib/tagutils.rb

@@ -9,12 +9,16 @@ require 'logutils'
 
 require 'tagutils/version'  # let it always go first
 
-require 'tagutils/schema'
+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/active_record'   # -- adds has_many_tags macro
+
+require 'tagutils/active_record'   # -- adds has_many_tags, has_many_categories class macros
 
 
 module TagUtils
@@ -58,5 +62,39 @@ module TagDb
 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/active_record.rb

@@ -1,14 +1,48 @@
 
+module TagDb
+  module ClassMacros
+    def has_many_tags( opts={} )
+      puts "  [TagDb.has_many_tags] adding taggings n tags has_many assocs to model >#{name}<"
 
-module ActiveRecord
-  class Base
-
-    def self.has_many_tags( opts={} )
-      puts "  [TagUtils.has_many_tags] adding taggings n tags has_many assocs to model >#{name}<"
       has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
       has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
+
+      ### check: use tag_name instead of tag_key ???
+      scope :with_tag, ->(tag_key){ joins(:tags).where('tags.key' => tag_key) }
     end
+    
+    ## same as scope above
+    ## def with_tag( tag_key )
+    ##  joins(:tags).where( 'tags.key' => tag_key )
+    ## end
+  end
+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/categorization.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module CategoryDb
+  module Model
+
+
+class Categorization < ActiveRecord::Base
+
+  belongs_to :category
+  belongs_to :categorizable, :polymorphic => true
+
+  ## validates :category,      presence: true
+  ## validates :categorizable, presence: true
+
+end   # class Categorization
+
+
+  end # module CategoryDb
+end # module Model

data/lib/tagutils/models/category.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module CategoryDb
+  module Model
+
+class Category < ActiveRecord::Base
+
+  self.table_name = 'categories'
+
+  has_many :categorizations
+
+  ###
+  ## todo/fix: add validate for key - what constraints to use ??
+  #
+  ## nb: only allow spaces and underscore inbetween;
+  ##  do NOT allow digit as first char for now
+  # validates :key,  :format => { :with    => /^([a-z]|[a-z][a-z0-9_ ]*[a-z0-9])$/,
+  #                              :message => 'expected one or more lowercase letters a-z or 0-9 digits or space or underscore' }
+
+  scope :by_key,  -> { order( 'key desc' ) }
+  scope :by_name, -> { order( 'name desc' ) }
+
+  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( ' ', '-' )
+  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 # module CategoryDb
+end # module Model

data/lib/tagutils/models/tag.rb

@@ -12,9 +12,9 @@ class Tag < ActiveRecord::Base
     validates :key,  :format => { :with    => /^([a-z]|[a-z][a-z0-9_ ]*[a-z0-9])$/,
                                   :message => 'expected one or more lowercase letters a-z or 0-9 digits or space or underscore' }
 
-    scope :by_key,   order( 'key desc' )
-    scope :by_name,  order( 'name desc' )
-    scope :top,      where( 'grade=1' )
+    scope :by_key,   -> { order( 'key desc' )  }
+    scope :by_name,  -> { order( 'name desc' ) }
+    scope :top,      -> { where( 'grade=1' )   }
 
 
     before_save :on_before_save
@@ -34,7 +34,7 @@ class Tag < ActiveRecord::Base
   def title()       name;              end
   def title=(value) self.name = value; end
   
-  scope :by_title, order( 'name desc' )  ### depreciated ??? - use by_name
+  scope :by_title,  -> { order( 'name desc' ) }  ### depreciated ??? - use by_name
 
 
 end   # class Tag

data/lib/tagutils/models/tagging.rb

@@ -9,6 +9,9 @@ class Tagging < ActiveRecord::Base
   belongs_to :tag
   belongs_to :taggable, :polymorphic => true
 
+  ## validates :tag,      presence: true
+  ## validates :taggable, presence: true
+
 end   # class Tagging
 
 

data/lib/tagutils/schema_categories.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module CategoryDb
+
+class CreateDb < ActiveRecord::Migration
+
+  def up
+
+create_table :categories do |t|
+  t.string     :key,   null: false
+  t.string     :slug,  null: false
+  t.string     :name,  null: false
+  t.references :parent
+  # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+  t.timestamps
+end
+
+add_index :categories, :key, unique: true
+
+create_table :categorizations do |t|
+  t.references :category,      null: false
+  t.references :categorizable, null: false, polymorphic: true
+
+  # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+  t.timestamps
+end
+
+###
+# note: use name prop
+#  too avoid error index name too long (e.g. sqlite requires <64 chars)
+
+add_index :categorizations, :category_id, name: 'categorizations_cats_idx'
+add_index :categorizations, [:categorizable_id, :categorizable_type], name: 'categorizations_idx'
+add_index :categorizations, [:categorizable_id, :categorizable_type, :category_id], unique: true, name: 'categorizations_unique_idx'
+
+  end # method up
+
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+
+end  # class CreateDb
+
+end # module CategoryDb

data/lib/tagutils/{schema.rb → schema_tags.rb}

@@ -12,7 +12,8 @@ create_table :tags do |t|
   t.string  :name    # todo: make required?  -- note: was title formerly
   t.integer :grade, null: false, default: 1  # grade/tier e.g. 1/2/3 for now
 
-  ## todo: add parent or similar for hierachy (for tag stacks/packs)
+  # parent used for hierachy (e.g. lets you use tag stacks/packs etc.)
+  t.references :parent
 
   # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
   t.timestamps

data/lib/tagutils/version.rb

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

data/test/helper.rb

@@ -27,14 +27,19 @@ require 'logutils/db'   # NB: explict require required for LogDb (not automatic)
 
 
 
-Tag      = TagDb::Model::Tag
-Tagging  = TagDb::Model::Tagging
+Tag            = TagDb::Model::Tag
+Tagging        = TagDb::Model::Tagging
+
+Category       = CategoryDb::Model::Category
+Categorization = CategoryDb::Model::Categorization
 
 
 class Movie < ActiveRecord::Base
   has_many_tags
+  has_many_categories
 end
 
+
 class CreateMovieDb < ActiveRecord::Migration
 
   def up
@@ -74,6 +79,7 @@ def setup_in_memory_db
 
   LogDb.create
   TagDb.create
+  CategoryDb.create
   CreateMovieDb.new.up
 
 end

data/test/test_models.rb

@@ -6,29 +6,80 @@ class TestModels < MiniTest::Unit::TestCase
 
   def setup
     TagDb.delete!
+    CategoryDb.delete!
+
+    Movie.delete_all
   end
 
   def test_count
     assert_equal 0, Tag.count
     assert_equal 0, Tagging.count
+
+    assert_equal 0, Category.count
+    assert_equal 0, Categorization.count
+
     assert_equal 0, Movie.count
   end
 
+
+  def test_with
+    tag = Tag.create!( key: 'key', name: 'name' )
+    cat = Category.create!( key: 'key', name: 'name' )
+
+    ## add 1st movie
+    movie = Movie.create!( key: 'key', name: 'name' )
+  
+    movie.tags       << tag
+    movie.categories << cat
+
+    assert_equal 1, Movie.with_tag( 'key' ).count
+    assert_equal 0, Movie.with_tag( 'xxx' ).count
+
+    assert_equal 1, Movie.joins(:categories).count
+    assert_equal 1, Movie.joins(:categories).where( 'categories.key' => 'key' ).count
+
+    assert_equal 1, Movie.with_category( 'key' ).count
+    assert_equal 0, Movie.with_category( 'xxx' ).count
+
+    ## add another (2nd) movie
+    movie2 = Movie.create!( key: 'key2', name: 'name2' )
+
+    movie2.tags       << tag
+    movie2.categories << cat
+
+    assert_equal 2, Movie.with_tag( 'key' ).count
+    assert_equal 0, Movie.with_tag( 'xxx' ).count
+
+    assert_equal 2, Movie.with_category( 'key' ).count
+    assert_equal 0, Movie.with_category( 'xxx' ).count
+  end
+
+
   def test_assocs
     tag = Tag.new( key: 'key', name: 'name' )
     assert_equal 0, tag.taggings.count
 
+    cat = Category.new( key: 'key', name: 'name' )
+    assert_equal 0, cat.categorizations.count
+
     movie = Movie.new( key: 'key', name: 'name' )
     assert_equal 0, movie.taggings.count
     assert_equal 0, movie.tags.count
+    
+    assert_equal 0, movie.categorizations.count
+    assert_equal 0, movie.categories.count
 
     tag.save!
+    cat.save!
     movie.save!
 
     assert_equal 0, tag.taggings.count
+    assert_equal 0, cat.categorizations.count
 
     assert_equal 0, movie.taggings.count
     assert_equal 0, movie.tags.count
+    assert_equal 0, movie.categorizations.count
+    assert_equal 0, movie.categories.count
 
     ## note: add tag; op << will auto-save
     movie.tags << tag
@@ -36,6 +87,13 @@ class TestModels < MiniTest::Unit::TestCase
     assert_equal 1, tag.taggings.count
     assert_equal 1, movie.taggings.count
     assert_equal 1, movie.tags.count
+
+    ## note: add tag; op << will auto-save
+    movie.categories << cat
+
+    assert_equal 1, cat.categorizations.count
+    assert_equal 1, movie.categorizations.count
+    assert_equal 1, movie.categories.count
   end
 
 end # class TestModels

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagutils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &72493260 !ruby/object:Gem::Requirement
+  requirement: &85193010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72493260
+  version_requirements: *85193010
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &72492220 !ruby/object:Gem::Requirement
+  requirement: &85192530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *72492220
+  version_requirements: *85192530
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &72582430 !ruby/object:Gem::Requirement
+  requirement: &85191800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *72582430
+  version_requirements: *85191800
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &72582120 !ruby/object:Gem::Requirement
+  requirement: &85191060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *72582120
+  version_requirements: *85191060
 description: tagutils - tag utilities (tag, taggings, tag list, etc.)
 email: openmundi@googlegroups.com
 executables: []
@@ -68,9 +68,12 @@ files:
 - 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.rb
+- lib/tagutils/schema_categories.rb
+- lib/tagutils/schema_tags.rb
 - lib/tagutils/version.rb
 - test/helper.rb
 - test/test_models.rb