right-rails 0.3.0

data/lib/right_rails/java_script_generator.rb

@@ -0,0 +1,313 @@
+#
+# The right-rails scripts generator
+#
+class RightRails::JavaScriptGenerator
+  
+  def initialize(template, thread=nil)
+    @util = Util.new(template, thread)
+  end
+  
+  # the top-level constants that the generator should respond to transparently
+  JS_CONSTANTS = [:document, :window, :top, :RR]
+  
+  # method calls catchup
+  def method_missing(name, *args)
+    @util.record(if JS_CONSTANTS.include?(name)
+      name
+    elsif name.to_s[name.to_s.size-1, name.to_s.size] == '='
+      "#{name.to_s[0, name.to_s.size-1]}=#{@util.to_js_type(args.first)}"
+    else
+      "#{name}(#{@util.to_js_args(args)})"
+    end)
+  end
+  
+  # returns the result script
+  def to_s
+    @util.build_script
+  end
+  
+  #
+  # This module contains the predefined methods collection
+  #
+  module Methods
+    # referring an element by an id or a record
+    def [](record_or_id)
+      @util.record("$(\"#{@util.dom_id(record_or_id)}\")")
+    end
+
+    # just pushes a line of code into the thread
+    def << (code)
+      @util.write(code)
+      self
+    end
+
+    # builds a css-select block
+    def find(css_rule)
+      @util.record("$$(\"#{css_rule}\")")
+    end
+
+    # access to the javascript variables
+    def get(name)
+      @util.record(name)
+    end
+
+    # variables initializing method
+    def set(name, value)
+      @util.record("var #{name}=#{@util.to_js_type(value)}")
+    end
+
+    # generates the redirection script
+    def redirect_to(location)
+      self.document[:location].href = (location.is_a?(String) ? location : @util.template.url_for(location))
+      self
+    end
+
+    # generates the page reload script
+    def reload
+      self.document[:location].reload
+      self
+    end
+
+    # builds the record HTML code and then insterts it in place
+    def insert(record)
+      self.RR.insert(record.class.table_name, @util.render(record))
+    end
+    
+    # generates a script that inserts the record partial, then updates the form and the flashes block
+    def insert_and_care(record)
+      insert(record)
+      @util.template.instance_variable_set("@#{record.class.table_name.singularize}", record.class.new)
+      replace_form_for(record.class.new)
+      update_flash
+    end
+
+    # replaces the record element on the page
+    def replace(record)
+      self.RR.replace(@util.dom_id(record), @util.render(record))
+    end
+
+    # replaces the record partial and updates the flash
+    def replace_and_care(record)
+      replace(record)
+      update_flash
+    end
+
+    # removes the record element from the page
+    def remove(record)
+      self.RR.remove(@util.dom_id(record))
+    end
+
+    # renders and shows a form for the record
+    def show_form_for(record)
+      self.RR.show_form_for(@util.dom_id(record), @util.render('form'))
+    end
+
+    # renders and updates a form for the record
+    def replace_form_for(record)
+      self.RR.replace_form(@util.form_id_for(record), @util.render('form'))
+    end
+    
+    # updates the flashes block
+    def update_flash(content=nil)
+      self.RR.update_flash(content || @util.template.flashes)
+      @util.template.flash.clear
+    end
+  end
+  
+  include Methods
+  
+protected
+
+  #
+  # Keeps the javascript method calls sequence and then represents iteslf like a string of javascript
+  #
+  class MethodCall
+    
+    def initialize(this, util, parent)
+      @this   = this
+      @util   = util
+      @parent = parent
+    end
+    
+    # catches the properties request
+    def [](name)
+      @child = @util.make_call(".#{name}", self)
+    end
+    
+    # attribute assignment hook
+    def []=(name, value)
+      send "#{name}=", value
+    end
+    
+    OPERATIONS = %w{+ - * / % <<}
+    
+    # catches all the method calls
+    def method_missing(name, *args, &block)
+      name = name.to_s
+      args << block if block_given?
+      
+      @child = @util.make_call((
+        # assignments
+        if name[name.size-1, name.size] == '='
+          ".#{name[0,name.size-1]}=#{@util.to_js_type(args.first)}"
+          
+        # operation calls
+        elsif OPERATIONS.include?(name)
+          name = "+=" if name == '<<'
+          "#{name}#{@util.to_js_type(args.first)}"
+          
+        # usual method calls
+        else
+          ".#{name}(#{@util.to_js_args(args)})"
+        end
+      ), self)
+    end
+    
+    # exports the whole thing into a javascript string
+    def to_s
+      nodes = []
+      node = self
+      
+      while node
+        nodes << node
+        node = node.instance_variable_get(@parent.nil? ? "@child" : "@parent")
+      end
+      
+      # reversing the calls list if building from the right end
+      nodes.reverse! unless @parent.nil?
+      
+      nodes.collect{|n| n.instance_variable_get("@this").to_s }.join('')
+    end
+  end
+  
+  #
+  # We use this class to cleanup the main namespace of the JavaScriptGenerator instances
+  # So that the mesod_missing didn't interferate with the util methods
+  #
+  class Util
+    attr_reader :template
+    
+    def initialize(template, thread=nil)
+      @template = template
+      @thread   = thread || []
+    end
+    
+    # returns a conventional dom id for the record
+    def dom_id(record)
+      if [String, Symbol].include?(record.class)
+        "#{record}"
+      else
+        @template.dom_id(record)
+      end
+    end
+    
+    # generates the form-id for the given record
+    def form_id_for(record)
+      record.new_record? ? "new_#{record.class.table_name.singularize}" : "edit_#{dom_id(record)}"
+    end
+
+    # retnders the thing
+    def render(what)
+      @template.render(what)
+    end
+    
+    # builds a new method call object
+    def make_call(string, parent=nil)
+      MethodCall.new(string, self, parent)
+    end
+    
+    # Records a new call
+    def record(command)
+      @thread << (line = make_call(command))
+      line
+    end
+    
+    # writes a pline script code into the thread
+    def write(script)
+      @thread << script
+    end
+    
+    # builds the end script
+    def build_script
+      @thread.collect{|line|
+        line.is_a?(String) ? line : (line.to_s + ';')
+      }.join('')
+    end
+
+    # converts the list of values into a javascript function arguments list
+    def to_js_args(args)
+      args.collect do |value|
+        to_js_type(value)
+      end.join(',')
+    end
+    
+    # converts any ruby type into an javascript type
+    def to_js_type(value)
+      case value.class.name.to_sym
+        when :Float, :Fixnum, :TrueClass, :FalseClass, :Symbol then value.to_s
+        when :String   then "\"#{@template.escape_javascript(value)}\""
+        when :NilClass then 'null'
+        when :Array    then "[#{to_js_args(value)}]"
+        when :Proc     then proc_to_function(&value)
+        else
+            
+          # the other method-calls processing
+          if value.is_a?(MethodCall)
+            # removing the call out of the calls thread
+            top    = value
+            parent = value
+            while parent
+              top    = parent
+              parent = parent.instance_variable_get('@parent')
+            end
+            @thread.reject!{ |item| item == top }
+            
+            value.to_s
+            
+          # simple hashes processing
+          elsif value.is_a?(Hash)
+            pairs = []
+            value.each do |key, value|
+              pairs << "#{to_js_type(key)}:#{to_js_type(value)}"
+            end
+            "{#{pairs.sort.join(',')}}"
+          
+          # JSON exportable values processing
+          elsif value.respond_to?(:to_json)
+            to_js_type(value.to_json)
+          
+          # throwing an ansupported class name
+          else
+            throw "RightRails::JavaScriptGenerator doesn't instances of #{value.class.name} yet"
+          end
+      end
+    end
+    
+    # converts a proc into a javascript function
+    def proc_to_function(&block)
+      thread = []
+      args   = []
+      names  = []
+      name   = 'a'
+      page   = RightRails::JavaScriptGenerator.new(@template, thread)
+      
+      block.arity.times do |i|
+        args  << page.get(name)
+        names << name
+        name = name.succ
+      end
+      
+      # swapping the current thread with the block's one
+      old_thread = @thread
+      @thread = thread
+      
+      yield(*args)
+      
+      # swapping the current therad back
+      @thread = old_thread
+      
+      "function(#{names.join(',')}){#{page.to_s}}"
+    end
+  end
+  
+end

data/lib/right_rails.rb

@@ -0,0 +1,6 @@
+#
+# The RightRails module. Just a namespace
+#
+module RightRails
+  VERSION = '0.3.0'
+end

data/spec/lib/right_rails/controller_extensions_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + "/../../spec_helper.rb"
+
+class DummyController
+  include RightRails::ControllerExtensions
+  
+  attr_accessor :template
+  attr_accessor :request
+end
+
+describe RightRails::ControllerExtensions do
+  before :each do
+    @controller = DummyController.new
+    
+    @request    = mock(:request, {:content_type => Mime::JS})
+    
+    @template   = mock(:template, {:_evaluate_assigns_and_ivars => nil, :request => @request})
+    @controller.template = @template
+    
+    @generator = RightRails::JavaScriptGenerator.new(@template)
+    RightRails::JavaScriptGenerator.stub!(:new).with(@template).and_return(@generator)
+  end
+  
+  it "should bypass simple calls to the JavaScriptGenerator" do
+    @generator.should_receive(:alert).with('that')
+    @generator.should_receive(:to_s).and_return('the script')
+    
+    @controller.rjs.alert("that").should == {:text => 'the script', :content_type => Mime::JS}
+  end
+  
+  it "should process blocks properly" do
+    @generator.should_receive(:alert).with('boo')
+    @generator.should_receive(:confirm).with('foo')
+    
+    @generator.should_receive(:to_s).and_return('the script')
+    
+    @controller.rjs do |page|
+      page.alert('boo')
+      page.confirm('foo')
+    end.should == {:text => 'the script', :content_type => Mime::JS}
+  end
+  
+  it "should let you overload the options" do
+    @generator.should_receive(:alert).with('boo')
+    @generator.should_receive(:to_s).and_return('the script')
+    
+    @controller.rjs(:content_type => Mime::HTML, :layout => 'something').alert('boo').should == {
+      :text => 'the script', :content_type => Mime::HTML, :layout => 'something'
+    }
+  end
+  
+  it "should overload content-type and layout for the iframed uploads" do
+    @request.should_receive(:content_type).and_return('multipart/form-data')
+    @generator.should_receive(:update)
+    @generator.should_receive(:to_s).and_return('the script')
+    
+    @controller.rjs.update.should == {
+      :text => 'the script', :content_type => Mime::HTML, :layout => 'iframed'
+    }
+  end
+end

data/spec/lib/right_rails/helpers/basic_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + "/../../../spec_helper.rb"
+
+describe RightRails::Helpers::Basic do
+  include RightRails::Helpers::Basic
+  include ActionView::Helpers::TagHelper
+  
+  it "should build the basic javascript include tags" do
+    should_receive(:javascript_include_tag).with(*%w{right right/rails})
+    rightjs_scripts
+  end
+  
+  it "should catch the optional modules" do
+    @_right_scripts = %w{lightbox dnd}
+    
+    should_receive(:javascript_include_tag).with(*%w{right right/lightbox right/dnd right/rails})
+    
+    rightjs_scripts
+  end
+  
+  it "should let to specify the modules as arguments" do
+    should_receive(:javascript_include_tag).with(*%w{right right/lightbox right/dnd right/rails})
+    
+    rightjs_scripts :lightbox, :dnd
+  end
+  
+  it "should load internationalization modules if defined" do
+    should_receive(:javascript_include_tag).with(*%w{right right/rails right/i18n/ru})
+    
+    I18n.locale = 'ru'
+    RAILS_ROOT = "rails-root"
+    File.should_receive(:exists?).with("rails-root/public/javascripts/right/i18n/ru.js").and_return(true)
+    
+    rightjs_scripts
+  end
+  
+  it "should not include non-existing locales" do
+    should_receive(:javascript_include_tag).with(*%w{right right/rails})
+    
+    I18n.locale = 'some-weird-stuff'
+    File.should_receive(:exists?).with("rails-root/public/javascripts/right/i18n/some-weird-stuff.js").and_return(false)
+    
+    rightjs_scripts
+  end
+  
+  it "should use the source scripts in the development environment" do
+    should_receive(:javascript_include_tag).with(*%w{right-src right/rails-src})
+    
+    RAILS_ENV = 'development'
+    
+    rightjs_scripts
+  end
+  
+  it "should build a script-generator for the rjs method" do
+    rjs.should be_a(RightRails::JavaScriptGenerator)
+  end
+  
+  it "should generate scripts with rjs one-liners" do
+    rjs.boo.boo.boo.to_s.should == 'boo().boo().boo()'
+  end
+  
+  it "should generate scripts with rjs blocks" do
+    rjs do |page|
+      page.boo.boo.boo
+    end.to_s.should == 'boo().boo().boo();'
+  end
+  
+  it "should generate a proper javascript tag construction" do
+    should_receive(:javascript_tag).and_return('javascript_tag')
+    
+    rjs_tag do |page|
+      page.boo.boo.boo
+    end.to_s.should == 'javascript_tag'
+  end
+end

data/spec/lib/right_rails/helpers/forms_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/../../../spec_helper.rb"
+
+describe RightRails::Helpers::Forms do
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::JavaScriptHelper
+  include RightRails::Helpers::Basic
+  include RightRails::Helpers::Forms
+  
+  def url_for(options)   options end
+  def escape_javascript(str) str end
+  
+  it "should generate a #calendar_field_tag" do
+    calendar_field_tag('name', 'value').should == 
+      %Q{<input id="name" name="name" rel="calendar" type="text" value="value" />}
+    
+    @_right_scripts.should == ['calendar']
+  end
+  
+  it "should generate a #calendar_field_tag with options" do
+    calendar_field_tag('name', 'value', :format => '%Y/%m/%d').should ==
+      %Q{<input data-calendar-options="{format:'%Y/%m/%d'}" id="name" name="name" rel="calendar" type="text" value="value" />}
+  end
+  
+  it "should generate a #autocomplete_field_tag" do
+    autocomplete_field_tag('name', 'value', :url => '/foo').should ==
+      %Q{<input autocomplete="off" id="name" name="name" rel="autocompleter[/foo]" type="text" value="value" />}
+      
+    @_right_scripts.should == ['autocompleter']
+  end
+  
+  it "should generate a #autocomplete_field_tag with options" do
+    autocomplete_field_tag('name', 'value', :url => '/foo', :spinner => 'spinner', :min_length => 2).should ==
+      %Q{<input autocomplete="off" data-autocompleter-options="{minLength:2,spinner:'spinner'}" id="name" name="name" rel="autocompleter[/foo]" type="text" value="value" />}
+  end
+  
+  it "should generate a #slider_tag with options" do
+    slider_tag('some_field', 22, :min => 10, :max => 40).should ==
+      %Q{<input id="some_field" name="some_field" type="hidden" value="22" />\n<script type="text/javascript">\n//<![CDATA[\nnew Slider({max:40,min:10,value:22}).insertTo('some_field','after').assignTo('some_field');\n//]]>\n</script>}
+  end
+  
+  it "should generate a #rater_tag" do
+    rater_tag('some_field', 2).should ==
+      %Q{<input id="some_field" name="some_field" type="hidden" value="2" />\n<script type="text/javascript">\n//<![CDATA[\nnew Rater({value:2}).insertTo('some_field','after').assignTo('some_field');\n//]]>\n</script>}
+  end
+  
+  it "should generate the #rater_display tag" do
+    rater_display(4).should ==
+      %Q{<div class="right-rater right-rater-disabled"><div class="right-rater-glow">★</div><div class="right-rater-glow">★</div><div class="right-rater-glow">★</div><div class="right-rater-glow">★</div><div>★</div></div>}
+  end
+end

data/spec/lib/right_rails/helpers/misc_spec.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + "/../../../spec_helper.rb"
+
+describe RightRails::Helpers::Misc do
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  include RightRails::Helpers::Basic
+  include RightRails::Helpers::Misc
+  
+  it "should provide the basic #flashes builder" do
+    should_receive(:flash).any_number_of_times.and_return({
+      :warning => "Warning!",
+      :notice  => "Notice!",
+      :error   => "Error!"
+    })
+    
+    flashes.should == '<div id="flashes">'+
+      '<div class="error">Error!</div>'+
+      '<div class="notice">Notice!</div>'+
+      '<div class="warning">Warning!</div>'+
+    '</div>'
+  end
+  
+  describe "#autocomplete_result" do
+    it "should generate a simple result" do
+      autocomplete_result(%w{one two three}).should == '<ul><li>one</li><li>two</li><li>three</li></ul>'
+    end
+    
+    it "should generate result with highlightning" do
+      autocomplete_result(%w{one two three}, :highlight => 'o').should == 
+        '<ul><li><strong class="highlight">o</strong>ne</li><li>tw<strong class="highlight">o</strong></li><li>three</li></ul>'
+    end
+    
+    it "should escape strings by default" do
+      autocomplete_result(['<b>b</b>', '<i>i</i>']).should ==
+        %Q{<ul><li>&lt;b&gt;b&lt;/b&gt;</li><li>&lt;i&gt;i&lt;/i&gt;</li></ul>}
+    end
+    
+    it "should not escape strings if asked" do
+      autocomplete_result(['<b>b</b>', '<i>i</i>'], :escape => false).should ==
+        %Q{<ul><li><b>b</b></li><li><i>i</i></li></ul>}
+    end
+    
+    it "should generate result out of list of records" do
+      records = [
+        mock(:boo, :boo => 'one'),
+        mock(:boo, :boo => 'two')
+      ]
+      
+      autocomplete_result(records, :boo).should == '<ul><li>one</li><li>two</li></ul>'
+    end
+    
+    it "should highlight result when generated out of an objects list" do
+      records = [
+        mock(:boo, :boo => 'one'),
+        mock(:boo, :boo => 'two')
+      ]
+      
+      autocomplete_result(records, :boo, :highlight => 'o').should == 
+        %Q{<ul><li><strong class="highlight">o</strong>ne</li><li>tw<strong class="highlight">o</strong></li></ul>}
+    end
+  end
+  
+  describe "#link_to_lightbox" do
+    it "should generate the link" do
+      link_to_lightbox('boo', 'boo').should == '<a href="boo" rel="lightbox">boo</a>'
+      @_right_scripts.should == ['lightbox']
+    end
+    
+    it "should generate lightbox with roadtrip" do
+      link_to_lightbox('boo', 'boo', :roadtrip => true).should ==
+        %Q{<a href="boo" rel="lightbox[roadtrip]">boo</a>}
+    end
+  end
+  
+  describe "#tabs generator" do
+    def capture(&block)
+      return yield()
+    end
+    
+    def concat(content)
+      content
+    end
+    
+    it "should generate simple tabs" do
+      tabs(:id => 'my-tabs') {
+        tab("Tab 1", :id => 'tab-1'){ 'content 1' }
+        tab("Tab 2", :id => 'tab-2'){ 'content 2' }
+      }.should == %Q{<ul id=\"my-tabs\"><ul><li><a href=\"#tab-1\">Tab 1</a></li>\n<li><a href=\"#tab-2\">Tab 2</a></li></ul>\n<li id=\"tab-1\">content 1</li>\n<li id=\"tab-2\">content 2</li>\n</ul>\n<script type=\"text/javascript\">\n//<![CDATA[\nnew Tabs('my-tabs');\n//]]>\n</script>}
+    end
+    
+    it "should generate tabs with id prefix" do
+      tabs(:id => 'my-tabs', :id_prefix => 'foo-') {
+        tab("Tab 1", :id => 'tab-1'){ 'content 1' }
+        tab("Tab 2", :id => 'tab-2'){ 'content 2' }
+      }.should == %Q{<ul data-tabs-options=\"{idPrefix:'foo-'}\" id=\"my-tabs\"><ul><li><a href=\"#tab-1\">Tab 1</a></li>\n<li><a href=\"#tab-2\">Tab 2</a></li></ul>\n<li id=\"foo-tab-1\">content 1</li>\n<li id=\"foo-tab-2\">content 2</li>\n</ul>\n<script type=\"text/javascript\">\n//<![CDATA[\nnew Tabs('my-tabs');\n//]]>\n</script>}
+    end
+    
+    it "should generate remote tabs" do
+      tabs(:id => 'my-tabs') {
+        tab("Tab 1", :url => '/tab/1')
+        tab("Tab 2", :url => '/tab/2')
+      }.should == %Q{<ul id=\"my-tabs\"><ul><li><a href=\"/tab/1\">Tab 1</a></li>\n<li><a href=\"/tab/2\">Tab 2</a></li></ul>\n</ul>\n<script type=\"text/javascript\">\n//<![CDATA[\nnew Tabs('my-tabs');\n//]]>\n</script>}
+    end
+    
+    it "should generate carousel tabs" do
+      tabs(:id => 'my-tabs', :type => :carousel) {
+        tab("Tab 1", :id => 'tab-1'){ 'content 1' }
+        tab("Tab 2", :id => 'tab-2'){ 'content 2' }
+      }.should == %Q{<ul class=\"right-tabs-carousel\" id=\"my-tabs\"><ul><li><a href=\"#tab-1\">Tab 1</a></li>\n<li><a href=\"#tab-2\">Tab 2</a></li></ul>\n<li id=\"tab-1\">content 1</li>\n<li id=\"tab-2\">content 2</li>\n</ul>\n<script type=\"text/javascript\">\n//<![CDATA[\nnew Tabs('my-tabs');\n//]]>\n</script>}
+    end
+    
+    it "should generate harmonica tabs" do
+      tabs(:id => 'my-tabs', :type => :harmonica) {
+        tab("Tab 1", :id => 'tab-1'){ 'content 1' }
+        tab("Tab 2", :id => 'tab-2'){ 'content 2' }
+      }.should == %Q{<dl id=\"my-tabs\"><dt><a href=\"#tab-1\">Tab 1</a></dt>\n<dd id=\"tab-1\">content 1</dd>\n<dt><a href=\"#tab-2\">Tab 2</a></dt>\n<dd id=\"tab-2\">content 2</dd></dl>\n<script type=\"text/javascript\">\n//<![CDATA[\nnew Tabs('my-tabs');\n//]]>\n</script>}
+    end
+  end
+end