ambition 0.3.1 → 0.5.0

data/app_generators/ambition_adapter/templates/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Your Name
+
+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/app_generators/ambition_adapter/templates/README

@@ -0,0 +1,6 @@
+<%= string = "An Ambitious #{adapter_module} Adapter" %>
+<%= '=' * string.size %>
+
+More information on Ambition:
+-> http://ambition.rubyforge.org
+-> http://groups.google.com/group/ambition-rb/

data/app_generators/ambition_adapter/templates/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+
+Version = '0.1.0'
+
+begin
+  require 'rubygems'
+  gem 'echoe', '>=2.7'
+  ENV['RUBY_FLAGS'] = ""
+  require 'echoe'
+
+  Echoe.new('ambitious-<%= adapter_name %>') do |p|
+    p.dependencies  << '<%= adapter_name %> >=1.0'
+    p.summary        = "An ambitious adapter for <%= adapter_module %>"
+    p.author         = 'Your Name'
+    p.email          = "your@email.com"
+
+    p.project        = 'ambition'
+    p.url            = "http://ambition.rubyforge.org/"
+    p.test_pattern   = 'test/*_test.rb'
+    p.version        = Version
+    p.dependencies  << 'ambition >=0.5.0'
+  end
+
+rescue LoadError 
+  puts "Not doing any of the Echoe gemmy stuff, because you don't have the specified gem versions"
+end
+
+desc 'Install as a gem'
+task :install_gem do
+  puts `rake manifest package && gem install pkg/ambitious-<%= adapter_name %>-#{Version}.gem`
+end

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

@@ -0,0 +1,12 @@
+module Ambition
+  module Adapters
+    module <%= adapter_module %>
+      class Base
+        ##
+        # Extract common functionality into this class.
+        # All your classes, by default, inherit from this
+        # one -- Query and the Translators.
+      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/lib/query.rb.erb

@@ -0,0 +1,52 @@
+=begin
+
+These methods are king:
+
+  - owner
+  - clauses
+  - stash
+
++owner+ is the class from which the request was generated.
+
+User.select { |u| u.name == 'Pork' }
+# => owner == User
+
++clauses+ is the hash of translated arrays, keyed by processors
+
+User.select { |u| u.name == 'Pork' }
+# => clauses ==  { :select => [ "users.name = 'Pork'" ] }
+
++stash+ is your personal private stash.  A hash you can use for
+keeping stuff around.
+
+User.select { |u| u.profile.name == 'Pork' }
+# => stash == { :include => [ :profile ] }
+
+The above is totally arbitrary.  It's basically a way for your
+translators to talk to each other and, more importantly, to the Query
+object.
+
+=end
+module Ambition
+  module Adapters
+    module <%= adapter_module %>
+      class Query < Base
+        def kick
+          raise "Example: owner.find(:all, to_hash)"
+        end
+
+        def size
+          raise "Example: owner.count(to_hash)"
+        end
+
+        def to_hash
+          raise "Not implemented"
+        end
+
+        def to_s
+          raise "Not implemented"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+##
+# The format of the documentation herein is:
+#
+# >> method with block
+# => methods on this class called by Ambition (with arguments)
+#
+module Ambition
+  module Adapters
+    module <%= adapter_module %>
+      class Select < Base
+        # >> select { |u| u.name == 'chris' } 
+        # => #call(:name)
+        def call(method)
+          raise "Not implemented."
+        end
+
+        # >> select { |u| u.name.downcase == 'chris' } 
+        # => #call(:name, :downcase)
+        def chained_call(*methods)
+          # An idiom here is to call the chained method and pass it
+          # the first method.
+          #
+          #   if respond_to? methods[1]
+          #     send(methods[1], methods[0])
+          #   end
+          #
+          # In the above example, this translates to calling:
+          #
+          #   #downcase(:name)
+          #
+          raise "Not implemented."
+        end
+
+        # &&
+        # >> select { |u| u.name == 'chris' && u.age == 22 }
+        # => #both( processed left side, processed right side )
+        def both(left, right)
+          raise "Not implemented."
+        end
+
+        # ||
+        # >> select { |u| u.name == 'chris' || u.age == 22 }
+        # => #either( processed left side, processed right side )
+        def either(left, right)
+          raise "Not implemented."
+        end
+
+        # >> select { |u| u.name == 'chris' }
+        # => #==( call(:name), 'chris' )
+        def ==(left, right)
+          raise "Not implemented."
+        end
+
+        # !=
+        # >> select { |u| u.name != 'chris' }
+        # => #not_equal( call(:name), 'chris' )
+        def not_equal(left, right)
+          raise "Not implemented."
+        end
+
+        # >> select { |u| u.name =~ 'chris' }
+        # => #=~( call(:name), 'chris' )
+        def =~(left, right)
+          raise "Not implemented."
+        end
+
+        # !~
+        # >> select { |u| u.name !~ 'chris' }
+        # => #not_regexp( call(:name), 'chris' )
+        def not_regexp(left, right)
+          raise "Not implemented."
+        end
+
+        ##
+        # Etc.
+        def <(left, right)
+          raise "Not implemented."
+        end
+
+        def >(left, right)
+          raise "Not implemented."
+        end
+
+        def >=(left, right)
+          raise "Not implemented."
+        end
+
+        def <=(left, right)
+          raise "Not implemented."
+        end
+
+        # >> select { |u| [1, 2, 3].include? u.id }
+        # => #include?( [1, 2, 3], call(:id) )
+        def include?(left, right)
+          raise "Not implemented."
+        end
+      end
+    end
+  end
+end

data/app_generators/ambition_adapter/templates/lib/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/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/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