actionmailer-localized_preview 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d862fc0f1e806a26ad89e18ef376a0fec4500c18
+  data.tar.gz: b999b907118c85e32eacc6214d8e3eb04657dd98
+SHA512:
+  metadata.gz: e634c1b7dd129c9bc1ef02ea87aa89127b5c69cb0e14cd86445f53686daa29fc3e719837c21b0d5168dedba1484a170aa79a28809da10ddca627ce4bf516a4d9
+  data.tar.gz: e380dda48f44858da2674dbb42840662620a5dc6b37a7f4aba4e14363a36fc35db7a76e60fabac42b0d447dfafc97b50dd68ff319f3394e799d814a5da01ea20

data/.gitignore

@@ -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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Xavier Defrang
+
+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,72 @@
+# ActionMailer::LocalizedPreview
+
+This gem extends [ActionMailer::Preview](http://api.rubyonrails.org/classes/ActionMailer/Preview.html) to allow previews of emails in all available locales.
+
+## Usage
+
+Simply include `ActionMailer::LocalizedPreview` in your preview class
+
+```ruby
+require 'action_mailer/localized_preview'
+
+class NotifierPreview < ActionMailer::Preview
+  include ActionMailer::LocalizedPreview
+
+  def account_confirmation
+    account = Account.new(name: "Cosmo Kramer")
+    Notifier.account_confirmation(account)
+  end
+
+end
+
+```
+
+Assuming that `I18n.available_locales` is set to `[:en, :fr, :nl]`, it will make the following preview methods available:
+
+  * `account_confirmation_en`
+  * `account_confirmation_fr`
+  * `account_confirmation_nl`
+
+If you want direct access to the current locale in your mailer preview method, you may add a parameter to your method signature and the locale will be passed on:
+
+```ruby
+require 'action_mailer/localized_preview'
+
+class NotifierPreview < ActionMailer::Preview
+  include ActionMailer::LocalizedPreview
+
+  def account_confirmation(locale)
+    account = Account.new(name: "Cosmo Kramer", prefered_language: locale)
+    Notifier.account_confirmation(account)
+  end
+
+end
+
+```
+
+### Caveats
+
+* This was built for **Rails 4.1 onwards** and **wont work** with the [mail_view](https://github.com/basecamp/mail_view) gem which is the ancestor of the mailer preview feature but sports a different API
+* It hasn't been tested with locales containing a regional setting (e.g. `en-US`, `en-GB`, ...) and these are most probably not supported at this point.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'actionmailer-localized_preview'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actionmailer-localized_preview
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/actionmailer-localized_preview/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/actionmailer-localized_preview.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_mailer/localized_preview/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "actionmailer-localized_preview"
+  spec.version       = ActionMailer::LocalizedPreview::VERSION
+  spec.authors       = ["Xavier Defrang"]
+  spec.email         = ["xavier.defrang@gmail.com"]
+  spec.summary       = %q{Extends ActionMailer::Preview to allow email previews in all available locales}
+  spec.description   = ""
+  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_dependency "actionmailer", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/action_mailer/localized_preview.rb

@@ -0,0 +1,43 @@
+require "action_mailer/localized_preview/version"
+
+module ActionMailer
+  module LocalizedPreview
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def locales
+        I18n.available_locales
+      end
+
+      def emails
+        public_instance_methods(false).each_with_object([]) do |method, list|
+          locales.each do |locale|
+            list << "#{method}_#{locale}"
+          end
+        end.sort
+      end
+
+    end
+
+    def method_missing(localized_method_name, *args)
+      localized_method_name.to_s =~ /(.*)_([^_]+)$/
+      method_name, locale = $1, $2.to_sym
+      current_locale = I18n.locale
+      begin
+        I18n.locale = $2
+        case self.method(method_name).arity
+        when 0
+          public_send(method_name)
+        when 1
+          public_send(method_name, locale)
+        else
+          raise ArgumentError, "wrong number of arguments (expected 0 or 1)"
+        end
+      ensure
+        I18n.locale = current_locale
+      end
+    end
+
+  end
+end

data/lib/action_mailer/localized_preview/version.rb

@@ -0,0 +1,5 @@
+module ActionMailer
+  module LocalizedPreview
+    VERSION = "0.0.1"
+  end
+end

data/spec/localized_preview_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class TestPreview < ActionMailer::Preview
+
+  include ActionMailer::LocalizedPreview
+
+  def mailer1
+    "mailer1_message_with_locale_#{I18n.locale}"
+  end
+
+  def mailer2(locale)
+    "mailer2_message_with_locale_#{locale}"
+  end
+
+  def mailer3(foo, bar)
+    "will raise an error"
+  end
+
+end
+
+describe ActionMailer::LocalizedPreview do
+
+  before do
+    I18n.available_locales = [:en, :fr, :nl]
+  end
+
+  describe ".emails" do
+
+    it "returns localized method names" do
+      expected = %w{mailer1_en mailer1_fr mailer1_nl mailer2_en mailer2_fr mailer2_nl mailer3_en mailer3_fr mailer3_nl}
+      expect(TestPreview.emails).to eq(expected)
+    end
+
+  end
+
+  describe ".call" do
+
+    context "when calling a mailer with no arguments" do
+
+      it "calls the method with the correct locale set" do
+        expect(TestPreview.call("mailer1_en")).to eq("mailer1_message_with_locale_en")
+      end
+
+      it "does not affect the current locale" do
+        expect { TestPreview.call("mailer1_en") }.not_to change(I18n, :locale)
+      end
+
+    end
+
+    context "when calling a mailer which accepts one argument" do
+
+      it "passes the locale as argument to the method" do
+        expect(TestPreview.call("mailer2_fr")).to eq("mailer2_message_with_locale_fr")
+      end
+
+      it "does not affect the current locale" do
+        expect { TestPreview.call("mailer2_fr") }.not_to change(I18n, :locale)
+      end
+
+    end
+
+    context "when calling a mailer which accepts more than one argument" do
+
+      it "raises an error" do
+        expect { TestPreview.call("mailer3_fr") }.to raise_error(ArgumentError)
+      end
+
+      it "does not affect the current locale" do
+        expect do
+          TestPreview.call("mailer3_fr") rescue ArgumentError
+        end.not_to change(I18n, :locale)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'action_mailer'
+require_relative '../lib/action_mailer/localized_preview'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: actionmailer-localized_preview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Xavier Defrang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: ''
+email:
+- xavier.defrang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionmailer-localized_preview.gemspec
+- lib/action_mailer/localized_preview.rb
+- lib/action_mailer/localized_preview/version.rb
+- spec/localized_preview_spec.rb
+- spec/spec_helper.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Extends ActionMailer::Preview to allow email previews in all available locales
+test_files:
+- spec/localized_preview_spec.rb
+- spec/spec_helper.rb