rails-bootstrap-helpers 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (62) hide show
  1. checksums.yaml +15 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +158 -0
  4. data/Rakefile +38 -0
  5. data/lib/rails-bootstrap-helpers.rb +20 -0
  6. data/lib/rails-bootstrap-helpers/core_ext/abstract.rb +72 -0
  7. data/lib/rails-bootstrap-helpers/helpers/alert_helper.rb +45 -0
  8. data/lib/rails-bootstrap-helpers/helpers/base_helper.rb +32 -0
  9. data/lib/rails-bootstrap-helpers/helpers/button_helper.rb +55 -0
  10. data/lib/rails-bootstrap-helpers/helpers/form_tag_helper.rb +22 -0
  11. data/lib/rails-bootstrap-helpers/helpers/label_helper.rb +35 -0
  12. data/lib/rails-bootstrap-helpers/helpers/options_helper.rb +32 -0
  13. data/lib/rails-bootstrap-helpers/rails/engine.rb +15 -0
  14. data/lib/rails-bootstrap-helpers/renderers/abstract_button_renderer.rb +86 -0
  15. data/lib/rails-bootstrap-helpers/renderers/button_renderer.rb +43 -0
  16. data/lib/rails-bootstrap-helpers/renderers/renderer.rb +14 -0
  17. data/lib/rails-bootstrap-helpers/version.rb +3 -0
  18. data/lib/tasks/bootstrap-rails-helpers_tasks.rake +4 -0
  19. data/spec/dummy/README.rdoc +261 -0
  20. data/spec/dummy/Rakefile +7 -0
  21. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  22. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  23. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  24. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  25. data/spec/dummy/app/views/layouts/application.html.erb +14 -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 +25 -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/db/test.sqlite3 +0 -0
  43. data/spec/dummy/log/test.log +47 -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/helpers/alert_helper_spec.rb +24 -0
  50. data/spec/helpers/base_helper_spec.rb +18 -0
  51. data/spec/helpers/button_helper_spec.rb +94 -0
  52. data/spec/helpers/form_tag_helper_spec.rb +43 -0
  53. data/spec/helpers/label_helper_spec.rb +23 -0
  54. data/spec/helpers/options_helper_spec.rb +47 -0
  55. data/spec/spec_helper.rb +20 -0
  56. data/spec/support/matchers/helpers/alert_helper/render_bs_alert.rb +116 -0
  57. data/spec/support/matchers/helpers/base_helper/render_icon.rb +55 -0
  58. data/spec/support/matchers/helpers/button_helper/render_bs_button_to.rb +135 -0
  59. data/spec/support/matchers/helpers/button_helper/render_inline_button_to.rb +79 -0
  60. data/spec/support/matchers/helpers/form_tag_helper/render_bs_button_tag.rb +136 -0
  61. data/spec/support/matchers/helpers/label_helper/render_bs_label.rb +114 -0
  62. metadata +287 -0
@@ -0,0 +1,22 @@
1
+ module RailsBootstrapHelpers::Helpers::FormTagHelper
2
+ # Renders a Bootstrap button tag. This method behaves just as
3
+ # <tt>button_tag</tt> but will render a Bootstrap styled button tag instead.
4
+ #
5
+ # @params text [String] the text of the button
6
+ # @params type [String, Symbol] the type of the button. Adds a "type"
7
+ # attribute to the tag
8
+ #
9
+ # @params options [Hash] a hash of options
10
+ #
11
+ # ==== Options
12
+ # @param :style [String, Symbol] the style of the button
13
+ # @param :size ["large", "small", "mini"] the size of the button
14
+ # @param :disabled [Boolean] if the button should be disabled or not
15
+ # @param :icon [String] the name of an icon to render on the button
16
+ # @param :icon_position ["left", "right"] the post of the icon, if present
17
+ # @param :icon_invert [Boolean] if the color of the icon should be inverted
18
+ def bs_button_tag (value, type, options = {})
19
+ options = options.merge type: type
20
+ RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :button, value, options).render
21
+ end
22
+ end
@@ -0,0 +1,35 @@
1
+ module RailsBootstrapHelpers::Helpers::LabelHelper
2
+ include RailsBootstrapHelpers::Helpers::OptionsHelper
3
+
4
+ # Renders a Bootstrap label.
5
+ #
6
+ # @param text [String] the text rendered in the label
7
+ # @param style [Symbol, Symbol] the style used to render the label
8
+ # @param options [Hash] a hash of options. Passed straight through to the
9
+ # underlying "span" tag.
10
+ #
11
+ def bs_label (text, style = :default, options = {})
12
+ normalize_style = lambda do |style|
13
+ style = style.to_s
14
+
15
+ case style
16
+ when "inactive" then "default"
17
+ when "active" then "success"
18
+ when "error" then "important"
19
+ else
20
+ style
21
+ end
22
+ end
23
+
24
+ options = options.dup
25
+ style = normalize_style.call(style)
26
+
27
+ cls = options[:class]
28
+ cls ||= "label"
29
+ cls << " label-" + style unless style == "default"
30
+
31
+ options[:class] = cls
32
+
33
+ content_tag :span, text, bs_options(options)
34
+ end
35
+ end
@@ -0,0 +1,32 @@
1
+ module RailsBootstrapHelpers::Helpers::OptionsHelper
2
+ # Handles general Bootstrap options available for all Bootstrap helpers.
3
+ #
4
+ # Any option not specify below are kept intact.
5
+ #
6
+ # @param options [Hash] a hash of options
7
+ # @param html_options [Hash] a hash of HTML options/attributes
8
+ #
9
+ # ==== Options
10
+ # @param :tooltip [String] the text of the tooltip. IF present adds attributes
11
+ # for a Bootstrap tooltip. This will add the <tt>data-toggle="tooltip"</tt>
12
+ # and <tt>title="#{tooltip}" </tt> HTML attributes if not already present
13
+ #
14
+ # @param :tooltip_location ["left", "right", "top", "bottom"] the position of
15
+ # the tooltip if <tt>:tooltip</tt> is present. Adds the
16
+ # <tt>data-placement="#{tooltip_position}"</tt> HTML attribute if not
17
+ # already present.
18
+ def bs_options (options, html_options = {})
19
+ options = options.reverse_merge(html_options)
20
+
21
+ if tooltip = options.delete(:tooltip)
22
+ options[:"data-toggle"] ||= "tooltip"
23
+ options[:title] ||= tooltip
24
+
25
+ if tooltip_position = options.delete(:tooltip_position)
26
+ options[:"data-placement"] ||= tooltip_position
27
+ end
28
+ end
29
+
30
+ options
31
+ end
32
+ end
@@ -0,0 +1,15 @@
1
+ #require "action"
2
+
3
+ module RailsBootstrapHelpers
4
+ module Rails
5
+ class Engine < ::Rails::Engine
6
+ initializer "rails-bootstrap-helpers.helpers" do
7
+ ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::AlertHelper
8
+ ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::BaseHelper
9
+ ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::ButtonHelper
10
+ ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::FormTagHelper
11
+ ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::LabelHelper
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,86 @@
1
+ module RailsBootstrapHelpers::Renderers
2
+ class AbstractButtonRenderer < Renderer
3
+ def initialize (template, type, *args, &block)
4
+ super template
5
+ @args = args
6
+ @block = block
7
+ @text = self.args[0]
8
+ @type = type
9
+
10
+ extract_options!
11
+ end
12
+
13
+ def render
14
+ template.send method, *new_args, &block
15
+ end
16
+
17
+ protected
18
+
19
+ attr_reader :block
20
+ attr_reader :args
21
+
22
+ attr_accessor :options
23
+ attr_accessor :html_options
24
+ attr_accessor :text
25
+
26
+ def method
27
+ case @type
28
+ when :link then :link_to
29
+ when :button then :button_tag
30
+ else :link_to
31
+ end
32
+ end
33
+
34
+ def new_args
35
+ case @type
36
+ when :link
37
+ [text, options, html_options, *self.args[3 .. -1]]
38
+ when :button then
39
+ opts = options.reverse_merge(html_options)
40
+ [text, opts, *self.args[3 .. -1]]
41
+ else
42
+ [text, options, html_options, *self.args[3 .. -1]]
43
+ end
44
+ end
45
+
46
+ # Returns true if the given key exists as an option.
47
+ #
48
+ # @param key [String, Symbol] the key to check for
49
+ # @return the value of the option
50
+ def has_option? (key)
51
+ _has_option?(key, options, html_options)
52
+ end
53
+
54
+ # Appends the given class to the "class" HTMl attribute.
55
+ #
56
+ # @param cls [String, Symbol] the class to append
57
+ def append_class (cls)
58
+ return unless cls
59
+
60
+ if c = html_options[:class]
61
+ html_options[:class] << " " + cls.to_s
62
+ else
63
+ html_options[:class] = cls.to_s
64
+ end
65
+ end
66
+
67
+ private
68
+
69
+ def extract_options!
70
+ self.options = args[1]
71
+ self.options = options.stringify_keys if options.is_a?(Hash)
72
+ self.html_options = args[2] || {}
73
+ self.html_options = html_options.stringify_keys
74
+ end
75
+
76
+ def _has_option? (key, options, html_options = nil)
77
+ result = options.is_a?(Hash) && options.key?(key) && options.delete(key)
78
+
79
+ if html_options
80
+ result || _has_option?(key, html_options)
81
+ else
82
+ result
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,43 @@
1
+ module RailsBootstrapHelpers::Renderers
2
+ class ButtonRenderer < AbstractButtonRenderer
3
+ def render
4
+ append_class "btn"
5
+
6
+ if style = has_option?("style")
7
+ append_class "btn-" + style.to_s
8
+ end
9
+
10
+ if size = has_option?("size")
11
+ append_class "btn-" + size.to_s
12
+ end
13
+
14
+ if disabled = has_option?("disabled")
15
+ append_class "disabled"
16
+ end
17
+
18
+ if icon = has_option?("icon")
19
+ pos = has_option?("icon_position")
20
+ icon_args = [icon, invert: has_option?("icon_invert")]
21
+
22
+ if pos.to_s == "right"
23
+ self.text = self.text.to_s + " " + RailsBootstrapHelpers::Helpers::BaseHelper.icon(*icon_args)
24
+ else
25
+ self.text = RailsBootstrapHelpers::Helpers::BaseHelper.icon(*icon_args) + " " + self.text.to_s
26
+ end
27
+
28
+ self.text = self.text.html_safe
29
+ else
30
+ strip_unused_options!
31
+ end
32
+
33
+ super
34
+ end
35
+
36
+ private
37
+
38
+ def strip_unused_options!
39
+ has_option?("icon_position")
40
+ has_option?("icon_invert")
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,14 @@
1
+ module RailsBootstrapHelpers::Renderers
2
+ class Renderer
3
+ abstract :render
4
+ attr_reader :template
5
+
6
+ def initialize (template)
7
+ @template = template
8
+ end
9
+
10
+ def method_missing (*args, &block)
11
+ @template.send(*args, &block)
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,3 @@
1
+ module RailsBootstrapHelpers
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :rails-bootstrap-helpers do
3
+ # # Task goes here
4
+ # 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
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
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.