erp_base_erp_svcs 3.0.0

data/db/migrate/20080805000020_base_erp_services.rb

@@ -0,0 +1,461 @@
+class BaseErpServices < ActiveRecord::Migration
+  def self.up
+    
+    unless table_exists?(:compass_ae_instances)
+      create_table :compass_ae_instances do |t|
+        t.decimal :version
+        
+        t.timestamps
+      end
+    end
+    
+    # Create parties table
+    unless table_exists?(:parties)
+      create_table :parties do |t|
+        t.column    	:description,         :string
+        t.column    	:business_party_id,   :integer
+        t.column    	:business_party_type, :string
+        t.column    	:list_view_image_id,  :integer
+        
+        #This field is here to provide a direct way to map CompassERP
+        #business parties to unified idenfiers in organizations if they
+        #have been implemented in an enterprise.
+        t.column		:enterprise_identifier, :string
+        t.timestamps
+      end
+      add_index :parties, [:business_party_id, :business_party_type], :name => "besi_1"
+    end
+    
+    # Create party_roles table
+    unless table_exists?(:party_roles)
+      create_table :party_roles do |t|
+        #this column holds the class name of the 
+        #subtype of party-to-role_type relatsionship
+        t.column  :type,          :string
+        #xref between party and role_type      
+        t.column  :party_id,      :integer
+    	  t.column  :role_type_id,  :integer
+    	  t.timestamps
+      end
+	  add_index :party_roles, :party_id
+	  add_index :party_roles, :role_type_id 
+    end
+    
+    
+    # Create role_types table
+    unless table_exists?(:role_types)
+      create_table :role_types do |t|
+        #these columns are required to support the behavior of the plugin 'awesome_nested_set'
+        t.column  	:parent_id,    :integer
+        t.column  	:lft,          :integer
+        t.column  	:rgt,          :integer
+
+        #custom columns go here   
+        t.column     :description,         :string
+        t.column     :comments,            :string
+		    t.column 	   :internal_identifier, :string
+		    t.column 	   :external_identifier, :string
+		    t.column 	   :external_id_source,  :string
+        t.timestamps
+      end
+    end
+    
+    # Create relationship_types table
+    unless table_exists?(:relationship_types)
+      create_table :relationship_types do |t|
+        t.column  	:parent_id,    :integer
+        t.column  	:lft,          :integer
+        t.column  	:rgt,          :integer
+
+        #custom columns go here        
+        t.column  	:valid_from_role_type_id, :integer
+        t.column  	:valid_to_role_type_id,   :integer
+        t.column  	:name,                    :string  
+        t.column  	:description,             :string
+
+		t.column    :internal_identifier, 	  :string
+		t.column    :external_identifier, 	  :string
+	    t.column    :external_id_source,      :string
+        t.timestamps
+      end
+	  add_index :relationship_types, :valid_from_role_type_id
+	  add_index :relationship_types, :valid_to_role_type_id
+    end
+    
+    # Create party_relationships table
+    unless table_exists?(:party_relationships)
+      create_table :party_relationships do |t|
+        t.column    :description,           :string 
+        t.column    :party_id_from,         :integer
+        t.column    :party_id_to,           :integer
+        t.column    :role_type_id_from,     :integer
+        t.column    :role_type_id_to,       :integer
+        t.column    :status_type_id,        :integer
+        t.column    :priority_type_id,      :integer
+        t.column    :relationship_type_id,  :integer
+        t.column    :from_date,             :date
+        t.column    :thru_date,             :date   
+		    t.column    :external_identifier, 	:string
+		    t.column    :external_id_source,    :string
+      	t.timestamps
+      end
+	  add_index :party_relationships, :status_type_id
+      add_index :party_relationships, :priority_type_id
+      add_index :party_relationships, :relationship_type_id
+    end
+    
+    # Create organizations table
+    unless table_exists?(:organizations)
+      create_table :organizations do |t|
+		    t.column    :description,   :string
+		    t.column  	:tax_id_number, :string
+		    t.timestamps
+      end
+    end
+    
+    # Create individuals table 
+    unless table_exists?(:individuals)
+      create_table :individuals do |t|
+		    t.column  :party_id,                :integer
+		    t.column  :current_last_name,       :string
+		    t.column  :current_first_name,      :string
+		    t.column  :current_middle_name,     :string
+		    t.column  :current_personal_title,  :string
+		    t.column  :current_suffix,          :string
+		    t.column  :current_nickname,        :string
+		    t.column  :gender,                  :string,  :limit => 1
+		    t.column  :birth_date,              :date
+		    t.column  :height,                  :decimal, :precision => 5, :scale => 2
+		    t.column  :weight,                  :integer
+		    t.column  :mothers_maiden_name,     :string
+		    t.column  :marital_status,          :string,  :limit => 1
+		    t.column  :social_security_number,  :string
+		    t.column  :current_passport_number, :integer
+		    
+		    t.column  :current_passport_expire_date,  :date
+		    t.column  :total_years_work_experience,   :integer
+		    t.column  :comments,                      :string
+		    t.column  :encrypted_ssn,                 :string  	
+			t.column  :temp_ssn,                      :string 
+			t.column  :salt,                          :string
+			t.column  :ssn_last_four,                 :string 
+		    t.timestamps
+      end
+	  add_index :individuals, :party_id
+    end
+    
+    # Create contacts table
+    unless table_exists?(:contacts)
+      create_table :contacts do |t|
+        t.column    :party_id,                :integer
+        t.column    :contact_mechanism_id,    :integer
+        t.column    :contact_mechanism_type,  :string
+        
+        t.column 	:external_identifier,       :string
+        t.column 	:external_id_source, 	      :string
+
+        t.timestamps
+      end
+	  add_index :contacts, :party_id
+	  add_index :contacts, [:contact_mechanism_id, :contact_mechanism_type], :name => "besi_2"
+    end
+    
+    # Create contact_types
+    unless table_exists?(:contact_types)
+      create_table :contact_types do |t|
+        t.column  :parent_id,    :integer
+        t.column  :lft,          :integer
+        t.column  :rgt,          :integer
+
+        #custom columns go here   
+
+        t.column  :description,         :string
+        t.column  :comments,            :string
+
+		    t.column 	:internal_identifier, :string
+		    t.column 	:external_identifier, :string
+		    t.column 	:external_id_source, 	:string
+
+        t.timestamps
+      end
+	  add_index :contact_types, :parent_id
+    end
+    
+    # Create contact_purposes
+    unless table_exists?(:contact_purposes)
+      create_table :contact_purposes do |t|
+
+      	t.column  :parent_id,    :integer
+      	t.column  :lft,          :integer
+      	t.column  :rgt,          :integer
+
+        #custom columns go here   
+
+      	t.column  :description,         :string
+      	t.column  :comments,            :string
+
+		    t.column 	:internal_identifier, :string
+		    t.column 	:external_identifier, :string
+		    t.column 	:external_id_source, 	:string
+
+        t.timestamps
+      end
+	    add_index :contact_purposes, :parent_id
+      
+    end
+    
+    unless table_exists?(:contact_purposes_contacts)
+        create_table :contact_purposes_contacts, {:id => false} do |t|
+          t.column :contact_id,         :integer
+          t.column :contact_purpose_id, :integer
+        end
+        add_index :contact_purposes_contacts, [:contact_id, :contact_purpose_id], :name => "contact_purposes_contacts_index"
+    end
+    
+    # Create postal_addresses (a contact_mechanism)
+    unless table_exists?(:postal_addresses)
+      create_table :postal_addresses do |t|
+		    t.column    :address_line_1,    :string
+		    t.column    :address_line_2,    :string
+		    t.column    :city,              :string
+		    t.column    :state,             :string
+		    t.column    :zip,               :string
+		    t.column    :country,           :string
+		    t.column    :description,       :string
+		    t.column    :geo_country_id,    :integer
+		    t.column    :geo_zone_id,       :integer
+		    t.timestamps
+      end
+	  add_index :postal_addresses, :geo_country_id
+	  add_index :postal_addresses, :geo_zone_id
+    end
+    
+    # Create email_addresses (a contact_mechanism)
+    unless table_exists?(:email_addresses)
+	    create_table :email_addresses do |t|
+		  	t.column    :email_address,     	:string
+		  	t.column    :description,       	:string
+		  	
+		  	t.timestamps
+	    end
+    end
+    
+    # Create phone_numbers table (A contact_mechanism)
+    unless table_exists?(:phone_numbers)
+      create_table :phone_numbers do |t|
+			  t.column    :phone_number,  		:string
+			  t.column    :description,       :string
+
+        t.timestamps
+      end
+    end
+    
+    unless table_exists?(:party_search_facts)
+      create_table :party_search_facts do |t|
+        t.column :party_id,                       :integer
+        t.column :eid,                            :string
+        t.column :type,                           :string
+        t.column :roles,                          :text
+        t.column :party_description,              :string
+        t.column :party_business_party_type,      :string
+        t.column :user_login,                     :string
+        t.column :individual_current_last_name,   :string
+        t.column :individual_current_first_name,  :string
+        t.column :individual_current_middle_name, :string
+        t.column :individual_birth_date,          :string
+        t.column :individual_ssn,                 :string
+        t.column :party_phone_number,             :string
+        t.column :party_email_address,            :string
+        t.column :party_address_1,                :string
+        t.column :party_address_2,                :string
+        t.column :party_primary_address_city,     :string
+        t.column :party_primary_address_state,    :string
+        t.column :party_primary_address_zip,      :string
+        t.column :party_primary_address_country,  :string
+        t.column :user_enabled,                   :boolean
+        t.column :user_type,                      :string
+        t.column :reindex,                        :boolean
+        t.timestamps
+      end
+    end
+    
+    unless table_exists?(:money)
+      create_table :money do |t|
+        t.string      :description
+        t.float       :amount
+        t.references  :currency 
+        t.timestamps
+      end
+	  add_index :money, :currency_id
+    end
+
+    unless table_exists?(:currencies)
+      create_table :currencies do |t|
+	      t.string    :name
+		    t.string    :definition
+		    t.string    :internal_identifier # aka alphabetic_code
+		    t.string    :numeric_code
+		    t.string    :major_unit_symbol
+		    t.string    :minor_unit_symbol
+		    t.string    :ratio_of_minor_unit_to_major_unit
+		    t.string    :postfix_label
+		    t.datetime  :introduction_date
+		    t.datetime  :expiration_date
+        t.timestamps
+      end
+	  add_index :currencies, :internal_identifier
+    end
+
+    ## categories
+    unless table_exists?(:categories)
+      create_table :categories do |t|
+        t.string :description
+        t.string :external_identifier
+        t.datetime :from_date
+        t.datetime :to_date
+        t.string :internal_identifier
+
+        # polymorphic assns
+        t.integer :category_record_id
+        t.string  :category_record_type
+
+        # nested set cols
+        t.integer :parent_id
+        t.integer :lft
+        t.integer :rgt
+
+        t.timestamps
+      end
+	  add_index :categories, [:category_record_id, :category_record_type], :name => "category_polymorphic"
+    end
+
+    ## category_classifications
+    unless table_exists?(:category_classifications)
+      create_table :category_classifications do |t|
+        t.integer  :category_id
+        t.string   :classification_type
+        t.integer  :classification_id
+        t.datetime :from_date
+        t.datetime :to_date
+
+        t.timestamps
+      end
+	  add_index :category_classifications, [:classification_id, :classification_type], :name => "classification_polymorphic"
+    end
+
+    ## descriptive_assets
+    unless table_exists?(:descriptive_assets)
+      create_table :descriptive_assets do |t|
+        t.references :view_type
+        t.string     :internal_identifier
+        t.text       :description
+        t.string     :external_identifier
+        t.string     :external_id_source
+        t.references :described_record, :polymorphic => true
+
+        t.timestamps
+      end
+
+      add_index :descriptive_assets, :view_type_id
+      add_index :descriptive_assets, [:described_record_id, :described_record_type], :name => 'described_record_idx'
+    end
+
+    unless table_exists?(:view_types)
+      create_table :view_types do |t|
+        t.string     :internal_identifier
+        t.string     :description
+
+        t.timestamps
+      end
+    end
+
+    unless table_exists?(:geo_countries)
+      create_table :geo_countries do |t|
+        t.column :name,         :string
+        t.column :iso_code_2,   :string,  :length => 2
+        t.column :iso_code_3,   :string,  :length => 3
+        t.column :display,      :boolean, :default => true
+        t.column :external_id,  :integer
+        t.column :created_at,   :datetime
+      end
+	  add_index :geo_countries, :name
+      add_index :geo_countries, :iso_code_2
+    end
+
+    unless table_exists?(:geo_zones)
+      create_table :geo_zones do |t|
+        t.column :geo_country_id, :integer
+        t.column :zone_code,      :string,  :default => 2
+        t.column :zone_name,      :string
+        t.column :created_at,     :datetime
+      end
+	  add_index :geo_zones, :geo_country_id
+      add_index :geo_zones, :zone_name
+      add_index :geo_zones, :zone_code
+    end
+
+    unless table_exists?(:notes)
+      create_table   :notes do |t|
+        t.integer    :created_by_id
+        t.text       :content
+        t.references :noted_record, :polymorphic => true
+        t.references :note_type
+
+        t.timestamps
+      end
+
+      add_index :notes, [:noted_record_id, :noted_record_type]
+      add_index :notes, :note_type_id
+      add_index :notes, :created_by_id
+      add_index :notes, :content
+    end
+
+    unless table_exists?(:note_types)
+      create_table :note_types do |t|
+        #these columns are required to support the behavior of the plugin 'awesome_nested_set'
+        t.integer  	:parent_id
+        t.integer  	:lft
+        t.integer  	:rgt
+
+        t.string     :description
+        t.string     :internal_identifier
+        t.string     :external_identifier
+        t.references :note_type_record, :polymorphic => true
+
+        t.timestamps
+      end
+
+      add_index :note_types, [:note_type_record_id, :note_type_record_type], :name => "note_type_record_idx"
+    end
+    
+    unless table_exists?(:valid_note_types)
+      create_table   :valid_note_types do |t|
+        t.references :valid_note_type_record, :polymorphic => true
+        t.references :note_type
+    
+        t.timestamps
+      end
+
+      add_index :valid_note_types, [:valid_note_type_record_id, :valid_note_type_record_type], :name => "valid_note_type_record_idx"
+      add_index :valid_note_types, :note_type_id
+    end
+
+  end
+
+  def self.down
+    [
+      :currencies, :money,
+      :party_search_facts, :phone_numbers, :email_addresses, 
+      :postal_addresses, :contact_purposes, :contact_types,
+      :contacts, :individuals, :organizations, 
+      :party_relationships, :relationship_types, :role_types, 
+      :party_roles, :parties, :categories, :category_classifications,
+      :descriptive_assets, :view_types, :notes, :note_types, :valid_note_types, :compass_ae_instances
+    ].each do |tbl|
+      if table_exists?(tbl)
+        drop_table tbl
+      end
+    end
+
+  end
+end

data/db/migrate/20110913145329_create_compass_ae_instance.rb

@@ -0,0 +1,15 @@
+class CreateCompassAeInstance < ActiveRecord::Migration
+  def self.up
+    unless table_exists?(:compass_ae_instances)
+      create_table :compass_ae_instances do |t|
+        t.decimal :version
+        
+        t.timestamps
+      end
+    end
+  end
+
+  def self.down
+    drop_table :compass_ae_instances
+  end
+end

data/db/migrate/upgrade/20110907171257_add_notes.rb

@@ -0,0 +1,63 @@
+class AddNotes < ActiveRecord::Migration
+  def self.up
+    unless table_exists?(:notes)
+      create_table   :notes do |t|
+        t.integer    :created_by_id
+        t.text       :content
+        t.references :noted_record, :polymorphic => true
+        t.references :note_type
+
+        t.timestamps
+      end
+
+      add_index :notes, [:noted_record_id, :noted_record_type]
+      add_index :notes, :note_type_id
+      add_index :notes, :created_by_id
+      add_index :notes, :content
+    end
+
+    unless table_exists?(:note_types)
+      create_table :note_types do |t|
+        #these columns are required to support the behavior of the plugin 'awesome_nested_set'
+        t.integer  	:parent_id
+        t.integer  	:lft
+        t.integer  	:rgt
+
+        t.string     :description
+        t.string     :internal_identifier
+        t.string     :external_identifier
+        t.references :note_type_record, :polymorphic => true
+
+        t.timestamps
+      end
+
+      add_index :note_types, [:note_type_record_id, :note_type_record_type], :name => "note_type_record_idx"
+    end
+
+    unless table_exists?(:valid_note_types)
+      create_table   :valid_note_types do |t|
+        t.references :valid_note_type_record, :polymorphic => true
+        t.references :note_type
+
+        t.timestamps
+      end
+
+      add_index :valid_note_types, [:valid_note_type_record_id, :valid_note_type_record_type], :name => "valid_note_type_record_idx"
+      add_index :valid_note_types, :note_type_id
+    end
+  end
+
+  def self.down
+    if table_exists?(:valid_note_types)
+      drop_table :valid_note_types
+    end
+
+    if table_exists?(:note_types)
+      drop_table :note_types
+    end
+
+    if table_exists?(:notes)
+      drop_table :notes
+    end
+  end
+end

data/lib/erp_base_erp_svcs/ar_fixtures.rb

@@ -0,0 +1,103 @@
+# Extension to make it easy to read and write data to a file.
+class ActiveRecord::Base
+
+  class << self
+
+    # Writes content of this table to db/table_name.yml, or the specified file.
+    #
+    # Writes all content by default, but can be limited.
+    def dump_to_file(path=nil, limit=nil)
+      opts = {}
+      opts[:limit] = limit if limit
+      path ||= "db/#{table_name}.yml"
+      write_file(File.expand_path(path, Rails.root), self.find(:all, opts).to_yaml)
+    end
+  
+    # Delete existing data in database and load fresh from file in db/table_name.yml
+    def load_from_file(path=nil)
+      path ||= "db/#{table_name}.yml"
+
+      self.destroy_all
+
+      if connection.respond_to?(:reset_pk_sequence!)
+       connection.reset_pk_sequence!(table_name)
+      end
+
+      records = YAML::load( File.open( File.expand_path(path, Rails.root) ) )
+      records.each do |record|
+        record_copy = self.new(record.attributes)
+        record_copy.id = record.id
+
+        # For Single Table Inheritance
+        klass_col = record.class.inheritance_column.to_sym
+        if record[klass_col]
+           record_copy.type = record[klass_col]
+        end
+      
+        record_copy.save
+      end
+ 
+      if connection.respond_to?(:reset_pk_sequence!)
+       connection.reset_pk_sequence!(table_name)
+      end
+    end
+
+    # Write a file that can be loaded with +fixture :some_table+ in tests.
+    # Uses existing data in the database.
+    #
+    # Will be written to +test/fixtures/table_name.yml+. Can be restricted to some number of rows.
+    def to_fixture(limit=nil)
+      opts = {}
+      opts[:limit] = limit if limit
+
+      write_file(File.expand_path("test/fixtures/#{table_name}.yml", Rails.root), 
+          self.find(:all, opts).inject({}) { |hsh, record| 
+              hsh.merge("#{table_name.singularize}_#{'%05i' % record.id rescue record.id}" => record.attributes) 
+            }.to_yaml(:SortKeys => true))
+      habtm_to_fixture
+    end
+
+    # Write the habtm association table
+    def habtm_to_fixture
+      joins = self.reflect_on_all_associations.select { |j|
+        j.macro == :has_and_belongs_to_many
+      }
+      joins.each do |join|
+        hsh = {}
+        connection.select_all("SELECT * FROM #{join.options[:join_table]}").each_with_index { |record, i|
+          hsh["join_#{'%05i' % i}"] = record
+        }
+        write_file(File.expand_path("test/fixtures/#{join.options[:join_table]}.yml", Rails.root), hsh.to_yaml(:SortKeys => true))
+      end
+    end
+    
+    # Generates a basic fixture file in test/fixtures that lists the table's field names.
+    #
+    # You can use it as a starting point for your own fixtures.
+    #
+    #  record_1:
+    #    name:
+    #    rating:
+    #  record_2:
+    #    name:
+    #    rating:
+    #
+    # TODO Automatically add :id field if there is one.
+    def to_skeleton
+      record = { 
+          "record_1" => self.new.attributes,
+          "record_2" => self.new.attributes
+         }
+      write_file(File.expand_path("test/fixtures/#{table_name}.yml", Rails.root),
+        record.to_yaml)
+    end
+
+    def write_file(path, content) # :nodoc:
+      f = File.new(path, "w+")
+      f.puts content
+      f.close
+    end
+
+  end
+
+end

data/lib/erp_base_erp_svcs/command.rb

@@ -0,0 +1,37 @@
+module ErpBaseErpSvcs
+  module Command
+    extend self
+    
+    def banner
+      %(
+Usage:
+    compass_ae new <app_name> [setup_opt] [rails_opt]  Creates a new Rails Compass AE Application
+        setup_opt:
+            --skip-setup      generate only the rails infrastructure
+        rails_opt:            all the options accepted by the rails command
+
+    erp --help|-h             This help screen)
+    end
+    
+    def run
+      command = ARGV.shift
+      case command
+      when nil
+        raise "The command is missing!"
+      when 'skip'
+        app_name = ARGV.shift
+        raise "The application name is missing!" if app_name.nil?
+        puts 'Generating Rails infrastructure...'
+        system "rails new #{app_name} #{ARGV * ' '}"
+      when 'new'
+        template_path = File.join(File.dirname(__FILE__), 'rails_template.rb')
+        app_name = ARGV.shift
+        raise "The application name is missing!" if app_name.nil?
+        puts 'Generating Rails infrastructure...'
+        system "rails new #{app_name} #{ARGV * ' '} -m #{template_path}"
+      end
+    
+    end
+    
+  end
+end

data/lib/erp_base_erp_svcs/config.rb

@@ -0,0 +1,27 @@
+module ErpBaseErpSvcs
+  module Config
+    class << self
+      attr_accessor :compass_ae_extensions_directory
+
+      def init!
+        @defaults = {:@compass_ae_extensions_directory => nil}
+      end
+
+      def reset!
+        @defaults.each do |k,v|
+          instance_variable_set(k,v)
+        end
+      end
+
+      def configure(&blk)
+        @configure_blk = blk
+      end
+
+      def configure!
+        @configure_blk.call(self) if @configure_blk
+      end
+    end
+    init!
+    reset!
+  end
+end