README.md in initjs-0.1.3 vs README.md in initjs-1.0.0
- old
+ new
@@ -1,61 +1,72 @@
-# Initjs
+# Initjs [](https://travis-ci.org/josemarluedke/initjs) [](https://codeclimate.com/github/josemarluedke/initjs) [](https://gemnasium.com/josemarluedke/initjs) [](http://badge.fury.io/rb/initjs)
-Init.js is a Ruby Gem that helps run your javascript only in a page that its necessary.
+Initjs is a RubyGem that helps your organize your javascript files using Rails' asset pipeline. Providing a simple and automatic way to execute your javascript for a specific page.
-Along with Rails, you can make a good structure for your javascript.
-A good example is using the Backbone.js, separating each page into a view of the Backbone.js.
-
Works fine with Turbolinks from Rails.
## Javascript structure example
-The structure you need follow is the same of your controller and action.
+The structure you need follow is the same of your controller and actions on a Rails app.
You can use a namespace too.
-### With Backbone.js
+### Simple javascript functions
-```javascript
-App.Posts.New = Backbone.View.extend({
- initialize: function() {
- // Javascript for the page "posts/new"
- }
-});
+```coffee
+# app/assets/javascripts/app_name/posts/new.js.coffee
+AppName.Posts = {} if AppName.Posts is undefined
-App.Posts.Show = Backbone.View.extend({
- initialize: function() {
- // Javascript for the page "posts/1"
- }
-});
+AppName.Posts.New =->
+ # Javascript for the page "posts/new"
+```
+```coffee
+# app/assets/javascripts/app_name/posts/show.js.coffee
+AppName.Posts = {} if AppName.Posts is undefined
-// with namespace
-App.Blog.Posts.Show = Backbone.View.extend({
- initialize: function() {
- // Javascript for the page "blog/posts/1"
- }
-});
+AppName.Posts.Show =->
+ # Javascript for the page "posts/1"
```
+```coffee
+# app/assets/javascripts/app_name/blog/posts/show.js.coffee
+AppName.Blog = {} if AppName.Blog is undefined
+AppName.Blog.Posts = {} if AppName.Blog.Posts is undefined
-### Without Backbone.js
+AppName.Blog.Posts.Show =->
+ # Javascript for the page "blog/posts/1"
+```
-```javascript
-App.Posts.New = function() {
- // Javascript for the page "posts/new"
-};
+### Using Backbone.js
-App.Posts.Show = function() {
- // Javascript for the page "posts/1"
-};
+```coffee
+# app/assets/javascripts/app_name/posts/new.js.coffee
+AppName.Posts = {} if AppName.Posts is undefined
-// with namespace
-App.Blog.Posts.Show = function() {
- // Javascript for the page "blog/posts/1"
-};
+AppName.Posts.New = Backbone.View.extend
+ # Javascript for the page "posts/new"
```
+```coffee
+# app/assets/javascripts/app_name/posts/show.js.coffee
+AppName.Posts = {} if AppName.Posts is undefined
+AppName.Posts.Show = Backbone.View.extend
+ # Javascript for the page "posts/1"
+```
+```coffee
+# app/assets/javascripts/app_name/blog/posts/show.js.coffee
+AppName.Blog = {} if AppName.Blog is undefined
+AppName.Blog.Posts = {} if AppName.Blog.Posts is undefined
+AppName.Blog.Posts.Show = Backbone.View.extend
+ # Javascript for the page "blog/posts/1"
+```
+
+## Requirements
+- Rails 3.1 or higher
+- jQuery (`jquery-rails`)
+- CoffeeScript (`coffee-rails`)
+
## Installation
Add this line to your application's Gemfile:
gem 'initjs'
@@ -64,55 +75,173 @@
$ bundle
Run the generator:
- rails generate initjs
+ rails generate initjs:install
-Add `//= require init.js` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
+Make sure initjs generator has injected `//= require app_name/app_name.js` and `//= require init.js` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
-
## Usage
Include the Initjs tag in your application layout (usually found at `app/view/layouts/application.html.erb`) after the body tag.
```erb
-<%= initjs_tag %>
+<%= initjs_tag app_name: "AppName" %>
```
-### The app.js
+### The app file
-If you have a commom javascript that you need execute every page, you can put in `app/assets/javascripts/app.js.coffee`
+If you have a commom javascript that you need execute every page, you can put in `app/assets/javascripts/app_name/app_name.js.coffee`
#### Structure example
```coffee
-App = window.App =
+#= require_self
+#= require_tree .
+
+window.AppName =
Common:
initPage: ->
# If you are using the Turbolinks and you need run a code only one time, put something here.
# if you're not using the turbolinks, there's no difference between init and initPage.
init: ->
# Something here. This is called in every page, with or without Turbolinks.
finish: ->
# Something here. This is called in every page, with or without Turbolinks.
```
+## Recomended directory structure
-## Work left to do
+Here is the app folder `app/assets/javascripts/app_name/`.
-* Add proper unit tests
+* app_name
+ * [controller]
+ * [action].js.coffee
+ * [other_action].js.coffee
+ * [other_controller]
+ * [action].js
+ * [other_action].js.coffee
+ * [more_action].js.coffee
+ * [namespace]
+ * [controllers]
+ * [action].js.coffee
+## Generators
-## Thanks
+1. Generate a controller folder:
+```
+rails g initjs:add [controllers]
+```
+ **Example:**
+ ```
+ rails g initjs:add posts
+ ```
-I have thanks to @diogob, that is my inspiration for this gem and thanks for core of code ([gist:2321526](https://gist.github.com/2321526))
+ **Generates:**
+ * /app_name
+ * /posts
+2. Generate an action file:
+```
+rails g initjs:add [controllers] [action]
+```
+ **Example:**
+ ```
+ rails g initjs:add posts new
+ ```
+
+ **Generates:**
+ * /app_name
+ * /posts
+ * new.js.coffee
+
+
+3. Generate multiple actions files:
+```
+rails g initjs:add [controllers] [action_1] [action_2] ... [action_n]
+```
+ **Example:**
+ ```
+ rails g initjs:add posts new create edit update
+ ```
+
+ **Generates:**
+ * /app_name
+ * /posts
+ * new.js.coffee
+ * create.js.coffee
+ * edit.js.coffee
+ * update.js.coffee
+
+4. Generate namespaced controller and action:
+```
+rails g initjs:add [namespace]/[controllers] [action_1] [action_2] ... [action_n]
+```
+
+ **Example:**
+ ```
+ rails g initjs:add blog/posts new
+ ```
+
+ **Generates:**
+ * /app_name
+ * /blog
+ * /posts
+ * new.js.coffee
+
+
+## Development environment
+
+You'll need [RVM](https://rvm.io/) to isolate your development environment.
+
+Make sure you install `Ruby 1.9.3` on your [RVM](https://rvm.io/).
+
+Then just checkout the code, configure dependencies and run the tests:
+
+1. Clone the repository:
+
+ `git clone git://github.com/josemarluedke/initjs.git`
+
+2. Enter the repo directory and accept the [RVM](https://rvm.io/):
+
+ `cd initjs`
+
+ `yes` if solicited
+
+3. Install [Bundler](http://gembundler.com/) into our [RVM](https://rvm.io/):
+
+ `gem install bundler`
+
+4. Install all dependencies from [Gemspec](http://docs.rubygems.org/read/chapter/20):
+
+ `bundler install`
+
+### Running tests
+
+1. Go to dummy app folder
+
+ `cd spec/dummy/`
+
+2. Run the rspec
+
+ `rspec spec/`
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Thanks
+
+I have thanks to @diogob, that is my inspiration for this gem and thanks for core of code ([gist:2321526](https://gist.github.com/2321526))
+
+# License
+
+Copyright (c) 2012-2013 Josemar Davi Luedke
+
+Licensed under the MIT license (see LICENSE.txt file)
\ No newline at end of file