Skip to content

Commit 311f29a

Browse files
committed
Remove namespace declarations, these have been added to base.js
1 parent 40cc456 commit 311f29a

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ RailsScript is a Rails-centric, object oriented, featherweight framework for wri
44

55
## Installation
66

7-
NOTE: RailsScript is not currently compatible with Turbolinks 5 (the Rails 5 default). This is becase inline JS is ignored. A future release will fix this issue.
8-
97
Add this line to your application's Gemfile:
108

119
gem 'rails_script', '~> 0.6.1'
@@ -38,7 +36,6 @@ Your JavaScript class is named after your Controller and there is a method for e
3836
```coffeescript
3937
# app/assets/javascripts/users.js.coffee
4038

41-
window.App ||= {}
4239
class App.Users extends App.Base
4340

4441
show: =>
@@ -53,7 +50,7 @@ Executing some JavaScript to run on all controller actions is just a matter of a
5350

5451
```coffeescript
5552
# app/assets/javascripts/users.js.coffee
56-
window.App ||= {}
53+
5754
class App.Users extends App.Base
5855

5956
beforeAction: (action) =>
@@ -70,7 +67,8 @@ Running some JavaScript on every page of an Application is a common need. For e
7067

7168
```coffeescript
7269
# app/assets/javascripts/base.js.coffee
73-
window.App ||= {}
70+
71+
...
7472
class App.Base
7573

7674
constructor: ->
@@ -84,6 +82,7 @@ class App.Base
8482
out: ->
8583
$(".site-credit a").html("SITE CREDIT")
8684
)
85+
...
8786
```
8887

8988
In this example we extracted the rollover action into a new function. Doing so will make the class cleaner and easier to maintain as the application grows. Once again note the ```return this``` in the constructor.
@@ -96,7 +95,6 @@ Any functions that need to be accessible in the global scope should be defined i
9695

9796
```coffeescript
9897
# app/assets/javascripts/global.js.coffee
99-
window.App ||= {}
10098

10199
App.remoteSubmission = ($form) ->
102100
return $.ajax
@@ -122,7 +120,7 @@ This will create the following in ```/app/assets/javascripts/utilities/modal.js.
122120

123121
```coffeescript
124122
# /app/assets/javascripts/utilities/modal.js.coffee
125-
window.Utility ||= {}
123+
126124
class Utility.Modal
127125

128126
constructor: ->
@@ -133,7 +131,7 @@ Let's add some basic functionality:
133131

134132
```coffeescript
135133
# /app/assets/javascripts/utilities/modal.js.coffee
136-
window.Utility ||= {}
134+
137135
class Utility.Modal
138136
isOpen: false
139137

@@ -164,7 +162,6 @@ Now, here's how we use the utility from ```users#show```
164162
```coffeescript
165163
# app/assets/javascripts/users.js.coffee
166164

167-
window.App ||= {}
168165
class App.Users extends App.Base
169166

170167
show: ->
@@ -187,7 +184,6 @@ This will create the following in ```/app/assets/javascripts/elements/main_menu.
187184
```coffeescript
188185
# /app/assets/javascripts/elements/main_menu.js.coffee```
189186

190-
window.Element ||= {}
191187
class Element.MainMenu
192188

193189
constructor: ->
@@ -199,7 +195,6 @@ We can now add all the logic for the main menu in a separate class and call it o
199195
```coffeescript
200196
# app/assets/javascripts/base.js.coffee
201197

202-
window.App ||= {}
203198
class App.Base
204199

205200
constructor: ->
@@ -220,7 +215,6 @@ Which generates:
220215
````coffeescript
221216
# /app/assets/javascripts/elements/main_menu.js.coffee
222217

223-
window.Element ||= {}
224218
class Element.MainMenu extends Utility.Modal
225219

226220
constructor: ->
@@ -284,7 +278,6 @@ Which generates:
284278
```coffeescript
285279
# /app/assets/javascripts/my/class_name.js.coffee
286280

287-
window.App ||= {}
288281
class App.MyClassName
289282

290283
constructor: ->
@@ -320,7 +313,6 @@ And here's how we print that data to the console on the ```users#index``` action
320313
```coffeescript
321314
# /app/assets/javascripts/users.js.coffee
322315

323-
window.App ||= {}
324316
class App.Users extends App.Base
325317

326318
index: =>

0 commit comments

Comments
 (0)