tolk 1.2.0 → 2.0.0

data/lib/generators/tolk/utils.rb

@@ -0,0 +1,35 @@
+module Tolk
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          override_if_present_value.present? ?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value :
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+        end
+
+        def ask_boolean(wording, default_value = nil)
+          value = ask_for(wording, 'Y')
+          value = (value == 'Y')
+        end
+      end
+
+      module ClassMethods
+        def next_migration_number(dirname)
+          if ActiveRecord::Base.timestamped_migrations
+            migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+            migration_number += 1
+            migration_number.to_s
+          else
+            "%.3d" % (current_migration_number(dirname) + 1)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/tasks/tolk_tasks.rake

@@ -1,7 +1,14 @@
 namespace :tolk do
+  desc "Update locale"
+  task :update_locale, [:old_name, :new_name] => :environment do |t, args|
+    old_name, new_name = args[:old_name], args[:new_name]
+    puts Tolk::Locale.rename(old_name, new_name)
+  end
+
   desc "Add database tables, copy over the assets, and import existing translations"
   task :setup => :environment do
-    system("rails generate tolk_migration")
+    system 'rails g tolk:install'
+
     Rake::Task['db:migrate'].invoke
     Rake::Task['tolk:sync'].invoke
     Rake::Task['tolk:import'].invoke
@@ -17,6 +24,12 @@ namespace :tolk do
     Tolk::Locale.dump_all
   end
 
+  desc "Generate a single yml file for a specific locale"
+  task :dump_yaml, [:locale] => :environment do |t, args|
+    locale = args[:locale]
+    Tolk::Locale.dump_yaml(locale)
+  end
+
   desc "Imports data all non default locale yml files to Tolk"
   task :import => :environment do
     Rake::Task['tolk:sync'].invoke
@@ -30,5 +43,4 @@ namespace :tolk do
       puts "#{bt.phrase.key} - #{bt.text}"
     end
   end
-
 end

data/lib/tolk.rb

@@ -1,8 +1,19 @@
-require 'will_paginate'
-require 'ya2yaml'
+require 'safe_yaml/load'
+require 'tolk/config'
 require 'tolk/engine'
 require 'tolk/sync'
 require 'tolk/import'
+require 'tolk/export'
+require 'tolk/yaml'
+require 'tolk/pagination'
 
 module Tolk
+  # Setup Tolk
+  def self.config(&block)
+    if block_given?
+      block.call(Tolk::Config)
+    else
+      Tolk::Config
+    end
+  end
 end

data/lib/tolk/config.rb

@@ -0,0 +1,87 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Tolk
+  module Config
+
+
+    class << self
+      # Mapping : a hash of the type { 'ar'    => 'Arabic' }
+      attr_accessor :mapping
+
+      # Dump locale path by default the locales folder (config/locales)
+      attr_accessor :dump_path
+
+      # primary locale to not be overriden by default locale in development mode
+      attr_accessor :primary_locale_name
+
+      # exclude locales tokens from gems
+      attr_accessor :exclude_gems_token
+
+      # reject files of type xxx.en.yml when syncing locales
+      attr_accessor :block_xxx_en_yml_locale_files
+
+      # strip translation texts automatically
+      attr_accessor :strip_texts
+
+      def reset
+        @exclude_gems_token = false
+
+        @strip_texts = true
+
+        @block_xxx_en_yml_locale_files = true # keep compat with older versions
+
+        @dump_path = Proc.new { "#{Rails.application.root}/config/locales" }
+
+        @mapping = {
+          'ar'    => 'Arabic',
+          'bs'    => 'Bosnian',
+          'bg'    => 'Bulgarian',
+          'ca'    => 'Catalan',
+          'cs'    => 'Czech',
+          'da'    => 'Danish',
+          'de'    => 'German',
+          'el'    => 'Greek',
+          'en'    => 'English',
+          'es'    => 'Spanish',
+          'et'    => 'Estonian',
+          'fa'    => 'Persian',
+          'fi'    => 'Finnish',
+          'fr'    => 'French',
+          'he'    => 'Hebrew',
+          'hr'    => 'Croatian',
+          'hu'    => 'Hungarian',
+          'id'    => 'Indonesian',
+          'is'    => 'Icelandic',
+          'it'    => 'Italian',
+          'ja'    => 'Japanese',
+          'ko'    => 'Korean',
+          'lo'    => 'Lao',
+          'lt'    => 'Lithuanian',
+          'lv'    => 'Latvian',
+          'mk'    => 'Macedonian',
+          'nl'    => 'Dutch',
+          'no'    => 'Norwegian',
+          'pl'    => 'Polish',
+          'pt-BR' => 'Portuguese (Brazilian)',
+          'pt-PT' => 'Portuguese (Portugal)',
+          'ro'    => 'Romanian',
+          'ru'    => 'Russian',
+          'sv'    => 'Swedish',
+          'sk'    => 'Slovak',
+          'sl'    => 'Slovene',
+          'sr'    => 'Serbian',
+          'sw'    => 'Swahili',
+          'th'    => 'Thai',
+          'tr'    => 'Turkish',
+          'uk'    => 'Ukrainian',
+          'vi'    => 'Vietnamese',
+          'zh-CN' => 'Chinese (Simplified)',
+          'zh-TW' => 'Chinese (Traditional)'
+        }
+      end
+    end
+
+    # Set default values for configuration options on load
+    self.reset
+  end
+end

data/lib/tolk/engine.rb

@@ -3,5 +3,23 @@ require 'rails'
 module Tolk
   class Engine < Rails::Engine
     isolate_namespace Tolk
+
+    initializer :assets do |app|
+      app.config.assets.precompile += ['tolk/libraries.js']
+    end
+
+    # We need one of the two pagination engines loaded by this point.
+    # We don't care which one, just one of them will do.
+    begin
+      require 'kaminari'
+    rescue LoadError
+      begin
+        require 'will_paginate'
+      rescue LoadError
+       puts "Please add the kaminari or will_paginate gem to your application's Gemfile."
+       puts "The Tolk engine needs either kaminari or will_paginate in order to paginate."
+       exit
+      end
+    end
   end
 end

data/lib/tolk/export.rb

@@ -0,0 +1,27 @@
+module Tolk
+  class Export
+    attr_reader :name, :data, :destination
+
+    def initialize(args)
+      @name = args.fetch(:name, '')
+      @data = args.fetch(:data, {})
+      @destination = args.fetch(:destination, self.class.dump_path)
+    end
+
+    def dump
+      File.open("#{destination}/#{name}.yml", "w+") do |file|
+        file.write(Tolk::YAML.dump(data))
+      end
+    end
+
+    class << self
+      def dump(args)
+        new(args).dump
+      end
+
+      def dump_path
+        Tolk::Locale._dump_path
+      end
+    end
+  end
+end

data/lib/tolk/import.rb

@@ -8,14 +8,21 @@ module Tolk
 
       def import_secondary_locales
         locales = Dir.entries(self.locales_config_path)
-        locales = locales.reject {|l| ['.', '..'].include?(l) || !l.ends_with?('.yml') }.map {|x| x.split('.').first } - [Tolk::Locale.primary_locale.name]
 
+        locale_block_filter = Proc.new {
+          |l| ['.', '..'].include?(l) ||
+            !l.ends_with?('.yml') ||
+            l.match(/(.*\.){2,}/) # reject files of type xxx.en.yml
+        }
+        locales = locales.reject(&locale_block_filter).map {|x| x.split('.').first }
+        locales = locales - [Tolk::Locale.primary_locale.name]
         locales.each {|l| import_locale(l) }
       end
 
       def import_locale(locale_name)
-        locale = Tolk::Locale.find_or_create_by_name(locale_name)
+        locale = Tolk::Locale.where(name: locale_name).first_or_create
         data = locale.read_locale_file
+        return unless data
 
         phrases = Tolk::Phrase.all
         count = 0
@@ -25,9 +32,13 @@ module Tolk
 
           if phrase
             translation = locale.translations.new(:text => value, :phrase => phrase)
-            count = count + 1 if translation.save
+            if translation.save
+              count = count + 1
+            elsif translation.errors[:variables].present?
+              puts "[WARN] Key '#{key}' from '#{locale_name}.yml' could not be saved: #{translation.errors[:variables].first}"
+            end
           else
-            puts "[ERROR] Key '#{key}' was found in #{locale_name}.yml but #{Tolk::Locale.primary_language_name} translation is missing"
+            puts "[ERROR] Key '#{key}' was found in '#{locale_name}.yml' but #{Tolk::Locale.primary_language_name} translation is missing"
           end
         end
 
@@ -40,7 +51,14 @@ module Tolk
       locale_file = "#{self.locales_config_path}/#{self.name}.yml"
       raise "Locale file #{locale_file} does not exists" unless File.exists?(locale_file)
 
-      self.class.flat_hash(YAML::load(IO.read(locale_file))[self.name])
+      puts "[INFO] Reading #{locale_file} for locale #{self.name}"
+      begin
+        self.class.flat_hash(Tolk::YAML.load_file(locale_file)[self.name])
+      rescue
+        puts "[ERROR] File #{locale_file} expected to declare #{self.name} locale, but it does not. Skipping this file."
+        nil
+      end
+
     end
 
   end

data/lib/tolk/pagination.rb

@@ -0,0 +1,28 @@
+module Tolk
+  module Pagination
+    module Methods
+      # Kaminari defaults page_method_name to :page, will_paginate always uses
+      # :page
+      def pagination_method
+        defined?(Kaminari) ? Kaminari.config.page_method_name : :page
+      end
+
+      # Kaminari defaults param_name to :page, will_paginate always uses :page
+      def pagination_param
+        defined?(Kaminari) ? Kaminari.config.param_name : :page
+      end
+    end
+
+    module ViewHelper
+      def tolk_paginate(collection, options = {})
+        if respond_to?(:will_paginate)
+          # If parent app is using Will Paginate, we need to use it also
+          will_paginate collection, options
+        else
+          # Otherwise use Kaminari
+          paginate collection, options
+        end
+      end
+    end
+  end
+end

data/lib/tolk/sync.rb

@@ -10,14 +10,36 @@ module Tolk
       end
 
       def load_translations
-        I18n.available_locales # force load
+        if Tolk.config.exclude_gems_token
+          # bypass default init_translations
+          I18n.backend.reload! if I18n.backend.initialized?
+          I18n.backend.instance_variable_set(:@initialized, true)
+          translations_files = Dir[Rails.root.join('config', 'locales', "*.{rb,yml}")]
+
+          if Tolk.config.block_xxx_en_yml_locale_files
+            locale_block_filter = Proc.new {
+              |l| ['.', '..'].include?(l) ||
+                !l.ends_with?('.yml') ||
+                l.split("/").last.match(/(.*\.){2,}/) # reject files of type xxx.en.yml
+            }
+            translations_files =  translations_files.reject(&locale_block_filter)
+          end
+
+          I18n.backend.load_translations(translations_files)
+        else
+          I18n.backend.send :init_translations unless I18n.backend.initialized? # force load
+        end
         translations = flat_hash(I18n.backend.send(:translations)[primary_locale.name.to_sym])
         filter_out_i18n_keys(translations.merge(read_primary_locale_file))
       end
 
       def read_primary_locale_file
         primary_file = "#{self.locales_config_path}/#{self.primary_locale_name}.yml"
-        File.exists?(primary_file) ? flat_hash(YAML::load(IO.read(primary_file))[self.primary_locale_name]) : {}
+        if File.exists?(primary_file)
+          flat_hash(Tolk::YAML.load_file(primary_file)[self.primary_locale_name])
+        else
+          {}
+        end
       end
 
       def flat_hash(data, prefix = '', result = {})
@@ -38,7 +60,6 @@ module Tolk
 
       def sync_phrases(translations)
         primary_locale = self.primary_locale
-        secondary_locales = self.secondary_locales
 
         # Handle deleted phrases
         translations.present? ? Tolk::Phrase.destroy_all(["tolk_phrases.key NOT IN (?)", translations.keys]) : Tolk::Phrase.destroy_all
@@ -54,12 +75,7 @@ module Tolk
 
           if translation.changed? && !translation.new_record?
             # Set the primary updated flag if the primary translation has changed and it is not a new record.
-            secondary_locales.each do |locale|
-              if existing_translation = existing_phrase.translations.detect {|t| t.locale_id == locale.id }
-                existing_translation.force_set_primary_update = true
-                existing_translation.save!
-              end
-            end
+            existing_phrase.translations.where(Tolk::Translation.arel_table[:locale_id].not_eq(primary_locale.id)).update_all({ :primary_updated => true })
           end
 
           translation.primary = true

data/lib/tolk/version.rb

@@ -1,3 +1,3 @@
 module Tolk
-  VERSION = "1.2.0"
-end
+  VERSION = "2.0.0"
+end

data/lib/tolk/yaml.rb

@@ -0,0 +1,29 @@
+module Tolk
+  module YAML
+    SAFE_YAML_OPTIONS = SafeYAML::Deep.freeze({
+      :default_mode => :safe,
+      :deserialize_symbols => true
+    })
+
+    def self.load(yaml)
+      # SafeYAML.load has different arity depending on the YAML engine used.
+      if SafeYAML::YAML_ENGINE == "psych"
+        SafeYAML.load(yaml, nil, SAFE_YAML_OPTIONS)
+      else # syck
+        SafeYAML.load(yaml, SAFE_YAML_OPTIONS)
+      end
+    end
+
+    def self.load_file(filename)
+      SafeYAML.load_file(filename, SAFE_YAML_OPTIONS)
+    end
+
+    def self.dump(payload)
+      if payload.respond_to?(:ya2yaml)
+        payload.ya2yaml(:syck_compatible => true)
+      else
+        ::YAML.dump(payload)
+      end
+    end
+  end
+end

metadata

@@ -1,51 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: tolk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 - Piotr Sarnacki
 - Emilio Tagua
 - Thomas Darde
+- Ferran Basora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: will_paginate
+  name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: ya2yaml
+  name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: 0.8.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tolk is a web interface for doing i18n translations packaged as an engine
   for Rails applications.
 email: david@loudthinking.com
@@ -54,21 +120,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- config/routes.rb
-- init.rb
-- lib/generators/tolk_migration/templates/migrate/create_tolk_tables.rb
-- lib/generators/tolk_migration/tolk_migration_generator.rb
-- lib/tasks/tolk_tasks.rake
-- lib/tolk/engine.rb
-- lib/tolk/import.rb
-- lib/tolk/sync.rb
-- lib/tolk/version.rb
-- lib/tolk.rb
+- app/assets/javascripts/tolk/actions.js
 - app/assets/javascripts/tolk/application.js
-- app/assets/javascripts/tolk/controls.js
-- app/assets/javascripts/tolk/dragdrop.js
-- app/assets/javascripts/tolk/effects.js
-- app/assets/javascripts/tolk/prototype.js
+- app/assets/javascripts/tolk/interpolations.js
+- app/assets/javascripts/tolk/jquery-1.9.1.min.js
+- app/assets/javascripts/tolk/layout.js
+- app/assets/javascripts/tolk/libraries.js
 - app/assets/stylesheets/tolk/application.css
 - app/assets/stylesheets/tolk/reset.css
 - app/assets/stylesheets/tolk/screen.css
@@ -86,28 +143,44 @@ files:
 - app/views/tolk/locales/show.html.erb
 - app/views/tolk/searches/_form.html.erb
 - app/views/tolk/searches/show.html.erb
-homepage: http://github.com/tolk/tolk
-licenses: []
+- config/initializers/will_paginate.rb
+- config/routes.rb
+- lib/generators/tolk/install_generator.rb
+- lib/generators/tolk/templates/initializer.erb
+- lib/generators/tolk/templates/migration.rb
+- lib/generators/tolk/utils.rb
+- lib/tasks/tolk_tasks.rake
+- lib/tolk.rb
+- lib/tolk/config.rb
+- lib/tolk/engine.rb
+- lib/tolk/export.rb
+- lib/tolk/import.rb
+- lib/tolk/pagination.rb
+- lib/tolk/sync.rb
+- lib/tolk/version.rb
+- lib/tolk/yaml.rb
+homepage: https://github.com/tolk/tolk
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails engine providing web interface for managing i18n yaml files
 test_files: []