template-switcher 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. data/.gitignore +18 -0
  2. data/.travis.yml +5 -0
  3. data/Gemfile +4 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +59 -0
  6. data/Rakefile +6 -0
  7. data/lib/template-switcher.rb +2 -0
  8. data/lib/template_switcher.rb +20 -0
  9. data/lib/template_switcher/action_controller_extension.rb +18 -0
  10. data/lib/template_switcher/auto_render_switcher.rb +17 -0
  11. data/lib/template_switcher/railtie.rb +10 -0
  12. data/lib/template_switcher/version.rb +3 -0
  13. data/spec/controllers/render_switcher_spec.rb +86 -0
  14. data/spec/rails_app/.gitignore +15 -0
  15. data/spec/rails_app/README.rdoc +261 -0
  16. data/spec/rails_app/Rakefile +7 -0
  17. data/spec/rails_app/app/assets/images/rails.png +0 -0
  18. data/spec/rails_app/app/assets/javascripts/application.js +15 -0
  19. data/spec/rails_app/app/assets/stylesheets/application.css +13 -0
  20. data/spec/rails_app/app/controllers/application_controller.rb +3 -0
  21. data/spec/rails_app/app/controllers/posts_controller.rb +9 -0
  22. data/spec/rails_app/app/helpers/application_helper.rb +2 -0
  23. data/spec/rails_app/app/mailers/.gitkeep +0 -0
  24. data/spec/rails_app/app/models/.gitkeep +0 -0
  25. data/spec/rails_app/app/switch_views/posts/index.html.erb +1 -0
  26. data/spec/rails_app/app/switch_views/posts/new.html.erb +1 -0
  27. data/spec/rails_app/app/views/layouts/application.html.erb +14 -0
  28. data/spec/rails_app/app/views/posts/index.html.erb +1 -0
  29. data/spec/rails_app/app/views/posts/new.html.erb +1 -0
  30. data/spec/rails_app/config.ru +4 -0
  31. data/spec/rails_app/config/application.rb +65 -0
  32. data/spec/rails_app/config/boot.rb +6 -0
  33. data/spec/rails_app/config/database.yml +21 -0
  34. data/spec/rails_app/config/environment.rb +5 -0
  35. data/spec/rails_app/config/environments/development.rb +37 -0
  36. data/spec/rails_app/config/environments/production.rb +67 -0
  37. data/spec/rails_app/config/environments/test.rb +37 -0
  38. data/spec/rails_app/config/initializers/backtrace_silencers.rb +7 -0
  39. data/spec/rails_app/config/initializers/inflections.rb +15 -0
  40. data/spec/rails_app/config/initializers/mime_types.rb +5 -0
  41. data/spec/rails_app/config/initializers/secret_token.rb +7 -0
  42. data/spec/rails_app/config/initializers/session_store.rb +8 -0
  43. data/spec/rails_app/config/initializers/template_switcher.rb +3 -0
  44. data/spec/rails_app/config/initializers/wrap_parameters.rb +14 -0
  45. data/spec/rails_app/config/locales/en.yml +5 -0
  46. data/spec/rails_app/config/routes.rb +3 -0
  47. data/spec/rails_app/db/seeds.rb +7 -0
  48. data/spec/rails_app/lib/assets/.gitkeep +0 -0
  49. data/spec/rails_app/lib/tasks/.gitkeep +0 -0
  50. data/spec/rails_app/public/404.html +26 -0
  51. data/spec/rails_app/public/422.html +26 -0
  52. data/spec/rails_app/public/500.html +25 -0
  53. data/spec/rails_app/public/favicon.ico +0 -0
  54. data/spec/rails_app/public/index.html +241 -0
  55. data/spec/rails_app/public/robots.txt +5 -0
  56. data/spec/rails_app/script/rails +6 -0
  57. data/spec/rails_app/test/fixtures/.gitkeep +0 -0
  58. data/spec/rails_app/test/functional/.gitkeep +0 -0
  59. data/spec/rails_app/test/integration/.gitkeep +0 -0
  60. data/spec/rails_app/test/performance/browsing_test.rb +12 -0
  61. data/spec/rails_app/test/test_helper.rb +13 -0
  62. data/spec/rails_app/test/unit/.gitkeep +0 -0
  63. data/spec/spec_helper.rb +19 -0
  64. data/template-switcher.gemspec +29 -0
  65. metadata +294 -0
data/.gitignore ADDED
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ .rspec
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ language: ruby
2
+ script: "bundle exec rake spec build"
3
+ rvm:
4
+ - 1.9.3
5
+ - 1.9.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in template-switcher.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 joker1007
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # TemplateSwitcher
2
+
3
+ Rails template switcher.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'template-switcher'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install template-switcher
18
+
19
+ ## Usage
20
+
21
+ config/initializer/template\_switcher.rb
22
+ ```ruby
23
+ TemplateSwitcher.mapping = {
24
+ "abc.example.domain" => "abc_views",
25
+ "xyz.example.domain" => "xyz_views",
26
+ }
27
+ ```
28
+
29
+
30
+ app/controllers/posts_controller.rb
31
+ ```ruby
32
+ class PostsController < ApplicationController
33
+ include TemplateSwitcher::AutoRenderSwitcher
34
+
35
+ def index
36
+ render "index"
37
+ end
38
+
39
+ private
40
+ def template_selector
41
+ request.host
42
+ end
43
+ end
44
+ ```
45
+
46
+
47
+ If requested host name is "abc.example.domain", rendered "app/abc_views/posts/index.html.haml".
48
+
49
+ If requested host name is "xyz.example.domain", rendered "app/xyz_views/posts/index.html.haml".
50
+
51
+ Otherwize, rendered "app/views/posts/index.html.haml".
52
+
53
+ ## Contributing
54
+
55
+ 1. Fork it
56
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
57
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
58
+ 4. Push to the branch (`git push origin my-new-feature`)
59
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec) do |t|
5
+ t.rspec_opts = "--color --format d"
6
+ end
@@ -0,0 +1,2 @@
1
+ require "template_switcher"
2
+
@@ -0,0 +1,20 @@
1
+ module TemplateSwitcher
2
+ class << self
3
+ def mapping
4
+ @mapping
5
+ end
6
+
7
+ def mapping=(mapping = {})
8
+ @mapping = mapping
9
+ end
10
+ end
11
+ end
12
+
13
+ begin
14
+ require "rails"
15
+ rescue LoadError
16
+ # do nothing
17
+ end
18
+
19
+ require "template_switcher/auto_render_switcher"
20
+ require "template_switcher/railtie"
@@ -0,0 +1,18 @@
1
+ module TemplateSwitcher
2
+ module ActionControllerExtension
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ alias :__render__ :render
7
+ end
8
+
9
+ def render_switcher(selector, *args)
10
+ TemplateSwitcher.mapping ||= {}
11
+
12
+ if mapping = TemplateSwitcher.mapping[selector]
13
+ prepend_view_path(Rails.root.join("app", mapping))
14
+ end
15
+ __render__(*args)
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,17 @@
1
+ module TemplateSwitcher
2
+ module AutoRenderSwitcher
3
+ extend ActiveSupport::Concern
4
+
5
+ def render(*args)
6
+ render_switcher(template_selector, *args)
7
+ end
8
+
9
+ def template_selector
10
+ nil
11
+ end
12
+
13
+ included do
14
+ include ActionControllerExtension
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,10 @@
1
+ module TemplateSwitcher
2
+ class Railtie < ::Rails::Railtie
3
+ initializer 'template_switcher' do |_app|
4
+ ActiveSupport.on_load(:action_controller) do
5
+ require "template_switcher/action_controller_extension"
6
+ ::ActionController::Base.send :include, TemplateSwitcher::ActionControllerExtension
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,3 @@
1
+ module TemplateSwitcher
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,86 @@
1
+ require "template-switcher"
2
+ require "spec_helper"
3
+
4
+ describe PostsController do
5
+ render_views
6
+
7
+ describe "#render_switcher" do
8
+ context "given template_selector is nil" do
9
+ before do
10
+ mod = Module.new do
11
+ def template_selector
12
+ nil
13
+ end
14
+ end
15
+
16
+ PostsController.send :include, mod
17
+ end
18
+
19
+ it do
20
+ get :index
21
+ response.should render_template("posts/index")
22
+ response.body.should_not =~ /switch/
23
+ end
24
+ end
25
+
26
+ context "given template_selector is :select_key" do
27
+ before do
28
+ mod = Module.new do
29
+ def template_selector
30
+ :select_key
31
+ end
32
+ end
33
+
34
+ PostsController.send :include, mod
35
+ end
36
+
37
+ it do
38
+ get :index
39
+ response.should render_template("posts/index")
40
+ response.body.should =~ /switch/
41
+ end
42
+ end
43
+
44
+ context "given template_selector is undefined key" do
45
+ before do
46
+ mod = Module.new do
47
+ def template_selector
48
+ :undefined_key
49
+ end
50
+ end
51
+
52
+ PostsController.send :include, mod
53
+ end
54
+
55
+ it do
56
+ get :index
57
+ response.should render_template("posts/index")
58
+ response.body.should_not =~ /switch/
59
+ end
60
+ end
61
+ end
62
+
63
+ describe TemplateSwitcher::AutoRenderSwitcher do
64
+ before do
65
+ PostsController.send :include, TemplateSwitcher::AutoRenderSwitcher
66
+ end
67
+
68
+ context "given template_selector is :select_key" do
69
+ before do
70
+ mod = Module.new do
71
+ def template_selector
72
+ :select_key
73
+ end
74
+ end
75
+
76
+ PostsController.send :include, mod
77
+ end
78
+
79
+ it do
80
+ get :new
81
+ response.should render_template("posts/new")
82
+ response.body.should =~ /switch/
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,15 @@
1
+ # See http://help.github.com/ignore-files/ for more about ignoring files.
2
+ #
3
+ # If you find yourself ignoring temporary files generated by your text editor
4
+ # or operating system, you probably want to add a global ignore instead:
5
+ # git config --global core.excludesfile ~/.gitignore_global
6
+
7
+ # Ignore bundler config
8
+ /.bundle
9
+
10
+ # Ignore the default SQLite database.
11
+ /db/*.sqlite3
12
+
13
+ # Ignore all logfiles and tempfiles.
14
+ /log/*.log
15
+ /tmp
@@ -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.