spree_mobility 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 022505f406f3f9336ed07f01f2e991a46d04d21fb8c6a8320dc4b3c79093b227
+  data.tar.gz: 4bd438df89aad4b7be914cf0e8e40b128b67ac70409d99bc5a775d0841d95a0a
+SHA512:
+  metadata.gz: db5144c00d20a57c15a5ce19de8b507d8cf56195ca5c1de4dcb554fb21f4127713fefbb4ed3e2817aa3be5b2335916c7b544e7d363929d5042e9c37622bf2313
+  data.tar.gz: 0cd224a84e281656efd79977715d2c688fa068ff846cea76b84f9a9506e77fb6adc1b09bc6ecf86d6e0ca51e92bbb5ce466a4c0e162745de2816e355b67dc9b2

data/.gitignore

@@ -0,0 +1,22 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+.bundle
+gemfiles/*.gemfile.lock

data/.hound.yml

@@ -0,0 +1,21 @@
+---
+# Too picky.
+LineLength:
+  Enabled: false
+
+# This should truly be on for well documented gems.
+Documentation:
+  Enabled: false
+
+# Neatly aligned code is too swell.
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Don't mess with RSpec DSL.
+Blocks:
+  Exclude:
+    - 'spec/**/*'
+
+# Avoid contradictory style rules by enforce single quotes.
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,7 @@
+---
+inherit_from: .hound.yml
+
+AllCops:
+  Exclude:
+    - spec/dummy/**/*
+    - bin/*

data/.travis.yml

@@ -0,0 +1,45 @@
+os: linux
+dist: bionic
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+services:
+  - mysql
+  - postgresql
+
+language: ruby
+
+rvm:
+  - 2.7
+
+env:
+  - DB=mysql
+  - DB=postgres
+
+gemfile:
+  - gemfiles/spree_4_2.gemfile
+  - gemfiles/spree_master.gemfile
+
+jobs:
+  allow_failures:
+    - gemfile: gemfiles/spree_master.gemfile
+
+before_script:
+  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
+  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
+  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
+  - unzip chromedriver_linux64.zip -d ~/bin
+  - nvm install 14
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec
+
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"

data/Appraisals

@@ -0,0 +1,8 @@
+appraise 'spree-4-2' do
+  gem 'spree', '~> 4.2.0.rc4'
+  gem 'spree_i18n', github: 'spree-contrib/spree_i18n'
+end
+
+appraise 'spree-master' do
+  gem 'spree', github: 'spree/spree', branch: 'master'
+end

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing
+
+Spree mobility is an open source project and we encourage contributions. Please see the [contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html) for more information before contributing.
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing [translations][3] (e.g. use branch 2-4-stable for Spree v2.4.x)
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+---
+
+## Filing an issue
+
+When filing an issue on this extension, please first do these things:
+
+* Verify you can reproduce this issue in a brand new application.
+* Run through the steps to reproduce the issue again.
+
+In the issue itself please provide:
+
+* A comprehensive list of steps to reproduce the issue.
+* What you're *expecting* to happen compared with what's *actually* happening.
+* The version of Spree *and* the version of Rails.
+* A list of all extensions.
+* Any relevant stack traces ("Full trace" preferred)
+* Your `Gemfile`
+
+In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+
+---
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new features to this extension.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
+
+3. Create new branch then make changes and add tests for your changes. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need tests!
+
+4. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+
+At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers.
+* Include tests that fail without your code, and pass with it.
+* Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution.
+
+---
+
+## TL;DR
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/dummy`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Ensure all syntax ok by running `rubocop .`
+* Submit your pull request
+
+And in case we didn't emphasize it enough: **we love tests!**
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree-contrib/spree_mobility/issues
+[3]: https://github.com/spree-contrib/spree_mobility/tree/master/config/locales

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'spree', '~> 4.3.1'
+gem 'spree_frontend', '~> 4.3.1'
+gem 'spree_backend', '~> 4.3.1'
+gem 'spree_i18n', github: 'spree-contrib/spree_i18n', branch: 'main'
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+group :red_green_refactor, halt_on_fail: true do
+
+  guard 'rspec', cmd: 'bundle exec rspec' do
+    watch('spec/spec_helper.rb')                       { 'spec' }
+    watch('config/routes.rb')                          { 'spec/controllers' }
+    watch(%r{^spec/(.+)_spec\.rb$})                    { |m| "spec/#{m[1]}_spec.rb"}
+    watch(%r{^app/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^app/(.*)(\.erb)$})                       { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+    watch(%r{^lib/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^app/controllers/(.+)_(controller)\.rb$}) { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+  end
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+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,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * 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
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,92 @@
+# Spree Mobility
+
+This is a Spree model translation gem based on `spree_globalize` for [Spree Commerce][1] version 4.3+.
+It uses `mobility` instead of `globalize`, since `globalize` is not actively developed anymore.
+It is a drop-in replacement for `spree_globalize` and will use your existing translations.
+
+## Improvements
+
+This gem offers several improvements over `spree_globalize`:
+
+* Proper translation fallbacks support (if a translation for the current locale is missing, it will fallback to other locales, strictly based on configured fallbacks):
+  * for finders (slug/permalink)
+  * when searching by product name (frontend & admin search)
+* Proper validations on translation models (e.g. slug presence validation), also meaning uniqueness validations will now work correctly per-locale
+* Better support for future versions of Rails as `mobility` is more actively maintained
+
+Admin:
+
+* Rich-text editor for product description translations in admin (if enabled)
+* Searching by product SKU in admin
+* Admin product search will no longer return duplicate results
+* Works correctly if using custom Spree.admin_path config
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'spree_i18n', '~> 5.0'
+gem 'friendly_id-mobility', github: 'mrbrdo/friendly_id-mobility', branch: 'master'
+gem 'spree_mobility'
+```
+
+Run `bundle install`
+
+You can use the generator to install migrations and append spree_mobility assets to
+your app spree manifest file.
+
+    rails g spree_mobility:install
+
+This will insert these lines into your spree manifest files:
+
+```
+vendor/assets/javascripts/spree/backend/all.js
+//= require spree/backend/spree_mobility
+```
+
+It is also recommended to configure Mobility fallback locales, especially if your admin locale is not the same as your Store's default_locale. For example if you have en and de locale:
+
+```
+# config/initializers/mobility.rb
+Mobility.configure do
+  plugins do
+    fallbacks({ :en => [:de], :de => [:en] })
+  end
+end
+```
+
+---
+
+## Model Translations
+
+This feature uses the [Mobility][3] gem to localize model data.
+So far the following models are translatable:
+
+    Product, Promotion, OptionType, Taxonomy, Taxon, Property, Store and ShippingMethod.
+
+Start your server and you should see a TRANSLATIONS link or a flag icon on each
+admin section that supports this feature.
+
+*Every record needs to have a translation. If by any chance you remove `spree_mobility`
+from your Gemfile, add some records and then add `spree_mobility` gem back you might get
+errors like ``undefined method for nilClass`` because Mobility will try fetch
+translations that do not exist.*
+
+---
+
+## Contributing
+
+[See corresponding guidelines][7]
+
+---
+
+Copyright (c) 2010-2022 MrBrdo. released under the [New BSD License][6]
+
+[1]: http://spreecommerce.org
+[2]: http://guides.spreecommerce.org/developer/i18n.html
+[3]: https://github.com/shioyama/mobility
+[5]: https://github.com/spree-contrib/spree_globalize/graphs/contributors
+[6]: https://github.com/mrbrdo/spree_mobility/blob/master/LICENSE.md
+[7]: https://github.com/mrbrdo/spree_mobility/blob/master/CONTRIBUTING.md
+[8]: https://github.com/spree-contrib/spree_i18n

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+spec = eval(File.read('spree_mobility.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_mobility'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_mobility.js

@@ -0,0 +1,2 @@
+//= require spree/backend
+//= require_tree .

data/app/assets/javascripts/spree/backend/taxon_tree_menu.js

@@ -0,0 +1,49 @@
+(function() {
+  var root;
+
+  root = typeof exports !== "undefined" && exports !== null ? exports : this;
+
+  root.taxon_tree_menu = function(obj, context) {
+    var admin_base_url, edit_url, id, translation_base_path, translation_url;
+    id = obj.attr("id");
+    admin_base_url = Spree.url(Spree.routes.admin_taxonomy_taxons_path);
+    edit_url = admin_base_url.clone();
+    edit_url.setPath(edit_url.path() + '/' + id + "/edit");
+    translation_url = Spree.url(admin_base_url.path().replace(/\/taxonomies\/\d.+$/, '') + '/taxons/' + id + '/translations');
+    return {
+      create: {
+        label: "<span class='icon icon-plus'></span> " + Spree.translations.add,
+        action: function(obj) {
+          return context.create(obj);
+        }
+      },
+      rename: {
+        label: "<span class='icon icon-pencil'></span> " + Spree.translations.rename,
+        action: function(obj) {
+          return context.rename(obj);
+        }
+      },
+      remove: {
+        label: "<span class='icon icon-trash'></span> " + Spree.translations.remove,
+        action: function(obj) {
+          return context.remove(obj);
+        }
+      },
+      edit: {
+        separator_before: true,
+        label: "<span class='icon icon-cog'></span> " + Spree.translations.edit,
+        action: function(obj) {
+          return window.location = edit_url.toString();
+        }
+      },
+      translate: {
+        separator_before: true,
+        label: "<span class='icon icon-flag'></span> " + Spree.translations.translations,
+        action: function(obj) {
+          return window.location = translation_url.toString();
+        }
+      }
+    };
+  };
+
+}).call(this);

data/app/assets/javascripts/spree/backend/translations.js

@@ -0,0 +1,50 @@
+(function() {
+  var display_locale_fields;
+
+  display_locale_fields = function() {
+    var attr, locale, locales, show, _fn, _i, _len;
+    attr = $('#attr_list a.active').data('attr');
+    locale = $('#locale').val();
+    available_locales = $('#available_locales').val().split(',');
+    show = $("select[name='show-only']").val();
+    $('#attr_fields .panel').hide();
+    _fn = function(locale) {
+      var display, value;
+      value = $('#attr_fields .panel.' + attr + '.' + locale + ' :input').val().replace(/^\s+|\s+$/g, "");
+      if (show === 'incomplete') {
+        display = value === '';
+      } else if (show === 'complete') {
+        display = value !== '';
+      } else {
+        display = true;
+      }
+      if (display) {
+        return $('#attr_fields .panel.' + attr + '.' + locale).show();
+      }
+    };
+    if (locale === '') {
+      available_locales.forEach(function(locale) { _fn(locale) });
+    } else {
+      _fn(locale);
+    }
+    if ($('#attr_fields .panel:visible').length === 0 && show !== 'all') {
+      return $('#attr_fields .no-translations').show();
+    }
+  };
+
+  $(function() {
+    $('#attr_list a').click(function() {
+      $('#attr_list a').removeClass('active');
+      $(this).addClass('active');
+      display_locale_fields();
+      return false;
+    });
+    $('#locale').change(function() {
+      return display_locale_fields();
+    });
+    return $("select[name='show-only']").change(function() {
+      return display_locale_fields();
+    });
+  });
+
+}).call(this);

data/app/controllers/concerns/spree_mobility/controller_mobility_helper.rb

@@ -0,0 +1,18 @@
+module SpreeMobility
+  # 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 ControllerMobilityHelper
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_action :mobility_fallbacks
+
+      private
+
+      def mobility_fallbacks
+        SpreeMobility::Fallbacks.config!
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/option_values_controller_decorator.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Admin
+    module OptionValuesControllerDecorator
+      def update
+        option_value = Spree::OptionValue.find(params[:id])
+        option_value.update update_option_value_attribute
+        redirect_to spree.edit_admin_option_type_path(option_value.option_type)
+      end
+
+      private
+
+      def update_option_value_attribute
+        params.require(:option_value).permit(permitted_params)
+      end
+
+      def permitted_params
+        Spree::PermittedAttributes.option_value_attributes
+      end
+    end
+  end
+end
+
+SpreeMobility.prepend_once(::Spree::Admin::OptionValuesController, Spree::Admin::OptionValuesControllerDecorator)

data/app/controllers/spree/admin/product_properties_controller_decorator.rb

@@ -0,0 +1,22 @@
+module Spree
+  module Admin
+    module ProductPropertiesControllerDecorator
+      def translate
+        product_property = Spree::ProductProperty.find(params[:id])
+        product_property.update update_product_property_attribute
+        redirect_to spree.admin_product_product_properties_path(product_property.product)
+      end
+
+      private
+      def update_product_property_attribute
+        params.require(:product_property).permit(permitted_params)
+      end
+
+      def permitted_params
+      [translations_attributes: [:id, :locale, :value]]
+      end
+    end
+  end
+end
+
+SpreeMobility.prepend_once(::Spree::Admin::ProductPropertiesController, Spree::Admin::ProductPropertiesControllerDecorator)

data/app/controllers/spree/admin/shipping_methods_controller_decorator.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Admin
+    module ShippingMethodsControllerDecorator
+      private
+      # We have to override those filters since they break proper PATCH behaviour.
+
+      def set_shipping_category
+        super unless params['shipping_method'][:translations_attributes]
+      end
+
+      def set_zones
+        super unless params['shipping_method'][:translations_attributes]
+      end
+    end
+  end
+end
+
+SpreeMobility.prepend_once(::Spree::Admin::ShippingMethodsController, Spree::Admin::ShippingMethodsControllerDecorator)

data/app/controllers/spree/admin/translations_controller.rb

@@ -0,0 +1,53 @@
+module Spree
+  class Admin::TranslationsController < Admin::BaseController
+    before_action :load_parent
+
+    if defined?(SpreeI18n::ControllerLocaleHelper)
+      helper 'spree_i18n/locale'
+    end
+    helper 'spree_mobility/locale'
+
+    helper_method :collection_url
+
+    def index
+      render resource_name
+    end
+
+    private
+
+    def load_parent
+      set_resource_ivar(resource)
+    end
+
+    def resource_name
+      params[:resource].singularize
+    end
+
+    def set_resource_ivar(resource)
+      instance_variable_set("@#{resource_name}", resource)
+    end
+
+    def klass
+      @klass ||= "Spree::#{params[:resource].classify}".constantize
+    end
+
+    def resource
+      @resource ||= if slugged_models.include? klass.name
+        klass.friendly.find(params[:resource_id])
+      else
+        klass.find(params[:resource_id])
+      end
+    end
+
+    def collection_url
+      ActionController::Routing::Routes.recognize_path("admin_#{resource_name}_url", @resource)
+      send "admin_#{resource_name}_url", @resource
+    rescue
+      send "edit_admin_#{resource_name}_url", @resource
+    end
+
+    def slugged_models
+      ["Spree::Product"]
+    end
+  end
+end

data/app/controllers/spree/api/base_controller_decorator.rb

@@ -0,0 +1,5 @@
+module Spree::Api::BaseControllerDecorator
+  Spree::Api::BaseController.include(SpreeMobility::ControllerMobilityHelper)
+end
+
+SpreeMobility.prepend_once(::Spree::Api::BaseController, Spree::Api::BaseControllerDecorator)

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,5 @@
+module Spree::BaseControllerDecorator
+  Spree::BaseController.include(SpreeMobility::ControllerMobilityHelper)
+end
+
+SpreeMobility.prepend_once(::Spree::BaseController, Spree::BaseControllerDecorator)

data/app/helpers/spree_mobility/locale_helper.rb

@@ -0,0 +1,11 @@
+module SpreeMobility
+  module LocaleHelper
+    def select_available_locales_fields
+      select_tag(
+        'locale',
+        options_for_select(available_locales_options, nil),
+        { include_blank: Spree.t(:all), class: 'select2' }
+      )
+    end
+  end
+end