view_models 2.0.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.bundle/config +2 -0
- data/.gitignore +8 -0
- data/.rspec +2 -0
- data/.rvmrc +1 -0
- data/.travis.yml +19 -0
- data/.yardoc/checksums +13 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/Appraisals +15 -0
- data/CHANGELOG +31 -0
- data/Gemfile +13 -0
- data/Gemfile.lock +174 -0
- data/MIT-LICENSE +20 -0
- data/README.textile +199 -0
- data/Rakefile +24 -0
- data/doc/ModulesInRenderHierarchy.html +186 -0
- data/doc/ModulesInRenderHierarchy/ClassMethods.html +188 -0
- data/doc/ViewModels.html +202 -0
- data/doc/ViewModels/Base.html +1342 -0
- data/doc/ViewModels/ContextExtractor.html +406 -0
- data/doc/ViewModels/Extensions.html +128 -0
- data/doc/ViewModels/Extensions/ModelReader.html +255 -0
- data/doc/ViewModels/Extensions/ModelReader/FilteredDelegationInstaller.html +908 -0
- data/doc/ViewModels/Extensions/ModelReader/Options.html +551 -0
- data/doc/ViewModels/Extensions/View.html +303 -0
- data/doc/ViewModels/Helpers.html +129 -0
- data/doc/ViewModels/Helpers/Mapping.html +562 -0
- data/doc/ViewModels/Helpers/Mapping/Collection.html +844 -0
- data/doc/ViewModels/Helpers/View.html +287 -0
- data/doc/ViewModels/PathStore.html +745 -0
- data/doc/ViewModels/RenderOptions.html +126 -0
- data/doc/ViewModels/RenderOptions/Base.html +1187 -0
- data/doc/ViewModels/RenderOptions/Partial.html +231 -0
- data/doc/ViewModels/RenderOptions/Template.html +231 -0
- data/doc/ViewModels/View.html +414 -0
- data/doc/ViewModelsGenerator.html +410 -0
- data/doc/_index.html +317 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/file.README.html +113 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +113 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +628 -0
- data/doc/top-level-namespace.html +114 -0
- data/feature_support/testapp/app/controllers/heroes_controller.rb +6 -0
- data/feature_support/testapp/app/controllers/users_controller.rb +6 -0
- data/feature_support/testapp/app/helpers/application_helper.rb +8 -0
- data/feature_support/testapp/app/models/hero.rb +8 -0
- data/feature_support/testapp/app/models/user.rb +3 -0
- data/feature_support/testapp/app/view_models/hero.rb +8 -0
- data/feature_support/testapp/app/view_models/test.rb +8 -0
- data/feature_support/testapp/app/view_models/user.rb +14 -0
- data/feature_support/testapp/app/views/heroes/show.html.slim +6 -0
- data/feature_support/testapp/app/views/users/_box.html.slim +8 -0
- data/feature_support/testapp/app/views/users/show.html.slim +6 -0
- data/feature_support/testapp/config/application.rb +64 -0
- data/feature_support/testapp/config/cucumber.yml +8 -0
- data/feature_support/testapp/config/database.yml +28 -0
- data/feature_support/testapp/config/environments/cucumber.rb +11 -0
- data/feature_support/testapp/config/environments/test.rb +27 -0
- data/feature_support/testapp/config/routes.rb +4 -0
- data/feature_support/testapp/db/migrate/1_create_users.rb +13 -0
- data/feature_support/testapp/features/inheritance.feature +16 -0
- data/feature_support/testapp/features/step_definitions/testapp_steps.rb +16 -0
- data/feature_support/testapp/features/support/env.rb +13 -0
- data/feature_support/testapp/features/users.feature +15 -0
- data/feature_support/testapp/lib/tasks/cucumber.rake +31 -0
- data/feature_support/testapp/spec/factories/heroes.rb +7 -0
- data/feature_support/testapp/spec/factories/users.rb +7 -0
- data/features/rails_integration.feature +21 -0
- data/features/step_definitions/rails_steps.rb +112 -0
- data/features/support/env.rb +6 -0
- data/gemfiles/3.0.Gemfile +13 -0
- data/gemfiles/3.1.Gemfile +15 -0
- data/gemfiles/3.2.gemfile +15 -0
- data/lib/rails/generators/view_models/USAGE +6 -0
- data/lib/rails/generators/view_models/templates/views/_collection.html.erb +6 -0
- data/lib/{rails2/generators/view_models/templates/views/view_models/collection → rails/generators/view_models/templates/views}/_collection.html.haml +1 -2
- data/lib/rails/generators/view_models/templates/views/_collection.html.slim +6 -0
- data/lib/{rails2/generators/view_models/templates/views/_empty.html.haml → rails/generators/view_models/templates/views/_empty.html.erb} +0 -0
- data/lib/rails/generators/view_models/templates/views/_empty.html.haml +0 -0
- data/lib/rails/generators/view_models/templates/views/_empty.html.slim +0 -0
- data/lib/rails/generators/view_models/templates/views/_list.html.erb +6 -0
- data/lib/rails/generators/view_models/templates/views/_list.html.haml +4 -0
- data/lib/rails/generators/view_models/templates/views/_list.html.slim +5 -0
- data/lib/rails/generators/view_models/templates/views/_pagination.html.erb +18 -0
- data/lib/{rails2/generators/view_models/templates/views/view_models/collection → rails/generators/view_models/templates/views}/_pagination.html.haml +2 -2
- data/lib/rails/generators/view_models/templates/views/_pagination.html.slim +12 -0
- data/lib/rails/generators/view_models/templates/views/_table.html.erb +10 -0
- data/lib/{rails2/generators/view_models/templates/views/view_models/collection → rails/generators/view_models/templates/views}/_table.html.haml +0 -0
- data/lib/rails/generators/view_models/templates/views/_table.html.slim +5 -0
- data/lib/rails/generators/view_models/view_models_generator.rb +57 -0
- data/lib/view_models.rb +15 -5
- data/lib/{shared/lib/view_models → view_models}/base.rb +148 -37
- data/lib/{shared/lib/view_models → view_models}/context_extractor.rb +6 -2
- data/lib/{shared/lib/view_models → view_models}/extensions/model_reader.rb +27 -13
- data/lib/{rails2/lib → view_models}/extensions/view.rb +6 -1
- data/lib/view_models/helpers/collection.rb +113 -0
- data/lib/{shared/lib/view_models → view_models}/helpers/mapping.rb +12 -15
- data/lib/{rails2/lib → view_models}/helpers/view.rb +5 -1
- data/lib/{shared/lib/view_models → view_models}/path_store.rb +6 -1
- data/lib/{shared/lib/view_models → view_models}/render_options.rb +19 -4
- data/lib/view_models/version.rb +5 -0
- data/lib/{rails2/lib/view_models → view_models}/view.rb +7 -6
- data/spec/{rails2/lib → lib}/view_models/base_spec.rb +38 -5
- data/spec/{rails2/lib → lib/view_models}/extensions/model_reader_spec.rb +4 -4
- data/spec/{shared/lib → lib/view_models}/helpers/collection_spec.rb +21 -1
- data/spec/{shared/lib → lib/view_models}/helpers/mapping_spec.rb +6 -5
- data/spec/{rails2/lib → lib/view_models}/helpers/view_spec.rb +1 -1
- data/spec/lib/view_models/view_spec.rb +42 -0
- data/spec/spec_helper.rb +32 -0
- data/spec/spec_helper_extensions.rb +13 -0
- data/view_models.gemspec +36 -0
- metadata +411 -142
- data/lib/init.rb +0 -1
- data/lib/padrino/README.textile +0 -3
- data/lib/padrino/init.rb +0 -10
- data/lib/padrino/lib/helpers/collection.rb +0 -27
- data/lib/padrino/lib/padrino/view_models.rb +0 -19
- data/lib/padrino/lib/view_models/base.rb +0 -65
- data/lib/rails2/README.textile +0 -3
- data/lib/rails2/TODO.textile +0 -5
- data/lib/rails2/generators/view_models/USAGE +0 -6
- data/lib/rails2/generators/view_models/templates/README +0 -1
- data/lib/rails2/generators/view_models/templates/spec/view_model_spec.rb +0 -7
- data/lib/rails2/generators/view_models/templates/view_models/view_model.rb +0 -5
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_collection.html.erb +0 -1
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_collection.text.erb +0 -6
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_list.html.erb +0 -1
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_list.text.erb +0 -6
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_pagination.text.erb +0 -3
- data/lib/rails2/generators/view_models/templates/views/view_models/collection/_table.text.erb +0 -10
- data/lib/rails2/generators/view_models/view_models_generator.rb +0 -47
- data/lib/rails2/init.rb +0 -18
- data/lib/rails2/lib/experimental/README.textile +0 -32
- data/lib/rails2/lib/experimental/modules_in_render_hierarchy.rb +0 -21
- data/lib/rails2/lib/helpers/collection.rb +0 -27
- data/lib/rails2/lib/view_models.rb +0 -1
- data/lib/rails2/lib/view_models/base.rb +0 -99
- data/lib/shared/README.textile +0 -3
- data/lib/shared/init.rb +0 -11
- data/lib/shared/lib/view_models.rb +0 -4
- data/lib/shared/lib/view_models/extensions/active_record.rb +0 -27
- data/lib/shared/lib/view_models/helpers/collection.rb +0 -110
- data/spec/padrino/integration/integration_spec.rb +0 -287
- data/spec/padrino/lib/helpers/collection_spec.rb +0 -30
- data/spec/rails2/integration/integration_spec.rb +0 -279
- data/spec/rails2/lib/extensions/active_record_spec.rb +0 -31
- data/spec/rails2/lib/helpers/collection_spec.rb +0 -30
- data/spec/rails2/lib/view_models/view_spec.rb +0 -12
@@ -0,0 +1,113 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.3
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '';
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="_index.html">Index</a> »
|
35
|
+
<span class="title">File: README</span>
|
36
|
+
|
37
|
+
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">
|
42
|
+
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
44
|
+
href="class_list.html">
|
45
|
+
Class List
|
46
|
+
</a>
|
47
|
+
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
49
|
+
href="method_list.html">
|
50
|
+
Method List
|
51
|
+
</a>
|
52
|
+
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
54
|
+
href="file_list.html">
|
55
|
+
File List
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><div id='filecontents'><h1>ViewModels</h1>
|
65
|
+
<p>A view model/representer solution for Padrino and Rails.</p>
|
66
|
+
<h2>Features</h2>
|
67
|
+
<ul>
|
68
|
+
<li>Polymorph view model objects that correspond to model objects.</li>
|
69
|
+
<li>View model specific templates.</li>
|
70
|
+
<li>Hierarchical Template Rendering: Allows generalized templates for a class tree of view models.</li>
|
71
|
+
<li>Helper methods directly on the view models.</li>
|
72
|
+
<li>No view related code in the models.</li>
|
73
|
+
<li>A clean <span class="caps">API</span> for use in Padrino/Rails.</li>
|
74
|
+
<li>100% rcov coverage, nice metrics, gallons of blood and sweat by excellent contributors.</li>
|
75
|
+
</ul>
|
76
|
+
<h2>Installation</h2>
|
77
|
+
<h3>Padrino (via Gem)</h3>
|
78
|
+
<p>Note: The Padrino <span class="caps">API</span> might change as I get acquainted with the Padrino way of doing things. Basic calls like render_as without all its options will stay the same, and so will view_model_for.</p>
|
79
|
+
<p><code>gem install view_models</code></p>
|
80
|
+
<p>and then adding the line</p>
|
81
|
+
<p><code>gem 'view_models', '>=2.0.0' # for example</code></p>
|
82
|
+
<p>in your Gemfile, followed by your app file(s):</p>
|
83
|
+
<pre class="code ruby"><code>require 'view_models'
|
84
|
+
...
|
85
|
+
class MyApplication < Padrino::Application
|
86
|
+
register Padrino::ViewModels
|
87
|
+
...
|
88
|
+
end
|
89
|
+
</code></pre>
|
90
|
+
<p>Note: Adheres to the Padrino style by explicitly registering.</p>
|
91
|
+
<h3>Rails (via Gem)</h3>
|
92
|
+
<p><code>gem install view_models</code></p>
|
93
|
+
<p>and then adding the line</p>
|
94
|
+
<p><code>config.gem 'view_models'</code></p>
|
95
|
+
<p>in your environment.rb.</p>
|
96
|
+
<h2>Links Galore!</h2>
|
97
|
+
<p><a href="http://wiki.github.com/floere/view_models/">Usage, Examples, In-depth Infos [Wiki]</a>
|
98
|
+
<a href="http://rdoc.info/projects/floere/view_models">Reference [RDoc]</a>
|
99
|
+
<a href="http://rubygems.org/gems/view_models">Gem [RubyGems.org]</a>
|
100
|
+
<a href="http://groups.google.com/group/view_models/topics">Mailing List</a>
|
101
|
+
<a href="http://github.com/floere/view_models/issues">Bug Tracker</a>
|
102
|
+
<a href="http://getcaliper.com/caliper/project?repo=git://github.com/floere/view_models.git">Metrics</a>
|
103
|
+
<a href="http://github.com/floere/view_models">Source [Github]</a>
|
104
|
+
<a href="http://floere.github.com/view_models/">Homepage</a></p></div></div>
|
105
|
+
|
106
|
+
<div id="footer">
|
107
|
+
Generated on Tue Oct 16 23:27:34 2012 by
|
108
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
109
|
+
0.8.3 (ruby-1.9.3).
|
110
|
+
</div>
|
111
|
+
|
112
|
+
</body>
|
113
|
+
</html>
|
data/doc/file_list.html
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<base id="base_target" target="_parent" />
|
19
|
+
</head>
|
20
|
+
<body>
|
21
|
+
<script type="text/javascript" charset="utf-8">
|
22
|
+
if (window.top.frames.main) {
|
23
|
+
document.getElementById('base_target').target = 'main';
|
24
|
+
document.body.className = 'frames';
|
25
|
+
}
|
26
|
+
</script>
|
27
|
+
<div id="content">
|
28
|
+
<h1 id="full_list_header">File List</h1>
|
29
|
+
<div id="nav">
|
30
|
+
|
31
|
+
<span><a target="_self" href="class_list.html">
|
32
|
+
Classes
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="method_list.html">
|
36
|
+
Methods
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
<span><a target="_self" href="file_list.html">
|
40
|
+
Files
|
41
|
+
</a></span>
|
42
|
+
|
43
|
+
</div>
|
44
|
+
<div id="search">Search: <input type="text" /></div>
|
45
|
+
|
46
|
+
<ul id="full_list" class="file">
|
47
|
+
|
48
|
+
|
49
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
50
|
+
|
51
|
+
|
52
|
+
</ul>
|
53
|
+
</div>
|
54
|
+
</body>
|
55
|
+
</html>
|
data/doc/frames.html
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
3
|
+
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
+
<title>Documentation by YARD 0.8.3</title>
|
8
|
+
</head>
|
9
|
+
<script type="text/javascript" charset="utf-8">
|
10
|
+
window.onload = function() {
|
11
|
+
var match = window.location.hash.match(/^#!(.+)/);
|
12
|
+
var name = 'index.html';
|
13
|
+
if (match) {
|
14
|
+
name = unescape(match[1]);
|
15
|
+
}
|
16
|
+
document.writeln('<frameset cols="20%,*">' +
|
17
|
+
'<frame name="list" src="class_list.html" />' +
|
18
|
+
'<frame name="main" src="' + name + '" />' +
|
19
|
+
'</frameset>');
|
20
|
+
}
|
21
|
+
</script>
|
22
|
+
<noscript>
|
23
|
+
<frameset cols="20%,*">
|
24
|
+
<frame name="list" src="class_list.html" />
|
25
|
+
<frame name="main" src="index.html" />
|
26
|
+
</frameset>
|
27
|
+
</noscript>
|
28
|
+
</html>
|
data/doc/index.html
ADDED
@@ -0,0 +1,113 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.3
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '';
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="_index.html">Index</a> »
|
35
|
+
<span class="title">File: README</span>
|
36
|
+
|
37
|
+
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">
|
42
|
+
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
44
|
+
href="class_list.html">
|
45
|
+
Class List
|
46
|
+
</a>
|
47
|
+
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
49
|
+
href="method_list.html">
|
50
|
+
Method List
|
51
|
+
</a>
|
52
|
+
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
54
|
+
href="file_list.html">
|
55
|
+
File List
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><div id='filecontents'><h1>ViewModels</h1>
|
65
|
+
<p>A view model/representer solution for Padrino and Rails.</p>
|
66
|
+
<h2>Features</h2>
|
67
|
+
<ul>
|
68
|
+
<li>Polymorph view model objects that correspond to model objects.</li>
|
69
|
+
<li>View model specific templates.</li>
|
70
|
+
<li>Hierarchical Template Rendering: Allows generalized templates for a class tree of view models.</li>
|
71
|
+
<li>Helper methods directly on the view models.</li>
|
72
|
+
<li>No view related code in the models.</li>
|
73
|
+
<li>A clean <span class="caps">API</span> for use in Padrino/Rails.</li>
|
74
|
+
<li>100% rcov coverage, nice metrics, gallons of blood and sweat by excellent contributors.</li>
|
75
|
+
</ul>
|
76
|
+
<h2>Installation</h2>
|
77
|
+
<h3>Padrino (via Gem)</h3>
|
78
|
+
<p>Note: The Padrino <span class="caps">API</span> might change as I get acquainted with the Padrino way of doing things. Basic calls like render_as without all its options will stay the same, and so will view_model_for.</p>
|
79
|
+
<p><code>gem install view_models</code></p>
|
80
|
+
<p>and then adding the line</p>
|
81
|
+
<p><code>gem 'view_models', '>=2.0.0' # for example</code></p>
|
82
|
+
<p>in your Gemfile, followed by your app file(s):</p>
|
83
|
+
<pre class="code ruby"><code>require 'view_models'
|
84
|
+
...
|
85
|
+
class MyApplication < Padrino::Application
|
86
|
+
register Padrino::ViewModels
|
87
|
+
...
|
88
|
+
end
|
89
|
+
</code></pre>
|
90
|
+
<p>Note: Adheres to the Padrino style by explicitly registering.</p>
|
91
|
+
<h3>Rails (via Gem)</h3>
|
92
|
+
<p><code>gem install view_models</code></p>
|
93
|
+
<p>and then adding the line</p>
|
94
|
+
<p><code>config.gem 'view_models'</code></p>
|
95
|
+
<p>in your environment.rb.</p>
|
96
|
+
<h2>Links Galore!</h2>
|
97
|
+
<p><a href="http://wiki.github.com/floere/view_models/">Usage, Examples, In-depth Infos [Wiki]</a>
|
98
|
+
<a href="http://rdoc.info/projects/floere/view_models">Reference [RDoc]</a>
|
99
|
+
<a href="http://rubygems.org/gems/view_models">Gem [RubyGems.org]</a>
|
100
|
+
<a href="http://groups.google.com/group/view_models/topics">Mailing List</a>
|
101
|
+
<a href="http://github.com/floere/view_models/issues">Bug Tracker</a>
|
102
|
+
<a href="http://getcaliper.com/caliper/project?repo=git://github.com/floere/view_models.git">Metrics</a>
|
103
|
+
<a href="http://github.com/floere/view_models">Source [Github]</a>
|
104
|
+
<a href="http://floere.github.com/view_models/">Homepage</a></p></div></div>
|
105
|
+
|
106
|
+
<div id="footer">
|
107
|
+
Generated on Tue Oct 16 23:27:34 2012 by
|
108
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
109
|
+
0.8.3 (ruby-1.9.3).
|
110
|
+
</div>
|
111
|
+
|
112
|
+
</body>
|
113
|
+
</html>
|
data/doc/js/app.js
ADDED
@@ -0,0 +1,214 @@
|
|
1
|
+
function createSourceLinks() {
|
2
|
+
$('.method_details_list .source_code').
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
4
|
+
$('.toggleSource').toggle(function() {
|
5
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
6
|
+
$(this).text("Hide source");
|
7
|
+
},
|
8
|
+
function() {
|
9
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
10
|
+
$(this).text("View source");
|
11
|
+
});
|
12
|
+
}
|
13
|
+
|
14
|
+
function createDefineLinks() {
|
15
|
+
var tHeight = 0;
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
|
+
$('.toggleDefines').toggle(function() {
|
18
|
+
tHeight = $(this).parent().prev().height();
|
19
|
+
$(this).prev().show();
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
21
|
+
$(this).text("(less)");
|
22
|
+
},
|
23
|
+
function() {
|
24
|
+
$(this).prev().hide();
|
25
|
+
$(this).parent().prev().height(tHeight);
|
26
|
+
$(this).text("more...");
|
27
|
+
});
|
28
|
+
}
|
29
|
+
|
30
|
+
function createFullTreeLinks() {
|
31
|
+
var tHeight = 0;
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
33
|
+
tHeight = $(this).parent().prev().height();
|
34
|
+
$(this).parent().toggleClass('showAll');
|
35
|
+
$(this).text("(hide)");
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
37
|
+
},
|
38
|
+
function() {
|
39
|
+
$(this).parent().toggleClass('showAll');
|
40
|
+
$(this).parent().prev().height(tHeight);
|
41
|
+
$(this).text("show all");
|
42
|
+
});
|
43
|
+
}
|
44
|
+
|
45
|
+
function fixBoxInfoHeights() {
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
+
$(this).prev().height($(this).height());
|
48
|
+
});
|
49
|
+
}
|
50
|
+
|
51
|
+
function searchFrameLinks() {
|
52
|
+
$('.full_list_link').click(function() {
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
+
return false;
|
55
|
+
});
|
56
|
+
}
|
57
|
+
|
58
|
+
function toggleSearchFrame(id, link) {
|
59
|
+
var frame = $('#search_frame');
|
60
|
+
$('#search a').removeClass('active').addClass('inactive');
|
61
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
62
|
+
frame.slideUp(100);
|
63
|
+
$('#search a').removeClass('active inactive');
|
64
|
+
}
|
65
|
+
else {
|
66
|
+
$(id).addClass('active').removeClass('inactive');
|
67
|
+
frame.attr('src', link).slideDown(100);
|
68
|
+
}
|
69
|
+
}
|
70
|
+
|
71
|
+
function linkSummaries() {
|
72
|
+
$('.summary_signature').click(function() {
|
73
|
+
document.location = $(this).find('a').attr('href');
|
74
|
+
});
|
75
|
+
}
|
76
|
+
|
77
|
+
function framesInit() {
|
78
|
+
if (hasFrames) {
|
79
|
+
document.body.className = 'frames';
|
80
|
+
$('#menu .noframes a').attr('href', document.location);
|
81
|
+
window.top.document.title = $('html head title').text();
|
82
|
+
}
|
83
|
+
else {
|
84
|
+
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
85
|
+
}
|
86
|
+
}
|
87
|
+
|
88
|
+
function keyboardShortcuts() {
|
89
|
+
if (window.top.frames.main) return;
|
90
|
+
$(document).keypress(function(evt) {
|
91
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
92
|
+
if (typeof evt.target !== "undefined" &&
|
93
|
+
(evt.target.nodeName == "INPUT" ||
|
94
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
95
|
+
switch (evt.charCode) {
|
96
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
97
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
98
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
99
|
+
default: break;
|
100
|
+
}
|
101
|
+
});
|
102
|
+
}
|
103
|
+
|
104
|
+
function summaryToggle() {
|
105
|
+
$('.summary_toggle').click(function() {
|
106
|
+
if (localStorage) {
|
107
|
+
localStorage.summaryCollapsed = $(this).text();
|
108
|
+
}
|
109
|
+
$('.summary_toggle').each(function() {
|
110
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
111
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
112
|
+
if (next.hasClass('compact')) {
|
113
|
+
next.toggle();
|
114
|
+
next.nextAll('ul.summary').first().toggle();
|
115
|
+
}
|
116
|
+
else if (next.hasClass('summary')) {
|
117
|
+
var list = $('<ul class="summary compact" />');
|
118
|
+
list.html(next.html());
|
119
|
+
list.find('.summary_desc, .note').remove();
|
120
|
+
list.find('a').each(function() {
|
121
|
+
$(this).html($(this).find('strong').html());
|
122
|
+
$(this).parent().html($(this)[0].outerHTML);
|
123
|
+
});
|
124
|
+
next.before(list);
|
125
|
+
next.toggle();
|
126
|
+
}
|
127
|
+
});
|
128
|
+
return false;
|
129
|
+
});
|
130
|
+
if (localStorage) {
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
132
|
+
$('.summary_toggle').first().click();
|
133
|
+
}
|
134
|
+
else localStorage.summaryCollapsed = "expand";
|
135
|
+
}
|
136
|
+
}
|
137
|
+
|
138
|
+
function fixOutsideWorldLinks() {
|
139
|
+
$('a').each(function() {
|
140
|
+
if (window.location.host != this.host) this.target = '_parent';
|
141
|
+
});
|
142
|
+
}
|
143
|
+
|
144
|
+
function generateTOC() {
|
145
|
+
if ($('#filecontents').length === 0) return;
|
146
|
+
var _toc = $('<ol class="top"></ol>');
|
147
|
+
var show = false;
|
148
|
+
var toc = _toc;
|
149
|
+
var counter = 0;
|
150
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
151
|
+
var i;
|
152
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
153
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
154
|
+
var lastTag = parseInt(tags[0][1], 10);
|
155
|
+
$(tags.join(', ')).each(function() {
|
156
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
157
|
+
if (this.id == "filecontents") return;
|
158
|
+
show = true;
|
159
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
160
|
+
if (this.id.length === 0) {
|
161
|
+
var proposedId = $(this).attr('toc-id');
|
162
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
163
|
+
else {
|
164
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
165
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
166
|
+
this.id = proposedId;
|
167
|
+
}
|
168
|
+
}
|
169
|
+
if (thisTag > lastTag) {
|
170
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
171
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
172
|
+
}
|
173
|
+
}
|
174
|
+
if (thisTag < lastTag) {
|
175
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
176
|
+
}
|
177
|
+
var title = $(this).attr('toc-title');
|
178
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
179
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
180
|
+
lastTag = thisTag;
|
181
|
+
});
|
182
|
+
if (!show) return;
|
183
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
184
|
+
$('#content').prepend(html);
|
185
|
+
$('#toc').append(_toc);
|
186
|
+
$('#toc .hide_toc').toggle(function() {
|
187
|
+
$('#toc .top').slideUp('fast');
|
188
|
+
$('#toc').toggleClass('hidden');
|
189
|
+
$('#toc .title small').toggle();
|
190
|
+
}, function() {
|
191
|
+
$('#toc .top').slideDown('fast');
|
192
|
+
$('#toc').toggleClass('hidden');
|
193
|
+
$('#toc .title small').toggle();
|
194
|
+
});
|
195
|
+
$('#toc .float_toc').toggle(function() {
|
196
|
+
$(this).text('float');
|
197
|
+
$('#toc').toggleClass('nofloat');
|
198
|
+
}, function() {
|
199
|
+
$(this).text('left');
|
200
|
+
$('#toc').toggleClass('nofloat');
|
201
|
+
});
|
202
|
+
}
|
203
|
+
|
204
|
+
$(framesInit);
|
205
|
+
$(createSourceLinks);
|
206
|
+
$(createDefineLinks);
|
207
|
+
$(createFullTreeLinks);
|
208
|
+
$(fixBoxInfoHeights);
|
209
|
+
$(searchFrameLinks);
|
210
|
+
$(linkSummaries);
|
211
|
+
$(keyboardShortcuts);
|
212
|
+
$(summaryToggle);
|
213
|
+
$(fixOutsideWorldLinks);
|
214
|
+
$(generateTOC);
|