acts_as_mailable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ff3332015a7ed1d1495cfa5bfde4573ce9fba2c
+  data.tar.gz: 2b366862795f619edd2c2efa413bc6c677f898d9
+SHA512:
+  metadata.gz: 124d16630eea130d2849f888bf082ae070804b71cb4746cd6e6e05bc148d6af2eaf7f6156307a10f649c86450514ac8b97227e0746420b9eeeb74f8b30640d2a
+  data.tar.gz: a7fb1d254361e16b99410832378f453d83653b86e2cef82d666af2512967d14f94fb95146064db7a0f08557c0a2a3cc97a9048ce0f6266881badf8d8ece5897f

data/.document

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

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "rails", "~> 4.0.0"
+gem "sqlite3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 3.5.0"
+  gem "rdoc", "~> 4.0.1"
+  gem "bundler", ">= 1.3.5"
+  gem "jeweler", "~> 1.8.7"
+  gem "simplecov", ">= 0.7.1"
+end

data/Gemfile.lock

@@ -0,0 +1,135 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    arel (4.0.0)
+    atomic (1.1.14)
+    builder (3.1.4)
+    erubis (2.7.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.3.5)
+  jeweler (~> 1.8.7)
+  rails (~> 4.0.0)
+  rdoc (~> 4.0.1)
+  shoulda (>= 3.5.0)
+  simplecov (>= 0.7.1)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Lachlan Priest
+
+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,49 @@
+[![Code Climate](https://codeclimate.com/github/lachlanp/acts_as_mailable.png)](https://codeclimate.com/github/lachlanp/acts_as_mailable)
+# Acts As Mailable
+
+Allows for email_templates to be added to multiple and different models.
+
+## Installation :
+
+Add the following line to your Gemfile
+
+    gem 'acts_as_mailable'
+
+## Generator
+
+Basic Email Templates
+  rails g email_template
+
+And if you wish to keep a record of emails sent_at etc
+
+    rails g mailable_template
+
+
+Then migrate your database:
+
+    rake db:migrate
+
+## Usage
+
+Make your ActiveRecord model act as commentable:
+
+    class Organisation < ActiveRecord::Base
+      acts_as_mailable
+    end
+
+Add a comment to a model instance:
+
+    mailable = Organisation.create(name: "King")
+    mailable.email_templates.create(name: "First template.", subject: "This is the first template.", body: "This is the body of the first template.")
+
+Fetch email_templates for a mailable model:
+
+    organisation = Organisation.find(1)
+    organisation.email_templates.create(name: "First template.", subject: "This is the first template.", body: "This is the body of the first template.")
+
+
+## Copyright
+
+Copyright (c) 2013 Lachlan Priest. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+desc 'Test the acts_as_mailable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/acts_as_mailable.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_mailable}
+  s.version = "0.0.1"
+
+  s.authors = ["Lachlan Priest"]
+  s.date = %q{2013-09-27}
+  s.description = %q{Plugin/gem that provides custom email templates and mailing functionality}
+  s.email = %q{lachlanpriest@gmail.com}
+  s.files = `git ls-files`.split("\n")
+  s.has_rdoc = false
+  s.license      = 'MIT'
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{2.1.9}
+  s.summary = %q{Plugin/gem that provides custom email functionality}
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/acts_as_mailable.rb

@@ -0,0 +1,2 @@
+require 'mailable_methods'
+require 'email_template_methods'

data/lib/email_template_methods.rb

@@ -0,0 +1,32 @@
+module ActsAsMailable
+  # including this module into your EmailTemplate model will give you finders and named scopes
+  # useful for working with EmailTemplates.
+  # The named scopes are:
+  #   in_order: Returns email_templates in the order they were created (created_at ASC).
+  #   recent: Returns email_templates by how recently they were created (created_at DESC).
+  #   limit(N): Return no more than N email_templates.
+  module EmailTemplate
+
+    def self.included(email_template_model)
+      email_template_model.extend Finders
+      email_template_model.scope :in_order, -> { email_template_model.order('created_at ASC') }
+      email_template_model.scope :recent, -> { email_template_model.reorder('created_at DESC') }
+    end
+
+    module Finders
+      # Helper class method to look up all email_templates for
+      # mailable class name and mailable id.
+      def find_email_templates_for_mailable(mailable_str, mailable_id)
+        where(["mailable_type = ? and mailable_id = ?", mailable_str, mailable_id]).order("created_at DESC")
+      end
+
+      # Helper class method to look up a mailable object
+      # given the mailable class name and id
+      def find_mailable(mailable_str, mailable_id)
+        model = mailable_str.constantize
+        model.respond_to?(:find_email_templates_for) ? model.find(mailable_id) : nil
+      end
+    end
+  end
+end
+

data/lib/generators/email_template/USEGA

@@ -0,0 +1,6 @@
+Description:
+    Copies models to app/models/.
+    Copies migrations to db/migrate
+
+Examples:
+    `rails generate email_template`

data/lib/generators/email_template/email_template_generator.rb

@@ -0,0 +1,6 @@
+class EmailTemplateGenerator < TemplateGenerator
+  def create_model_file
+    template "email_template.rb", "app/models/email_template.rb"
+    migration_template "create_email_template.rb", "db/migrate/create_mailable.rb"
+  end
+end

data/lib/generators/email_template/mailable_template_generator.rb

@@ -0,0 +1,6 @@
+class MailableTemplateGenerator < TemplateGenerator
+  def create_model_file
+    template "mailable_template.rb", "app/models/mailable_template.rb"
+    migration_template "create_mailable_templates.rb", "db/migrate/create_mailable.rb"
+  end
+end

data/lib/generators/email_template/template_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/migration'
+
+class TemplateGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_acts_as_mailable_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/email_template/templates/create_email_templates.rb

@@ -0,0 +1,19 @@
+class CreateEmailTemplates < ActiveRecord::Migration
+  def self.up
+    ##Email templates
+    create_table :email_templates do |t|
+      t.string   :name
+      t.string   :subject
+      t.text     :body
+      t.references :mailable, polymorphic: true
+      t.timestamps
+    end
+    add_index :email_templates, :mailable_type
+    add_index :email_templates, :mailable_id
+  end
+
+  def self.down
+    drop_table :email_templates
+  end
+end
+

data/lib/generators/email_template/templates/create_mailable_templates.rb

@@ -0,0 +1,21 @@
+class CreateMailableTemplates < ActiveRecord::Migration
+  def self.up
+
+    ## Email history
+    create_table :mailable_templates do |t|
+      t.integer  :email_template_id
+      t.integer  :author_id
+      t.string   :recipients
+      # t.datetime :sent_at #uncomment if you intend to create templates before sending, ie maintenance emailing.
+      t.timestamps
+    end
+
+    add_index :mailable_templates, :author_id
+    add_index :mailable_templates, :email_template_id
+  end
+
+  def self.down
+    drop_table :mailable_templates
+  end
+end
+

data/lib/generators/email_template/templates/email_template.rb

@@ -0,0 +1,9 @@
+class EmailTemplate < ActiveRecord::Base
+
+  include ActsAsMailable::EmailTemplate
+
+  belongs_to :mailable, polymorphic: true
+
+  has_many :mailable_templates
+  default_scope -> { order('created_at ASC') }
+end

data/lib/generators/email_template/templates/mailable_template.rb

@@ -0,0 +1,4 @@
+class MailableTemplate < ActiveRecord::Base
+  belongs_to :email_template
+  belongs_to :author, class_name: 'User'
+end

data/lib/mailable_methods.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+
+#ActsAsMailable
+module Monola
+  module Acts
+    module Mailable
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_mailable
+          has_many :email_templates, as: :mailable, dependent: :destroy
+
+          def self.find_email_templates_for(obj)
+            mailable = self.base_class.name
+            EmailTemplate.find_email_templates_for_mailable(mailable, obj.id)
+          end
+
+          def email_templates_ordered_by_submitted
+            EmailTemplate.find_email_templates_for_mailable(self.class.name, id).order("created_at")
+          end
+
+          def add_email_template(email_template)
+            email_templates << email_template
+          end
+        end
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, Monola::Acts::Mailable)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'acts_as_mailable')

data/test/acts_as_mailable_test.rb

@@ -0,0 +1,89 @@
+require 'test/unit'
+require 'logger'
+require 'pry'
+require File.expand_path(File.dirname(__FILE__) + '/../rails/init')
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+class ActsAsMailableTest < Test::Unit::TestCase
+
+  def setup_mailable
+    require File.expand_path(File.dirname(__FILE__) + '/../lib/generators/email_template/templates/create_email_templates.rb')
+    CreateEmailTemplates.up
+    require File.expand_path(File.dirname(__FILE__) + '/../lib/generators/email_template/templates/create_mailable_templates.rb')
+    CreateMailableTemplates.up
+    load(File.expand_path(File.dirname(__FILE__) + '/../lib/generators/email_template/templates/email_template.rb'))
+    load(File.expand_path(File.dirname(__FILE__) + '/../lib/generators/email_template/templates/mailable_template.rb'))
+  end
+
+  def setup_test_models
+    load(File.expand_path(File.dirname(__FILE__) + '/schema.rb'))
+    load(File.expand_path(File.dirname(__FILE__) + '/models.rb'))
+  end
+
+  def setup
+    setup_mailable
+    setup_test_models
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  def test_create_email_template
+    organisation = Organisation.create(:name => "Organisation One")
+    assert_not_nil organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.").id
+  end
+
+  def test_fetch_email_templates
+    organisation = Organisation.create(:name => "Organisation One")
+    organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    mailable = Organisation.find(1)
+    assert_equal 1, mailable.email_templates.length
+    assert_equal "First template.", mailable.email_templates.first.name
+    assert_equal "This is the first template.", mailable.email_templates.first.subject
+  end
+
+  def test_find_email_templates_for_mailable
+    organisation = Organisation.create(:name => "Organisation One")
+    email_template = organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    assert_equal [email_template], EmailTemplate.find_email_templates_for_mailable(organisation.class.name, email_template.id)
+  end
+
+  def test_find_mailable
+    organisation = Organisation.create(:name => "Organisation One")
+    email_template = organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    assert_equal organisation, EmailTemplate.find_mailable(organisation.class.name, email_template.id)
+  end
+
+  def test_find_email_templates_for
+    organisation = Organisation.create(:name => "Organisation One")
+    email_template = organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    assert_equal [email_template], Organisation.find_email_templates_for(organisation)
+  end
+
+  def test_email_templates_ordered_by_submitted
+    organisation = Organisation.create(:name => "Organisation One")
+    email_template = organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    email_template2 = organisation.email_templates.create(:name => "Second template.", :subject => "This is the second template.")
+    assert_equal [email_template2, email_template], organisation.email_templates.recent
+  end
+
+  def test_add_email_template
+    organisation = Organisation.create(:name => "Organisation One")
+    email_template = EmailTemplate.new(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    organisation.email_templates << email_template
+    assert_equal [email_template], organisation.email_templates
+  end
+
+  def test_create_mailable_template
+    organisation = Organisation.create(:name => "Organisation One")
+    user = User.create(name: "James")
+    email_template = organisation.email_templates.create(:name => "First template.", :subject => "This is the first template.", body: "This is the body of the first template.")
+    assert_not_nil MailableTemplate.create(email_template_id: email_template.id, author_id: user.id).id
+  end
+
+end

data/test/models.rb

@@ -0,0 +1,6 @@
+class Organisation < ActiveRecord::Base
+  acts_as_mailable
+end
+
+class User < ActiveRecord::Base
+end

data/test/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :organisations do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :users do |u|
+    u.string :name
+    u.integer :organisation_id
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_mailable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lachlan Priest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies: []
+description: Plugin/gem that provides custom email templates and mailing functionality
+email: lachlanpriest@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_mailable.gemspec
+- init.rb
+- lib/acts_as_mailable.rb
+- lib/email_template_methods.rb
+- lib/generators/email_template/USEGA
+- lib/generators/email_template/email_template_generator.rb
+- lib/generators/email_template/mailable_template_generator.rb
+- lib/generators/email_template/template_generator.rb
+- lib/generators/email_template/templates/create_email_templates.rb
+- lib/generators/email_template/templates/create_mailable_templates.rb
+- lib/generators/email_template/templates/email_template.rb
+- lib/generators/email_template/templates/mailable_template.rb
+- lib/mailable_methods.rb
+- rails/init.rb
+- test/acts_as_mailable_test.rb
+- test/models.rb
+- test/schema.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.1.9
+signing_key: 
+specification_version: 4
+summary: Plugin/gem that provides custom email functionality
+test_files: []