initjs 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,58 @@
 # Initjs
 
-TODO: Write a gem description
+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.
+
+Works fine with Turbolinks from Rails.
+
+
+## Javascript structure example
+
+The structure you need follow is the same of your controller and action.
+You can use a namespace too.
+
+### With Backbone.js
+
+```javascript
+App.Posts.New = Backbone.View.extend({
+  initialize: function() {
+    // Javascript for the page "posts/new"
+  }
+});
+
+App.Posts.Show = Backbone.View.extend({
+  initialize: function() {
+    // Javascript for the page "posts/1"
+  }
+});
+
+// with namespace
+App.Blog.Posts.Show = Backbone.View.extend({
+  initialize: function() {
+    // Javascript for the page "blog/posts/1"
+  }
+});
+```
+
+### Without Backbone.js
+
+```javascript
+App.Posts.New = function() {
+  // Javascript for the page "posts/new"
+};
+
+App.Posts.Show = function() {
+  // Javascript for the page "posts/1"
+};
+
+// with namespace
+App.Blog.Posts.Show = function() {
+  // Javascript for the page "blog/posts/1"
+};
+```
+
 
 ## Installation
 
@@ -12,13 +64,42 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Run the generator:
+
+    rails generate initjs
+
+Add `//= require init.js` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
+
 
-    $ gem install initjs
 
 ## Usage
 
-TODO: Write usage instructions here
+Include the Initjs tag in your application layout (usually found at `app/view/layouts/application.html.erb`) after the body tag.
+
+```erb
+<%= initjs_tag %>
+```
+
+### The app.js
+
+If you have a commom javascript that you need execute every page, you can put in `app/assets/javascripts/app.js.coffee`
+
+#### Structure example
+
+```coffee
+App = window.App =
+  Common:
+    init: ->
+      # Something here
+    finish: ->
+      # Something here
+```
+
+
+## Work left to do
+
+* Add proper unit tests
+
 
 ## Contributing
 

data/initjs.gemspec

@@ -8,12 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = Initjs::VERSION
   gem.authors       = ["Josemar Davi Luedke"]
   gem.email         = ["josemarluedke@gmail.com"]
-  gem.description   = %q{Init.js for Rails an Backbone.js}
-  gem.summary       = %q{Init.js}
+  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.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency('rails', '~> 3.1')
 end

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

@@ -0,0 +1,37 @@
+window.Initjs =
+  initialize: ->
+    infos = $("#init-js")
+    controllerClass = infos.data("controller-class")
+    controllerName = infos.data("controller-name")
+    action = infos.data("action")
+    this.execFilter('init')
+    this.exec(controllerClass, controllerName, action)
+    this.execFilter('finish')
+
+  exec: (controllerClass, controllerName, action) ->
+    namespace = App
+
+    if controllerClass
+      railsNamespace = controllerClass.split("::").slice(0, -1)
+    else
+      railsNamespace = []
+
+    for name in railsNamespace
+      namespace = namespace[name] if namespace
+
+    if namespace and controllerName
+      controller = namespace[controllerName]
+      if controller and View = controller[action]
+        App.currentView = window.view = new View()
+
+  execFilter: (filterName) ->
+    if App.Common and typeof App.Common[filterName] == 'function'
+      App.Common[filterName]()
+
+jQuery ->
+  window.Initjs.initialize()
+
+  unless window.Turbolinks is undefined
+    document.addEventListener "page:change", ->
+      window.Initjs.initialize()
+

data/lib/generators/initjs/initjs_generator.rb

@@ -0,0 +1,11 @@
+module Initjs
+  module Generators
+    class InitjsGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_files
+        copy_file "app.js.coffee", "app/assets/javascripts/app.js.coffee"
+      end
+    end
+  end
+end

data/lib/generators/initjs/templates/app.js.coffee

@@ -0,0 +1,7 @@
+App = window.App =
+  Common:
+    init: ->
+      # Something here
+    finish: ->
+      # Something here
+

data/lib/initjs/helper.rb

@@ -0,0 +1,12 @@
+module Initjs
+  module Helper
+    def initjs_tag
+      content_tag 'div', '', { :id => "init-js",
+                                :"data-controller-class" => controller.class.name,
+                                :"data-controller-name" => controller.controller_name.camelize,
+                                :"data-action" => controller.action_name.camelize }
+    end
+  end
+end
+
+ActionView::Base.send :include, Initjs::Helper

data/lib/initjs/version.rb

@@ -1,3 +1,3 @@
 module Initjs
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/initjs.rb

@@ -1,5 +1,7 @@
 require "initjs/version"
+require "initjs/helper"
 
 module Initjs
-  # Your code goes here...
+  class Engine < ::Rails::Engine
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: initjs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
-dependencies: []
-description: Init.js for Rails an Backbone.js
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Init.js is a Ruby Gem that helps run your javascript only in a page that
+  its necessary
 email:
 - josemarluedke@gmail.com
 executables: []
@@ -24,7 +41,11 @@ files:
 - README.md
 - Rakefile
 - initjs.gemspec
+- lib/assets/javascript/init.js.coffee
+- lib/generators/initjs/initjs_generator.rb
+- lib/generators/initjs/templates/app.js.coffee
 - lib/initjs.rb
+- lib/initjs/helper.rb
 - lib/initjs/version.rb
 homepage: ''
 licenses: []
@@ -49,5 +70,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Init.js
+summary: Init.js for your Rails application
 test_files: []