i18n_emails 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,4 @@
+gem 'rspec',    '2.0.0'
+gem 'i18n'
+gem 'activesupport'
+gem 'actionpack'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activesupport
+  i18n
+  rspec (= 2.0.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matt Vague, VersaPay Corporation
+
+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.rdoc

@@ -0,0 +1,46 @@
+= easy_i18n_emails
+
+I18nEmails makes it easy to create and maintain I18n emails in Rails apps.
+
+Using I18n in large Rails apps often results in large and incomprehensible translation files. The idea of splitting up concerns should also apply to translations files and emails in particular and that is why this gem was created.
+
+I18nEmails allows you to create separate translation files for each email (.email) and store them in a nested folder structure mirroring a translation file, for example: config/locales/en/notifier/forgotten_password.email.
+
+The email body content in a .email file is also more readable for both developer and non-technical people then a YAML file.
+
+== Example email:
+
+    subject: Forgotten password
+
+    heading: It's ok, we all forget our passwords sometimes
+    # Available interpolation args: username, link
+
+    --------------------------------------------
+
+    Hi %{username},
+
+    Click here to reset your password %{link}.
+
+    Have a great day!
+
+== Notes
+
+Anything above the <code>----</code> is still parsed as YAML, but anything below it becomes the body of the email (newlines are converted to <p></p> tags using simple_format)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Contributors
+
+* Greg Bell       http://github.com/gregbell
+
+== Copyright
+
+Copyright (c) 2010 Matt Vague, VersaPay Corporation. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "i18n_emails"
+    gem.summary = %Q{The nicer way to create and maintain emails in Rails apps using I18n}
+    gem.description = %Q{I18nEmails makes it easy to create and maintain I18n emails in Rails apps.
+
+    Using I18n in large Rails apps often results in large and incomprehensible translation files. The idea of splitting up concerns should also apply to translations files and emails in particular and that is why this gem was created.
+
+    I18nEmails allows you to create separate translation files for each email (.email) and store them in a nested folder structure mirroring a translation file, for example: config/locales/en/notifier/forgotten_password.email.
+
+    The email body content in a .email file is also more readable for both developer and non-technical people then a YAML file. }
+    gem.email = "mattvague@gmail.com"
+    gem.homepage = "http://github.com/mattvague/i18n_emails"
+    gem.authors = ["Matt Vague", "Greg Bell", "VersaPay"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "i18n_emails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/i18n_emails.rb

@@ -0,0 +1,62 @@
+require 'i18n'
+require 'active_support'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'action_view'
+require "yaml"
+require "i18n_emails/i18n_extension"
+
+module I18nEmails
+  
+  mattr_accessor :load_path
+  self.load_path = "config/locales/en"
+  
+  class Email
+    
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::TextHelper # to use simple_format
+    
+    BODY_SPLIT = /^-{3,}\n/
+    
+    class << self
+      # Returns a hash of the content of all .email files contained the
+      # the specified directory (searches recursivly)
+      def load_all(dir = I18nEmails.load_path)
+        hash = {}
+      
+        Dir[File.join(dir, "*")].each do |file_or_folder|
+          if File.directory?(file_or_folder)
+            hash[File.basename(file_or_folder)] = Email.load_all(file_or_folder)
+          else
+            if email_file?(file_or_folder)
+              email = Email.new(file_or_folder)
+              hash[email.key] = email.to_hash
+            end
+          end
+        end
+      
+        hash
+      end
+    
+      protected
+      
+      def email_file?(filename)
+        filename =~ /.email$/
+      end
+    end
+    
+    def initialize(path)
+      @path = path
+      @file_contents = File.read(path)
+    end
+    
+    def key
+      File.basename(@path).gsub(".email", '')
+    end
+    
+    def to_hash
+      header, body = @file_contents.split(BODY_SPLIT)
+      YAML::load(header).merge({'body' => simple_format(body)})
+    end
+  end
+end

data/lib/i18n_emails/i18n_extension.rb

@@ -0,0 +1,10 @@
+module I18n
+  class << self
+    def reload_with_emails!
+      reload_without_emails!
+      I18n.backend.store_translations(I18n.default_locale, I18nEmails::Email.load_all)
+    end
+    
+    alias_method_chain :reload!, :emails
+  end
+end

data/spec/fixtures/dont_load.me

@@ -0,0 +1 @@
+subject: NOOOOO!

data/spec/fixtures/en.yml

@@ -0,0 +1,2 @@
+en:
+  hello: World

data/spec/fixtures/forgotten_password.email

@@ -0,0 +1,11 @@
+subject: Forgotten password
+
+heading: It's ok, we all forget our passwords sometimes
+# Available interpolation args: username, link
+
+--------------------------------------------
+Hi %{username},
+
+Click here to reset your password %{link}.
+
+Have a great day!

data/spec/fixtures/nested/a_nested.email

@@ -0,0 +1,11 @@
+subject: Forgotten password
+
+heading: It's ok, we all forget our passwords sometimes
+# Available interpolation args: username, link
+
+-------------------------------
+Hi %{username},
+
+Click here to reset your password %{link}.
+
+Have a great day!

data/spec/fixtures/nested/second_nest/second_nest.email

@@ -0,0 +1,11 @@
+subject: Forgotten password
+
+heading: It's ok, we all forget our passwords sometimes
+# Available interpolation args: username, link
+
+-------------------------------
+Hi %{username},
+
+Click here to reset your password %{link}.
+
+Have a great day!

data/spec/fixtures/with_shorter_split.email

@@ -0,0 +1,11 @@
+subject: Forgotten password
+
+heading: It's ok, we all forget our passwords sometimes
+# Available interpolation args: username, link
+
+-------------------------------
+Hi %{username},
+
+Click here to reset your password %{link}.
+
+Have a great day!

data/spec/i18n_emails_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "I18nEmails" do
+  describe "loading a file" do
+    
+    let(:email_file) {File.expand_path("../fixtures/forgotten_password.email", __FILE__)}
+    let(:email) { I18nEmails::Email.new(email_file) }
+    
+    it "should load the email header keys" do
+      email.to_hash["subject"].should == "Forgotten password"
+      email.to_hash["heading"].should == "It's ok, we all forget our passwords sometimes"
+    end
+    
+    it "should load the email body with newlines converted to paragraph tags" do
+      email.to_hash["body"].should == "<p>Hi %{username},</p>\n\n<p>Click here to reset your password %{link}.</p>\n\n<p>Have a great day!</p>"
+    end
+    
+    context "with a different split" do
+      let(:email_file) {File.expand_path("../fixtures/with_shorter_split.email", __FILE__)}
+      
+      it "should load the email header keys" do
+        email.to_hash["subject"].should == "Forgotten password"
+        email.to_hash["heading"].should == "It's ok, we all forget our passwords sometimes"
+      end
+
+      it "should load the email body" do
+        email.to_hash["body"].should == "<p>Hi %{username},</p>\n\n<p>Click here to reset your password %{link}.</p>\n\n<p>Have a great day!</p>"
+      end
+    end
+    
+    it "should raise an exception if no file" do
+      lambda {
+        I18nEmails::Email.new("/my/non/existent/file")
+      }.should raise_exception(Errno::ENOENT)
+    end
+  end
+  
+  describe "loading files" do
+    
+    let(:email_dir) {File.expand_path("../fixtures/", __FILE__)}
+    
+    it "should load all files in a directory" do
+      I18nEmails::Email.load_all(email_dir).keys.should include("with_shorter_split", "forgotten_password", "nested")
+    end
+    
+    context "from a subdirectory" do
+      it "should load files in a nested hash" do
+        I18nEmails::Email.load_all(email_dir)["nested"].keys.should include("a_nested")
+      end
+      it "should load files nested twice" do
+        I18nEmails::Email.load_all(email_dir)["nested"]["second_nest"].keys.should == ["second_nest"]
+      end
+    end
+    
+    it "should should only load .email files" do
+      I18nEmails::Email.load_all(email_dir).keys.should_not include("dont_load.me")
+    end
+  end
+   
+  describe "loading translations into I18n" do
+    it "should load into a backend" do
+      I18n.load_path = [File.expand_path("../fixtures/en.yml", __FILE__)]
+      I18nEmails.load_path = File.expand_path("../fixtures", __FILE__)
+      I18n.reload!
+      I18n.t("hello").should == "World"
+      I18n.t("forgotten_password.subject").should == "Forgotten password"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i18n_emails'
+
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+
+require 'rubygems'
+require "bundler"
+Bundler.setup
+
+require 'rspec'
+require 'rspec/autorun'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_emails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Vague
+- Greg Bell
+- VersaPay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: "I18nEmails makes it easy to create and maintain I18n emails in Rails apps.\n\n    Using I18n in large Rails apps often results in large and incomprehensible translation files. The idea of splitting up concerns should also apply to translations files and emails in particular and that is why this gem was created.\n\n    I18nEmails allows you to create separate translation files for each email (.email) and store them in a nested folder structure mirroring a translation file, for example: config/locales/en/notifier/forgotten_password.email.\n\n    The email body content in a .email file is also more readable for both developer and non-technical people then a YAML file. "
+email: mattvague@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/i18n_emails.rb
+- lib/i18n_emails/i18n_extension.rb
+- spec/fixtures/dont_load.me
+- spec/fixtures/en.yml
+- spec/fixtures/forgotten_password.email
+- spec/fixtures/nested/a_nested.email
+- spec/fixtures/nested/second_nest/second_nest.email
+- spec/fixtures/with_shorter_split.email
+- spec/i18n_emails_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mattvague/i18n_emails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The nicer way to create and maintain emails in Rails apps using I18n
+test_files: 
+- spec/i18n_emails_spec.rb
+- spec/spec_helper.rb