interpret 0.1.1

data/interpret.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "interpret/version"
+
+Gem::Specification.new do |s|
+  s.name        = "interpret"
+  s.version     = Interpret::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Roger Campos"]
+  s.email       = ["roger@itnig.net"]
+  s.homepage    = "https://github.com/rogercampos/interpret"
+  s.summary     = %q{Manage your app translations with an i18n active_record backend}
+  s.description = %q{Manage your app translations with an i18n active_record backend}
+
+  s.rubyforge_project = "interpret"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.0.3"
+  s.add_dependency "i18n", "~> 0.5.0"
+  s.add_dependency "i18n-active_record"
+  s.add_dependency "ya2yaml", ">= 0.30.0"
+  s.add_dependency "will_paginate", ">= 3.0.pre2"
+  s.add_dependency "best_in_place", ">= 0.1.7"
+
+  s.add_development_dependency "rspec-rails", ">= 2.5"
+end

data/lib/generators/interpret/migration_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module Interpret
+
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Creates the migration for i18n activerecord backend translations table"
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def copy_translations_migration
+      migration_template "migration.rb", "db/migrate/interpret_create_translations.rb"
+    end
+
+  end
+end
+

data/lib/generators/interpret/setup_generator.rb

@@ -0,0 +1,21 @@
+module Interpret
+
+  class SetupGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../../public", __FILE__)
+    desc "Copies needed css and js files into your app's public folders"
+
+    def copy_css
+      copy_file "stylesheets/interpret_style.css", "public/stylesheets/interpret_style.css"
+    end
+
+    def copy_js
+      copy_file "javascripts/jquery.purr.js", "public/javascripts/jquery.purr.js"
+    end
+
+    def copy_images
+      copy_file "stylesheets/plus_icon.gif", "public/stylesheets/plus_icon.gif"
+      copy_file "stylesheets/minus_icon.gif", "public/stylesheets/minus_icon.gif"
+
+    end
+  end
+end

data/lib/generators/interpret/templates/migration.rb

@@ -0,0 +1,16 @@
+class InterpretCreateTranslations < ActiveRecord::Migration
+  def self.up
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text   :value
+      t.text   :interpolations
+      t.boolean :is_proc, :default => false
+    end
+  end
+
+  def self.down
+    drop_table :translations
+  end
+end
+

data/lib/generators/interpret/views_generator.rb

@@ -0,0 +1,16 @@
+module Interpret
+
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../../app/views", __FILE__)
+    desc "Copies all Interpret views to your application."
+
+    argument :scope, :required => false, :default => nil,
+                      :desc => "The scope to copy views to"
+
+    def copy_views
+      scope ||=  Interpret.controller.split("/").first
+      directory "interpret", "app/views/#{scope}"
+    end
+
+  end
+end

data/lib/interpret/capistrano.rb

@@ -0,0 +1,15 @@
+namespace :interpret do
+  desc "Update translations keys in database"
+  task :update, :roles => :app, :except => { :no_release => true } do
+    commands = [
+      "RAILS_ENV=#{rails_env} rake interpret:update",
+    ]
+
+    run <<-CMD
+      cd #{release_path} &&
+      #{commands.join(" && ")}
+    CMD
+  end
+end
+
+after "deploy:update_code", "interpret:update"

data/lib/interpret/engine.rb

@@ -0,0 +1,23 @@
+require 'i18n/backend/active_record'
+require 'interpret/logger'
+require 'interpret/helpers'
+
+module Interpret
+  class Engine < Rails::Engine
+    if Interpret.registered_envs.include?(Rails.env.to_sym)
+      initializer "interpret.register_i18n_active_record_backend" do |app|
+        I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+        I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Flatten)
+
+        Interpret.backend = I18n::Backend::ActiveRecord.new
+        app.config.i18n.backend = Interpret.backend
+      end
+    end
+
+    initializer "interpret.setup_translations_logger" do |app|
+      logfile = File.open("#{Rails.root}/log/interpret.log", 'a')
+      logfile.sync = true
+      Interpret.logger = InterpretLogger.new(logfile)
+    end
+  end
+end

data/lib/interpret/helpers.rb

@@ -0,0 +1,45 @@
+module Interpret
+  module InterpretHelpers
+
+    # Generates the html tree from the given keys
+    def show_interpret_tree(tree, origin_keys)
+      tree = tree.first[1]
+      unless origin_keys.nil?
+        origin_keys.split(".").each do |key|
+          tree = tree[key]
+        end
+      end
+      build_tree(tree, origin_keys)
+    end
+
+    def build_tree(hash, origin_keys = "", prev_key = "")
+      out = "<ul id='navigation'>"
+      if origin_keys.present? && prev_key.blank?
+        parent_key = origin_keys.split(".")[0..-2].join(".")
+        if parent_key.blank?
+          out << "<li>#{link_to "..", interpret_root_path}</li>"
+        else
+          out << "<li>#{link_to "..", interpret_root_path(:key => parent_key)}</li>"
+        end
+      end
+      hash.keys.each do |key|
+        out << "<li>"
+        out << "#{link_to key, interpret_root_path(:key => "#{origin_keys.blank? ? "" : "#{origin_keys}."}#{prev_key}#{key}")}"
+        out << "</li>"
+      end
+      out << "</ul>"
+      out.html_safe
+    end
+
+    def current_controller?(opts)
+      hash = Rails.application.routes.recognize_path(url_for(opts))
+      params[:controller] == hash[:controller]
+    end
+
+    def interpret_section_link_to(name, options = {}, html_options = {})
+      html_options.merge!({ :class => 'current' }) if current_controller?(options)
+      link_to name, options, html_options
+    end
+
+  end
+end

data/lib/interpret/lazy_hash.rb

@@ -0,0 +1,21 @@
+# Gist from: https://gist.github.com/745617
+module LazyHash
+  class << self
+    def lazy_add(hash, key, value, pre = nil)
+      skeys = key.split(".")
+      f = skeys.shift
+      if skeys.empty?
+        pre.nil? ? hash.send("[]=", f, value) : pre.send("[]=", f, value)
+      else
+        pre = pre.nil? ? hash.send("[]", f) : pre.send("[]", f)
+        lazy_add(hash, skeys.join("."), value, pre)
+      end
+    end
+
+    def build_hash
+      lazy = lambda { |h,k| h[k] = Hash.new(&lazy) }
+      Hash.new(&lazy)
+    end
+  end
+end
+

data/lib/interpret/logger.rb

@@ -0,0 +1,7 @@
+module Interpret
+  class InterpretLogger < Logger
+    def format_message(severity, timestamp, progname, msg)
+      "#{timestamp.to_formatted_s(:db)} #{msg}\n"
+    end
+  end
+end

data/lib/interpret/version.rb

@@ -0,0 +1,3 @@
+module Interpret
+  VERSION = "0.1.1"
+end

data/lib/interpret.rb

@@ -0,0 +1,30 @@
+require 'best_in_place'
+require 'will_paginate'
+require 'interpret/lazy_hash'
+
+module Interpret
+  mattr_accessor :backend
+  mattr_accessor :logger
+
+  mattr_accessor :controller
+  @@controller = "action_controller/base"
+
+  mattr_accessor :sweeper
+  @@sweeper = nil
+
+  mattr_accessor :registered_envs
+  @@registered_envs = [:production, :staging]
+
+  mattr_accessor :scope
+  @@scope = ""
+
+  # More options:
+  # - memoize?
+  # - flatten?
+  # - logging?
+  # - current_user method. If set, current_user will appear in logs, otherwise not.
+end
+
+require 'interpret/engine' if defined? Rails
+
+ActionView::Base.send(:include, Interpret::InterpretHelpers)

data/lib/tasks/interpret.rake

@@ -0,0 +1,11 @@
+namespace :interpret do
+  desc 'Copy all the translations from config/locales/*.yml into DB backend'
+  task :migrate => [:environment, "tmp:cache:clear"] do
+    Interpret::Translation.dump
+  end
+
+  desc 'Synchronize the keys used in db backend with the ones on *.yml files'
+  task :update => [:environment, "tmp:cache:clear"] do
+    Interpret::Translation.update
+  end
+end

data/public/javascripts/jquery.purr.js

@@ -0,0 +1,180 @@
+/**
+ * jquery.purr.js
+ * Copyright (c) 2008 Net Perspective (net-perspective.com)
+ * Licensed under the MIT License (http://www.opensource.org/licenses/mit-license.php)
+ * 
+ * @author R.A. Ray
+ * @projectDescription	jQuery plugin for dynamically displaying unobtrusive messages in the browser. Mimics the behavior of the MacOS program "Growl."
+ * @version 0.1.0
+ * 
+ * @requires jquery.js (tested with 1.2.6)
+ * 
+ * @param fadeInSpeed 					int - Duration of fade in animation in miliseconds
+ * 													default: 500
+ *	@param fadeOutSpeed  				int - Duration of fade out animationin miliseconds
+ 														default: 500
+ *	@param removeTimer  				int - Timeout, in miliseconds, before notice is removed once it is the top non-sticky notice in the list
+ 														default: 4000
+ *	@param isSticky 						bool - Whether the notice should fade out on its own or wait to be manually closed
+ 														default: false
+ *	@param usingTransparentPNG 	bool - Whether or not the notice is using transparent .png images in its styling
+ 														default: false
+ */
+
+( function( $ ) {
+	
+	$.purr = function ( notice, options )
+	{ 
+		// Convert notice to a jQuery object
+		notice = $( notice );
+		
+		// Add a class to denote the notice as not sticky
+		if ( !options.isSticky )
+		{
+			notice.addClass( 'not-sticky' );
+		};
+		
+		// Get the container element from the page
+		var cont = document.getElementById( 'purr-container' );
+		
+		// If the container doesn't yet exist, we need to create it
+		if ( !cont )
+		{
+			cont = '<div id="purr-container"></div>';
+		}
+		
+		// Convert cont to a jQuery object
+		cont = $( cont );
+		
+		// Add the container to the page
+		$( 'body' ).append( cont );
+			
+		notify();
+
+		function notify ()
+		{	
+			// Set up the close button
+			var close = document.createElement( 'a' );
+			$( close ).attr(	
+				{
+					className: 'close',
+					href: '#close',
+					innerHTML: 'Close'
+				}
+			)
+				.appendTo( notice )
+					.click( function ()
+						{
+							removeNotice();
+							
+							return false;
+						}
+					);
+			
+			// Add the notice to the page and keep it hidden initially
+			notice.appendTo( cont )
+				.hide();
+				
+			if ( jQuery.browser.msie && options.usingTransparentPNG )
+			{
+				// IE7 and earlier can't handle the combination of opacity and transparent pngs, so if we're using transparent pngs in our
+				// notice style, we'll just skip the fading in.
+				notice.show();
+			}
+			else
+			{
+				//Fade in the notice we just added
+				notice.fadeIn( options.fadeInSpeed );
+			}
+			
+			// Set up the removal interval for the added notice if that notice is not a sticky
+			if ( !options.isSticky )
+			{
+				var topSpotInt = setInterval( function ()
+				{
+					// Check to see if our notice is the first non-sticky notice in the list
+					if ( notice.prevAll( '.not-sticky' ).length == 0 )
+					{ 
+						// Stop checking once the condition is met
+						clearInterval( topSpotInt );
+						
+						// Call the close action after the timeout set in options
+						setTimeout( function ()
+							{
+								removeNotice();
+							}, options.removeTimer
+						);
+					}
+				}, 200 );	
+			}
+		}
+
+		function removeNotice ()
+		{
+			// IE7 and earlier can't handle the combination of opacity and transparent pngs, so if we're using transparent pngs in our
+			// notice style, we'll just skip the fading out.
+			if ( jQuery.browser.msie && options.usingTransparentPNG )
+			{
+				notice.css( { opacity: 0	} )
+					.animate( 
+						{ 
+							height: '0px' 
+						}, 
+						{ 
+							duration: options.fadeOutSpeed, 
+							complete:  function ()
+								{
+									notice.remove();
+								} 
+							} 
+					);
+			}
+			else
+			{
+				// Fade the object out before reducing its height to produce the sliding effect
+				notice.animate( 
+					{ 
+						opacity: '0'
+					}, 
+					{ 
+						duration: options.fadeOutSpeed, 
+						complete: function () 
+							{
+								notice.animate(
+									{
+										height: '0px'
+									},
+									{
+										duration: options.fadeOutSpeed,
+										complete: function ()
+											{
+												notice.remove();
+											}
+									}
+								);
+							}
+					} 
+				);
+			}
+		};
+	};
+	
+	$.fn.purr = function ( options )
+	{
+		options = options || {};
+		options.fadeInSpeed = options.fadeInSpeed || 500;
+		options.fadeOutSpeed = options.fadeOutSpeed || 500;
+		options.removeTimer = options.removeTimer || 4000;
+		options.isSticky = options.isSticky || false;
+		options.usingTransparentPNG = options.usingTransparentPNG || false;
+		
+		this.each( function() 
+			{
+				new $.purr( this, options );
+			}
+		);
+		
+		return this;
+	};
+})( jQuery );
+