kangaroo 0.0.3 → 0.1.0.alpha1

data/lib/kangaroo/model/readonly_attributes.rb

@@ -0,0 +1,43 @@
+module Kangaroo
+  module Model
+    module ReadonlyAttributes
+      
+      def define_setter attribute_name
+        field = fields_hash[attribute_name.to_sym] rescue nil
+        
+        super and return unless field
+        return if field.always_readonly?
+        
+        unless field.eventually_readonly?
+          super
+        else
+          define_method "#{attribute_name}=" do |value|
+            if state.blank? && field.readonly?
+              raise Kangaroo::ReadonlyRecord
+            elsif field.readonly_in? state
+              raise Kangaroo::ReadonlyRecord
+            else
+              write_attribute attribute_name, value
+            end
+          end
+        end
+      end
+      
+      
+      protected
+      def attributes_for_update
+        without_readonly_attributes super
+      end
+
+      def attributes_for_create
+        without_readonly_attributes super
+      end
+      
+      def without_readonly_attributes attributes
+        attributes.reject do |key, val|
+          state && fields_hash[key.to_sym].readonly_in?(state)
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/model/relation.rb

@@ -1,6 +1,10 @@
+require 'kangaroo/model/dynamic_finder'
+
 module Kangaroo
   module Model
     class Relation
+      include DynamicFinder
+      
       # @private
       ARRAY_DELEGATES = %w( all? any? as_json at b64encode blank? choice class clone collect collect! combination compact compact! concat
                             cycle decode64 delete delete_at delete_if detect drop drop_while dup duplicable? each each_cons each_index
@@ -17,7 +21,14 @@ module Kangaroo
                             type uniq uniq! uniq_by uniq_by! unshift values_at yaml_initialize zip |).freeze
 
       # @private
-      attr_accessor :target, :where_clauses, :offset_clause, :limit_clause, :select_clause, :order_clause, :context_clause
+      attr_accessor :target,
+                    :where_clauses,
+                    :offset_clause,
+                    :limit_clause,
+                    :select_clause,
+                    :order_clause,
+                    :context_clause,
+                    :reverse_flag
 
       alias_method :_clone, :clone
       alias_method :_tap, :tap
@@ -46,7 +57,8 @@ module Kangaroo
 
       # Return only the last record
       def last
-        reverse.first
+        count = self.count
+        offset(count - 1).limit(1).first
       end
 
       # Check if a record with fulfilling this conditions exist
@@ -62,6 +74,18 @@ module Kangaroo
         records.all :
         records.first
       end
+      
+      def find_in_batches batch_size = 100
+        objects_count = count
+        batches_count = objects_count / batch_size + 1
+        
+        objects = []
+        batches_count.times do |batch_no|
+          objects += limit(batch_size).offset(batch_no * batch_size).all
+        end
+        
+        objects
+      end
 
       # Count how many records fulfill this conditions
       def count
@@ -73,9 +97,12 @@ module Kangaroo
       # Reverse all order clauses
       def reverse
         if @order_clause.blank?
-          order('id', true)
+          _clone._tap do |c|
+            c.reverse_flag = !c.reverse_flag
+          end
         else
           _clone._tap do |c|
+            c.reverse_flag = false
             c.order_clause = c.order_clause.map do |order|
               reverse_order order
             end
@@ -139,8 +166,11 @@ module Kangaroo
       # @param [String, Symbol] column field to order by
       # @param [boolean] desc true to order descending
       def order column, desc = false
-        column = column.to_s + " desc" if desc
+        column = column.to_s
+        column = column + " desc" if desc
+        
         _clone._tap do |c|
+          c.reverse_flag = true if column.downcase == 'id desc'
           c.order_clause += [column.to_s]
         end
       end
@@ -186,17 +216,18 @@ module Kangaroo
       protected
       def search_parameters
         {
-          :offset => @offset_clause,
-          :limit => @limit_clause,
-          :order => @order_clause.join(", "),
+          :offset  => @offset_clause,
+          :limit   => @limit_clause,
+          :order   => @order_clause.join(", "),
           :context => @context_clause
         }
       end
 
       def read_parameters
         {
-          :fields => @select_clause,
-          :context => @context_clause
+          :fields       => @select_clause,
+          :context      => @context_clause,
+          :reverse_flag => @reverse_flag
         }
       end
 

data/lib/kangaroo/model/remote_execute.rb

@@ -2,7 +2,7 @@ module Kangaroo
   module Model
     module RemoteExecute
       def call name, *args
-        return_value = remote.send name, ids_for_execute, *args
+        return_value = remote.call! name, ids_for_execute, *args
         
         # TODO: handle warnings etc
         if Hash === return_value && return_value[:value]

data/lib/kangaroo/model/required_attributes.rb

@@ -0,0 +1,26 @@
+module Kangaroo
+  module Model
+    module RequiredAttributes
+      extend ActiveSupport::Concern
+      include ActiveModel::Validations
+      
+      def save options = {}
+        if options[:validate] != false
+          valid? && super
+        else
+          super
+        end
+      end
+      
+      module ClassMethods
+        def define_setter attribute_name
+          if fields_hash[attribute_name.to_sym].try :required?
+            validates_presence_of attribute_name
+          end
+        
+          super
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/railtie.rb

@@ -1,13 +1,23 @@
 module Kangaroo
   class Railtie < Rails::Railtie
-    initializer 'kangaroo.initialize' do
+    attr_accessor :configuration
+
+    # Get the client instance configured via config/kangaroo.yml
+    #
+    # @return [Kangaroo::Util::Client] client
+    def client
+      @configuration.try :client
+    end
+
+    config.to_prepare do
       begin
         config_file = File.join(Rails.root, %w(config kangaroo.yml))
-        configuration = Kangaroo::Util::Configuration.new config_file, Rails.logger
-        configuration.load_models
+        @configuration = Kangaroo::Util::Configuration.new config_file, Rails.logger
+        @configuration.load_models
       rescue Errno::ECONNREFUSED => e
         Rails.logger.error "Could not connect to OpenERP XML-RPC Service."
       end
     end
+
   end
 end

data/lib/kangaroo/ruby_adapter/base.rb

@@ -20,7 +20,8 @@ module Kangaroo
       def to_ruby
         define_class
         add_fields
-
+        add_associations
+        
         @ruby_model
       end
     end

data/lib/kangaroo/ruby_adapter/class_definition.rb

@@ -15,12 +15,14 @@ module Kangaroo
 
       def define_model_class
         @ruby_model = set_const_in @namespace, constant_names.last, model_subclass
-
+        
         if !@ruby_model.is_a?(Class)
           raise ChildDefinedBeforeParentError
         end
         @ruby_model.database = @oo_model.class.database
-
+        @ruby_model.namespace = @oo_model.class.namespace
+        @ruby_model.oo_name = @oo_model.model
+        @ruby_model.oo_model = @oo_model
         @ruby_model
       end
 
@@ -40,9 +42,22 @@ module Kangaroo
 
       # Set constant only if not already defined
       def set_const_in mod, name, const
-        mod.const_set name, const unless mod.const_defined?(name)
+        mod.const_set name, const unless const_already_defined?(mod, name)
         mod.const_get name
       end
+      
+      def const_already_defined? mod, name
+        if is_18?
+          mod.const_defined? name
+        else
+          mod.const_defined? name, false
+        end
+      end
+      
+      protected
+      def is_18?
+        RUBY_VERSION =~ /^1\.8/
+      end
     end
   end
 end

data/lib/kangaroo/ruby_adapter/fields.rb

@@ -1,13 +1,38 @@
+require 'kangaroo/ruby_adapter/many2one'
+require 'kangaroo/ruby_adapter/one2many'
+
 module Kangaroo
   module RubyAdapter
     module Fields
+      include Many2one
+      include One2many
+      
       def add_fields
         @ruby_model.define_multiple_accessors *field_names
       end
       
-      protected
+      def add_associations
+        @ruby_model.association_fields.each do |association_field|
+          add_association association_field
+        end
+      end
+      
+      def add_association association_field
+        case association_field.type
+        when 'many2one'
+          add_many2one_association association_field
+        when 'one2many'
+          add_one2many_association association_field
+        end
+      end
+      
+      protected      
+      def define_method_in_model name, &block
+        @ruby_model.send :define_method, name, &block
+      end
+      
       def field_names
-        fields.map &:name
+        fields.map(&:name) - [:id]
       end
       
       def fields

data/lib/kangaroo/ruby_adapter/many2one.rb

@@ -0,0 +1,38 @@
+module Kangaroo
+  module RubyAdapter
+    module Many2one
+      protected
+      def add_many2one_association association_field
+        define_many2one_id_accessor association_field
+        define_many2one_name_accessor association_field
+        define_many2one_obj_accessor association_field
+      end
+      
+      def define_many2one_name_accessor association_field
+        define_method_in_model "#{association_field.name}_name" do
+          read_many2one_name_for association_field
+        end
+      end
+      
+      def define_many2one_id_accessor association_field
+        define_method_in_model "#{association_field.name}_id" do
+          read_many2one_id_for association_field
+        end
+        
+        define_method_in_model "#{association_field.name}_id=" do |id|
+          write_many2one_id_for association_field, id
+        end
+      end
+      
+      def define_many2one_obj_accessor association_field
+        define_method_in_model "#{association_field.name}_obj" do
+          read_many2one_obj_for association_field
+        end
+        
+        define_method_in_model "#{association_field.name}_obj=" do |obj|
+          write_many2one_obj_for association_field, obj
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/ruby_adapter/one2many.rb

@@ -0,0 +1,31 @@
+module Kangaroo
+  module RubyAdapter
+    module One2many
+      protected
+      def add_one2many_association association_field
+        define_one2many_id_accessor association_field
+        define_one2many_obj_accessor association_field
+      end
+      
+      def define_one2many_id_accessor association_field
+        define_method_in_model "#{association_field.name}_ids" do
+          read_one2many_ids_for association_field
+        end
+        
+        define_method_in_model "#{association_field.name}_ids=" do |ids|
+          write_one2many_ids_for association_field, ids
+        end
+      end
+
+      def define_one2many_obj_accessor association_field
+        define_method_in_model "#{association_field.name}_objs" do
+          read_one2many_objs_for association_field
+        end
+        
+        define_method_in_model "#{association_field.name}_objs=" do |objs|
+          write_one2many_objs_for association_field, objs
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/util/client.rb

@@ -4,6 +4,31 @@ require 'kangaroo/util/proxy'
 
 module Kangaroo
   module Util
+    # This is the central point to interact with OpenERP. You can configure your
+    # connection via Kangaroo::Util::Configuration.
+    #
+    # @see Kangaroo::Util::Configuration
+    # @see Kangaroo::Util::Database
+    # @example Configure Kangaroo and get the client instance
+    #     config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+    #     client = config.client
+    #
+    # @example Use non-database dependent services
+    #     client.common
+    #     client.db
+    #     client.superadmin 'superadminpassword'
+    #
+    # @example Use database dependent services
+    #     client.database.object 'product.product'
+    #     client.database.wizard
+    #     client.database.report
+    #     client.database.workflow
+    #
+    # @example For convenience, the non-database dependent services are also available via database
+    #     client.database.common
+    #     client.database.db
+    #     client.database.superadmin 'superadminpassword'
+    #
     class Client < Rapuncel::Client
       SERVICES = %w(db common object wizard report).freeze
 
@@ -33,7 +58,7 @@ module Kangaroo
         RUBY
       end
 
-      # Access the {Kangaroo::Util::Proxy::Superadmin Superadmin Proxy}
+      # Access the Kangaroo::Util::Proxy::Superadmin
       #
       # @param [String] super_password Superadmin password
       # @return [Kangaroo::Util::Proxy::Superadmin] Superadmin proxy
@@ -41,14 +66,14 @@ module Kangaroo
         Proxy::Superadmin.new db_service, super_password
       end
 
-      # Access the {Kangaroo::Util::Proxy::Common Common Proxy}
+      # Access the Kangaroo::Util::Proxy::Common
       #
       # @return [Kangaroo::Util::Proxy::Common] Common proxy
       def common
         @common_proxy ||= Proxy::Common.new common_service
       end
 
-      # Access the {Kangaroo::Util::Proxy::Db Db Proxy}
+      # Access the Kangaroo::Util::Proxy::Db
       #
       # @return [Kangaroo::Util::Proxy::Db] Db proxy
       def db
@@ -56,7 +81,7 @@ module Kangaroo
       end
       
       def inspect
-        "#Kangaroo::Util::Client:0x#{hash.to_s(16)}>"
+        "<#Kangaroo::Util::Client:0x#{hash.to_s(16)}>"
       end
     end
   end