interpret 0.1.4 → 0.1.5

data/public/javascripts/facebox-1.3/facebox.js

@@ -0,0 +1,309 @@
+/*
+ * Facebox (for jQuery)
+ * version: 1.2 (05/05/2008)
+ * @requires jQuery v1.2 or later
+ *
+ * Examples at http://famspam.com/facebox/
+ *
+ * Licensed under the MIT:
+ *   http://www.opensource.org/licenses/mit-license.php
+ *
+ * Copyright 2007, 2008 Chris Wanstrath [ chris@ozmm.org ]
+ *
+ * Usage:
+ *
+ *  jQuery(document).ready(function() {
+ *    jQuery('a[rel*=facebox]').facebox()
+ *  })
+ *
+ *  <a href="#terms" rel="facebox">Terms</a>
+ *    Loads the #terms div in the box
+ *
+ *  <a href="terms.html" rel="facebox">Terms</a>
+ *    Loads the terms.html page in the box
+ *
+ *  <a href="terms.png" rel="facebox">Terms</a>
+ *    Loads the terms.png image in the box
+ *
+ *
+ *  You can also use it programmatically:
+ *
+ *    jQuery.facebox('some html')
+ *    jQuery.facebox('some html', 'my-groovy-style')
+ *
+ *  The above will open a facebox with "some html" as the content.
+ *
+ *    jQuery.facebox(function($) {
+ *      $.get('blah.html', function(data) { $.facebox(data) })
+ *    })
+ *
+ *  The above will show a loading screen before the passed function is called,
+ *  allowing for a better ajaxy experience.
+ *
+ *  The facebox function can also display an ajax page, an image, or the contents of a div:
+ *
+ *    jQuery.facebox({ ajax: 'remote.html' })
+ *    jQuery.facebox({ ajax: 'remote.html' }, 'my-groovy-style')
+ *    jQuery.facebox({ image: 'stairs.jpg' })
+ *    jQuery.facebox({ image: 'stairs.jpg' }, 'my-groovy-style')
+ *    jQuery.facebox({ div: '#box' })
+ *    jQuery.facebox({ div: '#box' }, 'my-groovy-style')
+ *
+ *  Want to close the facebox?  Trigger the 'close.facebox' document event:
+ *
+ *    jQuery(document).trigger('close.facebox')
+ *
+ *  Facebox also has a bunch of other hooks:
+ *
+ *    loading.facebox
+ *    beforeReveal.facebox
+ *    reveal.facebox (aliased as 'afterReveal.facebox')
+ *    init.facebox
+ *    afterClose.facebox
+ *
+ *  Simply bind a function to any of these hooks:
+ *
+ *   $(document).bind('reveal.facebox', function() { ...stuff to do after the facebox and contents are revealed... })
+ *
+ */
+(function($) {
+  $.facebox = function(data, klass) {
+    $.facebox.loading()
+
+    if (data.ajax) fillFaceboxFromAjax(data.ajax, klass)
+    else if (data.image) fillFaceboxFromImage(data.image, klass)
+    else if (data.div) fillFaceboxFromHref(data.div, klass)
+    else if ($.isFunction(data)) data.call($)
+    else $.facebox.reveal(data, klass)
+  }
+
+  /*
+   * Public, $.facebox methods
+   */
+
+  $.extend($.facebox, {
+    settings: {
+      opacity      : 0.2,
+      overlay      : true,
+      loadingImage : '/javascripts/facebox-1.3/loading.gif',
+      closeImage   : '/javascripts/facebox-1.3/closelabel.png',
+      imageTypes   : [ 'png', 'jpg', 'jpeg', 'gif' ],
+      faceboxHtml  : '\
+    <div id="facebox" style="display:none;"> \
+      <div class="popup"> \
+        <div class="content"> \
+        </div> \
+        <a href="#" class="close"><img src="/javascripts/facebox-1.3/closelabel.png" title="close" class="close_image" /></a> \
+      </div> \
+    </div>'
+    },
+
+    loading: function() {
+      init()
+      if ($('#facebox .loading').length == 1) return true
+      showOverlay()
+
+      $('#facebox .content').empty()
+      $('#facebox .body').children().hide().end().
+        append('<div class="loading"><img src="'+$.facebox.settings.loadingImage+'"/></div>')
+
+      $('#facebox').css({
+        top:	getPageScroll()[1] + (getPageHeight() / 10),
+        left:	$(window).width() / 2 - 205
+      }).show()
+
+      $(document).bind('keydown.facebox', function(e) {
+        if (e.keyCode == 27) $.facebox.close()
+        return true
+      })
+      $(document).trigger('loading.facebox')
+    },
+
+    reveal: function(data, klass) {
+      $(document).trigger('beforeReveal.facebox')
+      if (klass) $('#facebox .content').addClass(klass)
+      $('#facebox .content').append(data)
+      $('#facebox .loading').remove()
+      $('#facebox .body').children().fadeIn('normal')
+      $('#facebox').css('left', $(window).width() / 2 - ($('#facebox .popup').width() / 2))
+      $(document).trigger('reveal.facebox').trigger('afterReveal.facebox')
+    },
+
+    close: function() {
+      $(document).trigger('close.facebox')
+      return false
+    }
+  })
+
+  /*
+   * Public, $.fn methods
+   */
+
+  $.fn.facebox = function(settings) {
+    if ($(this).length == 0) return
+
+    init(settings)
+
+    function clickHandler() {
+      $.facebox.loading(true)
+
+      // support for rel="facebox.inline_popup" syntax, to add a class
+      // also supports deprecated "facebox[.inline_popup]" syntax
+      var klass = this.rel.match(/facebox\[?\.(\w+)\]?/)
+      if (klass) klass = klass[1]
+
+      fillFaceboxFromHref(this.href, klass)
+      return false
+    }
+
+    return this.bind('click.facebox', clickHandler)
+  }
+
+  /*
+   * Private methods
+   */
+
+  // called one time to setup facebox on this page
+  function init(settings) {
+    if ($.facebox.settings.inited) return true
+    else $.facebox.settings.inited = true
+
+    $(document).trigger('init.facebox')
+    makeCompatible()
+
+    var imageTypes = $.facebox.settings.imageTypes.join('|')
+    $.facebox.settings.imageTypesRegexp = new RegExp('\.(' + imageTypes + ')$', 'i')
+
+    if (settings) $.extend($.facebox.settings, settings)
+    $('body').append($.facebox.settings.faceboxHtml)
+
+    var preload = [ new Image(), new Image() ]
+    preload[0].src = $.facebox.settings.closeImage
+    preload[1].src = $.facebox.settings.loadingImage
+
+    $('#facebox').find('.b:first, .bl').each(function() {
+      preload.push(new Image())
+      preload.slice(-1).src = $(this).css('background-image').replace(/url\((.+)\)/, '$1')
+    })
+
+    $('#facebox .close').click($.facebox.close)
+    $('#facebox .close_image').attr('src', $.facebox.settings.closeImage)
+  }
+
+  // getPageScroll() by quirksmode.com
+  function getPageScroll() {
+    var xScroll, yScroll;
+    if (self.pageYOffset) {
+      yScroll = self.pageYOffset;
+      xScroll = self.pageXOffset;
+    } else if (document.documentElement && document.documentElement.scrollTop) {	 // Explorer 6 Strict
+      yScroll = document.documentElement.scrollTop;
+      xScroll = document.documentElement.scrollLeft;
+    } else if (document.body) {// all other Explorers
+      yScroll = document.body.scrollTop;
+      xScroll = document.body.scrollLeft;
+    }
+    return new Array(xScroll,yScroll)
+  }
+
+  // Adapted from getPageSize() by quirksmode.com
+  function getPageHeight() {
+    var windowHeight
+    if (self.innerHeight) {	// all except Explorer
+      windowHeight = self.innerHeight;
+    } else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode
+      windowHeight = document.documentElement.clientHeight;
+    } else if (document.body) { // other Explorers
+      windowHeight = document.body.clientHeight;
+    }
+    return windowHeight
+  }
+
+  // Backwards compatibility
+  function makeCompatible() {
+    var $s = $.facebox.settings
+
+    $s.loadingImage = $s.loading_image || $s.loadingImage
+    $s.closeImage = $s.close_image || $s.closeImage
+    $s.imageTypes = $s.image_types || $s.imageTypes
+    $s.faceboxHtml = $s.facebox_html || $s.faceboxHtml
+  }
+
+  // Figures out what you want to display and displays it
+  // formats are:
+  //     div: #id
+  //   image: blah.extension
+  //    ajax: anything else
+  function fillFaceboxFromHref(href, klass) {
+    // div
+    if (href.match(/#/)) {
+      var url    = window.location.href.split('#')[0]
+      var target = href.replace(url,'')
+      if (target == '#') return
+      $.facebox.reveal($(target).html(), klass)
+
+    // image
+    } else if (href.match($.facebox.settings.imageTypesRegexp)) {
+      fillFaceboxFromImage(href, klass)
+    // ajax
+    } else {
+      fillFaceboxFromAjax(href, klass)
+    }
+  }
+
+  function fillFaceboxFromImage(href, klass) {
+    var image = new Image()
+    image.onload = function() {
+      $.facebox.reveal('<div class="image"><img src="' + image.src + '" /></div>', klass)
+    }
+    image.src = href
+  }
+
+  function fillFaceboxFromAjax(href, klass) {
+    $.get(href, function(data) { $.facebox.reveal(data, klass) })
+  }
+
+  function skipOverlay() {
+    return $.facebox.settings.overlay == false || $.facebox.settings.opacity === null
+  }
+
+  function showOverlay() {
+    if (skipOverlay()) return
+
+    if ($('#facebox_overlay').length == 0)
+      $("body").append('<div id="facebox_overlay" class="facebox_hide"></div>')
+
+    $('#facebox_overlay').hide().addClass("facebox_overlayBG")
+      .css('opacity', $.facebox.settings.opacity)
+      .click(function() { $(document).trigger('close.facebox') })
+      .fadeIn(200)
+    return false
+  }
+
+  function hideOverlay() {
+    if (skipOverlay()) return
+
+    $('#facebox_overlay').fadeOut(200, function(){
+      $("#facebox_overlay").removeClass("facebox_overlayBG")
+      $("#facebox_overlay").addClass("facebox_hide")
+      $("#facebox_overlay").remove()
+    })
+
+    return false
+  }
+
+  /*
+   * Bindings
+   */
+
+  $(document).bind('close.facebox', function() {
+    $(document).unbind('keydown.facebox')
+    $('#facebox').fadeOut(function() {
+      $('#facebox .content').removeClass().addClass('content')
+      $('#facebox .loading').remove()
+      $(document).trigger('afterClose.facebox')
+    })
+    hideOverlay()
+  })
+
+})(jQuery);

data/public/stylesheets/interpret_live_edit_style.css

@@ -0,0 +1,38 @@
+#interpret_live_edit {
+  padding-top: 15px;
+  padding-right: 16px;
+  width: 700px;
+  min-height: 300px;
+  text-align: center;
+}
+
+#interpret_live_edit textarea {
+  width: 100%;
+  height: 31em;
+}
+
+#interpret_live_edit input[type=submit] {
+  background-color: #555;
+  color: #FFF;
+  border: none;
+  font-size: 1em;
+  margin-top: .5em;
+  padding: .6em 1.5em;
+  cursor: hand;
+  cursor: pointer;
+  border-radius: 5px;
+}
+
+#interpret_live_edit input[type=submit]:hover {
+  background-color: #777;
+}
+
+.interpret_editable {
+  background-color: #F8FD7D;
+  cursor: hand;
+  cursor: pointer;
+}
+.interpret_editable:hover {
+  background-color: #FCF305;
+}
+

data/public/stylesheets/interpret_style.css

@@ -521,3 +521,21 @@ html body * dd.clear
 #interpret_container #tree_sidebar a:hover {
   text-decoration: underline;
 }
+
+#interpret_container .interpret_flash {
+    width: 95%;
+    min-height: 0.8em;
+    padding: 1em;
+    margin-bottom: 0.5em;
+    text-align: center;
+}
+
+#interpret_container .interpret_flash.notice {
+    background-color: #BBFFBB;
+    border: 1px solid #55FF55;
+}
+#interpret_container .interpret_flash.alert {
+    background-color: #FFBBBB;
+    border: 1px solid #FF5555;
+}
+

data/spec/models/translation_spec.rb

@@ -88,7 +88,7 @@ es:
         if dict[x].kind_of?(Hash)
           res += parse_hash(dict[x], locale, "#{prefix}#{x}.")
         else
-          res << Interpret::Translation.new(:locale => locale, :key => "#{prefix}#{x}", :value => dict[x])
+          res << Interpret::Translation.create!(:locale => locale, :key => "#{prefix}#{x}", :value => dict[x])
         end
       end
       res
@@ -102,6 +102,7 @@ es:
   end
 
   before do
+    Interpret::Translation.delete_all
     I18n.stub!(:default_locale).and_return('en')
   end
 
@@ -132,7 +133,7 @@ es:
   end
 
   describe ".update" do
-    before(:all) do
+    before do
       # Supose the database has the default contents, look at the top of this
       # file for en_yml simulated locale file
       file2db(en_yml)
@@ -144,15 +145,21 @@ es:
       YAML.should_receive(:load_file).twice.and_return(YAML.load(new_en_yml), YAML.load(new_es_yml))
     end
 
-    context "when a key exists in database but not in yml files [for I18n.default_locale]" do
-      it "should remove that key from database for I18n.default_locale" do
-        Interpret::Translation.update
-        Interpret::Translation.locale('en').find_by_key("folder1.content").should be_nil
+    context "when Interpret.soft is false" do
+      before do
+        Interpret.soft = false
       end
 
-      it "should remove that key if it exists for any other language in database" do
-        Interpret::Translation.update
-        Interpret::Translation.locale('es').find_by_key("folder1.content").should be_nil
+      context "when a key exists in database but not in yml files [for I18n.default_locale]" do
+        it "should remove that key from database for I18n.default_locale" do
+          Interpret::Translation.update
+          Interpret::Translation.locale('en').find_by_key("folder1.content").should be_nil
+        end
+
+        it "should remove that key if it exists for any other language in database" do
+          Interpret::Translation.update
+          Interpret::Translation.locale('es').find_by_key("folder1.content").should be_nil
+        end
       end
     end
 
@@ -190,22 +197,26 @@ es:
   end
 
   describe ".dump" do
-    it "should dump all contents from yml files into database" do
-      # Initial database state
-      file2db(en_yml)
-      file2db(es_yml)
+    context "when Interpret.soft is false" do
+      it "should dump all contents from yml files into database" do
+        Interpret.soft = false
 
-      Dir.stub!(:"[]").and_return(['/path/to/en.yml', '/path/to/es.yml'])
-      YAML.should_receive(:load_file).twice.and_return(YAML.load(new_en_yml), YAML.load(new_es_yml))
-      Interpret::Translation.dump
+        # Initial database state
+        file2db(en_yml)
+        file2db(es_yml)
 
-      # We use export to check for the existing database contents, which is
-      # also tested in this spec file
-      en_trans = Interpret::Translation.locale('en').all
-      Interpret::Translation.export(en_trans).should == YAML.load(new_en_yml)
+        Dir.stub!(:"[]").and_return(['/path/to/en.yml', '/path/to/es.yml'])
+        YAML.should_receive(:load_file).twice.and_return(YAML.load(new_en_yml), YAML.load(new_es_yml))
+        Interpret::Translation.dump
 
-      es_trans = Interpret::Translation.locale('es').all
-      Interpret::Translation.export(es_trans).should == YAML.load(new_es_yml)
+        # We use export to check for the existing database contents, which is
+        # also tested in this spec file
+        en_trans = Interpret::Translation.locale('en').all
+        Interpret::Translation.export(en_trans).should == YAML.load(new_en_yml)
+
+        es_trans = Interpret::Translation.locale('es').all
+        Interpret::Translation.export(es_trans).should == YAML.load(new_es_yml)
+      end
     end
   end
 

data/spec/observers/expiration_observer_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Interpret::ExpirationObserver do
+
+  before do
+    Interpret::Translation.delete_all
+  end
+
+  it "should call run_expiration on observer" do
+    backend = mock("A backend")
+    backend.should_receive(:"reload!").once
+    Interpret.backend = backend
+    Interpret::Translation.create! :locale => "en", :key => "en.hello", :value => "Hello world"
+  end
+end
+

data/spec/spec_helper.rb

@@ -21,7 +21,6 @@ migrate_database
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each{|f| require f}
 
-
 RSpec.configure do |config|
   # Remove this line if you don't want RSpec's should and should_not
   # methods or matchers

data/test_app/Gemfile

@@ -1,10 +1,12 @@
 source 'http://rubygems.org'
 
-gem 'rails', '~> 3.0.3'
-gem 'interpret', :path => ".."
+gem 'rails', '~> 3.0.5'
 gem 'haml-rails'
 gem 'capistrano'
 
 group :development, :test do
   gem 'sqlite3-ruby', :require => 'sqlite3'
+  gem 'ruby-debug'
 end
+
+gem 'interpret', :path => ".."

data/test_app/app/controllers/application_controller.rb

@@ -2,9 +2,10 @@ class ApplicationController < ActionController::Base
   protect_from_forgery
   before_filter :set_current_user
   helper_method :current_user
+  before_filter :set_locale
 
   def current_user
-    session[:user_id] ? User.find(session[:user_id]) : User.first
+    session[:user_id] ? User.find(session[:user_id]) : User.where(:admin => true).first
   end
 
   def set_current_user
@@ -12,4 +13,19 @@ class ApplicationController < ActionController::Base
       session[:user_id] = params[:admin] == "true" ? User.where(:admin => true).first : User.where(:admin => false).first
     end
   end
+
+  def toggle_edition_mode
+    Interpret.live_edit = !Interpret.live_edit
+
+    redirect_to request.env["HTTP_REFERER"]
+  end
+
+  def set_locale
+    I18n.locale = params[:locale] || I18n.default_locale
+  end
+
+  def default_url_options(options = {})
+    options.merge({:locale => I18n.locale})
+  end
+
 end

data/test_app/app/controllers/pages_controller.rb

@@ -1,3 +1,2 @@
 class PagesController < ApplicationController
-  caches_page :index
 end

data/test_app/app/models/my_sweeper.rb

@@ -0,0 +1,5 @@
+class MySweeper < Interpret::ExpirationObserver
+  def expire_cache
+    puts "Custom app expiration logic"
+  end
+end

data/test_app/app/views/layouts/application.html.erb

@@ -1,15 +1,125 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Cuca</title>
-  <%= stylesheet_link_tag :all %>
+  <title>Interpret Demo</title>
+  <%= stylesheet_link_tag "default" %>
   <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js" %>
-  <%= javascript_include_tag :all %>
   <%= csrf_meta_tag %>
 </head>
 <body>
-  This is the APPLICATION main Layout
-  <%= yield %>
+  <div id="demo_sidebar">
+    <p>
+    This is a DEMO site to provide an example usage of <a href="https://github.com/rogercampos/interpret">Interpret</a>.
+    </p>
+
+    <p>
+      <ul>
+        <li>
+          <%= link_to "Login to interpret as ADMIN", interpret_root_path(:admin => "true") %>
+        </li>
+        <li>
+          <%= link_to "Login to interpret as USER", interpret_root_path(:admin => "false") %>
+        </li>
+      </ul>
+    </p>
+    <br/>
+
+    <p>
+    <% if current_user %>
+      You are currently logged in as <%= current_user.admin? ? "an ADMIN" : "an USER" %>
+    <% else %>
+      You are not logged in
+    <% end %>
+    </p>
+    <p>
+    <% if current_user && current_user.admin? %>
+      <%= button_to Interpret.live_edit ? "Disable edition mode" : "Enable edition mode", toggle_edition_mode_path %>
+    <% else %>
+      Log in as an ADMIN to use the live edition features!
+    <% end %>
+    </p>
+
+    <br/>
+    <p>You can reestore the original contents with the option "Dump", inside the backoffice > Tools section.</p>
+    <p>
+      Thanks to <a href="http://nodethirtythree.com">NodeThirtyThree</a> to provide this template in order to demostrate a real website.
+    </p>
+  </div>
+
+  <div id="outer">
+
+    <div id="upbg"></div>
+
+    <div id="inner">
+
+      <div id="header">
+        <h1><%= t "main_header_html" %></h1>
+        <h2><%= t "main_h2" %></h2>
+      </div>
+
+      <div id="splash"></div>
+
+      <div id="menu">
+        <ul>
+          <li class="first"><a href="/">Home</a></li>
+          <li><%= link_to "Archives", archives_path %></li>
+          <li><%= link_to "Links", links_path %></li>
+          <li><%= link_to "Resources", resources_path %></li>
+          <li><%= link_to "Contact", contact_path %></li>
+        </ul>
+
+        <div id="lang_menu">
+          Language:
+          <%= link_to "English", :locale => :en %>
+          |
+          <%= link_to "Spanish", :locale => :es %>
+        </div>
+      </div>
+
+
+      <div id="primarycontent">
+        <%= yield %>
+      </div>
+
+      <div id="secondarycontent">
+
+        <!-- secondary content start -->
+
+        <h3><%= t "about_me" %></h3>
+        <div class="content">
+          <img src="/images/pic2.jpg" class="picB" alt="" />
+          <p><%= t "about_me_text_html" %></p>
+        </div>
+
+        <h3><%= t "topics" %></h3>
+        <div class="content">
+          <ul class="linklist">
+            <li class="first"><%= t "t1_html", :scope => "topics_list" %></li>
+            <li><%= t "t2_html", :scope => "topics_list" %></li>
+            <li><%= t "t3_html", :scope => "topics_list" %></li>
+            <li><%= t "t4_html", :scope => "topics_list" %></li>
+            <li><%= t "t5_html", :scope => "topics_list" %></li>
+            <li><%= t "t6_html", :scope => "topics_list" %></li>
+            <li><%= t "t7_html", :scope => "topics_list" %></li>
+            <li><%= t "t8_html", :scope => "topics_list" %></li>
+          </ul>
+        </div>
+
+        <!-- secondary content end -->
+
+      </div>
+
+      <div id="footer">
+
+        &copy; My Website. All rights reserved. Design by <a href="http://www.nodethirtythree.com/">NodeThirtyThree</a>.
+
+      </div>
+
+    </div>
+
+  </div>
+
+  <%= interpret_live_edition %>
 </body>
 </html>