email_prefixer 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7702d0b953f2c520988dc25b8cff260d405fd0ad
-  data.tar.gz: 19c241633096b2754c8cb081f12e4ec027d3de3a
+  metadata.gz: b61b05c800103a57cec9350aaa65927affc4d587
+  data.tar.gz: ce1f60d57950924b048d6f17d3919dcf5f461b95
 SHA512:
-  metadata.gz: 6c88e03eeec1aa766f24692d4735aa2595b9b277d33435e358c5826550bf6c1f785e5f12adc18a666c14d25b0e5f33c1204be6c4e509d8d4aafb81aefacce6dd
-  data.tar.gz: 01fc43833f98b12d051fa7a0ea3e1db4fa1f14ed2295226dc661a3aa88c73dc30185d233bd29697960f7ac058083cbe4fb384c7002d00ddf708ec8ab098aa643
+  metadata.gz: 4145cf9ded7b88ade8a6467f7616c88116c74af43055aa9ff732008def8aa1339a8dd74d59da279526c906f8b7fbd84d0a02ec0b9ae89023c3a705a4ae708234
+  data.tar.gz: c6a2266d03a164ecbac1f405c553a6043efbd2f62fae69da4430162a7931a4b5b29f0ca02aa8809224516c3aeb740a3aeeaa741ff4bf3ee8767a4274861aa32f

data/README.md

@@ -25,17 +25,41 @@ gem 'email_prefixer'
 ```
 
 ## Configuration
+All EmailPrefixer configuration can be customized using
+a standard Rails config initializer.
 
-#### Custom Application Name
-EmailPrefixer automatically infers the application name
-from the Rails application class name, but this can be
-changed using a standard config/initializer.
+```ruby
+# config/initializers/email_prefixer.rb
+EmailPrefixer.configure do |config|
+  # custom configuration goes here
+end
+```
+
+Some of the more common configuration options are listed here.
+See the source code and test suite for a full list of options.
+
+#### application_name - Customize Application Name
+The application name is automatically inferred from the Rails application class name
+and can be overridden via the `application_name` setting.
+
+Example:
+```ruby
+# config/initializers/email_prefixer.rb
+EmailPrefixer.configure do |config|
+  config.application_name = 'MyApp'
+end
+```
+
+#### stage_name - Customize Environment Stage Name
+The application environment/stage name is automatically
+inferred from the running Rails.env and it can be overridden
+via the `stage_name` setting.
 
 Example:
 ```ruby
 # config/initializers/email_prefixer.rb
 EmailPrefixer.configure do |config|
-  config.application_name = 'MyCompany'
+  config.stage_name = 'demo'
 end
 ```
 

data/lib/email_prefixer/configuration.rb

@@ -1,5 +1,5 @@
 module EmailPrefixer
   class Configuration
-    attr_accessor :application_name
+    attr_accessor :application_name, :stage_name
   end
 end

data/lib/email_prefixer/interceptor.rb

@@ -1,5 +1,12 @@
 module EmailPrefixer
   class Interceptor
+    extend Forwardable
+    def_delegators :@configuration, :application_name, :stage_name
+
+    def initialize
+      @configuration = EmailPrefixer.configuration
+    end
+
     def delivering_email(mail)
       mail.subject.prepend(subject_prefix)
     end
@@ -9,8 +16,8 @@ module EmailPrefixer
 
     def subject_prefix
       prefixes = []
-      prefixes << EmailPrefixer.configuration.application_name
-      prefixes << Rails.env.upcase unless Rails.env.production?
+      prefixes << application_name
+      prefixes << stage_name.upcase unless stage_name == 'production'
       "[#{prefixes.join(' ')}] "
     end
   end

data/lib/email_prefixer/railtie.rb

@@ -6,6 +6,7 @@ module EmailPrefixer
       ActionMailer::Base.register_interceptor(interceptor)
       EmailPrefixer.configure do |config|
         config.application_name ||= app.class.parent_name
+        config.stage_name ||= Rails.env
       end
     end
   end

data/lib/email_prefixer/version.rb

@@ -1,3 +1,3 @@
 module EmailPrefixer
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/spec/lib/email_prefixer/interceptor_spec.rb

@@ -2,12 +2,42 @@ require 'rails_helper'
 
 RSpec.describe EmailPrefixer::Interceptor do
   describe '#delivering_email' do
-    before do
-      ExampleMailer.simple_mail.deliver
+    subject(:email) { ExampleMailer.simple_mail }
+    context 'when application_name is configured' do
+      before do
+        email.deliver_now
+      end
+      it 'adds prefix to delivered mail subject' do
+        expect(email.subject).to eq '[CustomApp TEST] Here is the Subject'
+      end
     end
-    it 'adds prefix to delivered mail subject' do
-      mail = ActionMailer::Base.deliveries.last
-      expect(mail.subject).to eq '[CustomApp TEST] Here is the Subject'
+
+    context 'when stage_name is configured' do
+      before do
+        @original_stage_name = EmailPrefixer.configuration.stage_name
+        EmailPrefixer.configuration.stage_name = 'staging'
+        email.deliver_now
+      end
+      after do
+        EmailPrefixer.configuration.stage_name = @original_stage_name
+      end
+      it 'adds custom stage name to subject' do
+        expect(email.subject).to eq '[CustomApp STAGING] Here is the Subject'
+      end
+    end
+
+    context 'when stage_name == production' do
+      before do
+        @original_stage_name = EmailPrefixer.configuration.stage_name
+        EmailPrefixer.configuration.stage_name = 'production'
+        email.deliver_now
+      end
+      after do
+        EmailPrefixer.configuration.stage_name = @original_stage_name
+      end
+      it 'does not add the stage_name to the subject' do
+        expect(email.subject).to eq '[CustomApp] Here is the Subject'
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'coveralls'
 Coveralls.wear!
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
+Dir[File.join('support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_prefixer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Sonnek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails