dojo-rails 0.9.10 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +1 -1
- data/LICENSE +19 -0
- data/README.md +82 -0
- data/Rakefile +2 -0
- data/TODO.md +18 -0
- data/lib/dojo/rails/version.rb +2 -2
- metadata +6 -2
data/.gitignore
CHANGED
data/LICENSE
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
Copyright (c) 2012 Robin Dupret
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the "Software"),
|
5
|
+
to deal in the Software without restriction, including without limitation the
|
6
|
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
7
|
+
sell copies of the Software, and to permit persons to whom the Software is
|
8
|
+
furnished to do so, subject to the following conditions:
|
9
|
+
|
10
|
+
The above copyright notice and this permission notice shall be included in
|
11
|
+
all copies or substantial portions of the Software.
|
12
|
+
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
14
|
+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
16
|
+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
18
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
19
|
+
DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
# Dojo with Ruby on Rails
|
2
|
+
|
3
|
+
I haven't found a good implementation of the cool javascript Dojo toolkit library so I decided to release my own gem. This gem allows you to use the full dojo suite in your [Ruby on Rails](http://github.com/rails/rails) application. The project is divided into three gems dojo-rails, [dijit-rails](https://github.com/robin850/dijit-rails) and [dojox-rails](https://github.com/robin850/dojox-rails).
|
4
|
+
|
5
|
+
This repository used to host each project's folder but there are now in their own repository. This one host dojo itself (the base and full version).
|
6
|
+
|
7
|
+
**Notice** : these gems aren't very stable for the moment. You must be aware of that.
|
8
|
+
|
9
|
+
## Installation and use
|
10
|
+
|
11
|
+
To use these gems, you should edit the `Gemfile` of your application and add the following line (commonly in your `:assets` group)
|
12
|
+
|
13
|
+
``` ruby
|
14
|
+
group :assets do
|
15
|
+
# ...
|
16
|
+
gem 'dojo-rails'
|
17
|
+
end
|
18
|
+
```
|
19
|
+
|
20
|
+
Then run the `bundle` command to install it. Now, inside your javascript assets, you can use dojo? If you want more information on how to set-up and use one of these gems in your application, please see [the wiki](https://github.com/robin850/dojo-rails/wiki).
|
21
|
+
|
22
|
+
Notice that `dojo-rails` provides both the base and full distribution of the toolkit. If you just the want the base distribution, in your js file, add:
|
23
|
+
|
24
|
+
```javascript
|
25
|
+
//= require dojo
|
26
|
+
```
|
27
|
+
|
28
|
+
And for the full version:
|
29
|
+
|
30
|
+
```javascript
|
31
|
+
//= require dojo/dojo
|
32
|
+
```
|
33
|
+
|
34
|
+
That's it! It may seem obvious but you can also use [CoffeeScript](http://coffeescript.org) in your files. Here an example [reference guide](http://dojotoolkit.org/reference-guide/1.8/):
|
35
|
+
|
36
|
+
```coffeescript
|
37
|
+
#= require dojo
|
38
|
+
require(["dojo/router", "dojo/dom", "dojo/fx", "dojo/domReady!"], (router, dom, fx) ->
|
39
|
+
router.register("/articles/:id", (evt) ->
|
40
|
+
alert "The article has the id " + evt[id]
|
41
|
+
)
|
42
|
+
router.startup()
|
43
|
+
|
44
|
+
greeting = dom.byId("greeting")
|
45
|
+
greeting.innerHTML += " from Dojo!"
|
46
|
+
|
47
|
+
fx.slideTo({
|
48
|
+
top: 100,
|
49
|
+
left: 200,
|
50
|
+
node: greeting
|
51
|
+
}).play()
|
52
|
+
)
|
53
|
+
```
|
54
|
+
|
55
|
+
### Troubleshooting
|
56
|
+
|
57
|
+
One of the worst problem when you use dojo-rails and Coffeescript together is that sometimes, Dojo defines functions which are reserved keyword in Coffeescript such as `then` with `dojo/request` or the `dojo/on` module that you will certainly name `on`. Except rename modules, there is no real solution such as for the `then` function. If you have a solution, **please let me know**!
|
58
|
+
|
59
|
+
## Special thanks
|
60
|
+
|
61
|
+
I want to thanks the [jquery-rails](http://github.com/rails/jquery-rails) project ; it helps me to release theses three projects. I would also thanks the [Ruby on Rails team](http://github.com/rails/) and its contributors. Thanks guys!
|
62
|
+
|
63
|
+
## Contribution
|
64
|
+
|
65
|
+
### Code
|
66
|
+
|
67
|
+
If you want to contribute to the code of the project to enhance a gem or the full suite, thanks ! You just have to :
|
68
|
+
|
69
|
+
* Fork the project
|
70
|
+
* Clone the repository on your local machine
|
71
|
+
* Create a new branch with `git checkout -b new_feature`
|
72
|
+
* Make changes and commit them
|
73
|
+
* `git push origin master`
|
74
|
+
* Open a new pull request
|
75
|
+
|
76
|
+
### Bugs and issues
|
77
|
+
|
78
|
+
If you found bug or if you have issues, please open a [new ticket](https://github.com/robin850/dojo-rails/issues/new) on the issue tracker. Thank you a lot!
|
79
|
+
|
80
|
+
## License
|
81
|
+
|
82
|
+
This project is released under the MIT license. See the `LICENSE` file for more information.
|
data/Rakefile
ADDED
data/TODO.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Todo list
|
2
|
+
|
3
|
+
## dojo-rails
|
4
|
+
|
5
|
+
*Nothing to do. Yay!*
|
6
|
+
|
7
|
+
## dijit-rails
|
8
|
+
|
9
|
+
*idem*
|
10
|
+
|
11
|
+
## dojox-rails
|
12
|
+
|
13
|
+
* Clean up the vendor directory reorganizing assets
|
14
|
+
* av/widget (images)
|
15
|
+
* form/resources (css + images)
|
16
|
+
* mobile/themes (images + css)
|
17
|
+
* treemap/themes (css)
|
18
|
+
* widget/**
|
data/lib/dojo/rails/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: dojo-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.11.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-
|
12
|
+
date: 2012-11-02 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: railties
|
@@ -51,6 +51,10 @@ extensions: []
|
|
51
51
|
extra_rdoc_files: []
|
52
52
|
files:
|
53
53
|
- .gitignore
|
54
|
+
- LICENSE
|
55
|
+
- README.md
|
56
|
+
- Rakefile
|
57
|
+
- TODO.md
|
54
58
|
- dojo-rails.gemspec
|
55
59
|
- lib/dojo-rails.rb
|
56
60
|
- lib/dojo/rails.rb
|