erp_base_erp_svcs 3.0.0

data/lib/erp_base_erp_svcs/engine.rb

@@ -0,0 +1,27 @@
+require 'has_many_polymorphic'
+require 'attr_encrypted'
+require 'awesome_nested_set'
+require 'data_migrator'
+
+module ErpBaseErpSvcs
+  class Engine < Rails::Engine
+    isolate_namespace ErpBaseErpSvcs
+
+    config.erp_base_erp_svcs = ErpBaseErpSvcs::Config
+
+	  ActiveSupport.on_load(:active_record) do
+      include ErpBaseErpSvcs::Extensions::ActiveRecord::IsDescribable
+      include ErpBaseErpSvcs::Extensions::ActiveRecord::HasNotes
+      include ErpBaseErpSvcs::Extensions::ActiveRecord::ActsAsNoteType
+	    include ErpBaseErpSvcs::Extensions::ActiveRecord::ActsAsErpType
+      include ErpBaseErpSvcs::Extensions::ActiveRecord::ActsAsCategory
+      include ErpBaseErpSvcs::Extensions::ActiveRecord::HasContact
+      extend ErpBaseErpSvcs::Extensions::ActiveRecord::StiInstantiation::ActMacro
+    end
+
+    config.to_prepare do
+      Rails::Engine.load_extensions
+    end
+    
+  end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/acts_as_category.rb

@@ -0,0 +1,50 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module ActsAsCategory
+				def self.included(base)
+				  base.extend(ClassMethods)
+				end
+
+				module ClassMethods
+				  def acts_as_category
+            extend ActsAsCategory::SingletonMethods
+  					include ActsAsCategory::InstanceMethods
+  					
+					  after_initialize :initialize_category
+  					after_create :save_category
+  					after_update :save_category
+  					after_destroy :destroy_category
+					
+					  has_one :category, :as => :category_record
+				  end
+				end
+
+				module SingletonMethods
+				end
+
+				module InstanceMethods
+				  def method_missing(name, *args)
+            self.category.respond_to?(name) ? self.category.send(name, *args) : super
+				  end
+
+				  def save_category
+            self.category.save
+				  end
+
+				  def destroy_category
+            self.category.destroy
+				  end
+
+				  def initialize_category
+            if (self.category.nil?)
+              category = Category.new
+              self.category = category
+              category.category_record = self
+            end
+				  end
+				end
+			end
+		end
+	end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/acts_as_erp_type.rb

@@ -0,0 +1,148 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module ActsAsErpType
+				def self.included(base)
+				  base.extend(ClassMethods) 	        	      	
+				end
+
+				# declare the class level helper methods which
+				# will load the relevant instance methods
+				# defined below when invoked
+				module ClassMethods
+
+				  def acts_as_erp_type
+							
+            # this is at the class level
+            # add any class level manipulations you need here, like has_many, etc.
+            extend ActsAsErpType::ActsAsSingletonMethods
+            include ActsAsErpType::ActsAsInstanceMethods
+							
+            if ::ActiveRecord::Base.connection.tables.include?(self.table_name)
+              # find each valid value for the domain type (erp_type) in question
+              # we will then create a class method with the name of the internal idenfifier
+              # for that type
+              valid_values = self.all
+							
+              # the class method will return a populated instance of the correct type
+              valid_values.each do | vv |
+                (class << self; self; end).instance_eval { define_method vv.internal_identifier, Proc.new{vv} } unless vv.internal_identifier.nil?
+              end
+            end
+				  end
+
+				  def belongs_to_erp_type(model_id = nil, options = {})
+
+            @model_id = model_id
+            self.belongs_to model_id, options
+            extend ActsAsErpType::BelongsToSingletonMethods
+            include ActsAsErpType::BelongsToInstanceMethods
+							
+				  end
+
+				end
+
+				# Adds singleton methods.
+				module ActsAsSingletonMethods
+								  
+				  def valid_types
+            self.all.collect{ |type| type.internal_identifier.to_sym }
+				  end
+					  
+				  def valid_type?( type_name_string )
+            sym_list = self.all.collect{ |type| type.internal_identifier.to_sym }
+            sym_list.include?(type_name_string.to_sym)
+				  end
+						
+				  def eid( external_identifier_string )
+            where('external_identifier = ?', external_identifier_string.to_s).first
+				  end
+							
+				  def iid( internal_identifier_string )
+            where('internal_identifier = ?', internal_identifier_string.to_s).first
+				  end
+						
+				end
+
+				module BelongsToSingletonMethods
+						
+				  def fbet( domain_value, options = {})
+            find_by_erp_type( domain_value, options )
+				  end
+							
+				  def find_by_erp_type(domain_value, options = {})
+							
+            # puts "options...."
+            # puts options[:class]
+            # puts options[:foreign_key]
+							
+            erp_type = options[:class] || @model_id
+            fk_str = options[:foreign_key] || erp_type.to_s + '_id'
+							
+            #***************************************************************
+            # uncomment these lines for a variety of debugging information
+            #***************************************************************
+            # klass = self.to_s.underscore + '_type'
+            # puts "default class name"
+            # puts klass
+							
+            # puts "model id"
+            # puts @model_id
+            #
+            # puts "finding by erp type"
+            # puts "self is: #{self}"
+            # puts "type is: #{erp_type}"
+							
+            # puts "fk_str for in clause..."
+            # puts fk_str
+							
+            type_klass = Kernel.const_get( erp_type.to_s.camelcase )
+            in_clause_array = type_klass.send( domain_value.to_sym )
+							
+            where(fk_str + ' in (?)', in_clause_array)
+							
+				  end
+
+				  def fabet( domain_value, options = {} )
+            find_all_by_erp_type( domain_value, options )
+				  end
+
+				  def find_all_by_erp_type( domain_value, options = {} )
+
+            erp_type = options[:class] || @model_id
+            fk_str = options[:foreign_key] || erp_type.to_s + '_id'
+											
+            type_klass = Kernel.const_get( erp_type.to_s.camelcase )
+            in_clause_array = type_klass.send( domain_value.to_sym ).full_set
+
+            #puts "id for in clause..."
+            #id_str = erp_type.to_s + '_id'
+							
+            where(fk_str + ' in (?)', in_clause_array)
+							
+				  end			
+				end
+
+					
+				# Adds instance methods.
+				module ActsAsInstanceMethods
+						
+				  # def instance_method_for_acts_as
+				  #   puts "Instance with ID #{self.id}"
+				  # end
+					  
+				end
+
+				# Adds instance methods.
+				module BelongsToInstanceMethods
+						
+				  # def instance_method_for_belongs_to
+				  #   puts "Instance with ID #{self.id}"
+				  # end
+					  
+				end
+			end
+		end
+	end
+end
+

data/lib/erp_base_erp_svcs/extensions/active_record/acts_as_note_type.rb

@@ -0,0 +1,47 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module ActsAsNoteType
+				def self.included(base)
+				  base.extend(ClassMethods)
+				end
+
+				module ClassMethods
+				  def acts_as_note_type
+            extend ActsAsNoteType::SingletonMethods
+  					include ActsAsNoteType::InstanceMethods
+  					
+					  after_initialize :initialize_note_type
+  					after_create :save_note_type
+  					after_update :save_note_type
+  					after_destroy :destroy_note_type
+					
+					  has_one :note_type_record, :as => :note_type_record, :class_name => 'NoteType'
+				  end
+				end
+
+				module SingletonMethods
+				end
+
+				module InstanceMethods
+				  def save_note_type
+					  self.note_type_record.save
+				  end
+
+				  def destroy_note_type
+					  self.note_type_record.destroy
+				  end
+
+				  def initialize_note_type
+					  if (self.note_type_record.nil?)
+					    note_type_record = NoteType.new
+					    self.note_type_record = note_type_record
+					    self.note_type_record.note_type_record = self
+					  end
+				  end
+				  
+				end
+			end
+		end
+	end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/data_migrator.rb

@@ -0,0 +1,46 @@
+module RussellEdge
+  class DataMigrator
+
+    class << self
+      def prepare_upgrade_migrations
+        dirs = Rails::Application::Railties.engines.map{|p| p.config.root.to_s}
+        dirs.each do |dir|
+          if File.directory? File.join(dir,'db/data_migrations/upgrade')
+            target = File.join(dir,'db/data_migrations/')
+            files = Dir["#{target}*.rb"]
+            unless files.empty?
+              FileUtils.mkdir_p "#{target}app/"
+              FileUtils.cp files, "#{target}app/"
+              puts "copied #{files.size} upgrade data migrations to #{target}app"
+            end
+
+            files = Dir["#{File.join(dir,'db/data_migrations/upgrade')}/*.rb"]
+            FileUtils.cp files, File.join(dir,'db/data_migrations/')
+          end
+        end
+      end
+
+      def cleanup_upgrade_migrations
+        dirs = Rails::Application::Railties.engines.map{|p| p.config.root.to_s}
+        dirs.each do |dir|
+          if File.directory? File.join(dir,'db/data_migrations/app')
+            target = File.join(dir,'db/data_migrations/')
+            files = Dir["#{target}/*.rb"]
+            unless files.empty?
+              FileUtils.rm files
+              puts "removed #{files.size} data migrations from #{target}"
+            end
+
+            files = Dir["#{target}/app/*.rb"]
+            unless files.empty?
+              FileUtils.cp files, target
+              puts "copied #{files.size} data migrations back to #{target}"
+            end
+            FileUtils.rm_rf "#{target}/app"
+          end
+        end
+      end
+    end
+
+  end#DataMigrator
+end#RussellEdge

data/lib/erp_base_erp_svcs/extensions/active_record/has_contact.rb

@@ -0,0 +1,56 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module HasContact
+				def self.included(base)
+				  base.extend(ClassMethods)
+				end
+
+				module ClassMethods
+				  def has_contact
+            extend HasContact::SingletonMethods
+  					include HasContact::InstanceMethods
+  					
+					  after_initialize :initialize_contact
+  					after_create :save_contact
+  					after_update :save_contact
+  					after_destroy :destroy_contact
+					
+					  has_one :contact, :as => :contact_mechanism
+				  end
+				end
+
+				module SingletonMethods
+				end
+
+				module InstanceMethods
+				  # return first contact purpose
+          def contact_purpose
+            contact.contact_purposes.count == 0 ? nil : contact.contact_purposes.first
+          end
+
+          # return all contact purposes
+          def contact_purposes
+            contact.contact_purposes
+          end
+				  
+				  def save_contact
+					  self.contact.save
+				  end
+
+				  def destroy_contact
+					  self.contact.destroy
+				  end
+
+				  def initialize_contact
+            if self.new_record? and self.contact.nil?
+              self.contact = Contact.new
+              self.contact.description = self.description
+            end
+          end
+          
+				end
+			end
+		end
+	end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/has_notes.rb

@@ -0,0 +1,32 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module HasNotes
+				def self.included(base)
+				  base.extend(ClassMethods)
+				end
+
+				module ClassMethods
+				  def has_notes
+
+            has_many :notes, :as => :noted_record, :dependent => :delete_all do
+              def by_type(note_type)
+                find_by_note_type_id(note_type.id)
+              end
+            end
+					
+            extend ErpBaseErpSvcs::Extensions::ActiveRecord::HasNotes
+            include ErpBaseErpSvcs::Extensions::ActiveRecord::HasNotes
+
+				  end
+				end
+
+				module SingletonMethods
+				end
+
+				module InstanceMethods
+				end
+			end
+		end
+	end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/is_describable.rb

@@ -0,0 +1,44 @@
+module ErpBaseErpSvcs
+	module Extensions
+		module ActiveRecord
+			module IsDescribable
+			
+				def self.included(base)
+					base.extend(ClassMethods)  	        	      	
+				end
+
+				module ClassMethods
+			  
+					def is_describable
+						has_many :descriptions, :class_name => 'DescriptiveAsset', :as => :described_record, :dependent => :destroy
+					
+						extend IsDescribable::SingletonMethods
+						include IsDescribable::InstanceMethods
+																		
+					end
+				end
+				
+				module SingletonMethods			
+				end
+						
+				module InstanceMethods
+				  def find_descriptions_by_view_type(view_iid)
+					self.descriptions.where('view_type_id = ?', ViewType.find_by_internal_identifier(view_iid).id)
+				  end
+
+				  def find_description_by_iid(iid)
+					self.descriptions.where('internal_identifier = ?', iid).first
+				  end
+
+				  def add_description(view_type, description)
+					descriptive_asset = DescriptiveAsset.create(
+					  :view_type => view_type,
+					  :description => description)
+					descriptive_asset.described_record = self
+					self.descriptions << descriptive_asset
+				  end
+				end
+			end
+		end
+	end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/migrator.rb

@@ -0,0 +1,76 @@
+ActiveRecord::Migrator.instance_eval do
+  def prepare_migrations
+    target = "#{Rails.root}/db/migrate/"
+    # first copy all app migrations away
+    files = Dir["#{target}*.rb"]
+
+    unless files.empty?
+      FileUtils.mkdir_p "#{target}app/"
+      FileUtils.cp files, "#{target}app/"
+      puts "copied #{files.size} migrations to db/migrate/app"
+    end
+
+    dirs = Rails::Application::Railties.engines.map{|p| p.config.root.to_s}
+    files = Dir["{#{dirs.join(',')}}/db/migrate/*.rb"]
+
+    unless files.empty?
+      FileUtils.mkdir_p target
+      FileUtils.cp files, target
+      puts "copied #{files.size} migrations to db/migrate"
+    end
+  end
+  
+  def cleanup_migrations
+    target = "#{Rails.root}/db/migrate"
+    files = Dir["#{target}/*.rb"]
+    unless files.empty?
+      FileUtils.rm files
+      puts "removed #{files.size} migrations from db/migrate"
+    end
+    files = Dir["#{target}/app/*.rb"]
+    unless files.empty?
+      FileUtils.cp files, target
+      puts "copied #{files.size} migrations back to db/migrate"
+    end
+    FileUtils.rm_rf "#{target}/app"
+  end
+
+  def prepare_upgrade_migrations
+    dirs = Rails::Application::Railties.engines.map{|p| p.config.root.to_s}
+    dirs.each do |dir|
+      if File.directory? File.join(dir,'db/migrate/upgrade')
+        target = File.join(dir,'db/migrate/')
+        files = Dir["#{target}*.rb"]
+        unless files.empty?
+          FileUtils.mkdir_p "#{target}app/"
+          FileUtils.cp files, "#{target}app/"
+          puts "copied #{files.size} upgrade migrations to #{target}app"
+        end
+
+        files = Dir["#{File.join(dir,'db/migrate/upgrade')}/*.rb"]
+        FileUtils.cp files, File.join(dir,'db/migrate/')
+      end
+    end
+  end
+
+  def cleanup_upgrade_migrations
+    dirs = Rails::Application::Railties.engines.map{|p| p.config.root.to_s}
+    dirs.each do |dir|
+      if File.directory? File.join(dir,'db/migrate/app')
+        target = File.join(dir,'db/migrate/')
+        files = Dir["#{target}/*.rb"]
+        unless files.empty?
+          FileUtils.rm files
+          puts "removed #{files.size} migrations from #{target}"
+        end
+
+        files = Dir["#{target}/app/*.rb"]
+        unless files.empty?
+          FileUtils.cp files, target
+          puts "copied #{files.size} migrations back to #{target}"
+        end
+        FileUtils.rm_rf "#{target}/app"
+      end
+    end
+  end
+end

data/lib/erp_base_erp_svcs/extensions/active_record/sti_instantiation.rb

@@ -0,0 +1,37 @@
+module ErpBaseErpSvcs
+  module Extensions
+    module ActiveRecord
+      module StiInstantiation
+        module ActMacro
+          def instantiates_with_sti
+            include InstanceMethods
+            extend ClassMethods
+            instantiates_with_sti?
+          end
+
+          def instantiates_with_sti?
+            included_modules.include?(ErpBaseErpSvcs::Extensions::ActiveRecord::StiInstantiation::InstanceMethods)
+          end
+        end
+
+        module InstanceMethods
+        end
+
+        module ClassMethods
+          def new(*args, &block)
+            options = args.first.is_a?(Hash) ? args.first : {}
+            type = options[:type] || options['type']
+            klass = type.is_a?(Class) ? type : type.constantize if type
+
+            if type and klass != self
+              raise "STI instantiation error: class #{klass.name} should be a descendant of #{self.name}" unless klass < self
+              klass.new(*args, &block)
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erp_base_erp_svcs/extensions/core/array.rb

@@ -0,0 +1,20 @@
+Array.class_eval do
+
+  #convert all elements of array to symbols
+  #throw exception if all elements are not of class String
+  def to_sym
+    new_ary = []
+    old_ary = to_ary
+
+    old_ary.each do |item|
+      if item.class == String
+        new_ary << item.to_sym
+      else
+        throw "All array elements must be of class String to use to_sym"
+      end
+    end
+
+    new_ary
+  end
+
+end

data/lib/erp_base_erp_svcs/extensions/core/hash.rb

@@ -0,0 +1,19 @@
+Hash.class_eval do
+  #take keys of hash and transform those to a symbols
+  def self.symbolize_keys(item)
+    if item.class == Hash
+      item.to_options!
+      item.each do |key, value|
+        self.symbolize_keys(value)
+      end
+    elsif item.class == Array
+      item.each do |array_val|
+        self.symbolize_keys(array_val)
+      end
+    end
+
+    item
+  end
+
+end
+

data/lib/erp_base_erp_svcs/extensions/core/numbers.rb

@@ -0,0 +1,27 @@
+module ErpBaseErpSvcs
+	module Extensions
+	  module Core
+	    module Commas
+	      def commas
+    	    self.to_s =~ /([^\.]*)(\..*)?/
+    	    int, dec = $1.reverse, $2 ? $2 : ""
+    	    while int.gsub!(/(,|\.|^)(\d{3})(\d)/, '\1\2,\3')
+    	    end
+    	    int.reverse + dec
+    	  end
+	    end
+	  end
+	end
+end
+
+class Bignum
+	 include ErpBaseErpSvcs::Extensions::Core::Commas
+end   
+
+class Float
+	 include ErpBaseErpSvcs::Extensions::Core::Commas
+end
+
+class Fixnum
+	 include ErpBaseErpSvcs::Extensions::Core::Commas
+end

data/lib/erp_base_erp_svcs/extensions/core/object.rb

@@ -0,0 +1,6 @@
+Object.instance_eval do
+  def all_subclasses
+    klasses = self.subclasses
+    (klasses | klasses.collect do |klass| klass.all_subclasses end).flatten.uniq
+  end
+end