Module: Railspress

Defined in:
lib/railspress.rb,
lib/railspress/engine.rb,
lib/railspress/entity.rb,
lib/railspress/version.rb,
app/models/railspress/tag.rb,
app/models/railspress/post.rb,
app/models/railspress/export.rb,
app/models/railspress/import.rb,
app/models/railspress/tagging.rb,
app/models/railspress/category.rb,
app/helpers/railspress/cms_helper.rb,
app/models/railspress/focal_point.rb,
app/helpers/railspress/admin_helper.rb,
app/jobs/railspress/application_job.rb,
app/models/railspress/content_group.rb,
app/jobs/railspress/export_posts_job.rb,
app/jobs/railspress/import_posts_job.rb,
app/models/railspress/content_element.rb,
app/models/concerns/railspress/taggable.rb,
app/models/railspress/application_record.rb,
app/helpers/railspress/application_helper.rb,
app/mailers/railspress/application_mailer.rb,
app/models/railspress/post_export_processor.rb,
app/models/railspress/post_import_processor.rb,
app/models/concerns/railspress/soft_deletable.rb,
app/models/railspress/content_element_version.rb,
app/services/railspress/content_export_service.rb,
app/services/railspress/content_import_service.rb,
app/controllers/railspress/admin/base_controller.rb,
app/controllers/railspress/admin/tags_controller.rb,
app/controllers/railspress/admin/posts_controller.rb,
app/controllers/railspress/application_controller.rb,
lib/generators/railspress/entity/entity_generator.rb,
app/controllers/railspress/admin/exports_controller.rb,
app/controllers/railspress/admin/imports_controller.rb,
lib/generators/railspress/install/install_generator.rb,
app/controllers/railspress/admin/entities_controller.rb,
app/controllers/railspress/admin/dashboard_controller.rb,
app/controllers/railspress/admin/categories_controller.rb,
app/controllers/railspress/admin/prototypes_controller.rb,
app/controllers/railspress/admin/focal_points_controller.rb,
app/controllers/railspress/admin/cms_transfers_controller.rb,
app/controllers/railspress/admin/content_groups_controller.rb,
app/controllers/railspress/admin/content_elements_controller.rb,
app/controllers/railspress/admin/content_element_versions_controller.rb

Defined Under Namespace

Modules: Admin, AdminHelper, ApplicationHelper, CMS, CmsHelper, Entity, Generators, HasFocalPoint, SoftDeletable, Taggable Classes: ApplicationController, ApplicationJob, ApplicationMailer, ApplicationRecord, Category, Configuration, ConfigurationError, ContentElement, ContentElementVersion, ContentExportService, ContentGroup, ContentImportService, Engine, EntityConfig, Export, ExportPostsJob, FocalPoint, Import, ImportPostsJob, Post, PostExportProcessor, PostImportProcessor, Tag, Tagging

Constant Summary collapse

VERSION = 
"1.2.0"

Class Method Summary collapse

Class Method Details

.author_class ⇒ Object 



215
216
217
 
# File 'lib/railspress.rb', line 215

def author_class
  configuration.author_class_name.constantize
end

.author_display_method ⇒ Object 



230
231
232
 
# File 'lib/railspress.rb', line 230

def author_display_method
  configuration.author_display_method
end

.authors_enabled? ⇒ Boolean

Convenience accessors

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/railspress.rb', line 195

def authors_enabled?
  configuration.authors_enabled
end

.available_authors ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/railspress.rb', line 219

def available_authors
  scope = configuration.author_scope
  klass = author_class

  case scope
  when Symbol then klass.public_send(scope)
  when Proc   then scope.call(klass)
  else             klass.all
  end
end

.blog_path ⇒ Object 



246
247
248
 
# File 'lib/railspress.rb', line 246

def blog_path
  configuration.blog_path
end

.cms_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/railspress.rb', line 207

def cms_enabled?
  configuration.cms_enabled
end

.configuration ⇒ Object 



181
182
183
 
# File 'lib/railspress.rb', line 181

def configuration
  @configuration ||= Configuration.new
end

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

Yields:



185
186
187
188
 
# File 'lib/railspress.rb', line 185

def configure
  yield(configuration)
  configuration.validate!
end

.current_author_method ⇒ Object 



234
235
236
 
# File 'lib/railspress.rb', line 234

def current_author_method
  configuration.current_author_method
end

.current_author_proc ⇒ Object 



238
239
240
 
# File 'lib/railspress.rb', line 238

def current_author_proc
  configuration.current_author_proc
end

.default_index_columns ⇒ Object 



250
251
252
 
# File 'lib/railspress.rb', line 250

def default_index_columns
  configuration.default_index_columns
end

.entity_for(route_key) ⇒ Object 



267
268
269
 
# File 'lib/railspress.rb', line 267

def entity_for(route_key)
  configuration.entity_for(route_key)
end

.entity_registered?(route_key) ⇒ Boolean

Returns:

  • (Boolean) 


271
272
273
 
# File 'lib/railspress.rb', line 271

def entity_registered?(route_key)
  configuration.entity_registered?(route_key)
end

.focal_points_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/railspress.rb', line 203

def focal_points_enabled?
  configuration.focal_points_enabled
end

.image_contexts ⇒ Object 



211
212
213
 
# File 'lib/railspress.rb', line 211

def image_contexts
  configuration.image_contexts
end

.inline_editing_check ⇒ Object 



258
259
260
 
# File 'lib/railspress.rb', line 258

def inline_editing_check
  configuration.inline_editing_check
end

.post_image_variants ⇒ Object 



254
255
256
 
# File 'lib/railspress.rb', line 254

def post_image_variants
  configuration.post_image_variants
end

.post_images_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/railspress.rb', line 199

def post_images_enabled?
  configuration.post_images_enabled
end

.registered_entities ⇒ Object

Entity registry convenience accessors



263
264
265
 
# File 'lib/railspress.rb', line 263

def registered_entities
  configuration.registered_entities
end

.reset_configuration! ⇒ Object 



190
191
192
 
# File 'lib/railspress.rb', line 190

def reset_configuration!
  @configuration = Configuration.new
end

.words_per_minute ⇒ Object 



242
243
244
 
# File 'lib/railspress.rb', line 242

def words_per_minute
  configuration.words_per_minute
end