Module: Ditty::Components

Defined in:
lib/ditty.rb

Overview

Ripped off from Roda - github.com/jeremyevans/roda

Defined Under Namespace

Modules: Base

Class Method Summary collapse

Class Method Details

.component?(name) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/ditty.rb', line 72

def self.component?(name)
  @components.key? name
end

.components ⇒ Object 



85
86
87
 
# File 'lib/ditty.rb', line 85

def self.components
  @components
end

.load_component(name) ⇒ Object

If the registered component already exists, use it. Otherwise, require it and return it. This raises a LoadError if such a component doesn’t exist, or a Component if it exists but it does not register itself correctly.



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/ditty.rb', line 61

def self.load_component(name)
  h = @components
  unless (component = h[name])
    require "ditty/components/#{name}"
    unless (component = h[name])
      raise ComponentError, "Component #{name} did not register itself correctly in Ditty::Components"
    end
  end
  component
end

.migrations ⇒ Object 



106
107
108
109
110
 
# File 'lib/ditty.rb', line 106

def self.migrations
  components.map do |_name, comp|
    comp.migrations if comp.respond_to?(:migrations)
  end.compact
end

.navigation ⇒ Object

Return an ordered list of navigation items: ‘[’/users/‘, text:’Users’, ‘/roles/’, text:‘Roles’]



99
100
101
102
103
104
 
# File 'lib/ditty.rb', line 99

def self.navigation
  nav = components.each_with_object([]) do |comp, memo|
    memo.concat comp[1].navigation if comp[1].respond_to?(:navigation)
  end
  nav.sort_by { |v| v[:order] }
end

.public_folder ⇒ Object 



112
113
114
115
116
 
# File 'lib/ditty.rb', line 112

def self.public_folder
  components.map do |_name, comp|
    comp.public_folder if comp.respond_to?(:public_folder)
  end.compact
end

.register_component(name, mod) ⇒ Object

Register the given component with Component, so that it can be loaded using #component with a symbol. Should be used by component files. Example:

Ditty::Components.register_component(:component_name, ComponentModule)



80
81
82
83
 
# File 'lib/ditty.rb', line 80

def self.register_component(name, mod)
  ::Ditty::Services::Logger.info "Registering #{mod} as #{name}"
  @components[name] = mod
end

.routes ⇒ Object

Return a hash of controllers with their routes as keys: ‘{ ’/users’ => Ditty::Controllers::Users }‘



90
91
92
93
94
95
 
# File 'lib/ditty.rb', line 90

def self.routes
  rts = components.each_with_object({}) do |comp, memo|
    memo.merge! comp[1].routes if comp[1].respond_to?(:routes)
  end
  rts.compact
end

.seeders ⇒ Object 



118
119
120
121
122
 
# File 'lib/ditty.rb', line 118

def self.seeders
  components.map do |_name, comp|
    comp.seeder if comp.respond_to?(:seeder)
  end.compact
end

.tasks ⇒ Object 



130
131
132
133
134
135
136
137
 
# File 'lib/ditty.rb', line 130

def self.tasks
  require 'rake'
  require 'rake/tasklib'
  require 'ditty/db' unless defined? DB
  components.each do |_name, comp|
    comp.tasks if comp.respond_to?(:tasks)
  end
end

.workers ⇒ Object 



124
125
126
127
128
 
# File 'lib/ditty.rb', line 124

def self.workers
  components.each_with_object([]) do |comp, memo|
    memo.concat comp[1].workers if comp[1].respond_to?(:workers)
  end
end