text_helpers 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b830f91668677103c3ef206b9921ee1b22002f38
-  data.tar.gz: b8083debf8108e5a2aabbb006a3a714d8ccd7326
+  metadata.gz: 5996591783903a77aa42bf6661456c457408b437
+  data.tar.gz: 290c4f04de2c35b257dfeabcf7a3fa3044b106ad
 SHA512:
-  metadata.gz: 775485ba26237b01b0b037517fd2a684d4c409a197bb7e30a87e2c760d40ac390e9810f241c7cc546487326bbefc7cceff3c10932bdefc767f9499a873c8ea8d
-  data.tar.gz: 3c3d7e67185f1f54e3a6a8afc6281f1c492214a739fda44e6a3d9e6f51efde7d3cccd291709e535aa3fd6a9cce05207338b59d0e1ce698e6e385858156f4fd2a
+  metadata.gz: 33242fb49efb10f6c229d2acc44e361e371ae548d61a017030c40a7085822b1613e1693cabadadedc01813cdbf2a116456acbde9287728056b7b179920d2a785
+  data.tar.gz: 6b6f8d31bf1b5b04cee1ddb5b0498d8c62c26caade7ac35f0e5e3e5992eb67be6fa8d54751807308585e68a7b6da39efcea22c40d76fefcc3ef26dff780face1

data/.gitignore

@@ -18,4 +18,5 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+log
 tmp

data/README.md

@@ -90,3 +90,40 @@ specs by adding `view: true` to the spec metadata.
 
 The controller text helpers described above can be accessed in controller
 specs by adding `controller: true` to your spec metadata.
+
+## Configuration & Initialization
+
+### Initialization
+
+`TextHelpers` performs some setup during your application's initialization. Four
+initializers are installed:
+
+#### `text_helpers.action_view.extend_base`
+
+This initializer includes the `TextHelpers::Translation` module into
+`ActionView::Base` and adds an appropriate `#translation_scope` method.
+
+#### `text_helpers.action_mailer.extend_base`
+
+This initializer includes the `TextHelpers::Translation` module into
+`ActionMailer::Base` and adds an appropriate `#translation_scope` method.
+
+#### `text_helpers.action_controller.extend_base`
+
+This initializer includes the `TextHelpers::Translation` module into
+`ActionController::Base` and adds an appropriate `#translation_scope` method.
+
+#### `text_helpers.setup_exception_handling`
+
+This initializer configures exception handling so that exceptions are raised
+if `config.text_helpers.raise_on_missing_translations` is set to `true`, which
+it is by default in the `test` or `development` environments.
+
+### Configuration
+
+#### `config.text_helpers.raise_on_missing_translations`
+
+This configuration value defaults to `true` in `test` or `development`
+environments. If set to `false`, your own exception handling can be configured
+by setting `config.action_view.raise_on_missing_translations` and
+`I18n.exception_handler` as appropriate.

data/Rakefile

@@ -5,3 +5,5 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
 end
+
+task default: :test

data/lib/text_helpers/railtie.rb

@@ -1,15 +1,13 @@
 module TextHelpers
-
   class Railtie < Rails::Railtie
+    config.text_helpers = ActiveSupport::OrderedOptions.new
+    config.text_helpers.raise_on_missing_translations = Rails.env.test? || Rails.env.development?
 
-    initializer "text_helpers.configure_rails_initialization" do
-
-      class ActionView::Base
+    initializer "text_helpers.action_view.extend_base" do
+      ActionView::Base.class_eval do
         include TextHelpers::Translation
 
-        protected
-
-        # Protected: Derive a translation scope from the current view template.
+        # Public: Derive a translation scope from the current view template.
         #
         # Determines an I18n-friendly scope for the current view file when possible,
         # or falls back to "views.<controller>.<action>"
@@ -27,13 +25,13 @@ module TextHelpers
           end
         end
       end
+    end
 
-      class ActionMailer::Base
+    initializer "text_helpers.action_mailer.extend_base" do
+      ActionMailer::Base.class_eval do
         include TextHelpers::Translation
 
-        protected
-
-        # Protected: Provides a scope for I18n lookups.
+        # Public: Provides a scope for I18n lookups.
         #
         # Should look like `mailers.<mailer>.<action>`
         #
@@ -42,13 +40,13 @@ module TextHelpers
           "mailers.#{mailer_name.tr("/", ".").sub("_mailer", "")}.#{action_name}"
         end
       end
+    end
 
-      class ActionController::Base
+    initializer "text_helpers.action_controller.extend_base" do
+      ActionController::Base.class_eval do
         include TextHelpers::Translation
 
-        protected
-
-        # Protected: Provides a scope for I18n lookups.
+        # Public: Provides a scope for I18n lookups.
         #
         # Should look like `controllers.<controller_name>`.
         #
@@ -58,5 +56,15 @@ module TextHelpers
         end
       end
     end
+
+    initializer "text_helpers.setup_exception_handling", after: 'after_initialize' do
+      next unless config.text_helpers.raise_on_missing_translations
+
+      if config.respond_to?(:action_view)
+        config.action_view.raise_on_missing_translations = true
+      end
+
+      TextHelpers.install_i18n_exception_handler
+    end
   end
 end

data/lib/text_helpers/version.rb

@@ -1,3 +1,3 @@
 module TextHelpers
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/text_helpers.rb

@@ -2,4 +2,29 @@ require "text_helpers/version"
 require "text_helpers/translation"
 require "text_helpers/railtie" if defined?(Rails)
 
-module TextHelpers; end
+module TextHelpers
+  # RaiseExceptionHandler just raises all exceptions, rather than swallowing
+  # MissingTranslation ones. It's cribbed almost verbatim from
+  # http://edgeguides.rubyonrails.org/i18n.html#customize-your-i18n-setup.
+  class RaiseExceptionHandler < I18n::ExceptionHandler
+    def call(exception, locale, key, options)
+      if exception.is_a?(I18n::MissingTranslation)
+        raise exception.to_exception
+      else
+        super
+      end
+    end
+  end
+
+  # Public: Install an instance of TextHelpers::RaiseExceptionHandler as the
+  # default I18n exception handler.
+  #
+  # Returns the handler instance.
+  def self.install_i18n_exception_handler
+    if I18n.exception_handler
+      Rails.logger.warn("Overwriting existing I18n exception handler")
+    end
+
+    I18n.exception_handler = RaiseExceptionHandler.new
+  end
+end

data/test/lib/text_helpers/railtie_test.rb

@@ -0,0 +1,117 @@
+require_relative '../../test_helper'
+
+require 'active_support'
+require 'rails'
+require 'rails/railtie'
+require 'rails/application'
+require 'text_helpers/railtie'
+
+describe TextHelpers::Railtie do
+  include StubHelpers
+
+  let(:railtie) { TextHelpers::Railtie }
+  let(:action_view_base) { Class.new }
+  let(:action_mailer_base) { Class.new }
+  let(:action_controller_base) { Class.new }
+
+  let(:app) do
+    Class.new(Rails::Application) do
+      config.eager_load = false
+
+      self
+    end
+  end
+
+  let(:stub_resets) do
+    []
+  end
+
+  before do
+    stub_resets << stub_nested_const(TextHelpers::Railtie, "ActionView::Base", action_view_base)
+    stub_resets << stub_nested_const(TextHelpers::Railtie, "ActionMailer::Base", action_mailer_base)
+    stub_resets << stub_nested_const(TextHelpers::Railtie, "ActionController::Base", action_controller_base)
+
+    app.initialize!
+  end
+
+  after do
+    stub_resets.reverse.map(&:call)
+  end
+
+  describe "ActionView::Base extensions" do
+    it "includes TextHelpers::Translation" do
+      assert_includes(action_view_base.included_modules, TextHelpers::Translation)
+    end
+
+    describe "#translation_scope" do
+      let(:action_view_base) do
+        Class.new do
+          attr_accessor :virtual_path, :params
+        end
+      end
+
+      let(:view_instance) { action_view_base.new }
+
+      it "is based on the view virtual path if a matching path is present" do
+        view_instance.virtual_path = 'foo/bar/_some_view.html.haml'
+        assert_equal('views.foo.bar.some_view', view_instance.translation_scope)
+      end
+
+      it "is based on the controller and action name with a non-matching virtual path" do
+        view_instance.virtual_path = 'this-wont-match-at-all'
+        view_instance.params = {controller: "a_controller", action: "an_action"}
+        assert_equal('views.a_controller.an_action', view_instance.translation_scope)
+      end
+
+      it "is based on the controller and action name with no virtual path" do
+        view_instance.virtual_path = nil
+        view_instance.params = {controller: "a_controller", action: "an_action"}
+        assert_equal('views.a_controller.an_action', view_instance.translation_scope)
+      end
+    end
+  end
+
+  describe "ActionMailer::Base extensions" do
+    it "includes TextHelpers::Translation" do
+      assert_includes(action_mailer_base.included_modules, TextHelpers::Translation)
+    end
+
+    describe "#translation_scope" do
+      let(:action_mailer_base) do
+        Class.new do
+          attr_accessor :mailer_name, :action_name
+        end
+      end
+
+      let(:mailer_instance) { action_mailer_base.new }
+
+      it "is based on the mailer name and action" do
+        mailer_instance.mailer_name = "foo/bar/baz_mailer"
+        mailer_instance.action_name = "notification_message"
+        assert_equal('mailers.foo.bar.baz.notification_message', mailer_instance.translation_scope)
+      end
+    end
+  end
+
+  describe "ActionController::Base extensions" do
+    it "includes TextHelpers::Translation" do
+      assert_includes(action_mailer_base.included_modules, TextHelpers::Translation)
+    end
+
+    describe "#translation_scope" do
+      let(:action_mailer_base) do
+        Class.new do
+          attr_accessor :mailer_name, :action_name
+        end
+      end
+
+      let(:mailer_instance) { action_mailer_base.new }
+
+      it "is based on the mailer name and action" do
+        mailer_instance.mailer_name = "foo/bar/baz_mailer"
+        mailer_instance.action_name = "notification_message"
+        assert_equal('mailers.foo.bar.baz.notification_message', mailer_instance.translation_scope)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,4 +1,59 @@
 require 'minitest/autorun'
 require File.expand_path('../../lib/text_helpers.rb', __FILE__)
 
+module StubHelpers
+
+  # Public: Stub a constant down a nested module path.
+  #
+  # target      - A target Class or Module to stub a constant on.
+  # module_path - A path to a constant, like "Foo::Bar::Baz".
+  # stub        - The stub value to return.
+  #
+  # Yields a block during which the stub is in place.
+  # Returns a Proc that can be called to reset the stub, if no block was given.
+  def stub_nested_const(target, module_path, stub)
+    module_names = module_path.split("::")[0..-1]
+
+    # Save original values
+    _, *original_values = module_names.inject([target]) do |collected, module_name|
+      last_module = collected.last
+      break(collected) unless last_module.const_defined?(module_name, false)
+
+      collected.push(last_module.const_get(module_name, false))
+    end
+
+    # Stub new values
+    *chain, last = module_names
+
+    last_stubbed = chain.inject(target) do |t, module_name|
+      module_value = if t.const_defined?(module_name, false)
+                       t.const_get(module_name, false)
+                     else
+                       Module.new
+                     end
+
+      t.const_set(module_name, module_value)
+    end
+
+    last_stubbed.const_set(last, stub)
+
+    # Reset values
+    reset_block = lambda do
+      unset_last = original_values.length != module_names.length
+
+      last_target = original_values.zip(module_names).inject(target) do |t, (value, name)|
+        t.const_set(name, value)
+      end
+
+      if unset_last
+        last_target.send(:remove_const, module_names[original_values.length])
+      end
+    end
+
+    block_given? ? yield : reset_block
+  ensure
+    reset_block.call if block_given?
+  end
+end
+
 I18n.enforce_available_locales = false

data/text_helpers.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency("activesupport")
   gem.add_dependency("i18n", ">=0.6.8")
   gem.add_dependency("redcarpet")
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("railties")
 end

metadata

@@ -1,55 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: text_helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.8
 - !ruby/object:Gem::Dependency
   name: redcarpet
   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: rake
+  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: railties
+  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: Easily fetch text and static content from your locales
@@ -59,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -69,6 +97,7 @@ files:
 - lib/text_helpers/railtie.rb
 - lib/text_helpers/translation.rb
 - lib/text_helpers/version.rb
+- test/lib/text_helpers/railtie_test.rb
 - test/lib/text_helpers/translation_test.rb
 - test/lib/text_helpers/version_test.rb
 - test/test_helper.rb
@@ -83,23 +112,24 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: TextHelpers is a gem which supplies some basic utilities for text localization
   in Rails projects.  The library is intended to make it simple to keep your application's
   static and semi-static text content independent of the view structure.
 test_files:
+- test/lib/text_helpers/railtie_test.rb
 - test/lib/text_helpers/translation_test.rb
 - test/lib/text_helpers/version_test.rb
 - test/test_helper.rb