Class: Refinery::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/refinery/plugin.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#always_allow_access ⇒ Object

Returns the value of attribute always_allow_access.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def always_allow_access
  @always_allow_access
end

#class_name ⇒ Object

Returns the value of attribute class_name.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def class_name
  @class_name
end

#controller ⇒ Object

Returns the value of attribute controller.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def controller
  @controller
end

#dashboard ⇒ Object

Returns the value of attribute dashboard.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def dashboard
  @dashboard
end

#directory ⇒ Object

Returns the value of attribute directory.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def directory
  @directory
end

#hide_from_menu ⇒ Object

Returns the value of attribute hide_from_menu.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def hide_from_menu
  @hide_from_menu
end

#menu_match ⇒ Object

Returns the value of attribute menu_match.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def menu_match
  @menu_match
end

#name ⇒ Object

Returns the value of attribute name.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def name
  @name
end

#pathname ⇒ Object

Returns the value of attribute pathname.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def pathname
  @pathname
end

#plugin_activity ⇒ Object

Returns the value of attribute plugin_activity.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def plugin_activity
  @plugin_activity
end

#url ⇒ Object

Returns a hash that can be used to create a url that points to the administration part of the plugin.



61
62
63
 
# File 'lib/refinery/plugin.rb', line 61

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



6
7
8
 
# File 'lib/refinery/plugin.rb', line 6

def version
  @version
end

Class Method Details

.register {|plugin = self.new| ... } ⇒ Object

Yields:

  • (plugin = self.new) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/refinery/plugin.rb', line 10

def self.register(&block)
  yield(plugin = self.new)

  raise "A plugin MUST have a name!: #{plugin.inspect}" if plugin.name.blank?

  # Set defaults.
  plugin.menu_match ||= %r{refinery/#{plugin.name}(/.+?)?$}
  plugin.always_allow_access ||= false
  plugin.dashboard ||= false
  plugin.class_name ||= plugin.name.camelize

  # add the new plugin to the collection of registered plugins
  ::Refinery::Plugins.registered << plugin
end

Instance Method Details

#activity ⇒ Object

Retrieve information about how to access the latest activities of this plugin.



36
37
38
 
# File 'lib/refinery/plugin.rb', line 36

def activity
  self.plugin_activity ||= []
end

#activity=(activities) ⇒ Object

Stores information that can be used to retrieve the latest activities of this plugin



41
42
43
 
# File 'lib/refinery/plugin.rb', line 41

def activity=(activities)
  [activities].flatten.each { |activity| add_activity(activity) }
end

#activity_by_class_name(class_name) ⇒ Object

Given a record’s class name, find the related activity object.



46
47
48
 
# File 'lib/refinery/plugin.rb', line 46

def activity_by_class_name(class_name)
  self.activity.select{ |a| a.class_name == class_name.to_s.camelize }
end

#description ⇒ Object

Returns the internationalized version of the description



31
32
33
 
# File 'lib/refinery/plugin.rb', line 31

def description
  ::I18n.translate(['refinery', 'plugins', name, 'description'].join('.'))
end

#highlighted?(params) ⇒ Boolean

Used to highlight the current tab in the admin interface

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/refinery/plugin.rb', line 51

def highlighted?(params)
  !!(params[:controller].try(:gsub, "admin/", "") =~ menu_match) || (dashboard && params[:action] == 'error_404')
end

#title ⇒ Object

Returns the internationalized version of the title



26
27
28
 
# File 'lib/refinery/plugin.rb', line 26

def title
  ::I18n.translate(['refinery', 'plugins', name, 'title'].join('.'))
end