rocky 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,13 @@
 # Rocky
 
-TODO: Write a gem description
+Current status: Middleware in development
+
+Rocky is CoffeeScript Middleware that binds class objects with HTML page elements.
+Class objects interact with page elements through Backbone events.
+Rocky also implements the logic of the following components:
+  Modal (Dynamic building and binding)
+  Puppet page (Blank page, which closed after the action and sends instructions to the parent window)
+
 
 ## Installation
 
@@ -11,14 +18,139 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
+    $ rails g rocky:install
+
+Last command will add the following lines in file (app/assets/javascripts/application.js):
+
+    //= require underscore
+    //= require backbone
+    //= require middleware
+    //= require application/#{your_application_name}
+
+## Login Form example
+
+Login Controller (SessionsController):
+
+    def new
+      @user_session = UserSession.new
+    end
+
+    def create
+      @user_session = log_in(params[:user_session])
+
+      if logged_in?
+        render :json => { :completed => true, :url => root_path }
+      else
+        flash.now[:alert] = "Incorrect email or password"
+        render :json => { :completed => false, :template => render_to_string("sessions/new") }
+      end
+    end
+
+Login Template (sessions/new.haml):
+
+    .login.form{ :data => { :block => "login_form" } }
+
+      - flash.each do |key, value|
+        %div{ :class => "alert alert-#{key == :notice ? 'success' : 'error'}" }= value
+
+      = form_for(@user_session, :url => login_path, :remote => true, :method => :post) do |form|
+
+        .field
+          = form.label :email
+          = form.text_field :email, :autofocus => true
+
+        .field
+          = form.label :password
+          = form.password_field :password
+
+        .actions
+          link_to "Facebook login", "javascript:void(0)", :data => { :url => "facebook_oauth2_path",
+                                                          :action => "open_connection",
+                                                          :name   => "Log into My Application",
+                                                          :width  => 600,
+                                                          :height => 400 }
+
+          = form.check_box :remember_me
+          = form.label :remember_me, "Keep me logged in"
+          = link_to "Log In", "javascript:void(0)", :data => { :action => "submit" }
+
+Login CoffeeScript View Class (app/assets/javascripts/application/view/login.js.coffee):
+
+         class MyApplicationName.Views.Login extends Middleware.System.Base
+
+           constructor: (@container) ->
+             super(@container)
+             @initForm()
+
+           initForm: =>
+             @form = @container.find("form")
+
+             MyApplicationName.Views.Login.initOpenConnection(@form.find("a[data-action=open_connection]"))
+
+             @form.on "ajax:success",      @createResponse
+             @form.on "request:completed", @completeForm
+             @form.on "request:failed",    @updateForm
+
+             @submitButton = @form.find("a[data-action=submit]")
+             @submitButton.on "click", =>
+               @form.trigger("submit.rails")
+
+           createResponse: (event, json) =>
+             if json["completed"] == true
+               @form.trigger("request:completed", json)
+             else
+               @form.trigger("request:failed", json)
+
+           completeForm: (event, json) =>
+             window.location.replace(json["url"])
+
+           updateForm: (event, json) =>
+             @container.replaceWith(json["template"])
+             MyApplicationName.Views.Login.bindMany("*[data-block=login_form]")
+
+           @initOpenConnection: (button) ->
+             button.on "click", (e) ->
+               left = (screen.width/2)-(button.data("width")/2)
+               top  = (screen.height/2)-(button.data("height")/2)
+               window.open(button.data("url"),
+                           button.data("name"),
+                           "menubar=no,toolbar=no,status=no,width=#{button.data('width')},height=#{button.data('height')},toolbar=no,left=#{left},top=#{top}"
+               ).focus()
+
+               e.stopPropagation()
+               return false
+
+         jQuery ->
+           MyApplicationName.Views.Login.bindMany("*[data-block=login_form]")
+
+### Modal Example:
+
+HTML Header:
+
+        %header{ :data => { :block => "header" } }
+          .buttons
+            - if logged_in?
+              = link_to "Edit account", edit_user_path(current_user), :data => { :remote => true, :action => "edit_user" }
+
+Header CoffeeScript View Class (app/assets/javascripts/application/views/header.js.coffee):
+
+        class MyApplicationName.Views.Header extends Middleware.System.Base
+
+          constructor: (@container) ->
+            super(@container)
+            @initElements()
 
-Or install it yourself as:
+          initElements: =>
+            @editUserButton = @container.find("a[data-action='edit_user']")
+            @editUserButton.on "ajax:success", @createEditUserContainer
 
-    $ gem install rocky
+          createEditUserContainer: (event, json) =>
+            @editUserContainer = Middleware.Component.Modal.create("edit_user")
+            @editUserContainer.fill("hello")
 
-## Usage
+        jQuery ->
+          MyApplicationname.Views.Header.bindMany("*[data-block='header']")
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/rocky/version.rb

@@ -1,3 +1,3 @@
 module Rocky
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocky
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors: