offroad 0.0.2 → 0.0.3

data/lib/module_funcs.rb

@@ -1,94 +1,94 @@
-module Offroad
-  @@app_online_flag = nil
-  @@group_base_model = nil
-  @@global_data_models = {}
-  @@group_owned_models = {}
-  @@group_single_models = {}
-  
-  # Used in the environment configuration file to set the app to online or offline mode.
-  # This should not be called from within the app.
-  def self.config_app_online(flag)
-    @@app_online_flag = flag
-  end
-  
-  # Returns true if the app is in offline mode (running on a local system without access to the main server)
-  def self.app_offline?
-    not app_online?
-  end
-  
-  # Returns true if the app is in online mode (or in other words, this is the main server)
-  def self.app_online?
-    case @@app_online_flag
-      when true then true
-      when false then false
-      else raise AppModeUnknownError.new
-    end
-  end
-  
-  # Returns a Time that identifies the version of the app
-  # Specifically, the modification timestamp (on the online app) of the most recently modified source file in the app
-  def self.app_version
-    # TODO Implement
-    # Online - When app is launched, scan all application files, returns the Time of the most recently changed file
-    # Offline - Based on the app version noted in the last down-mirror file successfully loaded
-    return 1
-  end
-  
-  #:nodoc#
-  def self.init
-    @@config = YAML.load_file(File.join(RAILS_ROOT, "config", "offroad.yml"))
-  end
-  
-  # Returns the record of the group base model that this app is in charge of
-  # This is only applicable if the app is offline
-  def self.offline_group
-    raise PluginError.new("'Offline group' is only meaningful if the app is offline") unless app_offline?
-    group_base_model.first
-  end
-  
-  private
-  
-  def self.online_url
-    @@config[:online_url] or raise PluginError.new("No online url specified in offroad config")
-  end
-  
-  def self.app_name
-    @@config[:app_name] or raise PluginError.new("No app name specified in offroad config")
-  end
-  
-  def self.note_global_data_model(cls)
-    @@global_data_models[cls.name] = cls
-  end
-  
-  def self.global_data_models
-    @@global_data_models
-  end
-  
-  def self.note_group_base_model(cls)
-    if @@group_base_model and @@group_base_model.to_s != cls.to_s
-      raise ModelError.new("You can only define one group base model")
-    end
-    @@group_base_model = cls
-  end
-  
-  def self.group_base_model
-    raise ModelError.new("No group base model was specified") unless @@group_base_model
-    @@group_base_model
-  end
-  
-  def self.note_group_owned_model(cls)
-    @@group_owned_models[cls.name] = cls
-  end
-  
-  def self.group_owned_models
-    @@group_owned_models
-  end
-  
-  def self.note_group_single_model(cls)
-    @@group_single_models[cls.name] = cls
-  end
-  
-  def self.group_single_models
-    @@group_single_models
-  end
-end
+module Offroad
+  @@app_online_flag = nil
+  @@group_base_model = nil
+  @@global_data_models = {}
+  @@group_owned_models = {}
+  @@group_single_models = {}
+  
+  # Used in the environment configuration file to set the app to online or offline mode.
+  # This should not be called from within the app.
+  def self.config_app_online(flag)
+    @@app_online_flag = flag
+  end
+  
+  # Returns true if the app is in offline mode (running on a local system without access to the main server)
+  def self.app_offline?
+    not app_online?
+  end
+  
+  # Returns true if the app is in online mode (or in other words, this is the main server)
+  def self.app_online?
+    case @@app_online_flag
+      when true then true
+      when false then false
+      else raise AppModeUnknownError.new
+    end
+  end
+  
+  # Returns a Time that identifies the version of the app
+  # Specifically, the modification timestamp (on the online app) of the most recently modified source file in the app
+  def self.app_version
+    # TODO Implement
+    # Online - When app is launched, scan all application files, returns the Time of the most recently changed file
+    # Offline - Based on the app version noted in the last down-mirror file successfully loaded
+    return 1
+  end
+  
+  #:nodoc#
+  def self.init
+    @@config = YAML.load_file(File.join(RAILS_ROOT, "config", "offroad.yml"))
+  end
+  
+  # Returns the record of the group base model that this app is in charge of
+  # This is only applicable if the app is offline
+  def self.offline_group
+    raise PluginError.new("'Offline group' is only meaningful if the app is offline") unless app_offline?
+    group_base_model.first
+  end
+  
+  private
+  
+  def self.online_url
+    @@config[:online_url] or raise PluginError.new("No online url specified in offroad config")
+  end
+  
+  def self.app_name
+    @@config[:app_name] or raise PluginError.new("No app name specified in offroad config")
+  end
+  
+  def self.note_global_data_model(cls)
+    @@global_data_models[cls.name] = cls
+  end
+  
+  def self.global_data_models
+    @@global_data_models
+  end
+  
+  def self.note_group_base_model(cls)
+    if @@group_base_model and @@group_base_model.to_s != cls.to_s
+      raise ModelError.new("You can only define one group base model")
+    end
+    @@group_base_model = cls
+  end
+  
+  def self.group_base_model
+    raise ModelError.new("No group base model was specified") unless @@group_base_model
+    @@group_base_model
+  end
+  
+  def self.note_group_owned_model(cls)
+    @@group_owned_models[cls.name] = cls
+  end
+  
+  def self.group_owned_models
+    @@group_owned_models
+  end
+  
+  def self.note_group_single_model(cls)
+    @@group_single_models[cls.name] = cls
+  end
+  
+  def self.group_single_models
+    @@group_single_models
+  end
+end

data/lib/offroad.rb

@@ -1,41 +1,41 @@
-# Offroad
-
-require 'version'
-require 'module_funcs'
-require 'cargo_streamer'
-require 'exceptions'
-require 'mirror_data'
-
-path = File.join(File.dirname(__FILE__), 'app', 'models')
-$LOAD_PATH << path
-ActiveSupport::Dependencies.autoload_paths << path
-
-require 'ar-extensions' # External dependency
-# Monkey patch a bug in ar-extensions which breaks postgres compatibility
-module ActiveRecord # :nodoc:
-  module ConnectionAdapters # :nodoc:
-    class AbstractAdapter # :nodoc:
-      def next_value_for_sequence(sequence_name)
-        %{nextval('#{sequence_name}')}
-      end
-    end
-  end
-end
-
-
-require 'controller_extensions'
-class ActionController::Base
-  extend Offroad::ControllerExtensions
-end
-
-require 'model_extensions'
-class ActiveRecord::Base
-  extend Offroad::ModelExtensions
-end
-
-require 'view_helper'
-class ActionView::Base
-  include Offroad::ViewHelper
-end
-
-Offroad::init
+# Offroad
+
+require 'version'
+require 'module_funcs'
+require 'cargo_streamer'
+require 'exceptions'
+require 'mirror_data'
+
+path = File.join(File.dirname(__FILE__), 'app', 'models')
+$LOAD_PATH << path
+ActiveSupport::Dependencies.autoload_paths << path
+
+require 'ar-extensions' # External dependency
+# Monkey patch a bug in ar-extensions which breaks postgres compatibility
+module ActiveRecord # :nodoc:
+  module ConnectionAdapters # :nodoc:
+    class AbstractAdapter # :nodoc:
+      def next_value_for_sequence(sequence_name)
+        %{nextval('#{sequence_name}')}
+      end
+    end
+  end
+end
+
+
+require 'controller_extensions'
+class ActionController::Base
+  extend Offroad::ControllerExtensions
+end
+
+require 'model_extensions'
+class ActiveRecord::Base
+  extend Offroad::ModelExtensions
+end
+
+require 'view_helper'
+class ActionView::Base
+  include Offroad::ViewHelper
+end
+
+Offroad::init

data/lib/version.rb

@@ -1,3 +1,3 @@
-module Offroad
-  VERSION = "0.0.2"
-end
+module Offroad
+  VERSION = "0.0.3"
+end

data/lib/view_helper.rb

@@ -1,7 +1,7 @@
-module Offroad
-  module ViewHelper
-    def link_to_online_app(name = nil)
-      link_to(name ? name : Offroad::online_url, Offroad::online_url)
-    end
-  end
-end
+module Offroad
+  module ViewHelper
+    def link_to_online_app(name = nil)
+      link_to(name ? name : Offroad::online_url, Offroad::online_url)
+    end
+  end
+end

data/templates/offline.rb

@@ -1,36 +1,36 @@
-# This file defines the offline envrionment
-# "Offline" means that the application is running on a local network, with only a subset of the real online app's data
-# It is implemented by the gem Offroad 
-
-# Settings specified here will take precedence over those in config/environment.rb
-
-# Use the offline database configuration file instead of the regular one
-config.database_configuration_file = "config/offline_database.yml"
-
-# Code is not reloaded between requests
-config.cache_classes = true
-
-# Full error reports are disabled and caching is turned on
-config.action_controller.consider_all_requests_local = false
-config.action_controller.perform_caching             = true
-config.action_view.cache_template_loading            = true
-
-# See everything in the log (default is :info)
-# config.log_level = :debug
-
-# Use a different logger for distributed setups
-# config.logger = SyslogLogger.new
-
-# Use a different cache store in production
-# config.cache_store = :mem_cache_store
-
-# Enable serving of images, stylesheets, and javascripts from an asset server
-# config.action_controller.asset_host = "http://assets.example.com"
-
-# Disable delivery errors, bad email addresses will be ignored
-# config.action_mailer.raise_delivery_errors = false
-
-# Enable threaded mode
-# config.threadsafe!
-
-Offroad::config_app_online(false)
+# This file defines the offline envrionment
+# "Offline" means that the application is running on a local network, with only a subset of the real online app's data
+# It is implemented by the gem Offroad 
+
+# Settings specified here will take precedence over those in config/environment.rb
+
+# Use the offline database configuration file instead of the regular one
+config.database_configuration_file = "config/offline_database.yml"
+
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!
+
+Offroad::config_app_online(false)

data/templates/offline_database.yml

@@ -1,7 +1,7 @@
-# This database config file is used by the 'offline' environment
-
-offline:
-  adapter: sqlite3
-  database: db/offline.sqlite3
-  pool: 5
-  timeout: 5000
+# This database config file is used by the 'offline' environment
+
+offline:
+  adapter: sqlite3
+  database: db/offline.sqlite3
+  pool: 5
+  timeout: 5000

data/templates/offroad.yml

@@ -1,6 +1,6 @@
-# Configuration for Offroad
-# :online_url: The URL for the regular online version of the app 
-# :app_name: The name of the application, to be used in helpful messages in the generated mirror data files.
-
-:online_url: "http://example.com"
-:app_name: Example Application
+# Configuration for Offroad
+# :online_url: The URL for the regular online version of the app 
+# :app_name: The name of the application, to be used in helpful messages in the generated mirror data files.
+
+:online_url: "http://example.com"
+:app_name: Example Application

data/test/app_root/app/controllers/application_controller.rb

@@ -1,2 +1,2 @@
-class ApplicationController < ActionController::Base
-end
+class ApplicationController < ActionController::Base
+end

data/test/app_root/app/controllers/group_controller.rb

@@ -1,28 +1,28 @@
-class GroupController < ApplicationController
-  offroad_group_controller
-
-  def download_down_mirror
-    render_down_mirror_file Group.find(params[:id]), "down-mirror-file", :layout => "mirror"
-  end
-  
-  def download_initial_down_mirror
-    render_down_mirror_file Group.find(params[:id]), "down-mirror-file", :layout => "mirror", :initial_mode => true
-  end
-  
-  def download_up_mirror
-    render_up_mirror_file Group.find(params[:id]), "up-mirror-file", :layout => "mirror"
-  end
-  
-  def upload_up_mirror
-    load_up_mirror_file Group.find(params[:id]), params[:mirror_data]
-  end
-  
-  def upload_down_mirror
-    load_down_mirror_file Group.find(params[:id]), params[:mirror_data]
-  end
-  
-  def upload_initial_down_mirror
-    load_down_mirror_file nil, params[:mirror_data], :initial_mode => true
-    render :upload_down_mirror
-  end
-end
+class GroupController < ApplicationController
+  offroad_group_controller
+
+  def download_down_mirror
+    render_down_mirror_file Group.find(params[:id]), "down-mirror-file", :layout => "mirror"
+  end
+  
+  def download_initial_down_mirror
+    render_down_mirror_file Group.find(params[:id]), "down-mirror-file", :layout => "mirror", :initial_mode => true
+  end
+  
+  def download_up_mirror
+    render_up_mirror_file Group.find(params[:id]), "up-mirror-file", :layout => "mirror"
+  end
+  
+  def upload_up_mirror
+    load_up_mirror_file Group.find(params[:id]), params[:mirror_data]
+  end
+  
+  def upload_down_mirror
+    load_down_mirror_file Group.find(params[:id]), params[:mirror_data]
+  end
+  
+  def upload_initial_down_mirror
+    load_down_mirror_file nil, params[:mirror_data], :initial_mode => true
+    render :upload_down_mirror
+  end
+end