dm-ambition 0.10.2

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Kubb
+
+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.txt

@@ -0,0 +1,23 @@
+.gitignore
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+dm-ambition.gemspec
+lib/dm-ambition.rb
+lib/dm-ambition/collection.rb
+lib/dm-ambition/model.rb
+lib/dm-ambition/query.rb
+lib/dm-ambition/query/filter_processor.rb
+lib/dm-ambition/version.rb
+spec/public/collection_spec.rb
+spec/public/model_spec.rb
+spec/public/shared/filter_shared_spec.rb
+spec/semipublic/query_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/hoe.rb
+tasks/install.rb
+tasks/spec.rb

data/README.rdoc

@@ -0,0 +1,118 @@
+= dm-ambition
+
+DataMapper::Ambition is a plugin that provides an Ambition-like API for
+accessing DataMapper models.
+
+== Installation
+
+With Rubygems:
+
+  $ sudo gem install dm-ambition
+  $ irb -rubygems
+  >> require 'dm-core'
+  >> require 'dm-ambition'
+  => true
+
+With git and local working copy:
+
+  $ git clone git://github.com/dkubb/dm-ambition.git
+  $ cd dm-ambition
+  $ rake build && sudo rake install
+  $ irb -rubygems
+  >> require 'dm-core'
+  >> require 'dm-ambition'
+  => true
+
+== Examples
+
+    # with == operator
+    User.select { |u| u.name == 'Dan Kubb' }
+
+    # with =~ operator
+    User.select { |u| u.name =~ /Dan Kubb/ }
+
+    # with > operator
+    User.select { |u| u.id > 1 }
+
+    # with >= operator
+    User.select { |u| u.id >= 1 }
+
+    # with < operator
+    User.select { |u| u.id < 1 }
+
+    # with <= operator
+    User.select { |u| u.id <= 1 }
+
+    # with < operator
+    User.select { |u| u.id < 1 }
+
+    # with receiver.attribute.nil?
+    User.select { |u| u.id.nil? }
+
+    # with nil bind value
+    User.select { |u| u.id == nil }
+
+    # with true bind value
+    User.select { |u| u.admin == true }
+
+    # with false bind value
+    User.select { |u| u.admin == false }
+
+    # with AND conditions
+    User.select { |u| u.id == 1 && u.name == 'Dan Kubb' }
+
+    # with negated conditions
+    User.select { |u| !(u.id == 1) }
+
+    # with double-negated conditions
+    User.select { |u| !(!(u.id == 1)) }
+
+    # with receiver matching
+    User.select { |u| u == user }
+
+    # using send on receiver
+    User.select { |u| u.send(:name) == 'Dan Kubb' }
+
+    # with Array#include?
+    User.select { |u| user_ids.include?(u.id) }
+
+    # with Range#include?
+    User.select { |u| (1..10).include?(u.id) }
+
+    # with Hash#key?
+    User.select { |u| { 1 => 'Dan Kubb' }.key?(u.id) }
+
+    # with Hash#value?
+    User.select { |u| { 'Dan Kubb' => 1 }.value?(u.id) }
+
+    # with receiver and Array#include?
+    User.select { |u| users.include?(u) }
+
+    # with receiver and Hash#key?
+    User.select { |u| { user => 'Dan Kubb' }.key?(u) }
+
+    # with receiver and Hash#value?
+    User.select { |u| { 'Dan Kubb' => user }.value?(u) }
+
+== License
+
+Copyright (c) 2009 Dan Kubb
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+require File.expand_path('../lib/dm-ambition/version', __FILE__)
+
+begin
+  gem 'jeweler', '~> 1.4'
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name        = 'dm-ambition'
+    gem.summary     = 'DataMapper plugin providing an Ambition-like API'
+    gem.description = gem.summary
+    gem.email       = 'dan.kubb@gmail.com'
+    gem.homepage    = 'http://github.com/dkubb/%s' % gem.name
+    gem.authors     = [ 'Dan Kubb' ]
+
+    gem.version = DataMapper::Ambition::VERSION
+
+    gem.rubyforge_project = 'dm-ambition'
+
+    gem.add_dependency 'dm-core',   '~> 0.10.2'
+    gem.add_dependency 'ParseTree', '~> 3.0.4'
+    gem.add_dependency 'ruby2ruby', '~> 1.2.4'
+
+    gem.add_development_dependency 'rspec', '~> 1.2.9'
+    gem.add_development_dependency 'yard',  '~> 0.4.0'
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  FileList['tasks/**/*.rake'].each { |task| import task }
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end

data/dm-ambition.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-ambition}
+  s.version = "0.10.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Kubb"]
+  s.date = %q{2009-12-14}
+  s.description = %q{DataMapper plugin providing an Ambition-like API}
+  s.email = %q{dan.kubb@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "dm-ambition.gemspec",
+     "lib/dm-ambition.rb",
+     "lib/dm-ambition/collection.rb",
+     "lib/dm-ambition/model.rb",
+     "lib/dm-ambition/query.rb",
+     "lib/dm-ambition/query/filter_processor.rb",
+     "lib/dm-ambition/version.rb",
+     "spec/public/collection_spec.rb",
+     "spec/public/model_spec.rb",
+     "spec/public/shared/filter_shared_spec.rb",
+     "spec/rcov.opts",
+     "spec/semipublic/query_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/ci.rake",
+     "tasks/clean.rake",
+     "tasks/heckle.rake",
+     "tasks/metrics.rake",
+     "tasks/spec.rake",
+     "tasks/yard.rake",
+     "tasks/yardstick.rake"
+  ]
+  s.homepage = %q{http://github.com/dkubb/dm-ambition}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dm-ambition}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DataMapper plugin providing an Ambition-like API}
+  s.test_files = [
+    "spec/public/collection_spec.rb",
+     "spec/public/model_spec.rb",
+     "spec/public/shared/filter_shared_spec.rb",
+     "spec/semipublic/query_spec.rb",
+     "spec/spec_helper.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_runtime_dependency(%q<dm-core>, ["~> 0.10.2"])
+      s.add_runtime_dependency(%q<ParseTree>, ["~> 3.0.4"])
+      s.add_runtime_dependency(%q<ruby2ruby>, ["~> 1.2.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.2.9"])
+      s.add_development_dependency(%q<yard>, ["~> 0.4.0"])
+    else
+      s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
+      s.add_dependency(%q<ParseTree>, ["~> 3.0.4"])
+      s.add_dependency(%q<ruby2ruby>, ["~> 1.2.4"])
+      s.add_dependency(%q<rspec>, ["~> 1.2.9"])
+      s.add_dependency(%q<yard>, ["~> 0.4.0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
+    s.add_dependency(%q<ParseTree>, ["~> 3.0.4"])
+    s.add_dependency(%q<ruby2ruby>, ["~> 1.2.4"])
+    s.add_dependency(%q<rspec>, ["~> 1.2.9"])
+    s.add_dependency(%q<yard>, ["~> 0.4.0"])
+  end
+end
+

data/lib/dm-ambition/collection.rb

@@ -0,0 +1,73 @@
+# TODO: update Collection#select in dm-core to return a Collection
+# TODO: update Collection#reject in dm-core to return a Collection
+
+module DataMapper
+  module Ambition
+    module Collection
+      def self.included(base)
+        base.send(:alias_method, :find_all, :select)
+        base.send(:alias_method, :find,     :detect)
+      end
+
+      # TODO: add empty?
+      # TODO: add any?  (handle with and without block)
+      # TODO: add all?  (handle with and without block)
+      # TODO: add none? (handle with and without block) (add to LazyArray for < 1.9)
+      # TODO: add one?  (handle with and without block) (add to LazyArray for < 1.9)
+
+      # TODO: document this
+      # @api public
+      def select(&block)
+        query = self.query.filter(&block)
+
+        if loaded?
+          new_collection(query, super)
+        else
+          collection = all(query)
+
+          if head.any?
+            collection.unshift(*head.select(&block))
+          end
+
+          if tail.any?
+            collection.concat(tail.select(&block))
+          end
+
+          collection
+        end
+      end
+
+      # TODO: document this
+      # @api public
+      def detect(&block)
+        if loaded?
+          super
+        else
+          head.detect(&block) || first(query.filter(&block))
+        end
+      end
+
+      # TODO: document this
+      # @api public
+      def reject(&block)
+        query = self.query.filter(true, &block)
+
+        if loaded?
+          new_collection(query, super)
+        else
+          collection = all(query)
+
+          if head.any?
+            collection.unshift(*head.reject(&block))
+          end
+
+          if tail.any?
+            collection.concat(tail.reject(&block))
+          end
+
+          collection
+        end
+      end
+    end # module Collection
+  end # module Ambition
+end # module DataMapper

data/lib/dm-ambition/model.rb

@@ -0,0 +1,28 @@
+module DataMapper
+  module Ambition
+    module Model
+      def self.included(base)
+        base.send(:alias_method, :find_all, :select)
+        base.send(:alias_method, :find,     :detect)
+      end
+
+      # TODO: document this
+      # @api public
+      def select(&block)
+        all.select(&block)
+      end
+
+      # TODO: document this
+      # @api public
+      def detect(&block)
+        all.detect(&block)
+      end
+
+      # TODO: document this
+      # @api public
+      def reject(&block)
+        all.reject(&block)
+      end
+    end # module Model
+  end # module Ambition
+end # module DataMapper

data/lib/dm-ambition/query/filter_processor.rb

@@ -0,0 +1,361 @@
+require 'parse_tree'
+require 'parse_tree_extensions'
+require 'ruby2ruby'
+
+module DataMapper
+  module Ambition
+    module Query
+      class FilterProcessor < SexpProcessor
+        attr_reader :conditions
+
+        def initialize(binding, model, negated = false)
+          super()
+
+          self.expected        = Object # allow anything for now
+          self.auto_shift_type = true
+          self.default_method  = :process_error
+
+          @binding    = binding
+          @model      = model
+          @receiver   = nil
+
+          @container = DataMapper::Query::Conditions::Operation.new(:and)
+
+          if negated
+            @conditions = DataMapper::Query::Conditions::Operation.new(:not, @container)
+          else
+            @conditions = @container
+          end
+        end
+
+        def process_error(exp)
+          raise "DEBUG: calling process_#{exp.shift} with #{exp.inspect} (in process_error)"
+        end
+
+        def process_iter(exp)
+          call_argslist = exp.shift
+          raise "DEBUG: invalid: #{call_argslist.inspct}" if call_argslist != s(:call, nil, :proc, s(:arglist))
+
+          # get the reciever
+          @receiver = process(exp.shift)
+
+          # process the Proc body
+          result = process(exp.shift)
+
+          if result.nil?
+            raise 'DEBUG: conditions must be supplied'
+          end
+
+          unless result.equal?(@container)
+            raise "DEBUG: invalid result processing body: #{result.inspect} (expected #{@container.inspect})"
+          end
+
+          result
+        end
+
+        def process_lasgn(exp)
+          exp.shift
+        end
+
+        def process_call(exp)
+          if exp.size == 3
+            lhs      = process(exp.shift)
+            operator = exp.shift
+            rhs      = process(exp.shift)
+
+            if operator == :send
+              operator = rhs.shift
+            end
+
+            if rhs.size > 1
+              raise "DEBUG: rhs.size should not be larger than 1, but was #{rhs.size}: #{rhs.inspect}"
+            else
+              rhs = rhs.first
+            end
+
+            if lhs.nil?
+              nil
+            else
+              evaluate_operator(operator, lhs, rhs)
+            end
+          else
+            raise "DEBUG: unhandled call: #{exp.inspect}"
+          end
+        end
+
+        def process_and(exp)
+          parent = @container
+
+          begin
+            unless @container.kind_of?(DataMapper::Query::Conditions::AndOperation)
+              parent << @container = DataMapper::Query::Conditions::Operation.new(:and)
+            end
+
+            while sexp = exp.shift
+              process(sexp)
+            end
+          ensure
+            @container = parent
+          end
+
+          @container
+        end
+
+        def process_or(exp)
+          parent = @container
+
+          begin
+            unless @container.kind_of?(DataMapper::Query::Conditions::OrOperation)
+              parent << @container = DataMapper::Query::Conditions::Operation.new(:or)
+            end
+
+            while sexp = exp.shift
+              process(sexp)
+            end
+          ensure
+            @container = parent
+          end
+
+          @container
+        end
+
+        def process_not(exp)
+          parent = @container
+
+          begin
+            parent << @container = DataMapper::Query::Conditions::Operation.new(:not)
+            process(exp.shift)
+          ensure
+            @container = parent
+          end
+
+          @container
+        end
+
+        def process_lvar(exp)
+          var = exp.shift
+          var == @receiver ? @model : value(var)
+        end
+
+        def process_arglist(exp)
+          arglist = []
+          while sexp = exp.shift
+            arglist << process(sexp)
+          end
+          arglist
+        end
+
+        def process_colon2(exp)
+          const = process(exp.shift)
+
+          const.const_get(exp.shift)
+        end
+
+        def process_const(exp)
+          Object.const_get(exp.shift)
+        end
+
+        def process_match3(exp)
+          rhs = process(exp.shift)
+          lhs = process(exp.shift)
+
+          evaluate_operator(:=~, lhs, rhs)
+        end
+
+        def process_array(exp)
+          array = []
+          while sexp = exp.shift
+            array << process(sexp)
+          end
+          array
+        end
+
+        def process_hash(exp)
+          hash = {}
+          until exp.empty?
+            key   = process(exp.shift)
+            value = process(exp.shift)
+
+            hash[key] = value
+          end
+          hash
+        end
+
+        def process_str(exp)
+          exp.shift
+        end
+
+        def process_lit(exp)
+          literal = exp.shift
+          exp.shift  # FIXME: workaround for bug in ParseTree or SexpProcessor
+          literal
+        end
+
+        def process_true(exp)
+          true
+        end
+
+        def process_false(exp)
+          false
+        end
+
+        def process_nil(exp)
+          nil
+        end
+
+        def process_ivar(exp)
+          value(exp.shift)
+        end
+
+        def process_gvar(exp)
+          value(exp.shift)
+        end
+
+        def evaluate_operator(operator, lhs, rhs)
+          if operator == :=~ && !lhs.kind_of?(Regexp) && !rhs.kind_of?(Regexp)
+            raise "DEBUG: when using =~ operator one side should be a Regexp"
+          end
+
+          if lhs == @model
+            if rhs.nil?
+              @model.properties[operator]
+            elsif rhs.kind_of?(DataMapper::Resource) && operator == :==
+              resource = rhs
+
+              if resource.repository == DataMapper.repository &&
+                resource.saved? &&
+                !resource.dirty? &&
+                (key = resource.key).all?
+
+                @model.key.zip(key) do |property, bind_value|
+                  @container << DataMapper::Query::Conditions::Comparison.new(:eql, property, bind_value)
+                end
+
+                @container
+              end
+            else
+              raise "DEBUG: cannot call #{@model.name}.#{operator} with #{rhs.inspect}"
+            end
+
+          elsif rhs == @model
+            if @model.key.size > 1
+              raise 'Until OR conditions are added can only match resources with single keys'
+            end
+
+            resources = case lhs
+              when Array
+                case operator
+                  when :include?, :member? then lhs
+                end
+
+              when Hash
+                case operator
+                  when :key?, :has_key?, :include?, :member? then lhs.keys
+                  when :value?, :has_value?                  then lhs.values
+                end
+            end
+
+            unless resources
+              raise "DEBUG: cannot call #{lhs.class}##{operator} with #{rhs.inspect}"
+            end
+
+            unless resources.all? { |r| r.kind_of?(DataMapper::Resource) }
+              raise 'cannot compare against a non-resource'
+            end
+
+            property   = @model.key.first
+            bind_value = resources.map { |r| r.key.first }.sort
+
+            evaluate_operator(:include?, bind_value, property)
+
+          elsif lhs.kind_of?(DataMapper::Property)
+            property   = lhs
+            bind_value = rhs
+
+            # TODO: throw an exception if the operator is :== and the value is an Array
+            #   - this prevents conditions like { |u| u.val == [ 1, 2, 3 ] }
+
+            if operator == :nil? && bind_value.nil?
+              operator   = :==
+              bind_value = nil
+            end
+
+            operator = remap_operator(operator)
+
+            @container << DataMapper::Query::Conditions::Comparison.new(operator, property, bind_value)
+            @container
+
+          elsif rhs.kind_of?(DataMapper::Property)
+            property   = rhs
+            bind_value = lhs
+
+            # TODO: throw an exception if the operator is :== and the bind value is an Array
+            #   - this prevents conditions like { |u| [ 1, 2, 3 ] == u.val }
+
+            case bind_value
+              when Array
+                case operator
+                  when :include?, :member?
+                    operator = :in
+                  else
+                    raise "DEBUG: cannot call Array##{operator} with #{bind_value.inspect}"
+                end
+
+              when Range
+                case operator
+                  when :include?, :member?, :===
+                    operator = :in
+                  else
+                    raise "DEBUG: cannot call Range##{operator} with #{bind_value.inspect}"
+                end
+
+              when Hash
+                case operator
+                  when :key?, :has_key?, :include?, :member?
+                    operator   = :in
+                    bind_value = bind_value.keys
+                  when :value?, :has_value?
+                    operator   = :in
+                    bind_value = bind_value.values
+                  else
+                    raise "DEBUG: cannot call Hash##{operator} with #{bind_value.inspect}"
+                end
+            end
+
+            operator = remap_operator(operator)
+
+            @container << DataMapper::Query::Conditions::Comparison.new(operator, property, bind_value)
+            @container
+
+          elsif lhs.respond_to?(operator)
+            lhs.send(operator, *[ rhs ].compact)
+
+          else
+            raise "DEBUG: not handled: #{lhs.inspect} #{operator} #{rhs.inspect}"
+
+          end
+        end
+
+        # TODO: update dm-core internals to use the Ruby operators
+        # insted of the DM specific ones
+        def remap_operator(operator)
+          # remap Ruby to DM operators
+          case operator
+            when :in then :in
+            when :== then :eql
+            when :=~ then :regexp
+            when :>  then :gt
+            when :>= then :gte
+            when :<  then :lt
+            when :<= then :lte
+            else raise "DEBUG: unknown operator #{operator}"
+          end
+        end
+
+        def value(value)
+          eval(value.to_s, @binding)
+        end
+      end # class FilterProcessor
+    end # module Query
+  end # module Ambition
+end # module DataMapper