kangaroo 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kangaroo (0.0.1.pre2)
+    kangaroo (0.0.2)
       activerecord (>= 3.0.0)
       activesupport (>= 3.0.0)
       hirb
@@ -10,57 +10,58 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
       builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
+      i18n (~> 0.5.0)
+    activerecord (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
       arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.5)
+    activesupport (3.0.6)
     arel (2.0.9)
     builder (2.1.2)
     columnize (0.3.2)
-    cucumber (0.10.0)
+    cucumber (0.10.2)
       builder (>= 2.1.2)
-      diff-lcs (~> 1.1.2)
-      gherkin (~> 2.3.2)
-      json (~> 1.4.6)
-      term-ansicolor (~> 1.0.5)
+      diff-lcs (>= 1.1.2)
+      gherkin (>= 2.3.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
     diff-lcs (1.1.2)
-    gherkin (2.3.3)
-      json (~> 1.4.6)
-    hirb (0.3.6)
+    gherkin (2.3.5)
+      json (>= 1.4.6)
+    hirb (0.4.3)
     i18n (0.5.0)
-    json (1.4.6)
+    json (1.5.1)
     linecache (0.43)
     nokogiri (1.4.4)
     rapuncel (0.0.2)
       activesupport (>= 3.0.0)
       nokogiri
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.5.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
     term-ansicolor (1.0.5)
-    tzinfo (0.3.25)
-    yard (0.6.4)
+    tzinfo (0.3.26)
+    yard (0.6.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler
   cucumber
   kangaroo!
   rspec

data/README.md

@@ -4,12 +4,14 @@ Kangaroo
 Overview
 --------
 
-Kangaroo is an OpenObject client/wrapper for Rails 3, based on ActiveModel. It provides CRUD access to OpenERP objects via XMLRPC.
+Kangaroo is an OpenObject client/wrapper for Ruby, based on ActiveModel. It provides CRUD access to OpenERP objects via XMLRPC.
 It's fast and provides default data for new objects.
 
 Installation
 ------------
 
+### Rails 3
+
 If you're on Rails 3, just add Kangaroo to your Gemfile:
 
     gem 'kangaroo'
@@ -31,6 +33,29 @@ And create a **kangaroo.yml** configuration file in **[RAILS\_ROOT]/config**, co
 
 Adjust your connection and database settings and specify the models you need.
 
+### Ruby
+
+Use Kangaroo in any Ruby project!
+
+    gem install kangaroo
+    
+In your code
+
+    require 'rubygems'
+    require 'kangaroo'
+    
+    # Configure a connection to an OpenERP server
+    config = Kangaroo::Util::Configuration.new yaml_file_or_hash, Logger.new(STDOUT)
+    config.login
+  
+    # Load OpenERP models matching "res.*" into namespace ::Oo
+    # Kangaroo::Util::Loader can be called several times, whenever needed.
+    Kangaroo::Util::Loader.new('res.*', config.database, 'Oo').load!
+
+### Console
+
+See CLI below.
+
 Usage
 -----
 
@@ -100,7 +125,33 @@ console:
     +------+-----------------------------+
     5 rows in set
 
+
+Lazy model loading
+------------------
+
+You don't have to specify all models you ever need in your configuration file. Kangaroo will lazy load
+models as they are accessed:
+
+    ruby-1.8.7-p302 :001 > Oo.const_defined? "Product"
+     => false 
+    ruby-1.8.7-p302 :002 > Oo::Product
+     => Module 'Oo::Product' contains loaded OpenERP Models/Namespaces:  
+    ruby-1.8.7-p302 :003 > Oo::Product.const_defined? "Product"
+     => false 
+    ruby-1.8.7-p302 :004 > Oo::Product::Product
+     => <Oo::Product::Product id, loc_case, volume, type, uos_coeff, incoming_qty, price_margin, sale_ok, loc_rack, description_purchase, code, ean13, warranty, description_sale, outgoing_qty, product_tmpl_id, standard_price, rental, uom_po_id, default_code, supply_method, categ_id, procure_method, virtual_available, variants, packaging, pricelist_id, name_template, uos_id, lst_price, cost_method, description, seller_delay, price_extra, seller_id, price, active, company_id, qty_available, list_price, produce_delay, partner_ref, state, name, purchase_ok, mes_type, sale_delay, weight_net, seller_qty, weight, seller_ids, loc_row, product_manager, uom_id> 
     
-etc.
 Please refer to {file:docs/Usage.md Usage} to learn about limitations/features not yet
-implemented.
+implemented.
+
+Development
+-----------
+
+SCM:
+[https://github.com/cice/kangARoo](https://github.com/cice/kangARoo)
+
+Issues:
+[https://kayoom.lighthouseapp.com/projects/73738-kangaroo/tickets](https://kayoom.lighthouseapp.com/projects/73738-kangaroo/tickets)
+
+Rubygems:
+[https://rubygems.org/gems/kangaroo](https://rubygems.org/gems/kangaroo)

data/kangaroo.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'ruby-debug'
   s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'bundler'
 end

data/lib/kangaroo/ruby_adapter/class_definition.rb

@@ -28,7 +28,9 @@ module Kangaroo
         @namespace = @root_namespace
 
         constant_names[1..-2].each do |mod|
-          @namespace = set_const_in @namespace, mod, Module.new
+          const = Module.new
+          const.send :extend, Util::Loader::Namespace
+          @namespace = set_const_in @namespace, mod, const
         end
       end
 

data/lib/kangaroo/util/loader.rb

@@ -6,6 +6,7 @@ module Kangaroo
     class Loader
       autoload :Model, 'kangaroo/util/loader/model'
       autoload :Namespace, 'kangaroo/util/loader/namespace'
+      autoload :RootNamespace, 'kangaroo/util/loader/root_namespace'
       attr_accessor :model_names, :models, :database, :namespace
 
       # Initialize a Loader instance
@@ -35,6 +36,7 @@ module Kangaroo
       rescue NameError
         eval <<-RUBY
           module #{namespace}
+            extend Kangaroo::Util::Loader::RootNamespace
             extend Kangaroo::Util::Loader::Namespace
           end
         RUBY

data/lib/kangaroo/util/loader/namespace.rb

@@ -2,12 +2,33 @@ module Kangaroo
   module Util
     class Loader
       module Namespace
-        def oo_to_ruby oo_name
-          name + "::" + oo_name.gsub('.','/').camelize
+        def inspect
+          "Module '#{name}' contains loaded OpenERP Models/Namespaces: #{constants.join(', ')}"
         end
-
-        def ruby_to_oo ruby_name
-           ruby_name.sub(name + "::",'').underscore.gsub '/', '.'
+      
+        def namespace_name
+          name.match(/^([^\:]+)/)[1]
+        end
+      
+        def namespace
+          namespace_name.constantize
+        end
+      
+        def const_missing const_name
+          namespaced_const_name = "#{name}::#{const_name}"
+        
+          if namespace.model_exists?(namespaced_const_name)
+            namespace.load_model(namespaced_const_name)
+          elsif namespace.models_in?(namespaced_const_name)
+            Module.new.tap do |mod|
+              mod.send :extend, Namespace
+              const_set const_name, mod
+            end
+          else
+            super
+          end
+        rescue
+          super
         end
       end
     end

data/lib/kangaroo/util/loader/root_namespace.rb

@@ -0,0 +1,35 @@
+module Kangaroo
+  module Util
+    class Loader
+      module RootNamespace
+        def oo_to_ruby oo_name
+          name + "::" + oo_name.gsub('.','/').camelize
+        end
+
+        def ruby_to_oo ruby_name
+           ruby_name.sub(name + "::",'').underscore.gsub '/', '.'
+        end
+        
+        def reflection_model
+          const_get('Ir').const_get('Model')
+        end
+        
+        def model_exists? name
+          name = ruby_to_oo name
+          reflection_model.where(:model => name).exists?
+        end
+        
+        def models_in? name
+          name = ruby_to_oo name
+          
+          reflection_model.where("model like #{name}.%").exists?
+        end
+        
+        def load_model model_name
+          model_name = ruby_to_oo model_name
+          Loader.new([model_name], reflection_model.database, name).load!.first
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/version.rb

@@ -1,3 +1,3 @@
 module Kangaroo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/functional/lazy_loading_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+
+module Kangaroo
+  describe 'Lazy Loading' do
+    before :all do
+      config = Kangaroo::Util::Configuration.new 'spec/test_env/test.yml'
+      config.login
+  
+      Kangaroo::Util::Loader.new('res.partner', config.database).load!
+    end
+    
+    it 'should raise error if trying to access constant without corresponding OpenERP Model' do
+      lambda {
+        Oo::Abcd
+      }.should raise_error
+      
+      lambda {
+        Oo::Res::Bcde
+      }.should raise_error
+    end
+    
+    it 'should lazy load additional models in an OpenERP namespace' do
+      lambda {
+        Oo::Res::Country
+      }.should_not raise_error
+    end
+    
+    it 'should create namespace modules on demand' do
+      lambda {
+        Oo::Product
+      }.should_not raise_error
+    end
+    
+    it 'should lazy load missing models in other namespaces' do
+      lambda {
+        Oo::Product::Product
+      }.should_not raise_error
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kangaroo
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Michael Eickenberg
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 +02:00
+date: 2011-04-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,6 +137,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
 description: ActiveRecord-ish OpenObject Wrapper
 email: marian@cice-online.net
 executables: 
@@ -191,6 +205,7 @@ files:
 - lib/kangaroo/util/loader.rb
 - lib/kangaroo/util/loader/model.rb
 - lib/kangaroo/util/loader/namespace.rb
+- lib/kangaroo/util/loader/root_namespace.rb
 - lib/kangaroo/util/proxy.rb
 - lib/kangaroo/util/proxy/common.rb
 - lib/kangaroo/util/proxy/db.rb
@@ -200,6 +215,7 @@ files:
 - lib/kangaroo/util/proxy/wizard.rb
 - lib/kangaroo/util/proxy/workflow.rb
 - lib/kangaroo/version.rb
+- spec/functional/lazy_loading_spec.rb
 - spec/model/attributes_spec.rb
 - spec/model/base_spec.rb
 - spec/model/default_attributes_spec.rb
@@ -256,6 +272,7 @@ test_files:
 - features/step_definitions/configuration_steps.rb
 - features/support/test.yml
 - features/utility_services.feature
+- spec/functional/lazy_loading_spec.rb
 - spec/model/attributes_spec.rb
 - spec/model/base_spec.rb
 - spec/model/default_attributes_spec.rb