spotlight 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 youpy
+
+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/README.rdoc

@@ -0,0 +1,33 @@
+= spotlight
+
+Description goes here.
+
+== Synopsis
+
+ require 'spotlight'
+
+=== Finds files matching a given query
+
+ query = Spotlight::Query.new('kMDItemKind = "JPEG image" && kMDItemPixelHeight > 2000')
+ query.execute.map {|item|
+   puts item.get(:kMDItemPath)
+ }
+
+=== Gets the metadata attributes for the specified file
+
+ item = Spotlight::Item.new('/Users/youpy/foo')
+ item.get(:kMDItemKind)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 youpy. See LICENSE for details.

data/ext/md_item_native/extconf.rb

@@ -0,0 +1,7 @@
+require "mkmf"
+require "rbconfig"
+
+$LDFLAGS += ' -framework CoreFoundation -framework CoreServices'
+
+have_header("md_item_native")
+create_makefile("md_item_native")

data/ext/md_item_native/md_item_native.c

@@ -0,0 +1,107 @@
+#include "md_item_native.h"
+
+static VALUE rb_cMDItemNative;
+
+struct ItemObject {
+  MDItemRef item;
+};
+
+CFStringRef CString2CFString(char *str) {
+  return CFStringCreateWithCString(kCFAllocatorDefault,
+                                   str,
+                                   CFStringGetSystemEncoding());
+}
+
+MDItemRef getItem(VALUE obj) {
+  struct ItemObject *itemObject;
+
+  Data_Get_Struct(obj, struct ItemObject, itemObject);
+  return itemObject->item;
+}
+
+void cMDItemNative_free(void *ptr) {
+  MDItemRef item = (MDItemRef)(((struct ItemObject *)ptr)->item);
+
+  if(item != NULL) {
+    CFRelease(item);
+  }
+
+  free(ptr);
+/*   printf("cMDItemNative_free()\n"); */
+}
+
+VALUE createInstanceFromMDItem(MDItemRef item) {
+  struct ItemObject *itemObject;
+
+  itemObject = malloc(sizeof(struct ItemObject));
+  itemObject->item = item;
+
+  return Data_Wrap_Struct(rb_cMDItemNative, 0, cMDItemNative_free, itemObject);
+}
+
+static VALUE cMDItemNative_new(int argc, VALUE *argv, VALUE klass)
+{
+  VALUE filename, obj;
+  MDItemRef item;
+  CFStringRef cfFilename;
+
+  rb_scan_args(argc, argv, "1", &filename);
+
+  cfFilename = CString2CFString(StringValuePtr(filename));
+  item = MDItemCreate(kCFAllocatorDefault, cfFilename);
+
+  if(item != NULL) {
+    obj = createInstanceFromMDItem(item);
+  } else {
+    rb_raise(rb_eArgError, "no such file or directory");
+  }
+
+  CFRelease(cfFilename);
+
+  return obj;
+}
+
+static VALUE cMDItemNative_get(int argc, VALUE *argv, VALUE self)
+{
+  MDItemRef item = getItem(self);
+  CFStringRef itemValue, cfAttrName;
+  VALUE attrName, result;
+  char *tmpptr;
+  int stringSize;
+  
+  rb_scan_args(argc, argv, "1", &attrName);
+
+  if(TYPE(attrName) == T_SYMBOL) {
+    cfAttrName = (CFStringRef)CString2CFString(rb_id2name(SYM2ID(attrName)));
+  } else {
+    cfAttrName = (CFStringRef)CString2CFString(StringValuePtr(attrName));
+  }
+
+  itemValue = (CFStringRef)MDItemCopyAttribute(item, cfAttrName);
+
+  if(itemValue != NULL) {
+    stringSize = CFStringGetMaximumSizeForEncoding(CFStringGetLength(itemValue), kCFStringEncodingUTF8) + 1;
+    tmpptr = (char *)malloc(sizeof(char) * stringSize);
+
+    CFStringGetCString(itemValue, tmpptr, stringSize, kCFStringEncodingUTF8);
+
+    result = rb_str_new2(tmpptr);
+
+    free(tmpptr);
+    CFRelease(cfAttrName);
+    CFRelease(itemValue);
+  } else {
+    return Qnil;
+  }
+
+  return result;
+}
+
+void Init_md_item_native(void){
+  VALUE rb_mSpotlight;
+  
+  rb_mSpotlight = rb_define_module("Spotlight");
+  rb_cMDItemNative = rb_define_class_under(rb_mSpotlight, "MDItemNative", rb_cObject);
+  rb_define_singleton_method(rb_cMDItemNative, "new", cMDItemNative_new, -1);
+  rb_define_method(rb_cMDItemNative, "get", cMDItemNative_get, -1);
+}

data/ext/md_item_native/md_item_native.h

@@ -0,0 +1,9 @@
+#ifndef MD_ITEM_NATIVE_H
+#define MD_ITEM_NATIVE_H
+
+#include <ruby.h>
+#include </System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/Metadata.framework/Versions/A/Headers/MDItem.h>
+
+VALUE createInstanceFromMDItem(MDItemRef item);
+
+#endif

data/ext/md_query_native/extconf.rb

@@ -0,0 +1,6 @@
+require "mkmf"
+require "rbconfig"
+
+$LDFLAGS += ' -framework CoreFoundation -framework CoreServices'
+
+create_makefile("md_query_native")

data/ext/md_query_native/md_query_native.c

@@ -0,0 +1,112 @@
+#include <ruby.h>
+#include </System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/Metadata.framework/Versions/A/Headers/MDQuery.h>
+#include "../md_item_native/md_item_native.h"
+
+struct QueryObject {
+  CFStringRef queryString;
+  MDQueryRef query;
+};
+
+CFStringRef CString2CFString(char *str) {
+  return CFStringCreateWithCString(kCFAllocatorDefault,
+                                   str,
+                                   CFStringGetSystemEncoding());
+}
+
+MDQueryRef getQuery(VALUE obj) {
+  struct QueryObject *queryObject;
+
+  Data_Get_Struct(obj, struct QueryObject, queryObject);
+  return queryObject->query;
+}
+
+void cMDQueryNative_free(void *ptr) {
+  MDQueryRef query = (MDQueryRef)(((struct QueryObject *)ptr)->query);
+  CFStringRef queryString = (CFStringRef)(((struct QueryObject *)ptr)->queryString);
+
+  if(query != NULL) {
+    CFRelease(query);
+  }
+
+  if(queryString != NULL) {
+    CFRelease(queryString);
+  }
+
+  free(ptr);
+/*   printf("cMDQueryNative_free()\n"); */
+}
+
+static VALUE cMDQueryNative_new(int argc, VALUE *argv, VALUE klass)
+{
+  VALUE queryString;
+  VALUE obj;
+
+  rb_scan_args(argc, argv, "1", &queryString);
+
+  struct QueryObject *q = malloc(sizeof(struct QueryObject));
+  q->queryString = CString2CFString(StringValuePtr(queryString));
+  q->query = MDQueryCreate(kCFAllocatorDefault, q->queryString, NULL, NULL);
+  obj = Data_Wrap_Struct(klass, 0, cMDQueryNative_free, q);
+
+  return obj;
+}
+
+static VALUE cMDQueryNative_set_search_scopes(int argc, VALUE *argv, VALUE self)
+{
+  VALUE scopes;
+  CFStringRef *itemsList;
+  CFArrayRef scopesList;
+  int i;
+
+  rb_scan_args(argc, argv, "1", &scopes);
+  itemsList = (CFStringRef *)malloc(sizeof(CFStringRef) * (RARRAY(scopes)->len));
+
+  for(i = 0; i < RARRAY(scopes)->len; i ++) {
+    itemsList[i] = (CFStringRef)CString2CFString(StringValuePtr(RARRAY(scopes)->ptr[i]));
+  }
+
+  scopesList = CFArrayCreate(kCFAllocatorDefault,
+                             (const void**)itemsList,
+                             RARRAY(scopes)->len,
+                             NULL);
+  MDQuerySetSearchScope(getQuery(self), scopesList, 0);
+
+  CFRelease(scopesList);
+  free(itemsList);
+
+  return self;
+}
+
+static VALUE cMDQueryNative_execute(int argc, VALUE *argv, VALUE self)
+{
+  MDQueryRef query = getQuery(self);
+  MDItemRef item;
+  VALUE result = rb_ary_new();
+  VALUE rItem;
+  int resultCount, i;
+
+  MDQueryExecute(query, kMDQuerySynchronous);
+  MDQueryStop(query);
+  resultCount = MDQueryGetResultCount(query);
+  for(i = 0; i < resultCount; i ++) {
+    item = (MDItemRef)MDQueryGetResultAtIndex(query, i);
+    if(item != NULL) {
+      CFRetain(item);
+      rItem = createInstanceFromMDItem(item);
+      rb_ary_push(result, rItem);
+    }
+  }
+
+  return result;
+}
+
+void Init_md_query_native(void){
+  VALUE rb_mSpotlight;
+  VALUE rb_cMDQueryNative;
+  
+  rb_mSpotlight = rb_define_module("Spotlight");
+  rb_cMDQueryNative = rb_define_class_under(rb_mSpotlight, "MDQueryNative", rb_cObject);
+  rb_define_singleton_method(rb_cMDQueryNative, "new", cMDQueryNative_new, -1);
+  rb_define_method(rb_cMDQueryNative, "set_search_scopes", cMDQueryNative_set_search_scopes, -1);
+  rb_define_method(rb_cMDQueryNative, "execute", cMDQueryNative_execute, -1);
+}

data/lib/spotlight/query.rb

@@ -0,0 +1,17 @@
+module Spotlight
+  class Query
+    attr_reader :query_string
+    attr_accessor :scopes
+
+    def initialize(query_string)
+      @query_string = query_string
+      @scopes = []
+    end
+
+    def execute
+      @md_query = MDQueryNative.new(query_string)
+      @md_query.set_search_scopes(@scopes)
+      @md_query.execute
+    end
+  end
+end

data/lib/spotlight.rb

@@ -0,0 +1,7 @@
+require 'md_query_native'
+require 'md_item_native'
+require 'spotlight/query'
+
+module Spotlight
+  Item = MDItemNative
+end

data/spec/md_item_native_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Spotlight::MDItemNative do
+  before do
+    @query = Spotlight::MDItemNative.new(__FILE__)
+  end
+
+  it "should instanciate" do
+    @query.should be_an_instance_of(Spotlight::MDItemNative)
+  end
+
+  it "should get attribute by name" do
+    @query.get('kMDItemKind').should eql('Ruby Source File')
+    @query.get(:kMDItemKind).should eql('Ruby Source File')
+  end
+
+  it "should get nil if attribute is not found" do
+    @query.get('kMDXXXXXX').should be_nil
+  end
+end

data/spec/md_query_native_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Spotlight::MDQueryNative do
+  before do
+    @query = Spotlight::MDQueryNative.new('kMDItemDisplayName = "*_spec.rb"cdw')
+  end
+
+  it "should instanciate" do
+    @query.should be_an_instance_of(Spotlight::MDQueryNative)
+  end
+
+  it "should execute" do
+    @query.set_search_scopes([File.expand_path(File.dirname(__FILE__))]);
+    @query.execute.first.should be_an_instance_of(Spotlight::MDItemNative)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spotlight'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/spotlight_query_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Spotlight::Query do
+  before do
+    @query = Spotlight::Query.new('kMDItemDisplayName = "spotlight_query_spec.rb"')
+  end
+
+  it "should have query string" do
+    @query.query_string.should eql('kMDItemDisplayName = "spotlight_query_spec.rb"')
+  end
+
+  it "should execute query" do
+    @query.scopes << File.expand_path(File.dirname(__FILE__))
+    result = @query.execute
+    result.size.should eql(1)
+    result.first.should be_an_instance_of(Spotlight::MDItemNative)
+    result.first.get(:kMDItemPath).should eql(File.expand_path(File.dirname(__FILE__) + '/spotlight_query_spec.rb'))
+
+    @query.scopes = ['/tmp/xxx/yyy']
+    result = @query.execute
+    result.should be_empty
+  end
+
+  it "should execute query with empty scope" do
+    result = @query.execute
+    result.should_not be_empty 
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: spotlight
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- youpy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Library to use Spotlight from Ruby
+email: youpy@buycheapviagraonlinenow.com
+executables: []
+
+extensions: 
+- ext/md_item_native/extconf.rb
+- ext/md_query_native/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- ext/md_item_native/md_item_native.c
+- ext/md_item_native/md_item_native.h
+- ext/md_query_native/md_query_native.c
+- lib/spotlight.rb
+- lib/spotlight/query.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/youpy/spotlight
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Spotlight for Ruby
+test_files: 
+- spec/md_item_native_spec.rb
+- spec/md_query_native_spec.rb
+- spec/spec_helper.rb
+- spec/spotlight_query_spec.rb