Class: Spree::Admin::Engine::NavigationEnvironment

Inherits:
Object
  • Object
show all
Defined in:
lib/spree/admin/engine.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ NavigationEnvironment

Returns a new instance of NavigationEnvironment.



142
143
144
 
# File 'lib/spree/admin/engine.rb', line 142

def initialize
  @contexts = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args) ⇒ Object

Define accessor methods for predefined and custom contexts



177
178
179
180
181
182
183
 
# File 'lib/spree/admin/engine.rb', line 177

def method_missing(method_name, *args)
  if method_name.to_s.end_with?('=')
    super
  else
    get_context(method_name)
  end
end

Instance Method Details

#context?(name) ⇒ Boolean

Check if a context exists

Parameters:

  • name (Symbol) —

    The context name to check

Returns:

  • (Boolean) —

    true if the context is registered



172
173
174
 
# File 'lib/spree/admin/engine.rb', line 172

def context?(name)
  @contexts.key?(name.to_sym)
end

#contexts ⇒ Array<Symbol>

List all registered contexts

Returns:

  • (Array<Symbol>) —

    Array of registered context names



165
166
167
 
# File 'lib/spree/admin/engine.rb', line 165

def contexts
  @contexts.keys
end

#get_context(name) ⇒ Spree::Admin::Navigation

Get a registered navigation context

Parameters:

  • name (Symbol) —

    The name of the navigation context

Returns:

Raises:

  • (NoMethodError) —

    if the context hasn't been registered



158
159
160
161
 
# File 'lib/spree/admin/engine.rb', line 158

def get_context(name)
  name = name.to_sym
  @contexts[name] || raise(NoMethodError, "Navigation context '#{name}' has not been registered. Use Spree.admin.navigation.register_context(:#{name}) first.")
end

#register_context(name) ⇒ Spree::Admin::Navigation

Register a new navigation context

Parameters:

  • name (Symbol) —

    The name of the navigation context

Returns:



149
150
151
152
 
# File 'lib/spree/admin/engine.rb', line 149

def register_context(name)
  name = name.to_sym
  @contexts[name] ||= Spree::Admin::Navigation.new(name)
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/spree/admin/engine.rb', line 185

def respond_to_missing?(method_name, include_private = false)
  method_name.to_s.end_with?('=') ? false : context?(method_name)
end