vlaah 0.9.0

data/lib/vlaah/topic.rb

@@ -0,0 +1,216 @@
+require 'vlaah/base'
+require 'vlaah/unit'
+require 'rexml/xpath'
+
+module VLAAH
+  # = Topic: The atomic object of VLAAH.
+  #
+  # It represents topics of VLAAH.
+  # There is no creation or deletion of topics in VLAAH, like pages in wiki.
+  #
+  # == Finding (Or Creating) Topic
+  #
+  # You can find topics with VLAAH::find method.
+  #
+  #     topic  = VLAAH::Topic.find "Zhuangzi"
+  #     topic2 = VLAAH::Topic.find "Common Lisp"
+  #
+  # == Getting Names
+  #
+  # There are three types of names in VLAAH::Topic.
+  #
+  # - +name+ (called name) for respect to the context (e.g. RESTful vs restful)
+  # - +normalized_name+ for equality testing (e.g. iPod touch and iPod Touch)
+  # - +usual_name+ for printing name prettily
+  #
+  #     a = VLAAH::Topic.find "RESTful"
+  #     b = VLAAH::Topic.find "restful"
+  #     a.name, b.name             #=> ["RESTful", "restful"]
+  #     a.normalized_name          #=> "restful"
+  #     b.normalized_name          #=> "restful"
+  #     a == b                     #=> true
+  #
+  # The most frequent naming becomes +usual_name+.
+  #
+  #     a.usual_name, b.usual_name #=> ["RESTful", "RESTful"]
+  #
+  # == Getting Numbers
+  #
+  # The standard unit in VLAAH is the +degree+(+point+).
+  #
+  #     topic.degree        #=> 300
+  #     topic.degree.plus   #=> 380
+  #     topic.degree.minus  #=> 80
+  #
+  # If you want just the number of people that commented to the topic,
+  # call +people+ method.
+  #
+  #     topic.people        #=> 46
+  #     topic.people.plus   #=> 38
+  #     topic.people.minus  #=> 8
+  #
+  # There is the +percent+ method also.
+  #
+  #     topic.percent        #=> 82
+  #     topic.percent.plus   #=> 82
+  #     topic.percent.minus  #=> 17
+  #
+  # The above three methods(+degree+, +people+, +percent+) return an instance
+  # of VLAAH::Unit. It is number-like value object, so it has arithmetic
+  # operators, and it also have +plus+, +minus+ method. That two methods return
+  # just an instance of Fixnum or Float.
+  #
+  # == Getting Comments
+  #
+  # Comments of the topic are gettable with VLAAH::Topic#comments method.
+  #
+  #     topic.comments  #=> [<VLAAH::Comment name="?1234" ...>,
+  #                          <VLAAH::Comment name="?567" ...> ... (42 comments)]
+  #
+  # It returns an instance of VLAAH::CommentList. It implements +Enumerable+
+  # and is Array-like.
+  #
+  # == Getting Commenters
+  #
+  # VLAAH::Topic#commenters returns an array of people that commented to the
+  # topic. This array also have two more singleton methods: +plus+ and +minus+.
+  #
+  #     topic.commenters        #=> [<VLAAH::Person name="~dahlia" ...>,
+  #                                  <VLAAH::Person name="~heungsub" ...> ...]
+  #     topic.commenters.plus   #=> [<VLAAH::Person name="~dahlia" ...> ...]
+  #     topic.commenters.minus  #=> [<VLAAH::Person name="~heungsub" ...> ...]
+  class Topic < Base
+    NamePattern = //
+
+    # Returns the topic named +name+.
+    # May be VLAAH::Topic or VLAAH::Person or VLAAH::Comment.
+    def self.find(name)
+      Person.find(name) or Comment.find(name) or new(name)
+    end
+
+    # DO NOT INITIALIZE TOPIC _DIRECTLY_. USE VLAAH::Topic#find INSTEAD.
+    def initialize(name_or_xml)
+      if name_or_xml.is_a? ::REXML::Element
+        @raw_data = name_or_xml
+      elsif name_or_xml.is_a? ::REXML::Document
+        @raw_data = name_or_xml.root
+      else
+        @name = name_or_xml.strip
+      end
+
+      @name = @raw_data.attributes['name'].strip if defined? @raw_data
+    end
+
+    # The name of the topic. It is not normalized.
+    #
+    #     Topic.find("VLAAH").name  #=> "VLAAH"
+    #     Topic.find("vlaah").name  #=> "vlaah"
+    def name
+      @name
+    end
+
+    # Its normalized name. It is used for testing equality of topics.
+    #
+    #     Topic.find("VLAAH").normalized_name      #=> "vlaah"
+    #     Topic.find("  vlaah  ").normalized_name  #=> "vlaah"
+    #     Topic.find("블 라").normalized_name      #=> "블라"
+    def normalized_name
+      raw_data("@normalized-name").first.value
+    end
+
+    # Returns +true+ if it and +operand+ are the same.
+    # (Compare by +normalized_name+.)
+    #
+    #     Topic.find("Smalltalk").eql? Topic.find("SmallTalk")  #=> true
+    #     Topic.find("Smalltalk") ==   Topic.find("SmallTalk")  #=> true
+    #     Topic.find("Scheme").eql? Topic.find("Common Lisp")   #=> false
+    #     Topic.find("Scheme") ==   Topic.find("Common Lisp")   #=> false
+    def eql?(operand)
+      operand.normalized_name.eql? normalized_name
+    end
+
+    alias_method :==, :eql?
+
+    # Its name that called usually.
+    #
+    #     Topic.find("vlaah").normalized_name      #=> "VLAAH"
+    #     Topic.find("SmallTalk").normalized_name  #=> "Smalltalk"
+    #     Topic.find("~Dahlia").normalized_name    #=> "~dahlia"
+    def usual_name 
+      raw_data("@usual-name").first.value
+    end
+
+    def degree
+      Unit.new(raw_data("//degree").first) { |x| x.to_i }
+    end
+
+    alias_method :point, :degree
+
+    def people
+      Unit.new(raw_data("//people").first) { |x| x.to_i }
+    end
+
+    def percent
+      Unit.new(raw_data("//percent").first) { |x| x.to_f / 100 }
+    end
+
+    # Returns a list of its comments. (An instance of VLAAH::CommentList.)
+    def comments
+      CommentList.new name, "comments"
+    end
+
+    # Returns an array of people that commented to the topic.
+    def commenters
+      xml = self.class.raw_data(name, "commenters")
+      commenters = ::REXML::XPath.match(xml, "//person") \
+                                 .map(&Person.method(:new))
+      commenters.instance_variable_set(:@__vlaah_commenters, xml)
+
+      def commenters.plus
+        ::REXML::XPath.match(@__vlaah_commenters, "//plus/person") \
+                      .map(&Person.method(:new))
+      end
+
+      def commenters.minus
+        ::REXML::XPath.match(@__vlaah_commenters, "//minus/person") \
+                      .map(&Person.method(:new))
+      end
+
+      return commenters
+    end
+
+    alias_method :to_s, :name
+
+    def inspect
+      "<#{self.class.name} name=#{name.inspect}>"
+    end
+
+    protected
+
+    def raw_data(xpath = nil, retry_ = false)
+      if xpath
+        result = ::REXML::XPath.match(raw_data, xpath)
+
+        if retry_ and result.empty?
+          @raw_data = self.class.raw_data(name)
+          return ::REXML::XPath.match(@raw_data, xpath)
+        else
+          return result
+        end
+      end
+
+      @raw_data if defined? @raw_data
+      @raw_data = self.class.raw_data(name)
+    end
+  end
+end
+
+class String
+  # Converts string to a VLAAH::Topic.
+  #
+  #     "Smalltalk".to_topic   #=> <VLAAH::Topic name="Smalltalk">
+  #     "VLAAH".to_topic.name  #=> "VLAAH"
+  def to_topic
+    VLAAH::Topic.find(self)
+  end
+end

data/lib/vlaah/unit.rb

@@ -0,0 +1,62 @@
+
+module VLAAH
+  class Unit < Numeric
+    def initialize(element)
+      @total = yield element.attributes['total']
+      @plus  = yield element.attributes['plus']
+      @minus = yield element.attributes['minus']
+    end
+
+    def plus
+      @plus
+    end
+
+    def minus
+      @minus
+    end
+
+    def method_missing(method, *args)
+      @total.__send__(method, *args)
+    end
+
+    def coerce(operand)
+      [operand, @total.is_a?(Float) ? self.to_f : self.to_i]
+    end
+
+    def to_s(*args)
+      @total.to_s(*args)
+    end
+
+    def to_i
+      @total.to_i
+    end
+
+    def to_int
+      @total.to_int
+    end
+
+    def truncate
+      @total.truncate
+    end
+
+    def to_f
+      @total.to_f
+    end
+
+    def +@
+      @total
+    end
+
+    def -@
+      -@total
+    end
+
+    def <=> operand
+      @total <=> operand
+    end
+
+    def inspect
+      "#{@total.inspect} <plus=#{@plus.inspect} minus=#{@minus.inspect}>"
+    end
+  end
+end

data/lib/vlaah/version.rb

@@ -0,0 +1,4 @@
+
+module VLAAH
+  Version = "0.9.0"
+end

data/lib/vlaah.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright (c) 2008 Lunant <http://lunant.net/>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+$:.unshift File.dirname(__FILE__)
+
+require 'vlaah/version'
+require 'vlaah/base'
+require 'vlaah/unit'
+require 'vlaah/topic'
+require 'vlaah/person'
+require 'vlaah/comment'
+require 'vlaah/comment_list'

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: vlaah
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+date: 2008-10-19 00:00:00 +09:00
+summary: VLAAH API client library for Ruby.
+require_paths: 
+- lib
+email: 
+homepage: http://vlaah.rubyforge.org/
+rubyforge_project: 
+description: It provides various model classes which wrap the raw protocol of VLAAH API. (http://api.vlaah.com/)
+autorequire: vlaah
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: []
+
+files: 
+- doc/template.rb
+- lib/vlaah
+- lib/vlaah/base.rb
+- lib/vlaah/person.rb
+- lib/vlaah/comment.rb
+- lib/vlaah/version.rb
+- lib/vlaah/topic.rb
+- lib/vlaah/comment_list.rb
+- lib/vlaah/unit.rb
+- lib/vlaah/locale.rb
+- lib/vlaah.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+