xapor 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RUBYMINE
+.idea/*
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Workman
+
+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,17 @@
+= xapor
+
+Description goes here.
+
+== 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 David Workman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xapor"
+    gem.summary = %Q{Rails plugin for Xapian search}
+    gem.description = %Q{Rails plugin for Xapian search, built on XapianFu and DelayedJob.}
+    gem.email = "workmad3@hedtek.com"
+    gem.homepage = "http://github.com/hedtekltd/xapor"
+    gem.authors = ["David Workman"]
+    gem.add_dependency "xapian-fu", ">= 1.1.0"
+    gem.add_dependency "delayed_job", ">= 2.0.3"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xapor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/features/step_definitions/xapor_steps.rb

@@ -0,0 +1,48 @@
+class XaporTest
+
+end
+
+Given /^I have a model object with "([^\"]*)"$/ do |field|
+  XaporTest.send(:attr_accessor, field.to_sym)
+  XaporTest.new.respond_to?(field.to_sym).should be_true
+  XaporTest.new.respond_to?(:"#{field}=").should be_true
+end
+
+When /^I call xapor to index "([^\"]*)"$/ do |field|
+  XaporTest.send(:include, Xapor::ModelIntegration)
+  XaporTest.send(:xapor) do |index|
+    index.search field.to_sym
+  end
+end
+
+Then /^I should have a "([^\"]*)" function$/ do |func_name|
+  @test = XaporTest.new
+  @test.respond_to?(func_name.to_sym).should be_true
+end
+
+Then /^I should have a "([^\"]*)" class function$/ do |func_name|
+  XaporTest.respond_to?(func_name.to_sym).should be_true
+end
+
+Given /^I have a xapor model object with a name$/ do
+  XaporTest.send(:attr_accessor, :name)
+  XaporTest.send(:include, Xapor::ModelIntegration)
+  XaporTest.send(:xapor) do |index|
+    index.search :name
+  end
+end
+
+When /^I have a xapor model with name "([^\"]*)"$/ do |name|
+  model = XaporTest.new
+  model.name = name
+  if !@models
+    @models = []
+  end
+  @models << model
+end
+When /^I search the model for "([^\"]*)"$/ do |query|
+  @search_results = XaporTest.search(query)
+end
+Then /^I should get 1 result$/ do
+  @search_results.size.should == 1
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'xapor'
+
+require 'spec/expectations'

data/features/xapor.feature

@@ -0,0 +1,17 @@
+Feature:
+  In order to search models
+  I need to add search functionality to a model with xapor
+
+  Scenario: Adding xapor searching to an object
+    Given I have a model object with "name"
+    When I call xapor to index "name"
+    Then I should have a "search" class function
+    And I should have a "search_by_name" class function
+
+  Scenario: Searching with xapor
+    Given I have a xapor model object with a name
+    And I have a xapor model with name "Testing"
+    And I have a xapor model with name "Awesome"
+    When I search the model for "Testing"
+    Then I should get 1 result
+    And I should have a result with name "Testing"

data/init.rb

@@ -0,0 +1 @@
+require 'xapor'

data/lib/xapor/config.rb

@@ -0,0 +1,28 @@
+class Xapor::Config
+  attr_reader :search_fields
+  attr_reader :store_fields
+  attr_reader :directory_config
+  
+  def initialize
+    @search_fields = []
+    @store_fields = []
+  end
+
+  def search(field, options = {})
+    @search_fields << field
+    if options[:store]
+      @store_fields << field
+    end
+  end
+
+  def directory(path)
+    @directory_config = path
+  end
+
+  def xapian_fu_db
+    db_settings = {}
+    db_settings[:dir] = @directory_config if @directory_config
+    db_settings[:store] = @store_fields unless @store_fields.empty?
+    return db_settings
+  end
+end

data/lib/xapor/model_integration.rb

@@ -0,0 +1,54 @@
+module Xapor::ModelIntegration
+  def self.included(base)
+    base.send(:include, Xapor::XapianFuIntegration)
+  end
+end
+
+module Xapor::XapianFuIntegration
+  include XapianFu
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def xapor
+      class << self
+        include XapianFu
+
+        def search(query)
+          db = XapianDb.new(@config.xapian_fu_db)
+          db.search(query)
+        end
+
+        def xapor_config
+          @config
+        end
+      end
+      @config = Xapor::Config.new
+      if block_given?
+        yield @config
+      end
+      @config.search_fields.each do |field|
+        class_eval("def self.search_by_#{field}(query)\nself.search(query)\nend")
+      end
+    end
+  end
+
+  def perform
+    config = self.class.xapor_config
+    db = XapianDb.new(config.xapian_fu_db.merge(:create => true))
+    doc = {:id => self.id}
+    config.search_fields.each do |field|
+      doc[field] = self.send(field.to_sym)
+    end
+    db << doc
+    db.flush
+  end
+
+  def add_to_index
+    Delayed::Job.enqueue self
+    Thread.new do
+      Delayed::Worker.new.start
+    end
+  end
+end

data/lib/xapor.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'delayed_job'
+require 'xapian-fu'
+
+module Xapor
+  LIB_PATH = File.join(File.dirname(__FILE__), "xapor")
+end
+
+require File.join(Xapor::LIB_PATH, "model_integration")
+require File.join(Xapor::LIB_PATH, "config")

data/spec/lib/xapor/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Xapor::Config, "Configuration settings for a Xapor index" do
+  it "should allow specification of search fields" do
+    config = Xapor::Config.new
+    config.respond_to?(:search).should be_true
+    config.search :test
+    config.search_fields.should == [:test]
+  end
+
+  it "should allow specification of the index location" do
+    config = Xapor::Config.new
+    config.respond_to?(:directory).should be_true
+    config.directory "test/path.db"
+    config.directory_config.should == "test/path.db"
+  end
+
+  it "should let you specify if you want to store a field" do
+    config = Xapor::Config.new
+    config.search :test, :store => true
+    config.store_fields.should == [:test]
+  end
+
+  it "should provide XapianFu config settings" do
+    config = Xapor::Config.new
+    config.directory "test/path.db"
+    config.xapian_fu_db.should == {:dir => "test/path.db"}
+  end
+end

data/spec/lib/xapor/model_integration_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Xapor::ModelIntegration, "Search integration into a model class" do
+  it "should add a xapor function when included" do
+    XaporTest.respond_to?(:xapor).should be_false
+    XaporTest.send(:include, Xapor::ModelIntegration)
+    XaporTest.respond_to?(:xapor).should be_true
+  end
+
+  it "should add a search function when xapor is called" do
+    XaporTest.send(:include, Xapor::ModelIntegration)
+    XaporTest.send(:xapor)
+    XaporTest.respond_to?(:search).should be_true
+  end
+
+  it "should add a search_by_name function when xapor is called with a block that indexes the name" do
+    XaporTest.send(:attr_accessor, :name)
+    XaporTest.send(:include, Xapor::ModelIntegration)
+    XaporTest.send(:xapor) {|idx| idx.search :name}
+    XaporTest.respond_to?(:search_by_name).should be_true
+  end
+
+  it "add a perform method for delayed job" do
+    XaporTest.send(:attr_accessor, :name)
+    XaporTest.send(:include, Xapor::ModelIntegration)
+    XaporTest.send(:xapor) {|idx|
+      idx.search :name
+      idx.directory "test.db"
+    }
+    XaporTest.new.respond_to?(:perform).should be_true
+    test = XaporTest.new
+    test.should_receive(:id).and_return(1)
+    test.should_receive(:name).and_return("Awesome")
+    test.perform
+  end
+end

data/spec/lib/xapor_spec.rb

@@ -0,0 +1,2 @@
+require 'spec_helper'
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xapor'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+# An empty class to be used for hooking on the Xapor spec functionality
+class XaporTest
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: xapor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- David Workman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xapian-fu
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: delayed_job
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 3
+        version: 2.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Rails plugin for Xapian search, built on XapianFu and DelayedJob.
+email: workmad3@hedtek.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/step_definitions/xapor_steps.rb
+- features/support/env.rb
+- features/xapor.feature
+- init.rb
+- lib/xapor.rb
+- lib/xapor/config.rb
+- lib/xapor/model_integration.rb
+- spec/lib/xapor/config_spec.rb
+- spec/lib/xapor/model_integration_spec.rb
+- spec/lib/xapor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hedtekltd/xapor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails plugin for Xapian search
+test_files: 
+- spec/lib/xapor/config_spec.rb
+- spec/lib/xapor/model_integration_spec.rb
+- spec/lib/xapor_spec.rb
+- spec/spec_helper.rb