alephant-renderer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99aaf2d2aa11f5ac1f525a49943ad5e3b0662215
-  data.tar.gz: f50d57090b29cf1016ca6e80f6bd39b1b5598081
+  metadata.gz: 8fee80f6f73582dd588edaa90618125a27ceaf6c
+  data.tar.gz: 19487c21a2c959aa75195ce3039cd5ebad362edc
 SHA512:
-  metadata.gz: 6e45b2dc23c8cd5d18db75445f4dbc138ff96f427ad73acd0a17292ef1eaf35a0bae2019b8447618fa89425bea9e3881b880594b7c3cd8beaaf4a1401226987b
-  data.tar.gz: 8eaf85eb822165ceb11ae4ae3a1f37aa5e17d6354f987a41142810482e576d7b6f7c306c65bf8c9f50e198438627f3ea3ce44ea4ba761c33d18e3a0e86bcc8e5
+  metadata.gz: 108b9c8f2ba7e33146c5c377c9bb2fd36bb6e331a162308a4dfbc066cd7744b21172a51c4b3b343133bb4837399a5ff4f5664a1c10db0e4c04de267f6dde512b
+  data.tar.gz: 46db4d9d1bbe6e89d5bbbe5fcf5c1461ab5172dc4b1a5120a1ce31b4e9d916b2d04ebbc3f4a11765aab9091b05d1af743f8b061c2d05a08719271cf3381f971e

data/.gitignore

@@ -3,6 +3,7 @@
 Gemfile.lock
 .rspec
 *.gem
+*.swp
 
 /pkg
 /tmp

data/README.md

@@ -28,9 +28,86 @@ require 'alephant/renderer'
 Alephant::Renderer.create('foo_template', '/base/path', 'foo_model')
 ```
 
+## Translations
+
+Currently there is a simple implementation of the [i18n](https://github.com/svenfuchs/i18n) library that allows templates to be translated.
+
+### Setup
+
+You need the following directory structure inside of the folder that relates to the `base_path`:
+
+```bash
+components
+├── locale
+│   ├── en.yml
+│   ├── cy.yml
+```
+
+The yaml configs must have the extension `.yml`.
+
+### Yaml structure
+
+The yaml translations files must follow the following structure:
+
+```yaml
+en:
+	template_name:
+		key: 'foo'
+		sub:
+			key: 'bar'
+
+	another_template:
+		key: 'baz'
+```
+
+The first node is the language code, then the next set of nodes are the names of the templates files that the translations apply to. This allows you to just reference the translation key in the templates without prefixing the name of the template.
+
+### Usage
+
+For each translation, a seperate model and view is needed.
+
+#### Model
+
+All that's needed in the model is to override the LOCALE constant:
+
+```rb
+class TestModel < Alephant::Views::Base
+  LOCALE = :cy
+end
+```
+
+#### Templates
+
+The best approach with the templates when translations are needed, is to have a base template then a seperate one for each lanuage that's being translated.
+
+The following tag can be used in the templates to perform a translation:
+
+```mustache
+{{#t}}text.to.translate{{/t}}
+```
+
+#### Example
+
+If we had a template called 'test_template.mustache' we would have the following:
+
+>test_template.mustache
+
+```mustache
+{{#t}}translation.key{{/t}}
+```
+
+>locale/en.yml
+
+```yaml
+en:
+    test_template:
+	    translation:
+		    key: 'A translation!'
+```
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/alephant-renderer/fork )
+1. Fork it ( http://github.com/bbc-news/alephant-renderer/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/alephant-renderer.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 
+  spec.add_runtime_dependency 'i18n'
   spec.add_runtime_dependency 'mustache', '>= 0.99.5'
   spec.add_runtime_dependency 'alephant-logger'
   spec.add_runtime_dependency 'hashie'

data/lib/alephant/renderer/engines/mustache.rb

@@ -1,5 +1,6 @@
 require 'alephant/logger'
 require 'mustache'
+require 'i18n'
 
 module Alephant
   module Renderer
@@ -13,6 +14,8 @@ module Alephant
         @base_path     = base_path
         @model         = model
 
+        load_translations_from base_path
+
         logger.info("Renderer.initialize: end with @base_path set to #{@base_path}")
       end
 
@@ -31,6 +34,28 @@ module Alephant
           logger.error("Renderer.template: view template #{template_file} not found")
         end
       end
+
+      private
+
+      def load_translations_from(base_path)
+        if I18n.load_path.empty?
+          I18n.config.enforce_available_locales = false
+          I18n.load_path << i18n_load_path_from(base_path)
+          I18n.backend.load_translations
+        end
+      end
+
+      def i18n_load_path_from(base_path)
+        Dir[
+          File.join(
+            Pathname.new(base_path).parent,
+            'locale',
+            '*.yml')
+        ]
+        .flatten
+        .uniq
+      end
+
     end
 
   end

data/lib/alephant/renderer/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Renderer
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/alephant/views/base.rb

@@ -1,15 +1,31 @@
 require 'mustache'
 require 'alephant/views'
 require 'hashie'
+require 'json'
+require 'i18n'
 
 module Alephant::Views
   class Base < Mustache
     attr_accessor :data
 
+    LOCALE = :en
+
     def initialize(data = {})
       @data = Hashie::Mash.new data
     end
 
+    def t(*args)
+      I18n.locale = self.class::LOCALE
+      lambda do |comma_delimited_args|
+        args   = comma_delimited_args.strip.split ','
+        key    = args.shift
+        params = args.empty? ? {} : JSON.parse(args.first).with_indifferent_access
+        prefix = /\/([^\/]+)\./.match(template_file)[1]
+
+        I18n.translate("#{prefix}.#{key}", params)
+      end
+    end
+
     def self.inherited(subclass)
       ::Alephant::Views.register(subclass)
     end

data/spec/renderer_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Alephant::Renderer do
   let(:template_file) { 'foo' }
-  let(:base_path) { :base_path }
+  let(:base_path) { 'bar/baz' }
   let(:model) { :model }
 
   before(:each) do

data/trans.yml

@@ -0,0 +1,2 @@
+en:
+  test: 'Hello!'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-renderer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -136,6 +136,20 @@ dependencies:
         version: '0'
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: i18n
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: mustache
   version_requirements: !ruby/object:Gem::Requirement
@@ -204,6 +218,7 @@ files:
 - spec/fixtures/components/foo/templates/foo.mustache
 - spec/renderer_spec.rb
 - spec/spec_helper.rb
+- trans.yml
 homepage: ''
 licenses:
 - MIT