i18n_lazy_scope 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dc1ed2523804d760805abfb82ed7479ffaea98a
+  data.tar.gz: 3e1c861232b2cf3e7cc130eac814bf7c2e013071
+SHA512:
+  metadata.gz: 4ba9f541345de796626518e20843e8865a8a9e2ee303e3cd22d88bc2663a45acf82d3571dcaa182f6419182ae3c17daff7cffdc55c532b3fd753cb9d52787b72
+  data.tar.gz: 0817f901549cc0913798adc9919b9bbe4bc80d4ed44043d1ca13aef1e861ff714d3d274b54657b0068a42b5adbfbd5e6737b36435329a2e651296fb359a41a82

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mohamad El-Husseini
+
+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,152 @@
+# I18nLazyScope
+
+I18nLazyScope is a tiny library that lets you use lazy lookup and keep a better structure for your locale files when localising strings in your Ruby applications. This means quicker translations without sacrificing the structure of your locale files.
+
+```ruby
+# users_controller#create
+redirect_to @user, notice: scoped_t('welcome_message')
+```
+
+```yaml
+en:
+  controllers: # <- Oh, look, it's a controller scope with lazy lookup! Yay!
+    users:
+      create:
+        welcome_message: "You are such a star!"
+```
+
+I18nLazyScope provides a wrapper method around the `translate` and `t` methods in Rails and the Ruby [I18n][3] gem.
+
+## What Problem Does This Solve
+
+Imagine you are in the `users_controller#show` action, and you want to flash a localised welcome message.
+
+```ruby
+def create
+  if @user.save
+    redirect_to @user, notice: t('welcome_message')
+  end
+end
+```
+
+This scopes the translation to `locale.welcome_message`. If your current--or default--locale is English, the corresponding key in your locale file would be `en.welcome_message`.
+
+Oh dear! This is an awful way to structure translations. You want to scope them instead. You create a key in your locale file.
+
+```yaml
+en:
+  controllers:
+    users:
+      create:
+        welcome_message: "You are such a star!"
+```
+
+And you add the key to your code.
+
+```ruby
+redirect_to @user, notice: t('controllers.users.create.welcome_message')
+```
+
+Holy Semantics, Batman! `controllers.users.create` is a lot to type before each key name. And after some time you tire of typing it repeatedly. You read the documentation and discover [lazy lookup][1]--brilliant. You decide to use it, and diligently place a dot before your key name.
+
+```ruby
+redirect_to @user, notice: t('.welcome_message')
+```
+
+Soon after, when testing, you discover that you have a `translation missing` error in your template. This is because lazy lookup will scope the translation to `en.users.create.welcome_message`. The neat `controller` namespace we created is missing.
+
+You have two choices:
+
+1. Change the structure of your locale file to match how lazy lookup works.
+2. Use verbose, fully qualified scopes.
+
+Option one might cause your locale file to become a mess, or worse, cause namespace collisions because views and controllers share part of the namespace: `en.users`. And option two is annoying to type all the time.
+
+**I18nLazyScope** lets you use lazy lookup and keep a better structure for your locale files.
+
+```erb
+redirect_to @user, notice: scoped_t('welcome_message')
+
+```
+
+```yaml
+en:
+  controllers: # or mailers, views, or, whatever you want
+    users:
+      create:
+        welcome_message: "You are such a star!"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_lazy_scope'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_lazy_scope
+
+## Usage
+
+Call the `t_scoped` method instead of `t`, or `translate`, and make sure you have the corresponding keys in your locale file. Say you are in `app/views/users/show.html.erb`.
+
+```erb
+<%= t_scoped 'weclome' %>
+```
+
+```yaml
+en:
+  views:
+    users:
+      show:
+       greeting: "Hello!"
+```
+
+### Interpolation
+
+It works exactly as it would if you call `t` or `translate`.
+
+```erb
+<%= t_scoped 'weclome', name: @user.name %>
+```
+
+```yaml
+en:
+  views:
+    users:
+      show:
+       greeting: "Hello, %{name}!"
+```
+
+### Scoping
+
+If you have to customise the scope on individual basis, then you should use `t` and `translate` that ship with the [I18n][3] gem. Scoping on individual basis defeates the point of this gem. This gem isn't meant to replace the I18n; it's a tiny wrapper that depends on it. But in future releases you will be able to customise top level namespaces, such as `views`, `controllers`, `mailers`, etc.
+
+## API
+
+```ruby
+t_scoped(key, **args)
+```
+
+## A Note on Ruby Versions
+
+I18nLazyScope requires Ruby 2.0 because it uses the [double splat `**` operator][2] to capture all keyword arguments.
+
+## Contributing
+
+1. Fork it ( https://github.com/abitdodgy/i18n_lazy_scope/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
+
+[1]: http://guides.rubyonrails.org/i18n.html#lazy-lookup
+[2]: http://stackoverflow.com/questions/18289152/what-does-a-double-splat-operator-do
+[3]: https://github.com/svenfuchs/rails-i18n

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec "irb -r i18n_lazy_scope -I ./lib"
+end

data/i18n_lazy_scope.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_lazy_scope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_lazy_scope"
+  spec.version       = I18nLazyScope::VERSION
+  spec.authors       = ["Mohamad El-Husseini"]
+  spec.email         = ["husseini.mel@gmail.com"]
+  spec.summary       = %q{Use lazy lookup with custom scopes in your locale files.}
+  spec.description   = %q{I18nLazyScope lets you use lazy lookup and keep a better structure for your locale files when localising strings in your Ruby on Rails application. This means quicker translations without sacrificing the structure of your locale files.}
+  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.7"
+  spec.add_development_dependency "i18n"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/i18n_lazy_scope.rb

@@ -0,0 +1,10 @@
+require "i18n_lazy_scope/version"
+require "i18n_lazy_scope/railtie" if defined?(Rails)
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module I18nLazyScope
+end

data/lib/i18n_lazy_scope/action_controller/helper.rb

@@ -0,0 +1,7 @@
+module I18nLazyScope::ActionController
+  module Helper
+    def lazy_scope
+      [:controllers, controller_name, action_name]
+    end
+  end
+end

data/lib/i18n_lazy_scope/action_mailer/helper.rb

@@ -0,0 +1,7 @@
+module I18nLazyScope::ActionMailer
+  module Helper
+    def lazy_scope
+      [:mailers, mailer_name, action_name]
+    end
+  end
+end

data/lib/i18n_lazy_scope/action_view/helper.rb

@@ -0,0 +1,21 @@
+module I18nLazyScope::ActionView
+  module Helper
+    def t_scoped(key, **args)
+      t(key, scope: lazy_scope(key), **args)
+    end
+
+    def lazy_scope(key)
+      [:views, view_path]
+    end
+
+  private
+
+    def view_path
+      if @virtual_path
+        @virtual_path.gsub(%r{/_?}, ".")
+      else
+        raise "Cannot use t(#{key.inspect}) lazy lookup because path is not available"
+      end
+    end
+  end
+end

data/lib/i18n_lazy_scope/helper.rb

@@ -0,0 +1,7 @@
+module I18nLazyScope
+  module Helper
+    def t_scoped(key, **args)
+      t(key, scope: lazy_scope, **args)
+    end
+  end
+end

data/lib/i18n_lazy_scope/railtie.rb

@@ -0,0 +1,27 @@
+require "rails"
+
+require "i18n_lazy_scope/action_controller/helper"
+require "i18n_lazy_scope/action_mailer/helper"
+require "i18n_lazy_scope/action_view/helper"
+
+require "i18n_lazy_scope/helper"
+
+module I18nLazyScope
+  class Railtie < Rails::Railtie
+    initializer "i18n_lazy_scope.helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        include I18nLazyScope::Helper
+        include I18nLazyScope::ActionController::Helper
+      end
+
+      ActiveSupport.on_load(:action_mailer) do
+        include I18nLazyScope::Helper
+        include I18nLazyScope::ActionMailer::Helper
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include I18nLazyScope::ActionView::Helper
+      end
+    end
+  end
+end

data/lib/i18n_lazy_scope/version.rb

@@ -0,0 +1,3 @@
+module I18nLazyScope
+  VERSION = "0.0.1"
+end

data/spec/i18n_lazy_scope/action_controller/helper_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+class FakeController
+  include I18nLazyScope::ActionController::Helper
+  include I18nLazyScope::Helper
+
+  def t(*args)
+    I18n.t(*args)
+  end
+
+  def controller_name; :users; end
+  def action_name;     :show;  end
+end
+
+describe FakeController do
+  before :each do
+    @controller = FakeController.new
+  end
+
+  describe "#t_scoped" do
+    it "delegates to t" do
+      expect(@controller).to receive(:t)
+      @controller.t_scoped(:key)
+    end
+
+    it "returns correct key with scope" do
+      string = @controller.t_scoped(:hello)
+      expect(string).to eq('World!')
+    end
+
+    it "interpolates passed variables" do
+      string = @controller.t_scoped(:greet, name: 'Mohamad', greeting: 'Hello')
+      expect(string).to eq('Hello, Mohamad!')
+    end
+  end
+end

data/spec/i18n_lazy_scope/action_mailer/helper_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+class FakeMailer
+  include I18nLazyScope::ActionMailer::Helper
+  include I18nLazyScope::Helper
+
+  def t(*args)
+    I18n.t(*args)
+  end
+
+  def mailer_name; :user_mailer;   end
+  def action_name; :welcome_email; end
+end
+
+describe FakeMailer do
+  before :each do
+    @mailer = FakeMailer.new
+  end
+
+  describe "#t_scoped" do
+    it "delegates to t" do
+      expect(@mailer).to receive(:t)
+      @mailer.t_scoped(:key)
+    end
+
+    it "returns correct key with scope" do
+      string = @mailer.t_scoped(:hello)
+      expect(string).to eq('World!')
+    end
+
+    it "interpolates passed variables" do
+      string = @mailer.t_scoped(:subject, name: 'Mohamad', greeting: 'Hello')
+      expect(string).to eq('Hello, Mohamad!')
+    end
+  end
+end

data/spec/i18n_lazy_scope/action_view/helper_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+class FakeView
+  include I18nLazyScope::ActionView::Helper
+
+  def initialize
+    @virtual_path = 'users.show.user_profile'
+  end
+
+  def t(*args)
+    I18n.t(*args)
+  end
+
+  def controller_name; :users; end
+  def action_name;     :show;  end
+end
+
+describe FakeView do
+  before :each do
+    @view = FakeView.new
+  end
+
+  describe "#t_scoped" do
+    it "delegates to t" do
+      expect(@view).to receive(:t)
+      @view.t_scoped(:key)
+    end
+
+    it "returns correct key with scope" do
+      string = @view.t_scoped(:hello)
+      expect(string).to eq('World!')
+    end
+
+    it "interpolates passed variables" do
+      string = @view.t_scoped(:greet, name: 'Mohamad', greeting: 'Hello')
+      expect(string).to eq('Hello, Mohamad!')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "i18n_lazy_scope/helper"
+require "i18n_lazy_scope/action_controller/helper"
+require "i18n_lazy_scope/action_mailer/helper"
+require "i18n_lazy_scope/action_view/helper"
+
+require "i18n"
+
+RSpec.configure do |config|
+  config.before :all do
+    I18n.load_path = [[File.dirname(__FILE__) + '/support/en.yml']]
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/en.yml

@@ -0,0 +1,17 @@
+en:
+  controllers:
+    users:
+      show:
+        hello: "World!"
+        greet: "%{greeting}, %{name}!"
+  mailers:
+    user_mailer:
+      welcome_email:
+        hello: "World!"
+        subject: "%{greeting}, %{name}!"
+  views:
+    users:
+      show:
+        user_profile:
+          hello: "World!"
+          greet: "%{greeting}, %{name}!"

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: i18n_lazy_scope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohamad El-Husseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: I18nLazyScope lets you use lazy lookup and keep a better structure for
+  your locale files when localising strings in your Ruby on Rails application. This
+  means quicker translations without sacrificing the structure of your locale files.
+email:
+- husseini.mel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_lazy_scope.gemspec
+- lib/i18n_lazy_scope.rb
+- lib/i18n_lazy_scope/action_controller/helper.rb
+- lib/i18n_lazy_scope/action_mailer/helper.rb
+- lib/i18n_lazy_scope/action_view/helper.rb
+- lib/i18n_lazy_scope/helper.rb
+- lib/i18n_lazy_scope/railtie.rb
+- lib/i18n_lazy_scope/version.rb
+- spec/i18n_lazy_scope/action_controller/helper_spec.rb
+- spec/i18n_lazy_scope/action_mailer/helper_spec.rb
+- spec/i18n_lazy_scope/action_view/helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/en.yml
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Use lazy lookup with custom scopes in your locale files.
+test_files:
+- spec/i18n_lazy_scope/action_controller/helper_spec.rb
+- spec/i18n_lazy_scope/action_mailer/helper_spec.rb
+- spec/i18n_lazy_scope/action_view/helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/en.yml