kangaroo 0.0.3 → 0.1.0.alpha1

data/.gitignore

@@ -1,2 +1,7 @@
 .yardoc
-*.gem
+*.gem
+.rvmrc
+.bundle
+Gemfile.lock
+doc/
+coverage/

data/Gemfile

@@ -1,2 +1,13 @@
 source :rubygems
 gemspec
+
+group :test do
+  gem 'autotest-growl'
+  gem 'autotest-fsevent'
+  gem 'simplecov', '>= 0.4.0', :require => false
+end
+
+group :development do
+  # gem 'ruby-debug19', :require => 'ruby-debug'
+  gem 'ruby-debug'
+end

data/README.md

@@ -5,153 +5,44 @@ Overview
 --------
 
 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.
+It's fast and provides a lot of neat features.
 
-Installation
-------------
+Documentation and Feedback
+--------------------------
 
-### Rails 3
+Please give us some feedback especially on the documentation, which surely requires a lot of work.
 
-If you're on Rails 3, just add Kangaroo to your Gemfile:
-
-    gem 'kangaroo'
-
-And create a **kangaroo.yml** configuration file in **[RAILS\_ROOT]/config**, containing these options:
-
-    host: 127.0.0.1
-    port: 8069
-
-    database:
-      name: my_openerp
-      user: admin
-      password: admin
-
-      models:
-        - account.*
-        - product.*
-        - res.company
-
-Adjust your connection and database settings and specify the models you need.
-
-### Ruby
-
-Use Kangaroo in any Ruby project!
+Quick Start
+-----------
 
     gem install kangaroo
     
-In your code
+    kang -u admin -p admin -d some_database
+    > Oo::Res::Country.limit(5).order(:name).all
+    # +------+-----------------------------+
+    # | code | name                        |
+    # +------+-----------------------------+
+    # | DZ   | Algeria                     |
+    # | AS   | American Samoa              |
+    # | AD   | Andorra, Principality of    |
+    # | AO   | Angola                      |
+    # | AI   | Anguilla                    |
+    # +------+-----------------------------+
 
-    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
------
-
-OpenObject models are mapped to ruby classes:
-
-    Oo::Res::Country
-    # represents 'res.country'
-    
-    Oo::Product::Product
-    # represents 'product.product'
-    
-    Oo::Sale::Order::Line
-    # represents 'sale.order.line
     
-You can use this models like ActiveRecord models:
-
-    country = Oo::Res::Country.find 1
-    country = Oo::Res::Country.where(:code => 'DE').first
-    
-    country.name = "Schland"
-    country.save
-    
-    country.reload
-    
-    countries = Oo::Res::Country.limit(100).all
-    countries = Oo::Res::Country.limit(100).order('code').all
-    
-    Oo::Res::Country.create :code => 'DE', :name => 'Germany'
-    
-CLI
----
-
-Kangaroo comes with a console based on IRB, try it:
-    
-    $kang -c spec/test_env/test.yml 
-    I, [2011-04-15T23:19:41.990623 #6834]  INFO -- : Loading Kangaroo configuration "spec/test_env/test.yml"
-    I, [2011-04-15T23:19:41.991091 #6834]  INFO -- : Configured OpenERP database "kangaroo_test_database" at "127.0.0.1"
-    I, [2011-04-15T23:19:41.996197 #6834]  INFO -- : Authenticated user "admin" for OpenERP database "kangaroo_test_database"
-    ruby-1.8.7-p302 :001 > Oo::Res::Country
-     => <Oo::Res::Country id, name, code> 
-    ruby-1.8.7-p302 :002 > Oo::Res::Country.first
-    +---------+------+
-    | name    | code |
-    +---------+------+
-    | Algeria | DZ   |
-    +---------+------+
-    1 row in set
-    
-If you omit the -c command line option, you can initialize your Kangaroo connection from the
-console:
-
-    $kang
-    ruby-1.8.7-p302 :001 > Kang.init "port"=>8069, "database"=>{"name"=>"kangaroo_test_database", "models"=>["res.*"], "password"=>"admin", "user"=>"admin"}, "host"=>"127.0.0.1"
-    I, [2011-04-15T23:23:59.789551 #7017]  INFO -- : Loading Kangaroo configuration {"port"=>8069, "database"=>{"name"=>"kangaroo_test_database", "models"=>["res.*"], "user"=>"admin", "password"=>"admin"}, "host"=>"127.0.0.1"}
-    I, [2011-04-15T23:23:59.789706 #7017]  INFO -- : Configured OpenERP database "kangaroo_test_database" at "127.0.0.1"
-    I, [2011-04-15T23:23:59.794861 #7017]  INFO -- : Authenticated user "admin" for OpenERP database "kangaroo_test_database"
-     => true 
-    ruby-1.8.7-p302 :002 > Oo::Res::Country.limit(5).all
-    +------+-----------------------------+
-    | code | name                        |
-    +------+-----------------------------+
-    | DZ   | Algeria                     |
-    | AS   | American Samoa              |
-    | AD   | Andorra, Principality ofä ß |
-    | AO   | Angola                      |
-    | AI   | Anguilla                    |
-    +------+-----------------------------+
-    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> 
-    
-Please refer to {file:docs/Usage.md Usage} to learn about limitations/features not yet
-implemented.
+[a lot more here](http://kangaroogem.org)
 
 Development
 -----------
 
+Homepage:
+[http://kangaroogem.org](http://kangaroogem.org)
+
 SCM:
-[https://github.com/cice/kangARoo](https://github.com/cice/kangARoo)
+[https://github.com/kayoom/kangaroo](https://github.com/kayoom/kangaroo)
 
 Issues:
-[https://kayoom.lighthouseapp.com/projects/73738-kangaroo/tickets](https://kayoom.lighthouseapp.com/projects/73738-kangaroo/tickets)
+[http://github.com/kayoom/kangaroo/issues](http://github.com/kayoom/kangaroo/issues)
 
 Rubygems:
 [https://rubygems.org/gems/kangaroo](https://rubygems.org/gems/kangaroo)

data/Rakefile

@@ -22,14 +22,6 @@ rescue LoadError
   puts "RSpec is not available. In order to run specs, you must: gem install rspec"
 end
 
-begin
-  require 'cucumber/rake/task'
-  desc "Run Cucumber features."
-  Cucumber::Rake::Task.new(:features)
-rescue LoadError
-  puts "Cucumber is not available. In order to run features, you must: gem install cucumber"
-end
-
 
 
 # If you want to make this the default task

data/bin/kang

@@ -1,80 +1,21 @@
 #!/usr/bin/env ruby
 
 begin
+  # Try to just load kangaroo
   require 'kangaroo'
 rescue LoadError
   begin
+    # Try kangaroo as installed gem
     require 'rubygems'
     require 'kangaroo'
   rescue LoadError
+    # Used for development, if you exec 'bin/kang' from kangaroo source dir and gem not installed
     require 'bundler/setup'
     require 'kangaroo'
   end
 end
 
-require 'ostruct'
-require 'optparse'
-options = {}
-
-optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: kang -c config_file.yaml"
-  
-  options[:config_file] = nil
-  opts.on '-c', '--config FILE', 'Specify config file' do |file|
-    options[:config_file] = file
-  end   
-  
-  # This displays the help screen, all programs are
-  # assumed to have this option.
-  opts.on( '-h', '--help', 'Display this screen' ) do
-    puts opts
-    exit
-  end
-end
-
-optparse.parse!
-
-Kang = OpenStruct.new
-Kang.logger = Logger.new(STDOUT)
-
-Kang.class_eval do
-  def inspect
-    "Kang console"
-  end
-  
-  def init file_or_hash    
-    Kang.logger.info "Loading Kangaroo configuration #{file_or_hash.inspect}"
-    Kang.config = Kangaroo::Util::Configuration.new file_or_hash, Kang.logger
-    Kang.config.login
-  
-    Kangaroo::Util::Loader.new('res.*', Kang.config.database).load!
-    true
-  end
-end
-
-options[:config_file] && Kang.init(options[:config_file])
-
-require 'irb'
-require 'irb/completion'
-
-Hirb.enable
-IRB.start
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+require 'kangaroo/commands/cli'
 
+Kangaroo::Commands::CLI.new(*ARGV).run
 

data/bin/kangdoc

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+begin
+  # Try to just load kangaroo
+  require 'kangaroo'
+rescue LoadError
+  begin
+    # Try kangaroo as installed gem
+    require 'rubygems'
+    require 'kangaroo'
+  rescue LoadError
+    # Used for development, if you exec 'bin/kang' from kangaroo source dir and gem not installed
+    require 'bundler/setup'
+    require 'kangaroo'
+  end
+end
+
+require 'kangaroo/commands/doc'
+
+Kangaroo::Commands::Doc.new(*ARGV).run
+

data/bin/kangviz

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+begin
+  # Try to just load kangaroo
+  require 'kangaroo'
+rescue LoadError
+  begin
+    # Try kangaroo as installed gem
+    require 'rubygems'
+    require 'kangaroo'
+  rescue LoadError
+    # Used for development, if you exec 'bin/kang' from kangaroo source dir and gem not installed
+    require 'bundler/setup'
+    require 'kangaroo'
+  end
+end
+
+require 'kangaroo/commands/viz'
+
+Kangaroo::Commands::Viz.new(*ARGV).run
+

data/config/kangaroo.yml.sample

@@ -1,12 +1,22 @@
+# Hostname or ip address and XMLRPC port of your OpenERP Server
 host: 127.0.0.1
 port: 8069
 
+# Configure the database you want to use
 database:
-  name: my_openerp
+  # Database name and credentials
+  name: kangaroo_test_database
   user: admin
   password: admin
   
+  # Namespace (top-level Module) for your OpenObject classes, e.g. 
+  # OpenObjects 'product.product' will be accessible via Ruby class Abc::Product::Product
+  # __must__ begin with a capital letter!
+  namespace: 'Abc'
+  
+  # Specify models to load on startup, e.g. all models in the 'product' namespace, and the single 'res.company' model
+  # Keep in mind, that Kangaroo will lazy load any model not specified here on first access. You can even leave this
+  # blank to load all models as late as they're needed.
   models:
-    - account.*
     - product.*
     - res.company

data/docs/Architecture.md

@@ -7,6 +7,7 @@ Architecture
 {file:docs/Usage.md Usage}
 {file:docs/Architecture.md Architecture}
 {file:docs/AdditionalServices.md Additional Services}
+{file:docs/Classes.md Classes}
 
 
 Components

data/docs/Classes.md

@@ -0,0 +1,67 @@
+Classes
+=======
+
+#### Index
+{file:README.md Readme}
+{file:docs/Installation.md Installation}
+{file:docs/Usage.md Usage}
+{file:docs/Architecture.md Architecture}
+{file:docs/AdditionalServices.md Additional Services}
+{file:docs/Classes.md Classes}
+
+{Kangaroo}
+--------
+
+### Railtie
+* {Kangaroo::Railtie}
+
+### Model
+* {Kangaroo::Model}
+* * {Kangaroo::Model::Attributes}
+* * {Kangaroo::Model::Base}
+* * {Kangaroo::Model::ConditionNormalizer}
+* * {Kangaroo::Model::DefaultAttributes}
+* * {Kangaroo::Model::Field}
+* * {Kangaroo::Model::Finder}
+* * {Kangaroo::Model::Inspector}
+* * {Kangaroo::Model::OpenObjectOrm}
+* * {Kangaroo::Model::Persistence}
+* * {Kangaroo::Model::ReadonlyAttributes}
+* * {Kangaroo::Model::Relation}
+* * {Kangaroo::Model::RemoteExecute}
+
+### RubyAdapter
+* {Kangaroo::RubyAdapter}
+* * {Kangaroo::RubyAdapter::Base}
+* * {Kangaroo::RubyAdapter::ClassDefinition}
+* * {Kangaroo::RubyAdapter::Fields}
+
+### Util
+* {Kangaroo::Util}
+* * {Kangaroo::Util::Client}
+* * {Kangaroo::Util::Configuration}
+* * {Kangaroo::Util::Database}
+* * {Kangaroo::Util::Loader}
+* * * {Kangaroo::Util::Loader::Model}
+* * * {Kangaroo::Util::Loader::Namespace}
+* * * {Kangaroo::Util::Loader::RootNamespace}
+* * {Kangaroo::Util::Proxy}
+* * * {Kangaroo::Util::Proxy::Common}
+* * * {Kangaroo::Util::Proxy::Db}
+* * * {Kangaroo::Util::Proxy::Object}
+* * * {Kangaroo::Util::Proxy::Report}
+* * * {Kangaroo::Util::Proxy::Superadmin}
+* * * {Kangaroo::Util::Proxy::Wizard}
+* * * {Kangaroo::Util::Proxy::Workflow}
+
+### Hirb
+* {Hirb::Views::Kangaroo}
+
+### Exceptions
+* {Kangaroo::Exception}
+* * {Kangaroo::RecordNotFound}
+* * {Kangaroo::ReadonlyRecord}
+* * {Kangaroo::RecordSavingFailed}
+* * {Kangaroo::InstantiatedRecordNeedsIDError}
+* * {Kangaroo::ChildDefinedBeforeParentError}
+* * {Kangaroo::NoMethodError}