tagutils 0.1.0 → 0.1.1

data/Manifest.txt

@@ -3,6 +3,10 @@ Manifest.txt
 README.md
 Rakefile
 lib/tagutils.rb
-lib/tagutils/models.rb
+lib/tagutils/active_record.rb
+lib/tagutils/models/tag.rb
+lib/tagutils/models/tagging.rb
 lib/tagutils/schema.rb
 lib/tagutils/version.rb
+test/helper.rb
+test/test_models.rb

data/README.md

@@ -7,9 +7,23 @@ tagutils gems - tag utilities (tag, taggings, tag list, etc.)
 * gem   :: [rubygems.org/gems/tagutils](https://rubygems.org/gems/tagutils)
 * rdoc  :: [rubydoc.info/gems/tagutils](http://rubydoc.info/gems/tagutils)
 
+
 ## Usage
 
-TBD
+~~~
+class Country < ActiveRecord::Base
+  has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
+  has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
+end
+~~~
+
+or
+
+~~~
+class Country < ActiveRecord::Base
+  has_many_tags
+end
+~~~
 
 
 ## Real World Usage
@@ -21,6 +35,27 @@ TBD
 
 ## Alternatives
 
+
+### Tags
+
+- [gutentag](https://github.com/pat/gutentag)
+
+~~~
+create_table :taggings do |t|
+  t.integer    :tag_id,        null: false
+  t.integer    :taggable_id,   null: false
+  t.string     :taggable_type, null: false
+  t.timestamps
+end
+
+create_table :tags do |t|
+  t.string      :name,           null: false
+  t.integer     :taggings_count, null: false, default: 0
+  t.timestamps
+end
+~~~
+
+
 - [acts_as_taggable_on](https://github.com/mbleigh/acts-as-taggable-on)
 
 ~~~
@@ -30,9 +65,9 @@ end
 
 create_table :taggings do |t|
   t.references :tag
-  t.references :taggable, :polymorphic => true
-  t.references :tagger,   :polymorphic => true
-  t.string     :context,  :limit => 128
+  t.references :taggable, polymorphic: true
+  t.references :tagger,   polymorphic: true
+  t.string     :context,  limit: 128
   t.datetime   :created_at
 end
 ~~~
@@ -44,14 +79,14 @@ end
 
 ~~~
 create_table :tags do |t|
-  t.string :name, :default => ''
-  t.string :kind, :default => ''
+  t.string :name, default: ''
+  t.string :kind, default: ''
 end
 
 create_table :taggings do |t|
   t.integer :tag_id
 
-  t.string  :taggable_type, :default => ''
+  t.string  :taggable_type, default: ''
   t.integer :taggable_id
 end
 ~~~
@@ -67,8 +102,8 @@ end
 
 create_table :taggings do |t|
   t.references :tag
-  t.references :taggable, :polymorphic => true
-  t.references :tagger,   :polymorphic => true
+  t.references :taggable, polymorphic: true
+  t.references :tagger,   polymorphic: true
   t.string     :context
   t.datetime   :created_at
 end
@@ -86,15 +121,15 @@ end
 
 ~~~
 create_table :tags do |t|
-  t.column :name,           :string
-  t.column :taggings_count, :integer, :default => 0, :null => false
+  t.string  :name
+  t.integer :taggings_count,  null: false, default: 0
 end
  
 create_table :taggings do |t|
-  t.column :tag_id, :integer
-  t.column :taggable_id, :integer
-  t.column :taggable_type, :string
-  t.column :user_id, :integer
+  t.integer :tag_id
+  t.integer :taggable_id
+  t.string  :taggable_type
+  t.integer :user_id
 end 
 ~~~
 
@@ -105,15 +140,15 @@ end
 
 ~~~
 create_table :tags do |t|
-  t.column :name, :string
+  t.string :name
 end
-    
+
 create_table :taggings do |t|
-  t.column :tag_id,        :integer
-  t.column :taggable_id,   :integer
-  t.column :taggable_type, :string
-      
-  t.column :created_at,    :datetime
+  t.integer  :tag_id
+  t.integer  :taggable_id
+  t.string   :taggable_type
+
+  t.datetime :created_at
 end
 ~~~
 
@@ -123,6 +158,36 @@ end
 - [Ruby Toolbook - Rails Tagging Category](https://www.ruby-toolbox.com/categories/rails_tagging)
 
 
+### Categories
+
+- [categoryz3](https://github.com/tscolari/categoryz3)
+
+~~~
+create_table :categoryz3_categories do |t|
+  t.string     :name
+  t.references :parent
+  t.integer    :items_count,       default: 0
+  t.integer    :child_items_count, default: 0
+  t.integer    :childrens_count,   default: 0
+  t.timestamps
+end
+
+create_table :categoryz3_items do |t|
+  t.references :category,      null: false
+  t.references :categorizable, null: false, polymorphic: true
+  t.timestamps
+end
+
+create_table :categoryz3_child_items do |t|
+  t.references :category,      null: false
+  t.references :categorizable, null: false, polymorphic: true
+  t.references :master_item,   null: false
+  t.timestamps
+end
+~~~
+
+- [acts_as_category](https://github.com/wuwx/acts_as_category)
+
 
 ## License
 

data/Rakefile

@@ -11,14 +11,15 @@ Hoe.spec 'tagutils' do
   self.urls    = ['https://github.com/rubylibs/tagutils']
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'openmundi@googlegroups.com'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
-    ['logutils', '>= 0.5']
+    ['activerecord' ],
+    ['logutils', '>= 0.6']
   ]
 
   self.licenses = ['Public Domain']
@@ -28,4 +29,4 @@ Hoe.spec 'tagutils' do
   }
 
 
-end
+end

data/lib/tagutils.rb

@@ -10,7 +10,11 @@ require 'logutils'
 require 'tagutils/version'  # let it always go first
 
 require 'tagutils/schema'
-require 'tagutils/models'
+require 'tagutils/models/tag'
+require 'tagutils/models/tagging'
+
+
+require 'tagutils/active_record'   # -- adds has_many_tags macro
 
 
 module TagUtils
@@ -28,6 +32,12 @@ 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 )
@@ -35,14 +45,12 @@ module TagDb
 
   # delete ALL records (use with care!)
   def self.delete!
-    ## fix: use Deleter (see sportdb etc.)
     puts '*** deleting tag/tagging table records/data...'
     Model::Tagging.delete_all
     Model::Tag.delete_all
-  end # method delete!
+  end
 
   def self.tables
-    ## fix: use Stats class (see sportdb etc.)
     puts "#{Model::Tag.count} tags"
     puts "#{Model::Tagging.count} taggings"
   end
@@ -52,4 +60,3 @@ end # module TagDb
 
 
 puts TagUtils.banner    # say hello
-

data/lib/tagutils/active_record.rb

@@ -0,0 +1,40 @@
+
+
+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
+    end
+
+  end # class Base
+end # module ActiveRecord
+
+
+
+####################################################
+# todo/check:  use concern - why? why not? e.g
+#
+
+=begin
+require 'active_support/concern'
+
+module TagUtils::ActiveRecord
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_many_tags
+      has_many :taggings, class_name: 'TagDb::Model::Tagging', :as => :taggable
+      has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include TagUtils::ActiveRecord
+end
+
+=end
+

data/lib/tagutils/models/tag.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module TagDb
+  module Model
+
+class Tag < ActiveRecord::Base
+
+    has_many :taggings
+
+    ## 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' )
+    scope :top,      where( 'grade=1' )
+
+
+    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( ' ', '-' )
+ 
+      ## 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 TagDb
+end # module Model

data/lib/tagutils/models/tagging.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module TagDb
+  module Model
+
+
+class Tagging < ActiveRecord::Base
+
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+
+end   # class Tagging
+
+
+  end # module TagDb
+end # module Model

data/lib/tagutils/schema.rb

@@ -11,22 +11,29 @@ create_table :tags do |t|
   t.string  :slug,  null: false
   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)
-  t.timestamps   # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+
+  # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+  t.timestamps
 end
 
 add_index :tags, :key,  unique: true
 
 create_table :taggings do |t|
   t.references :tag,      null: false
-  t.references :taggable, polymorphic: true
-  t.timestamps   # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+  t.references :taggable, null: false, polymorphic: true
+
+  # todo: use only t.datetime :created_at (do we get ar magic? is updated used/needed??)
+  t.timestamps
 end
 
 add_index :taggings, :tag_id
 add_index :taggings, [:taggable_id, :taggable_type]
+add_index :taggings, [:taggable_id, :taggable_type, :tag_id], unique: true
+
+  end # method up
 
-  end
 
   def down
     raise ActiveRecord::IrreversibleMigration

data/lib/tagutils/version.rb

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

data/test/helper.rb

@@ -0,0 +1,82 @@
+
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+# require 'minitest/unit'
+require 'minitest/autorun'
+
+# include MiniTest::Unit  # lets us use TestCase instead of MiniTest::Unit::TestCase
+
+
+# ruby stdlibs
+
+require 'json'
+require 'uri'
+require 'pp'
+require 'logger'
+
+# ruby gems
+
+require 'active_record'
+
+# our own code
+
+require 'tagutils'
+require 'logutils/db'   # NB: explict require required for LogDb (not automatic) 
+
+
+
+Tag      = TagDb::Model::Tag
+Tagging  = TagDb::Model::Tagging
+
+
+class Movie < ActiveRecord::Base
+  has_many_tags
+end
+
+class CreateMovieDb < ActiveRecord::Migration
+
+  def up
+    create_table :movies do |t|
+      t.string  :key,   null: false
+      t.string  :name,  null: false
+      t.timestamps
+    end
+  end # method up
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+
+end  # class CreateMovieDb
+
+
+
+def setup_in_memory_db
+  # Database Setup & Config
+
+  db_config = {
+    adapter:  'sqlite3',
+    database: ':memory:'
+  }
+
+  pp db_config
+
+  ActiveRecord::Base.logger = Logger.new( STDOUT )
+  ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+  ## NB: every connect will create a new empty in memory db
+  ActiveRecord::Base.establish_connection( db_config )
+
+
+  ## build schema
+
+  LogDb.create
+  TagDb.create
+  CreateMovieDb.new.up
+
+end
+
+
+setup_in_memory_db()

data/test/test_models.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestModels < MiniTest::Unit::TestCase
+
+  def setup
+    TagDb.delete!
+  end
+
+  def test_count
+    assert_equal 0, Tag.count
+    assert_equal 0, Tagging.count
+    assert_equal 0, Movie.count
+  end
+
+  def test_assocs
+    tag = Tag.new( key: 'key', name: 'name' )
+    assert_equal 0, tag.taggings.count
+
+    movie = Movie.new( key: 'key', name: 'name' )
+    assert_equal 0, movie.taggings.count
+    assert_equal 0, movie.tags.count
+
+    tag.save!
+    movie.save!
+
+    assert_equal 0, tag.taggings.count
+
+    assert_equal 0, movie.taggings.count
+    assert_equal 0, movie.tags.count
+
+    ## note: add tag; op << will auto-save
+    movie.tags << tag
+
+    assert_equal 1, tag.taggings.count
+    assert_equal 1, movie.taggings.count
+    assert_equal 1, movie.tags.count
+  end
+
+end # class TestModels

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagutils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,20 +11,31 @@ bindir: bin
 cert_chain: []
 date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &72493260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *72493260
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &74247220 !ruby/object:Gem::Requirement
+  requirement: &72492220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *74247220
+  version_requirements: *72492220
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &74246900 !ruby/object:Gem::Requirement
+  requirement: &72582430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *74246900
+  version_requirements: *72582430
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &74246500 !ruby/object:Gem::Requirement
+  requirement: &72582120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,9 +54,9 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *74246500
+  version_requirements: *72582120
 description: tagutils - tag utilities (tag, taggings, tag list, etc.)
-email: webslideshow@googlegroups.com
+email: openmundi@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -56,9 +67,14 @@ files:
 - README.md
 - Rakefile
 - lib/tagutils.rb
-- lib/tagutils/models.rb
+- lib/tagutils/active_record.rb
+- lib/tagutils/models/tag.rb
+- lib/tagutils/models/tagging.rb
 - lib/tagutils/schema.rb
 - lib/tagutils/version.rb
+- test/helper.rb
+- test/test_models.rb
+- .gemtest
 homepage: https://github.com/rubylibs/tagutils
 licenses:
 - Public Domain
@@ -86,4 +102,5 @@ rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: tagutils - tag utilities (tag, taggings, tag list, etc.)
-test_files: []
+test_files:
+- test/test_models.rb

data/lib/tagutils/models.rb

@@ -1,28 +0,0 @@
-# encoding: utf-8
-
-module TagDb
-  module Model
-
-
-class Tag < ActiveRecord::Base
-
-  ###########################################################################3
-  # alias for name (remove! add depreciated api call) ?? why? why not??
-  def title()       name;              end
-  def title=(value) self.name = value; end
-
-end   # class Tag
-
-
-class Tagging < ActiveRecord::Base
-  # add code here
-end   # class Tagging
-
-
-
-  end # module Model
-
-  ##### add convenience module alias in plural e.g. lets you use include TagDb::Models
-  Models = Model
-
-end # module TagDb