afalkear_translation_center 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7e797778fb7cc8e6df68b6e83084caafd16fc8d
+  data.tar.gz: 3e895fcbb80ad876ae8a129b101fcbfbc9640c7e
+SHA512:
+  metadata.gz: 5a3be959ca721e763e9612c4be463a66c825d06cb0d1e80f11d8ea95b74baefd78c29c06b6b4559a66f9f6decc9ac3e079d2d2f9d0007b385f4874896a2a58f9
+  data.tar.gz: 1ddb30065206e20c6b9fc71629771f2e077d76c852c1c53422ec5e37b776509cb1640afd0fb23657e0e6c8189d7726060115708610e7f291d2793968c9f8a37d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,293 @@
+## Translation Center Status
+[![Code Climate](https://codeclimate.com/github/BadrIT/translation_center.png)](https://codeclimate.com/github/BadrIT/translation_center)
+[![Gem Version](https://badge.fury.io/rb/translation_center.png)](http://badge.fury.io/rb/translation_center)
+[![Dependency Status](https://gemnasium.com/BadrIT/translation_center.png)](https://gemnasium.com/BadrIT/translation_center)
+
+## Introduction
+
+Translation Center is a multi lingual web engine for Rails 3 apps. It builds a translation center community with translators and admins from your system users.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/view_keys.png "View category translations")
+
+## Translation Center can be used by:
+
+###App Users
+Contribute in translating your app in different locales using easy web interface.
+
+###Rails Developers
+Avoid updating many yaml files as you will just use the easy web interface to manage translations.
+
+###Site Admin
+Manage all app translations; collect stats, accept, add, edit, remove translations...etc
+
+
+## Features
+
+  * Different roles: translators and admins
+  * Add new locales easily
+  * Support right-to-left and left-to-right translations
+  * Detect new translation keys in code and store them in DB for users to translate
+  * Inspect translation keys from your application view directly
+  * Import and Export translations in yaml format
+  * Switch translations backend between DB and yaml
+  * Admin dashboard for languages status and activity
+  * Users can vote up translations
+  * Default translation in English for keys
+
+## Getting started
+
+TranslationCenter works with Rails 3.1 onwards. You can add it to your Gemfile with:
+
+```ruby
+gem 'translation_center'
+```
+
+Run bundle install command.
+
+TranslationCenter depends on Devise, so make sure you installed it successfully https://github.com/plataformatec/devise#starting-with-rails
+
+After you install TranslationCenter and add it to your Gemfile, you need to run the generator:
+
+```ruby
+rails generate translation_center:install en ar de
+```
+
+This will add three languages to the translation center, you need to add them in the config/translation_center.yaml
+
+```ruby
+development:
+  lang:
+    en: 
+      name: 'English'
+      direction: 'ltr'
+    ar:
+      name: 'Arabic'
+      direction: 'rtl'
+    de:
+      name: 'German'
+      direction: 'ltr'
+```
+
+if you don't supply languages for the generator it will support only English.
+
+And run the migrations
+
+```ruby
+rake db:migrate
+```
+
+Add this line to the translator model (typically `User`)
+
+```ruby
+acts_as_translator
+```
+
+And then run this rake to get all current translations to the db
+```ruby
+rake translation_center:synch
+```
+
+and change the `translator_type` in `translation_center.yml` to the translator model name (if it is `User` keep it commented)
+
+```ruby
+# tranlator_type: 'User'
+```
+
+In routes file add 
+
+```ruby
+mount TranslationCenter::Engine => "/translation_center"
+```
+
+By default, all users are admins, you need to define who is the translation center admin. Admin can accept translations, manage translation keys and do more things. To define your admin, you need to override User#can_admin_translations? method like the following....
+
+```ruby
+def can_admin_translations?
+  self.email == 'admin@tc.com'
+end
+```
+
+## How to use
+
+Add new key to your views, for example:
+
+```ruby
+t('posts.index.title')
+```
+
+When you visit the page where this key is rendered, a new translation key will be stored with name 'index.title' under category 'posts'.
+You then visit the TranslationCenter and translate the key (by default translations added by admins are considered accepted).
+
+To migrate translations from TranslationCenter database to yaml files
+
+```ruby
+rake translation_center:db2yaml
+```
+
+To migrate translations from yaml files to TranslationCenter database 
+
+```ruby
+rake translation_center:yaml2db
+```
+
+If you want to export or import just one locale, provide the locale as an attribute to the rakes, for example:
+
+```ruby
+rake translation_center:yaml2db[ar]
+```
+
+Or you could use the Controls section in the Dashboard page to run these rakes
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/controls_shot.png "View category translations")
+
+Imported translations should have a translator. You can edit translator identifier (usually email address) in `translation_center.yml` The rake task `yaml2db` will create this user if it doesn't exist.
+
+```ruby
+yaml_translator_identifier: 'coder@tc.com'
+```
+
+The imported translations status will be accepted by default. If you want to disable this, comment the following line in `translation_center.yaml`
+
+```ruby
+yaml2db_translations_accepted: true
+```
+
+You can control the translations source by changing the value of `i18n_source` in `translation_center.yaml`
+
+```ruby
+i18n_source: 'yaml' # can be db or yaml; default is yaml
+```
+
+##Without Devise
+
+If your application doesn't use devise for authentication then you have to
+provide helper named `current_user` that returns the current user in the session and a before_filter named `authenticate_user!` that redirects a user
+to login page if not already signed in.
+
+You also need to add these methods in an initialize, for example `translation_authentication.rb` :
+```ruby
+module TranslationCenter
+  class ApplicationController < ActionController::Base
+
+    # current_user is needed in views
+    helper_method :current_user
+
+    def authenticate_user!
+      # redirect to login if user not signed in
+    end
+
+    def current_user
+      # write code that returns the current user in session
+    end
+
+  end
+end  
+```
+
+**Email attribute:** 
+
+Translation Center assumes that the translator model (for example `User`) has an `email` attribute, this attribute is used when showing translations, activity log in dashboard and updating existing translations.
+
+If your `User` model has no `email` attribute then change the `identifier_type` in your `translation_center.yml` to a unique attribute of your translator model (`User`), for example to use username instead of email:
+
+```ruby
+  identifier_type: 'username' # Uncomment and change the identifier if your User model has no email attribute
+```
+
+
+
+##Inspector
+
+Another nice option is the inspector that allows the users to go directly to the key from your application view.
+Just set `inspector` option in `translation_center.yml` to `all` if you want to inspect all keys otherwise set it to `missing` to inspect only untranslated keys, and then add this line to your `application.css`
+
+```ruby
+*= require translation_center/inspector
+```
+
+and this line to your `application.js`
+
+```ruby
+//= require translation_center/inspector
+```
+
+Now when you reload your page you will see a small icon beside your keys.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/inspector_shot.png "Inspected keys")
+
+In the previous image, if you click on the icon of 'Betrachten', you will be directed to the key page, where you can add/edit translations directly.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/inspector_visit_key.png "Visit a key from inspector")
+
+
+##Add new language
+
+If you want to add a language to the translation center, you need to run the generator:
+
+```ruby
+rails g translation_center:add_lang es fr
+rake db:migrate
+```
+
+You will also need to add the language to config/translation_center.yml
+
+```ruby
+development:
+  lang:
+    en:
+      name: 'English'
+      direction: 'ltr'
+    ar:
+      name: 'Arabic'
+      direction: 'rtl'
+    de:
+      name: 'German'
+      direction: 'ltr'
+```
+
+##Screen Shots
+
+When you visit `/translation_center` you will see the list of all categories and how many keys they have.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/categories_screen.png "Listing Categories")
+
+Click on category to view all the keys, keys are divided into untranslated (has no translations), pending (has translations but not approved yet), translated (has accepted translations)
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/view_keys.png "View a category")
+
+
+Click on a key to view all translations for that key, then you can add or edit your translation for that key, users can also vote for translations.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/many_translations.png "View a translation key")
+
+As an admin you can accept pending translations that have been added by other users, you can also edit and remove keys.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/accept_pending.png "Accept pending")
+
+Admin also can view the dashboard to know the status of every language
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/dashboard.png "Dashboard")
+
+or monitor activity of changes to translations.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/activity.png "Activity")
+
+##Video
+
+Watch it on YouTube.
+http://www.youtube.com/watch?v=BTy6ZI31JmU
+
+
+
+## Credits
+
+![BadrIT](http://www.badrit.com/images/logo-main.png)
+
+Translation Center is maintained and developed by [BadrIT](http://badrit.com/)
+
+## Support
+
+Help us make this engine better by submitting any bugs or enhancments in the issues page for this project.
+We also added an error page that will appear to you if any error goes with translation_center.
+
+![Alt text](https://raw.github.com/BadrIT/translation_center/master/samples/support.png "Support")

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TranslationCenter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/translation_center/application.js

@@ -0,0 +1,75 @@
+// 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 .
+
+
+function Category() {
+}
+
+Category.key = function() {
+  return $('#category_key').val();
+}
+
+function Filter() {
+}
+
+Filter.key = function() {
+  return $('#current_filter').val();
+}
+
+function capitaliseFirstLetter(string)
+{
+  return string.charAt(0).toUpperCase() + string.slice(1);
+}
+
+var spinner_params = {
+  lines: 13, // The number of lines to draw
+  length: 0, // The length of each line
+  width: 4, // The line thickness
+  radius: 14, // The radius of the inner circle
+  corners: 1, // Corner roundness (0..1)
+  rotate: 33, // The rotation offset
+  direction: 1, // 1: clockwise, -1: counterclockwise
+  color: '#000', // #rgb or #rrggbb
+  speed: 1.1, // Rounds per second
+  trail: 41, // Afterglow percentage
+  shadow: false, // Whether to render a shadow
+  hwaccel: false, // Whether to use hardware acceleration
+  className: 'spinner', // The CSS class to assign to the spinner
+  zIndex: 2e9, // The z-index (defaults to 2000000000)
+  top: 'auto', // Top position relative to parent in px
+  left: 'auto' // Left position relative to parent in px
+};
+
+$(document).ready(function(){
+
+  $('.dropdown-toggle').dropdown()
+
+  // search for key with that name and jump to it when clicked
+  $('#search_keys').typeahead({
+    // note that "value" is the default setting for the property option
+    source: function (query, process) {
+      return $.get(Routes['translation_center_search_translation_keys_path'] + '.json', { query: query }, function (data) {
+        return process(data);
+      });
+    },
+    updater: function(item) {
+      document.location = Routes['translation_center_search_translation_keys_path'] + '?search_key_name=' + item
+    }
+
+  });
+    
+
+});