themes 0.0.2 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +15 -0
  2. data/README.md +55 -0
  3. data/Rakefile +5 -9
  4. data/lib/generators/themes/new_generator.rb +36 -0
  5. data/lib/generators/themes/templates/theme_loader.rb.erb +12 -0
  6. data/lib/themes.rb +5 -3
  7. data/lib/themes/engine.rb +4 -0
  8. data/lib/themes/environments.rb +17 -0
  9. data/lib/themes/version.rb +1 -1
  10. data/spec/controllers/posts_controller_spec.rb +29 -0
  11. data/spec/dummy/README.rdoc +261 -0
  12. data/spec/dummy/Rakefile +7 -0
  13. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  14. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  15. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  16. data/spec/dummy/app/controllers/posts_controller.rb +2 -0
  17. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  18. data/spec/dummy/app/mailers/notifier.rb +15 -0
  19. data/spec/dummy/app/views/layouts/application.html.erb +4 -0
  20. data/spec/dummy/app/views/notifier/good_bye_message.html.erb +3 -0
  21. data/spec/dummy/app/views/notifier/wellcome_message.html.erb +3 -0
  22. data/spec/dummy/app/views/posts/index.html.erb +1 -0
  23. data/spec/dummy/app/views/themes/test/layouts/application.html.erb +4 -0
  24. data/spec/dummy/app/views/themes/test/notifier/wellcome_message.html.erb +3 -0
  25. data/spec/dummy/app/views/themes/test/posts/index.html.erb +1 -0
  26. data/spec/dummy/config.ru +4 -0
  27. data/spec/dummy/config/application.rb +59 -0
  28. data/spec/dummy/config/boot.rb +10 -0
  29. data/spec/dummy/config/database.yml +26 -0
  30. data/spec/dummy/config/environment.rb +5 -0
  31. data/spec/dummy/config/environments/development.rb +37 -0
  32. data/spec/dummy/config/environments/production.rb +67 -0
  33. data/spec/dummy/config/environments/test.rb +37 -0
  34. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  35. data/spec/dummy/config/initializers/inflections.rb +15 -0
  36. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  37. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  38. data/spec/dummy/config/initializers/session_store.rb +8 -0
  39. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  40. data/spec/dummy/config/locales/en.yml +5 -0
  41. data/spec/dummy/config/routes.rb +58 -0
  42. data/spec/dummy/config/themes/test.rb +8 -0
  43. data/spec/dummy/log/test.log +264 -0
  44. data/spec/dummy/public/404.html +26 -0
  45. data/spec/dummy/public/422.html +26 -0
  46. data/spec/dummy/public/500.html +25 -0
  47. data/spec/dummy/public/favicon.ico +0 -0
  48. data/spec/dummy/script/rails +6 -0
  49. data/spec/generators/new_theme_generator_spec.rb +45 -0
  50. data/spec/mailer/notifier_spec.rb +21 -0
  51. data/spec/spec_helper.rb +49 -0
  52. data/spec/themes_engine_spec.rb +27 -0
  53. data/spec/tmp/config/themes/brand_new_theme.rb +20 -0
  54. metadata +145 -43
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ZTNiMjQ5NDM2ZjUzYmI0MWM3YzQzNjFjOTEzN2NiNGUwYjE0ZDRhNA==
5
+ data.tar.gz: !binary |-
6
+ ZTBjZDUxZjRhNjM5ZTUzOWNhZDMzZmE5Mzk1MzJjN2VjYjg2N2YxYg==
7
+ SHA512:
8
+ metadata.gz: !binary |-
9
+ YmI4NTczYTAzYzMyY2I2MzliODAzNDcyOGVjZDgyMzBjMjE4MGJjZTkzZjcx
10
+ MmRjYzYwODYxY2EwNTI2MjkwMjM2ZmI0ZTJkZDhkZDkzZTNmMGVlM2VmZTk5
11
+ OGE1Njc1N2JjOWFkZTA4NGUzNTkxZGEwMzg1MTYxYjQ4OWU3MTM=
12
+ data.tar.gz: !binary |-
13
+ OGNmYjNiNmI3MjY1MDQxNWQzYTEwMmY0ZWFmOTkxNzc0ZGI2ZjU2YjM3YTJh
14
+ ZDZlYjY0NzNkYmM2N2VjNzk4N2VjNmUwZmU1YmZmODBhNzg4Yjk2MmFlZTIy
15
+ NGZmMTY4ODZlZDc2ZjQ2NjliZDdjZTMzZGIxNWMzMzAzY2Q1Nzg=
data/README.md CHANGED
@@ -2,6 +2,57 @@
2
2
 
3
3
  Add simple themes to your rails applications
4
4
 
5
+ # Usage
6
+
7
+ Gemfile:
8
+
9
+ ```ruby
10
+
11
+ gem "themes"
12
+
13
+ ```
14
+
15
+ Run bundler and then create your first theme:
16
+
17
+ ```bash
18
+
19
+ $ bundle install
20
+ $ rails generate themes:new my_theme sales@company.com
21
+
22
+ ```
23
+
24
+ It will generate a configuration file.
25
+
26
+ ```ruby
27
+ # encoding: utf-8
28
+
29
+ class Themes::Loader
30
+ def self.configure(app)
31
+ app.config.theme.name = 'my_theme'
32
+ app.config.theme.email = 'sales@company.com'
33
+
34
+ development do
35
+ # Place development environment stuff here
36
+ end
37
+
38
+ production do
39
+ # Place production environment stuff here
40
+ end
41
+
42
+ test do
43
+ # Place test environment stuff here
44
+ end
45
+ end
46
+ end
47
+
48
+ ```
49
+
50
+ Folders to place views files and assets will be created.
51
+
52
+ - app/assets/javascripts/my_theme
53
+ - app/assets/stylesheets/my_theme
54
+ - app/views/themes/my_theme
55
+
5
56
  ## Main features:
6
57
 
7
58
  - allow app to load diferent configuration depending on theme
@@ -13,3 +64,7 @@ Add simple themes to your rails applications
13
64
  - Use differnt theme depending on domain name
14
65
 
15
66
 
67
+ ## Code Status
68
+
69
+ * [![Build Status](https://api.travis-ci.org/ritxi/themes.png)](https://travis-ci.org/ritxi/themes)
70
+ * [![Coverage Status](https://coveralls.io/repos/ritxi/themes/badge.png)](https://coveralls.io/r/ritxi/themes)
data/Rakefile CHANGED
@@ -25,14 +25,10 @@ end
25
25
 
26
26
  Bundler::GemHelper.install_tasks
27
27
 
28
- require 'rake/testtask'
29
-
30
- Rake::TestTask.new(:test) do |t|
31
- t.libs << 'lib'
32
- t.libs << 'test'
33
- t.pattern = 'test/**/*_test.rb'
34
- t.verbose = false
35
- end
28
+ require 'coveralls/rake/task'
29
+ require 'rspec/core/rake_task'
30
+ Coveralls::RakeTask.new('coveralls:push')
31
+ RSpec::Core::RakeTask.new(:spec)
36
32
 
33
+ task :default => :spec
37
34
 
38
- task :default => :test
@@ -0,0 +1,36 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/named_base'
3
+
4
+ class Themes::NewGenerator < Rails::Generators::NamedBase
5
+ class Environments
6
+ extend Themes::Environments
7
+ end
8
+
9
+ source_root File.expand_path('../templates', __FILE__)
10
+
11
+ argument :name, type: :string, default: [], banner: "theme_name"
12
+ argument :email, type: :string, default: [], banner: "theme_email"
13
+
14
+
15
+ def create_theme_configuration_file
16
+ template 'theme_loader.rb.erb', "config/themes/#{theme_name}.rb"
17
+ end
18
+
19
+ def create_views_initial_files
20
+ empty_directory "app/views/themes/#{theme_name}"
21
+ empty_directory "app/views/themes/#{theme_name}/layouts"
22
+ end
23
+
24
+ def create_assets_files
25
+ empty_directory "app/assets/stylesheets/#{theme_name}"
26
+ empty_directory "app/assets/javascripts/#{theme_name}"
27
+ end
28
+
29
+ def theme_name
30
+ name
31
+ end
32
+
33
+ def theme_email
34
+ email
35
+ end
36
+ end
@@ -0,0 +1,12 @@
1
+ # encoding: utf-8
2
+
3
+ class Themes::Loader
4
+ def self.configure(app)
5
+ app.config.theme.name = '<%= theme_name %>'
6
+ app.config.theme.email = '<%= theme_email %>'<% Environments.list.each do |env_name| %>
7
+
8
+ <%= env_name %> do
9
+ # Place <%= env_name %> environment stuff here
10
+ end<% end %>
11
+ end
12
+ end
@@ -6,8 +6,10 @@ module Themes
6
6
 
7
7
  mattr_accessor :email
8
8
  @@email = nil
9
+
10
+ autoload :Helpers, 'themes/helpers'
11
+ autoload :Paths, 'themes/paths'
12
+ autoload :Environments, 'themes/environments'
9
13
  end
10
14
 
11
- require 'themes/engine'
12
- require 'themes/helpers'
13
- require 'themes/paths'
15
+ require 'themes/engine'
@@ -1,8 +1,12 @@
1
1
  module Themes
2
+ class Loader; end;
3
+
2
4
  class Engine < ::Rails::Engine
3
5
  config.theme = Themes
4
6
 
5
7
  initializer "themes.setup_theme", before: 'action_mailer.set_configs' do |app|
8
+ Themes::Loader.extend(Themes::Environments)
9
+
6
10
  require Rails.root.join('config', 'themes', ENV['APP_THEME'])
7
11
  Themes::Loader.configure(app)
8
12
  end
@@ -0,0 +1,17 @@
1
+ module Themes
2
+ module Environments
3
+ def list
4
+ @list ||= Dir.entries(Rails.root.join('config', 'environments').to_s).
5
+ select{ |f| f.match /.*\.rb/ }.
6
+ map{|f| File.basename(f, '.rb').to_sym}.sort
7
+ end
8
+
9
+ def method_missing(method_name, *arguments, &block)
10
+ if block_given? && list.include?(method_name)
11
+ block.call if Rails.env.send("#{method_name}?")
12
+ else
13
+ super
14
+ end
15
+ end
16
+ end
17
+ end
@@ -1,3 +1,3 @@
1
1
  module Themes
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.4"
3
3
  end
@@ -0,0 +1,29 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+
4
+ describe PostsController, controller: true do
5
+ describe "#index" do
6
+ before { get :index }
7
+
8
+ it { expect(response).to have_rendered('posts/index') }
9
+
10
+ context "render_views with theme custom views" do
11
+ render_views
12
+
13
+ it { expect(response.body).to match /Posts index from theme/m }
14
+ it { expect(response.body).to match /Test theme layout/m }
15
+ end
16
+
17
+ context "render_views with default views" do
18
+ pending "should be able to reload theme path"
19
+ #before do
20
+ # ENV['APP_THEME']='empty'
21
+ # subject
22
+ #end
23
+ #render_views
24
+ #
25
+ #it { expect(response.body).to match /Default posts index/m }
26
+ #it { expect(response.body).to match /Default layout/m }
27
+ end
28
+ end
29
+ 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.