benhoskings-ambition 0.5.4

data/app_generators/ambition_adapter/templates/lib/adapter/slice.rb.erb

@@ -0,0 +1,19 @@
+module Ambition
+  module Adapters
+    module <%= adapter_module %>
+      class Slice < Base
+        # >> User.first(5)
+        # => #slice(0, 5)
+        #
+        # >> User.first
+        # => #slice(0, 1)
+        #
+        # >> User[10, 20]
+        # => #slice(10, 20)
+        def slice(start, length)
+          raise "Not implemented."
+        end
+      end
+    end
+  end
+end

data/app_generators/ambition_adapter/templates/lib/adapter/sort.rb.erb

@@ -0,0 +1,43 @@
+module Ambition
+  module Adapters
+    module <%= adapter_module %>
+      class Sort < Base
+        # >> sort_by { |u| u.age }
+        # => #sort_by(:age)
+        def sort_by(method)
+          raise "Not implemented."
+        end
+
+        # >> sort_by { |u| -u.age }
+        # => #reverse_sort_by(:age)
+        def reverse_sort_by(method)
+          raise "Not implemented."
+        end
+
+        # >> sort_by { |u| u.profile.name }
+        # => #chained_sort_by(:profile, :name)
+        def chained_sort_by(receiver, method)
+          raise "Not implemented."
+        end
+
+        # >> sort_by { |u| -u.profile.name }
+        # => #chained_reverse_sort_by(:profile, :name)
+        def chained_reverse_sort_by(receiver, method)
+          raise "Not implemented."
+        end
+
+        # >> sort_by(&:name)
+        # => #to_proc(:name)
+        def to_proc(symbol)
+          raise "Not implemented."
+        end
+
+        # >> sort_by { rand }
+        # => #rand
+        def rand
+          raise "Not implemented."
+        end
+      end
+    end
+  end
+end

data/app_generators/ambition_adapter/templates/lib/init.rb.erb

@@ -0,0 +1,22 @@
+require 'ambition'
+require '<%= adapter_name %>'
+require 'ambition/adapters/<%= adapter_name %>/base'
+require 'ambition/adapters/<%= adapter_name %>/query'
+require 'ambition/adapters/<%= adapter_name %>/select'
+require 'ambition/adapters/<%= adapter_name %>/sort'
+require 'ambition/adapters/<%= adapter_name %>/slice'
+
+##
+# This is where you inject Ambition into your target.
+#
+# Use `extend' if you are injecting a class, `include' if you are
+# injecting instances of that class.
+#
+# You must also set the `ambition_adapter' class variable on your target
+# class, regardless of whether you are injecting instances or the class itself.
+#
+# You probably want something like this:
+#
+#   <%= adapter_module %>::Base.extend Ambition::API
+#   <%= adapter_module %>::Base.ambition_adapter = Ambition::Adapters::<%= adapter_module %>
+#

data/app_generators/ambition_adapter/templates/test/helper.rb.erb

@@ -0,0 +1,9 @@
+%w( rubygems test/spec mocha English ).each { |f| require f }
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'ambition/adapters/<%= adapter_name %>'

data/app_generators/ambition_adapter/templates/test/select_test.rb.erb

@@ -0,0 +1,157 @@
+require File.dirname(__FILE__) + '/helper'
+
+context "<%= adapter_module %> Adapter :: Select" do
+  setup do
+    @klass = User
+  end
+
+  xspecify "==" do
+    translator = @klass.select { |m| m.name == 'jon' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "!=" do
+    translator = @klass.select { |m| m.name != 'jon' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== && ==" do
+    translator = @klass.select { |m| m.name == 'jon' && m.age == 21 }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== || ==" do
+    translator = @klass.select { |m| m.name == 'jon' || m.age == 21 }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "mixed && and ||" do
+    translator = @klass.select { |m| m.name == 'jon' || m.age == 21 && m.password == 'pass' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "grouped && and ||" do
+    translator = @klass.select { |m| (m.name == 'jon' || m.name == 'rick') && m.age == 21 }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify ">/<" do
+    translator = @klass.select { |m| m.age > 21 }
+    translator.to_s.should == %Q(foo)
+
+    translator = @klass.select { |m| m.age >= 21 }
+    translator.to_s.should == %Q(foo)
+
+    translator = @klass.select { |m| m.age < 21 }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "array.include? item" do
+    translator = @klass.select { |m| [1, 2, 3, 4].include? m.id }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "variabled array.include? item" do
+    array = [1, 2, 3, 4]
+    translator = @klass.select { |m| array.include? m.id }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== with variables" do
+    me = 'chris'
+    translator = @klass.select { |m| m.name == me }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== with method arguments" do
+    def test_it(name)
+      translator = @klass.select { |m| m.name == name }
+      translator.to_s.should == %Q(foo)
+    end
+
+    test_it('chris')
+  end
+
+  xspecify "== with instance variables" do
+    @me = 'chris'
+    translator = @klass.select { |m| m.name == @me }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== with instance variable method call" do
+    require 'ostruct'
+    @person = OpenStruct.new(:name => 'chris')
+
+    translator = @klass.select { |m| m.name == @person.name }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== with global variables" do
+    $my_name = 'boston'
+    translator = @klass.select { |m| m.name == $my_name }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "== with method call" do
+    def band
+      'skinny puppy'
+    end
+
+    translator = @klass.select { |m| m.name == band }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "=~ with string" do
+    translator = @klass.select { |m| m.name =~ 'chris' }
+    translator.to_s.should == %Q(foo)
+
+    translator = @klass.select { |m| m.name =~ 'chri%' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "!~ with string" do
+    translator = @klass.select { |m| m.name !~ 'chris' }
+    translator.to_s.should == %Q(foo)
+
+    translator = @klass.select { |m| !(m.name =~ 'chris') }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "=~ with regexp" do
+    translator = @klass.select { |m| m.name =~ /chris/ }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "=~ with regexp flags" do
+    translator = @klass.select { |m| m.name =~ /chris/i }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "downcase" do
+    translator = @klass.select { |m| m.name.downcase =~ 'chris%' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "upcase" do
+    translator = @klass.select { |m| m.name.upcase =~ 'chris%' }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "undefined equality symbol" do
+    should.raise { @klass.select { |m| m.name =* /chris/ } }
+  end
+
+  xspecify "block variable / assigning variable conflict" do
+    m = @klass.select { |m| m.name == 'chris' }
+    m.should == %Q(foo)
+  end
+  
+  xspecify "== with inline ruby" do
+    translator = @klass.select { |m| m.created_at == Time.now.to_s }
+    translator.to_s.should == %Q(foo)
+  end
+
+  xspecify "inspect" do
+    @klass.select { |u| u.name }.inspect.should.match %r(call #to_s or #to_hash)
+  end
+end

data/app_generators/ambition_adapter/templates/test/slice_test.rb.erb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/helper'
+
+context "<%= adapter_module %> Adapter :: Slice" do
+  setup do
+    @klass = User
+    @block = @klass.select { |m| m.name == 'jon' }
+  end
+
+  xspecify "first" do
+    @klass.expects(:find).with(:limit => 1, :name => 'jon')
+    @block.first
+  end
+
+  xspecify "first with argument" do
+    @klass.expects(:find).with(:limit => 5, :name => 'jon')
+    @block.first(5).entries
+  end
+  
+  xspecify "[] with two elements" do
+    @klass.expects(:find).with(:limit => 20, :offset => 10, :name => 'jon')
+    @block[10, 20].entries
+
+    @klass.expects(:find).with(:limit => 20, :offset => 20, :name => 'jon')
+    @block[20, 20].entries
+  end
+  
+  xspecify "slice is an alias of []" do
+    @klass.expects(:find).with(:limit => 20, :offset => 10, :name => 'jon')
+    @block.slice(10, 20).entries
+  end
+  
+  xspecify "[] with range" do
+    @klass.expects(:find).with(:limit => 10, :offset => 10, :name => 'jon')
+    @block[11..20].entries
+  end
+end

data/app_generators/ambition_adapter/templates/test/sort_test.rb.erb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/helper'
+
+context "<%= adapter_module %> Adapter :: Sort" do
+  setup do
+    @klass = User
+    @block = @klass.select { |m| m.name == 'jon' }
+  end
+
+  xspecify "order" do
+    string = @block.sort_by { |m| m.name }.to_s
+    string.should == "foo"
+  end
+
+  xspecify "combined order" do
+    string = @block.sort_by { |m| [ m.name,  m.age ] }.to_s
+    string.should == "foo"
+  end
+
+  xspecify "combined order with single reverse" do
+    string = @block.sort_by { |m| [ m.name,  -m.age ] }.to_s
+    string.should == "foo"
+  end
+
+  xspecify "combined order with two reverses" do
+    string = @block.sort_by { |m| [ -m.name,  -m.age ] }.to_s
+    string.should == "foo"
+  end
+
+  xspecify "reverse order with -" do
+    string = @block.sort_by { |m| -m.age }.to_s
+    string.should == "foo"
+  end
+
+  xspecify "reverse order with #reverse" do
+    # TODO: not implemented
+    string = @block.sort_by { |m| m.age }.reverse.to_s
+    string.should == "foo"
+  end
+
+  xspecify "random order" do
+    string = @block.sort_by { rand }.to_s
+    string.should == "foo"
+  end
+  
+  xspecify "non-existent method to sort by" do
+    should.raise(NoMethodError) { @block.sort_by { foo }.to_s }
+  end
+
+  xspecify "Symbol#to_proc" do
+    string = @klass.sort_by(&:name).to_s
+    string.should == "foo"
+  end
+end

data/bin/ambition_adapter

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  version = File.read('./Rakefile').scan(/Version = '(.+)'/).first.first
+  puts "#{File.basename($0)} #{version}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources! :ambition_adapter
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'ambition_adapter')

data/lib/ambition.rb

@@ -0,0 +1,11 @@
+require 'ambition/enumerable'
+require 'ambition/api'
+require 'ambition/context'
+require 'ambition/core_ext'
+require 'ambition/sexp_translator'
+
+require 'ambition/processors/base'
+require 'ambition/processors/select'
+require 'ambition/processors/sort'
+require 'ambition/processors/slice'
+require 'ambition/processors/ruby'

data/lib/ambition/api.rb

@@ -0,0 +1,116 @@
+module Ambition #:nodoc:
+  # Module that you will extend from in your adapters in your toplevel file.
+  # 
+  # For example, for ambitious_sphinx in lib/ambition/adapters/ambitious_sphinx.rb, we have:
+  #   ActiveRecord::Base.extend Ambition::API
+  module API
+    include Enumerable
+
+    def chain(other_context)
+      other_context.clauses.inject(ambition_context) {|context,(k,v)|
+        context.clauses[k].concat(other_context.clauses[k]).uniq!
+        context
+      } unless other_context.nil?
+    end
+
+    ##
+    # Entry methods
+    def select(&block)
+      context = ambition_context 
+      context << Processors::Select.new(context, block)
+    end
+
+    def sort_by(&block)
+      context = ambition_context 
+      context << Processors::Sort.new(context, block)
+    end
+
+    # Entries that our context is able to find.
+    def entries
+      ambition_context.kick
+    end
+    alias_method :to_a, :entries
+
+    def size
+      context = ambition_context
+      context == self ? super : context.size
+    end
+
+    def slice(start, length = nil)
+      context = ambition_context 
+      context << Processors::Slice.new(context, start, length)
+    end
+    alias_method :[], :slice
+
+    ##
+    # Convenience methods
+    
+    # See Enumerable#detect
+    def detect(&block)
+      select(&block).first
+    end
+
+    # See Array#first
+    def first(count = 1)
+      sliced = slice(0, count)
+      count == 1 ? Array(sliced.kick).first : sliced
+    end
+
+    # See Array#each, applied to +entries+
+    def each(&block)
+      entries.each(&block)
+    end
+
+    # See Enumerable#any?
+    def any?(&block)
+      select(&block).size > 0
+    end
+
+    # See Enumerable#all?
+    def all?(&block)
+      size == select(&block).size
+    end
+
+    # See Array#empty?
+    def empty?
+      size.zero?
+    end
+
+    # Builds a new +Context+.
+    def ambition_context
+      Context.new(self)
+    end
+
+    # Gives you the current ambitious adapter.
+    def ambition_adapter
+      own_name = respond_to?(:name) ? name : self.class.name
+      parent = respond_to?(:superclass) ? superclass : self.class.superclass
+      @@ambition_adapter[own_name] || @@ambition_adapter[parent.name] || infer_ambition_adapter
+    end
+
+    # If we're in a class that doesn't have an adapter assigned, but descends from a class
+    # that does, use that adapter (storing it for next time, since ancestors.include? is
+    # expensive to run constantly).
+    def infer_ambition_adapter
+      famous_ancestor = @@ambition_adapter.keys.detect {|key|
+        ancestors.include?(Object.recursive_const_get(key))
+      }
+      self.ambition_adapter = @@ambition_adapter[famous_ancestor] unless famous_ancestor.nil?
+    end
+
+    # Assign the ambition adapter. Typically, you use this in the toplevel file of your adapter.
+    #
+    # For example, for ambitious_sphinx, in our lib/ambition/adapters/ambitious_sphinx.rb:
+    #
+    #   ActiveRecord::Base.ambition_adapter = Ambition::Adapters::AmbitiousSphinx
+    def ambition_adapter=(klass)
+      @@ambition_adapter ||= {}
+      # should this be doing the same check for respond_to?(:name) like above?
+      @@ambition_adapter[name] = klass
+    end
+
+    def ambition_owner
+      @owner || self
+    end
+  end
+end