blacklight-locale_picker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17a822c82012ee32b19b4c03ccfd2e213cd050bd7e08d902e816e8e997d525ea
+  data.tar.gz: 452e5def5ab4cc417158e52236ebbbd4074b825f520a6f699672db8c00837c3f
+SHA512:
+  metadata.gz: 0456f053e837749f2c369119215f22fb492c245c2b9b739ae81e48bb414f7a93aa69538bd1af8392e854b0ed06e269efe6afc1a65f28e873e99fe875e2acab69
+  data.tar.gz: ccc0749116ec7960106507d169c77e564ea111d895fe566c2f889eeaa3fe6097c57402cbe3ff697e82a61a8a766112bc65951175386bc79371bad8c742b86857

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+
+.internal_test_app
+.rspec_status
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+notifications:
+  email: false
+rvm:
+  - 2.6.3
+jdk:
+  - oraclejdk9

data/Gemfile

@@ -0,0 +1,49 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in blacklight-locale_picker.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 2.3.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2019 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# Blacklight::LocalePicker
+A dropdown locale switcher for Blacklight apps
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blacklight-locale_picker'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install blacklight-locale_picker
+```
+
+And then run the install generator:
+```bash
+$ rails generate blacklight:locale_picker:install
+```
+## Configuration
+To add locales to your application, add an initializer.
+```
+Blacklight::LocalePicker::Engine.config.available_locales = [:en, :es]
+```

data/Rakefile

@@ -0,0 +1,46 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'engine_cart/rake_task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blacklight::LocalePicker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'solr_wrapper'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+require 'engine_cart/rake_task'
+
+task ci: ['engine_cart:generate'] do
+  ENV['environment'] = 'test'
+
+  SolrWrapper.wrap(port: '8983') do |solr|
+    solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path(File.dirname(__FILE__)), '.internal_test_app', 'solr', 'conf')) do
+      within_test_app do
+        system 'bundle install'
+        system 'bundle exec rake db:migrate'
+      end
+
+      # run the tests
+      Rake::Task['spec'].invoke
+    end
+  end
+end
+
+task default: :ci

data/app/controllers/concerns/blacklight/locale_picker/concern.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+##
+# A module to add set locales that is sent to application controller
+module Blacklight::LocalePicker::Concern
+  extend ActiveSupport::Concern
+  included do
+    before_action :set_locale
+
+    def default_url_options
+      { locale: (I18n.locale unless I18n.default_locale == I18n.locale) }
+    end
+
+    before_action do
+      blacklight_config.add_nav_action(:locale, partial: 'shared/locale_picker')
+    end
+
+    private
+
+    def set_locale
+      I18n.locale = params[:locale] || I18n.default_locale
+    end
+  end
+end

data/app/helpers/blacklight/locale_picker/locale_helper.rb

@@ -0,0 +1,30 @@
+# Helpers for building the locale picker
+module Blacklight::LocalePicker::LocaleHelper
+  # Locales to display in the locale picker; by default, it picks up
+  # the information from the engine configuration
+  def available_locales
+    Blacklight::LocalePicker::Engine.config.available_locales
+  end
+
+  # Returns the url for the current page in the new locale. This may be
+  # overridden in downstream applications where our naive use of `url_for`
+  # is insufficient to generate the expected routes
+  def current_page_for_locale(locale)
+    initial_exception = nil
+
+    ([self] + additional_locale_routing_scopes).each do |scope|
+      return scope.public_send(:url_for, locale: locale)
+    rescue ActionController::UrlGenerationError => e
+      initial_exception ||= e
+    end
+
+    raise initial_exception
+  end
+
+  # Returns an array of routing scopes (e.g. mounted engines) to attempt to use
+  # for switching locale-specific routes. This is likely overridden in complex
+  # applications to add scopes for additional mounted engines
+  def additional_locale_routing_scopes
+    [blacklight]
+  end
+end

data/app/views/shared/_locale_picker.html.erb

@@ -0,0 +1,18 @@
+<% if available_locales.many?  %>
+  <li class="nav-item dropdown">
+    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false" aria-controls="language-dropdown-menu">
+      <span class="sr-only"><%= t('blacklight.toolbar.language_switch') %></span>
+      <span><%= t("locales.#{I18n.locale}") %></span>
+      <b class="caret"></b>
+    </a>
+    <ul id="language-dropdown-menu" class="dropdown-menu" role="menu">
+      <li role="presentation" class="dropdown-header"><%= t('blacklight.toolbar.language_switch') %></li>
+      <li role="presentation" class="divider"></li>
+      <% available_locales.each do |locale| %>
+        <li role="presentation" lang="<%= locale %>">
+          <%= link_to t("locales.#{locale}"), current_page_for_locale(locale), class: 'dropdown-item' %>
+        </li>
+      <% end %>
+    </ul>
+  </li>
+<% end %>

data/blacklight-locale_picker.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "blacklight/locale_picker/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "blacklight-locale_picker"
+  spec.version     = Blacklight::LocalePicker::VERSION
+  spec.authors     = ["Camille Villa", "Chris Beer"]
+  spec.email       = ["cvilla100@gmail.com", "chris@cbeer.info"]
+  spec.homepage    = "https://github.com/projectblacklight/blacklight-locale_picker"
+  spec.summary     = ""
+  spec.description = ""
+  spec.license     = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "rails", "~> 5.2.3"
+
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "solr_wrapper"
+end

data/config/locales/locale_picker.en.yml

@@ -0,0 +1,12 @@
+en:
+  locales:
+    de: German
+    en: English
+    es: Spanish
+    fr: French
+    hu: Hungarian
+    it: Italian
+    nl: Dutch
+    pt-BR: Portuguese - Brazil
+    sq: Albanian
+    zh: Chinese

data/lib/blacklight/locale_picker.rb

@@ -0,0 +1,6 @@
+require "blacklight/locale_picker/engine"
+
+module Blacklight
+  module LocalePicker
+  end
+end

data/lib/blacklight/locale_picker/engine.rb

@@ -0,0 +1,11 @@
+module Blacklight
+  module LocalePicker
+    class Engine < ::Rails::Engine
+      config.available_locales = []
+
+      config.autoload_paths += %W(
+        #{config.root}/app/controllers/concerns
+      )
+    end
+  end
+end

data/lib/blacklight/locale_picker/version.rb

@@ -0,0 +1,5 @@
+module Blacklight
+  module LocalePicker
+    VERSION = '0.1.0'
+  end
+end

data/lib/generators/blacklight/locale_picker/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Blacklight::LocalePicker
+  ##
+  # Blacklight::LocalePicker install generator
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_locale_picker_to_controller
+      inject_into_file 'app/controllers/application_controller.rb', after: 'include Blacklight::Controller' do
+        "\n  include Blacklight::LocalePicker::Concern"
+      end
+    end
+
+    def add_locale_picker_helpers
+      inject_into_file 'app/helpers/application_helper.rb', after: 'module ApplicationHelper' do
+        "\n  include Blacklight::LocalePicker::LocaleHelper"
+      end
+    end
+  end
+end

data/lib/tasks/blacklight/locale_picker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :blacklight_locale_picker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: blacklight-locale_picker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Camille Villa
+- Chris Beer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: engine_cart
+  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: rspec-rails
+  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: rubocop
+  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: 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: solr_wrapper
+  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: ''
+email:
+- cvilla100@gmail.com
+- chris@cbeer.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/blacklight/locale_picker/concern.rb
+- app/helpers/blacklight/locale_picker/locale_helper.rb
+- app/views/shared/_locale_picker.html.erb
+- blacklight-locale_picker.gemspec
+- config/locales/locale_picker.en.yml
+- lib/blacklight/locale_picker.rb
+- lib/blacklight/locale_picker/engine.rb
+- lib/blacklight/locale_picker/version.rb
+- lib/generators/blacklight/locale_picker/install_generator.rb
+- lib/tasks/blacklight/locale_picker_tasks.rake
+homepage: https://github.com/projectblacklight/blacklight-locale_picker
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []