turnout 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e23a0f9e95613f840f72654c2250f0a2f32bcb4
-  data.tar.gz: 5a9906f6096a154d0e46ce9c1a2bc466a75ad403
+  metadata.gz: c4ae8144b28714433ab814cb9604ed7e4eb82d5c
+  data.tar.gz: c2b3041f66b67b9e446067657818a15bbd396d3d
 SHA512:
-  metadata.gz: c3be20dedbee8b73ee09e2822697869b0ba22b3f1c2ee5c13f8ab66e6b39cf72fa3525b1546e805ca9967f591a3ec8ec633934fb767c74b694680ee78c78a1b3
-  data.tar.gz: 91df6435f2030872f014e45b8ea54653e213d35d70a58f577147faa9aebf36a95fc4c58234dde15144d0f5e3072bac822d15d7423afa50490eadadc22066fcde
+  metadata.gz: b5c5a40abcc33d99d789d3c4dfe115da5a571c9ac07bf8ae627d18f030934044e83d1931281b48bc60b5dbfe9afd50ac9642549fdd69506090ade13fbbc25171
+  data.tar.gz: ecda16629ec28698fb40318aa156e9a4511c96f0482c8d60ff15f6f4d9c81c1dd8c57ddc3233aabe96b1fe5f116096bd05a3b31d863a5802b3c62f65fb70b381

data/README.md

@@ -1,4 +1,4 @@
-Turnout [![Build Status](https://travis-ci.org/biola/turnout.png?branch=master)](https://travis-ci.org/biola/turnout) [![Code Climate](https://codeclimate.com/github/biola/turnout.png)](https://codeclimate.com/github/biola/turnout)
+Turnout [![Build Status](https://travis-ci.org/biola/turnout.svg?branch=master)](https://travis-ci.org/biola/turnout) [![Code Climate](https://codeclimate.com/github/biola/turnout.svg)](https://codeclimate.com/github/biola/turnout) [![Gem Version](https://badge.fury.io/rb/turnout.svg)](https://badge.fury.io/rb/turnout)
 =======
 Turnout is [Rack](http://rack.rubyforge.org/) middleware with a [Ruby on Rails](http://rubyonrails.org) engine that allows you to easily put your app in maintenance mode.
 
@@ -151,14 +151,23 @@ The source code of any custom maintenance files you created in the `/public` dir
 Tips
 ====
 
+Denied Paths
+--------------
 There is no `denied_paths` feature because turnout denies everything by default.
 However you can achieve the same sort of functionality by using
 [negative lookaheads](http://www.regular-expressions.info/lookaround.html) with the `allowed_paths` setting, like so:
 
     rake maintenance:start allowed_paths="^(?!/your/under/maintenance/path)"
 
+Multi-App Maintenance
+------------------------
 A central `named_maintenance_file_path` can be configured in all your apps such as `/tmp/turnout.yml` so that all apps on a server can be put into mainteance mode at once. You could even configure service based paths such as `/tmp/mongodb_maintenance.yml` so that all apps using MongoDB could be put into maintenance mode.
 
+Detecting Maintenance Mode
+-------------------------------
+
+If you'd like to detect if maintenance mode is on in your app (for those users or pages that aren't blocked) just call `!Turnout::MaintenanceFile.find.nil?`.
+
 Behind the Scenes
 =================
 On every request the Rack app will check to see if `tmp/maintenance.yml` exists. If the file exists the maintenance page will be shown (unless allowed IPs are given and the requester is in the allowed range).

data/lib/turnout/configuration.rb

@@ -1,8 +1,9 @@
+require_relative './ordered_options'
 module Turnout
   class Configuration
     SETTINGS = [:app_root, :named_maintenance_file_paths,
       :maintenance_pages_path, :default_maintenance_page, :default_reason,
-      :default_allowed_paths, :default_response_code, :default_retry_after]
+      :default_allowed_paths, :default_response_code, :default_retry_after, :i18n]
 
     SETTINGS.each do |setting|
       attr_accessor setting
@@ -17,6 +18,12 @@ module Turnout
       @default_allowed_paths = []
       @default_response_code = 503
       @default_retry_after = 7200 # 2 hours by default
+      @i18n = Turnout::OrderedOptions.new
+      @i18n.railties_load_path = []
+      @i18n.load_path = []
+      @i18n.fallbacks = Turnout::OrderedOptions.new
+      @i18n.enabled = false
+      @i18n.use_language_header = false
     end
 
     def app_root

data/lib/turnout/i18n/accept_language_parser.rb

@@ -0,0 +1,109 @@
+module Turnout
+  class AcceptLanguageParser
+    attr_accessor :header
+
+    def initialize(header)
+      @header = header
+    end
+
+    # Returns a sorted array based on user preference in HTTP_ACCEPT_LANGUAGE.
+    # Browsers send this HTTP header, so don't think this is holy.
+    #
+    # Example:
+    #
+    #   request.user_preferred_languages
+    #   # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
+    #
+    def user_preferred_languages
+      return [] if header.to_s.strip.empty?
+      @user_preferred_languages ||= begin
+        header.to_s.gsub(/\s+/, '').split(',').map do |language|
+          locale, quality = language.split(';q=')
+          raise ArgumentError, 'Not correctly formatted' unless locale =~ /^[a-z\-0-9]+|\*$/i
+
+          locale  = locale.downcase.gsub(/-[a-z0-9]+$/i, &:upcase) # Uppercase territory
+          locale  = nil if locale == '*' # Ignore wildcards
+
+          quality = quality ? quality.to_f : 1.0
+
+          [locale, quality]
+        end.sort do |(_, left), (_, right)|
+          right <=> left
+        end.map(&:first).compact
+      rescue ArgumentError # Just rescue anything if the browser messed up badly.
+        []
+      end
+    end
+
+    # Sets the user languages preference, overriding the browser
+    #
+    def user_preferred_languages=(languages)
+      @user_preferred_languages = languages
+    end
+
+    # Finds the locale specifically requested by the browser.
+    #
+    # Example:
+    #
+    #   request.preferred_language_from I18n.available_locales
+    #   # => 'nl'
+    #
+    def preferred_language_from(array)
+      (user_preferred_languages & array.map(&:to_s)).first
+    end
+
+    # Returns the first of the user_preferred_languages that is compatible
+    # with the available locales. Ignores region.
+    #
+    # Example:
+    #
+    #   request.compatible_language_from I18n.available_locales
+    #
+    def compatible_language_from(available_languages)
+      user_preferred_languages.map do |preferred| #en-US
+        preferred = preferred.downcase
+        preferred_language = preferred.split('-', 2).first
+
+        available_languages.find do |available| # en
+          available = available.to_s.downcase
+          preferred == available || preferred_language == available.split('-', 2).first
+        end
+      end.compact.first
+    end
+
+    # Returns a supplied list of available locals without any extra application info
+    # that may be attached to the locale for storage in the application.
+    #
+    # Example:
+    # [ja_JP-x1, en-US-x4, en_UK-x5, fr-FR-x3] => [ja-JP, en-US, en-UK, fr-FR]
+    #
+    def sanitize_available_locales(available_languages)
+      available_languages.map do |available|
+        available.to_s.split(/[_-]/).reject { |part| part.start_with?("x") }.join("-")
+      end
+    end
+
+    # Returns the first of the user preferred languages that is
+    # also found in available languages.  Finds best fit by matching on
+    # primary language first and secondarily on region.  If no matching region is
+    # found, return the first language in the group matching that primary language.
+    #
+    # Example:
+    #
+    #   request.language_region_compatible(available_languages)
+    #
+    def language_region_compatible_from(available_languages)
+      available_languages = sanitize_available_locales(available_languages)
+      user_preferred_languages.map do |preferred| #en-US
+        preferred = preferred.downcase
+        preferred_language = preferred.split('-', 2).first
+
+        lang_group = available_languages.select do |available| # en
+          preferred_language == available.downcase.split('-', 2).first
+        end
+
+        lang_group.find { |lang| lang.downcase == preferred } || lang_group.first #en-US, en-UK
+      end.compact.first
+    end
+  end
+end

data/lib/turnout/i18n/internationalization.rb

@@ -0,0 +1,141 @@
+require 'i18n'
+require 'i18n/backend/fallbacks'
+require_relative './accept_language_parser'
+require_relative '../ordered_options'
+
+module Turnout
+  class Internationalization
+    class << self
+      attr_reader :env
+      attr_writer :env
+
+      def initialize_i18n(env)
+        @env = env
+        setup_i18n_config
+      end
+
+      def i18n_config
+        @i18n_config = Turnout.config.i18n
+        @i18n_config =  @i18n_config.is_a?(Turnout::OrderedOptions) ? @i18n_config : Turnout::InheritableOptions.new(@i18n_config)
+      end
+
+      def turnout_page
+        @turnout_page ||= Turnout.config.default_maintenance_page
+      end
+
+      def http_accept_language
+        language = (env.nil? || env.empty?) ? nil : env["HTTP_ACCEPT_LANGUAGE"]
+        @http_accept_language ||= Turnout::AcceptLanguageParser.new(language)
+      end
+
+      def setup_additional_helpers
+        i18n_additional_helpers = i18n_config.delete(:additional_helpers)
+        i18n_additional_helpers = i18n_additional_helpers.is_a?(Array) ? i18n_additional_helpers : []
+
+        i18n_additional_helpers.each do |helper|
+          turnout_page.send(:include, helper) if helper.is_a?(Module)
+        end
+      end
+
+      def expanded(path)
+        result = []
+        if File.directory?(path)
+          result.concat(Dir.glob(File.join(path, '**', '**')).map { |file| file }.sort)
+        else
+          result << path
+        end
+        result.uniq!
+        result
+      end
+
+      # Returns all expanded paths but only if they exist in the filesystem.
+      def existent(path)
+        expanded(path).select { |f| File.exist?(f) }
+      end
+
+      # Setup i18n configuration.
+      def setup_i18n_config
+        return unless i18n_config.enabled
+        setup_additional_helpers
+        fallbacks = i18n_config.delete(:fallbacks)
+
+
+        # Avoid issues with setting the default_locale by disabling available locales
+        # check while configuring.
+        enforce_available_locales = i18n_config.delete(:enforce_available_locales)
+        enforce_available_locales = I18n.enforce_available_locales if enforce_available_locales.nil?
+        I18n.enforce_available_locales = false
+
+        i18n_config.except(:enabled, :use_language_header).each do |setting, value|
+          case setting
+          when :railties_load_path
+            I18n.load_path.unshift(*value.map { |file| existent(file) }.flatten)
+          when :load_path
+            I18n.load_path += value
+          else
+            I18n.send("#{setting}=", value)
+          end
+        end
+
+
+        init_fallbacks(fallbacks) if fallbacks && validate_fallbacks(fallbacks)
+        I18n.backend.load_translations
+
+        # Restore available locales check so it will take place from now on.
+        I18n.enforce_available_locales = enforce_available_locales
+
+        begin
+          if i18n_config.use_language_header
+            I18n.locale = http_accept_language.compatible_language_from(I18n.available_locales) || I18n.default_locale
+          else
+            I18n.locale = I18n.default_locale
+          end
+        rescue
+          #nothing
+        end
+
+      end
+
+      def array_wrap(object)
+        if object.nil?
+          []
+        elsif object.respond_to?(:to_ary)
+          object.to_ary || [object]
+        else
+          [object]
+        end
+      end
+
+      def include_fallbacks_module
+        I18n.backend.class.send(:include, I18n::Backend::Fallbacks)
+      end
+
+      def init_fallbacks(fallbacks)
+        include_fallbacks_module
+
+        args = case fallbacks
+        when Turnout::OrderedOptions
+          [*(fallbacks[:defaults] || []) << fallbacks[:map]].compact
+        when Hash, Array
+          array_wrap(fallbacks)
+        else # TrueClass
+          []
+        end
+
+        I18n.fallbacks = I18n::Locale::Fallbacks.new(*args)
+      end
+
+      def validate_fallbacks(fallbacks)
+        case fallbacks
+        when Turnout::OrderedOptions
+          !fallbacks.empty?
+        when TrueClass, Array, Hash
+          true
+        else
+          raise "Unexpected fallback type #{fallbacks.inspect}"
+        end
+      end
+
+    end
+  end
+end

data/lib/turnout/maintenance_page/erb.rb

@@ -2,17 +2,21 @@ require 'erb'
 require 'tilt'
 require 'tilt/erb'
 require_relative './html'
+require_relative '../i18n/internationalization'
+
 module Turnout
   module MaintenancePage
     class Erb < Turnout::MaintenancePage::HTML
 
       def content
+        Turnout::Internationalization.initialize_i18n(@options[:env])
         Tilt.new(File.expand_path(path)).render(self, {reason: reason}.merge(@options))
       end
-
+      
       def self.extension
         'html.erb'
       end
+
     end
   end
 end

data/lib/turnout/ordered_options.rb

@@ -0,0 +1,98 @@
+module Turnout
+  class OrderedOptions < Hash
+    alias_method :_get, :[] # preserve the original #[] method
+    protected :_get # make it protected
+
+    def initialize(constructor = {}, &block)
+      if constructor.respond_to?(:to_hash)
+        super()
+        update(constructor, &block)
+        hash = constructor.to_hash
+
+        self.default = hash.default if hash.default
+        self.default_proc = hash.default_proc if hash.default_proc
+      else
+        super()
+      end
+    end
+
+    def update(other_hash)
+      if other_hash.is_a? Hash
+        super(other_hash)
+      else
+        other_hash.to_hash.each_pair do |key, value|
+          if block_given?
+            value = yield(key, value)
+          end
+          self[key] = value
+        end
+        self
+      end
+    end
+
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+
+    def [](key)
+      super(key.to_sym)
+    end
+
+    def method_missing(name, *args)
+      name_string = name.to_s
+      if name_string.chomp!('=')
+        self[name_string] = args.first
+      else
+        bangs = name_string.chomp!('!')
+
+        if bangs
+          value = fetch(name_string.to_sym)
+          raise(RuntimeError.new("#{name_string} is blank.")) if value.nil? || value.empty?
+          value
+        else
+          self[name_string]
+        end
+      end
+    end
+
+    def except(*keys)
+      dup.except!(*keys)
+    end
+
+    def except!(*keys)
+      keys.each { |key| delete(key) }
+      self
+    end
+
+
+    def respond_to_missing?(name, include_private)
+      true
+    end
+  end
+
+
+  # +InheritableOptions+ provides a constructor to build an +OrderedOptions+
+  # hash inherited from another hash.
+  #
+  # Use this if you already have some hash and you want to create a new one based on it.
+  #
+  #   h = ActiveSupport::InheritableOptions.new({ girl: 'Mary', boy: 'John' })
+  #   h.girl # => 'Mary'
+  #   h.boy  # => 'John'
+  class InheritableOptions < Turnout::OrderedOptions
+    def initialize(parent = nil)
+      if parent.kind_of?(Turnout::OrderedOptions)
+        # use the faster _get when dealing with OrderedOptions
+        super(parent) {|key,value| parent._get(key) }
+      elsif parent
+        super(parent) { |key, value| parent[key] }
+      else
+        super(parent)
+      end
+    end
+
+    def inheritable_copy
+      self.class.new(self)
+    end
+  end
+end

data/lib/turnout/version.rb

@@ -1,3 +1,3 @@
 module Turnout
-  VERSION = '2.3.1'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnout
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-21 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -34,16 +34,22 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-accept
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +120,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov-summary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 description: Turnout makes it easy to put your Rails application into maintenance
   mode
 email: adam@codenoble.com
@@ -114,12 +174,15 @@ files:
 - lib/turnout.rb
 - lib/turnout/configuration.rb
 - lib/turnout/engine.rb
+- lib/turnout/i18n/accept_language_parser.rb
+- lib/turnout/i18n/internationalization.rb
 - lib/turnout/maintenance_file.rb
 - lib/turnout/maintenance_page.rb
 - lib/turnout/maintenance_page/base.rb
 - lib/turnout/maintenance_page/erb.rb
 - lib/turnout/maintenance_page/html.rb
 - lib/turnout/maintenance_page/json.rb
+- lib/turnout/ordered_options.rb
 - lib/turnout/rake_tasks.rb
 - lib/turnout/request.rb
 - lib/turnout/version.rb
@@ -151,3 +214,4 @@ signing_key:
 specification_version: 4
 summary: A Rack based maintenance mode plugin for Rails
 test_files: []
+has_rdoc: