solidus_i18n 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0de9177ef69dd299f196ad557a46b1bae3bed9cae5e7895355564802330c04eb
-  data.tar.gz: 9e3f5ff6b46eb825e22b85797025cbd63c4cc2b0b6a7b689bd11f06333c16df2
+  metadata.gz: 0bbd02ebe1aede79103a8db264d1493f3e9cb56bb62722461fed73656e24ba31
+  data.tar.gz: 757a07d2e2d4a0902191d8895a033d28635271f4b3e9c9d429e19ec02e49f3ba
 SHA512:
-  metadata.gz: 4d200695f22be7bbc14d2b0cab0c97b589024b0ece7595e18a8c8ea2759a14791d76013810dbd93394c2dee5e5f63de3d6a284f6a60c7dfc3f7da5dc177f26eb
-  data.tar.gz: fa2f1672afdeb8be73d6b4e414ffba0d6bf21b69e3341a9743479171c524dd160833b2a5d5f8125c646f1c1e8f597b1e19fb8f73cd67a591f01d63095e605a03
+  metadata.gz: 52dfde0677e5350c135c0777cd4ffc4f8a3e19e6416f362d75f3daa6462712da8192b08f6d4f9984868422e6a44390512a09415cd1ea27a9587a89a861690143
+  data.tar.gz: 34e0080d9502f180c87c0445e001a6fac8b974a771427c66c769e5014c0f29bd9b3c5e3d93c3fda5f912a1c220bc001e074248fbfff0926a825135c379c15316

data/README.md

@@ -1,61 +1,66 @@
 # Solidus Internationalization
 
-[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_i18n.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_i18n)
-[![Code Climate](https://codeclimate.com/github/solidusio-contrib/solidus_i18n/badges/gpa.svg)](https://codeclimate.com/github/solidusio-contrib/solidus_i18n)
+[![Build Status](https://travis-ci.org/solidusio/solidus_i18n.svg?branch=master)](https://travis-ci.org/solidusio/solidus_i18n)
+[![Code Climate](https://codeclimate.com/github/solidusio/solidus_i18n/badges/gpa.svg)](https://codeclimate.com/github/solidusio/solidus_i18n)
 [![Gem Version](https://badge.fury.io/rb/solidus_i18n.svg)](https://badge.fury.io/rb/solidus_i18n)
 
 This is the Internationalization project for [Solidus](https://solidus.io)
 
 ---
 
-## Supported languages
+## Changes in Version 2.0
 
-We currently support the [following locales](https://github.com/solidusio-contrib/solidus_i18n/tree/master/config/locales)
-by default. If you need a locale that is not in the list you can add a custom
-translation file into your application by following the
-[Rails translations guide](http://guides.rubyonrails.org/i18n.html#how-to-store-your-custom-translations).
+solidus_i18n Version 2.0+ only contains translation files.
+
+Previous versions of solidus_i18n included extra functionality like locale
+selectors and which is now built in to Solidus 2.6+. Configuration for
+`routing-fitler` has also been removed and must be configured manually
+(See [Locale in URL](#locale-in-url)).
 
 ## Installation
 
 Add the following to your `Gemfile`:
 
 ```ruby
-gem 'solidus_i18n', github: 'solidusio-contrib/solidus_i18n', branch: 'master'
+gem 'solidus_i18n', '~> 2.0'
+gem 'rails-i18n', '~> 5.1'
+gem 'kaminari-i18n', '~> 0.5.0'
 ```
 
-Run `bundle install`
-
-You can use the generator to install migrations and append solidus_i18n assets to
-your app solidus manifest file.
+## Locale in URL
 
-    bin/rails g solidus_i18n:install
+Older versions of solidus_i18n included the routing-filter gem and configured routes to include the locale in the URL.
+This is still supported (maybe even recommended) but requires some additional configuration.
 
-This will insert these lines into your Spree assets manifests:
+1. Add this gem to your `Gemfile`, then run `bundle install`
 
-In `vendor/assets/javascripts/spree/frontend/all.js`
-
-```
-//= require spree/frontend/solidus_i18n
+``` ruby
+gem 'routing-filter', '~> 0.6.0'
 ```
 
-In `vendor/assets/javascripts/spree/backend/all.js`
+2. Add `filter :locale` to your `config/routes.rb`
 
-```
-//= require spree/backend/solidus_i18n
-```
+``` ruby
+Rails.application.routes.draw do
+  filter :locale
 
-## Set default locale
+  mount Spree::Core::Engine, at: '/'
+end
+```
 
-In `config/initializers/spree.rb` you will find the default locale settings
-for both frontend and backend. Just replace `'en'` with your default locale
-code.
+3. Configure routing-fitler in `config/initializers/locale_filter.rb` (optional)
 
-## Add more languages to the frontend locale toggle
+``` ruby
+# Do not include the default locale in the URL
+RoutingFilter::Locale.include_default_locale = false
+```
 
-Go to Admin -> General Settings -> Localization Setting and add the locales
-you want your users to be able to select from the locale toggle on the frontend.
+## Supported languages
 
----
+We currently support the [following locales](https://github.com/solidusio/solidus_i18n/tree/master/config/locales)
+by default. If you need a locale that is not in the list you can add a custom
+translation file into your application by following the
+[Rails translations guide](http://guides.rubyonrails.org/i18n.html#how-to-store-your-custom-translations).
 
 ## Updating Translations
 
@@ -69,8 +74,6 @@ Substitute <LOCALE> with your locale code (e.g: `it`).
 This will do a cleanup and prepare `<LOCALE>.yml` with all the missing keys.
 You can then write the translations and open a pull request.
 
----
-
 ## Model Translations
 
 We **removed** support for translating models into [a separate Gem](https://github.com/solidusio-contrib/solidus_globalize).
@@ -82,24 +85,6 @@ Please update your `Gemfile` if you still need the model translations.
 gem 'solidus_globalize', github: 'solidusio-contrib/solidus_globalize', branch: 'master'
 ```
 
----
-
-## Upgrading
-
-**WARNING**: If you want to keep your model translations, be sure to add the `solidus_globalize` gem to your `Gemfile` **before** migrating the database. Otherwise **you will loose your translations**!
-
-### 1. Migrate your database
-
-    bin/rake solidus_i18n:upgrade
-    bin/rake db:migrate
-
-*Note:* The migration automatically skips the removal of the translations tables. So it's safe to run the migration without data loss. But be sure to have the `solidus_globalize` gem in your `Gemfile`, if you want to keep them.
-
-### 2. Remove Configuration
-
-Remove all occurrences of `SolidusI18n::Config.supported_locales` from your code.
-
-
 Contributing
 ------------
 

data/config/routes.rb

@@ -1,16 +1,2 @@
 Spree::Core::Engine.routes.draw do
-  # from routing-filter gem
-  filter :locale
-
-  post '/locale/set', to: 'locale#set', defaults: { format: :json }, as: :set_locale
-
-  namespace :api do
-    scope :config do
-      resources :available_locales, only: [:update, :index]
-    end
-  end
-
-  namespace :admin do
-    resource :locale, only: [:show, :update]
-  end
 end

data/lib/solidus_i18n.rb

@@ -1,8 +1,3 @@
-require 'rails-i18n'
 require 'solidus_core'
-require 'solidus_support'
 require 'solidus_i18n/engine'
-require 'solidus_i18n/locale'
 require 'solidus_i18n/version'
-require 'coffee_script'
-require 'deface'

data/lib/solidus_i18n/engine.rb

@@ -1,44 +1,5 @@
-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|
-      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/version.rb

@@ -8,8 +8,8 @@ module SolidusI18n
   end
 
   module VERSION
-    MAJOR = 1
-    MINOR = 3
+    MAJOR = 2
+    MINOR = 0
     TINY  = 0
     PRE   = nil
 

data/solidus_i18n.gemspec

@@ -23,21 +23,8 @@ Gem::Specification.new do |s|
 
   s.has_rdoc = false
 
-  s.add_runtime_dependency 'i18n_data', '~> 0.7.0'
-  s.add_runtime_dependency 'rails-i18n', ['>= 4.0.1', '< 6']
-  s.add_runtime_dependency 'kaminari-i18n', '~> 0.5.0'
-  s.add_runtime_dependency 'routing-filter', '~> 0.6.0'
   s.add_runtime_dependency 'solidus_core', ['>= 1.1', '< 3']
-  s.add_runtime_dependency 'solidus_support'
-  s.add_runtime_dependency 'deface', '~> 1.0'
 
-  s.add_development_dependency 'byebug'
-  s.add_development_dependency 'capybara', '~> 2.17'
-  s.add_development_dependency 'selenium-webdriver', '~> 3.9'
-  s.add_development_dependency 'database_cleaner', '~> 1.3'
-  s.add_development_dependency 'factory_bot', '~> 4.5'
-  s.add_development_dependency 'ffaker', '>= 1.25.0'
-  s.add_development_dependency 'poltergeist', '~> 1.17'
   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'

data/spec/{lib/solidus_i18n/locale_spec.rb → solidus_i18n_spec.rb}

@@ -1,10 +1,14 @@
 require 'spec_helper'
 
-RSpec.describe SolidusI18n::Locale do
-  describe '.all' do
-    subject { SolidusI18n::Locale.all }
+RSpec.describe "solidus_i18n" do
+  describe 'defined locales' do
+    subject do
+      I18n.available_locales.select do |locale|
+        I18n.t('spree.i18n.this_file_language', locale: locale, fallback: false, default: nil)
+      end
+    end
 
-    it "Contains all available Solidus locales" do
+    it "contains the added locales" do
       # Add to this list when adding/removing locales
       expect(subject).to match_array %i[
         en
@@ -49,5 +53,13 @@ RSpec.describe SolidusI18n::Locale do
         sl-SI
       ]
     end
+
+    it "has a unique description for each locale" do
+      descriptions = subject.map do |locale|
+        I18n.t('spree.i18n.this_file_language', locale: locale)
+      end
+
+      expect(descriptions.uniq).to eq(descriptions)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ rescue LoadError
 end
 
 require 'pry'
-require 'ffaker'
 require 'rspec/rails'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_i18n
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -10,68 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: i18n_data
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: rails-i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: kaminari-i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: routing-filter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: solidus_core
   requirement: !ruby/object:Gem::Requirement
@@ -92,132 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: solidus_support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: deface
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.17'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-- !ruby/object:Gem::Dependency
-  name: ffaker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.25.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.25.0
-- !ruby/object:Gem::Dependency
-  name: poltergeist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -289,30 +101,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- app/assets/javascripts/spree/backend/edit_inline_locales.js.coffee.erb
-- app/assets/javascripts/spree/backend/helpers.js.coffee.erb
-- app/assets/javascripts/spree/backend/inline_table_locales.js.coffee
-- app/assets/javascripts/spree/backend/solidus_i18n.js
-- app/assets/javascripts/spree/backend/templates/available_locales.hbs.erb
-- app/assets/javascripts/spree/backend/translations.js.coffee
-- app/assets/javascripts/spree/frontend/locale.js.coffee
-- app/assets/javascripts/spree/frontend/solidus_i18n.js
-- app/assets/stylesheets/spree/backend/solidus_i18n.css
-- app/assets/stylesheets/spree/frontend/solidus_i18n.css
-- app/controllers/spree/admin/locales_controller.rb
-- app/controllers/spree/api/available_locales_controller.rb
-- app/controllers/spree/api/base_controller_decorator.rb
-- app/controllers/spree/base_controller_decorator.rb
-- app/controllers/spree/locale_controller_decorator.rb
-- app/helpers/solidus_i18n/locale_helper.rb
-- app/models/spree/store_decorator.rb
-- app/overrides/spree/admin/shared/_configuration_menu/add_i18n_tab.html.erb.deface
-- app/overrides/spree/shared/_main_nav_bar/locale_selector.html.erb.deface
-- app/views/spree/admin/locales/show.html.erb
-- app/views/spree/api/available_locales/show.json.jbuilder
 - bin/rails
-- config/initializers/country_names.rb
-- config/initializers/routing_filter.rb
 - config/locales/bg.yml
 - config/locales/ca.yml
 - config/locales/cs.yml
@@ -353,30 +142,13 @@ files:
 - config/locales/zh-CN.yml
 - config/locales/zh-TW.yml
 - config/routes.rb
-- db/migrate/20150609154031_remove_translations_from_spree_tables.rb
-- db/migrate/20170523151209_add_available_locales_on_store.rb
-- lib/generators/solidus_i18n/install/install_generator.rb
 - lib/solidus_i18n.rb
-- lib/solidus_i18n/configuration.rb
-- lib/solidus_i18n/controller_locale_helper.rb
 - lib/solidus_i18n/engine.rb
-- lib/solidus_i18n/locale.rb
 - lib/solidus_i18n/version.rb
 - lib/tasks/solidus_i18n/upgrade.rake
 - solidus_i18n.gemspec
-- spec/controllers/locales_controller_spec.rb
-- spec/features/admin/translations_spec.rb
-- spec/features/russian_errors_translation_spec.rb
-- spec/features/translation_spec.rb
-- spec/features/translations_spec.rb
-- spec/helpers/locale_helper_spec.rb
-- spec/lib/solidus_i18n/locale_spec.rb
+- spec/solidus_i18n_spec.rb
 - spec/spec_helper.rb
-- spec/support/capybara.rb
-- spec/support/database_cleaner.rb
-- spec/support/factory_girl.rb
-- spec/support/i18n.rb
-- spec/support/spree.rb
 homepage: https://solidus.io
 licenses:
 - BSD-3
@@ -403,16 +175,5 @@ signing_key:
 specification_version: 4
 summary: Provides locale information for use in Solidus.
 test_files:
-- spec/controllers/locales_controller_spec.rb
-- spec/features/admin/translations_spec.rb
-- spec/features/russian_errors_translation_spec.rb
-- spec/features/translation_spec.rb
-- spec/features/translations_spec.rb
-- spec/helpers/locale_helper_spec.rb
-- spec/lib/solidus_i18n/locale_spec.rb
+- spec/solidus_i18n_spec.rb
 - spec/spec_helper.rb
-- spec/support/capybara.rb
-- spec/support/database_cleaner.rb
-- spec/support/factory_girl.rb
-- spec/support/i18n.rb
-- spec/support/spree.rb