ytag 0.0.1

data/README

@@ -0,0 +1,62 @@
+== What
+Tagging library for Ruby
+
+Provide a robust tagging API that solves the problems posed by Acidus:
+
+1. How to handle multiple words
+2. If/how to allow tag delimiter inside a tag
+3. Does letter case matter
+4. Punctuation and symbols
+5. Handling plural or singular words
+6. Date formating
+7. Multiple language support
+8. Colloquialisms/slang
+
+YTag handles cases 1, 2, 3, and 4, as these are syntactic issues. Cases 5, 6,
+7, and 8 are more interesting. I think they should really be left to user
+creativity. Case 6 is not a problem because YTag maintains independent date and
+time stamps for tags, so even if I encode it in the tag in a weird manner, any
+user will be able to get at an ISO-standard date/time stamp.
+
+At the end of the day, YTag draws a lot of inspiration from Consumating [RIP]
+and del.icio.us.
+
+References:
+http://neosmart.net/blog/2007/the-need-for-creating-tag-standards/
+http://www.memestreams.net/users/acidus/blogid152074
+
+== How
+require 'rubygems'
+require 'ytag'
+
+Dependencies:
+- HTMLEntities gem
+- REX gem
+- RCL gem
+
+What you get:
+
+YTag::Tag#new(name, user, active=true, hidden=false)
+YTag::Tag#create
+YTag::Tag#modify
+YTag::Tag#access
+YTag::Tag#print
+
+YTag::tagify(tag)
+
+== Install
+To construct a Ruby gem, just type:
+
+  rake gem
+
+To install it, type:
+
+  sudo gem install pkg/ytag-0.0.1.gem
+
+== Notes
+I haven't tested this code with YARV, so YMMV.
+
+== Contribute
+The source is availble at github: git://github.com/yesmar/ytag.git. Feel free
+to clone it and implement your own awesome ideas. You can also send your
+patches by email to yesmar[at]speakeasy[dot]net.

data/lib/ytag.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# ytag.rb
+# yesmar@speakeasy.net
+
+module YTag
+  YTag::NAME = 'ytag'
+  YTag::VERSION = '0.0.1'
+  YTag::COPYRIGHT = 'Copyright (c) 2008 Ramsey Dow'
+  def self.copyright() YTag::COPYRIGHT end
+  def self.version() YTag::VERSION end
+  def self.libdir() File.expand_path(__FILE__).gsub(%r/\.rb$/, '') end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/ytag')
+
+require 'tag'
+require 'bundle'
+
+# TODO add more Tag unit tests
+# TODO implement bundle
+# TODO code up some examples
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/ytag/bundle.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# bundle.rb
+# yesmar@speakeasy.net
+
+require 'rubygems'
+require 'htmlentities'
+require 'rex'
+require 'rcl'
+
+module YTag
+  class Bundle
+
+  end
+end

data/lib/ytag/tag.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+
+# tag.rb
+# yesmar@speakeasy.net
+
+require 'rubygems'
+require 'htmlentities'
+require 'rex'
+require 'rcl'
+
+module YTag
+  class Tag
+    attr_reader :name, :user, :active, :hidden
+
+    MARKUP = {}
+    BOGUS = 'system:undefined'
+
+    def initialize(name, user, active=true, hidden=false)
+      raise ArgumentError, 'nil name' if name.nil?
+      raise ArgumentError, 'invalid name class' if name.class != String
+      raise ArgumentError, 'empty name' if name.empty?
+      raise ArgumentError, 'nil user' if user.nil?
+      raise ArgumentError, 'invalid user class' if user.class != String
+      raise ArgumentError, 'empty user' if user.empty?
+      raise ArgumentError, 'invalid active class' if \
+        active.class != TrueClass && active.class != FalseClass
+      raise ArgumentError, 'invalid hidden class' if \
+        hidden.class != TrueClass && hidden.class != FalseClass
+
+      @name = YTag::tagify(name)
+      @user = user
+      @active = active
+      @hidden = hidden
+      @timestamp = RCL::Timestamp.new
+
+      nil
+    end
+
+    def create
+      @timestamp.create
+    end
+
+    def modify
+      @timestamp.modify
+    end
+
+    def access
+      @timestamp.access
+    end
+
+    def print(stream=STDOUT)
+      raise 'nil stream' if stream.nil?
+      raise 'invalid stream class' if stream.class != IO
+
+      @timestamp.update_access
+
+      stream << "#{@name} ["
+      stream << 'in' if !@active
+      stream << 'active, '
+      if !@hidden
+        stream << 'public'
+      else
+        stream << 'private'
+      end
+      stream << "]\n"
+
+      stream << "+ added by #{@user} on #{@timestamp.create}\n"
+      stream << "+ last accessed on #{@timestamp.access}\n"
+
+      nil
+    end
+
+    private
+
+    @name
+    @user
+    @active
+    @hidden
+    @timestamp
+  end
+
+  def self.tagify(tag)
+    raise ArgumentError, 'nil tag' if tag.nil?
+    raise ArgumentError, 'invalid tag class' if tag.class != String
+    raise ArgumentError, 'empty tag' if tag.empty?
+
+    # scrub all markup/scripting
+    tag.scrub!(Tag::MARKUP)
+
+    # from here on, tag may become empty and/or nil after any given operation
+
+    # encode HTML entities
+    tag = HTMLEntities.encode_entities(tag, :basic, :named) \
+      if !tag.nil? && !tag.empty?
+
+    # transform &amp; => _amp_
+    tag.gsub!('&amp;', '_amp_') if !tag.nil? && !tag.empty?
+
+    # transform & => _amp_
+    tag.gsub!('&', '_amp_') if !tag.nil? && !tag.empty?
+
+    # transform ? => _qm
+    tag.gsub!('?', '_qm') if !tag.nil? && !tag.empty?
+
+    # transform ! => _xpt
+    tag.gsub!('!', '_xpt') if !tag.nil? && !tag.empty?
+
+    # transform / => _fs_
+    tag.gsub!('/', '_fs_') if !tag.nil? && !tag.empty?
+
+    # transform \ => _bs_
+    tag.gsub!('\\', '_bs_') if !tag.nil? && !tag.empty?
+
+    # compress whitespace
+    tag.squeeze(' \t') if !tag.nil? && !tag.empty?
+
+    # delete undefined characters
+    tag.delete!('=~@#$%^*()+[]{}|;:\'\"<>') if !tag.nil? && !tag.empty?
+
+    # transform illegal separators
+    tag.tr!(' ,.-', '_') if !tag.nil? && !tag.empty?
+
+    # compress underscores
+    tag.squeeze!('_') if !tag.nil? && !tag.empty?
+
+    # remove preceding underscore
+    tag = tag[1..-1] if !tag.nil? && !tag.empty? && tag[0].chr == '_'
+
+    # remove trailing underscore
+    tag = tag[0..tag.length-2] if !tag.nil? && !tag.empty? && tag[-1].chr == '_'
+
+    # downcase
+    tag.downcase! if !tag.nil? && !tag.empty?
+
+    # handle nil or empty tags
+    tag = Tag::BOGUS if tag.nil? || tag.empty?
+
+    tag
+  end
+end

data/test/tagify.rb

@@ -0,0 +1,259 @@
+#!/usr/bin/env ruby
+
+# tagify.rb
+# YTag::tagify unit tests
+
+require 'test/unit'
+
+require 'pathname'
+dir = Pathname.new(File.expand_path(__FILE__)).realpath
+require File.join(File.dirname(dir.to_s), '../lib/ytag')
+
+class TagifyTests < Test::Unit::TestCase
+  def test_nil_string
+    expected = nil
+    actual = nil
+
+    assert_raise ArgumentError do
+      actual = YTag::tagify(nil)
+    end
+
+    assert_nil(actual)
+    assert_instance_of(NilClass, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_invalid_class
+    expected = nil
+    actual = nil
+  
+    assert_raise ArgumentError do
+      actual = YTag::tagify(TrueClass)
+    end
+
+    assert_nil(actual)
+    assert_instance_of(NilClass, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_empty_string
+    expected = nil
+    actual = nil
+
+    assert_raise ArgumentError do
+      actual = YTag::tagify('')
+    end
+
+    assert_nil(actual)
+    assert_instance_of(NilClass, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_html_entities_1
+    expected = 'amp_amp_lt_amp_gt'
+    actual = nil
+  
+    assert_nothing_raised do
+      actual = YTag::tagify('&<>')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_html_entities_2
+    expected = 'abc_amp_auml'
+    actual = nil
+  
+    assert_nothing_raised do
+      actual = YTag::tagify("abc\303\244")
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_markup
+    expected = YTag::Tag::BOGUS
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify("<img src=\"javascript:alert('xss');\">")
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_script_1
+    expected = 'document_cookie'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('<script>document.cookie</script>')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_script_2
+    expected = YTag::Tag::BOGUS
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('<script></script>')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_whitespace_compression
+    expected = 'mac_os_x'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('   Mac  OS   X   ')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_underscore_compression
+    expected = 'foo_bar'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('______foo__________bar___________')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_undefined_characters
+    expected = 'amp_apos_bs_amp_quot_amp_lt_amp_gt'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('=~@#$%^*()+[]{}|;:\'\"<>')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_illegal_separators
+    expected = 'a_b_c_d_e'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('a b,c.d-e')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_preceding_separarator
+    expected = 'tag'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('_tag')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_trailing_separator
+    expected = 'tag'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('tag_')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_ampersand
+    expected = 'a_amp_b'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('a & b')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_question_mark
+    expected = 'wtf_qm'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('wtf?')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_exclamation_mark
+    expected = 'ausgezeichnet_xpt'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('ausgezeichnet_xpt')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_forward_slash
+    expected = 'fs_etc_fs_passwd'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('/etc/passwd')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+
+  def test_backward_slash
+    expected = 'c_bs_windows_bs_system32'
+    actual = nil
+
+    assert_nothing_raised do
+      actual = YTag::tagify('C:\\WINDOWS\\system32')
+    end
+
+    assert_not_nil(actual)
+    assert_instance_of(String, actual)
+    assert_equal(expected, actual)
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: ytag
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ramsey Dow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rex
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcl
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+description: 
+email: yesmar @nospam@ speakeasy.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/ytag.rb
+- lib/ytag/bundle.rb
+- lib/ytag/tag.rb
+- test/tagify.rb
+- README
+has_rdoc: true
+homepage: http://ytag.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: http://rubyforge.org/projects/ytag/
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Tagging library for Ruby
+test_files: 
+- test/tagify.rb