solidus_i18n 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed8e33f5b243d4064d181a50c9ddc3969cb8c7c1
-  data.tar.gz: d44330025193250d62aabf963178adaaffc5d510
+SHA256:
+  metadata.gz: 1b6e21b2e37c009c788f848056a93337d066c54ae04583d42305c4d0371e08eb
+  data.tar.gz: 031cbfd44787548a02e65e54a4f715a798a0cfdbd34378ebfa2adde38aefca1d
 SHA512:
-  metadata.gz: 60b20095c44e83638e94d8fc409ec76cfd6d1a64e2123c2f747e7388a3ce0ee3bc7d4fc704ac29ee041c57f875d41f0d4756d8091a56c4baa6a494da29176e02
-  data.tar.gz: e80049c2f3faa448c391ed4a8ebca5c272cf6fd7769b3f5e7ef61377746cd981df8fba5f1559023276b9aecdcec5852a9e235624b2da93d5c73bdbd2504d7947
+  metadata.gz: 59b14bced5193d9adf11e8886ebeb3399cd11e8823af0d2696525e63c5b92ee0422ed5e032b72f7cd0e9c96b0c7331aecd38f73528cd12578f907902d28d93e3
+  data.tar.gz: e7a402a040a4926aa7793e8bfff7d83db16e648c17b3bd46c5b9948cfda17d421e298bab4275900bf0de5a7b893908dd42034445335ca5fc014c246306008759

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_i18n/version.rb'
+  message: Bump SolidusI18n to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -1,20 +1,16 @@
+*.gem
 \#*
 *~
 .#*
 .DS_Store
 .idea
-.localeapp/locales
 .project
+.sass-cache
 coverage
-default
 Gemfile.lock
 tmp
 nbproject
 pkg
-*.sw?
+*.swp
 spec/dummy
-.rvmrc
-.sass-cache
-public/spree
-.ruby-version
-.ruby-gemset
+spec/examples.txt

data/.hound.yml

@@ -8,7 +8,7 @@ Style/Documentation:
   Enabled: false
 
 # Neatly aligned code is too swell.
-Style/SingleSpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Enabled: false
 
 # Don't mess with RSpec DSL.

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,7 +1,4 @@
----
-inherit_from: .hound.yml
+require:
+  - solidus_dev_support/rubocop
 
-AllCops:
-  Exclude:
-    - spec/dummy/**/*
-    - bin/*
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-01-24 11:23:54 +0100 using RuboCop version 0.76.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/solidus_i18n_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/solidus_i18n_spec.rb'

data/Gemfile

@@ -1,13 +1,31 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gemspec
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
 
-gem 'solidus', github: 'solidusio/solidus', branch: 'v1.0'
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
 
-if ENV['DB'] == 'mysql'
-  gem 'mysql2', '~> 0.3.20'
-elsif ENV['DB'] == 'postgres'
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
   gem 'pg'
 else
-  gem 'sqlite3', '~> 1.3.10'
+  gem 'sqlite3'
+end
+
+group :development, :test do
+  gem 'i18n-tasks', '~> 0.9' if branch == 'master'
 end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g.: `gem 'pry-debug'`.
+eval_gemfile 'Gemfile-local' if File.exist? 'Gemfile-local'

data/{LICENSE.md → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2015 Spree Commerce Inc., and other contributors.
+Copyright (c) 2011-2015 Spree Commerce Inc. and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -9,7 +9,7 @@ are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name Spree nor the names of its contributors may be used to
+    * Neither the name Solidus nor the names of its contributors may be used to
       endorse or promote products derived from this software without specific
       prior written permission.
 

data/README.md

@@ -1,42 +1,78 @@
 # 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)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_i18n.svg?style=svg)](https://circleci.com/gh/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)
 
 ---
 
+## Changes in Version 2.0
+
+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-filter` 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`
+## Locale in URL
 
-You can use the generator to install migrations and append solidus_i18n assets to
-your app solidus manifest file.
+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.
 
-    bin/rails g solidus_i18n:install
+1. Add this gem to your `Gemfile`, then run `bundle install`
 
-This will insert these lines into your Spree assets manifests:
+``` ruby
+gem 'routing-filter', '~> 0.6.0'
+```
 
-In `vendor/assets/javascripts/spree/frontend/all.js`
+2. Add `filter :locale` to your `config/routes.rb`
 
-```
-//= require spree/frontend/solidus_i18n
+``` ruby
+Rails.application.routes.draw do
+  filter :locale
+
+  mount Spree::Core::Engine, at: '/'
+end
 ```
 
-In `vendor/assets/javascripts/spree/backend/all.js`
+3. Configure routing-fitler in `config/initializers/locale_filter.rb` (optional)
 
-```
-//= require spree/backend/solidus_i18n
+``` ruby
+# Do not include the default locale in the URL
+RoutingFilter::Locale.include_default_locale = false
 ```
 
----
+## 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
+
+If you want to improve the translations on your language, run the tasks:
+
+    bundle exec rake solidus_i18n:update_default
+    bundle exec i18n-tasks add-missing --nil-value --locale <LOCALE>
+
+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
 
@@ -49,23 +85,21 @@ Please update your `Gemfile` if you still need the model translations.
 gem 'solidus_globalize', github: 'solidusio-contrib/solidus_globalize', branch: 'master'
 ```
 
----
-
-## Upgrading
+## Localizing country names
 
-**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**!
+You can translate country names by defining `spree.country_names` in your own locale files. For example, to have countries in Spanish do:
 
-### 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.
+```yml
+es:
+  spree:
+    country_names:
+      US: Estados Unidos de América
+      UK: Reino Unido
+      CA: Canadá
+      # ...
+```
 
+Some supported languages already define localized country names. Take a look at this repo's `.yml` files for your locale to confirm if we already provide translations.
 
 Contributing
 ------------

data/Rakefile

@@ -1,85 +1,22 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rubygems/package_task'
-require 'rspec/core/rake_task'
-require 'spree/testing_support/common_rake'
-require 'solidus_i18n'
-
-Bundler::GemHelper.install_tasks
-RSpec::Core::RakeTask.new
-
-task default: :spec
-
-spec = eval(File.read('solidus_i18n.gemspec'))
-
-Gem::PackageTask.new(spec) do |p|
-  p.gem_spec = spec
-end
+# frozen_string_literal: true
 
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'solidus_i18n'
-  Rake::Task['common:test_app'].invoke
-end
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
+require 'solidus_i18n'
 namespace :solidus_i18n do
   desc 'Update by retrieving the latest Solidus locale files'
-  task :update_default do
-    puts "Fetching latest Solidus locale file to #{locales_dir}"
-    require 'uri'
-    require 'net/https'
-
+  task update_default: :environment do
+    require 'open-uri'
+    puts 'Fetching latest Solidus locale file'
     location = 'https://raw.github.com/solidusio/solidus/master/core/config/locales/en.yml'
-    begin
-      uri = URI.parse(location)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      puts "Getting from #{uri}"
-      request = Net::HTTP::Get.new(uri.request_uri)
-      case response = http.request(request)
-      when Net::HTTPRedirection then location = response['location']
-      when Net::HTTPClientError, Net::HTTPServerError then response.error!
-      end
-    end until Net::HTTPSuccess == response
-
-    FileUtils.mkdir_p(default_dir) unless File.directory?(default_dir)
 
-    File.open("#{default_dir}/solidus_core.yml", 'w') { |file| file << response.body }
-  end
-
-  desc 'Syncronize translation files with latest en (adds comments with fallback en value)'
-  task :sync do
-    puts 'Starting syncronization...'
-    words = translation_keys
-
-    Dir["#{locales_dir}/*.yml"].each do |filename|
-      basename = File.basename(filename, '.yml')
-      (comments, other) = SolidusI18n::Utils.read_file(filename, basename)
-      # Initializing hash variable as en fallback if it does not exist
-      words.each { |k, _v| other[k] ||= "#{words[k]}" }
-      # Remove if not defined in en locale
-      other.delete_if { |k, _v| !words[k] }
-      SolidusI18n::Utils.write_file(filename, basename, comments, other, false)
-    end
-  end
-
-  def translation_keys
-    (dummy_comments, words) = SolidusI18n::Utils.read_file(File.dirname(__FILE__) + '/default/solidus_core.yml', 'en')
-      words
+    File.write("#{locales_dir}/en.yml", URI.parse(location).read)
   end
 
   def locales_dir
     File.join File.dirname(__FILE__), 'config/locales'
   end
-
-  def default_dir
-    File.join File.dirname(__FILE__), 'default'
-  end
-
-  def env_locale
-    ENV['LOCALE'].presence
-  end
 end
+
+task default: 'extension:specs'

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_i18n"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)