Represents a particular mounted padrino application Stores the name of the application (app folder name) and url mount path
@example
Mounter.new("blog_app", :app_class => "Blog").to("/blog") Mounter.new("blog_app", :app_file => "/path/to/blog/app.rb").to("/blog")
@param [String, Padrino::Application] name
The app name or the {Padrino::Application} class
@param [Hash] options @option options [Symbol] :app_class (Detected from name) @option options [Symbol] :app_file (Automatically detected) @option options [Symbol] :app_obj (Detected) @option options [Symbol] :app_root (Directory of :app_file)
# File lib/padrino-core/mounter.rb, line 26 def initialize(name, options={}) @name = name.to_s @app_class = options[:app_class] || @name.camelize @app_file = options[:app_file] || locate_app_file @app_obj = options[:app_obj] || app_constant || locate_app_object ensure_app_file! || ensure_app_object! @app_root = options[:app_root] || File.dirname(@app_file) @uri_root = "/" Padrino::Reloader.exclude_constants << @app_class end
Makes two Mounters equal if they have the same name and uri_root
@param [Padrino::Mounter] other
# File lib/padrino-core/mounter.rb, line 120 def ==(other) other.is_a?(Mounter) && self.app_class == other.app_class && self.uri_root == other.uri_root end
@return [Padrino::Application]
the class object for the app if defined, nil otherwise
# File lib/padrino-core/mounter.rb, line 128 def app_constant klass = Object for piece in app_class.split("::") piece = piece.to_sym if klass.const_defined?(piece) klass = klass.const_get(piece) else return end end klass end
Registers the mounted application onto Padrino for the given host
@param [String] mount_host
Host name
@example
Mounter.new("blog_app").to("/blog").host("blog.padrino.org") Mounter.new("blog_app").host("blog.padrino.org") Mounter.new("catch_all").host(/.*\.padrino.org/)
# File lib/padrino-core/mounter.rb, line 63 def host(mount_host) @app_host = mount_host Padrino.insert_mounted_app(self) self end
Maps Padrino application onto a Padrino::Router For use in constructing a Rack application
@param [Padrino::Router]
@return [Padrino::Router]
@example
@app.map_onto(router)
# File lib/padrino-core/mounter.rb, line 80 def map_onto(router) app_data, app_obj = self, @app_obj app_obj.set :uri_root, app_data.uri_root app_obj.set :app_name, app_data.name app_obj.set :app_file, app_data.app_file unless ::File.exist?(app_obj.app_file) app_obj.set :root, app_data.app_root unless app_data.app_root.blank? app_obj.set :public_folder, Padrino.root('public', app_data.uri_root) unless File.exists?(app_obj.public_folder) app_obj.set :static, File.exist?(app_obj.public_folder) if app_obj.nil? app_obj.setup_application! # Initializes the app here with above settings. router.map(:to => app_obj, :path => app_data.uri_root, :host => app_data.app_host) end
Returns the basic route information for each named route
@return [Array]
Array of routes
# File lib/padrino-core/mounter.rb, line 105 def named_routes app_obj.routes.map { |route| name_array = "(#{route.named.to_s.split("_").map { |piece| %Q[:#{piece}] }.join(", ")})" request_method = route.conditions[:request_method][0] full_path = File.join(uri_root, route.original_path) next if route.named.blank? || request_method == 'HEAD' OpenStruct.new(:verb => request_method, :identifier => route.named, :name => name_array, :path => full_path) }.compact end
Returns the route objects for the mounted application
# File lib/padrino-core/mounter.rb, line 95 def routes app_obj.routes end
Registers the mounted application onto Padrino
@param [String] mount_url
Path where we mount the app
@example
Mounter.new("blog_app").to("/blog")
# File lib/padrino-core/mounter.rb, line 46 def to(mount_url) @uri_root = mount_url Padrino.insert_mounted_app(self) self end
Raises an exception unless app_file is located properly
# File lib/padrino-core/mounter.rb, line 168 def ensure_app_file! message = "Unable to locate source file for app '#{app_class}', try with :app_file => '/path/app.rb'" raise MounterException, message unless @app_file end
Raises an exception unless app_obj is defined properly
# File lib/padrino-core/mounter.rb, line 176 def ensure_app_object! message = "Unable to locate app for '#{app_class}', try with :app_class => 'MyAppClass'" raise MounterException, message unless @app_obj end
Returns the determined location of the mounted application main file
# File lib/padrino-core/mounter.rb, line 156 def locate_app_file candidates = [] candidates << app_constant.app_file if app_constant.respond_to?(:app_file) && File.exist?(app_constant.app_file.to_s) candidates << Padrino.first_caller if File.identical?(Padrino.first_caller.to_s, Padrino.called_from.to_s) candidates << Padrino.mounted_root(name.downcase, "app.rb") candidates << Padrino.root("app", "app.rb") candidates.find { |candidate| File.exist?(candidate) } end
Generated with the Darkfish Rdoc Generator 2.