this should be added very soon to edge. In the meantime you can begin using it now!

It can be very useful to structure your models and operations into common (client and server) and server only definitions.

We have been doing this by including modules defined in app/models or app/operations with a unless RUBY_ENGINE == 'opal' guard.

This is cumbersome, and also requires moving a lot of stuff around if adding hyperstack to a brownfield site.

The require_server_side_file method solves the problem nicely. Just add that declaration to the beginning of any file in a hyperstack directory, and the matching file from the app directory will be required, BUT ONLY ON THE SERVER.

The following method can be added to the beginning of your hyperstack/models/application_record.rb file:

class Object
  def require_server_side_file
    return if RUBY_ENGINE == 'opal'

    path = caller[0].split(':')[0].split(File::SEPARATOR).reverse
    hs_index = path.length.times { |i| break i if path[i] == 'hyperstack' }
    new_path = (path[0..hs_index - 1] + path[hs_index + 1..-1]).reverse
    load_path = new_path.join(File::SEPARATOR)
    require_dependency load_path
  end
end

The you can say (for example)

# app/hyperstack/models/my_big_model.rb
require_server_side_file

class MyBigModel < ApplicationRecord 
   ... definitions visible to the client AND server ...
end

# app/models/my_big_model.rb

class MyBigModel < ApplicationRecord 
  ... definitions only available on the server ...
end

How it works:

the hyperstack directory is before the app directory, so rails will find the hyperstack file first. Normally once rails finds a file that defines the constant it is looking for it quits, and so the server side file wont get loaded, unless you explicitly do a require_dependency on it.

The method above simply automtically does the require_dependency, but only when running on the server.