mac-spotlight 0.0.1

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Li Xiao, iam@li-xiao.com
+
+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.

data/Manifest

@@ -0,0 +1,10 @@
+MIT-LICENSE.txt
+Manifest
+README.rdoc
+Rakefile
+TODO
+ext/spotlight/extconf.rb
+ext/spotlight/spotlight.c
+lib/spotlight.rb
+test/test_file.txt
+test/test_spotlight.rb

data/README.rdoc

@@ -0,0 +1,28 @@
+= Spotlight -- Ruby interface to Mac OSX Spotlight
+
+Not done yet, see TODO what's missed currently
+
+== Install
+
+You may need setup environment ARCHFLAGS="-arch i386" when installing the gem
+
+== Limitation
+
+It only works on Mac.
+
+= Other stuff
+
+Author: Li Xiao <iam@li-xiao.com>
+
+Requires: Ruby 1.8.6 or later
+
+License: Copyright 2010 by Li Xiao.
+         Released under an MIT-LICENSE.  See the MIT-LICENSE.txt file
+         included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,21 @@
+
+ENV["ARCHFLAGS"]="-arch i386"
+
+require 'rubygems'
+require 'echoe'
+require 'rake/extensiontask'
+
+Echoe.new('mac-spotlight', '0.0.1') do |p|
+  p.description     = "Spotlight - Ruby interface to Mac OSX Spotlight"
+  p.url             = "https://github.com/xli/spotlight"
+  p.author          = "Li Xiao"
+  p.email           = "iam@li-xiao.com"
+  p.ignore_pattern  = "*.gemspec"
+  p.development_dependencies = ['rake', 'echoe', 'rake-compiler']
+  p.test_pattern = "test/test_*.rb"
+  p.rdoc_options    = %w(--main README.rdoc --inline-source --line-numbers --charset UTF-8)
+end
+
+Rake::ExtensionTask.new('spotlight') do |ext|
+  ext.lib_dir = 'lib/spotlight'
+end

data/TODO

@@ -0,0 +1,2 @@
+delete attribute
+memory leak test

data/ext/spotlight/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+$LDFLAGS << " -framework CoreServices"
+have_header("CoreServices/CoreServices.h")
+
+create_makefile('spotlight/spotlight')

data/ext/spotlight/spotlight.c

@@ -0,0 +1,236 @@
+/*
+ *  spotlight.c
+ *  spotlight
+ *
+ *  Created by xli on 4/26/10.
+ *  Copyright 2010 ThoughtWorks. All rights reserved.
+ */
+
+#include <ruby.h>
+#include <CoreServices/CoreServices.h>
+
+#define RELEASE_IF_NOT_NULL(ref) { if (ref) { CFRelease(ref); } }
+
+void MDItemSetAttribute(MDItemRef item, CFStringRef name, CFTypeRef value);
+
+VALUE method_search(VALUE self, VALUE queryString, VALUE scopeDirectory);
+VALUE method_attributes(VALUE self, VALUE path);
+VALUE method_set_attribute(VALUE self, VALUE path, VALUE name, VALUE value);
+VALUE method_get_attribute(VALUE self, VALUE path, VALUE name);
+
+void Init_spotlight (void)
+{
+  VALUE Spotlight = rb_define_module("Spotlight");
+  VALUE SpotlightIntern = rb_define_module_under(Spotlight, "Intern");
+  rb_define_module_function(SpotlightIntern, "search", method_search, 2);
+  rb_define_module_function(SpotlightIntern, "attributes", method_attributes, 1);
+  rb_define_module_function(SpotlightIntern, "set_attribute", method_set_attribute, 3);
+  rb_define_module_function(SpotlightIntern, "get_attribute", method_get_attribute, 2);
+}
+
+VALUE cfstring2rbstr(CFStringRef str) {
+  CFIndex len = CFStringGetMaximumSizeForEncoding(CFStringGetLength(str), kCFStringEncodingUTF8);
+  char *result = (char *)malloc(sizeof(char) * len);
+  CFStringGetCString(str, result, len, kCFStringEncodingUTF8);
+  free(result);
+  return rb_str_new2(result);
+}
+
+CFStringRef rbstr2cfstring(VALUE str) {
+  return CFStringCreateWithCString(kCFAllocatorDefault, StringValuePtr(str), kCFStringEncodingUTF8);
+}
+
+CFStringRef date_string(CFDateRef date) {
+  CFLocaleRef locale = CFLocaleCopyCurrent();
+  CFDateFormatterRef formatter = CFDateFormatterCreate(kCFAllocatorDefault, locale, kCFDateFormatterFullStyle, kCFDateFormatterFullStyle);
+  CFStringRef result = CFDateFormatterCreateStringWithDate(kCFAllocatorDefault, formatter, date);
+  RELEASE_IF_NOT_NULL(formatter);
+  RELEASE_IF_NOT_NULL(locale);
+  return result;
+}
+
+VALUE convert2rb_type(CFTypeRef ref) {
+  VALUE result = Qnil;
+  double double_result;
+  int int_result;
+  long long_result;
+  int i;
+  if (ref != nil) {
+    if (CFGetTypeID(ref) == CFStringGetTypeID()) {
+      result = cfstring2rbstr(ref);
+    } else if (CFGetTypeID(ref) == CFDateGetTypeID()) {
+      // 978307200.0 == (January 1, 2001 00:00 GMT) - (January 1, 1970 00:00 UTC)
+      // CFAbsoluteTime => January 1, 2001 00:00 GMT
+      // ruby Time => January 1, 1970 00:00 UTC
+      double_result = (double) CFDateGetAbsoluteTime(ref) + 978307200;
+      result = rb_funcall(rb_cTime, rb_intern("at"), 1, rb_float_new(double_result));
+    } else if (CFGetTypeID(ref) == CFArrayGetTypeID()) {
+      result = rb_ary_new();
+      for (i = 0; i < CFArrayGetCount(ref); i++) {
+        rb_ary_push(result, convert2rb_type(CFArrayGetValueAtIndex(ref, i)));
+      }
+    } else if (CFGetTypeID(ref) == CFNumberGetTypeID()) {
+      if (CFNumberIsFloatType(ref)) {
+        CFNumberGetValue(ref, CFNumberGetType(ref), &double_result);
+        result = rb_float_new(double_result);
+      } else {
+        CFNumberGetValue(ref, CFNumberGetType(ref), &long_result);
+        result = LONG2NUM(long_result);
+      }
+    }
+  }
+  return result;
+}
+
+CFTypeRef convert2cf_type(VALUE obj) {
+  CFTypeRef result = nil;
+  double double_result;
+  int int_result;
+  long long_result;
+  int i, len;
+  VALUE tmp[1];
+  CFAbsoluteTime time;
+
+  switch (TYPE(obj)) {
+    case T_NIL:
+      result = nil;
+      break;
+    case T_TRUE:
+      result = kCFBooleanTrue;
+      break;
+    case T_FALSE:
+      result = kCFBooleanFalse;
+      break;
+    case T_FLOAT:
+      double_result = NUM2DBL(obj);
+      result = CFNumberCreate(kCFAllocatorDefault, kCFNumberDoubleType, &double_result);
+      break;
+    case T_BIGNUM:
+      long_result = NUM2LONG(obj);
+      result = CFNumberCreate(kCFAllocatorDefault, kCFNumberLongType, &long_result);
+      break;
+    case T_FIXNUM:
+      int_result = FIX2INT(obj);
+      result = CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &int_result);
+      break;
+    case T_STRING:
+      result = rbstr2cfstring(obj);
+      break;
+    case T_DATA:
+    case T_OBJECT:
+      // todo : check type is Time
+      // 978307200.0 == (January 1, 2001 00:00 GMT) - (January 1, 1970 00:00 UTC)
+      // CFAbsoluteTime => January 1, 2001 00:00 GMT
+      // ruby Time => January 1, 1970 00:00 UTC
+      if (rb_obj_is_kind_of(obj, rb_cTime)) {
+        time = (CFAbsoluteTime) (NUM2DBL(rb_funcall(obj, rb_intern("to_f"), 0)) - 978307200.0);
+        result = CFDateCreate(kCFAllocatorDefault, time);
+      }
+      break;
+    case T_ARRAY:
+      len = RARRAY(obj)->len;
+      CFTypeRef *values = (CFTypeRef *)malloc(sizeof(CFTypeRef) * len);
+      for (i = 0; i < len; i++) {
+        tmp[0] = INT2NUM(i);
+        values[i] = convert2cf_type(rb_ary_aref(1, tmp, obj));
+      }
+      result = CFArrayCreate(kCFAllocatorDefault, (const void **)values, len, nil);
+      free(values);
+      break;
+  }
+  return result;
+}
+
+void set_search_scope(MDQueryRef query, VALUE scopeDirectories) {
+  int i;
+  int len = RARRAY(scopeDirectories)->len;
+  CFStringRef *scopes = (CFStringRef *)malloc(sizeof(CFStringRef) * len);
+  for (i=0; i<len; i++) {
+    scopes[i] = rbstr2cfstring(rb_ary_pop(scopeDirectories));
+  }
+
+  CFArrayRef scopesRef = CFArrayCreate(kCFAllocatorDefault, (const void **)scopes, len, nil);
+  free(scopes);
+
+  MDQuerySetSearchScope(query, scopesRef, 0);
+  RELEASE_IF_NOT_NULL(scopesRef);
+}
+
+VALUE method_search(VALUE self, VALUE queryString, VALUE scopeDirectories) {
+  VALUE result = Qnil;
+  int i;
+  CFStringRef path;
+  MDItemRef item;
+
+  CFStringRef qs = rbstr2cfstring(queryString);
+  MDQueryRef query = MDQueryCreate(kCFAllocatorDefault, qs, nil, nil);
+  RELEASE_IF_NOT_NULL(qs);
+
+  if (query) {
+    set_search_scope(query, scopeDirectories);
+    if (MDQueryExecute(query, kMDQuerySynchronous)) {
+      result = rb_ary_new();
+      for(i = 0; i < MDQueryGetResultCount(query); ++i) {
+        item = (MDItemRef) MDQueryGetResultAtIndex(query, i);
+        path = MDItemCopyAttribute(item, kMDItemPath);
+        rb_ary_push(result, cfstring2rbstr(path));
+      }
+    }
+    RELEASE_IF_NOT_NULL(path);
+    RELEASE_IF_NOT_NULL(query);
+  }
+
+  return result;
+}
+
+VALUE method_attributes(VALUE self, VALUE path) {
+  int i;
+  CFStringRef attrNameRef;
+  CFTypeRef attrValueRef;
+  CFStringRef pathRef = rbstr2cfstring(path);
+  MDItemRef mdi = MDItemCreate(kCFAllocatorDefault, pathRef);
+  RELEASE_IF_NOT_NULL(pathRef);
+  CFArrayRef attrNamesRef = MDItemCopyAttributeNames(mdi);
+  VALUE result = rb_hash_new();
+  for (i = 0; i < CFArrayGetCount(attrNamesRef); i++) {
+    attrNameRef = CFArrayGetValueAtIndex(attrNamesRef, i);
+    attrValueRef = MDItemCopyAttribute(mdi, attrNameRef);
+    rb_hash_aset(result, cfstring2rbstr(attrNameRef), convert2rb_type(attrValueRef));
+    RELEASE_IF_NOT_NULL(attrValueRef);
+  }
+  
+  RELEASE_IF_NOT_NULL(mdi);
+  RELEASE_IF_NOT_NULL(attrNamesRef);
+
+  return result;
+}
+
+VALUE method_get_attribute(VALUE self, VALUE path, VALUE name) {
+  MDItemRef mdi = MDItemCreate(kCFAllocatorDefault, rbstr2cfstring(path));
+  CFStringRef nameRef = rbstr2cfstring(name);
+  CFTypeRef valueRef = MDItemCopyAttribute(mdi, nameRef);
+
+  VALUE result = convert2rb_type(valueRef);
+
+  RELEASE_IF_NOT_NULL(valueRef);
+  RELEASE_IF_NOT_NULL(nameRef);
+  RELEASE_IF_NOT_NULL(mdi);
+
+  return result;
+}
+
+VALUE method_set_attribute(VALUE self, VALUE path, VALUE name, VALUE value) {
+  MDItemRef item = MDItemCreate(kCFAllocatorDefault, rbstr2cfstring(path));
+  CFStringRef nameRef = rbstr2cfstring(name);
+  CFTypeRef valueRef = convert2cf_type(value);
+
+  MDItemSetAttribute(item, nameRef, valueRef);
+
+  RELEASE_IF_NOT_NULL(valueRef);
+  RELEASE_IF_NOT_NULL(nameRef);
+  RELEASE_IF_NOT_NULL(item);
+
+  return Qtrue;
+}
+
+

data/lib/spotlight.rb

@@ -0,0 +1,41 @@
+require 'spotlight/spotlight'
+
+module Spotlight
+  VERSION = "0.0.1"
+
+  def self.search(query_string, *scope_directories)
+    Intern.search(query_string, scope_directories).collect {|path| MDItem.new(path)}
+  end
+
+  class MDItem
+    VALID_ATTRIBUTE_VALUE_TYPE = [String, Time, Fixnum, Bignum, Float, Array]
+
+    class InvalidAttributeValueTypeError < StandardError
+    end
+
+    attr_reader :path
+    def initialize(path)
+      @path = path
+    end
+    def attributes
+      Intern.attributes(@path)
+    end
+    def [](attr_name)
+      Intern.get_attribute(@path, attr_name)
+    end
+    def []=(attr_name, attr_value)
+      validate(attr_value)
+      Intern.set_attribute(@path, attr_name, attr_value)
+    end
+    def reload
+      self
+    end
+    def ==(obj)
+      obj.is_a?(MDItem) && @path == obj.path
+    end
+
+    def validate(value)
+      raise InvalidAttributeValueTypeError, "Invalid attribute value type #{value.class.inspect}, valid types: #{VALID_ATTRIBUTE_VALUE_TYPE.join(", ")}" unless VALID_ATTRIBUTE_VALUE_TYPE.include?(value.class)
+    end
+  end
+end

data/mac-spotlight.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mac-spotlight}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Li Xiao"]
+  s.date = %q{2010-05-03}
+  s.description = %q{Spotlight - Ruby interface to Mac OSX Spotlight}
+  s.email = %q{iam@li-xiao.com}
+  s.extensions = ["ext/spotlight/extconf.rb"]
+  s.extra_rdoc_files = ["README.rdoc", "TODO", "ext/spotlight/extconf.rb", "ext/spotlight/spotlight.c", "lib/spotlight.rb"]
+  s.files = ["MIT-LICENSE.txt", "Manifest", "README.rdoc", "Rakefile", "TODO", "ext/spotlight/extconf.rb", "ext/spotlight/spotlight.c", "lib/spotlight.rb", "test/test_file.txt", "test/test_spotlight.rb", "mac-spotlight.gemspec"]
+  s.homepage = %q{https://github.com/xli/spotlight}
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{mac-spotlight}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Spotlight - Ruby interface to Mac OSX Spotlight}
+  s.test_files = ["test/test_spotlight.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+      s.add_development_dependency(%q<rake-compiler>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+      s.add_dependency(%q<rake-compiler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+    s.add_dependency(%q<rake-compiler>, [">= 0"])
+  end
+end

data/test/test_file.txt

@@ -0,0 +1 @@
+just for test

data/test/test_spotlight.rb

@@ -0,0 +1,58 @@
+require "test/unit"
+require "spotlight"
+
+class TestSpotlight < Test::Unit::TestCase
+
+  def setup
+    @dir = File.expand_path(File.dirname(__FILE__))
+    @item = Spotlight::MDItem.new(File.join(@dir, 'test_file.txt'))
+  end
+
+  def test_search
+    assert_equal [@item], Spotlight.search("kMDItemDisplayName == 'test_file.txt'", @dir)
+  end
+
+  def test_search_with_multi_scope_directories
+    @lib_dir = File.expand_path(File.dirname(__FILE__) + "/../lib")
+    assert_equal [@item], Spotlight.search("kMDItemDisplayName == 'test_file.txt'", @lib_dir, @dir)
+  end
+
+  def test_search_attribute_just_set
+    time_now = Time.now.to_i
+    @item['kMDItemNow'] = time_now
+    assert_equal [@item], Spotlight.search("kMDItemNow == #{time_now}", @dir)
+  end
+
+  def test_attributes
+    assert_equal "test_file.txt", @item.attributes['kMDItemDisplayName']
+  end
+
+  def test_could_not_set_attribute_value_when_it_is_not_time_string_int_and_float
+    assert_raise Spotlight::MDItem::InvalidAttributeValueTypeError do
+      assert_attribute_set('kMDItemTestLongType', Hash.new)
+    end
+  end
+
+  def test_get_attribute
+    assert_equal "test_file.txt", @item['kMDItemDisplayName']
+    assert_equal ["public.plain-text", "public.text", "public.data", "public.item", "public.content"], @item['kMDItemContentTypeTree']
+  end
+
+  def test_set_attribute
+    assert_attribute_set('kMDItemTestStringType', "Time.now: #{Time.now}")
+    assert_attribute_set('kMDItemTestLongType', Time.now.to_i)
+    assert_attribute_set('kMDItemTestIntType', Time.now.to_i.to_s[-3..-1].to_i)
+    assert_attribute_set('kMDItemTestFloatType', 1.123456688)
+    assert_attribute_set('kMDItemTestArrayTypeWithString', ["public.plain-text", "public.text"])
+    assert_attribute_set('kMDItemTestArrayTypeWithLong', [123456789])
+  end
+
+  def test_set_date_attribute
+    assert_attribute_set('kMDItemTestDateType', Time.now)
+  end
+
+  def assert_attribute_set(name, value)
+    @item[name] = value
+    assert_equal value, @item.reload[name]
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: mac-spotlight
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Li Xiao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Spotlight - Ruby interface to Mac OSX Spotlight
+email: iam@li-xiao.com
+executables: []
+
+extensions: 
+- ext/spotlight/extconf.rb
+extra_rdoc_files: 
+- README.rdoc
+- TODO
+- ext/spotlight/extconf.rb
+- ext/spotlight/spotlight.c
+- lib/spotlight.rb
+files: 
+- MIT-LICENSE.txt
+- Manifest
+- README.rdoc
+- Rakefile
+- TODO
+- ext/spotlight/extconf.rb
+- ext/spotlight/spotlight.c
+- lib/spotlight.rb
+- test/test_file.txt
+- test/test_spotlight.rb
+- mac-spotlight.gemspec
+has_rdoc: true
+homepage: https://github.com/xli/spotlight
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+- --charset
+- UTF-8
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: mac-spotlight
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Spotlight - Ruby interface to Mac OSX Spotlight
+test_files: 
+- test/test_spotlight.rb