solidus_i18n 1.0.0

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.add_routes do
+  # from routing-filter gem
+  filter :locale
+
+  post '/locale/set', to: 'locale#set', defaults: { format: :json }, as: :set_locale
+end

data/db/migrate/20150609154031_remove_translations_from_spree_tables.rb

@@ -0,0 +1,65 @@
+class RemoveTranslationsFromSpreeTables < ActiveRecord::Migration
+  def up
+    # Don't migrate if we still use Globalize, i.e. through spree_globalize Gem
+    return if defined?(Globalize)
+
+    %w(
+      OptionType
+      OptionValue
+      ProductProperty
+      Product
+      Promotion
+      Property
+      Store
+      Taxon
+      Taxonomy
+    ).each do |class_name|
+      migrate_translation_data!(class_name)
+    end
+  end
+
+  def down
+    return if defined?(Globalize)
+    raise ActiveRecord::IrreversibleMigration
+  end
+
+  private
+
+  def current_locale
+    I18n.default_locale || 'en'
+  end
+
+  def migrate_translation_data!(class_name)
+    klass = "Spree::#{class_name}".constantize
+    table_name = klass.table_name
+    singular_table_name = table_name.singularize
+
+    return if !table_exists?(table_name) || !table_exists?("#{singular_table_name}_translations")
+
+    # We can't rely on Globalize drop_translation_table! here,
+    # because the Gem has been already removed, so we need to run custom SQL
+    records = exec_query("SELECT * FROM #{singular_table_name}_translations WHERE locale = '#{current_locale}';")
+
+    records.each do |record|
+      id = record["#{singular_table_name}_id"]
+      attributes = record.except(
+        'id',
+        "#{singular_table_name}_id",
+        'locale',
+        'deleted_at',
+        'created_at',
+        'updated_at'
+      )
+      object = if klass.respond_to?(:with_deleted)
+                 klass.with_deleted.find(id)
+               else
+                 klass.find(id)
+               end
+      object.update_columns(attributes)
+    end
+
+    say "Migrated #{current_locale} translation for #{class_name} back into original table."
+
+    drop_table "#{singular_table_name}_translations"
+  end
+end

data/lib/generators/solidus_i18n/install/install_generator.rb

@@ -0,0 +1,27 @@
+module SolidusI18n
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: true
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/backend/all.js',
+          "//= require spree/backend/solidus_i18n\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js',
+          "//= require spree/frontend/solidus_i18n\n"
+      end
+
+      def add_migrations
+        run 'bin/rake solidus_i18n:install:migrations'
+      end
+
+      def run_migrations
+        if options[:auto_run_migrations] ||
+          ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+          run 'bin/rake db:migrate'
+        else
+          puts "Skiping rake db:migrate, don't forget to run it!"
+        end
+      end
+    end
+  end
+end

data/lib/solidus_i18n/configuration.rb

@@ -0,0 +1,9 @@
+module SolidusI18n
+  class Configuration < Spree::Preferences::Configuration
+    # These configs intend to, respectively:
+    #
+    #   Set locales that should be available for end users
+    #
+    preference :available_locales, :array, default: [:en]
+  end
+end

data/lib/solidus_i18n/controller_locale_helper.rb

@@ -0,0 +1,29 @@
+module SolidusI18n
+  # The fact this logic is in a single module also helps to apply a custom
+  # locale on the spree/api context since api base controller inherits from
+  # MetalController instead of Spree::BaseController
+  module ControllerLocaleHelper
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_filter :set_user_language
+
+      private
+
+      # Overrides the Spree::Core::ControllerHelpers::Common logic so that only
+      # supported locales defined by SolidusI18n::Config.supported_locales can
+      # actually be set
+      def set_user_language
+        # params[:locale] can be added by routing-filter gem
+        I18n.locale = \
+          if params[:locale] && Config.available_locales.include?(params[:locale].to_sym)
+            params[:locale]
+          elsif respond_to?(:config_locale, true) && !config_locale.blank?
+            config_locale
+          else
+            Rails.application.config.i18n.default_locale || I18n.default_locale
+          end
+      end
+    end
+  end
+end

data/lib/solidus_i18n/engine.rb

@@ -0,0 +1,45 @@
+require 'routing_filter'
+require 'kaminari-i18n/engine'
+
+module SolidusI18n
+  class Engine < Rails::Engine
+    engine_name 'solidus_i18n'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer 'solidus.i18n' do |app|
+      SolidusI18n::Engine.instance_eval do
+        pattern = pattern_from app.config.i18n.available_locales
+
+        add("config/locales/#{pattern}/*.{rb,yml}")
+        add("config/locales/#{pattern}.{rb,yml}")
+      end
+    end
+
+    initializer 'solidus.i18n.environment', before: :load_config_initializers do |app|
+      app.config.i18n.fallbacks = true
+      I18n.locale = app.config.i18n.default_locale if app.config.i18n.default_locale
+      SolidusI18n::Config = SolidusI18n::Configuration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+
+    protected
+
+    def self.add(pattern)
+      files = Dir[File.join(File.dirname(__FILE__), '../..', pattern)]
+      I18n.load_path.concat(files)
+    end
+
+    def self.pattern_from(args)
+      array = Array(args || [])
+      array.blank? ? '*' : "{#{array.join ','}}"
+    end
+  end
+end

data/lib/solidus_i18n/locale.rb

@@ -0,0 +1,13 @@
+module SolidusI18n
+  class Locale
+    class << self
+      def all
+        Dir["#{dir}/*.yml"].map { |f| File.basename(f, '.yml').to_sym }
+      end
+
+      def dir
+        File.join(File.dirname(__FILE__), '/../../config/locales')
+      end
+    end
+  end
+end

data/lib/solidus_i18n/utils.rb

@@ -0,0 +1,56 @@
+require 'active_support/core_ext'
+
+module SolidusI18n
+  module Utils
+    # Retrieve comments, translation data in hash form
+    def read_file(filename, basename)
+      # Add error checking for failed file read?
+      (comments, data) = IO.read(filename).split(/#{basename}:\s*\n/)
+      return comments, create_hash(data)
+    end
+    module_function :read_file
+
+    # Creates hash of translation data
+    def create_hash(data)
+      words = {}
+      return words unless data
+      parent = []
+      previous_key = 'base'
+      data.split("\n").each do |w|
+        next if w.strip.blank? || w.strip[0] == '#'
+        (key, value) = w.split(':', 2)
+        value ||= ''
+        # Determine level of current key in comparison to parent array
+        shift = (key =~ /\w/) / 2 - parent.size
+        key = key.sub(/^\s+/, '')
+        # If key is child of previous key, add previous key as parent
+        parent << previous_key if shift > 0
+        # If key is not related to previous key, remove parent keys
+        (shift*-1).times { parent.pop } if shift < 0
+        # Track key in case next key is child of this key
+        previous_key = key
+        words[parent.join(':') + ':' + key] = value
+      end
+      words
+    end
+    module_function :create_hash
+
+    # Writes to file from translation data hash structure
+    def write_file(filename, basename, _comments, words, comment_values = true, _fallback_values = {})
+      File.open(filename, 'w') do |log|
+        log.puts(basename + ": \n")
+        words.sort.each do |k, v|
+          keys = k.split(':')
+          # Add indentation for children keys
+          (keys.size - 1).times do
+            keys[keys.size - 1] = '  ' + keys[keys.size - 1]
+          end
+          value = v.strip
+          value = ('#' + value) if comment_values && !value.blank?
+          log.puts "#{keys[keys.size - 1]}: #{value}\n"
+        end
+      end
+    end
+    module_function :write_file
+  end
+end

data/lib/solidus_i18n/version.rb

@@ -0,0 +1,18 @@
+module SolidusI18n
+  module_function
+
+  # Returns the version of the currently loaded SolidusI18n as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/solidus_i18n.rb

@@ -0,0 +1,8 @@
+require 'sass/rails'
+require 'rails-i18n'
+require 'solidus_core'
+require 'solidus_i18n/engine'
+require 'solidus_i18n/version'
+require 'solidus_i18n/utils'
+require 'coffee_script'
+require 'deface'

data/lib/tasks/solidus_i18n/upgrade.rake

@@ -0,0 +1,43 @@
+require 'fileutils'
+
+namespace :solidus_i18n do
+  desc 'Upgrades to version without globalize.'
+  task upgrade: :environment do
+    files = %w(
+      add_translations_to_main_models
+      add_translations_to_product_permalink
+      add_translations_to_option_value
+      rename_activator_translations_to_promotion_translations
+      update_spree_product_translations
+      add_translations_to_product_properties
+      remove_null_constraints_from_spree_tables
+      add_deleted_at_to_translation_tables
+      add_translations_to_store
+    ).collect do |file_name|
+      Dir.glob Rails.root.join('db', 'migrate', "*_#{file_name}*.rb")
+    end.flatten
+
+    # Delete old migrations
+    FileUtils.rm files
+
+    # Install new migrations
+    Rake::Task['solidus_i18n:install:migrations'].invoke
+
+    puts <<-DESC
+Upgraded migrations successfully.
+
+Now please remove these lines from your vendor/assets folder:
+
+From `vendor/assets/javascripts/spree/backend/all.js`
+
+    //= require spree/backend/spree_i18n
+
+and from `vendor/assets/stylesheets/spree/backend/all.css`
+
+    *= require spree/backend/spree_i18n
+
+Don't forget to run `rake db:migrate` now.
+
+DESC
+  end
+end

data/solidus_i18n.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'solidus_i18n/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_i18n'
+  s.version     = SolidusI18n.version
+  s.summary     = 'Provides locale information for use in Solidus.'
+  s.description = s.summary
+
+  s.author      = 'Thomas von Deyen'
+  s.email       = 'tvd@magiclabs.de'
+  s.homepage    = 'https://solidus.io'
+  s.license     = 'BSD-3'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.has_rdoc = false
+
+  s.add_runtime_dependency 'i18n_data', '~> 0.7.0'
+  s.add_runtime_dependency 'rails-i18n', '~> 4.0.1'
+  s.add_runtime_dependency 'kaminari-i18n', '~> 0.3.2'
+  s.add_runtime_dependency 'routing-filter', '~> 0.5.0'
+  s.add_runtime_dependency 'solidus_core', '~> 1.0'
+  s.add_runtime_dependency 'deface', '~> 1.0'
+
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'capybara', '~> 2.4.4'
+  s.add_development_dependency 'coffee-rails', '~> 4.0.0'
+  s.add_development_dependency 'database_cleaner', '~> 1.3'
+  s.add_development_dependency 'factory_girl', '~> 4.5'
+  s.add_development_dependency 'ffaker', '>= 1.25.0'
+  s.add_development_dependency 'poltergeist', '~> 1.5'
+  s.add_development_dependency 'pry-rails', '>= 0.3.0'
+  s.add_development_dependency 'rubocop', '>= 0.24.1'
+  s.add_development_dependency 'rspec-rails', '~> 3.1'
+  s.add_development_dependency 'sass-rails', '~> 5.0.0'
+  s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'guard-rspec', '>= 4.2.0'
+end

data/spec/controllers/locales_controller_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Spree::HomeController, type: :controller do
+  routes { Spree::Core::Engine.routes }
+
+  before do
+    reset_spree_preferences
+    SolidusI18n::Config.available_locales = [:en, :es]
+  end
+
+  context 'tries not supported fr locale' do
+    it 'falls back do default locale' do
+      get :index, locale: 'fr'
+      expect(I18n.locale).to eq :en
+    end
+  end
+
+  context 'tries supported es locale' do
+    it 'takes this locale' do
+      get :index, locale: 'es'
+      expect(I18n.locale).to eq :es
+    end
+  end
+end

data/spec/features/admin/translations_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.feature 'Translations', :js do
+  stub_authorization!
+
+  given!(:store) { create(:store) }
+
+  background do
+    reset_spree_preferences
+  end
+
+  context 'localization settings' do
+    given(:language) { Spree.t(:this_file_language, scope: 'i18n', locale: 'de') }
+    given(:french) { Spree.t(:this_file_language, scope: 'i18n', locale: 'fr') }
+
+    background do
+      SolidusI18n::Config.available_locales = []
+      visit spree.edit_admin_general_settings_path
+    end
+
+    scenario 'adds german to available locales' do
+      targetted_select2_search(language, from: '#s2id_available_locales_')
+      click_on 'Update'
+      expect(SolidusI18n::Config.available_locales).to include(:de)
+    end
+
+    scenario 'adds french to available locales' do
+      targetted_select2_search(french, from: '#s2id_available_locales_')
+      click_on 'Update'
+      expect(SolidusI18n::Config.available_locales).to include(:fr)
+    end
+  end
+end

data/spec/features/russian_errors_translation_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'spec_helper'
+
+RSpec.describe 'Russian errors translations' do
+  def translation(count)
+    Spree.t(:errors_prohibited_this_record_from_being_saved, count: count)
+  end
+
+  context 'when current locale is Russian' do
+    it 'translation is available' do
+      I18n.locale = :ru
+      expect(translation(1)).to eq 'Одна ошибка не позволяет сохранить запись в базе'
+      expect(translation(3)).to eq '3 ошибки не позволяют сохранить запись в базе'
+      expect(translation(10)).to eq '10 ошибок не позволяют сохранить запись в базе'
+    end
+  end
+end

data/spec/features/translation_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'spec_helper'
+
+RSpec.describe 'Translation' do
+  def translation
+    I18n.t('activerecord.attributes.spree/address.zipcode')
+  end
+
+  context 'when current locale is en' do
+    it 'translation is available' do
+      I18n.locale = :en
+      expect(translation).to eq 'Zip Code'
+    end
+  end
+
+  # German is chosen as an example of language whose translations are found in a file.
+  context 'when current locale is German' do
+    it 'translation is available' do
+      I18n.locale = :de
+      expect(translation).to eq 'PLZ'
+    end
+  end
+
+  # Chilean spanish is chosen
+  context 'when current locale is Chilean Spanish' do
+    it 'translation is available' do
+      I18n.locale = :'es-CL'
+      expect(translation).to eq 'Código Postal'
+    end
+  end
+end

data/spec/features/translations_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'spec_helper'
+
+RSpec.feature 'Translations', :js do
+  given(:language) { Spree.t(:this_file_language, scope: 'i18n', locale: 'pt-BR') }
+
+  background do
+    reset_spree_preferences
+    SolidusI18n::Config.available_locales = [:en, :'pt-BR']
+  end
+
+  context 'page' do
+    context 'switches locale from the dropdown' do
+      before do
+        visit spree.root_path
+        select(language, from: Spree.t(:language, scope: 'i18n'))
+      end
+
+      scenario 'selected translation is applied' do
+        expect(page).to have_content(/#{Spree.t(:home, locale: 'pt-BR')}/i)
+      end
+
+      scenario 'JS cart link is translated' do
+        expect(page).to have_content(/#{Spree.t(:cart, locale: 'pt-BR')}/i)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+begin
+  require File.expand_path('../dummy/config/environment', __FILE__)
+rescue LoadError
+  puts 'Could not load dummy application. Please ensure you have run `bundle exec rake test_app`'
+  exit
+end
+
+require 'pry'
+require 'ffaker'
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.fail_fast = false
+  config.filter_run focus: true
+  config.infer_spec_type_from_file_location!
+  config.mock_with :rspec
+  config.raise_errors_for_deprecations!
+  config.run_all_when_everything_filtered = true
+  config.use_transactional_fixtures = false
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), '/support/**/*.rb')].each { |file| require file }

data/spec/support/capybara.rb

@@ -0,0 +1,11 @@
+require 'capybara/rspec'
+require 'capybara/rails'
+require 'capybara/poltergeist'
+
+RSpec.configure do
+  Capybara.javascript_driver = :poltergeist
+
+  Capybara.register_driver(:poltergeist) do |app|
+    Capybara::Poltergeist::Driver.new app, timeout: 90
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,23 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/i18n.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before do
+    I18n.locale = I18n.default_locale
+  end
+end

data/spec/support/spree.rb

@@ -0,0 +1,12 @@
+require 'spree/testing_support/factories'
+require 'spree/testing_support/preferences'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/authorization_helpers'
+
+RSpec.configure do |config|
+  config.include Spree::TestingSupport::UrlHelpers
+  config.include Spree::TestingSupport::Preferences
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+end