foaf_stone 0.0.3

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-11-03
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,63 @@
+Copyright (c) 2007 Donald G. Park
+
+The "Ruby Licence" from
+http://www.ruby-lang.org/en/LICENSE.txt
+
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+
+

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/foaf_stone.rb
+lib/foaf_stone/parse.rb
+lib/foaf_stone/person.rb
+lib/foaf_stone/search.rb
+lib/foaf_stone/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+test/person_spec.rb
+test/search_spec.rb
+test/foafs/don_park.rdf

data/README.txt

@@ -0,0 +1,7 @@
+The foaf_stone gem is a set of classes to simplify
+the retrieval, search, and manipulation of a
+FOAF Person.
+
+Details on the FOAF XML format can be found at:
+http://xmlns.com/foaf/spec/
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'foaf_stone/version'
+
+AUTHOR = 'Don Park'  # can also be an array of Authors
+EMAIL = "don.park@gmail.com"
+DESCRIPTION = "manage personal information and social contacts in FOAF documents"
+GEM_NAME = 'foaf_stone' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'foafstone' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = FoafStone::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'foaf_stone documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'foaf_stone'

data/lib/foaf_stone.rb

@@ -0,0 +1,6 @@
+basedir = File.dirname(__FILE__)
+$:.unshift basedir
+
+require 'foaf_stone/person.rb'
+require 'foaf_stone/search.rb'
+require 'foaf_stone/parse.rb'

data/lib/foaf_stone/parse.rb

@@ -0,0 +1,12 @@
+require 'open-uri'
+require 'rexml/document'
+
+class FoafStone
+  # This is an empty subclass of REXML::Document. Substuting a 
+  # different XML parser in the future will be easier this way.
+  # Also a useful spot for future helpers.
+  class Document < REXML::Document
+  end
+  class Element < REXML::Element
+  end
+end

data/lib/foaf_stone/person.rb

@@ -0,0 +1,134 @@
+require 'uri'
+require 'rubygems'
+require 'ruby-debug'
+
+class FoafStone
+  # The Person class represents a person as described by
+  # the <foaf:Person> XML element.
+  #
+  # Manipulation of the data in the foaf:Person is made simpler
+  # with these methods.
+  #
+  # === example:
+  #  person = FoafStone::Person.new("http://socialnetwork/johndoe/foaf.rdf")
+  #  puts "I have detailed files about " + person.name
+  #
+  #  person.knows.each { |person| puts person.name + " is a friend."  }
+  #
+  class Person
+    attr_reader :uri_base
+
+    def initialize(start, uri_base=nil)
+      if start.kind_of?(String) 
+        start = URI.parse(start)
+      end
+      if start.kind_of?(URI)
+        create_from_uri(start)
+        @uri_base = start
+      end
+      if start.kind_of?(REXML::Element)
+        create_from_xml_element(start)
+        @uri_base = uri_base
+      end
+    end
+
+    def create_from_uri(uri)
+      document = Document.new(open(uri.to_s))
+      @document_root = document.elements["/"]
+      # If there is only one person, use that
+      top_people = @document_root.get_elements("/rdf:RDF/foaf:Person")
+      if top_people.size == 1
+        @root = top_people.first
+      end
+      # If there are many people, use the 'me' identifier
+      if top_people.size > 1
+        @root = @document_root.elements["/rdf:RDF/foaf:Person[@rdf:ID='me']"]
+      end
+      raise "The foaf:Person cannot be found" if @root.nil?
+    end
+
+    def create_from_xml_element(element)
+      @root = element
+    end
+
+    # did the given xml url load and parse?
+    def loaded?
+      !@root.nil?
+    end
+
+    # read the foaf:img element
+    def image_uri
+      element = @root.elements["foaf:img"]
+      if element.nil?
+        element = @root.elements["foaf:depiction"]
+      end
+      return URI.parse(element.attributes["resource"]) if element
+    end
+
+    # read the rdfs:seeAlso element
+    def see_also
+      element = @root.elements["rdfs:seeAlso"]
+      element.attributes["resource"] if element
+    end
+
+    # read the foaf:homepage element
+    def homepage
+      element = @root.elements["foaf:homepage"]
+      element.attributes["resource"] if element
+    end
+
+    # read the foaf:nick element
+    def nick
+      nick_element = @root.elements["foaf:nick"]
+      nick_element.text if nick_element
+    end
+
+    # read the foaf:name element
+    def name
+      name_element = @root.elements["foaf:name"]
+      name_element.text if name_element
+    end
+
+    # set the foaf:name element 
+    def name=(name)
+      name_element = @root.elements["foaf:name"]
+      name_element.text = name if name_element
+    end
+
+    # return an array of People whom this person knows
+    def knows
+      friends = []
+      @root.elements.each("foaf:knows") do |know|
+        # There are different ways to specify a foaf:Person
+        # from a foaf:Knows element
+
+        # <foaf:Knows rdf:resource="#rdf_id" />
+        rdf_resource = know.attributes["resource"]
+        if rdf_resource
+          rdf_id = rdf_resource[/[^#]+$/]
+          if rdf_resource[/^#/] # local reference
+            document_root = @document_root
+          else # remote reference
+            document = Document.new(open(uri))
+            document_root = document.elements["/"]
+          end
+          friend_root = document_root.elements["/rdf:RDF/foaf:Person[@rdf:ID='#{rdf_id}']"]
+          new_person = Person.new(friend_root, rdf_resource)
+        end
+
+        # <foaf:Knows> <foaf:Person/> </foaf:Knows>
+        person_literal = know.elements["foaf:Person"]
+        if person_literal
+          new_person = Person.new(person_literal, @uri_base)
+        end
+
+        friends << new_person
+      end
+      friends
+    end
+
+    # add to the list of known people
+    def <<(other)
+    end
+  end
+end

data/lib/foaf_stone/search.rb

@@ -0,0 +1,33 @@
+class FoafStone
+  # The Search class explores the social graph.
+  #
+  # A search is initiatied with the start method.
+  # The search is asynchronous, using a seperate
+  # thread to load the connected FOAF profiles for
+  # a match to the search criteria. A callback object
+  # is passed to allow the thread to signal the calling
+  # thread that the search has finished.
+  #
+  class Search
+    # 'start' begins an asynchronous search by spawning
+    # a new thread that does HTTP requests for foaf documents,
+    # starting with the starting_url.
+    #
+    # the search_term is currently a simple substring match on
+    # the name field.
+    # 
+    # the callback object will be sent a search_done message
+    # with an array of Person objects that meet the search
+    # criteria.
+    #
+    # === example
+    #   def search_done(answers)
+    #     puts "Found #{answer.size} results"
+    #   end
+    #   my_foaf_uri="http://my_server/foaf.rdf"
+    #   FoafStone::Search.start(my_foaf_uri, "Dennis", self)
+    #
+    def self.start(starting_url, search_term, callback)
+    end
+  end
+end

data/lib/foaf_stone/version.rb

@@ -0,0 +1,9 @@
+class FoafStone #:nodoc:
+  class VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 3
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/foaf_stone/version.rb'
+
+version  = FoafStone::VERSION::STRING
+download = 'http://rubyforge.org/projects/foaf_stone'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)