translation_center 1.7.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e4abb561664f8d78d8a31df030415a8201bfd5f
-  data.tar.gz: 165949a1ad4ede3782f45b221c56f536e19ae2ba
+  metadata.gz: 73cc7ca99fab28be936e25cb27ca191d73ea67cf
+  data.tar.gz: 6ddc9259b02e7c53a6b7d30a66be2026d4f544a2
 SHA512:
-  metadata.gz: e321ff0bf63b43f3e55c7f4a39a17bd66c243526f53736069e663a5ae43c176d9bc9fd03dce2fc9001a701e8869f299fd3fd2df800503c1e395984e4a6b4c239
-  data.tar.gz: ba4c021ca164d611732ed14ce6f31c41300447efd05ee2cd69dda0e949b4079c8c17ebc61816bb31de79c194427d4ec00465c9b7f6b0efd0b0d2f016545abc8e
+  metadata.gz: 6af06086f8b3dc23bbbe7658d041a4d27ce52dc1675032f1cb6808dcb4e7b28b9f0f02917963a5235d9287e0a2dc8331384c3e81322dc03beeea153abc58f598
+  data.tar.gz: ad2d4fa823c7713718b38aa8acc06f5ec542be5b61438dea8f2b953e90db4ed5556d1ec51379775760ce336cad668e13a20dcd2ffd5630665f71aecea2cd1c97

data/README.md

@@ -5,7 +5,7 @@
 
 ## 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.
+Translation Center is a multi lingual web engine for Rails 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")
 
@@ -36,7 +36,7 @@ Manage all app translations; collect stats, accept, add, edit, remove translatio
 
 ## Getting started
 
-TranslationCenter works with Rails 3.1 onwards. You can add it to your Gemfile with:
+TranslationCenter works with Rails 4.x onwards. You can add it to your Gemfile with:
 
 ```ruby
 gem 'translation_center'
@@ -106,6 +106,37 @@ def can_admin_translations?
   self.email == 'admin@tc.com'
 end
 ```
+## Rails 3
+If you are Using rails 3 you can revert back to tag 1.7.2 
+
+## MongoDB Support
+  * Create a SQL database so your app connects to both MongoDB and this new SQL database.
+  * Create a new SQL table (ex: translator_users) that will be considered as translator user and has a foreign key for your MongoDB user (ex: mongo_user_id)
+  * Add `acts_as_translator` to your ActiverRecord user (ex: TranslatorUser) model not Mogno User 
+  * Update translation_center.yml to the translator model name if needed
+    ```ruby 
+      tranlator_type: 'TranslatorUser'
+    ```
+  * You also need to add these methods in an initializer in case Devise is not existing in Mongo, 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 ActiveRecord user in session
+          end
+
+        end
+      end  
+      ```
+    in the current_user method make sure that you return the ActiveRecord user not the Mongo user because that's what we will use in translation center engine.
 
 ## How to use
 
@@ -285,6 +316,11 @@ http://www.youtube.com/watch?v=BTy6ZI31JmU
 
 Translation Center is maintained and developed by [BadrIT](http://badrit.com/)
 
+## Contributing
+
+We hope that you will consider contributing to Translation Center.
+You will usually want to write tests for your changes. To run the test suite, go into Translation Center's top-level directory and run "bundle install" and then "rspec spec" 
+
 ## Support
 
 Help us make this engine better by submitting any bugs or enhancments in the issues page for this project.

data/Rakefile

@@ -12,6 +12,7 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
+desc 'Generating documentation'
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'TranslationCenter'
@@ -20,21 +21,15 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
+desc 'RSpec tests'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-task :default => :test
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

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

@@ -12,7 +12,7 @@
 //
 //= require jquery
 //= require jquery_ujs
-//= require jquery.ui.all
+//= require jquery-ui
 //= require_tree .
 
 

data/app/assets/stylesheets/translation_center/application.css

@@ -9,7 +9,7 @@
  * compiled file, but it's generally better to create a new file per style scope.
  *
  *= require_self
- *= require jquery.ui.all
+ *= require jquery-ui
  *= require_tree .
   */
 

data/app/assets/stylesheets/translation_center/translation_keys.css

@@ -2,7 +2,9 @@
   Place all the styles related to the matching controller here.
   They will automatically be included in application.css.
 */
-
+#keys_ul{
+  height: 100%;
+}
 .translation_keys_listing {
   height: 410px;
   overflow: auto;

data/app/controllers/translation_center/application_controller.rb

@@ -12,7 +12,7 @@ module TranslationCenter
 
         render "translation_center/errors/exception"
       end
-      
+
     end
 
     # defaults
@@ -24,7 +24,7 @@ module TranslationCenter
     end
 
     protected
-    
+
     def can_admin?
       current_user.can_admin_translations?
     end

data/app/controllers/translation_center/translation_keys_controller.rb

@@ -11,14 +11,14 @@ module TranslationCenter
       @key_before_status = @translation_key.status(session[:lang_to])
       respond_to do |format|
         # only admin can edit accepted translations
-        if (current_user.can_admin_translations? || !@translation.accepted?) && !params[:value].strip.blank?
+        if (current_user.can_admin_translations? || !@translation.accepted?) && !params[:value].to_s.strip.blank?
           # use yaml.load to handle arrays
-          @translation.update_attributes(value: YAML.load(params[:value].strip), status: 'pending')
+          @translation.update(value: YAML.load(params[:value].strip), status: 'pending')
           # translation added by admin is considered the accepted one as it is trusted
           @translation.accept if current_user.can_admin_translations? && CONFIG['accept_admin_translations']
           format.json {render json: { value: @translation.value, status: @translation.key.status(@translation.lang), key_before_status: @key_before_status  } }
         else
-          render nothing: true
+          format.any {render nothing: true}
         end 
       end
     end
@@ -42,7 +42,7 @@ module TranslationCenter
     # PUT /translation_keys/1
     # PUT /translation_keys/1.json
     def update
-      params[:value].strip!
+      params[:value].to_s.strip!
       @old_value = @translation_key.category.name
       respond_to do |format|
         if !params[:value].blank? && @translation_key.update_attribute(:name, params[:value])

data/app/models/translation_center/activity_query.rb

@@ -18,7 +18,7 @@ module TranslationCenter
 
     # retuns and ActiveRecord Relation of Audit(s) that matches this search criteria
     def activities
-      query = Audited::Adapters::ActiveRecord::Audit.where(auditable_id: translation_ids).scoped
+      query = Audited::Adapters::ActiveRecord::Audit.where(auditable_id: translation_ids).all
       query = query.where("DATE(created_at) <= DATE(?)", created_at_lteq) unless created_at_lteq.blank?
       query = query.where("DATE(created_at) >= DATE(?)", created_at_gteq) unless created_at_gteq.blank?
       query.order('created_at DESC')
@@ -28,7 +28,7 @@ module TranslationCenter
 
     # return translation ids that matches this search criteria
     def translation_ids
-      query = Translation.scoped
+      query = Translation.all
       query = query.where(lang: lang) unless lang.blank?
       query = query.joins(:translation_key).where("translation_center_translation_keys.name LIKE ?", "%#{translation_key_name}%") unless translation_key_name.blank?
 
@@ -41,6 +41,5 @@ module TranslationCenter
 
       query.map(&:id)
     end
-
   end
 end

data/app/models/translation_center/category.rb

@@ -1,6 +1,6 @@
 module TranslationCenter
   class Category < ActiveRecord::Base
-    attr_accessible :name
+    # attr_accessible :name
     has_many :translation_keys, dependent: :destroy
 
     alias_method :keys, :translation_keys
@@ -10,7 +10,7 @@ module TranslationCenter
 
     # gets how much complete translation of category is in a certain language
     def complete_percentage_in(lang)
-      if self.keys.empty?
+      if self.keys.blank?
         100
       else
         accepted_keys = accepted_keys(lang)
@@ -43,5 +43,10 @@ module TranslationCenter
       self.name.titleize
     end
 
+    private
+
+    def category_params
+      params.require(:category).permit(:name)
+    end
   end
 end

data/app/models/translation_center/translation.rb

@@ -1,84 +1,100 @@
 module TranslationCenter
   class Translation < ActiveRecord::Base
 
-    attr_accessible :value, :lang, :translation_key_id, :user_id, :status
+    # attr_accessible :value, :lang, :translation_key_id, :user_id, :status
     # serialize as we could store arrays
-    serialize :value
-
     CHANGES_PER_PAGE = 5
     NUMBER_PER_PAGE = 15
 
+    # Statuses
+    ACCEPTED = "accepted"
+    PENDING = "pending"
+
+    # Relations
     belongs_to :translation_key
     belongs_to :translator, polymorphic: true
 
-    alias_method :key, :translation_key
-    acts_as_votable
-    audited
-
-    # validations
+    # Validations
     validates :translation_key_id, :lang, :status, :value, presence: true
     validate :one_translation_per_lang_per_key, on: :create
 
-    # returns accepted transations
-    scope :accepted, where(status: 'accepted')
+    # Scopes
+    # Returns accepted transations
+    scope :accepted, -> { where(status: ACCEPTED) }
 
-    # returns translations in a certain language
-    scope :in, lambda { |lang| where(lang: lang.to_s.strip) }
+    # Returns translations in a certain language
+    scope :in, ->(lang) { where(lang: lang.to_s.strip) }
 
-    # sorts translations by number of votes
-    scope :sorted_by_votes, where('votable_type IS NULL OR votable_type = ?', 'TranslationCenter::Translation').select('translation_center_translations.*, count(votes.id) as votes_count').joins('LEFT OUTER JOIN votes on votes.votable_id = translation_center_translations.id').group('translation_center_translations.id').order('votes_count desc')
+    # Sorts translations by number of votes
+    scope :sorted_by_votes, -> do
+      where('votable_type IS NULL OR votable_type = ?', 'TranslationCenter::Translation')
+      .select('translation_center_translations.*, count(votes.id) as votes_count')
+      .joins('LEFT OUTER JOIN votes on votes.votable_id = translation_center_translations.id')
+      .group('translation_center_translations.id')
+      .order('votes_count desc')
+    end
 
+    # Callbacks
     after_save :update_key_status
     after_destroy :notify_key
 
+    alias_method :key, :translation_key
+    acts_as_votable
+    audited
+
+    # Serialize as we could store arrays
+    serialize :value
+
     # called after save to update the key status
     def update_key_status
-      self.key.update_status self.lang
+      self.key.update_status(self.lang)
     end
 
     # called before destory to update the key status
     def notify_key
-      self.key.update_status self.lang
-      self.audits.destroy_all
+      self.key.update_status(self.lang)
+      self.audits.destroy
     end
 
     # returns true if the status of the translation is accepted
     def accepted?
-      self.status == 'accepted'
+      self.status == ACCEPTED
     end
 
     # returns true if the status of the translation is pending
     def pending?
-      self.status == 'pending'
+      self.status == PENDING
     end
 
-    # accept translation by changing its status and if there is an accepting translation
+    # Accept translation by changing its status and if there is an accepting translation
     # make it pending
     def accept
-      # if translation is accepted do nothing
+      # If translation is accepted do nothing
       unless self.accepted?
-        self.translation_key.accepted_translation_in(self.lang).try(:update_attribute, :status, 'pending')
+        self.translation_key.accepted_translation_in(self.lang)
+          .try(:update_attribute, :status, TranslationKey::PENDING)
+
         # reload the translation key as it has changed
         self.translation_key.reload
-        self.update_attribute(:status, 'accepted')
+        self.update_attribute(:status, ACCEPTED)
       end
-      
     end
 
     # unaccept a translation
     def unaccept
-      self.update_attribute(:status, 'pending')
-    end
-
-    # gets recent changes on translations
-    # TODO: remove this method as it is not being used elsewhere
-    def self.recent_changes
-      Audited::Adapters::ActiveRecord::Audit.where('auditable_type = ?', 'TranslationCenter::Translation').search(params).relation.reorder('created_at DESC')
+      self.update_attribute(:status, PENDING)
     end
 
     # make sure user has one translation per key per lang
     def one_translation_per_lang_per_key
-      if Translation.where(lang: self.lang, translator_id: self.translator.id, translator_type: self.translator.class.name, translation_key_id: self.key.id).empty?
+      translation_exists = Translation.exists?(
+        lang: self.lang,
+        translator_id: self.translator.id,
+        translator_type: self.translator.class.name,
+        translation_key_id: self.key.id
+      )
+
+      unless translation_exists
         true
       else
         false
@@ -86,5 +102,11 @@ module TranslationCenter
       end
     end
 
+    private
+
+    def translation_params
+      params.require(:translation).permit(:value, :lang, :translation_key_id, :user_id, :status)
+    end
+
   end
 end

data/app/models/translation_center/translation_key.rb

@@ -1,47 +1,52 @@
 module TranslationCenter
 
   class TranslationKey < ActiveRecord::Base
-    attr_accessible :name, :last_accessed, :category_id
+    # Constants
+    ACCEPTED = "accepted"
+    PENDING = "pending"
+    TRANSLATED = "translated"
+    UNTRANSLATED = "untranslated"
+    PER_PAGE = 7
+
+    # Relations
+    # attr_accessible :name, :last_accessed, :category_id
     belongs_to :category
     has_many :translations, dependent: :destroy
 
-    # validations
+    # Validations
     validates :name, uniqueness: true
     validates :name, presence: true
 
     # called after key is created or updated
     before_save :add_category
 
-    PER_PAGE = 7
-
-    scope :translated, lambda { |lang| where("#{lang.to_s}_status" => 'translated') }
-    scope :pending, lambda { |lang| where("#{lang.to_s}_status" => 'pending') }
-    scope :untranslated, lambda { |lang| where("#{lang.to_s}_status" => 'untranslated') }
-
+    scope :translated, ->(lang) { where("#{lang.to_s}_status" => TRANSLATED) }
+    scope :pending, ->(lang) { where("#{lang.to_s}_status" => PENDING) }
+    scope :untranslated, ->(lang) { where("#{lang.to_s}_status" => UNTRANSLATED) }
 
     # add a category of this translation key
     def add_category
       category_name = self.name.to_s.split('.').first
       # if one word then add to general category
       category_name = self.name.to_s.split('.').size == 1 ? 'general' : self.name.to_s.split('.').first
-      self.category = TranslationCenter::Category.find_or_create_by_name(category_name)
+      self.category = TranslationCenter::Category.where(name: category_name).first_or_create
       self.last_accessed = Time.now
     end
 
     # updates the status of the translation key depending on the translations
     def update_status(lang)
       if self.translations.in(lang).blank?
-        self.update_attribute("#{lang}_status", 'untranslated')
+        self.update_attribute("#{lang}_status", UNTRANSLATED)
       elsif !self.translations.in(lang).accepted.blank?
-        self.update_attribute("#{lang}_status", 'translated')
+        self.update_attribute("#{lang}_status", TRANSLATED)
       else
-        self.update_attribute("#{lang}_status", 'pending')
+        self.update_attribute("#{lang}_status", PENDING)
       end
     end
 
     # returns true if the key is translated (has accepted translation) in this lang
     def accepted_in?(lang)
-      self.send("#{lang}_status") == 'translated'
+      self.send("#{lang}_status") == TRANSLATED
     end
     alias_method :translated_in?, :accepted_in?
 
@@ -52,7 +57,7 @@ module TranslationCenter
 
     # returns true if the translation key is untranslated (has no translations) in the language
     def no_translations_in?(lang)
-      self.send("#{lang}_status") == 'untranslated'
+      self.send("#{lang}_status") == UNTRANSLATED
     end
     alias_method :untranslated_in?, :no_translations_in?
 
@@ -63,17 +68,17 @@ module TranslationCenter
 
     # returns true if the key is pending (has translations but none is accepted)
     def pending_in?(lang)
-      self.send("#{lang}_status") == 'pending'
+      self.send("#{lang}_status") == PENDING
     end
 
     # returns the status of the key in a language
     def status(lang)
       if accepted_in?(lang)
-        'translated'
+        TRANSLATED
       elsif pending_in?(lang)
-        'pending'
+        PENDING
       else
-        'untranslated'
+        UNTRANSLATED
       end
     end
 
@@ -162,6 +167,12 @@ module TranslationCenter
     end
 
     private
+
+
+      def translation_key_params
+        params.require(:translation_key).permit(:name, :last_accessed, :category_id)
+      end
+
       def add_to_hash_rec(all_translations, levels, lang)
         current_level = levels.first
         # if we are at the bottom level just return the translation