Class: Caboose::Schema

Inherits:
Utilities::Schema
  • Object
show all
Defined in:
app/models/caboose/schema.rb

Class Method Summary collapse

Class Method Details

.indexes ⇒ Object

Any column indexes that need to exist in the database



23
24
25
26
27
28
29
30
 
# File 'app/models/caboose/schema.rb', line 23

def self.indexes
  {
    :role_memberships          => [ :role_id    , :user_id          ],
    :role_permissions          => [ :role_id    , :permission_id    ],
    :post_category_memberships => [ :post_id    , :post_category_id ],
    :sessions                  => [ :session_id , :updated_at       ]
  }
end

.load_data ⇒ Object

Loads initial data into the database



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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'app/models/caboose/schema.rb', line 205

def self.load_data

  c = ActiveRecord::Base.connection    
  #if c.column_exists?(:pages, :content)
  #  Caboose::Page.reorder(:id).all.each do |p|
  #    Caboose::PageBlock.create( :page_id => p.id, :block_type => 'richtext', :value => p.content )        
  #  end      
  #  c.remove_column(:pages, :content)
  #end
    
  if !Caboose::PageBlockType.where(:name => 'heading').exists?
    bt = Caboose::PageBlockType.create(:name => 'heading', :description => 'Heading')
    Caboose::PageBlockField.create(:page_block_type_id => bt.id, :name => 'text', :field_type => 'text', :nice_name => 'Text', :default => '', :width => 800, :fixed_placeholder => false)
    Caboose::PageBlockField.create(:page_block_type_id => bt.id, :name => 'size', :field_type => 'text', :nice_name => 'Size', :default =>  1, :width => 800, :fixed_placeholder => false, :options => "1|2|3|4|5|6")
  end
  
  if !Caboose::PageBlockType.where(:name => 'richtext').exists?
    bt = Caboose::PageBlockType.create(:name => 'richtext', :description => 'Rich Text')
    Caboose::PageBlockField.create(:page_block_type_id => bt.id, :name => 'text', :field_type => 'richtext', :nice_name => 'Text', :default => '', :width => 800, :height => 400, :fixed_placeholder => false)      
  end
  
  admin_user = nil
  if !Caboose::User.exists?(:username => 'admin')
    admin_user = Caboose::User.create(:first_name => 'Admin', :last_name => 'User', :username => 'admin', :email => '[email protected]')
    admin_user.password = Digest::SHA1.hexdigest(Caboose::salt + 'caboose')
    admin_user.save
  end
  admin_user = Caboose::User.where(:username => 'admin').first if admin_user.nil?
  
  Caboose::Role.create(:parent_id => -1           , :name => 'Admin'               ) if !Caboose::Role.exists?(:name =>  'Admin'               )
  admin_role  = Caboose::Role.where(:name => 'Admin'               ).first
  Caboose::Role.create(:parent_id => -1           , :name => 'Everyone Logged Out' ) if !Caboose::Role.exists?(:name =>  'Everyone Logged Out' )
  elo_role    = Caboose::Role.where(:name => 'Everyone Logged Out' ).first
  Caboose::Role.create(:parent_id => elo_role.id  , :name => 'Everyone Logged In'  ) if !Caboose::Role.exists?(:name =>  'Everyone Logged In'  )
  eli_role    = Caboose::Role.where(:name => 'Everyone Logged In'  ).first
  
  Caboose::User.create(:first_name => 'John', :last_name => 'Doe', :username => 'elo', :email => '[email protected]') if !Caboose::User.exists?(:username => 'elo')
  elo_user = Caboose::User.where(:username => 'elo').first
   
  Caboose::Permission.create(:resource => 'all'         , :action => 'all'    ) if !Caboose::Permission.exists?(:resource => 'all'	       , :action => 'all'    )
  Caboose::Permission.create(:resource => 'users'	      , :action => 'view'   ) if !Caboose::Permission.exists?(:resource => 'users'	     , :action => 'view'   )
  Caboose::Permission.create(:resource => 'users'	      , :action => 'edit'   ) if !Caboose::Permission.exists?(:resource => 'users'	     , :action => 'edit'   )
  Caboose::Permission.create(:resource => 'users'	      , :action => 'delete' ) if !Caboose::Permission.exists?(:resource => 'users'	     , :action => 'delete' )
  Caboose::Permission.create(:resource => 'users'	      , :action => 'add'    ) if !Caboose::Permission.exists?(:resource => 'users'	     , :action => 'add'    )
  Caboose::Permission.create(:resource => 'roles'	      , :action => 'view'   ) if !Caboose::Permission.exists?(:resource => 'roles'	     , :action => 'view'   )
  Caboose::Permission.create(:resource => 'roles'	      , :action => 'edit'   ) if !Caboose::Permission.exists?(:resource => 'roles'	     , :action => 'edit'   )
  Caboose::Permission.create(:resource => 'roles'	      , :action => 'delete' ) if !Caboose::Permission.exists?(:resource => 'roles'	     , :action => 'delete' )
  Caboose::Permission.create(:resource => 'roles'	      , :action => 'add'    ) if !Caboose::Permission.exists?(:resource => 'roles'	     , :action => 'add'    )
  Caboose::Permission.create(:resource => 'permissions' , :action => 'view'   ) if !Caboose::Permission.exists?(:resource => 'permissions' , :action => 'view'   )
  Caboose::Permission.create(:resource => 'permissions' , :action => 'edit'   ) if !Caboose::Permission.exists?(:resource => 'permissions' , :action => 'edit'   )
  Caboose::Permission.create(:resource => 'permissions' , :action => 'delete' ) if !Caboose::Permission.exists?(:resource => 'permissions' , :action => 'delete' )
  Caboose::Permission.create(:resource => 'permissions' , :action => 'add'    ) if !Caboose::Permission.exists?(:resource => 'permissions' , :action => 'add'    )

  # Add the admin user to the admin role
  Caboose::RoleMembership.create(:user_id => admin_user.id, :role_id => admin_role.id) if !Caboose::RoleMembership.exists?(:user_id => admin_user.id, :role_id => admin_role.id)
  
  # Add the elo to the elo role
  Caboose::RoleMembership.create(:user_id => elo_user.id, :role_id => elo_role.id) if !Caboose::RoleMembership.exists?(:user_id => elo_user.id, :role_id => elo_role.id)

  # Add the all/all permission to the admin role
  admin_perm = Caboose::Permission.where(:resource => 'all', :action => 'all').first
  Caboose::RolePermission.create(:role_id => admin_role.id, :permission_id => admin_perm.id) if !Caboose::RolePermission.exists?(:role_id => admin_role.id, :permission_id => admin_perm.id)
  
  # Create the necessary pages
  Caboose::Page.create(:title => 'Home'  , :parent_id => -1, :hide => 0, :layout => 'home', :uri => '') if !Caboose::Page.exists?(:title => 'Home')
  home_page = Caboose::Page.where(:title => 'Home', :parent_id => -1).first
  Caboose::Page.create(:title => 'Admin' , :parent_id => home_page.id, :hide => 0, :layout => 'admin', :alias => 'admin', :slug => 'admin', :uri => 'admin') if !Caboose::Page.exists?(:alias => 'admin')
  admin_page = Caboose::Page.where(:alias => 'admin').first
  Caboose::Page.create(:title => 'Login' , :parent_id => home_page.id, :hide => 0, :layout => 'login', :alias => 'login', :slug => 'login', :uri => 'login') if !Caboose::Page.exists?(:alias => 'login')
   = Caboose::Page.where(:alias => 'login').first
      
  Caboose::PagePermission.create(:role_id => elo_role.id, :page_id => home_page.id  , :action => 'view') if !Caboose::PagePermission.exists?(:role_id => elo_role.id, :page_id => home_page.id  , :action => 'view') 
  Caboose::PagePermission.create(:role_id => elo_role.id, :page_id => .id , :action => 'view') if !Caboose::PagePermission.exists?(:role_id => elo_role.id, :page_id => .id , :action => 'view')
  
  # Create a default post category
  Caboose::PostCategory.create(:name => 'General News') if !Caboose::PostCategory.exists?(:name => 'General News')
  
  # Create the required settings
  Caboose::Setting.create(:name => 'version'     , :value => Caboose::VERSION        ) if !Caboose::Setting.exists?(:name => 'version'     , :value => Caboose::VERSION        )
  Caboose::Setting.create(:name => 'site_name'   , :value => 'New Caboose Site'      ) if !Caboose::Setting.exists?(:name => 'site_name'   , :value => 'New Caboose Site'      )
  Caboose::Setting.create(:name => 'site_url'    , :value => 'www.mycaboosesite.com' ) if !Caboose::Setting.exists?(:name => 'site_url'    , :value => 'www.mycaboosesite.com' )
  Caboose::Setting.create(:name => 'admin_email' , :value => '[email protected]'       ) if !Caboose::Setting.exists?(:name => 'admin_email' , :value => '[email protected]'       )
  
end

.removed_columns ⇒ Object 



12
13
14
15
16
17
18
19
20
 
# File 'app/models/caboose/schema.rb', line 12

def self.removed_columns
  {
    Caboose::PageBlock => [:block_type, :value, :name],      
    Caboose::PageBlockField => [:model_binder_options],
    Caboose::AbValue => [:i, :text],
    Caboose::AbOption => [:text],
    Caboose::User => [:timezone]
  }
end

.renamed_tables ⇒ Object

Tables (in order) that were renamed in the development of the gem.



5
6
7
8
9
10
 
# File 'app/models/caboose/schema.rb', line 5

def self.renamed_tables
  {
    :roles_users       => :role_memberships,
    :permissions_roles => :role_permissions
  }
end

.schema ⇒ Object

The schema of the database { Model => [[name, data_type, options]] }



34
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
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
172
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
 
# File 'app/models/caboose/schema.rb', line 34

def self.schema      
  {
    Caboose::User => [  	
      [ :first_name           , :string     ],     
      [ :last_name            , :string     ], 
      [ :username             , :string     ], 
      [ :email                , :string     ],         
      [ :address              , :string     ],
      [ :address2             , :string     ],
      [ :city                 , :string     ],
      [ :state                , :string     ],
      [ :zip                  , :string     ],
      [ :phone                , :string     ],
      [ :fax                  , :string     ],
      [ :utc_offset           , :float      , { :default => -5 }],
      #[ :timezone             , :string     , { :default => 'America/Chicago' }],
      [ :timezone_id          , :integer    , { :defualt => 381 }], # Defaults to 'America/Chicago'        
      [ :password             , :string     ], 
      [ :password_reset_id    , :string     ], 
      [ :password_reset_sent  , :datetime   ], 
      [ :token                , :string     ], 
      [ :date_created         , :datetime   ],
      [ :image                , :attachment ]
    ],
    Caboose::Role => [    
      [ :parent_id            , :integer  ], 
      [ :name                 , :string   ],
      [ :description          , :string   ]
    ],
    Caboose::Permission => [    
      [ :resource , :string ], 
      [ :action   , :string ]
    ],
    Caboose::RoleMembership => [    
      [ :role_id, :integer ],
      [ :user_id, :integer ]
    ],
    Caboose::RolePermission => [
   	[ :role_id        , :integer ],
   	[ :permission_id  , :integer ]		
   ],
   Caboose::Asset => [
      [ :page_id        , :integer    ],  
      [ :user_id        , :integer    ], 
      [ :date_uploaded  , :datetime   ], 
      [ :name           , :string     ], 
      [ :filename       , :string     ], 
      [ :description    , :string     ], 
      [ :extension      , :string     ]
    ],
    Caboose::Page => [        
      [ :parent_id             , :integer ], 
      [ :title                 , :string  ],
      [ :menu_title            , :string  ],
      #[ :content               , :text    ],
      [ :slug                  , :string  ],
      [ :alias                 , :string  ],
      [ :uri                   , :string  ],
      [ :redirect_url          , :string  ],
      [ :hide                  , :boolean , :default => false ],
      [ :content_format        , :integer , :default => Caboose::Page::CONTENT_FORMAT_HTML ],
      [ :custom_css            , :text    ],
      [ :custom_js             , :text    ],
      [ :linked_resources      , :text    ],
      [ :layout                , :string  ],
      [ :sort_order            , :integer , :default => 0                ],
      [ :custom_sort_children  , :boolean , :default => false            ],
      [ :seo_title             , :string  , :limit => 70                 ],
      [ :meta_description      , :string  , :limit => 156                ],
      [ :meta_robots           , :string  , :default => 'index, follow'  ],
      [ :canonical_url         , :string  ],
      [ :fb_description        , :string  , :limit => 156 ],
      [ :gp_description        , :string  , :limit => 156 ]
    ],
    Caboose::PageBlock => [        
      [ :page_id               , :integer ],         
      [ :page_block_type_id    , :integer ],
      [ :sort_order            , :integer , :default => 0   ],
      [ :name                  , :string  ],
      [ :value                 , :text    ]        
    ],
    Caboose::PageBlockType => [        
      [ :name                  , :string  ],
      [ :description           , :string  ],
      [ :use_render_function   , :boolean , :default => false ],
      [ :render_function       , :text    ] 
    ],
    Caboose::PageBlockField => [
      [ :page_block_type_id   , :integer ],      
      [ :name                 , :string  ],
      [ :field_type           , :string  ],
      [ :nice_name            , :string  ],
      [ :default              , :text    ],
      [ :width                , :integer ],
      [ :height               , :integer ],
      [ :fixed_placeholder    , :boolean ],
      [ :options              , :text    ],
      [ :options_url          , :string  ]
    ],
    Caboose::PageBlockFieldValue => [
      [ :page_block_id        , :integer    ],
      [ :page_block_field_id  , :integer    ],
      [ :value                , :text       ],
      [ :file                 , :attachment ],
      [ :image                , :attachment ]
    ],      
    Caboose::Post => [  
      [ :title       , :text       ],  		 	 
      [ :body        , :text 		   ],  	 
      [ :hide        , :boolean    ], 	 
      [ :image_url   , :text 		   ],
      [ :published   , :boolean    ],
      [ :created_at  , :datetime   ],
      [ :updated_at  , :datetime   ],
      [ :image       , :attachment ]
    ],
    Caboose::PostCategory => [
      [ :name , :string ]
    ],    
    Caboose::PostCategoryMembership => [    
      [ :post_id          , :integer ],
      [ :post_category_id , :integer ]
    ],    
    Caboose::PagePermission => [
      [ :role_id , :integer  ],  
      [ :page_id , :integer  ],
      [ :action  , :string   ]
    ],
    Caboose::AbVariant => [
      [ :name           , :string ],
      [ :analytics_name , :string ],
    ],
    Caboose::AbOption => [        
      [ :ab_variant_id , :integer ],
      [ :value         , :string  ]
    ],
    Caboose::AbValue => [
      [ :session_id    , :string  ],
      [ :ab_variant_id , :integer ],
      [ :ab_option_id  , :integer ]
    ],
    Caboose::DatabaseSession => [
      [ :session_id  , :string   , :null => false ],
      [ :data        , :text                      ],
      [ :created_at  , :datetime , :null => true  ],
      [ :updated_at  , :datetime , :null => true  ]
    ],    
    Caboose::Setting => [    
      [ :name  , :string ],
      [ :value , :text   ]
    ],
    Caboose::Timezone => [
      [ :country_code , :string ],
      [ :name         , :string ]
    ],
    Caboose::TimezoneAbbreviation => [        
      [ :abbreviation , :string  ],
      [ :name         , :string  ]                
    ],
    Caboose::TimezoneOffset => [
      [ :timezone_id  , :integer  ],
      [ :abbreviation , :string   ],
      [ :time_start   , :integer  ],
      [ :gmt_offset   , :integer  ],
      [ :dst          , :boolean  ]        
    ]            
  }

end