Module: RocketCMS

Defined in:
lib/rocket_cms.rb,
lib/rocket_cms/admin.rb,
lib/rocket_cms/model.rb,
lib/rocket_cms/patch.rb,
lib/rocket_cms/engine.rb,
lib/rocket_cms/version.rb,
lib/rocket_cms/migration.rb,
lib/rocket_cms/models/seo.rb,
lib/rocket_cms/models/menu.rb,
lib/rocket_cms/models/news.rb,
lib/rocket_cms/models/page.rb,
lib/rocket_cms/seo_helpers.rb,
lib/rocket_cms/configuration.rb,
lib/rocket_cms/models/gallery.rb,
lib/rocket_cms/controllers/news.rb,
lib/rocket_cms/controllers/pages.rb,
lib/rocket_cms/controllers/search.rb,
lib/rocket_cms/models/mongoid/seo.rb,
lib/rocket_cms/models/mongoid/menu.rb,
lib/rocket_cms/models/mongoid/news.rb,
lib/rocket_cms/models/mongoid/page.rb,
lib/rocket_cms/controllers/contacts.rb,
lib/rocket_cms/models/gallery_image.rb,
lib/rocket_cms/models/contact_message.rb,
lib/rocket_cms/models/mongoid/gallery.rb,
lib/rocket_cms/models/embedded_element.rb,
lib/rocket_cms/models/active_record/seo.rb,
lib/rocket_cms/models/active_record/menu.rb,
lib/rocket_cms/models/active_record/news.rb,
lib/rocket_cms/models/active_record/page.rb,
lib/rocket_cms/models/mongoid/gallery_image.rb,
lib/rocket_cms/models/embedded_gallery_image.rb,
lib/rocket_cms/models/mongoid/contact_message.rb,
lib/rocket_cms/models/mongoid/embedded_element.rb,
lib/rocket_cms/models/active_record/contact_message.rb,
lib/rocket_cms/models/mongoid/embedded_gallery_image.rb

Defined Under Namespace

Modules: Controller, Controllers, ElasticSearch, Migration, Model, Models, SeoHelpers Classes: Configuration, Engine, PatchDSL

Constant Summary collapse

VERSION =
"0.9.2"
@@patches =
{}

Class Method Summary collapse

Class Method Details

.active_record?Boolean

Returns:

  • (Boolean)


47
48
49
# File 'lib/rocket_cms.rb', line 47

def active_record?
  RocketCMS.orm == :active_record
end

.apply_patches(s) ⇒ Object



41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/rocket_cms/patch.rb', line 41

def self.apply_patches(s)
  if s.class.name.index('RailsAdmin::Config::Sections::').nil?
    if s.class.name == 'RailsAdmin::Config::Model'
      s.instance_eval(&@@patches[s.abstract_model.model_name][:admin]) unless @@patches[s.abstract_model.model_name].nil?
    else
      s.instance_eval(&@@patches[s.name][:model]) unless @@patches[s.name].nil?
    end
  else
    model = s.abstract_model.model_name
    action = s.class.name.split('::')[-1].downcase.to_sym
    s.instance_eval(&@@patches[model][action]) unless @@patches[model].nil?
  end
end

.configObject



5
6
7
# File 'lib/rocket_cms/configuration.rb', line 5

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

.configurationObject



2
3
4
# File 'lib/rocket_cms/configuration.rb', line 2

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

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

Yields:



9
10
11
# File 'lib/rocket_cms/configuration.rb', line 9

def self.configure
  yield configuration
end

.contact_message_configObject



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/rocket_cms/admin.rb', line 144

def contact_message_config
  Proc.new {
    navigation_label I18n.t('rs.settings')
    field :c_at do
      read_only true
    end
    field :name
    field :content, :text
    field :email
    field :phone

    RocketCMS.config.contacts_fields.each_pair do |fn, ft|
      next if ft.nil?
      if ft.is_a?(Array)
        field fn, ft[1].to_sym
      else
        field fn
      end
    end

    if block_given?
      yield
    end

    RocketCMS.apply_patches self
    RocketCMS.only_patches self, [:show, :list, :edit, :export]
  }
end

.embedded_element_config(navigation_label = I18n.t('rs.cms'), fields = {}) ⇒ Object



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/rocket_cms/admin.rb', line 258

def embedded_element_config(navigation_label = I18n.t('rs.cms'), fields = {})
  Proc.new {
    navigation_label(navigation_label) unless navigation_label.nil?
    field :enabled, :toggle
    field :name, :string
    fields.each_pair do |name, type|
      if type.nil?
        field name
      else
        if type.is_a?(Array)
          field name, type[0], &type[1]
        else
          field name, type
        end
      end
    end

    if block_given?
      yield
    end
  }
end

.embedded_image_config(fields = {}) ⇒ Object



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/rocket_cms/admin.rb', line 281

def embedded_image_config(fields = {})
  jcrop_proc = Proc.new do
    jcrop_options :image_jcrop_options
  end

  if block_given?
    RocketCMS.embedded_element_config(
      nil,
      {image: [:jcrop, jcrop_proc]}.merge(fields),
      yield
    )
  else
    RocketCMS.embedded_element_config(
      nil,
      {image: [:jcrop, jcrop_proc]}.merge(fields)
    )
  end
end


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/rocket_cms/admin.rb', line 300

def gallery_config
  Proc.new {
    navigation_label I18n.t('rs.gallery')
    field :enabled, :toggle

    field :name, :string
    field :slugs, :enum do
      enum_method do
        :slugs
      end
      visible do
        bindings[:view].current_user.admin?
      end
      multiple do
        true
      end
    end
    field :text_slug

    field :image, :jcrop do
      jcrop_options :image_jcrop_options
    end

    if block_given?
      yield
    end
  }
end

.image_config(without_gallery = false, fields = {}) ⇒ Object



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/rocket_cms/admin.rb', line 329

def image_config(without_gallery = false, fields = {})
  Proc.new {
    navigation_label I18n.t('rs.gallery')
    field :enabled, :toggle
    unless without_gallery
      field :gallery
    end
    field :name, :string
    field :image, :jcrop do
      jcrop_options :image_jcrop_options
    end
    fields.each_pair do |name, type|
      if type.nil?
        field name
      else
        field name, type
      end
    end

    if block_given?
      yield
    end
  }
end

.map_config(is_active = true) ⇒ Object



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/rocket_cms/admin.rb', line 3

def map_config(is_active = true)
  Proc.new {
    active is_active
    label I18n.t('rs.map')
    field :address, :string
    field :map_address, :string
    field :map_hint, :string
    field :coordinates, :string do
      read_only true
      formatted_value{ bindings[:object].coordinates.to_json }
    end
    field :lat
    field :lon

    if block_given?
      yield
    end
  }
end


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/rocket_cms/admin.rb', line 128

def menu_config
  Proc.new {
    navigation_label 'CMS'

    field :enabled, :toggle
    field :text_slug
    field :name
    RocketCMS.apply_patches self
    RocketCMS.only_patches self, [:show, :list, :edit, :export]

    if block_given?
      yield
    end
  }
end

.model_namespaceObject



50
51
52
# File 'lib/rocket_cms.rb', line 50

def model_namespace
  "RocketCMS::Models::#{RocketCMS.orm.to_s.camelize}"
end

.mongoid?Boolean

Returns:

  • (Boolean)


44
45
46
# File 'lib/rocket_cms.rb', line 44

def mongoid?
  RocketCMS.orm == :mongoid
end

.news_config(fields = {}) ⇒ Object



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/rocket_cms/admin.rb', line 173

def news_config(fields = {})
  Proc.new {
    navigation_label I18n.t('rs.cms')
    list do
      scopes [:by_date, :enabled, nil]
    end

    field :enabled, :toggle
    field :time do
      sort_reverse true
    end
    field :name
    unless RocketCMS.config.news_image_styles.nil?
      field :image, :jcrop do
        jcrop_options :image_jcrop_options
      end
    end
    field :excerpt, :ck_editor
    field :slugs, :enum do
      enum_method do
        :slugs
      end
      visible do
        bindings[:view].current_user.admin?
      end
      multiple do
        true
      end
    end
    field :text_slug

    RocketCMS.apply_patches self

    list do
      RocketCMS.apply_patches self
      sort_by :time
    end

    edit do
      field :content, :ck_editor
      fields.each_pair do |name, type|
        if type.nil?
          field name
        else
          if type.is_a?(Array)
            field name, type[0], &type[1]
          else
            field name, type
          end
        end
      end
      RocketCMS.apply_patches self
      group :seo, &RocketCMS.seo_config
      group :sitemap_data, &RocketCMS.sitemap_data_config
    end

    RocketCMS.only_patches self, [:show, :list, :export]

    if block_given?
      yield(self)
    end
  }
end

.only_patches(s, sections) ⇒ Object



31
32
33
34
35
36
37
38
39
# File 'lib/rocket_cms/patch.rb', line 31

def self.only_patches(s, sections)
  s.instance_eval do
    sections.each do |section|
      send section do
        RocketCMS.apply_patches self
      end
    end
  end
end

.orm_specific(name) ⇒ Object



53
54
55
# File 'lib/rocket_cms.rb', line 53

def orm_specific(name)
  "#{model_namespace}::#{name}".constantize
end

.page_config(fields = {}) ⇒ Object



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/rocket_cms/admin.rb', line 55

def page_config(fields = {})
  Proc.new {
    RocketCMS.apply_patches self
    navigation_label I18n.t('rs.cms')
    list do
      scopes [:sorted, :enabled, nil]

      field :enabled,  :toggle
      field :menus, :menu
      field :name
      field :fullpath do
        pretty_value do
          bindings[:view].(:a, bindings[:object].fullpath, href: bindings[:object].fullpath)
        end
      end
      field :redirect
      field :slug
      RocketCMS.apply_patches self
    end
    edit do
      field :name
      field :excerpt, :ck_editor
      field :content, :ck_editor
      RocketCMS.apply_patches self
      group :menu do
        label I18n.t('rs.menu')
        field :menus
        field :fullpath, :string do
          help I18n.t('rs.with_final_slash')
        end
        field :regexp, :string do
          help I18n.t('rs.page_url_regex')
        end
        field :redirect, :string do
          help I18n.t('rs.final_in_menu')
        end
        field :text_slug
      end
      fields.each_pair do |name, type|
        if type.nil?
          field name
        else
          if type.is_a?(Array)
            field name, type[0], &type[1]
          else
            field name, type
          end
        end
      end
      if Seo.separate_table?
        group :seo do
          active true
          field :seo do
            active true
          end
        end
      else
        group :seo, &RocketCMS.seo_config(true)
      end
      group :sitemap_data, &RocketCMS.sitemap_data_config
    end
    RocketCMS.only_patches self, [:show, :export]
    nested_set({
      max_depth: RocketCMS.config.menu_max_depth,
      scopes: []
    })

    if block_given?
      yield
    end
  }
end

.patch(model, &blk) ⇒ Object



55
56
57
# File 'lib/rocket_cms/patch.rb', line 55

def self.patch(model, &blk)
   @@patches[model] = PatchDSL.call(&blk)
end

.seo_config(is_active = true) ⇒ Object



23
24
25
26
27
28
29
30
31
32
33
# File 'lib/rocket_cms/admin.rb', line 23

def seo_config(is_active = true)
  Proc.new {
    if respond_to?(:active)
      active is_active
      label "SEO"
    else
      visible false
    end
    RocketCMS.seo_fields(self)
  }
end

.seo_fields(s) ⇒ Object



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/rocket_cms/admin.rb', line 35

def seo_fields(s)
  s.instance_eval do
    field :h1, :string
    field :title, :string
    field :keywords, :text
    field :description, :text
    field :robots, :string

    field :og_title, :string

    field :og_image, :jcrop do
      jcrop_options :og_image_jcrop_options
    end

    if block_given?
      yield
    end
  end
end

.sitemap_data_config(is_active = false) ⇒ Object



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/rocket_cms/admin.rb', line 237

def sitemap_data_config(is_active = false)
  Proc.new {
    active is_active
    label I18n.t('rs.sitemap_data')
    field :sitemap_show
    field :sitemap_lastmod
    field :sitemap_changefreq, :enum do
      enum do
        SitemapData::SITEMAP_CHANGEFREQ_ARRAY
      end
    end
    field :sitemap_priority

    if block_given?
      yield
    end
  }
end