ooor-doc 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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/README.md

@@ -0,0 +1,3 @@
+= OoorDoc
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/ooor-doc.rb

@@ -0,0 +1,16 @@
+require 'active_support/concern'
+require 'active_support/dependencies/autoload'
+require 'ooor'
+require 'ooor/base'
+require 'ooor-doc/uml'
+
+module OoorDoc
+  module PrintUml
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def print_uml(options={}); OoorDoc::UML.print_uml([self], options); end
+    end
+  end
+
+  Ooor::Base.send :include, PrintUml
+end

data/lib/ooor-doc/uml.rb

@@ -0,0 +1,210 @@
+#    OOOR: OpenObject On Ruby
+#    Copyright (C) 2009-2012 Akretion LTDA (<http://www.akretion.com>).
+#    Author: Raphaël Valyi
+#    Licensed under the MIT license, see MIT-LICENSE file
+
+module OoorDoc
+  module UML
+    #usage: UML.print_uml or with options: UML.print_uml(:all, :detailed) or MyOpenObjectResource.print_uml or UML.print_uml([list_of_classes], :all, :detailed)
+
+    def print_uml(options={})
+      ooor = self.class.connection
+      UML.print_uml(ooor.config[:models] && ooor.loaded_models.select {|model| ooor.config[:models].index(model.openerp_model)} || ooor.loaded_models, options)
+    end
+
+    def serve_uml(options={})#TODO port
+      ooor = self
+      require 'sinatra'
+      set :public, File.dirname(__FILE__) + '/../../'
+
+      get '/model/:model_name' do
+        model_name = params[:model_name]
+        model = ooor.const_get(model_name)
+        model.print_uml
+        s = ""#"Hello world! #{model_name}"
+        s << "<IMG SRC='/x.png' USEMAP='#UMLbyOOOR' />"
+        f = File.open('x.map')
+        f.each_line {|l| s << l}
+        s
+      end
+
+      Sinatra::Application.run!
+    end
+
+    def self.display_fields(clazz)
+      s = ""
+      clazz.reload_fields_definition if clazz.fields.empty?
+      #clazz.fields.sort {|a,b| a[1]['type'] <=> b[1]['type']}.each {|i| s << "+ #{i[1]['type']} : #{i[0]}\\l\\n"}
+    clazz.fields.sort {|a,b| a[1]['type'] <=> b[1]['type']}.each {|i| s << "<TR><TD COLSPAN=\"2\" BGCOLOR=\"#bed1b8\" ALIGN=\"LEFT\">#{i[0]}</TD><TD ALIGN=\"LEFT\">#{i[1]['type']}</TD></TR>\\l\\n"}
+      s
+    end
+
+    def self.print_uml(classes, options={})
+#      options = options[0] if options[0].is_a?(Array)
+#      local = (options.index(:all) == nil)
+#      detailed = (options.index(:detailed) != nil) || local && (options.index(:nodetail) == nil)
+      return if classes.empty?
+      local = true
+      detailed = true
+      file_name = options[:file_name] || classes[0].name
+      if classes.size > 8
+        enabled_targets = classes.map {|i| i.openerp_model} #classes[0].ooor.config[:models] #defines the scope of the UML for option local
+      else
+        enabled_targets = classes[0].connection.config[:models] #defines the scope of the UML for option local
+      end
+
+      m2o_edges = {}
+      o2m_edges = {}
+      m2m_edges = {}
+      #instead of diplaying several relations of the same kind between two nodes which would bloat the graph,
+      #we track them all and factor them on a common multiline edge label:
+      connex_classes = UML.collect_edges(false, local, classes, enabled_targets, m2o_edges, o2m_edges, m2m_edges)
+      #back links from connex classes:
+      connex_classes += UML.collect_edges(true, local, connex_classes - classes, classes, m2o_edges, o2m_edges, m2m_edges)
+
+      File.open("#{file_name}.dot", 'w') do |f|
+        f << <<-eos
+        digraph UMLbyOOOR {
+            fontname = "Helvetica"
+            #{classes.size < 5 && "layout = fdp" || ""}
+            fontsize = 11
+            splines = polyline
+            label = "*** generated by OOOR by www.akretion.com ***"
+            node [
+                    fontname = "Helvetica"
+                    fontsize = 11
+                    shape = "record"
+                    fillcolor=orange
+                    style="rounded,filled"
+            ]
+            edge [
+                    arrowhead = "none"
+                    fontname = "Helvetica"
+                    fontsize = 9
+            ]
+        eos
+
+        #UML nodes definitions
+        ((connex_classes - classes) + classes - [IrModel, IrModel.const_get('ir.model.fields')]).each do |model|
+          #f << " #{model} [ label = \"{#{model.name}#{detailed ? '|' + display_fields(model) : ''}}\" URL=\"/model/#{model.openerp_model}\"];\n"
+      f << "#{model}[label=<<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" BGCOLOR=\"#ffffff\"><TR><TD COLSPAN=\"3\" BGCOLOR=\"#9bab96\" ALIGN=\"CENTER\">#{model.name}</TD></TR>#{(classes.index(model) || classes.size == 1) && display_fields(model) || ''}</TABLE>> URL=\"/model/#{model.openerp_model}\"];\n"
+        end
+
+        #many2one:
+        f << <<-eos
+            edge [
+                  headlabel = "1"
+                  taillabel = "n"
+            ]
+            eos
+        m2o_edges.each do |k, v|
+          reverse_part = v[3].size > 0 ? "\\n/#{v[3].join("\\n")}\"]\n" : "\"]\n"
+          f << "edge [label = \"#{v[2].join("\\n")}#{reverse_part}"
+          f << "#{v[0]} -> #{v[1]}\n"
+        end
+
+        #one2many:
+        f << <<-eos
+            edge [
+                  headlabel = "n"
+                  taillabel = "1"
+            ]
+            eos
+        o2m_edges.each do |k, v|
+          f << "edge [label = \"#{v[3].join("\\n")}\"]\n"
+          f << "#{v[0]} -> #{v[1]}\n"
+        end
+
+        #many2many:
+        f << <<-eos
+            edge [
+                  headlabel = "n"
+                  taillabel = "n"
+            ]
+            eos
+        m2m_edges.each do |k, v|
+          reverse_part = v[3].size > 0 ? "\\n/#{v[3].join("\\n")}\"]\n" : "\"]\n"
+          f << "edge [label = \"#{v[2].join("\\n")}}#{reverse_part}"
+          f << "#{v[0]} -> #{v[1]}\n"
+        end
+
+        f << "}"
+      end
+
+      begin
+        cmd_line1 = "rm  #{file_name}.png"
+        #system(cmd_line1)
+      rescue
+      end
+      #cmd_line2 = "dot -Tpng uml.dot -o uml.png"
+      cmd_line2 = "dot -Tcmapx -o#{file_name}.map -Tpng -o#{file_name}.png #{file_name}.dot"
+      system(cmd_line2)
+    end
+
+    def self.collect_edges(is_reverse, local, classes, enabled_targets, m2o_edges, o2m_edges, m2m_edges)
+      connex_classes = Set.new
+
+      classes.each do |model|
+        model.reload_fields_definition if model.fields.empty?
+
+        #many2one:
+        model.many2one_associations.each do |k, field|
+          target = UML.get_target(is_reverse, local, enabled_targets, field, model)
+          if target
+            connex_classes.add(target)
+            if m2o_edges["#{model}-#{target}"]
+              m2o_edges["#{model}-#{target}"][2] += [k]
+            else
+              m2o_edges["#{model}-#{target}"] = [model, target, [k], []]
+            end
+          end
+
+        end
+      end
+
+     classes.each do |model|
+        #one2many:
+        model.one2many_associations.each do |k, field|
+          target = UML.get_target(is_reverse, local, enabled_targets, field, model)
+          if target
+            connex_classes.add(target)
+            if m2o_edges["#{target}-#{model}"]
+              m2o_edges["#{target}-#{model}"][3] += [k]
+            elsif o2m_edges["#{model}-#{target}"]
+              o2m_edges["#{model}-#{target}"][3] += [k]
+            else
+              o2m_edges["#{model}-#{target}"] = [model, target, [], [k]]
+            end
+          end
+        end
+
+        #many2many:
+        model.many2many_associations.each do |k, field|
+          target = UML.get_target(is_reverse, local, enabled_targets, field, model)
+          if target
+            connex_classes.add(target)
+            if m2m_edges["#{model}-#{target}"]
+              m2m_edges["#{model}-#{target}"][2] += [k]
+            elsif m2m_edges["#{target}-#{model}"]
+              m2m_edges["#{target}-#{model}"][3] += [k]
+            else
+              m2m_edges["#{model}-#{target}"] = [model, target, [k], []]
+            end
+          end
+        end
+
+      end
+      connex_classes
+    end
+
+    private
+
+    def self.get_target(is_reverse, local, enabled_targets, field, model)
+      if (is_reverse && !local) || (!enabled_targets) || enabled_targets.index(field['relation'])
+        model.const_get(field['relation'])
+      else
+        false
+      end
+    end
+  end
+end

data/lib/ooor-doc/version.rb

@@ -0,0 +1,3 @@
+module OoorDoc
+  VERSION = "0.0.1"
+end

data/lib/tasks/ooor-doc_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ooor-doc do
+#   # Task goes here
+# end

data/spec/helpers/test_helper.rb

@@ -0,0 +1,11 @@
+Ooor.xtend('ir.module.module') do
+
+  def self.say_hello()
+    return "Hello"
+  end
+
+  def say_name()
+    return self.name
+  end
+
+end

data/spec/ooor_spec.rb

@@ -0,0 +1,76 @@
+#    OOOR: OpenObject On Ruby
+#    Copyright (C) 2009-2012 Akretion LTDA (<http://www.akretion.com>).
+#    Author: Raphaël Valyi
+#    Licensed under the MIT license, see MIT-LICENSE file
+
+require File.dirname(__FILE__) + '/../lib/ooor-doc'
+
+#RSpec executable specification; see http://rspec.info/ for more information.
+#Run the file with the rspec command  from the rspec gem
+describe Ooor do
+  before(:all) do
+    @url = 'http://localhost:8069/xmlrpc'
+    @db_password = 'admin'
+    @username = 'admin'
+    @password = 'admin'
+    @database = 'ooor_test'
+    @ooor = Ooor.new(:url => @url, :username => @username, :password => @password)
+  end
+
+  it "should keep quiet if no database is mentioned" do
+    @ooor.loaded_models.should be_empty
+  end
+
+  it "should be able to list databases" do
+    @ooor.list.should be_kind_of(Array) 
+  end
+
+  it "should be able to create a new database with demo data" do
+    unless @ooor.list.index(@database)
+      @ooor.create(@db_password, @database)
+    end
+    @ooor.list.index(@database).should_not be_nil
+  end
+
+  
+  describe "Configure existing database" do
+    before(:all) do
+      @ooor = Ooor.new(:url => @url, :username => @username, :password => @password, :database => @database)
+    end
+
+    it "should be able to load a profile" do
+      module_ids = IrModuleModule.search(['name','=', 'sale']) + IrModuleModule.search(['name','=', 'account_voucher']) + IrModuleModule.search(['name','=', 'sale_stock'])
+      module_ids.each do |accounting_module_id|
+        mod = IrModuleModule.find(accounting_module_id) 
+        unless mod.state == "installed"
+          mod.button_install
+        end
+      end
+      wizard = BaseModuleUpgrade.create
+      wizard.upgrade_module
+      @ooor.load_models
+      @ooor.loaded_models.should_not be_empty
+    end
+  end
+
+
+  describe "UML features" do
+    before(:all) do
+      @ooor = Ooor.new(:url => @url, :username => @username, :password => @password, :database => @database,
+        :models => ['res.user', 'res.partner', 'product.product',  'sale.order', 'account.invoice', 'product.category', 'stock.move', 'ir.ui.menu'])
+    end
+
+    it "should be able to draw the UML of any class" do
+      SaleOrder.print_uml.should be_true
+    end
+
+    it "should be able to draw the UML of several classes" do
+      OoorDoc::UML.print_uml([SaleOrder, SaleShop]).should be_true
+    end
+
+    it "should accept rendering options" do
+      SaleOrder.print_uml({:detailed => true}).should be_true
+    end
+  end
+
+end

data/spec/requirements.txt

@@ -0,0 +1,19 @@
+pillow
+docutils
+psutil
+pytz
+psycopg2
+reportlab
+lxml
+Mako
+--find-links=http://download.gna.org/pychart/
+PyChart
+vobject
+Babel
+simplejson
+python-dateutil
+python-openid
+PyYaml
+werkzeug
+unittest2
+mock

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ooor-doc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Raphael Valyi - www.akretion.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ooor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: UML and OpenERP classes auto-documentation OOOR tools
+email:
+- raphael.valyi@akretion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/ooor-doc_tasks.rake
+- lib/ooor-doc/version.rb
+- lib/ooor-doc/uml.rb
+- lib/ooor-doc.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/requirements.txt
+- spec/helpers/test_helper.rb
+- spec/ooor_spec.rb
+homepage: http://github.com/akretion/ooor-doc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: UML and OpenERP classes auto-documentation OOOR tools
+test_files:
+- spec/requirements.txt
+- spec/helpers/test_helper.rb
+- spec/ooor_spec.rb