afalkear_translation_center 0.0.0

data/lib/translation_center/engine.rb

@@ -0,0 +1,15 @@
+require 'jquery-rails'
+require 'jquery-ui-rails'
+require 'haml'
+require 'haml-rails'
+require 'acts_as_votable'
+require 'ya2yaml'
+require 'font-awesome-rails'
+require 'audited-activerecord'
+
+module TranslationCenter
+
+  class Engine < ::Rails::Engine
+    isolate_namespace TranslationCenter
+  end
+end

data/lib/translation_center/locale/en.yml

@@ -0,0 +1,75 @@
+en:
+    translation_center:
+        pagination:
+            next: Next
+            first: First
+            prev: Prev.
+            last: Last
+        actions:
+            are_you_sure: "Are you sure ?"
+        back_to_app: "Back To App"
+        categories: 
+            category: 
+                complete: Complete
+                keys: Keys
+            index: 
+                categories: Categories
+            show: 
+                all: All
+                pending: Pending
+                translated: Translated
+                untranslated: Untranslated
+        center: 
+            activity: 
+                ago: ago
+                changes: Changes
+                key: Key
+                locale: Locale
+                time: Time
+                user: User
+            dashboard: 
+                activity: Activity
+                all: All
+                controls: Controls
+                dashboard: Dashboard
+                language: Language
+                pending: Pending
+                progress: Progress
+                reset: Reset
+                search: Search
+                select_locale: "Select Locale"
+                these_actions_will_affect_existing_data: "These actions will affect existing data"
+                translated: Translated
+                untranslated: Untranslated
+            search:
+                title: "Keys with translations that contain '%{value}'"
+        dashboard: Dashboard
+        search_keys: "Keys"
+        search_translations: "Translations"
+        translate_to: "Translate To"
+        translation_center: "Translation Center"
+        translation_keys: 
+            destroyed_successfully: "Destroyed Successfully"
+            show: 
+                translations: Translations
+                add_edit_translation: "Add/Edit Translation"
+                back_to_category: "Back to"
+                destroy: Destroy
+            show_keys: 
+                created_on: "created on"
+                translated: Translated
+            translation_keys: 
+                no_translation_keys: "No Translation Keys"
+        translations: 
+            accept_translation: 
+                unaccept: Unaccept
+            index: 
+                date: Date
+                sort_by: "Sort by"
+                votings: Votes
+            show: 
+                by: by
+                on_date: "on"
+                vote: Vote
+                votings: Votes
+                you: You

data/lib/translation_center/translation_helpers.rb

@@ -0,0 +1,133 @@
+module TranslationCenter
+
+  # Return the default translator by building and returning the translator object
+  def self.prepare_translator
+
+    translator = TranslationCenter::CONFIG['translator_type'].camelize.constantize.where(TranslationCenter::CONFIG['identifier_type'] => TranslationCenter::CONFIG['yaml_translator_identifier']).first
+    
+    # if translator doesn't exist then create him
+    if translator.blank?
+      translator = TranslationCenter::CONFIG['translator_type'].camelize.constantize.new
+      translator.send "#{TranslationCenter::CONFIG['identifier_type']}=", TranslationCenter::CONFIG['yaml_translator_identifier']
+      begin
+        translator.save(validate: false)
+        # needed if the user is using confirmable with devise
+        translator.update_attribute(:confirmed_at, Time.now) if translator.attributes.has_key?('confirmed_at')
+      rescue
+        translator = nil
+      end
+    end
+    translator
+  end
+
+  def self.included(base)
+    base.class_eval do
+      alias_method_chain :translate, :adding if(TranslationCenter::CONFIG['enabled'])
+    end
+  end
+
+  # wraps a span if inspector option is set to all
+  def wrap_span(translation, translation_key)
+    # put the inspector class if inspector is all and the key doesn't belongs to translation_center
+    if TranslationCenter::CONFIG['inspector'] == 'all' && translation_key.name.to_s.split('.').first != 'translation_center'
+      "<span class='tc-inspector-key' data-locale='#{I18n.locale}' data-type='#{translation_key.status(I18n.locale)}' data-id='#{translation_key.id}'> #{translation} </span>".html_safe
+    else
+      translation
+    end
+  end
+
+  # make sure the complete key is build using the options such as scope and count
+  def prepare_key(key, options)
+    complete_key  = key
+
+    # if a scope is passed in options then build the full key
+    complete_key = options[:scope].present? ? "#{options[:scope].to_s}.#{complete_key}" : complete_key
+
+    # add the correct count suffix
+    if options[:count].present? && options[:count] == 1
+      complete_key = "#{complete_key}.one"
+    elsif options[:count].present? && options[:count] != 1
+      complete_key = "#{complete_key}.other"
+    end
+    complete_key
+  end
+
+  def translate_with_adding(locale, key, options = {})
+    # handle calling translation with a blank key
+    # or translation center tables don't exist
+    return translate_without_adding(locale, key, options) if key.blank? || !ActiveRecord::Base.connection.table_exists?('translation_center_translation_keys')
+
+    complete_key = prepare_key(key, options) # prepare complete key
+
+    # add the new key or update it
+    translation_key = TranslationCenter::TranslationKey.find_or_create_by_name(complete_key)
+    #  UNCOMMENT THIS LATER TO SET LAST ACCESSED AT
+    # translation_key.update_attribute(:last_accessed, Time.now)
+
+    # save the default value (Which is the titleized key name as the translation) if the option is enabled and no translation exists for that key in the db
+    translation_key.create_default_translation if TranslationCenter::CONFIG['save_default_translation'] && translation_key.translations.in(:en).empty? && !translation_key.has_children?
+
+    # if i18n_source is set to db and not overriden by options then fetch from db
+    if TranslationCenter::CONFIG['i18n_source']  == 'db' && options.delete(:yaml).blank?
+      val = translation_key.accepted_translation_in(locale).try(:value) || options[:default]
+      # replace variables in a translation with passed values
+      options.each_pair{ |key, value| val.gsub!("%{#{key.to_s}}", value.to_s) } if val.is_a?(String)
+
+      if val.blank? && !translation_key.has_children?
+        throw(:exception, I18n::MissingTranslation.new(locale, complete_key, options))
+      elsif translation_key.has_children?
+        # TODO should use ancestors for keys
+        return translation_key.children_translations(locale)
+      end
+      wrap_span(val, translation_key)
+    else
+      translation_value = translate_without_adding(locale, key, options)
+      translation_value.class == Hash ? translation_value : wrap_span(translation_value, translation_key)
+    end
+  end
+
+
+  # load tha translation config
+  if FileTest.exists?("config/translation_center.yml")
+    TranslationCenter::CONFIG = YAML.load_file("config/translation_center.yml")[Rails.env]
+    # identifier is by default email
+    TranslationCenter::CONFIG['identifier_type'] ||= 'email'
+    TranslationCenter::CONFIG['translator_type'] ||= 'User'
+  else
+    puts "WARNING: translation_center will be using default options if config/translation_center.yml doesn't exists"
+    TranslationCenter::CONFIG = {'enabled' => false, 'inspector' => 'missing', 'lang' => {'en' => {'name' => 'English', 'direction' => 'ltr'}}, 'yaml_translator_identifier' => 'coder@tc.com', 'i18n_source' => 'yaml', 'yaml2db_translations_accepted' => true,
+                                'accept_admin_translations' => true,  'save_default_translation' => true, 'identifier_type' => 'email', 'translator_type' => 'User' }
+  end
+  I18n.available_locales = TranslationCenter::CONFIG['lang'].keys
+
+end
+
+# override html_message to add a class to the returned span
+module I18n
+  class MissingTranslation
+    module Base
+      # added another class to be used
+      def html_message
+        category = keys.first
+        key = keys.last.to_s.gsub('_', ' ').gsub(/\b('?[a-z])/) { $1.capitalize }
+        translation_key = keys
+        # remove locale
+        translation_key.shift
+
+        translation_key = TranslationCenter::TranslationKey.find_by_name(translation_key.join('.'))
+        # don't put the inspector class if inspector is off or the key belongs to translation_center
+        if TranslationCenter::CONFIG['inspector'] == 'off' || category == 'translation_center'
+          %(<span class="translation_missing" title="translation missing: #{keys.join('.')}">#{key}</span>)
+        else
+          %(<span class="translation_missing tc-inspector-key" data-locale='#{I18n.locale}' data-type="#{translation_key.status(I18n.locale)}" data-id="#{translation_key.id}" title="translation missing: #{keys.join('.')}">#{key}</span>)
+        end
+      end
+
+    end
+  end
+end
+
+I18n::Backend::Base.send :include, TranslationCenter
+
+
+

data/lib/translation_center/translations_transfer.rb

@@ -0,0 +1,131 @@
+module TranslationCenter
+
+  # needed for interpolated translations in I18n
+  def self.get_translation_from_hash(key, hash)
+    path = key.split('.')
+    last_step = hash
+    path.each do |step|
+      break if last_step.blank? || !last_step.is_a?(Hash)
+      last_step = last_step[step.to_s.to_sym]
+    end
+    last_step
+  end
+
+  def self.collect_keys(scope, translations)
+    full_keys = []
+    translations.to_a.each do |key, translations|
+      new_scope = scope.dup << key
+      if translations.is_a?(Hash)
+        full_keys += collect_keys(new_scope, translations)
+      else
+        full_keys << new_scope.join('.')
+      end
+    end
+    return full_keys
+  end
+
+  # gets the translation of a a key in certian lang and inserts it in the db
+  # returns true if the translation was fonud in yaml 
+  def self.yaml2db_key(locale, translation_key, translator, all_yamls)
+    I18n.locale = locale
+    translation = TranslationCenter::Translation.find_or_initialize_by_translation_key_id_and_lang_and_translator_id(translation_key.id, locale.to_s, translator.id)
+    translation.translator_type = TranslationCenter::CONFIG['translator_type']
+    
+    # get the translation for this key from the yamls
+    value = get_translation_from_hash(translation_key.name, all_yamls[locale])
+
+    # if the value is not empty and is different from the existing value the update
+    if !value.blank? && value != translation.value
+      translation.update_attribute(:value, value)
+      # accept this yaml translation
+      translation.accept if TranslationCenter::CONFIG['yaml2db_translations_accepted']
+      true
+    end
+  end
+
+  # takes array of keys and creates/updates the keys in the db with translations in the given locales
+  def self.yaml2db_keys(keys, translator, locales, all_yamls)
+    # initialize stats variables
+    new_keys = 0
+    missing_keys = locales.inject({}) do |memo, lang|
+      memo[lang] = 0
+      memo
+    end
+
+    # for each key create it in the db if it doesn't exist, and add its translation to
+    # the db in every locale
+    keys.each do |key|
+
+      translation_key = TranslationCenter::TranslationKey.find_or_initialize_by_name(key)
+      if translation_key.new_record?
+        translation_key.save
+        new_keys += 1
+      end
+
+      # for each locale create/update its translation
+      locales.each do |locale|
+        missing_keys[locale] += 1 unless self.yaml2db_key(locale, translation_key, translator, all_yamls)
+      end
+
+    end
+
+    puts "found new #{new_keys} key(s)"
+    missing_keys.each do |locale, count|
+      puts "missing #{count} translation(s) for #{locale}" if count > 0
+    end
+  end
+
+  # take the yaml translations and update the db with them
+  def self.yaml2db(locale=nil)
+
+    # prepare translator by creating the translator if he doesn't exist
+    translator = TranslationCenter.prepare_translator
+
+    # if couldn't create translator then print error msg and quit
+    if translator.blank?
+      puts "ERROR: Unable to create default translator with #{TranslationCenter::CONFIG['identifier_type']} = #{TranslationCenter::CONFIG['yaml_translator_identifier']}"
+      puts "Create this user manually and run the rake again"
+      return false
+    end
+
+    # Make sure we've loaded the translations
+    I18n.backend.send(:init_translations)
+    puts "#{I18n.available_locales.size} #{I18n.available_locales.size == 1 ? 'locale' : 'locales'} available: #{I18n.available_locales.join(', ')}"
+
+    # Get all keys from all locales
+    all_yamls = I18n.backend.send(:translations)
+    all_keys = all_yamls.collect do |check_locale, translations|
+      collect_keys([], translations).sort
+    end.flatten.uniq
+
+    puts "#{all_keys.size} #{all_keys.size == 1 ? 'unique key' : 'unique keys'} found."
+
+    locales = locale.blank? ? I18n.available_locales : [locale.to_sym]
+
+    # create records for all keys that exist in the yaml
+    yaml2db_keys(all_keys, translator, locales, all_yamls)
+  end
+
+  def self.db2yaml(locale=nil)
+    locales = locale.blank? ? I18n.available_locales : [locale.to_sym]
+
+    # for each locale build a hash for the translations and write to file
+    locales.each do |locale|
+      result = {}
+      I18n.locale = locale
+      puts "Started exporting translations in #{locale}"
+      TranslationCenter::TranslationKey.translated(locale).each do |key|
+        begin
+          key.add_to_hash(result, locale)  
+        rescue
+          puts "Error writing key: #{key.name} to yaml for #{locale}"
+        end
+      end
+      File.open("config/locales/#{locale.to_s}.yml", 'w') do |file|
+        file.write({locale.to_s => result}.ya2yaml)
+      end
+      puts "Done exporting translations of #{locale} to #{locale.to_s}.yml"
+    end 
+  end
+
+end

data/lib/translation_center/version.rb

@@ -0,0 +1,3 @@
+module TranslationCenter
+  VERSION = "0.0.0"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .
+//= require translation_center/inspector

data/test/dummy/app/assets/javascripts/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ *= require translation_center/inspector
+ */

data/test/dummy/app/assets/stylesheets/articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/