Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
attilahorvath committed May 9, 2014
0 parents commit cd47e41
Show file tree
Hide file tree
Showing 9 changed files with 173 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
*.gem
*.rbc
.bundle
.config
.yardoc
Gemfile.lock
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
*.bundle
*.so
*.o
*.a
mkmf.log
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in i18n-globals.gemspec
gemspec
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2014 Attila Horvath

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.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# I18n::Globals

Adds support for I18n global variables, which will be available for interpolation into every translation.

## Description

Extends the Ruby I18n gem with global variables. The globals will be available for interpolation in every translation without explicitly specifying them in a call to `I18n.translate`. The variables can be accessed through `I18n.config.globals`.

## Installation

Add this line to your application's Gemfile:

gem 'i18n-globals'

And then execute:

$ bundle

Or install it yourself as:

$ gem install i18n-globals

## Usage

Add your global variables to the `I18n.config.globals` hash:

I18n.config.globals[:company] = "Initech"

Your global variables will then be automatically interpolated into every translation:

# If the value of 'greeting' is 'Welcome to %{company}!'
I18n.t "greeting" # Returns 'Welcome to Initech!'

You can override the globals:

I18n.t "greeting", company: "Initrode" # Returns 'Welcome to Initrode!'

It's also possible to mix globals and ordinary variables:

# If the value of 'signature' is '%{president}, President of %{company}'
I18n.t "signature", president: "Bill Lumbergh" # Returns 'Bill Lumbergh, President of Initech'

If you're using Rails, it can be useful to specify your globals in a `before_filter`:

class EmployeesController < ApplicationController
before_filter :set_i18n_globals

# ...

private

def set_i18n_globals
I18n.config.globals[:company] = Company.current.name
end
end

Now you can interpolate the `user_name` variable into every translation in your template:

<%= t "greeting" %>
<%= t "signature", president: "Bill Lumbergh" %>

## Contributing

1. Fork it ( https://github.com/attilahorvath/i18n-globals/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`)
5. Create a new Pull Request
2 changes: 2 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require "bundler/gem_tasks"

25 changes: 25 additions & 0 deletions i18n-globals.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'i18n/globals/version'

Gem::Specification.new do |spec|
spec.name = "i18n-globals"
spec.version = I18n::Globals::VERSION
spec.authors = ["Attila Horvath"]
spec.email = ["[email protected]"]
spec.summary = %q{Adds support for I18n global variables, which will be available for interpolation into every translation.}
spec.description = %q{Extends the Ruby I18n gem with global variables. The globals will be available for interpolation in every translation without explicitly specifying them in a call to I18n.translate. The variables can be accessed through I18n.config.globals.}
spec.homepage = ""
spec.license = "MIT"

spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]

spec.add_development_dependency "bundler", "~> 1.6"
spec.add_development_dependency "rake"

spec.add_runtime_dependency "i18n"
end
1 change: 1 addition & 0 deletions lib/i18n-globals.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
require "i18n/globals"
24 changes: 24 additions & 0 deletions lib/i18n/globals.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
require "i18n/globals/version"

module I18n
class Config
def globals
@globals ||= {}
end

def globals=(globals)
@globals = globals
end
end

class << self
def translate(*args)
if args.last.is_a?(Hash)
args[-1] = config.globals.merge(args.last)
else
args << config.globals
end
super(*args)
end
end
end
5 changes: 5 additions & 0 deletions lib/i18n/globals/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module I18n
module Globals
VERSION = "0.0.1"
end
end

0 comments on commit cd47e41

Please sign in to comment.