text_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307f8ef83a7eb8077ed118ef2bf734a50928a154
+  data.tar.gz: 310ecdda9460282480f1aa0b4631b2ab34959d82
+SHA512:
+  metadata.gz: d74b813995973bbd20a31e896de3da1d0591a78149af78f9aca8520ea9eaf84111b6c9493ea6617751b2605bea2eb8cb09f1faf4719374222a5df8e51942a106
+  data.tar.gz: 5d076830d152a39124937a218916066838ac3c16f6a77670ee4655dee9bdbffc2f0562b97187cbc9692bfc3b809e7d70c50273ec14329f6d3faef1f141cecc57

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lists-constant.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Horner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# TextHelpers
+
+`TextHelpers` is a library intended to make working with static text in Rails 
+projects as painless as possible.
+
+Include it in your `Gemfile` with:
+
+```
+gem "text_helpers"
+```
+
+## Suggested Use
+
+All static text should be placed in locale files, in a directory 
+structure mirroring the app directory structure. The text for 
+`app/views/some/_partial.html.haml` would go in 
+`config/locales/views/some/partial.en.yml`, for example. This is not a strict
+requirement, but will go a long way toward keeping your locales easily
+maintainable.
+
+In any locale file entry, you can reference another key in the locale file by
+using the syntax `!scope.to.key!`. For the sake of maintainability, the use of
+this interpolation should be restricted to small fragments of highly-recycled 
+static values. `I18n`'s built-in `%{value}` interpolation can be used for 
+variable text.
+
+### In Views
+
+To access this text in views, two helpers are available, `text` and `html`.
+Both helpers take a lookup key, used to identify the desired piece of text, 
+and an argument hash, which is forwarded to the `I18n.t` call.
+
+`text` returns the requested text, with special values interpolated, and made 
+html_safe (so HTML can be used here, when absolutely necessary).
+
+`html` parses the requested text using Markdown, making it useful for rendering
+larger pieces of text involving multiple paragraphs, list items or links.
+
+If you want to render a small fragment of Markdown without `p` tag wrappers,
+you can pass `inline: true` as an option to `html`.
+
+### In Controllers
+
+The same helpers are available in controllers, with the translation scope based
+on the controller name rather than the view directory. This will typically be
+used for flash messages or alerts of some kind.
+
+## Testing
+
+Some shared `RSpec` contexts are available to allow the same locale 
+abstractions for testing. You can include these contexts with:
+
+```
+require "text_helpers/contexts"
+```
+
+### Views
+
+The view text helpers described above can be accessed in view
+specs by adding `view: true` to the spec metadata.
+
+### Controllers
+
+The controller text helpers described above can be accessed in controller
+specs by adding `controller: true` to your spec metadata.

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/text_helpers/contexts.rb

@@ -0,0 +1,24 @@
+shared_context "a view spec", view: true do
+  include TextHelpers::Translation
+
+  def translation_scope
+    matcher = /(?<path>.*)\/_?(?<view>[^\/.]+)(?<extension>\.html\.haml)?/
+    info = matcher.match(example.metadata[:full_description])
+
+    if info
+      path = info[:path].gsub('/', '.')
+      "views.#{path}.#{info[:view]}"
+    else
+      "views.#{params[:controller]}.#{params[:action]}"
+    end
+  end
+end
+
+shared_context "a controller spec", controller: true do
+  include TextHelpers::Translation
+
+  def translation_scope
+    controller_name = described_class.name.sub(/Controller\z/, '').underscore
+    "controllers.#{controller_name}"
+  end
+end

data/lib/text_helpers/railtie.rb

@@ -0,0 +1,47 @@
+module TextHelpers
+
+  class Railtie < Rails::Railtie
+
+    initializer "text_helpers.configure_rails_initialization" do
+
+      class ActionView::Base
+        include TextHelpers::Translation
+
+        protected
+
+        # Protected: 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>"
+        #
+        # Returns a String.
+        def translation_scope
+          matcher = /(?<path>.*)\/_?(?<view>[^\/.]+)(?<extension>\.html\.haml)?/
+          info = matcher.match(@virtual_path)
+
+          if info
+            path = info[:path].gsub('/', '.')
+            "views.#{path}.#{info[:view]}"
+          else
+            "views.#{params[:controller]}.#{params[:action]}"
+          end
+        end
+      end
+
+      class ActionController::Base
+        include TextHelpers::Translation
+
+        protected
+
+        # Protected: Provides a scope for I18n lookups.
+        #
+        # Should look like `controllers.<controller_name>`.
+        #
+        # Returns a String.
+        def translation_scope
+          "controllers.#{params[:controller]}"
+        end
+      end
+    end
+  end
+end

data/lib/text_helpers/translation.rb

@@ -0,0 +1,55 @@
+require "i18n"
+require "active_support/core_ext/string/output_safety"
+require "github/markdown"
+
+module TextHelpers
+
+  module Translation
+
+    # Public: Get the I18n localized text for the passed key.
+    #
+    # key     - The desired I18n lookup key.
+    # options - A Hash of options to pass through to the lookup.
+    #
+    # Returns a String resulting from the I18n lookup.
+    def text(key, options = {})
+      text = I18n.t(key, {
+        scope: self.translation_scope,
+        default: "!#{key}!"
+      }.merge(options))
+
+      # Interpolate any keypaths (e.g., `!some.lookup.key!`) found in the text.
+      text.strip.gsub(/!([\w._]+)!/) do |match|
+        I18n.t($1)
+      end.html_safe
+    end
+
+    # Public: Get an HTML representation of the rendered markdown for the passed I18n key.
+    #
+    # key     - The desired I18n lookup key.
+    # options - A Hash of options to pass through to the lookup.
+    #           :inline - A special option that will remove the enclosing <p>
+    #                     tags when set to true.
+    #
+    # Returns a String containing the localized text rendered via Markdown
+    def html(key, options = {})
+      rendered = GitHub::Markdown.render(text(key, options))
+      if options[:inline]
+        rendered.match(/\A<p>(.*)<\/p>\Z/)[1].html_safe
+      else
+        rendered.html_safe
+      end
+    end
+
+    protected
+
+    # Protected: The proper scope for I18n translation.
+    #
+    # Must be implemented by any classes which include this module.
+    #
+    # Raises NotImplementedError.
+    def translation_scope
+      raise NotImplementedError
+    end
+  end
+end

data/lib/text_helpers/version.rb

@@ -0,0 +1,3 @@
+module TextHelpers
+  VERSION = "0.1.0"
+end

data/lib/text_helpers.rb

@@ -0,0 +1,5 @@
+require 'text_helpers/version'
+require 'text_helpers/translation'
+require 'text_helpers/railtie' if defined?(Rails)
+
+module TextHelpers; end

data/test/lib/text_helpers/translation_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../test_helper'
+
+describe TextHelpers::Translation do
+  before do
+    @helper = Object.send(:include, TextHelpers::Translation).new
+  end
+  describe "given a stored I18n lookup" do
+    before do
+      @scoped_text = "Scoped lookup"
+      @global_text = "Global lookup"
+
+      I18n.backend.store_translations :en, {
+        test_key: @global_text,
+        test: {
+          test_key: "*#{@scoped_text}*",
+          interpolated_key: "Global? (!test_key!)"
+        }
+      }
+    end
+
+    describe "for a specified scope" do
+      before do
+        @helper.define_singleton_method :translation_scope do
+          'test'
+        end
+      end
+
+      it "looks up the text for the key in a scope derived from the call stack" do
+        assert_equal @helper.text(:test_key), "*#{@scoped_text}*"
+      end
+
+      it "converts the text to HTML via Markdown" do
+        assert_equal @helper.html(:test_key), "<p><em>#{@scoped_text}</em></p>\n"
+      end
+
+      it "removes the enclosing paragraph with :inline" do
+        assert_equal @helper.html(:test_key, inline: true), "<em>#{@scoped_text}</em>"
+      end
+
+      it "interpolates values wrapped in !!" do
+        assert_equal @helper.text(:interpolated_key), "Global? (#{@global_text})"
+      end
+    end
+
+    describe "when no valid scope is provided" do
+      before do
+        @helper.define_singleton_method :translation_scope do
+          'nonexistent'
+        end
+      end
+
+      it "defaults to a globally-defined value for the key" do
+        assert_equal @helper.text(:test_key), @global_text
+      end
+    end
+  end
+end

data/test/lib/text_helpers/version_test.rb

@@ -0,0 +1,8 @@
+require_relative "../../test_helper"
+
+describe TextHelpers do
+
+  it "defines a version" do
+    TextHelpers::VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require File.expand_path('../../lib/text_helpers.rb', __FILE__)

data/text_helpers.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/text_helpers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Horner"]
+  gem.email         = ["andrew@tablexi.com"]
+
+  gem.homepage      = "https://github.com/ahorner/text-helpers"
+  gem.description   = %q{Easily fetch text and static content from your locales}
+  gem.summary       = %q{
+    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.
+  }
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.name          = "text_helpers"
+  gem.require_paths = ["lib"]
+  gem.version       = TextHelpers::VERSION
+
+  gem.add_dependency('activesupport')
+  gem.add_dependency('i18n')
+  gem.add_dependency('github-markdown')
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: text_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  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'
+description: Easily fetch text and static content from your locales
+email:
+- andrew@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/text_helpers.rb
+- lib/text_helpers/contexts.rb
+- lib/text_helpers/railtie.rb
+- lib/text_helpers/translation.rb
+- lib/text_helpers/version.rb
+- test/lib/text_helpers/translation_test.rb
+- test/lib/text_helpers/version_test.rb
+- test/test_helper.rb
+- text_helpers.gemspec
+homepage: https://github.com/ahorner/text-helpers
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+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/translation_test.rb
+- test/lib/text_helpers/version_test.rb
+- test/test_helper.rb