ffi-tracker 0.0.1

data/README.rdoc

@@ -0,0 +1,22 @@
+= ffi-tracker
+
+by Matijs van Zuijlen
+
+http://www.github.com/mvz/ffi-tracker
+
+== Description
+
+Ruby bindings for Tracker using GirFFI.
+
+== Features
+
+* Auto-generated bindings using GObject introspection.
+* Adds overrides for introspection data bugs.
+
+== License
+
+Copyright (c) 2011 Matijs van Zuijlen
+
+ffi-tracker is free software, distributed under the terms of the GNU Lesser
+General Public License, version 2.1 or later. See the file COPYING.LIB for
+more information.

data/Rakefile

@@ -0,0 +1,3 @@
+load 'tasks/setup.rb'
+
+task :default => 'test'

data/lib/ffi-tracker.rb

@@ -0,0 +1,15 @@
+require 'gir_ffi'
+
+GirFFI.setup :Tracker
+
+module Tracker
+  SparqlCursor.class_eval do
+    def get_string_with_hidden_length column
+      result, length = *get_string_without_hidden_length(column)
+      result
+    end
+
+    alias get_string_without_hidden_length get_string
+    alias get_string get_string_with_hidden_length
+  end
+end

data/tasks/notes.rake

@@ -0,0 +1,121 @@
+# The following code is copied straight from Bones 2.5.1
+#
+
+module Bones
+
+# A helper class used to find and display any annotations in a collection of
+# project files.
+#
+class AnnotationExtractor
+
+  class Annotation < Struct.new(:line, :tag, :text)
+    # Returns a string representation of the annotation. If the
+    # <tt>:tag</tt> parameter is given as +true+, then the annotation tag
+    # will be included in the string.
+    #
+    def to_s( opts = {} )
+      s = "[%3d] " % line
+      s << "[#{tag}] " if opts[:tag]
+      s << text
+    end
+  end
+
+  # Enumerate all the annoations for the given _project_ and _tag_. This
+  # will search for all athe annotations and display them on standard
+  # output.
+  #
+  def self.enumerate tag, id = nil, opts = {}
+    extractor = new(tag, id)
+    extractor.display(extractor.find, opts)
+  end
+
+  attr_reader :tag, :id
+
+  # Creates a new annotation extractor configured to use the _project_ open
+  # strcut and to search for the given _tag_ (which can be more than one tag
+  # via a regular expression 'or' operation -- i.e. THIS|THAT|OTHER)
+  #
+  def initialize tag, id
+    @tag = tag
+    @id = @id_rgxp = nil
+
+    unless id.nil? or id.empty?
+      @id = id
+      @id_rgxp = Regexp.new(Regexp.escape(id), Regexp::IGNORECASE)
+    end
+  end
+
+  # Iterate over all the files in the project and extract annotations from
+  # the those files. Returns the results as a hash for display.
+  #
+  def find
+    results = {}
+    rgxp = %r/(#{tag}):?\s*(.*?)(?:\s*(?:-?%>|\*+\/))?$/o
+
+    files = Dir.glob("lib/**/*.rb")
+    files += Dir.glob("test/**/*.rb")
+    files.each do |fn|
+      results.update(extract_annotations_from(fn, rgxp))
+    end
+
+    results
+  end
+
+  # Extract any annotations from the given _file_ using the regular
+  # expression _pattern_ provided.
+  #
+  def extract_annotations_from( file, pattern )
+    lineno = 0
+    result = File.readlines(file).inject([]) do |list, line|
+      lineno += 1
+      next list unless m = pattern.match(line)
+      next list << Annotation.new(lineno, m[1], m[2]) unless id
+
+      text = m[2]
+      if text =~ @id_rgxp
+        list << Annotation.new(lineno, m[1], text)
+      end
+      list
+    end
+    result.empty? ? {} : { file => result }
+  end
+
+  # Print the results of the annotation extraction to the screen. If the
+  # <tt>:tags</tt> option is set to +true+, then the annotation tag will be
+  # displayed.
+  #
+  def display( results, opts = {} )
+    results.keys.sort.each do |file|
+      puts "#{file}:"
+      results[file].each do |note|
+        puts "  * #{note.to_s(opts)}"
+      end
+      puts
+    end
+  end
+
+end  # class AnnotationExtractor
+end  # module Bones
+
+note_tags = ["TODO", "FIXME", "OPTIMIZE"]
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if t.application.top_level_tasks.length > 1
+    t.application.top_level_tasks.slice!(1..-1).join(' ')
+  end
+  Bones::AnnotationExtractor.enumerate(
+      note_tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+  note_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do |t|
+      id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+      end
+      Bones::AnnotationExtractor.enumerate(tag, id)
+    end
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,6 @@
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", :rerdoc => "rdoc:force") do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include "README.rdoc", "DESIGN.rdoc", "TODO.rdoc", "lib/**/*.rb"
+end

data/tasks/setup.rb

@@ -0,0 +1,6 @@
+require 'rake/clean'
+
+# Load the other rake files in the tasks folder
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+import(*rakefiles)

data/tasks/test.rake

@@ -0,0 +1,25 @@
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/unit/*_test.rb']
+    t.ruby_opts += ["-w"]
+  end
+
+  Rake::TestTask.new(:integration) do |t|
+    t.libs = ['lib']
+    t.test_files = FileList['test/integration/*_test.rb']
+    t.ruby_opts += ["-w"]
+  end
+
+  desc 'Run rcov for the entire test suite'
+  task :coverage do
+    rm_f "coverage"
+    system "rcov", "-Ilib", "--exclude", "\.gem\/,\/gems\/", *FileList['test/**/*_test.rb']
+  end
+end
+
+desc 'Run unit and integration tests'
+task :test => ['test:unit', 'test:integration']

data/tasks/yardoc.rake

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--private', '--protected', '--readme',  'README.rdoc', "--files", "DESIGN.rdoc,TODO.rdoc"]
+end

data/test/integration/load_test.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+describe "Upon load" do
+  describe "the Tracker module" do
+    it "should exist" do
+      Tracker
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ffi-tracker'
+

data/test/unit/tracker_sparql_cursor_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+describe Tracker::SparqlCursor do
+  describe "#get_string" do
+    it "returns just the string value" do
+      conn = Tracker::SparqlConnection.get_direct nil
+      cursor = conn.query "SELECT ?url WHERE { ?x a nie:InformationElement; nie:url ?url. }", nil
+
+      cursor.next nil
+      assert_instance_of String, cursor.get_string(0)
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-tracker
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matijs van Zuijlen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gir_ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 0
+        - 11
+        version: 0.0.11
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- matijs@matijs.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/ffi-tracker.rb
+- test/test_helper.rb
+- test/unit/tracker_sparql_cursor_test.rb
+- test/integration/load_test.rb
+- tasks/yardoc.rake
+- tasks/rdoc.rake
+- tasks/test.rake
+- tasks/setup.rb
+- tasks/notes.rake
+- README.rdoc
+- Rakefile
+homepage: http://www.github.com/mvz/ffi-tracker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: FFI-based binding to Tracker, using the GObject Introspection Repository
+test_files: 
+- test/integration/load_test.rb
+- test/test_helper.rb
+- test/unit/tracker_sparql_cursor_test.rb
+has_rdoc: