right-rails 0.6.0 → 1.0.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+2010-09-06 Nikolay Nemshilov
+  o Version 1.0.0
+    * RightJS v2.0.0-rc2
+    * All new RightJS UI 2.0 widgets
+    * RightRails configuration interface
+    * Full Rails 3 support
+    
+
 2010-01-16 Nikolay V. Nemshilov aka St.
   o Version 0.4.4
     * RightJS v 1.5.3

data/README.rdoc

@@ -0,0 +1,71 @@
+= Welcome To RightRails
+
+RightRails is a RubyOnRails plugin for {RightJS}[http://rightjs.org] javascript framework.
+
+It works as a drop in replacement for all the Prototype/Scriptaculous
+methods, plus it brings some more sweets and routine ajax operation
+helpers.
+
+
+== 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 various fields
+* Underscored and ruby-like aliases for RightJS core methods
+
+
+== Installation
+
+RightRails is available as a normal ruby-gem
+
+    sudo gem install right-rails
+
+Or you can install it as a rails plugin
+
+    script/plugin install git://github.com/MadRabbit/right-rails.git
+
+In case of ruby-gem and Rails 3, add the following into your +Gemfile+
+    
+    gem 'right-rails'
+
+If you on Rails 2, add the following code into your +environment.rb+
+
+    Rails::Initializer.run do |config|
+      config.gem 'right-rails'
+    end
+
+Once you've done that, run the +right_rails+ generator
+
+    script/generate right_rails
+
+Or under Rails 3
+
+    rails g right_rails
+
+Enjoy!
+
+
+== Documentation
+
+See the wiki-pages for the documentation
+
+http://wiki.github.com/MadRabbit/right-rails
+
+See also the demo application for examples
+
+http://github.com/MadRabbit/right-rails-demo
+
+    
+
+
+
+== Copyright
+
+Copyright (c) 2009-2010 Nikolay Nemshilov, released under the MIT license

data/Rakefile

@@ -1,16 +1,34 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
+require 'spec/rake/spectask'
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc 'Default: run rspec tests.'
+task :default => :spec
 
-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
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = lambda do
+      IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+
+#  desc "Print Specdoc for all specs"
+#  Spec::Rake::SpecTask.new(:doc) do |t|
+#    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+#    t.spec_files = FileList['spec/**/*_spec.rb']
+#  end
 end
 
 desc 'Generate documentation for the right_rails plugin.'
@@ -18,25 +36,137 @@ 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('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 
+#
+# Some of my own scripts to help me build the RightJS stuff
+# and properly organize it in the directory that will be
+# used in the Rails generator
+#
 namespace :rjs do
-  desc 'Patches the JavaScript UI modules for new images location'
-  task :patch_ui do
-    FileList['javascripts/*.js'].each do |filename|
+  CURRENT_DIR         = File.dirname(__FILE__)
+  
+  OUTPUT_DIR          = CURRENT_DIR + '/public'
+  OUTPUT_JSS_DIR      = OUTPUT_DIR + "/javascripts"
+  OUTPUT_IMG_DIR      = OUTPUT_DIR + "/images"
+  
+  RIGHTJS_CORE_DIR    = CURRENT_DIR + '/../RightJS'
+  RIGHTJS_PLUGINS_DIR = CURRENT_DIR + '/../RightJSPlugins'
+  RIGHTJS_UI_DIR      = CURRENT_DIR + '/../RightJSUI'
+  
+  desc 'Builds all the RightJS files and tosses them into the directories'
+  task :build do
+    Rake::Task['rjs:nuke'].invoke
+    Rake::Task['rjs:build:core'].invoke
+    Rake::Task['rjs:build:plugins'].invoke
+    Rake::Task['rjs:build:ui'].invoke
+    Rake::Task['rjs:patch'].invoke
+    Rake::Task['rjs:i18n'].invoke
+    Rake::Task['rjs:toss'].invoke
+  end
+  
+  desc 'Nukes the RightJS sources directory'
+  task :nuke do
+    require 'fileutils'
+    
+    puts "\e[31m<<<<<<<<<<<<<     TERMAL CLEANING     >>>>>>>>>>>>>>>>>\e[0m"
+    
+    FileUtils.rm_rf   OUTPUT_DIR if File.exists? OUTPUT_DIR
+    FileUtils.mkdir_p OUTPUT_DIR
+    FileUtils.mkdir_p OUTPUT_IMG_DIR
+    FileUtils.mkdir_p OUTPUT_JSS_DIR
+    FileUtils.mkdir_p OUTPUT_JSS_DIR + "/right"
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Builds RightJS core and copies them in place'
+  task :'build:core' do
+    puts "\e[31m<<<<<<<<<<<<     BUILDING THE CORE     >>>>>>>>>>>>>>>>\e[0m"
+    
+    system(%Q{
+      cd #{RIGHTJS_CORE_DIR};
+      rake build OPTIONS=no-olds;
+      cp build/*.js #{OUTPUT_JSS_DIR};
+      rake build OPTIONS=safe;
+      cp build/right-safe*.js #{OUTPUT_JSS_DIR};
+    })
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Builds RightJS plugins and copies them in place'
+  task :'build:plugins' do
+    puts "\e[31m<<<<<<<<<<<<<    BUILDING PLUGINS     >>>>>>>>>>>>>>>>>\e[0m"
+    
+    system(%Q{
+      cd #{RIGHTJS_PLUGINS_DIR};
+      rake build;
+      cp build/*.js #{OUTPUT_JSS_DIR}/right;
+    })
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Builds RightJS UI modules and copies them in place'
+  task :'build:ui' do
+    puts "\e[31m<<<<<<<<<<<     BUILDING UI MODULES     >>>>>>>>>>>>>>>\e[0m"
+    
+    system(%Q{
+      cd #{RIGHTJS_UI_DIR};
+      rake build;
+      cp build/*.js #{OUTPUT_JSS_DIR}/right;
+    })
+    
+    system(%Q{
+      cd #{RIGHTJS_UI_DIR};
+      cp img/* #{OUTPUT_IMG_DIR};
+    })
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Patches the RightJS UI modules for the Rails directories structure'
+  task :'patch' do
+    puts "\e[31m<<<<<<<     PATCHING UI MODULES FOR RAILS     >>>>>>>>>\e[0m"
+    
+    FileList["#{OUTPUT_JSS_DIR}/right/*.js"].each do |filename|
       old_content = File.read(filename)
       new_content = old_content.gsub('url(../../img/', "url(/images/rightjs-ui/")
-      new_content = new_content.gsub(/([^\s])no-repeat/, '\1 no-repeat') # front-compiler CSS compressor bug fix
       
       if old_content != new_content
-        puts "Patching: #{filename}"
+        puts "Patching: #{File.basename(filename)}"
         File.open(filename, "w") do |f|
           f.write new_content
         end
       end
     end
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Copies the RightJS UI i18n modules in place'
+  task :i18n do
+    puts "\e[31m<<<<<<<<<<<     COPYING I18N MODULES     >>>>>>>>>>>>>>\e[0m"
+    
+    system(%Q{
+      cp -r #{RIGHTJS_UI_DIR}/i18n #{OUTPUT_JSS_DIR}/right;
+    })
+    
+    puts "\e[32mDONE \e[0m"
+  end
+  
+  desc 'Prepares the files as they will be placed in Rails'
+  task :toss do
+    puts "\e[31m<<<<<<<<<     PREPARING FILES FOR RAILS     >>>>>>>>>>>\e[0m"
+    
+    FileList["#{OUTPUT_JSS_DIR}/right/right-*.js"].each do |filename|
+      system "mv #{filename.gsub('/right/right-', '/right/{right-,}')}"
+    end
+    
+    puts "\e[32mDONE \e[0m"
   end
 end

data/generators/right_rails/right_rails_generator.rb

@@ -4,39 +4,36 @@
 
 class RightRailsGenerator < Rails::Generator::Base
   
-  mandatory_options :source => "#{File.dirname(__FILE__)}/../../javascripts"
-    
   def manifest
+    source_path      = File.dirname(__FILE__)
+    images_path      = "#{source_path}/../../public/images"
+    javascripts_path = "#{source_path}/../../public/javascripts"
+    
     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', 'right-olds.js', 'right-olds-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
+      Dir["#{javascripts_path}/**/*.js"].each do |filename|
+        m.file(
+          filename.gsub("#{javascripts_path}/", "../../../public/javascripts/"),
+          "public/javascripts/#{filename.gsub("#{javascripts_path}/", '')}",
+          :chmod => 0644
+        )
       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"
+      m.file "iframed.html.erb", "app/views/layouts/iframed.html.erb"
       
       # copying the images in place
       m.directory "public/images/rightjs-ui"
-      Dir.open("#{File.dirname(__FILE__)}/../../images").each do |filename|
-        unless ['.', '..'].include?(filename)
-          m.file "/../images/#{filename}", "public/images/rightjs-ui/#{filename}"
-        end
+      
+      Dir["#{images_path}/*"].each do |filename|
+        m.file(
+          filename.gsub("#{images_path}/", "../../../public/images/"),
+          "public/images/rightjs-ui/#{filename.gsub("#{images_path}/", '')}",
+          :chmod => 0644
+        )
       end
     end
   end

data/init.rb

@@ -1,42 +1,21 @@
 # Include hook code here
 
 require 'right_rails'
-require 'right_rails/controller_extensions'
-require 'right_rails/java_script_generator'
-require 'right_rails/helpers'
-require 'right_rails/helpers/basic'
-require 'right_rails/helpers/forms'
-require 'right_rails/helpers/misc'
-require 'right_rails/helpers/rails'
 
 if defined?(Rails)
-  if Rails::VERSION::MAJOR == 2
-    # Rails 2.x.x initalizer
-    
-    if defined?(ActionController)
-      class ActionController::Base
-        include RightRails::ControllerExtensions
-    
-        helper RightRails::Helpers::Basic,
-               RightRails::Helpers::Rails,
-               RightRails::Helpers::Forms,
-               RightRails::Helpers::Misc
-      end
-    end
-
-  else
+  if Rails::VERSION::MAJOR > 2
     # Rails 3 initializer
     require 'action_controller/railtie'
-    
-    if defined?(ActionController)
-      class ActionController::Base
-        include RightRails::ControllerExtensions
-    
-        helper RightRails::Helpers::Basic,
-               RightRails::Helpers::Forms,
-               RightRails::Helpers::Misc,
-               RightRails::Helpers::Rails
-      end
+  end
+  
+  if defined?(ActionController)
+    class ActionController::Base
+      include RightRails::ControllerExtensions
+  
+      helper RightRails::Helpers::Basic,
+             RightRails::Helpers::Rails,
+             RightRails::Helpers::Forms,
+             RightRails::Helpers::Misc
     end
   end
 end

data/lib/generators/right_rails/right_rails_generator.rb

@@ -0,0 +1,27 @@
+#
+# Copies all the javascripts in place and updates them if necessary
+#
+# Kudos to Jose Fernández (http://github.com/magec)
+#
+class RightRailsGenerator < Rails::Generators::Base
+  
+  def manifest
+    source_path      = File.dirname(__FILE__)
+    images_path      = "#{source_path}/../../../public/images"
+    javascripts_path = "#{source_path}/../../../public/javascripts"
+
+    # copying the javascript javascript files
+    directory javascripts_path , "public/javascripts/"
+
+    # creating the iframed uploads layout
+    copy_file source_path + "/templates/iframed.html.erb", "app/views/layouts/iframed.html.erb"
+    
+    # copying the images in place
+    directory images_path, "public/images/rightjs-ui"
+  end
+  
+  def banner
+    "Usage: #{$0} right_rails"
+  end
+  
+end

data/lib/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/lib/right-rails.rb

@@ -5,7 +5,7 @@
 # to make it automatically initialized when you include the plugin as
 # a gem in your environment.rb without the actual lib option specification
 #
-# Copyright (C) 2009 Nikolay V. Nemshilov aka St.
+# Copyright (C) 2009-2010 Nikolay Nemshilov
 #
 require 'right_rails'
 require File.dirname(__FILE__) + '/../init.rb'