Class: PluginRoutes
- Inherits:
-
Object
- Object
- PluginRoutes
- Defined in:
- lib/plugin_routes.rb,
lib/generators/camaleon_cms/install_template/plugin_routes.rb
Constant Summary collapse
- @@_vars =
[]
Class Method Summary collapse
-
.all_apps ⇒ Object
return all apps loaded.
-
.all_enabled_apps ⇒ Object
return all enabled apps as []: system, themes, plugins.
-
.all_enabled_plugins ⇒ Object
return all enabled plugins (a theme is enabled if at least one site has installed).
-
.all_enabled_themes ⇒ Object
return all enabled themes (a theme is enabled if at least one site is assigned).
-
.all_helpers ⇒ Object
all helpers of enabled plugins.
-
.all_locales ⇒ Object
return all locales for all sites joined by |.
-
.all_locales_for_routes ⇒ Object
return all locales for translated routes.
-
.all_plugins ⇒ Object
return all plugins located in cms and in this project.
-
.all_themes ⇒ Object
return an array of all themes installed for all sites.
-
.apps_dir ⇒ Object
return apps directory path.
- .cache_variable(var_name, value = nil) ⇒ Object
-
.db_installed? ⇒ Boolean
check if db migrate already done.
-
.destroy_plugin(plugin_key) ⇒ Object
destroy plugin.
-
.destroy_theme(theme_key) ⇒ Object
destroy theme.
-
.draw_gems ⇒ Object
draw “all” gems registered for the plugins or themes and camaleon gems.
-
.enabled_apps(site, theme_slug = nil) ⇒ Object
return all enabled apps for site (themes + system + plugins) [] theme_slug: current theme slug.
-
.enabled_plugins(site) ⇒ Object
return all enabled plugins [].
-
.fixActionParameter(h) ⇒ Object
convert action parameter into hash.
-
.get_gem(name) ⇒ Object
check if a gem is available or not Arguemnts: name: name of the gem return (Boolean) true/false.
-
.get_gem_plugins ⇒ Object
return all plugins registered as gems.
-
.get_gem_themes ⇒ Object
return all themes registered as gems.
-
.get_sites ⇒ Object
return all sites registered for Plugin routes.
- .isRails4? ⇒ Boolean
- .isRails5? ⇒ Boolean
-
.load(env = "admin") ⇒ Object
load plugin routes if it is enabled.
- .load_themes(env = "admin") ⇒ Object
-
.plugin_info(plugin_key) ⇒ Object
return plugin information.
-
.reload ⇒ Object
reload routes.
-
.site_plugin_helpers(site) ⇒ Object
all helpers of enabled plugins for site.
-
.static_system_info ⇒ Object
(also: system_info)
return system static settings (config.json values).
-
.theme_info(theme_name) ⇒ Object
return theme information if theme_name is nil, the use current site theme.
Class Method Details
.all_apps ⇒ Object
return all apps loaded
303 304 305 |
# File 'lib/plugin_routes.rb', line 303 def self.all_apps all_plugins+all_themes end |
.all_enabled_apps ⇒ Object
return all enabled apps as []: system, themes, plugins
143 144 145 |
# File 'lib/plugin_routes.rb', line 143 def self.all_enabled_apps [system_info] + all_enabled_themes + all_enabled_plugins end |
.all_enabled_plugins ⇒ Object
return all enabled plugins (a theme is enabled if at least one site has installed)
159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/plugin_routes.rb', line 159 def self.all_enabled_plugins r = cache_variable("all_enabled_plugins") return r unless r.nil? res, enabled_ps = [], [] get_sites.each { |site| enabled_ps += site.plugins.active.pluck(:slug) } all_plugins.each do |plugin| if enabled_ps.include?(plugin["key"]) res << plugin end end cache_variable("all_enabled_plugins", res) end |
.all_enabled_themes ⇒ Object
return all enabled themes (a theme is enabled if at least one site is assigned)
148 149 150 151 152 153 154 155 156 |
# File 'lib/plugin_routes.rb', line 148 def self.all_enabled_themes r = cache_variable("all_enabled_themes"); return r unless r.nil? res = [] get_sites.each do |site| i = theme_info(site.get_theme_slug) res << i if i.present? end cache_variable("all_enabled_themes", res) end |
.all_helpers ⇒ Object
all helpers of enabled plugins
183 184 185 186 187 188 189 190 191 |
# File 'lib/plugin_routes.rb', line 183 def self.all_helpers r = cache_variable("plugins_helper") return r unless r.nil? res = [] all_apps.each do |settings| res += settings["helpers"] if settings["helpers"].present? end cache_variable("plugins_helper", res.uniq) end |
.all_locales ⇒ Object
return all locales for all sites joined by |
230 231 232 233 234 235 236 237 |
# File 'lib/plugin_routes.rb', line 230 def self.all_locales r = cache_variable("site_all_locales"); return r unless r.nil? res = [] get_sites.each do |s| res += s.get_languages end cache_variable("site_all_locales", res.uniq.join("|")) end |
.all_locales_for_routes ⇒ Object
return all locales for translated routes
240 241 242 243 244 245 246 247 248 |
# File 'lib/plugin_routes.rb', line 240 def self.all_locales_for_routes r = cache_variable("all_locales_for_routes"); return r unless r.nil? res = {} all_locales.split("|").each do |l| res[l] = "_#{l}" end res[false] = '' cache_variable("all_locales_for_routes", res) end |
.all_plugins ⇒ Object
return all plugins located in cms and in this project
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/plugin_routes.rb', line 256 def self.all_plugins camaleon_gem = get_gem('camaleon_cms') return [] if !camaleon_gem r = cache_variable("all_plugins"); return r unless (r.nil? || r == []) res = get_gem_plugins entries = [".", ".."] res.each{|plugin| entries << plugin["key"] } (Dir["#{apps_dir}/plugins/*"] + Dir["#{camaleon_gem.gem_dir}/app/apps/plugins/*"]).each do |path| entry = path.split("/").last config = File.join(path, "config", "config.json") next if entries.include?(entry) || !File.directory?(path) || !File.exist?(config) p = JSON.parse(File.read(config)) p = p.with_indifferent_access rescue p p["key"] = entry p["path"] = path p["kind"] = "plugin" res << p entries << entry end cache_variable("all_plugins", res) end |
.all_themes ⇒ Object
return an array of all themes installed for all sites
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/plugin_routes.rb', line 279 def self.all_themes camaleon_gem = get_gem('camaleon_cms') return [] if !camaleon_gem r = cache_variable("all_themes"); return r unless (r.nil? || r == []) res = get_gem_themes entries = [".", ".."] res.each{|theme| entries << theme["key"] } (Dir["#{apps_dir}/themes/*"] + Dir["#{camaleon_gem.gem_dir}/app/apps/themes/*"]).each do |path| entry = path.split("/").last config = File.join(path, "config", "config.json") next if entries.include?(entry) || !File.directory?(path) || !File.exist?(config) p = JSON.parse(File.read(config)) p = p.with_indifferent_access rescue p p["key"] = entry p["path"] = path p["kind"] = "theme" p["title"] = p["name"] res << p entries << entry end cache_variable("all_themes", res) end |
.apps_dir ⇒ Object
return apps directory path
251 252 253 |
# File 'lib/plugin_routes.rb', line 251 def self.apps_dir Rails.root.join("app", "apps").to_s end |
.cache_variable(var_name, value = nil) ⇒ Object
205 206 207 208 209 210 211 212 213 |
# File 'lib/plugin_routes.rb', line 205 def self.cache_variable(var_name, value=nil) @@_vars.push(var_name).uniq #if Rails.env != "development" # disable cache plugin routes for develoment mode cache = class_variable_get("@@cache_#{var_name}") rescue nil return cache if value.nil? #end class_variable_set("@@cache_#{var_name}", value) value end |
.db_installed? ⇒ Boolean
check if db migrate already done
225 226 227 |
# File 'lib/plugin_routes.rb', line 225 def self.db_installed? @@is_db_installed ||= ActiveRecord::Base.connection.table_exists?(CamaleonCms::Site.table_name) end |
.destroy_plugin(plugin_key) ⇒ Object
destroy plugin
194 195 196 197 |
# File 'lib/plugin_routes.rb', line 194 def self.destroy_plugin(plugin_key) FileUtils.rm_r(Rails.root.join("app", "apps", "plugins", plugin_key)) rescue "" PluginRoutes.reload end |
.destroy_theme(theme_key) ⇒ Object
destroy theme
200 201 202 203 |
# File 'lib/plugin_routes.rb', line 200 def self.destroy_theme(theme_key) FileUtils.rm_r(Rails.root.join("app", "apps", "themes", theme_key)) rescue "" PluginRoutes.reload end |
.draw_gems ⇒ Object
draw “all” gems registered for the plugins or themes and camaleon gems
4 5 6 7 8 9 10 11 12 13 14 |
# File 'lib/generators/camaleon_cms/install_template/plugin_routes.rb', line 4 def self.draw_gems res = [] dirs = [] + Dir["#{apps_dir}/plugins/*"] + Dir["#{apps_dir}/themes/*"] dirs.each do |path| next if [".", ".."].include?(path) g = File.join(path, "config", "Gemfile") res << File.read(g) if File.exist?(g) end res.join("\n") end |
.enabled_apps(site, theme_slug = nil) ⇒ Object
return all enabled apps for site (themes + system + plugins) [] theme_slug: current theme slug
134 135 136 137 138 139 140 |
# File 'lib/plugin_routes.rb', line 134 def self.enabled_apps(site, theme_slug = nil) theme_slug = theme_slug || site.get_theme_slug r = cache_variable("enabled_apps_#{site.id}_#{theme_slug}") return r unless r.nil? res = [system_info] + enabled_plugins(site) + [theme_info(theme_slug)] cache_variable("enabled_apps_#{site.id}_#{theme_slug}", res) end |
.enabled_plugins(site) ⇒ Object
return all enabled plugins []
120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/plugin_routes.rb', line 120 def self.enabled_plugins(site) r = cache_variable("enable_plugins_site_#{site.id}") return r unless r.nil? res = [] enabled_ps = site.plugins.active.pluck(:slug) all_plugins.each do |plugin| res << plugin if enabled_ps.include?(plugin["key"]) end res = res.sort_by{|e| e["position"] || 10 } cache_variable("enable_plugins_site_#{site.id}", res) end |
.fixActionParameter(h) ⇒ Object
convert action parameter into hash
107 108 109 |
# File 'lib/plugin_routes.rb', line 107 def fixActionParameter(h) (h.is_a?(ActionController::Parameters) ? h.to_hash : h) end |
.get_gem(name) ⇒ Object
check if a gem is available or not Arguemnts: name: name of the gem return (Boolean) true/false
351 352 353 354 355 356 357 |
# File 'lib/plugin_routes.rb', line 351 def self.get_gem(name) Gem::Specification.find_by_name(name) rescue Gem::LoadError false rescue Gem.available?(name) end |
.get_gem_plugins ⇒ Object
return all plugins registered as gems
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/plugin_routes.rb', line 308 def self.get_gem_plugins entries = [] Gem::Specification.each do |gem| path = gem.gem_dir config = File.join(path, "config", "camaleon_plugin.json") if File.exist?(config) p = JSON.parse(File.read(config)) p = p.with_indifferent_access rescue p p["key"] = gem.name if p["key"].nil? # TODO REVIEW ERROR FOR conflict plugin keys p["version"] = gem.version.to_s p["path"] = path p["kind"] = "plugin" p["descr"] = gem.description unless p["descr"].present? p["gem_mode"] = true entries << p end end entries end |
.get_gem_themes ⇒ Object
return all themes registered as gems
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/plugin_routes.rb', line 329 def self.get_gem_themes entries = [] Gem::Specification.each do |gem| path = gem.gem_dir config = File.join(path, "config", "camaleon_theme.json") if File.exist?(config) p = JSON.parse(File.read(config)) p = p.with_indifferent_access rescue p p["key"] = gem.name if p["key"].nil? # TODO REVIEW ERROR FOR conflict plugin keys p["path"] = path p["kind"] = "theme" p["gem_mode"] = true entries << p end end entries end |
.get_sites ⇒ Object
return all sites registered for Plugin routes
216 217 218 219 220 221 222 |
# File 'lib/plugin_routes.rb', line 216 def self.get_sites begin @@all_sites ||= CamaleonCms::Site.order(id: :asc).all.to_a rescue [] end end |
.isRails4? ⇒ Boolean
99 100 101 |
# File 'lib/plugin_routes.rb', line 99 def isRails4? Rails.version.to_s[0].to_i == 4 end |
.isRails5? ⇒ Boolean
103 104 105 |
# File 'lib/plugin_routes.rb', line 103 def isRails5? Rails.version.to_s[0].to_i == 5 end |
.load(env = "admin") ⇒ Object
load plugin routes if it is enabled
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/plugin_routes.rb', line 5 def self.load(env = "admin") plugins = all_enabled_plugins res = "" if env == "front" res << "namespace :plugins do \n" plugins.each do |plugin| res << "namespace '#{plugin["key"]}' do \n" res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" res << "end\n" end res << "end\n" elsif env == "admin" # admin res << "scope 'admin', as: 'admin' do \n" res << "namespace :plugins do \n" plugins.each do |plugin| res << "namespace '#{plugin["key"]}' do \n" res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" res << "end\n" end res << "end\n" res << "end\n" else # main plugins.each do |plugin| res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" end end res + load_themes(env) end |
.load_themes(env = "admin") ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/plugin_routes.rb', line 35 def self.load_themes(env = "admin") plugins = all_enabled_themes res = "" if env == "front" res << "namespace :themes do \n" plugins.each do |plugin| res << "namespace '#{plugin["key"]}' do \n" res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" res << "end\n" end res << "end\n" elsif env == "admin" # admin res << "scope 'admin', as: 'admin' do \n" res << "namespace :themes do \n" plugins.each do |plugin| res << "namespace '#{plugin["key"]}' do \n" res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" res << "end\n" end res << "end\n" res << "end\n" else # main plugins.each do |plugin| res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue "" end end res end |
.plugin_info(plugin_key) ⇒ Object
return plugin information
67 68 69 70 |
# File 'lib/plugin_routes.rb', line 67 def plugin_info(plugin_key) self.all_plugins.each{|p| return p if p["key"] == plugin_key || p['path'].split('/').last == plugin_key } nil end |
.reload ⇒ Object
reload routes
113 114 115 116 117 |
# File 'lib/plugin_routes.rb', line 113 def self.reload @@all_sites = nil @@_vars.each { |v| class_variable_set("@@cache_#{v}", nil) } Rails.application.reload_routes! end |
.site_plugin_helpers(site) ⇒ Object
all helpers of enabled plugins for site
173 174 175 176 177 178 179 180 |
# File 'lib/plugin_routes.rb', line 173 def self.site_plugin_helpers(site) r = cache_variable("site_plugin_helpers"); return r unless r.nil? res = [] enabled_apps(site).each do |settings| res += settings["helpers"] if settings["helpers"].present? end cache_variable("site_plugin_helpers", res) end |
.static_system_info ⇒ Object Also known as: system_info
return system static settings (config.json values)
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/plugin_routes.rb', line 80 def static_system_info r = cache_variable("statis_system_info"); return r unless r.nil? settings = {} gem_settings = File.join($camaleon_engine_dir, "config", "system.json") app_settings = Rails.root.join("config", "system.json") settings = settings.merge(JSON.parse(File.read(gem_settings))) if File.exist?(gem_settings) settings = settings.merge(JSON.parse(File.read(app_settings))) if File.exist?(app_settings) # custom settings settings["key"] = "system" settings["path"] = '' settings["kind"] = "system" settings["hooks"]["on_notification"] = (settings["hooks"]["on_notification"] || []) + ["admin_system_notifications"] cache_variable("statis_system_info", settings) end |
.theme_info(theme_name) ⇒ Object
return theme information if theme_name is nil, the use current site theme
74 75 76 77 |
# File 'lib/plugin_routes.rb', line 74 def theme_info(theme_name) self.all_themes.each{|p| return p if p["key"] == theme_name } nil end |