kangaroo 0.0.3 → 0.1.0.alpha1

data/docs/Installation.md

@@ -1,5 +1,5 @@
 Installation
-============
+=====
 
 #### Index
 {file:README.md Readme}
@@ -7,6 +7,7 @@ Installation
 {file:docs/Usage.md Usage}
 {file:docs/Architecture.md Architecture}
 {file:docs/AdditionalServices.md Additional Services}
+{file:docs/Classes.md Classes}
 
 Rails 3
 -------

data/docs/Usage.md

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

data/kangaroo.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Michael Eickenberg", "Marian Theisen"]
   s.email       = 'marian@cice-online.net'
   s.summary     = "Kang! ActiveRecord-ish OpenObject"
-  s.homepage    = "http://github.com/cice/kangARoo"
+  s.homepage    = "http://github.com/kayoom/kangaroo"
   s.description = "ActiveRecord-ish OpenObject Wrapper"
 
   s.files         = `git ls-files`.split("\n")
@@ -18,14 +18,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rapuncel', '~> 0.0.2'
-  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_dependency "rapuncel", "~> 0.0.5.RC1"
+  s.add_dependency "activemodel", ">= 3.0.0"
   s.add_dependency "activesupport", ">= 3.0.0"
   s.add_dependency "hirb"
+  s.add_dependency "highline"
+  s.add_dependency "ruby-graphviz", ">= 1.0.0"
   
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'ruby-debug'
-  s.add_development_dependency 'cucumber'
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
 end

data/lib/kangaroo.rb

@@ -1,7 +1,8 @@
-require 'kangaroo/railtie' if defined?(Rails)
 require 'kangaroo/util/configuration'
 require 'kangaroo/model/base'
 require 'kangaroo/hirb'
 
 module Kangaroo
-end
+end
+
+require 'kangaroo/railtie' if defined?(Rails)

data/lib/kangaroo/commands/base.rb

@@ -0,0 +1,123 @@
+require 'optparse'
+require 'highline/import'
+
+module Kangaroo
+  module Commands
+    class Base
+      attr_reader :configuration
+      
+      def initialize *args
+        @configuration = Kangaroo::Util::Configuration::Defaults.dup
+        
+        parse_options args
+      end
+      
+      def run
+        validate_configuration
+      end
+      
+      protected
+      def validate_configuration
+        unless database_configuration['name']
+          puts "Which database do you want to use?"
+          printf '> '
+          database_configuration['name'] = gets.strip
+        end
+        
+        unless database_configuration['user']
+          puts "What's your username at '#{database_configuration['user']}'?"
+          printf '> '
+          database_configuration['user'] = gets.strip
+        end
+        
+        unless database_configuration['password']
+          puts "Type your password"
+          database_configuration['password'] = ask('> ') {|q| q.echo = false}.strip
+        end
+      end
+      
+      def database_configuration
+        configuration['database'] ||= {}
+      end
+      
+      def logger
+        @logger ||= Logger.new STDOUT
+      end
+      
+      def parse_options args
+        option_parser.parse! args
+      end
+      
+      def banner
+        "Usage:"
+      end
+      
+      def option_parser
+        @option_parser ||= OptionParser.new do |p|
+          p.banner = banner
+          
+          setup_options p
+        end
+      end
+      
+      def set_config file
+        file_options = YAML.load_file file
+        @configuration = file_options
+      end
+      
+      def set_user user
+        database_configuration['user'] = user
+      end
+      
+      def set_password password
+        database_configuration['password'] = password
+      end
+      
+      def set_database name
+        database_configuration['name'] = name
+      end
+      
+      def set_namespace namespace
+        database_configuration['namespace'] = namespace
+      end
+      
+      def set_host host
+        configuration['host'] = host
+      end
+      
+      def set_port port
+        configuration['port'] = port
+      end
+      
+      def set_help *_
+        puts option_parser
+        exit
+      end
+      
+      def set_models models
+        models = "*" if models.strip == "all"
+        database_configuration['models'] = models.split(':')
+      end
+      
+      def setup_options p
+        setup_option p, '--help', "Display this help screen"
+        setup_option p, '--config FILE', 'Specify a configuration file'
+        setup_option p, '--user USER', 'Set user to use to login to OpenERP, must be a valid OpenERP user with sufficient privileges'
+        setup_option p, '--password PASSWORD', 'Set password for user'
+        setup_option p, '--host HOST', 'Set hostname (default: localhost)'
+        setup_option p, '--port PORT', 'Set port (default: 8069)', '-i'
+        setup_option p, '--database DATABASE', 'Set name of database to use'
+        setup_option p, '--namespace NAMESPACE', 'Set namespace / root module to use for models (default: Oo)'
+        setup_option p, '--models MODELS', 'Set models to load eagerly, separate with : (e.g. res.*:product.product:sale.* or "all" to load everything)'
+      end
+      
+      def setup_option p, param, desc = '', short = nil
+        param = param.to_s
+        short ||= param.match(/^-(-\w)\w*/)[1]
+        meth_name = param.match(/^--(\w+)/)[1]
+        
+        p.on short, param, desc, &method("set_#{meth_name}".to_sym)
+      end
+    end
+  end
+end

data/lib/kangaroo/commands/cli.rb

@@ -0,0 +1,65 @@
+require 'kangaroo/commands/base'
+require 'irb'
+require 'irb/completion'
+require 'hirb'
+require 'kangaroo/commands/endpoint'
+
+module IRB
+  mattr_accessor :prompt
+  
+  class << self
+    alias init_config_old init_config
+  end
+  
+  def IRB.init_config(ap_path)
+    init_config_old ap_path
+    @@prompt ||= "kang"
+    
+    @CONF[:PROMPT] = {
+      :CUSTOM => {
+        :PROMPT_I => "#{@@prompt} > ",
+        :PROMPT_S => "#{@@prompt} %l> ",
+        :PROMPT_C => "#{@@prompt} .. ",
+        :PROMPT_N => "#{@@prompt} .. ",
+        :RETURN => "=> %s\n"
+      }
+    }
+    @CONF[:PROMPT_MODE] = :CUSTOM
+    @CONF[:AUTO_INDENT] = true
+  end
+end
+
+module Kangaroo
+  module Commands
+    class CLI < Base
+      def run
+        super
+        
+        initialize_global_endpoint
+        start_irb
+      end
+      
+      protected
+      def initialize_global_endpoint
+        ::Kang.connect configuration, logger
+        ::Kang.load_models!
+      end
+      
+      def start_irb
+        ARGV.clear
+        
+        IRB.prompt = ::Kang.configuration['database'].values_at('user', 'name').join("@")
+        ::Hirb.enable
+        ::IRB.start
+      end
+      
+      def banner
+        "".tap do |s|
+          s << 'kang - The Kangaroo command line interface'
+          s << "\n\n"
+          s << 'Usage:'
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/commands/doc.rb

@@ -0,0 +1,44 @@
+require 'kangaroo/commands/base'
+require 'kangaroo/commands/endpoint'
+require 'kangaroo/doc'
+
+module Kangaroo
+  module Commands
+    class Doc < Base
+      def run
+        super
+        
+        initialize_global_endpoint
+        generate_yardoc
+      end
+      
+      protected
+      def set_load_associations
+        @load_associations = true
+      end
+      
+      def setup_options p
+        super
+        setup_option p, '--load_associations', 'Wether to load associated models too.'
+      end
+      
+      def initialize_global_endpoint
+        ::Kang.connect configuration, logger
+        ::Kang.load_models!
+        ::Kang.load_associated_models! if @load_associations
+      end
+      
+      def generate_yardoc
+        Kangaroo::Doc::Base.generate ::Kang.namespace
+      end
+      
+      def banner
+        "".tap do |s|
+          s << 'kangdoc - Generate yardoc for OpenERP models.'
+          s << ''
+          s << 'Usage:'
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/commands/endpoint.rb

@@ -0,0 +1,33 @@
+module Kangaroo
+  module Commands
+    class Endpoint
+      attr_reader :configuration, :config, :client, :logger, :models
+      
+      delegate :common, :db, :superadmin, :to => :client
+      delegate :database, :to => :config
+      
+      def connect configuration = {}, logger = Logger.new(STDOUT)
+        @logger = logger
+        @configuration = configuration
+        @config = Kangaroo::Util::Configuration.new configuration, logger
+        @client = config.client
+      end
+      
+      def load_models!
+        @models = config.load_models
+      end
+      
+      def load_associated_models!
+        @models.each do |m|
+          m.fields.each &:relation_class
+        end
+      end
+      
+      def namespace
+        Kernel.const_get config.namespace
+      end
+    end
+  end
+end
+
+::Kang = Kangaroo::Commands::Endpoint.new

data/lib/kangaroo/commands/viz.rb

@@ -0,0 +1,58 @@
+require 'kangaroo/commands/base'
+require 'kangaroo/commands/endpoint'
+require 'kangaroo/viz'
+
+module Kangaroo
+  module Commands
+    class Viz < Base
+      def run
+        super
+        
+        initialize_global_endpoint
+        init_viz.generate
+      end
+      
+      protected
+      def set_load_associations *args
+        @load_associations = true
+      end
+      
+      def set_file file
+        @file = file
+      end
+      
+      def set_type type
+        @type = type
+      end
+      
+      def setup_options p
+        super
+        setup_option p, '--load_associations', 'Wether to load associated models too.'
+        setup_option p, "--type FILE", "Specify output type (e.g. png, pdf, svg, etc. see ruby-graphviz)"
+        setup_option p, "--file TYPE", "Specify output file (e.g. kangaroo_models.png)"
+      end
+      
+      def initialize_global_endpoint
+        ::Kang.connect configuration, logger
+        ::Kang.load_models!
+        ::Kang.load_associated_models! if @load_associations
+      end
+      
+      def init_viz
+        Kangaroo::Viz::Base.new(::Kang.namespace).tap do |viz|
+          viz.namespace.dont_load_models = !@load_associations
+          viz.file = @file || "kangaroo_viz.png"
+          viz.type = @type || "png"
+        end
+      end
+      
+      def banner
+        "".tap do |s|
+          s << 'kangviz - Generate graphviz for OpenERP models.'
+          s << ''
+          s << 'Usage:'
+        end
+      end
+    end
+  end
+end

data/lib/kangaroo/doc.rb

@@ -0,0 +1,2 @@
+require 'kangaroo/doc/root_namespace'
+require 'kangaroo/doc/klass'

data/lib/kangaroo/exception.rb

@@ -1,7 +1,10 @@
 module Kangaroo
   class Exception < ::Exception ; end
   class RecordNotFound < Exception ; end
+  class ReadonlyRecord < Exception ; end
   class RecordSavingFailed < Exception ; end
   class InstantiatedRecordNeedsIDError < Exception ; end
   class ChildDefinedBeforeParentError < Exception ; end
+  
+  class NoMethodError < ::NoMethodError ; end
 end

data/lib/kangaroo/hirb.rb

@@ -15,7 +15,8 @@ module Hirb::Views::Kangaroo
       sorted_columns += (selected_columns - sorted_columns)
       fields = sorted_columns.map {|e| e.to_sym}
     end
-    fields
+    
+    [:id] + fields
   end
 end
 

data/lib/kangaroo/model/associations.rb

@@ -0,0 +1,33 @@
+module Kangaroo
+  module Model
+    module Associations
+      extend ActiveSupport::Concern
+      
+      autoload :Many2one, 'kangaroo/model/associations/many2one'
+      autoload :One2many, 'kangaroo/model/associations/one2many'
+      
+      Types = %w(many2one one2many).freeze
+      
+      included do
+        include Many2one
+        include One2many
+      end
+      
+      def id_for_associated field
+        send(field).first
+      end
+      
+      def name_for_associated field
+        send(field).last
+      end
+      
+      module ClassMethods
+        def association_fields
+          @association_fields ||= fields.select do |field|
+            Types.include? field.type
+          end
+        end
+      end
+    end
+  end
+end