dm-ferret-adapter 0.9.11 → 0.10.0

data/{History.txt → History.rdoc}

@@ -1,3 +1,7 @@
+=== 0.10.0 / 2009-10-15
+
+* Updated to work with dm-core 0.10.0
+
 === 0.9.11 / 2009-03-29
 
 * No changes this version

data/Manifest.txt

@@ -1,18 +1,19 @@
 .gitignore
-History.txt
+History.rdoc
 LICENSE
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 TODO
 bin/ferret
 lib/ferret_adapter.rb
+lib/ferret_adapter/adapter.rb
 lib/ferret_adapter/local_index.rb
 lib/ferret_adapter/remote_index.rb
 lib/ferret_adapter/repository_ext.rb
 lib/ferret_adapter/version.rb
 spec/adapter_spec.rb
-spec/helper.rb
 spec/spec.opts
+spec/spec_helper.rb
 tasks/install.rb
 tasks/spec.rb

data/Rakefile

@@ -1,5 +1,4 @@
 require 'pathname'
-require 'rubygems'
 
 ROOT    = Pathname(__FILE__).dirname.expand_path
 JRUBY   = RUBY_PLATFORM =~ /java/
@@ -14,7 +13,7 @@ GEM_NAME = 'dm-ferret-adapter'
 GEM_VERSION = DataMapper::FerretAdapter::VERSION
 GEM_DEPENDENCIES = [['dm-core', GEM_VERSION], ['ferret', '~>0.11.6']]
 GEM_CLEAN = %w[ log pkg coverage ]
-GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] } #,
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.rdoc LICENSE TODO History.rdoc ] } #,
 #               :executables => %w[ ferret ], :bindir => 'bin' }  # FIXME: should this be enabled?
 
 PROJECT_NAME = 'datamapper'

data/bin/ferret

@@ -7,10 +7,10 @@ require "optparse"
 require "rinda/tuplespace"
 require 'rubygems'
 
-gem 'dm-core', '0.9.11'
+gem 'dm-core', '0.10.0'
 require 'dm-core'
 
-gem 'dm-ferret-adapter', '0.9.11'
+gem 'dm-ferret-adapter', '0.10.0'
 require 'ferret_adapter'
 
 options = {

data/lib/ferret_adapter.rb

@@ -1,111 +1,7 @@
-require 'rubygems'
-require 'pathname'
-require Pathname(__FILE__).dirname + 'ferret_adapter/version'
-
-gem 'dm-core', '0.9.11'
-require 'dm-core'
-
-gem 'ferret', '~>0.11.6'
 require 'ferret'
 
-module DataMapper
-  module Adapters
-    class FerretAdapter < AbstractAdapter
-      def initialize(name, uri_or_options)
-        super
-        unless File.extname(@uri.path) == ".sock"
-          @index = LocalIndex.new(@uri)
-        else
-          @index = RemoteIndex.new(@uri)
-        end
-      end
-
-      def create(resources)
-        resources.each do |resource|
-          attributes = repository(self.name) do
-            attrs = resource.attributes
-            attrs.delete_if { |name, value| !resource.class.properties(self.name).has_property?(name) }
-            resource.class.new(attrs).attributes
-          end
-
-          # Since we don't inspect the models before generating the indices,
-          # we'll map the resource's key to the :id column.
-          key = resource.class.key.first
-          attributes[:id] = attributes.delete(key.name) unless key.name == :id
-          attributes[:_type] = resource.class.name
-
-          @index.add attributes
-        end
-        1
-      end
-
-      def delete(query)
-        ferret_query = dm_query_to_ferret_query(query)
-        @index.delete ferret_query
-        1
-      end
-
-      # This returns an array of Ferret docs (glorified hashes) which can
-      # be used to instantiate objects by doc[:_type] and doc[:_id]
-      def read_many(query, limit = query.limit)
-        ferret_query = dm_query_to_ferret_query(query)
-        @index.search(ferret_query, :limit => (limit || :all))
-      end
-
-      def read_one(query)
-        read_many(query).first
-      end
-
-      # This returns a hash of the resource constant and the ids returned for it
-      # from the search.
-      #   { Story => ["1", "2"], Image => ["2"] }
-      def search(query, limit)
-        results = Hash.new { |h, k| h[k] = [] }
-        read_many(query, limit).each do |doc|
-          results[Object.const_get(doc[:_type])] << doc[:id]
-        end
-        results
-      end
-
-      private
-
-      def dm_query_to_ferret_query(query)
-        # If we already have a ferret query, do nothing
-        return query if query.is_a?(String)
-
-        ferret = []
-
-        # We scope the query by the _type field to the query's model.
-        ferret << "+_type:\"#{query.model.name}\""
-
-        if query.conditions.empty?
-          ferret << "*"
-        else
-          query.conditions.each do |operator, property, value|
-            # We use property.field here, so that you can declare composite
-            # fields:
-            #     property :content, String, :field => "title|description"
-            name = property.field
-
-            # Since DM's query syntax does not support OR's, we prefix
-            # each condition with ferret's operator of +.
-            ferret << case operator
-            when :eql, :like  then "+#{name}:\"#{value}\""
-            when :not         then "-#{name}:\"#{value}\""
-            when :lt          then "+#{name}: < #{value}"
-            when :gt          then "+#{name}: > #{value}"
-            when :lte         then "+#{name}: <= #{value}"
-            when :gte         then "+#{name}: >= #{value}"
-            end
-          end
-        end
-        ferret.join(" ")
-      end
-
-    end
-  end
-end
-
-require Pathname(__FILE__).dirname + "ferret_adapter/local_index"
-require Pathname(__FILE__).dirname + "ferret_adapter/remote_index"
-require Pathname(__FILE__).dirname + "ferret_adapter/repository_ext"
+require 'ferret_adapter/adapter'
+require 'ferret_adapter/local_index'
+require 'ferret_adapter/remote_index'
+require 'ferret_adapter/repository_ext'
+require 'ferret_adapter/version'

data/lib/ferret_adapter/adapter.rb

@@ -0,0 +1,141 @@
+module DataMapper
+  module Adapters
+    class FerretAdapter < AbstractAdapter
+      def initialize(name, options)
+        super
+        @index = unless File.extname(@options[:path]) == '.sock'
+          LocalIndex.new(@options)
+        else
+          RemoteIndex.new(@options)
+        end
+      end
+
+      def create(resources)
+        resources.each do |resource|
+          attributes = resource.attributes(:field).to_mash
+
+          # Since we don't inspect the models before generating the indices,
+          # we'll map the resource's key to the :id column.
+          attributes[:id]    ||= resource.key.first
+          attributes[:_type]   = resource.model.name
+
+          @index.add attributes
+        end
+      end
+
+      # This returns an array of Ferret docs (glorified hashes) which can
+      # be used to instantiate objects by doc[:_type] and doc[:_id]
+      def read(query)
+        fields = query.fields
+        key    = query.model.key(name).first
+
+        ferret_query = dm_query_to_ferret_query(query)
+
+        @index.search(ferret_query, :limit => query.limit).map do |lazy_doc|
+          fields.map { |p| [ p, p.typecast(lazy_doc[p.field]) ] }.to_hash.update(
+            key.field => key.typecast(lazy_doc[:id])
+          )
+        end
+      end
+
+      def delete(collection)
+        @index.delete dm_query_to_ferret_query(collection.query)
+        1
+      end
+
+      # This returns a hash of the resource constant and the ids returned for it
+      # from the search.
+      #   { Story => ["1", "2"], Image => ["2"] }
+      def search(ferret_query, limit = :all)
+        results = {}
+        @index.search(ferret_query, :limit => limit).each do |doc|
+          resources = results[Object.const_get(doc[:_type])] ||= []
+          resources << doc[:id]
+        end
+        results
+      end
+
+      private
+
+      def dm_query_to_ferret_query(query)
+        # We scope the query by the _type field to the query's model.
+        statements = [ "+_type:#{quote_value(query.model.name)}" ]
+
+        if query.conditions.operands.empty?
+          statements << '*'
+        else
+          # TODO: make this work with the new Query conditions system
+          statements << "#{conditions_statement(query.conditions)}"
+        end
+
+        statements.join(' ')
+      end
+
+      def conditions_statement(conditions)
+        case conditions
+          when Query::Conditions::NotOperation       then negate_operation(conditions)
+          when Query::Conditions::AbstractOperation  then operation_statement(conditions)
+          when Query::Conditions::AbstractComparison then comparison_statement(conditions)
+        end
+      end
+
+      def negate_operation(operation)
+        "NOT (#{conditions_statement(operation.operands.first)})"
+      end
+
+      def operation_statement(operation)
+        statements  = []
+
+        operation.each do |operand|
+          statement = conditions_statement(operand)
+
+          if operand.respond_to?(:operands) && operand.operands.size > 1
+            statement = "(#{statement})"
+          end
+
+          statements << statement
+        end
+
+        join_with = operation.kind_of?(Query::Conditions::AndOperation) ? 'AND' : 'OR'
+        statements.join(" #{join_with} ")
+      end
+
+      def comparison_statement(comparison)
+        value = comparison.value
+
+        # TODO: move exclusive Range handling into another method, and
+        # update conditions_statement to use it
+
+        # break exclusive Range queries up into two comparisons ANDed together
+        if value.kind_of?(Range) && value.exclude_end?
+          operation = Query::Conditions::BooleanOperation.new(:and,
+            Query::Conditions::Comparison.new(:gte, comparison.subject, value.first),
+            Query::Conditions::Comparison.new(:lt,  comparison.subject, value.last)
+          )
+
+          return "(#{operation_statement(operation)})"
+        end
+
+        operator = case comparison
+          when Query::Conditions::EqualToComparison              then ''
+          when Query::Conditions::InclusionComparison            then raise NotImplementedError, 'no support for inclusion match yet'
+          when Query::Conditions::RegexpComparison               then raise NotImplementedError, 'no support for regexp match yet'
+          when Query::Conditions::LikeComparison                 then raise NotImplementedError, 'no support for like match yet'
+          when Query::Conditions::GreaterThanComparison          then '>'
+          when Query::Conditions::LessThanComparison             then '<'
+          when Query::Conditions::GreaterThanOrEqualToComparison then '>='
+          when Query::Conditions::LessThanOrEqualToComparison    then '<='
+        end
+
+        # We use property.field here, so that you can declare composite
+        # fields:
+        #     property :content, String, :field => "title|description"
+        [ "+#{comparison.subject.field}:", quote_value(value) ].join(operator)
+      end
+
+      def quote_value(value)
+        value.kind_of?(Numeric) ? value : "\"#{value}\""
+      end
+    end
+  end
+end

data/lib/ferret_adapter/local_index.rb

@@ -1,12 +1,9 @@
 module DataMapper
   module Adapters
     class FerretAdapter::LocalIndex
-
-      attr_accessor :uri
-
-      def initialize(uri)
-        @uri = uri
-        @options = { :path => @uri.path, :key => [:id, :_type] }
+      def initialize(options)
+        @options = options
+        @options = { :path => @options[:path], :key => [:id, :_type] }
         create_or_initialize_index
       end
 
@@ -29,7 +26,7 @@ module DataMapper
       private
 
       def create_or_initialize_index
-        unless File.exists?(@uri.path + "segments")
+        unless File.exists?(@options[:path] + "segments")
           field_infos = ::Ferret::Index::FieldInfos.new(:store => :no)
           field_infos.add_field(:id, :index => :untokenized, :term_vector => :no, :store => :yes)
           field_infos.add_field(:_type, :index => :untokenized, :term_vector => :no, :store => :yes)

data/lib/ferret_adapter/remote_index.rb

@@ -5,10 +5,8 @@ module DataMapper
       class IndexNotFound < Exception; end
       class SearchError < Exception; end
 
-      attr_accessor :uri
-
-      def initialize(uri)
-        @uri = uri
+      def initialize(options)
+        @options = options
 
         connect_to_remote_index
       end
@@ -39,7 +37,7 @@ module DataMapper
         require "rinda/tuplespace"
 
         DRb.start_service
-        tuple_space = DRb::DRbObject.new(nil, "drbunix://#{@uri.path}")
+        tuple_space = DRb::DRbObject.new(nil, "drbunix://#{@options[:path]}")
 
         # This will throw Errno::ENOENT if the socket does not exist.
         tuple_space.respond_to?(:write)

data/lib/ferret_adapter/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   class FerretAdapter
-    VERSION = '0.9.11'
+    VERSION = '0.10.0'.freeze
   end
 end

data/spec/adapter_spec.rb

@@ -1,35 +1,43 @@
-require 'pathname'
-require Pathname(__FILE__).dirname + "helper"
+require 'spec_helper'
 
-class User
-  include DataMapper::Resource
-  property :id, Serial
-end
+INDEX_PATH = Pathname(__FILE__).dirname.expand_path + 'index'
 
-class Photo
-  include DataMapper::Resource
-  property :uuid, String, :default => lambda { `uuidgen`.chomp }, :key => true
-end
+describe DataMapper::Adapters::FerretAdapter do
+  before do
+    @adapter = DataMapper.setup(:default, "ferret://#{INDEX_PATH}")
+
+    Object.send(:remove_const, :User) if defined?(User)
+    class ::User
+      include DataMapper::Resource
+
+      property :id, Serial
+    end
+
+    Object.send(:remove_const, :Photo) if defined?(Photo)
+    class ::Photo
+      include DataMapper::Resource
+
+      property :uuid, String, :default => proc { UUIDTools::UUID.random_create }, :key => true
+      property :happy, Boolean, :default => true
+    end
+  end
 
-describe "FerretAdapter" do
-  before :each do
-    @index = Pathname(__FILE__).dirname.expand_path + "index"
-    DataMapper.setup :search, "ferret://#{@index}"
+  after do
+    FileUtils.rm_r(INDEX_PATH)
   end
 
-  after :each do
-    FileUtils.rm_r(@index)
+  it 'should work with a model using id' do
+    u = User.create(:id => 2)
+    repository.search('*').should == { User => %w[ 2 ] }
   end
 
-  it "should work with a model using id" do
-    u = User.new(:id => 2)
-    repository(:search).create([u])
-    repository(:search).search("*").should == { User => ["2"] }
+  it 'should work with a model using another key than id' do
+    p = Photo.create
+    repository.search('*').should == { Photo => [p.uuid] }
   end
 
-  it "should work with a model using another key than id" do
-    p = Photo.new
-    repository(:search).create([p])
-    repository(:search).search("*").should == { Photo => [p.uuid] }
+  it 'should allow lookups using Model#get' do
+    u = User.create(:id => 2)
+    User.get(2).should == u
   end
 end

data/spec/spec.opts

@@ -1 +1,2 @@
 --colour
+--loadby random

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'uuidtools'
+
+# use local dm-core if running from a typical dev checkout.
+lib = File.join('..', '..', '..', 'dm-core', 'lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib)
+require 'dm-core'
+
+# Support running specs with 'rake spec' and 'spec'
+$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
+
+require 'ferret_adapter'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

data/tasks/install.rb

@@ -4,7 +4,7 @@ end
 
 desc "Install #{GEM_NAME} #{GEM_VERSION}"
 task :install => [ :package ] do
-  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+  sudo_gem "install pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
 end
 
 desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"

data/tasks/spec.rb

@@ -1,6 +1,4 @@
 begin
-  gem 'rspec', '~>1.2'
-  require 'spec'
   require 'spec/rake/spectask'
 
   task :default => [ :spec ]
@@ -8,16 +6,18 @@ begin
   desc 'Run specifications'
   Spec::Rake::SpecTask.new(:spec) do |t|
     t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
-    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s).map { |f| f.to_s }
+    t.libs      << 'lib' << 'spec' # needed for CI rake spec task, duplicated in spec_helper
 
     begin
-      gem 'rcov', '~>0.8'
+      require 'rcov'
       t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
       t.rcov_opts << '--exclude' << 'spec'
       t.rcov_opts << '--text-summary'
       t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
     rescue LoadError
       # rcov not installed
+    rescue SyntaxError
+      # rcov syntax invalid
     end
   end
 rescue LoadError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-ferret-adapter
 version: !ruby/object:Gem::Version 
-  version: 0.9.11
+  version: 0.10.0
 platform: ruby
 authors: 
 - Bernerd Schaefer
@@ -9,29 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-29 00:00:00 -07:00
+date: 2009-09-16 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: dm-core
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.9.11
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: ferret
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.11.6
-    version: 
+dependencies: []
+
 description: Ferret Adapter for DataMapper
 email: 
 - bernerd [a] wieck [d] com
@@ -40,35 +21,38 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 - LICENSE
 - TODO
-- History.txt
+- History.rdoc
 files: 
 - .gitignore
-- History.txt
+- History.rdoc
 - LICENSE
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - TODO
 - bin/ferret
 - lib/ferret_adapter.rb
+- lib/ferret_adapter/adapter.rb
 - lib/ferret_adapter/local_index.rb
 - lib/ferret_adapter/remote_index.rb
 - lib/ferret_adapter/repository_ext.rb
 - lib/ferret_adapter/version.rb
 - spec/adapter_spec.rb
-- spec/helper.rb
 - spec/spec.opts
+- spec/spec_helper.rb
 - tasks/install.rb
 - tasks/spec.rb
 has_rdoc: true
 homepage: http://github.com/sam/dm-more/tree/master/adapters/dm-ferret-adapter
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -86,9 +70,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: datamapper
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ferret Adapter for DataMapper
 test_files: []
 

data/spec/helper.rb

@@ -1,4 +0,0 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.parent + "lib/ferret_adapter"
-
-require "spec"