unknown_admin 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.md +57 -0
- data/Rakefile +38 -0
- data/app/controllers/admin/admin_controller.rb +60 -0
- data/app/controllers/admin/resources_controller.rb +44 -0
- data/app/controllers/admin/users_controller.rb +52 -0
- data/app/helpers/admin/resources_helper.rb +41 -0
- data/app/models/user.rb +4 -0
- data/app/views/admin/admin/index.html.erb +36 -0
- data/app/views/admin/resources/_breadcrumb.html.erb +6 -0
- data/app/views/admin/resources/_condition_fields.html.erb +10 -0
- data/app/views/admin/resources/_form.html.erb +4 -0
- data/app/views/admin/resources/_form_actions.html.erb +5 -0
- data/app/views/admin/resources/_form_fields.html.erb +4 -0
- data/app/views/admin/resources/_list.html.erb +13 -0
- data/app/views/admin/resources/_list_actions.html.erb +5 -0
- data/app/views/admin/resources/_list_header.html.erb +6 -0
- data/app/views/admin/resources/_list_item.html.erb +12 -0
- data/app/views/admin/resources/_list_item_actions.html.erb +11 -0
- data/app/views/admin/resources/_search_field.html.erb +31 -0
- data/app/views/admin/resources/edit.html.erb +19 -0
- data/app/views/admin/resources/index.html.erb +11 -0
- data/app/views/admin/resources/new.html.erb +19 -0
- data/app/views/admin/resources/show.html.erb +23 -0
- data/app/views/admin/users/_form.html.erb +102 -0
- data/app/views/admin/users/_form_new.html.erb +66 -0
- data/app/views/admin/users/token_fields.json.rabl +2 -0
- data/app/views/devise/confirmations/new.html.erb +12 -0
- data/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
- data/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
- data/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
- data/app/views/devise/passwords/edit.html.erb +16 -0
- data/app/views/devise/passwords/new.html.erb +12 -0
- data/app/views/devise/registrations/edit.html.erb +25 -0
- data/app/views/devise/registrations/new.html.erb +18 -0
- data/app/views/devise/sessions/new.html.erb +17 -0
- data/app/views/devise/shared/_links.erb +25 -0
- data/app/views/devise/unlocks/new.html.erb +12 -0
- data/app/views/layouts/admin/application.html.erb +31 -0
- data/config/routes.rb +8 -0
- data/lib/generators/unknown_admin/controller/controller_generator.rb +68 -0
- data/lib/generators/unknown_admin/controller/templates/standard_controller.rb +12 -0
- data/lib/generators/unknown_admin/install/install_generator.rb +36 -0
- data/lib/generators/unknown_admin/install/templates/admin.css +17 -0
- data/lib/generators/unknown_admin/install/templates/admin.js +20 -0
- data/lib/generators/unknown_admin/install/templates/admin_controller.rb +63 -0
- data/lib/generators/unknown_admin/install/templates/application.html.erb +39 -0
- data/lib/generators/unknown_admin/install/templates/resources_controller.rb +44 -0
- data/lib/tasks/unknown_admin_tasks.rake +4 -0
- data/lib/unknown_admin.rb +17 -0
- data/lib/unknown_admin/version.rb +3 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +59 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +58 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/test_helper.rb +15 -0
- data/test/unknown_admin_test.rb +7 -0
- metadata +290 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<h2>Resend unlock instructions</h2>
|
|
2
|
+
|
|
3
|
+
<%= form_for(resource, :as => resource_name, :url => unlock_path(resource_name), :html => { :method => :post }) do |f| %>
|
|
4
|
+
<%= devise_error_messages! %>
|
|
5
|
+
|
|
6
|
+
<div><%= f.label :email %><br />
|
|
7
|
+
<%= f.email_field :email %></div>
|
|
8
|
+
|
|
9
|
+
<div><%= f.submit "Resend unlock instructions" %></div>
|
|
10
|
+
<% end %>
|
|
11
|
+
|
|
12
|
+
<%= render "devise/shared/links" %>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale = 1" />
|
|
5
|
+
<title>UnknownAdmin: <%= "#{params[:controller]}-#{params[:action]}" %></title>
|
|
6
|
+
<%= stylesheet_link_tag "admin/admin", :media => "all" %>
|
|
7
|
+
<%= javascript_include_tag "admin/admin" %>
|
|
8
|
+
<style type="text/css" title="text/css">
|
|
9
|
+
</style>
|
|
10
|
+
<%= csrf_meta_tags %>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<div class="container">
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
<%= bootstrap_flash %>
|
|
17
|
+
<div class="row">
|
|
18
|
+
<div class="span12">
|
|
19
|
+
<%= yield %>
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<div class="span3 hidden">
|
|
23
|
+
<div id="detailColumn" >
|
|
24
|
+
<%= yield :detail_column %>
|
|
25
|
+
</div>
|
|
26
|
+
</div>
|
|
27
|
+
</div>
|
|
28
|
+
</div>
|
|
29
|
+
<div id="modal_container"></div>
|
|
30
|
+
</body>
|
|
31
|
+
</html>
|
data/config/routes.rb
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
require 'rails/generators'
|
|
2
|
+
|
|
3
|
+
module UnknownAdmin
|
|
4
|
+
module Generators
|
|
5
|
+
class ControllerGenerator < ::Rails::Generators::NamedBase
|
|
6
|
+
|
|
7
|
+
source_root File.expand_path("../templates", __FILE__)
|
|
8
|
+
desc "This generator creates a slim 'inherited-resources' controller"
|
|
9
|
+
class_option :skip_routes, :type => :boolean, :default => "false",:desc=>"Skip adding resource/namespace to route file"
|
|
10
|
+
#argument :stylesheets_type, :type => :string, :default => 'less', :banner => '*less or static'
|
|
11
|
+
|
|
12
|
+
def create_controller
|
|
13
|
+
|
|
14
|
+
template "standard_controller.rb", "app/controllers/admin/#{file_name}_controller.rb"
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def update_routes
|
|
20
|
+
unless options.skip_routes
|
|
21
|
+
line = "namespace :admin"
|
|
22
|
+
|
|
23
|
+
unless File.read('config/routes.rb').match(/^\s*#{Regexp.escape(line)}/i)
|
|
24
|
+
route_namespace "#{line} do end"
|
|
25
|
+
end
|
|
26
|
+
route_into "resources :#{file_name}",:admin
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
private
|
|
31
|
+
def route_into(routing_code,namespace)
|
|
32
|
+
log :route, routing_code
|
|
33
|
+
line = "namespace :#{namespace.to_s} do"
|
|
34
|
+
sentinel = /\s*#{Regexp.escape(line)}/mi
|
|
35
|
+
|
|
36
|
+
in_root do
|
|
37
|
+
inject_into_file 'config/routes.rb', "\n #{routing_code}\n", { :after => sentinel, :verbose => false }
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
def route_namespace(routing_code)
|
|
41
|
+
log :route, routing_code
|
|
42
|
+
sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
|
|
43
|
+
|
|
44
|
+
in_root do
|
|
45
|
+
inject_into_file 'config/routes.rb', "\n #{routing_code}\n", { :after => sentinel, :verbose => false }
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def file_name
|
|
50
|
+
name.underscore.pluralize
|
|
51
|
+
end
|
|
52
|
+
def model_name
|
|
53
|
+
name.singularize.underscore
|
|
54
|
+
end
|
|
55
|
+
def model
|
|
56
|
+
name.singularize.camelize.constantize
|
|
57
|
+
end
|
|
58
|
+
def klass_name
|
|
59
|
+
name.camelize.pluralize
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def columns
|
|
63
|
+
model.column_names.map{|c| ":#{c}"}
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
end
|
|
68
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
require 'rails/generators'
|
|
2
|
+
|
|
3
|
+
module UnknownAdmin
|
|
4
|
+
module Generators
|
|
5
|
+
class InstallGenerator < ::Rails::Generators::Base
|
|
6
|
+
|
|
7
|
+
source_root File.expand_path("../templates", __FILE__)
|
|
8
|
+
desc "This generator installs Twitter Bootstrap to Admin Asset Pipeline"
|
|
9
|
+
argument :stylesheets_type, :type => :string, :default => 'less', :banner => '*less or static'
|
|
10
|
+
|
|
11
|
+
def add_assets
|
|
12
|
+
|
|
13
|
+
unless File.exist?('app/assets/javascripts/admin/admin.js')
|
|
14
|
+
copy_file "admin.js", "app/assets/javascripts/admin/admin.js"
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
unless File.exist?('app/assets/stylesheets/admin/admin.css')
|
|
18
|
+
copy_file "admin.css", "app/assets/stylesheets/admin/admin.css"
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
unless File.exist?('app/views/layouts/admin/application.html.erb')
|
|
22
|
+
copy_file "application.html.erb", "app/views/layouts/admin/application.html.erb"
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
unless File.exist?('app/controllers/admin/admin_controller.rb')
|
|
26
|
+
copy_file "admin_controller.rb", "app/controllers/admin/admin_controller.rb"
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
unless File.exist?('app/controllers/admin/resources_controller.rb')
|
|
30
|
+
copy_file "resources_controller.rb", "app/controllers/admin/resources_controller.rb"
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
|
3
|
+
* listed below.
|
|
4
|
+
*
|
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
|
7
|
+
*
|
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
|
10
|
+
*
|
|
11
|
+
*= require_self
|
|
12
|
+
*= require bootstrap_and_overrides
|
|
13
|
+
*= require bootstrap-datepicker
|
|
14
|
+
*= require chosen
|
|
15
|
+
*= require token-input-facebook
|
|
16
|
+
*= require_tree .
|
|
17
|
+
*/
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
|
2
|
+
// listed below.
|
|
3
|
+
//
|
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
|
6
|
+
//
|
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
|
8
|
+
// the compiled file.
|
|
9
|
+
//
|
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
|
12
|
+
//
|
|
13
|
+
//= require jquery
|
|
14
|
+
//= require jquery_ujs
|
|
15
|
+
//= require jquery-ui
|
|
16
|
+
//= require chosen-jquery
|
|
17
|
+
//= require jquery.tokeninput
|
|
18
|
+
//= require bootstrap-datepicker
|
|
19
|
+
//= require twitter/bootstrap
|
|
20
|
+
//= require_tree .
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
module Admin
|
|
2
|
+
class AdminController < ActionController::Base
|
|
3
|
+
|
|
4
|
+
#before_filter :authenticate_user!
|
|
5
|
+
protect_from_forgery
|
|
6
|
+
|
|
7
|
+
layout :ajax_request
|
|
8
|
+
#before_filter :authorize
|
|
9
|
+
|
|
10
|
+
#delegate :allow?, to: :current_permission
|
|
11
|
+
helper_method :allow?
|
|
12
|
+
|
|
13
|
+
#delegate :allow_param?, to: :current_permission
|
|
14
|
+
#helper_method :allow_param?
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
#helper_method :current_domain
|
|
18
|
+
helper_method :current_style
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
private
|
|
23
|
+
def ajax_request
|
|
24
|
+
|
|
25
|
+
request.xhr? ? "admin/ajax" : "admin/application"
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
## TODO: Fix this
|
|
31
|
+
def allow?(*args)
|
|
32
|
+
true
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def current_domain
|
|
36
|
+
@current_domain ||= Domain.find(session[:current_domain_id]) unless session[:current_domain_id].nil?
|
|
37
|
+
end
|
|
38
|
+
def current_style
|
|
39
|
+
color = "#fff"
|
|
40
|
+
|
|
41
|
+
templ=Tilt::ERBTemplate.new { "body { background-color:<%=color%>}" }
|
|
42
|
+
return templ.render(self,:color=>color)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def current_permission
|
|
46
|
+
@current_permission ||= Permissions.permission_for(current_user)
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def current_resource
|
|
50
|
+
nil
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def authorize
|
|
54
|
+
User.current=current_user
|
|
55
|
+
if current_permission.allow?(params[:controller], params[:action], current_resource)
|
|
56
|
+
current_permission.permit_params! params
|
|
57
|
+
else
|
|
58
|
+
render :text=> "Not authorized.",:status=>:unauthorized
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
end
|
|
63
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale = 1" />
|
|
5
|
+
<title>B2kAdmin: <%= "#{params[:controller]}-#{params[:action]}" %></title>
|
|
6
|
+
<%= stylesheet_link_tag "admin/admin", :media => "all" %>
|
|
7
|
+
<%= javascript_include_tag "admin/admin" %>
|
|
8
|
+
<style type="text/css" title="text/css">
|
|
9
|
+
<%= current_style %>
|
|
10
|
+
</style>
|
|
11
|
+
<%= csrf_meta_tags %>
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<div class="container">
|
|
15
|
+
|
|
16
|
+
<div class="navbar navbar-fixed-top">
|
|
17
|
+
<div class="navbar-inner">
|
|
18
|
+
<div class="container">
|
|
19
|
+
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a>
|
|
20
|
+
<%= link_to "Unknown Admin", admin_root_url,class:"brand" %>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</div>
|
|
26
|
+
</div><!-- /navbar-inner -->
|
|
27
|
+
</div>
|
|
28
|
+
<%= bootstrap_flash %>
|
|
29
|
+
<div class="row">
|
|
30
|
+
<div class="span12">
|
|
31
|
+
<%= yield %>
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
</div>
|
|
36
|
+
</div>
|
|
37
|
+
<div id="modal_container"></div>
|
|
38
|
+
</body>
|
|
39
|
+
</html>
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
require 'inherited_resources'
|
|
2
|
+
module Admin
|
|
3
|
+
class ResourcesController < AdminController
|
|
4
|
+
|
|
5
|
+
inherit_resources
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
helper_method :list_fields
|
|
9
|
+
def list_fields
|
|
10
|
+
resource_class.column_names
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
helper_method :show_fields
|
|
14
|
+
def show_fields
|
|
15
|
+
(resource_class.column_names-["id","created_by","updated_by","created_at","updated_at"])
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
helper_method :search_fields
|
|
19
|
+
def search_fields
|
|
20
|
+
[]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def create
|
|
25
|
+
create! { collection_path }
|
|
26
|
+
end
|
|
27
|
+
def update
|
|
28
|
+
update! { collection_path }
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
protected
|
|
33
|
+
|
|
34
|
+
def collection
|
|
35
|
+
@search = end_of_association_chain.search(params[:q])
|
|
36
|
+
get_collection_ivar || set_collection_ivar(@search.result.paginate(:page => params[:page], :per_page => per_page))
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
def per_page
|
|
40
|
+
10
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
require 'rails'
|
|
2
|
+
|
|
3
|
+
module UnknownAdmin
|
|
4
|
+
class UnknownAdminEngine < ::Rails::Engine
|
|
5
|
+
config.unknown_admin = UnknownAdmin
|
|
6
|
+
require "inherited_resources"
|
|
7
|
+
require "has_scope"
|
|
8
|
+
require "twitter-bootstrap-rails"
|
|
9
|
+
require "bootstrap-datepicker-rails"
|
|
10
|
+
require "bootstrap-will_paginate"
|
|
11
|
+
require "will_paginate"
|
|
12
|
+
require "chosen-rails"
|
|
13
|
+
require "ransack"
|
|
14
|
+
require "simple_form"
|
|
15
|
+
require "strong_parameters"
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
== Welcome to Rails
|
|
2
|
+
|
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
|
5
|
+
|
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
|
12
|
+
and directing data to the view.
|
|
13
|
+
|
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
|
17
|
+
methods. You can read more about Active Record in
|
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
|
19
|
+
|
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
|
25
|
+
Rails. You can read more about Action Pack in
|
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
== Getting Started
|
|
30
|
+
|
|
31
|
+
1. At the command prompt, create a new Rails application:
|
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
|
33
|
+
|
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
|
36
|
+
|
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
|
39
|
+
|
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
|
41
|
+
the following resources handy:
|
|
42
|
+
|
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
== Debugging Rails
|
|
48
|
+
|
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
|
50
|
+
will help you debug it and get it back on the rails.
|
|
51
|
+
|
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
|
56
|
+
|
|
57
|
+
You can also log your own messages directly into the log file from your code
|
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
|
59
|
+
|
|
60
|
+
class WeblogController < ActionController::Base
|
|
61
|
+
def destroy
|
|
62
|
+
@weblog = Weblog.find(params[:id])
|
|
63
|
+
@weblog.destroy
|
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
The result will be a message in your log file along the lines of:
|
|
69
|
+
|
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
|
71
|
+
|
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
|
73
|
+
|
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
|
75
|
+
several books available online as well:
|
|
76
|
+
|
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
|
79
|
+
|
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
|
81
|
+
programming in general.
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
== Debugger
|
|
85
|
+
|
|
86
|
+
Debugger support is available through the debugger command when you start your
|
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
|
91
|
+
|
|
92
|
+
class WeblogController < ActionController::Base
|
|
93
|
+
def index
|
|
94
|
+
@posts = Post.all
|
|
95
|
+
debugger
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
|
101
|
+
|
|
102
|
+
>> @posts.inspect
|
|
103
|
+
=> "[#<Post:0x14a6be8
|
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
|
105
|
+
#<Post:0x14a6620
|
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
|
108
|
+
=> "hello from a debugger"
|
|
109
|
+
|
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
|
111
|
+
|
|
112
|
+
>> f = @posts.first
|
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
|
114
|
+
>> f.
|
|
115
|
+
Display all 152 possibilities? (y or n)
|
|
116
|
+
|
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
== Console
|
|
121
|
+
|
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
|
126
|
+
without arguments will launch it in the development environment.
|
|
127
|
+
|
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
|
129
|
+
directory.
|
|
130
|
+
|
|
131
|
+
Options:
|
|
132
|
+
|
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
|
134
|
+
made to the database.
|
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
|
137
|
+
|
|
138
|
+
To reload your controllers and models after launching the console run
|
|
139
|
+
<tt>reload!</tt>
|
|
140
|
+
|
|
141
|
+
More information about irb can be found at:
|
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
== dbconsole
|
|
146
|
+
|
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
|
152
|
+
PostgreSQL and SQLite 3.
|
|
153
|
+
|
|
154
|
+
== Description of Contents
|
|
155
|
+
|
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
|
157
|
+
|
|
158
|
+
|-- app
|
|
159
|
+
| |-- assets
|
|
160
|
+
| |-- images
|
|
161
|
+
| |-- javascripts
|
|
162
|
+
| `-- stylesheets
|
|
163
|
+
| |-- controllers
|
|
164
|
+
| |-- helpers
|
|
165
|
+
| |-- mailers
|
|
166
|
+
| |-- models
|
|
167
|
+
| `-- views
|
|
168
|
+
| `-- layouts
|
|
169
|
+
|-- config
|
|
170
|
+
| |-- environments
|
|
171
|
+
| |-- initializers
|
|
172
|
+
| `-- locales
|
|
173
|
+
|-- db
|
|
174
|
+
|-- doc
|
|
175
|
+
|-- lib
|
|
176
|
+
| `-- tasks
|
|
177
|
+
|-- log
|
|
178
|
+
|-- public
|
|
179
|
+
|-- script
|
|
180
|
+
|-- test
|
|
181
|
+
| |-- fixtures
|
|
182
|
+
| |-- functional
|
|
183
|
+
| |-- integration
|
|
184
|
+
| |-- performance
|
|
185
|
+
| `-- unit
|
|
186
|
+
|-- tmp
|
|
187
|
+
| |-- cache
|
|
188
|
+
| |-- pids
|
|
189
|
+
| |-- sessions
|
|
190
|
+
| `-- sockets
|
|
191
|
+
`-- vendor
|
|
192
|
+
|-- assets
|
|
193
|
+
`-- stylesheets
|
|
194
|
+
`-- plugins
|
|
195
|
+
|
|
196
|
+
app
|
|
197
|
+
Holds all the code that's specific to this particular application.
|
|
198
|
+
|
|
199
|
+
app/assets
|
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
|
201
|
+
|
|
202
|
+
app/controllers
|
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
|
204
|
+
automated URL mapping. All controllers should descend from
|
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
|
206
|
+
|
|
207
|
+
app/models
|
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
|
209
|
+
ActiveRecord::Base by default.
|
|
210
|
+
|
|
211
|
+
app/views
|
|
212
|
+
Holds the template files for the view that should be named like
|
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
|
214
|
+
eRuby syntax by default.
|
|
215
|
+
|
|
216
|
+
app/views/layouts
|
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
|
221
|
+
layout.
|
|
222
|
+
|
|
223
|
+
app/helpers
|
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
|
225
|
+
generated for you automatically when using generators for controllers.
|
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
|
227
|
+
|
|
228
|
+
config
|
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
|
230
|
+
and other dependencies.
|
|
231
|
+
|
|
232
|
+
db
|
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
|
234
|
+
sequence of Migrations for your schema.
|
|
235
|
+
|
|
236
|
+
doc
|
|
237
|
+
This directory is where your application documentation will be stored when
|
|
238
|
+
generated using <tt>rake doc:app</tt>
|
|
239
|
+
|
|
240
|
+
lib
|
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
|
243
|
+
the load path.
|
|
244
|
+
|
|
245
|
+
public
|
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
|
248
|
+
server.
|
|
249
|
+
|
|
250
|
+
script
|
|
251
|
+
Helper scripts for automation and generation.
|
|
252
|
+
|
|
253
|
+
test
|
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
|
255
|
+
command, template test files will be generated for you and placed in this
|
|
256
|
+
directory.
|
|
257
|
+
|
|
258
|
+
vendor
|
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
|
261
|
+
vendor/rails/. This directory is in the load path.
|