roda-i18n 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4feabc4adea61f368ca2a43fc29fbcd00d0ae10e
-  data.tar.gz: 609e51e11fd9a376c5201dbf07a6eadea8983b07
+  metadata.gz: 61da5676e50ba7ef694e025bfd717c279c0dfe01
+  data.tar.gz: 57e1b41f3d7856e464e51542fa9c6172f6fe93bc
 SHA512:
-  metadata.gz: faa5f46acced714ad64e94220d4c8c944962c92b41cc7463d49439cf83e4c0fb86acb11469c60bad01f3e17855a7492f017fb893626808c9dc1571cbc424ec65
-  data.tar.gz: 09c908134c0196c657d42c111279dffc083f0f9c54f03ddb979024d66ad4d4ada98518d3f6ce64d07e961a2c54cc09a77132ad6b011057b2565e4ff459367a99
+  metadata.gz: 741426239b80ef746c01ba0e3551855af218b12412147d8117da8a2524eba80502b7c934bca41ae1ad6cbbeaa2f1375581c08f639fe233776dbf69a397227437
+  data.tar.gz: 931482a0bbd46455887a2f67affc4a93c13329db1acf73c723e386f3cdf29aaecbe4f340cbcabee2ea4f2bdd8f83fc3f22243714eb4734966d602067befe3f17

data/.gitignore

@@ -0,0 +1,4 @@
+tmp
+Gemfile.lock
+coverage
+pkg

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roda-tags.gemspec
+gemspec
+
+# gem 'roda', '~> 2.5.1'
+# gem 'r18n-core'
+#
+# group :test do
+#   gem 'minitest'
+#   gem 'minitest-hooks'
+#   gem "rack-test"
+#
+#   gem 'tilt'
+#   gem 'erubis'
+#   gem 'kramdown'
+#
+#   gem 'simplecov', :require => false
+# end

data/README.md

@@ -1,6 +1,7 @@
 # Roda-i18n
 
-Easily add Internationalisation (i18n) and localisation support for [Roda](http://roda.jeremyevans.net/) apps, based upon the [R18n](https://github.com/ai/r18n) gem.
+Add Internationalisation (i18n) and localisation support to your [Roda](http://roda.jeremyevans.net/) 
+apps, based upon the [R18n](https://github.com/ai/r18n) gem.
 
 Extensively tested and with 100% code test coverage.
 
@@ -9,120 +10,136 @@ Extensively tested and with 100% code test coverage.
 
 To use this gem, just do
 
-    $ (sudo) gem install roda-i18n
-    
+```bash
+  $ (sudo) gem install roda-i18n
+```
+  
 or if you use Bundler
 
-    gem "roda-i18n"
-
+```ruby
+gem "roda-i18n"
+```
 
 <br>
 
 
 ## Getting Started
 
-To add internationalisation and localisation support to your app just add the following code snippet in your app.
+To add internationalisation and localisation support to your app just add the following code snippet 
+in your app.
 
-    plugin :i18n
+```ruby
+plugin :i18n
+```
 
-By default the default locale is set to <tt>'en'</tt> and the translations directory is set to the <tt>'i18n'</tt> directory in the rooot of your app, ie: '<tt>/path/2/app/i18n</tt>'.
+By default the default locale is set to `'en'` and the translations directory is set to the `'i18n'` 
+directory in the root of your app, ie: `'/path/2/app/i18n'`.
 
 
-**IMPORTANT! Make sure you create the 'i18n' folder and add an 'en.yml' file with 
-at least one translation within it.**
+**IMPORTANT! Make sure you create the 'i18n' folder and add an `'en.yml'` file with at least one 
+translation within it.**
 
 
 <br>
+---
 
 
 ## Configuration
 
 ### Overriding defaults during configuration
 
-Both <tt>:locale</tt> and <tt>:translations</tt> can be configured (overridden) during plugin configuration:
-
-    plugin :i18n, :locale => ['de'], :translations => ['absolute/path/2/i18n']
+Both `:locale` and `:translations` can be configured (overridden) during plugin configuration:
 
+```ruby
+plugin :i18n, :locale => ['de'], :translations => ['absolute/path/2/i18n']
+```
 
 **NOTE!** 
 
- 1. You must set <tt>opts[:root]</tt> in your app if you do not define the <tt>:translations</tt> path during plugin configuration.
+ 1. You must set `opts[:root]` in your app if you do not define the `:translations` path during 
+    plugin configuration.
 
- 2. When overriding <tt>:translations</tt> the **any path(s) given must be absolute**.
+ 3. When overriding `:translations` the **any path(s) given must be absolute**.
 
 
 #### Loading translations from multiple i18n directories
 
-The <tt>:translations</tt> path supports 'wildcards', ie: <tt>path/**/i18n</tt> so you can load translations from multiple combined apps, each with their own <tt>i18n</tt> folder with translations.
+The `:translations` path supports 'wildcards', ie: `path/**/i18n` so you can load translations from 
+multiple combined apps, each with their own `i18n` folder with translations.
 
 **Please Note!** 
 
-When loading translations from multiple sources and the same translation key is available in multiple files of the same locale, then **the translations in the first loaded translation file takes precedence over subsequent loaded translations**. 
+When loading translations from multiple sources and the same translation key is available in 
+multiple files of the same locale, then **the translations in the first loaded translation file 
+takes precedence over subsequent loaded translations**. 
 
-* ie: translations in <tt>./i18n/en.yml</tt> takes precedence over translations in <tt>./apps/app1/i18n/en.yml</tt>
+* ie: translations in `./i18n/en.yml` takes precedence over translations in `./apps/app1/i18n/en.yml`
 
 
 You can also set a list of preferred locales as an array ordered by priority.
 
-    plugin :i18n, :locale => ['es','fr','en']
-
+```ruby
+plugin :i18n, :locale => ['es','fr','en']
+```
 
 
 <br>
-
+---
 
 ##  USAGE
 
 The **i18n** plugin depends upon simple YAML based translations files:
 
-    # app/i18n/en.yml
-    
-    user:
-      edit: Edit user
-      name: User name is %1
-      count: !!pl
-        1: There is 1 user
-        n: There are %1 users
-    
-
-...and the **<tt>:t</tt>** instance method to output the translations:
-
-    
-    t.user.edit         #=> "Edit user"
-    t.user.name('John') #=> "User name is John"
-    t.user.count(5)     #=> "There are 5 users"
-    
-    t.does.not.exist | 'default' #=> "default"
-    
-
-...and the **<tt>:l</tt>** (lowercase L) instance method provides built-in localisations support:
-
-    
-    l Time.now           #=> "03/01/2010 18:54"
-    l Time.now, :human   #=> "now"
-    l Time.now, :full    #=> "3rd of January, 2010 18:54"
-    
-
-
-Both the <tt>:t</tt> and <tt>:l</tt> methods are available within the route and template (erb) scopes. ie:
-
-    
-    route do |r|
-      r.root do
-        t.welcome.message
-      end
-    end
-    
-    # app/views/layout.erb
-    <snip...>
-      <h1><%= t.welcome.message %></h1>
-    <snip...>
-    
+```ruby
+ # app/i18n/en.yml
+
+user:
+  edit: Edit user
+  name: User name is %1
+  count: !!pl
+    1: There is 1 user
+    n: There are %1 users
+```
+
+...and the **`:t`** instance method to output the translations:
+
+```ruby
+t.user.edit         #=> "Edit user"
+t.user.name('John') #=> "User name is John"
+t.user.count(5)     #=> "There are 5 users"
+
+t.does.not.exist | 'default' #=> "default"
+```
+
+...and the **`:l`** (lowercase L) instance method provides built-in localisations support:
+
+```ruby
+l Time.now           #=> "03/01/2010 18:54"
+l Time.now, :human   #=> "now"
+l Time.now, :full    #=> "3rd of January, 2010 18:54"
+```    
+
+
+Both the `:t` and `:l` methods are available within the route and template (erb) scopes. ie:
+
+```ruby 
+route do |r|
+  r.root do
+    t.welcome.message
+  end
+end
 
+ # app/views/layout.erb
+ <snip...>
+   <h1><%= t.welcome.message %></h1>
+ <snip...>
+```  
 
-Please visit [R18n](https://github.com/ai/r18n/tree/master/r18n-core) for more information about the R18n gem used to create the above.
+Please visit [R18n](https://github.com/ai/r18n/tree/master/r18n-core) for more information about the 
+R18n gem used to create the above.
 
 <br>
+---
 
 ## Key Methods / Functionality
 
@@ -130,59 +147,63 @@ Please visit [R18n](https://github.com/ai/r18n/tree/master/r18n-core) for more i
 <br>
 
 
-### <tt>#locale(opts={},&blk)</tt> - (request method)
+### `#locale(opts = {}, &blk)` - (request method)
 
-This request method makes it easy to handle translations based upon the **<tt>:locale</tt> prefix on a route / URL**. ie: <tt>blog.com/**de**/posts</tt>.
+This request method makes it easy to handle translations based upon the **`:locale` prefix on a 
+route / URL**. ie: `blog.com/**de**/posts`.
 
 
 To enable this, just use the following code structure:
 
-    route do |r|
-      
-      # all routes are prefixed with '/:locale'
-      # ie: GET /de/posts  => will use DE translations    
-      # ie: GET /es/posts  => will use ES translations
-      
-      r.locale do          # also aliased as #i18n_locale
-        r.is 'posts' do 
-	      t.posts.header # use translations or locales
-        end
-      end
-      
+```ruby
+route do |r|
+  
+  # all routes are prefixed with '/:locale'
+  # ie: GET /de/posts  => will use DE translations    
+  # ie: GET /es/posts  => will use ES translations
+  
+  r.locale do          # also aliased as #i18n_locale
+    r.is 'posts' do 
+    t.posts.header # use translations or locales
     end
-    
+  end
+  
+end
+```    
 
 	
 
-**NOTE!** Any URL / request with a non-present or not supported locale will be given the **configured default locale** or the EN (English) default locale.
+**NOTE!** Any URL / request with a non-present or not supported locale will be given the 
+**configured default locale** or the EN (English) default locale.
 
 
 <br>
 
 
-### <tt>#i18n_set_locale_from(type)</tt> - (request method)
+### ``#i18n_set_locale_from(type)` - (request method)
 
 Obtains the locale from either ENV, HTTP (browser), Params or Session values.
 
-    route do |r|
-      # A): set from session[:locale] (if present)
-      r.i18n_set_locale_from(:session)
-      
-      # B): set from URL params ie: GET /posts?locale=de
-      r.i18n_set_locale_from(:params)
-      
-      # C): set from the browser's HTTP request locale
-      r.i18n_set_locale_from(:http)
-      
-      # D): set from the server ENV['LANG'] variable
-      r.i18n_set_locale_from(:ENV)
-      
-      
-      r.is 'posts' do 
-        t.posts.header # use translations
-      end
-    end
-
+```ruby
+route do |r|
+  # A): set from session[:locale] (if present)
+  r.i18n_set_locale_from(:session)
+  
+  # B): set from URL params ie: GET /posts?locale=de
+  r.i18n_set_locale_from(:params)
+  
+  # C): set from the browser's HTTP request locale
+  r.i18n_set_locale_from(:http)
+  
+  # D): set from the server ENV['LANG'] variable
+  r.i18n_set_locale_from(:ENV)
+  
+  
+  r.is 'posts' do 
+    t.posts.header # use translations
+  end
+end
+```
 
 **NOTE!** defaults to the configured default locale, or English, if the given locale type is invalid.
 
@@ -190,30 +211,30 @@ Obtains the locale from either ENV, HTTP (browser), Params or Session values.
 <br>
 
 
-### <tt>#i18n_set_locale(locale, &blk)</tt> - (request method)
+### `i18n_set_locale(locale, &blk)` - (request method)
 
-Enables overriding the default locale and setting a temporary :locale
-within a route block.
+Enables overriding the default locale and setting a temporary `:locale` within a route block.
   
-    route do |r|
-      # configured default locale
-      
-	   <snip...>
-	   
-      r.i18n_set_locale('de') do
-        # within this route block the locale is DE (German)
-      end
-      
-      r.i18n_set_locale('es') do
-        # within this route block the locale is ES (Spanish)
-      end
-    
-    end
+```ruby
+route do |r|
+  # configured default locale
+  
+ <snip...>
+ 
+  r.i18n_set_locale('de') do
+    # within this route block the locale is DE (German)
+  end
   
+  r.i18n_set_locale('es') do
+    # within this route block the locale is ES (Spanish)
+  end
 
+end
+```  
 
+<br>
+---
 
-      
 ## InstanceMethods
 
 ### `#t`
@@ -236,8 +257,9 @@ Key localisation method. Handles dates etc. (See examples above)
 
 Returns a two-dimensional array of available locales.
 
-    puts i18n_available_locales #=> [ ['en', 'English'], ...]
-
+```ruby
+puts i18n_available_locales #=> [ ['en', 'English'], ...]
+```
 
 
         
@@ -249,12 +271,13 @@ Returns a two-dimensional array of available locales.
 
 ## Class Methods
         
-### <tt>#i18n_opts</tt>
+### `#i18n_opts()`
 
 Return the i18n options for this class as a Hash.
 
 
 <br>
+---
 
 
 ## Ideas
@@ -264,8 +287,9 @@ A few ideas that may be outlandish, but possible?
 
 ### Ability to load translations from multiple locations via an array.
 
-    plugin :i18n, :translations => ['app1/i18n', 'app2/i18n', 'app3/i18n']
-
+```ruby
+plugin :i18n, :translations => ['app1/i18n', 'app2/i18n', 'app3/i18n']
+```
 
 > [Concept Reference](https://github.com/ai/r18n/tree/master/r18n-core#loaders)
 >    
@@ -300,7 +324,8 @@ Som form of built-in support for storing / loading translations from a Sequel ba
 
 ## Credits
 
-* This plugin have been inspired by the `sinatra-i18n` gem available at [github/ai/r18n](http://github.com/ai/r18n) created by [Andrey Sitnik](http://github.com/ai).
+* This plugin have been inspired by the `sinatra-i18n` gem available at 
+  [github/ai/r18n](http://github.com/ai/r18n) created by [Andrey Sitnik](http://github.com/ai).
 
 * Testing code have been partly copied from [Forme](github.com/jeremyevans/forme).
 

data/Rakefile

@@ -1,53 +1,12 @@
-require "rake"
-require "rake/clean"
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-NAME = 'roda-i18n'
-CLEAN.include ["#{NAME}-*.gem", "rdoc", "coverage", '**/*.rbc']
-
-# Gem Packaging and Release
-
-desc "Packages #{NAME}"
-task :package=>[:clean] do |p|
-  sh %{gem build #{NAME}.gemspec}
-end
-
-desc "Upload #{NAME} gem to rubygems"
-task :release=>[:package] do
-  sh %{gem push ./#{NAME}-#{VERS.call}.gem} 
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-# ### RDoc
-#
-# RDOC_DEFAULT_OPTS = ["--line-numbers", "--inline-source", '--title', 'Roda I18n']
-#
-# begin
-#   gem 'hanna-nouveau'
-#   RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
-# rescue Gem::LoadError
-# end
-#
-# rdoc_task_class = begin
-#   require "rdoc/task"
-#   RDoc::Task
-# rescue LoadError
-#   require "rake/rdoctask"
-#   Rake::RDocTask
-# end
-#
-# RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
-#
-# rdoc_task_class.new do |rdoc|
-#   rdoc.rdoc_dir = "rdoc"
-#   rdoc.options += RDOC_OPTS
-#   rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
-# end
-
-### Specs
-
-desc "Run specs"
-task :spec do
-  sh "#{FileUtils::RUBY} -rubygems -I lib -e 'ARGV.each{|f| require f}' ./spec/*_spec.rb"
-end
 task :default => :spec
 
 desc "Run specs with coverage"
@@ -56,23 +15,7 @@ task :coverage do
   Rake::Task['spec'].invoke
 end
 
-### Other
-
-# desc "Print #{NAME} version"
-# task :version do
-#   puts VERS.call
-# end
-
-desc "Check syntax of all .rb files"
-task :check_syntax do
-  Dir['**/*.rb'].each{|file| print `#{ENV['RUBY'] || :ruby} -c #{file} | fgrep -v "Syntax OK"`}
+desc "Run Rubocop report"
+task :rubocop do
+  `rubocop -f html -o ./Rubocop-report.html lib/`
 end
-
-# desc "Start an IRB shell using the extension"
-# task :irb do
-#   require 'rbconfig'
-#   ruby = ENV['RUBY'] || File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-#   irb = ENV['IRB'] || File.join(RbConfig::CONFIG['bindir'], File.basename(ruby).sub('ruby', 'irb'))
-#   sh %{#{irb} -I lib -r forme}
-# end
-