compass_ae_starter_kit 1.0.0

data/README.md

@@ -0,0 +1,66 @@
+
+Compass AE Starter Kit
+======================
+
+Want to get started using the Compass AE framework but think its too complicated, well below are 5 easy steps to get you started.
+
+##prerequisites
+
+* [Rails]       -- (~> 3.1.1)
+* [bundler]     --  (1.0.21 ruby)
+* [wkhtmltopdf] --  (used by pdfkit https://github.com/jdpace/PDFKit)
+* [ImageMagick] --  (used by quick_magick http://quickmagick.rubyforge.org/quick_magick/)
+* [Solr]        --  (used by sunspot http://outoftime.github.com/sunspot/ only needed if erp_search module is installed)
+
+
+##Installation (Gems Only)
+
+(Step 1) Create a new rails application
+
+    rails new compass_demo
+
+(Step 2) Add our local gem repository to your Gemfile
+
+    source 'http://development.compassagile.com:8080'
+
+(Step 3) Add compass_ae_starter_kit gem to your Gemfile
+
+    gem 'compass_ae_starter_kit'
+
+(Step 4) Bundle it up
+
+    bundle install
+
+(Step 5) Initialize the Compass AE framework
+
+    rake compass_ae_starter_kit:initialize
+
+Follow the instructions and Enjoy !
+
+##Notes
+
+### Options
+
+You can install all Compass AE engines via
+
+    rake compass_ae_starter_kit:install:all
+
+OR
+
+You can install all Compass AE engines except some
+
+    rake compass_ae_starter_kit:install:all except=erp_products,erp_rules
+
+OR
+
+You can install engines that you choose
+
+    rake compass_ae_starter_kit:install engines=erp_app,erp_forms,knitkit,rails_db_admin
+
+### Development
+
+If you want the source from our GIT repositories and not just the gems you can pass an optional argument to the install task
+
+    rake compass_ae_starter_kit:install:core development=true
+
+This will clone our GIT repositories and point your Gemfile.rb to them

data/config/compass_ae_engines.yml

@@ -0,0 +1,97 @@
+--- 
+- :name: erp_base_erp_svcs
+  :git: 
+    :name: Compass-AE-Kernel
+    :url: https://github.com/portablemind/Compass-AE-Kernel.git
+    :is_group: true
+- :name: erp_tech_svcs
+  :has_routes: true
+  :git: 
+    :name: Compass-AE-Kernel
+    :url: https://github.com/portablemind/Compass-AE-Kernel.git
+    :is_group: true
+- :name: erp_app
+  :has_routes: true
+  :git: 
+    :name: Application-Stack---Suite
+    :url: https://github.com/portablemind/Application-Stack---Suite.git
+    :is_group: true
+- :name: erp_forms
+  :has_routes: true
+  :git: 
+    :name: Application-Stack---Suite
+    :url: https://github.com/portablemind/Application-Stack---Suite.git
+    :is_group: true
+- :name: knitkit
+  :has_routes: true
+  :git: 
+    :name: Knitkit-CMS
+    :url: https://github.com/portablemind/Knitkit-CMS.git
+- :name: rails_db_admin
+  :has_routes: true
+  :git: 
+    :name: Rails-DB-Admin
+    :url: https://github.com/portablemind/Rails-DB-Admin.git
+- :name: compass_ae_console
+  :has_routes: true
+  :git:
+    :name: Compass-AE-Console
+    :url: https://github.com/portablemind/Compass-AE-Console.git
+- :name: erp_agreements
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_commerce
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_communication_events
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_financial_accounting
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_inventory
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_invoicing
+  :has_routes: true
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_orders
+  :has_routes: true
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_products
+  :has_routes: true
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_rules
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_txns_and_accts
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true
+- :name: erp_work_effort
+  :git: 
+    :name: Erp-Modules
+    :url: https://github.com/portablemind/Erp-Modules.git
+    :is_group: true

data/lib/compass_ae_starter_kit/engine.rb

@@ -0,0 +1,9 @@
+module CompassAeStarterKit
+  class Engine < Rails::Engine
+    isolate_namespace CompassAeStarterKit
+    
+    rake_tasks do
+      Dir[File.join('../',File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/compass_ae_starter_kit/file_support.rb

@@ -0,0 +1,37 @@
+module CompassAeStarterKit
+  class FileSupport
+    class << self
+
+      def patch_file(path, current, insert, options = {})
+        options = {
+          :patch_mode => :insert_after
+        }.merge(options)
+
+        old_text = current
+        new_text = patch_string(current, insert, options[:patch_mode])
+
+        content = File.open(path) { |f| f.read }
+        content.gsub!(old_text, new_text) unless content =~ /#{Regexp.escape(insert)}/mi
+        File.open(path, 'w') { |f| f.puts(content) }
+      end
+
+      def append_file(path, content)
+        File.open(path, 'a') { |f| f.puts(content) }
+      end
+
+      def patch_string(current, insert, mode = :insert_after)
+        case mode
+        when :change
+          "#{insert}"
+        when :insert_after
+          "#{current}\n#{insert}"
+        when :insert_before
+          "#{insert}\n#{current}"
+        else
+          patch_string(current, insert, :insert_after)
+        end
+      end
+      
+    end
+  end
+end

data/lib/compass_ae_starter_kit/version.rb

@@ -0,0 +1,3 @@
+module CompassAeStarterKit
+  VERSION = "1.0.0"
+end

data/lib/compass_ae_starter_kit.rb

@@ -0,0 +1,6 @@
+require 'compass_ae_starter_kit/file_support'
+require 'compass_ae_starter_kit/engine'
+
+module CompassAeStarterKit
+  
+end

data/lib/tasks/compass_ae_starter_kit.rake

@@ -0,0 +1,235 @@
+require 'yaml'
+require 'fileutils'
+
+namespace :compass_ae_starter_kit do
+  
+  desc 'sets up all configuration files and initilizers to run Compass AE'
+  task :initialize => :environment do
+    #remove public index file from Rails application so Compass AE splash will show
+    File.unlink 'public/index.html' rescue Errno::ENOENT
+    FileUtils.cp File.join(File.dirname(__FILE__),'../../public','index.html'), 'public/index.html'
+    
+    CompassAeStarterKit::FileSupport.patch_file 'config/initializers/session_store.rb',
+      "# #{Rails.application.class.parent_name}::Application.config.session_store :active_record_store",
+      "  #{Rails.application.class.parent_name}::Application.config.session_store :active_record_store",
+      :patch_mode => :change
+
+    CompassAeStarterKit::FileSupport.patch_file 'config/environments/production.rb',
+      "  config.serve_static_assets = false",
+      "  config.serve_static_assets = true",
+      :patch_mode => :change
+
+    CompassAeStarterKit::FileSupport.patch_file 'config/environments/production.rb',
+      "  config.assets.compile = false",
+      "  config.assets.compile = true",
+      :patch_mode => :change
+
+    puts <<-end
+
+      Thanks for initializing Compass AE!
+
+      We've performed the following tasks:
+
+      * Replaced the index.html page from /public with our Compass AE splash screen
+      * patched config/initializers/session_store.rb to use ActiveRecord for your session store
+      * patched config/environments/production.rb and set config.serve_static_assets = true
+      * patched config/environments/production.rb and set config.assets.compile = true
+
+      Next Steps:
+
+      Install the Compass AE frameworks core engines
+
+      If you only want the gems and not the source:
+      
+      rake compass_ae_starter_kit:install:core
+
+      If you want to clone the git repositories and have the source for development
+
+      rake compass_ae_starter_kit:install:core development=true
+
+      enjoy!
+
+    end
+  end
+
+  namespace :install do
+    desc 'install core Compass AE engines'
+    task :core do
+      ENV['engines'] = 'core'
+      Rake::Task['compass_ae_starter_kit:install'].invoke
+    end
+
+    desc 'install all Compass AE engines'
+    task :all do
+      ENV['engines'] = 'all'
+      Rake::Task['compass_ae_starter_kit:install'].invoke
+    end
+    
+  end#:install
+
+  desc 'install selected compass engines (engines=core or engines=all or engines=name1,name2)'
+  task :install  => :environment do
+    # call the perform method set to :install
+    engines = perform(:install_engines)
+    
+    puts "Installed the following engines #{engines.collect{|engine|engine[:name]}.join(',')}"
+
+    puts <<-end
+
+      Thanks for installing Compass AE!
+
+      We've performed the following tasks:
+
+      * Updated your Gemfile with the installed engines
+      * patched config/routes.rb to mount the engines
+
+      Next Steps:
+
+      1. bundle install
+      2. rake db:migrate
+      3. rake db:migrate_data
+
+      Then startup your server...
+
+      rails s
+      open http://localhost:3000/
+
+      You should see the Compass AE Splash screen.
+
+      To Login to either the desktop or organizer the credentials are:
+
+      username: admin
+      passwrod: password
+
+      enjoy!
+
+    end
+
+  end
+
+  namespace :uninstall do
+    desc 'uninstall core Compass AE engines'
+    task :core do
+      ENV['engines'] = 'core'
+      Rake::Task['compass_ae_starter_kit:uninstall'].invoke
+    end
+
+    desc 'uninstall all Compass AE engines'
+    task :all do
+      ENV['engines'] = 'all'
+      Rake::Task['compass_ae_starter_kit:uninstall'].invoke
+    end
+    
+  end#:uninstall
+
+  desc 'uninstall selected compass engines (engines=core or engines=all or engines=name1,name2)'
+  task :uninstall  => :environment do
+    # call the perform set to :uninstall
+    engines = perform(:uninstall_engines)
+
+    puts "Uninstalled the following engines #{engines.collect{|engine|engine[:name]}.join(',')}"
+  end
+
+  def perform(method)
+    except = ENV['except'] ? ENV['except'].split(',') : []
+
+    engines = case ENV['engines']
+    when 'all'
+      all_engines
+    when 'core'
+      core_engines
+    else
+	  select_engines(ENV['engines'].split(','))
+    end
+
+    #remove exceptions
+    except.each do |exception_engine|
+      engines.delete_if{|engine| engine[:name] == exception_engine}
+    end
+    
+    send(method, engines, ENV['development']) if !engines.nil? and !engines.blank?
+
+    engines
+  end
+
+  def load_engines
+    YAML.load_file(File.join(File.dirname(__FILE__),'../../config','compass_ae_engines.yml'))
+  end
+
+  def all_engines
+    load_engines
+  end
+  
+  def core_engines
+	select_engines(%w{erp_base_erp_svcs erp_tech_svcs erp_app erp_forms knitkit rails_db_admin compass_ae_console})
+  end
+  
+  def select_engines(names)
+	all_engines.select{|engine| names.include?(engine[:name])}
+  end
+
+  def install_engines(engines, development=false)
+    installed_engines = Rails::Application::Railties.engines.collect{|e| e.railtie_name.camelize}
+
+    engines.each do |engine|
+      unless installed_engines.include?(engine[:name].camelize)
+        if engine[:has_routes]
+          CompassAeStarterKit::FileSupport.patch_file 'config/routes.rb',
+            "#{Rails.application.class.parent_name}::Application.routes.draw do",
+            " mount #{engine[:name].camelize}::Engine => '/#{engine[:name]}'",
+            :patch_mode => :insert_after
+        end
+
+        if development
+          git_settings = engine[:git]
+          git_path = File.join(Rails.root,'lib/compass')
+          FileUtils.mkdir_p git_path unless File.directory? git_path
+          
+          engine_repo = File.join(git_path,git_settings[:name])
+          
+          unless File.directory? engine_repo
+            Dir.chdir git_path
+            `git clone #{git_settings[:url]}`
+
+            Dir.chdir engine_repo
+            `git checkout`
+
+            Dir.chdir Rails.root
+          end
+
+          gem_path = git_settings[:is_group] ? File.join(engine_repo,engine[:name]) : engine_repo
+
+          CompassAeStarterKit::FileSupport.append_file 'Gemfile',
+            "gem '#{engine[:name]}', :path => '#{gem_path}'"
+        else
+          CompassAeStarterKit::FileSupport.append_file 'Gemfile',
+            "gem '#{engine[:name]}'"
+        end
+        
+      end
+    end
+
+  end
+
+  def uninstall_engines(engines)
+    installed_engines = Rails::Application::Railties.engines.collect{|e| e.railtie_name.camelize}
+
+    engines.each do |engine|
+      if installed_engines.include?(engine[:name].camelize)
+        CompassAeStarterKit::FileSupport.patch_file 'Gemfile',
+          "gem '#{engine[:name]}'",
+          " ",
+          :patch_mode => :change
+
+        if engine[:has_routes]
+          CompassAeStarterKit::FileSupport.patch_file 'config/routes.rb',
+            "#{Rails.application.class.parent_name}::Application.routes.draw do",
+            " mount #{engine[:name].camelize}::Engine => '/#{engine[:name]}'",
+            " ",
+            :patch_mode => :change
+        end
+      end
+    end
+  end
+
+end#:compass_ae_starter_kit

data/public/index.html

@@ -0,0 +1,221 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>compass_install_splash</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+<!-- Save for Web Styles (compass_install_splash.psd) -->
+<style type="text/css">
+<!--
+
+a img {
+  border-style: none;
+}
+
+div.Table_01 {
+  position: absolute;
+  left: 50%;
+  margin-left: -512px;
+  top:0px;
+  width:1024px;
+  height:768px;
+}
+
+div.main-bg_ {
+  position:absolute;
+  left:0px;
+  top:0px;
+  width:100%;
+  height:768px;
+  
+}
+
+div.compass-install-splash-02_ {
+  position:absolute;
+  left:15px;
+  top:0px;
+  width:1009px;
+  height:97px;
+}
+
+div.compass-install-splash-03_ {
+  position:absolute;
+  left:15px;
+  top:97px;
+  width:232px;
+  height:311px;
+}
+
+div.compass-logo_ {
+  position:absolute;
+  left:247px;
+  top:97px;
+  width:538px;
+  height:274px;
+}
+
+div.compass-install-splash-05_ {
+  position:absolute;
+  left:785px;
+  top:97px;
+  width:239px;
+  height:311px;
+}
+
+div.compass-install-splash-06_ {
+  position:absolute;
+  left:247px;
+  top:371px;
+  width:538px;
+  height:37px;
+}
+
+div.browse-docs-icon_ {
+  position:absolute;
+  left:180px;
+  top:408px;
+  width:285px;
+  height:254px;
+}
+
+div.desktop-icon_ {
+  position:absolute;
+  left:450px;
+  top:408px;
+  width:214px;
+  height:254px;
+}
+
+div.contact-mgt-icon_ {
+  position:absolute;
+  left:650px;
+  top:408px;
+  width:295px;
+  height:254px;
+}
+
+div.compass-install-splash-11_ {
+  position:absolute;
+  left:15px;
+  top:662px;
+  width:461px;
+  height:87px;
+}
+
+div.tn-logo_ {
+  position:absolute;
+  left:476px;
+  top:662px;
+  width:77px;
+  height:71px;
+}
+
+div.compass-install-splash-13_ {
+  position:absolute;
+  left:553px;
+  top:662px;
+  width:471px;
+  height:87px;
+}
+
+div.compass-install-splash-14_ {
+  position:absolute;
+  left:476px;
+  top:733px;
+  width:77px;
+  height:16px;
+}
+
+div.compass-install-splash-15_ {
+  position:absolute;
+  left:15px;
+  top:749px;
+  width:330px;
+  height:19px;
+}
+
+div.sponsored-by_ {
+  position:absolute;
+  left:345px;
+  top:749px;
+  width:342px;
+  height:19px;
+}
+
+div.compass-install-splash-17_ {
+  position:absolute;
+  left:687px;
+  top:749px;
+  width:337px;
+  height:19px;
+}
+
+-->
+</style>
+<!-- End Save for Web Styles -->
+</head>
+<body style="background-image:url(images/splash_screen/main_bg.png); ">
+<!-- Save for Web Slices (compass_install_splash.psd) -->
+
+
+
+<div class="Table_01">
+  <div class="main-bg_">
+    <img id="main_bg" src="images/splash_screen/main_bg.png" width="15" height="768" alt="" />
+  </div>
+  <div class="compass-install-splash-02_">
+    <img id="compass_install_splash_02" src="images/splash_screen/compass_install_splash_02.png" width="1009" height="97" alt="" />
+  </div>
+  <div class="compass-install-splash-03_">
+    <img id="compass_install_splash_03" src="images/splash_screen/compass_install_splash_03.png" width="232" height="311" alt="" />
+  </div>
+  <div class="compass-logo_">
+    <img id="compass_logo" src="images/splash_screen/compass_logo.png" width="538" height="274" alt="" />
+  </div>
+  <div class="compass-install-splash-05_">
+    <img id="compass_install_splash_05" src="images/splash_screen/compass_install_splash_05.png" width="239" height="311" alt="" />
+  </div>
+  <div class="compass-install-splash-06_">
+    <img id="compass_install_splash_06" src="images/splash_screen/compass_install_splash_06.png" width="538" height="37" alt="" />
+  </div>
+  <div class="browse-docs-icon_">
+    <a href="http://www.portablemind.com" style="border-style: none;">    
+      <img id="browse_docs_icon" src="images/splash_screen/browse_docs_icon.png" width="285" height="254" alt="" />
+    </a>
+  </div>
+  <div class="desktop-icon_">
+    <a href="/erp_app/desktop/" style="border-style: none;">    
+      <img id="desktop_icon" src="images/splash_screen/desktop_icon.png" width="214" height="254" alt="" />
+    </a>
+  </div>
+  <div class="contact-mgt-icon_">
+    <a href="/erp_app/organizer/" style="border-style: none;">
+      <img id="contact_mgt_icon" src="images/splash_screen/contact_mgt_icon.png" width="295" height="254" alt="" style="border-style: none;"/>
+    </a>
+  </div>
+  <div class="compass-install-splash-11_">
+    <img id="compass_install_splash_11" src="images/splash_screen/compass_install_splash_11.png" width="461" height="87" alt="" />
+  </div>
+  <div class="tn-logo_">
+    <img id="tn_logo" src="images/splash_screen/tn_logo.png" width="77" height="71" alt="" />
+  </div>
+  <div class="compass-install-splash-13_">
+    <img id="compass_install_splash_13" src="images/splash_screen/compass_install_splash_13.png" width="471" height="87" alt="" />
+  </div>
+  <div class="compass-install-splash-14_">
+    <img id="compass_install_splash_14" src="images/splash_screen/compass_install_splash_14.png" width="77" height="16" alt="" />
+  </div>
+  <div class="compass-install-splash-15_">
+    <img id="compass_install_splash_15" src="images/splash_screen/compass_install_splash_15.png" width="330" height="19" alt="" />
+  </div>
+  <div class="sponsored-by_">
+    <img id="sponsored_by" src="images/splash_screen/sponsored_by.png" width="342" height="19" alt="" />
+  </div>
+  <div class="compass-install-splash-17_">
+    <img id="compass_install_splash_17" src="images/splash_screen/compass_install_splash_17.png" width="337" height="19" alt="" />
+  </div>
+</div>
+
+
+<!-- End Save for Web Slices -->
+</body>
+</html>