i18n-callbacks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae3d088f84070a37a78555a10a1204db1dd1a4a0
+  data.tar.gz: ce8b40ef7a18a5c6cec0b8e99f1df79537cd1464
+SHA512:
+  metadata.gz: 7aeff25f7a8655937b9304d0e218352f16f69b704cf15cc04b489e6bc8e809068971cc8b52a7f7d7ec903693ae9f864c85017a47c54b1d7cef80f0273d8942ac
+  data.tar.gz: 611036153f983d64034ded43492523f2472cccee484a3f6043c76f3c01e3efc155e1a806eb068e2674a0f16f45cce7114e4d88e7f92c03419bbd641435e31024

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle/
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at joe.g.yates@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Yates
+
+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,74 @@
+# I18n::Callbacks
+
+Wrap your `I18n.t` calls in `before` and/or `after` hooks.
+
+This gem provides the `I18n::Backend::Callbacks` backend.
+
+You pass it an I18n backend to call plus before/after callbacks to pre-/post-
+process the calls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n-callbacks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n-callbacks
+
+## Usage
+
+Supply either a `:before` or `:after` proc to the constructor, process I18n.t
+calls.
+
+* `:before` - takes 3 parameters: locale, key and options,
+* `:after` - takes 4 parameters: locale, key and options, and the result of
+  the call to the backend that you are wrapping.
+
+Suppose you want all translated strings to be prefixed by the key used to
+access them:
+
+```ruby
+require "i18n"
+require "i18n/callbacks"
+
+wrapped = I18n::Backend::Simple.new
+
+# ...load you translations (normally from YAML files)
+wrapped.store_translations(:en, {foo: "bar"})
+
+I18n.backend = I18n::Backend::Callbacks.new(
+  wrapped,
+  after: ->(locale, key, options={}, result) { "#{key}: #{result}" }
+)
+
+I18n.t(:foo) # => "foo: bar"
+```
+
+## Development
+
+Run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/cantierecreativo/i18n-callbacks. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/i18n-callbacks.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i18n/callbacks/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n-callbacks"
+  spec.version       = I18n::Callbacks::VERSION
+  spec.authors       = ["Joe Yates"]
+  spec.email         = ["joe.g.yates@gmail.com"]
+
+  spec.summary       = %q{Pre- and post-process you calls to I18n.t()}
+  spec.homepage      = "https://github.com/cantierecreativo/i18n-callbacks"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.lines.map(&:chomp!)
+  spec.test_files    = `git ls-files spec`.lines.map(&:chomp!)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/i18n/backend/callbacks.rb

@@ -0,0 +1,31 @@
+require "i18n"
+
+class I18n::Backend::Callbacks < Delegator
+  attr_reader :wrapped
+  attr_reader :before
+  attr_reader :after
+
+  def initialize(wrapped, before: nil, after: nil)
+    super(wrapped)
+    @wrapped = wrapped
+    @before = before
+    @after = after
+  end
+
+  def translate(locale, key, options = {})
+    locale, key, options = before.call(locale, key, options) if before
+    result = wrapped.translate(locale, key, options)
+    result = after.call(locale, key, options, result) if after
+    result
+  end
+
+  # implement the Delegator interface
+
+  def __setobj__(obj)
+    @wrapped = obj
+  end
+
+  def __getobj__
+    wrapped
+  end
+end

data/lib/i18n/callbacks/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module Callbacks
+    VERSION = "0.1.0"
+  end
+end

data/lib/i18n/callbacks.rb

@@ -0,0 +1,2 @@
+require "i18n/callbacks/version"
+require "i18n/backend/callbacks"

data/spec/backend/callbacks_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe I18n::Backend::Callbacks do
+  let(:wrapped) do
+    instance_double(
+      I18n::Backend::Simple,
+      available_locales: [:en],
+      translate: original
+    )
+  end
+  let(:key) { "hello" }
+  let(:original) { "foo" }
+  let(:before) { nil }
+  let(:after) { nil }
+
+  before do
+    I18n.backend = described_class.new(wrapped, before: before, after: after)
+  end
+  after { I18n.backend = nil }
+
+  context "with a pre hook defined" do
+    let(:before) do
+      ->(locale, key, options = {}) { [:fr, key, options] }
+    end
+
+    it "allows pre-processing of I18n.t calls" do
+      I18n.t(key)
+
+      expect(wrapped).to have_received(:translate).with(:fr, key, {})
+    end
+  end
+
+  context "with a post hook defined" do
+    let(:after) do
+      ->(locale, key, options = {}, result) { "#{key} -> #{result}" }
+    end
+
+    it "allows post-processing of I18n.t calls" do
+      expect(I18n.t(key)).to eq("#{key} -> #{original}")
+    end
+  end
+
+  context "without hooks defined" do
+    it "proxies to the backend" do
+      expect(I18n.t("hello")).to eq(original)
+    end
+  end
+end

data/spec/callbacks_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe I18n::Callbacks do
+  it "has a version number" do
+    expect(I18n::Callbacks::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'i18n/callbacks'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: i18n-callbacks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-19 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n-callbacks.gemspec
+- lib/i18n/backend/callbacks.rb
+- lib/i18n/callbacks.rb
+- lib/i18n/callbacks/version.rb
+- spec/backend/callbacks_spec.rb
+- spec/callbacks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cantierecreativo/i18n-callbacks
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Pre- and post-process you calls to I18n.t()
+test_files:
+- spec/backend/callbacks_spec.rb
+- spec/callbacks_spec.rb
+- spec/spec_helper.rb