initjs 0.1.3 → 1.0.0

data/.gitignore

@@ -2,16 +2,15 @@
 *.rbc
 .bundle
 .config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
 pkg
 rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+spec/tmp/app/assets/javascripts/application.js
+spec/tmp/app/assets/javascripts/dummy/
+
+# Ignore the default SQLite database.
+spec/dummy/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+spec/dummy/log/*.log
+spec/dummy/tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.9.3@initjs

data/.travis.yml

@@ -0,0 +1,15 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+gemfile: "spec/dummy/Gemfile"
+
+env:
+  - DISPLAY=:99.0
+
+before_script:
+  - "sh -e /etc/init.d/xvfb start"
+  - "cd spec/dummy"
+  - "bundle exec rake db:migrate"
+
+script: "bundle exec rspec spec"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Josemar Davi Luedke
+Copyright (c) 2012-2013 Josemar Davi Luedke
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,58 +1,69 @@
-# Initjs
+# Initjs [![Build Status](https://travis-ci.org/josemarluedke/initjs.png)](https://travis-ci.org/josemarluedke/initjs) [![Code Climate](https://codeclimate.com/github/josemarluedke/initjs.png)](https://codeclimate.com/github/josemarluedke/initjs) [![Dependency Status](https://gemnasium.com/josemarluedke/initjs.png)](https://gemnasium.com/josemarluedke/initjs) [![Gem Version](https://badge.fury.io/rb/initjs.png)](http://badge.fury.io/rb/initjs)
 
-Init.js is a Ruby Gem that helps run your javascript only in a page that its necessary.
-
-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.
+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.
 
 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
+
+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
 
-// with namespace
-App.Blog.Posts.Show = Backbone.View.extend({
-  initialize: function() {
-    // Javascript for the page "blog/posts/1"
-  }
-});
+AppName.Blog.Posts.Show =->
+  # Javascript for the page "blog/posts/1"
 ```
 
-### Without Backbone.js
+### Using Backbone.js
 
-```javascript
-App.Posts.New = 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 = function() {
-  // Javascript for the page "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
 
-// with namespace
-App.Blog.Posts.Show = function() {
-  // Javascript for the page "blog/posts/1"
-};
+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
 
@@ -66,10 +77,9 @@ And then execute:
 
 Run the generator:
 
-    rails generate initjs
-
-Add `//= require init.js` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
+    rails generate initjs:install
 
+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
@@ -77,17 +87,20 @@ Add `//= require init.js` to your Javascript manifest file (usually found at `ap
 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.
@@ -98,16 +111,122 @@ App = window.App =
       # 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
 
@@ -116,3 +235,13 @@ I have thanks to @diogob, that is my inspiration for this gem and thanks for cor
 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)

data/initjs.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'initjs/version'
@@ -9,9 +8,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Josemar Davi Luedke"]
   gem.email         = ["josemarluedke@gmail.com"]
   gem.homepage      = "http://github.com/josemarluedke/initjs"
-  gem.description   = %q{Init.js is a Ruby Gem that helps run your javascript only in a page that its necessary}
-  gem.summary       = %q{Init.js for your Rails application}
-  gem.homepage      = ""
+  gem.description   = %q{Initjs helps your organize your javascript files using Rails' asset pipeline. Providing a simple and automatic way to execute your javascript for a specific page.}
+  gem.summary       = %q{Initjs for your Rails application}
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,4 +17,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency('rails', '>= 3.1')
+  gem.add_dependency 'jquery-rails'
+
+  gem.add_development_dependency 'rspec-rails', '~> 2.13.0'
+  gem.add_development_dependency 'generator_spec', '~> 0.8.7'
+  gem.add_development_dependency 'capybara', '~> 2.0.2'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'jquery-rails'
+  gem.add_development_dependency 'coffee-rails'
+  gem.add_development_dependency 'turbolinks'
 end

data/lib/assets/javascript/init.js.coffee

@@ -7,10 +7,16 @@ window.Initjs =
     this.execFilter('init')
     this.exec(controllerClass, controllerName, action)
     this.execFilter('finish')
+    this.appName()
+
+  appName: ->
+    appName = $("#init-js").data('app-name') || "App"
+    window.App = window[appName]
+    if window.App is undefined
+      console.log "Initjs: #{appName} is not defined. Run `rails generate initjs` for generates the app file."
 
   exec: (controllerClass, controllerName, action) ->
     namespace = App
-
     if controllerClass
       railsNamespace = controllerClass.split("::").slice(0, -1)
     else
@@ -25,6 +31,7 @@ window.Initjs =
         App.currentView = window.view = new View()
 
   execFilter: (filterName) ->
+    this.appName()
     if App.Common and typeof App.Common[filterName] == 'function'
       App.Common[filterName]()
 

data/lib/generators/initjs/add/add_generator.rb

@@ -0,0 +1,57 @@
+require 'generators/initjs/resource_helpers'
+
+module Initjs
+  module Generators
+    class AddGenerator < ::Rails::Generators::Base
+      include Initjs::Generators::ResourceHelpers
+      argument :actions, type: :array
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_files
+        arguments actions.shift
+
+        create_folders
+        generate_action_files(actions) if actions.present?
+      end
+
+      private
+      def arguments args
+        arg = args.split(' ')
+        controller = arg[0].split('/')
+        @namespace_name = (controller.length > 1) ? controller[0] : ''
+        @controller_name = @namespace_name.present? ? controller[1] : controller[0]
+      end
+
+      def file_path
+        if @namespace_name.present?
+          "#{application_path}/#{@namespace_name.underscore}/#{@controller_name.underscore}"
+        else
+          "#{application_path}/#{@controller_name.underscore}"
+        end
+      end
+
+      def create_folders
+        if @namespace_name.present?
+          create_file "#{application_path}/#{@namespace_name.underscore}/.gitkip"
+        end
+
+        create_file "#{file_path}/.gitkip"
+      end
+
+      def generate_action_files actions
+        actions.each do |action|
+          action_file = "#{file_path}/#{action.underscore}.js.coffee"
+          next if action.nil? || File.exists?(action_file)
+          @action_name = action
+
+          if @namespace_name.present?
+            template "namespaced_action.coffee", action_file
+          else
+            template "simple_action.coffee", action_file
+          end
+        end
+      end
+    end
+  end
+end