Module: Plum

Defined in:
lib/plum.rb,
lib/plum/engine.rb,
lib/plum/version.rb,
app/models/plum/site.rb,
app/models/plum/term.rb,
app/models/plum/user.rb,
app/models/plum/asset.rb,
app/models/plum/entry.rb,
app/models/plum/global.rb,
lib/plum/configuration.rb,
app/services/plum/theme.rb,
lib/plum/content_source.rb,
app/models/plum/nav_item.rb,
app/models/plum/nav_menu.rb,
app/models/plum/taxonomy.rb,
app/models/plum/entry_term.rb,
app/models/plum/site_scoped.rb,
app/models/plum/content_type.rb,
app/models/plum/site_setting.rb,
app/services/plum/base_blocks.rb,
lib/plum/liquid_tags/form_tag.rb,
app/models/plum/form_definition.rb,
app/models/plum/form_submission.rb,
app/services/plum/block_library.rb,
app/services/plum/form_renderer.rb,
lib/plum/content_source_context.rb,
app/services/plum/field_expander.rb,
app/services/plum/liquid_context.rb,
app/services/plum/liquid_filters.rb,
app/services/plum/theme_registry.rb,
app/services/plum/theme_resolver.rb,
lib/plum/content_source_registry.rb,
app/helpers/plum/cp/assets_helper.rb,
app/services/plum/liquid_renderer.rb,
app/models/plum/application_record.rb,
app/services/plum/builder_renderer.rb,
app/services/plum/theme_asset_path.rb,
app/controllers/plum/pages_controller.rb,
app/services/plum/block_editor_config.rb,
app/controllers/plum/cp/base_controller.rb,
app/services/plum/theme_settings_params.rb,
app/controllers/plum/cp/terms_controller.rb,
app/controllers/plum/sessions_controller.rb,
app/controllers/plum/cp/assets_controller.rb,
app/controllers/plum/cp/themes_controller.rb,
app/helpers/plum/cp/theme_settings_helper.rb,
app/services/plum/theme_package_installer.rb,
app/controllers/plum/cp/entries_controller.rb,
app/controllers/plum/cp/globals_controller.rb,
app/controllers/plum/application_controller.rb,
app/controllers/plum/cp/dashboard_controller.rb,
app/controllers/plum/cp/nav_items_controller.rb,
app/controllers/plum/cp/nav_menus_controller.rb,
app/controllers/plum/theme_assets_controller.rb,
app/controllers/plum/cp/taxonomies_controller.rb,
lib/generators/plum/install/install_generator.rb,
app/controllers/plum/cp/content_types_controller.rb,
app/controllers/plum/cp/site_settings_controller.rb,
app/controllers/plum/form_submissions_controller.rb,
app/controllers/plum/cp/theme_previews_controller.rb,
app/controllers/plum/cp/form_definitions_controller.rb,
app/controllers/plum/cp/form_submissions_controller.rb

Defined Under Namespace

Modules: BaseBlocks, Cp, Generators, LiquidFilters, LiquidTags, SiteScoped, Version Classes: ApplicationController, ApplicationRecord, Asset, BlockEditorConfig, BlockLibrary, BuilderRenderer, Configuration, ContentSource, ContentSourceContext, ContentSourceError, ContentSourceRegistry, ContentType, Engine, Entry, EntryTerm, FieldExpander, FormDefinition, FormRenderer, FormSubmission, FormSubmissionsController, Global, LiquidContext, LiquidRenderer, NavItem, NavMenu, PagesController, SessionsController, Site, SiteSetting, Taxonomy, Term, Theme, ThemeAssetPath, ThemeAssetsController, ThemeManifestError, ThemePackageInstaller, ThemeRegistry, ThemeResolver, ThemeSettingsParams, User

Constant Summary collapse

VERSION = 
Version::STRING

Class Method Summary collapse

Class Method Details

.authorized?(controller) ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
73
74
75
76
77
78
79
 
# File 'lib/plum/configuration.rb', line 70

def self.authorized?(controller)
  case configuration.authorize_with
  when :plum
    current_user(controller).present?
  when :host
    configuration.host_authorization_resolver.call(controller)
  else
    configuration.authorize_with.respond_to?(:call) && configuration.authorize_with.call(controller)
  end
end

.configuration ⇒ Object 



54
55
56
 
# File 'lib/plum/configuration.rb', line 54

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



58
59
60
 
# File 'lib/plum/configuration.rb', line 58

def self.configure
  yield configuration
end

.content_sources_for(controller, site:) ⇒ Object 



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

def self.content_sources_for(controller, site:)
  configuration.content_sources.to_liquid_context(controller: controller, site: site)
end

.current_site(controller) ⇒ Object 



62
63
64
 
# File 'lib/plum/configuration.rb', line 62

def self.current_site(controller)
  configuration.current_site_resolver.call(controller)
end

.current_user(controller) ⇒ Object 



66
67
68
 
# File 'lib/plum/configuration.rb', line 66

def self.current_user(controller)
  configuration.current_user_resolver.call(controller)
end

.register_content_source(handle, source = nil, &block) ⇒ Object 



81
82
83
 
# File 'lib/plum/configuration.rb', line 81

def self.register_content_source(handle, source = nil, &block)
  configuration.register_content_source(handle, source, &block)
end

.table_name_prefix ⇒ Object 



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

def self.table_name_prefix
  "plum_"
end