right-rails 0.3.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nikolay V. Nemshilov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.textile

@@ -0,0 +1,50 @@
+h1. Welcome To RightRails
+
+RightRails is a RubyOnRails plugin for RightJS javascript framework.
+
+It works as a drop in replacement for all the Prototype/Scriptaculous
+methods, plus it brings some more sweets and routine ajax operations
+organization.
+
+
+h2. Features
+
+* Lightning fast RightJS library
+* Transparent Prototype/Scriptaculous helpers replacement
+* More powerful and flexible new JavaScript generator for RJS
+* Conventional JavaScript interface for the most common AJAX operations
+* Better controller level access to the rjs generator
+* New ajax-friendly scaffold generator
+* Remote files uploading organization
+* Automatic RightJS modules inclusion handling (including i18n modules)
+* Additional FormBuilder methods for calendar and autocomplete fields
+* Underscored and ruby-like aliases for RightJS core methods
+
+
+h2. Documentation
+
+See the wiki-pages for the documentation
+
+<a href="http://wiki.github.com/MadRabbit/right-rails">http://wiki.github.com/MadRabbit/right-rails</a>
+
+
+h3. Usage
+
+Install the plugin to your rails application
+
+@script/plugin install git://github.com/MadRabbit/right-rails.git@
+
+After that run the @right_rails@ generator, which will put all the JavaScripts in place
+
+@script/generate right_rails@
+
+You also will have an ajax-friendly scaffold generator
+
+@script/generate right_scaffold Zing@
+
+
+The rubygem is still coming soon.
+
+
+
+Copyright (c) 2009 Nikolay V. Nemshilov, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the right_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the right_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RightRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/right_rails/right_rails_generator.rb

@@ -0,0 +1,41 @@
+#
+# Copies all the javascripts in place and updates them if necessary
+#
+
+class RightRailsGenerator < Rails::Generator::Base
+  
+  mandatory_options :source => "#{File.dirname(__FILE__)}/../../javascripts"
+    
+  def manifest
+    record do |m|
+      # creating the javascript directories
+      m.directory 'public/javascripts/right'
+      m.directory 'public/javascripts/right/i18n'
+      
+      # copying the javascript files
+      Dir.open(options[:source]).each do |file|
+        unless ['.', '..'].include?(file)
+          destination = if ['right.js', 'right-src.js'].include?(file)
+            file
+          elsif file.include?('ui-i18n')
+            file.gsub('right-', 'right/').gsub('ui-i18n-', 'i18n/')
+          else
+            file.gsub('right-', 'right/')
+          end
+          
+          m.file file, "public/javascripts/#{destination}", :chmod => 0644
+        end
+      end
+      
+      # creating the iframed uploads layout
+      m.directory "app/views/layouts"
+      m.file "/../generators/right_rails/templates/iframed.html.erb", "app/views/layouts/iframed.html.erb"
+    end
+  end
+  
+  
+  def banner
+    "Usage: #{$0} right_rails"
+  end
+  
+end

data/generators/right_rails/templates/iframed.html.erb

@@ -0,0 +1,10 @@
+<!-- iframed uploads JS responses layout -->
+<html>
+  <head>
+    <script type="text/javascript">
+      with (window.parent) {
+        <%= yield %>
+      }
+    </script>
+  </head>
+</html>

data/generators/right_scaffold/right_scaffold_generator.rb

@@ -0,0 +1,53 @@
+#
+# This is pretty much the same thing as the native rails scaffold generator
+# only without tests, plust it adds the '.js' format responses and fixes
+# the templates organization
+#
+#
+class RightScaffoldGenerator < ScaffoldGenerator
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions("#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_name)
+
+      # Controller, helper, views, test and stylesheets directories.
+      m.directory(File.join('app/models', class_path))
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('app/views/layouts', controller_class_path))
+      m.directory(File.join('public/stylesheets', class_path))
+
+      for action in scaffold_views
+        m.template(
+          "view_#{action}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.html.erb")
+        )
+      end
+      
+      m.template "view__form.html.erb", File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+      m.template "view__item.html.erb", File.join('app/views', controller_class_path, controller_file_name, "_#{file_name}.html.erb")
+
+      # Layout and stylesheet.
+      m.template('layout.html.erb', File.join('app/views/layouts', controller_class_path, "#{controller_file_name}.html.erb"))
+      m.template('style.css', 'public/stylesheets/scaffold.css')
+
+      m.template(
+        'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+
+      m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
+      
+      m.route_resources controller_file_name
+
+      m.dependency 'model', [name] + @args, :collision => :skip
+    end
+  end
+  
+protected
+
+  def banner
+    "Usage: #{$0} right_scaffold ModelName [field:type, field:type]"
+  end
+end

data/generators/right_scaffold/templates/controller.rb

@@ -0,0 +1,99 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= class_name %>.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @<%= table_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1
+  # GET /<%= table_name %>/1.xml
+  def show
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/new
+  # GET /<%= table_name %>/new.xml
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1/edit
+  # GET /<%= table_name %>/1/edit.js
+  def edit
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+    
+    respond_to do |format|
+      format.js  { render rjs.show_form_for(@<%= file_name %>) }
+      format.any # edit.html.erb
+    end
+  end
+
+  # POST /<%= table_name %>
+  # POST /<%= table_name %>.xml
+  # POST /<%= table_name %>.js
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+
+    respond_to do |format|
+      if @<%= file_name %>.save
+        flash[:notice] = '<%= class_name %> was successfully created.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { render :xml => @<%= file_name %>, :status => :created, :location => @<%= file_name %> }
+        format.js   { render rjs.insert_and_care(@<%= file_name %>) }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+        format.js   { render rjs.replace_form_for(@<%= file_name %>) }
+      end
+    end
+  end
+
+  # PUT /<%= table_name %>/1
+  # PUT /<%= table_name %>/1.xml
+  # PUT /<%= table_name %>/1.js
+  def update
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+        flash[:notice] = '<%= class_name %> was successfully updated.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { head :ok }
+        format.js   { render rjs.replace_and_care(@<%= file_name %>) }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+        format.js   { render rjs.replace_form_for(@<%= file_name %>) }
+      end
+    end
+  end
+
+  # DELETE /<%= table_name %>/1
+  # DELETE /<%= table_name %>/1.xml
+  # DELETE /<%= table_name %>/1.js
+  def destroy
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+    @<%= file_name %>.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(<%= table_name %>_url) }
+      format.xml  { head :ok }
+      format.js   { render rjs.remove(@<%= file_name %>) }
+    end
+  end
+end

data/generators/right_scaffold/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= controller_class_name %>Helper
+end

data/generators/right_scaffold/templates/layout.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'scaffold' %>
+  <%%= rightjs_scripts %>
+</head>
+<body>
+
+<%%= flashes %>
+
+<%%= yield %>
+
+</body>
+</html>

data/generators/right_scaffold/templates/style.css

@@ -0,0 +1,54 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+

data/generators/right_scaffold/templates/view__form.html.erb

@@ -0,0 +1,16 @@
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= f.error_messages %>
+
+<% for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+<% end -%>
+
+  <p class="buttons">
+    <%%= f.submit f.object.new_record? ? 'Create' : 'Update' %>
+    <%%= link_to_function 'Cancel', "$(this).parent('form').remove();" if request.xhr? %>
+    <%%= image_tag 'spinner.gif', :style => 'display:none', :class => :spinner %>
+  </p>
+<%% end %>

data/generators/right_scaffold/templates/view__item.html.erb

@@ -0,0 +1,13 @@
+<%% div_for <%= singular_name %> do %>
+<% for attribute in attributes -%>
+  <p>
+    <label><%= attribute.name %></label>: <%%=h <%= singular_name %>.<%= attribute.name %> %>
+  </p>
+<% end -%>
+  
+  <div class="actions">
+    <%%= link_to 'Show', <%= singular_name %> %> |
+    <%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>), :class => :edit %> |
+    <%%= link_to 'Destroy', <%= singular_name %>, :confirm => 'Are you sure?', :method => :delete, :class => :destroy %>
+  </div>
+<%% end -%>

data/generators/right_scaffold/templates/view_edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%%= render 'form' %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/generators/right_scaffold/templates/view_index.html.erb

@@ -0,0 +1,9 @@
+<h1>Listing <%= plural_name %></h1>
+
+<div id="<%= plural_name %>">
+  <%%= render @<%= plural_name %> %>
+</div>
+
+<br />
+
+<%%= link_to 'New <%= singular_name %>', new_<%= singular_name %>_path %>

data/generators/right_scaffold/templates/view_new.html.erb

@@ -0,0 +1,5 @@
+<h1>New <%= singular_name %></h1>
+
+<%%= render 'form' %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/generators/right_scaffold/templates/view_show.html.erb

@@ -0,0 +1,10 @@
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.column.human_name %>:</b>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<%%= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/init.rb

@@ -0,0 +1,12 @@
+# Include hook code here
+
+if defined?(ActionController)
+  class ActionController::Base
+    include RightRails::ControllerExtensions
+    
+    helper RightRails::Helpers::Basic,
+           RightRails::Helpers::Rails,
+           RightRails::Helpers::Forms,
+           RightRails::Helpers::Misc
+  end
+end