offroad 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,29 +1,29 @@
-*NOTE*: This gem is a work in progress. It does work, but it's not especially convenient, yet.
-Better documentation and scripts will follow in time.
-
-*NOTE*: Currently the gem is only compatible with Rails 2.
-
-== Overview
-
-This gem allows users without Internet access to still use your app. It requires that your application can
-be thought of in the following way:
-
-Your site is broken down into a set of "groups" or "organizations". Each group has their own distinct set of
-records, which are editable by only a distinct set of a users. Besides that, there are global records that can
-only be edited by overall site administrators, though they can possibly be viewed by regular users.
-
-In order to make offline use of your app possible, Offroad will generate an installer bundle, which is an
-OS-specific executable that can install Ruby, Rails, and also a launcher which controls a local instance of
-WEBrick and manages imports and exports. The installer and launcher will be visually labelled everywhere with
-the name of the Rails app itself, making its function obvious to users. This launcher can generate up-mirror
-files, which are transported on a USB thumbdrive or some other medium to an online system, where they can be
-uploaded to the main app site. After having done an upload, the user is prompted to download a down-mirror
-file which contains any changes to the global records, and bring this back to the offline system, which
-completes the sneakernet round-trip.
-
-Rather than sending all data, only globally accessible records and updates to the app itself are transferred
-in the down-mirror (except for the first down-mirror, which also contains the initial set of records for the
-group). Furthermore, the offline version of the app is considered be the absolutely canonical source of that
-group's records; really, this is not a "sync", it's a "mirror". This means that no-one on the online site can
-make changes to an offline group's records, not even the administrator; this is enforced by Offroad at a
-low level.
+*NOTE*: This gem is a work in progress. It does work, but it's not especially convenient, yet.
+Better documentation and scripts will follow in time.
+
+*NOTE*: Currently the gem is only compatible with Rails 2.
+
+== Overview
+
+This gem allows users without Internet access to still use your app. It requires that your application can
+be thought of in the following way:
+
+Your site is broken down into a set of "groups" or "organizations". Each group has their own distinct set of
+records, which are editable by only a distinct set of a users. Besides that, there are global records that can
+only be edited by overall site administrators, though they can possibly be viewed by regular users.
+
+In order to make offline use of your app possible, Offroad will generate an installer bundle, which is an
+OS-specific executable that can install Ruby, Rails, and also a launcher which controls a local instance of
+WEBrick and manages imports and exports. The installer and launcher will be visually labelled everywhere with
+the name of the Rails app itself, making its function obvious to users. This launcher can generate up-mirror
+files, which are transported on a USB thumbdrive or some other medium to an online system, where they can be
+uploaded to the main app site. After having done an upload, the user is prompted to download a down-mirror
+file which contains any changes to the global records, and bring this back to the offline system, which
+completes the sneakernet round-trip.
+
+Rather than sending all data, only globally accessible records and updates to the app itself are transferred
+in the down-mirror (except for the first down-mirror, which also contains the initial set of records for the
+group). Furthermore, the offline version of the app is considered be the absolutely canonical source of that
+group's records; really, this is not a "sync", it's a "mirror". This means that no-one on the online site can
+make changes to an offline group's records, not even the administrator; this is enforced by Offroad at a
+low level.

data/Rakefile

@@ -1,75 +1,75 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-
-def common_test_settings(t)
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Default: run unit and functional tests.'
-task :default => :test
-
-desc 'Test Offroad'
-Rake::TestTask.new(:test) do |t|
-  common_test_settings(t)
-end
-
-desc 'Generate documentation for Offroad.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Offroad'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'rcov/rcovtask'
-  
-  Rcov::RcovTask.new(:rcov) do |t|
-    common_test_settings(t)
-    t.pattern = 'test/unit/*_test.rb' # Don't care about coverage added by functional tests
-    t.rcov_opts << '-o coverage -x "/ruby/,/gems/,/test/,/migrate/"'
-  end
-rescue LoadError
-  # Rcov wasn't available
-end
-
-begin
-  require 'ruby-prof/task'
-  
-  RubyProf::ProfileTask.new(:profile) do |t|
-    common_test_settings(t)
-    t.output_dir = "#{File.dirname(__FILE__)}/profile"
-    t.printer = :call_tree
-    t.min_percent = 10
-  end
-rescue LoadError
-  # Ruby-prof wasn't available
-end
-
-require 'lib/version'
-gemspec = Gem::Specification.new do |s|
-  s.name         = "offroad"
-  s.version      = Offroad::VERSION
-  s.authors      = ["David Mike Simon"]
-  s.email        = "david.mike.simon@gmail.com"
-  s.homepage     = "http://github.com/DavidMikeSimon/offroad"
-  s.summary      = "Manages off-Internet instances of a Rails app"
-  s.description  = "Offroad manages offline instances of a Rails app on computers without Internet access. The online and offline instances can communicate via mirror files, transported by the user via thumbdrive, burned CD, etc."
-
-  s.files        = `git ls-files .`.split("\n") - [".gitignore"]
-  s.platform     = Gem::Platform::RUBY
-  s.require_path = 'lib'
-  s.rubyforge_project = '[none]'
-
-  s.add_dependency('ar-extensions', '0.9.4')
-end
-
-Rake::GemPackageTask.new(gemspec) do |pkg|
-end
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+def common_test_settings(t)
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Default: run unit and functional tests.'
+task :default => :test
+
+desc 'Test Offroad'
+Rake::TestTask.new(:test) do |t|
+  common_test_settings(t)
+end
+
+desc 'Generate documentation for Offroad.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Offroad'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  
+  Rcov::RcovTask.new(:rcov) do |t|
+    common_test_settings(t)
+    t.pattern = 'test/unit/*_test.rb' # Don't care about coverage added by functional tests
+    t.rcov_opts << '-o coverage -x "/ruby/,/gems/,/test/,/migrate/"'
+  end
+rescue LoadError
+  # Rcov wasn't available
+end
+
+begin
+  require 'ruby-prof/task'
+  
+  RubyProf::ProfileTask.new(:profile) do |t|
+    common_test_settings(t)
+    t.output_dir = "#{File.dirname(__FILE__)}/profile"
+    t.printer = :call_tree
+    t.min_percent = 10
+  end
+rescue LoadError
+  # Ruby-prof wasn't available
+end
+
+require 'lib/version'
+gemspec = Gem::Specification.new do |s|
+  s.name         = "offroad"
+  s.version      = Offroad::VERSION
+  s.authors      = ["David Mike Simon"]
+  s.email        = "david.mike.simon@gmail.com"
+  s.homepage     = "http://github.com/DavidMikeSimon/offroad"
+  s.summary      = "Manages off-Internet instances of a Rails app"
+  s.description  = "Offroad manages offline instances of a Rails app on computers without Internet access. The online and offline instances can communicate via mirror files, transported by the user via thumbdrive, burned CD, etc."
+
+  s.files        = `git ls-files .`.split("\n") - [".gitignore"]
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.rubyforge_project = '[none]'
+
+  s.add_dependency('ar-extensions', '0.9.4')
+end
+
+Rake::GemPackageTask.new(gemspec) do |pkg|
+end

data/TODO

@@ -1,42 +1,42 @@
-High priority:
-- Creating/updating the installer (ideally, git pull on target platform, one rake task, then git push)
-- Add a generate task to initialize config files in a Rails app
-- Documentation
-- Resolve issue of too-long index names
-
-Low priority:
-- Make unit tests against bugs fixed by 7f8415 and 31455d
-  - Try to come up with some more convenient way of building unit-test-specific model classes
-- Make sure ModelStates don't continue to stick around and cause trouble even after a class no longer acts_as_offroadable
-- Get README into the auto-generated gem rdocs
-- Get the test suite to stop generating a log file, it's annoying
-- Use finer-grained exceptions to allow for better error testing
-- Don't allow group_single records to reference non-single group records, since group_single "ownership" can change
-- Don't assume "id" as primary key name, always look it up with the appropriate ActiveRecord method
-- Allow offline app to relinquish ownership by setting a belongs_to field to 0 or NULL
-- Figure out why Hobo assumes all fields non-editable (something I'm doing in the patched-in updatable check...)
-- Assign a random number to group state when it is created, only accept mirror files with matching random number
-  - This is to prevent confusion if a group is made offline, then online, then offline again
-- Also assign a random number to the online app, and only accept mirror files which match this number as well
-  - Prevents multiple installations of an app from reading each others' mirror files
-- Use read transactions for mirror write operations (is it already doing this?)
-- The launcher should keep a log file
-- Include recent log lines (for both Rails and the launcher) in generated up-mirror files, for debugging purposes
-- Use rails logger to note activity
-- When mirror data version is confirmed, delete all sendable record state entries for deletions older than min(version) over all group_states
-- Try to gather some kind of machine identifier to put in a offline-owned group_state column
-- Try streaming out with large data sets and make sure it is sufficiently speedy, and is actually streaming (i.e. no Content-Length header)
-- Change mime-type of mirror files being downloaded to something that doesn't allow it to be accidentally viewed in-browser
-- Use md5sum on the entire cargo file instead of just each individual part, to protect against corruption outside the actual data segments
-- Allow app to optionally specify batch sizes on a model-by-model basis
-- Mirror file imports in the down mirror app should happen through GUI, and GUI should delete files once succesfully imported
-- If offline app attempts to import a down mirror file and it doesn't work, it should:
-  - Delete the down mirror file as usual, but...
-  - Explain that it wasn't imported and that another down mirror file should be downloaded
-- Figure out which activerecord methods skip the save callbacks, and wrap them to also update the mirror version
-  - Maybe methods for which this isn't practical should raise an error when called...
-- Load all the other informational values in GroupState
-- App creates a record then deletes it then sends mirror; does a deletion srs still get sent?
-  - For any fix to this: make sure that if app updates record then deletes it then sends mirror that deletion gets sent
-  - Maybe that means we need both create_version and update_version on srs?
-- Put the CargoStreamer into its own gem, it might be handy for other stuff
+High priority:
+- Creating/updating the installer (ideally, git pull on target platform, one rake task, then git push)
+- Add a generate task to initialize config files in a Rails app
+- Documentation
+- Resolve issue of too-long index names
+
+Low priority:
+- Make unit tests against bugs fixed by 7f8415 and 31455d
+  - Try to come up with some more convenient way of building unit-test-specific model classes
+- Make sure ModelStates don't continue to stick around and cause trouble even after a class no longer acts_as_offroadable
+- Get README into the auto-generated gem rdocs
+- Get the test suite to stop generating a log file, it's annoying
+- Use finer-grained exceptions to allow for better error testing
+- Don't allow group_single records to reference non-single group records, since group_single "ownership" can change
+- Don't assume "id" as primary key name, always look it up with the appropriate ActiveRecord method
+- Allow offline app to relinquish ownership by setting a belongs_to field to 0 or NULL
+- Figure out why Hobo assumes all fields non-editable (something I'm doing in the patched-in updatable check...)
+- Assign a random number to group state when it is created, only accept mirror files with matching random number
+  - This is to prevent confusion if a group is made offline, then online, then offline again
+- Also assign a random number to the online app, and only accept mirror files which match this number as well
+  - Prevents multiple installations of an app from reading each others' mirror files
+- Use read transactions for mirror write operations (is it already doing this?)
+- The launcher should keep a log file
+- Include recent log lines (for both Rails and the launcher) in generated up-mirror files, for debugging purposes
+- Use rails logger to note activity
+- When mirror data version is confirmed, delete all sendable record state entries for deletions older than min(version) over all group_states
+- Try to gather some kind of machine identifier to put in a offline-owned group_state column
+- Try streaming out with large data sets and make sure it is sufficiently speedy, and is actually streaming (i.e. no Content-Length header)
+- Change mime-type of mirror files being downloaded to something that doesn't allow it to be accidentally viewed in-browser
+- Use md5sum on the entire cargo file instead of just each individual part, to protect against corruption outside the actual data segments
+- Allow app to optionally specify batch sizes on a model-by-model basis
+- Mirror file imports in the down mirror app should happen through GUI, and GUI should delete files once succesfully imported
+- If offline app attempts to import a down mirror file and it doesn't work, it should:
+  - Delete the down mirror file as usual, but...
+  - Explain that it wasn't imported and that another down mirror file should be downloaded
+- Figure out which activerecord methods skip the save callbacks, and wrap them to also update the mirror version
+  - Maybe methods for which this isn't practical should raise an error when called...
+- Load all the other informational values in GroupState
+- App creates a record then deletes it then sends mirror; does a deletion srs still get sent?
+  - For any fix to this: make sure that if app updates record then deletes it then sends mirror that deletion gets sent
+  - Maybe that means we need both create_version and update_version on srs?
+- Put the CargoStreamer into its own gem, it might be handy for other stuff

data/lib/app/models/offroad/group_state.rb

@@ -1,85 +1,85 @@
-module Offroad
-  private
-  
-  class GroupState < ActiveRecord::Base
-    set_table_name "offroad_group_states"
-    
-    validates_presence_of :app_group_id
-    
-    def validate
-      errors.add_to_base "Cannot find associated app group record" unless app_group
-    end
-
-    def app_group
-      Offroad::group_base_model.find_by_id(app_group_id)
-    end
-    
-    has_many :received_record_states, :class_name => "::Offroad::ReceivedRecordState", :dependent => :delete_all
-    
-    named_scope :for_group, lambda { |group| { :conditions => {
-      :app_group_id => valid_group_record?(group) ? group.id : 0
-    } } }
-    
-    def before_create
-      if Offroad::app_offline?
-        # FIXME : Fill in last_installation_at, launcher_version, app_version, etc
-        self.operating_system ||= RUBY_PLATFORM
-      end
-      
-      self.confirmed_group_data_version ||= 1
-      
-      # When first setting a group offline at online app, assume it will start out with at least current global data.
-      # It should, since that's the earliest version that could be loaded into the initial down mirror file.
-      self.confirmed_global_data_version ||= Offroad::app_online? ? SystemState::current_mirror_version : 1
-    end
-    
-    def update_from_remote_group_state!(remote_gs)
-      versioning_columns = [
-        'confirmed_global_data_version',
-        'confirmed_group_data_version'
-      ]
-      
-      online_owned_columns = [
-        'last_installer_downloaded_at',
-        'last_down_mirror_created_at',
-        'last_up_mirror_loaded_at'
-      ]
-      
-      offline_owned_columns = [
-        'last_installation_at',
-        'last_down_mirror_loaded_at',
-        'last_up_mirror_created_at',
-        'launcher_version',
-        'app_version',
-        'operating_system'
-      ]
-      
-      # Copy in values from columns owned by the remote environment that created remote_gs
-      (Offroad::app_offline? ? online_owned_columns : offline_owned_columns).each do |col|
-        self.send("#{col}=", remote_gs.send(col))
-      end
-      
-      # If the remote side says they have a newer version of something than we currently think they have, update
-      versioning_columns.each do |col|
-        self.send("#{col}=", [self.send(col), remote_gs.send(col)].max)
-      end
-      
-      save!
-    end
-    
-    def self.safe_to_load_from_cargo_stream?
-      true
-    end
-    
-    def self.note_group_destroyed(group)
-      rec = find_by_app_group_id(group.id)
-      rec.destroy
-    end
-    
-    private
-    
-    def self.valid_group_record?(rec)
-      rec.class.respond_to?(:offroad_group_base?) && rec.class.offroad_group_base?
-    end
-  end
-end
+module Offroad
+  private
+  
+  class GroupState < ActiveRecord::Base
+    set_table_name "offroad_group_states"
+    
+    validates_presence_of :app_group_id
+    
+    def validate
+      errors.add_to_base "Cannot find associated app group record" unless app_group
+    end
+
+    def app_group
+      Offroad::group_base_model.find_by_id(app_group_id)
+    end
+    
+    has_many :received_record_states, :class_name => "::Offroad::ReceivedRecordState", :dependent => :delete_all
+    
+    named_scope :for_group, lambda { |group| { :conditions => {
+      :app_group_id => valid_group_record?(group) ? group.id : 0
+    } } }
+    
+    def before_create
+      if Offroad::app_offline?
+        # FIXME : Fill in last_installation_at, launcher_version, app_version, etc
+        self.operating_system ||= RUBY_PLATFORM
+      end
+      
+      self.confirmed_group_data_version ||= 1
+      
+      # When first setting a group offline at online app, assume it will start out with at least current global data.
+      # It should, since that's the earliest version that could be loaded into the initial down mirror file.
+      self.confirmed_global_data_version ||= Offroad::app_online? ? SystemState::current_mirror_version : 1
+    end
+    
+    def update_from_remote_group_state!(remote_gs)
+      versioning_columns = [
+        'confirmed_global_data_version',
+        'confirmed_group_data_version'
+      ]
+      
+      online_owned_columns = [
+        'last_installer_downloaded_at',
+        'last_down_mirror_created_at',
+        'last_up_mirror_loaded_at'
+      ]
+      
+      offline_owned_columns = [
+        'last_installation_at',
+        'last_down_mirror_loaded_at',
+        'last_up_mirror_created_at',
+        'launcher_version',
+        'app_version',
+        'operating_system'
+      ]
+      
+      # Copy in values from columns owned by the remote environment that created remote_gs
+      (Offroad::app_offline? ? online_owned_columns : offline_owned_columns).each do |col|
+        self.send("#{col}=", remote_gs.send(col))
+      end
+      
+      # If the remote side says they have a newer version of something than we currently think they have, update
+      versioning_columns.each do |col|
+        self.send("#{col}=", [self.send(col), remote_gs.send(col)].max)
+      end
+      
+      save!
+    end
+    
+    def self.safe_to_load_from_cargo_stream?
+      true
+    end
+    
+    def self.note_group_destroyed(group)
+      rec = find_by_app_group_id(group.id)
+      rec.destroy
+    end
+    
+    private
+    
+    def self.valid_group_record?(rec)
+      rec.class.respond_to?(:offroad_group_base?) && rec.class.offroad_group_base?
+    end
+  end
+end