the_merger 0.0.3 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/internal/db/combustion_test.sqlite

data/Gemfile

@@ -1,4 +1,15 @@
 source 'https://rubygems.org'
-gem 'rake'
+
+group :test do
+  gem 'activerecord'
+  gem 'actionmailer'
+  gem 'actionpack' # action_controller, action_view
+  gem 'sqlite3'
+  gem 'debugger'
+  gem 'sprockets'
+  gem 'rspec-rails'
+  gem 'combustion', '~> 0.5.0'
+end
+
 # Specify your gem's dependencies in the_merger.gemspec
 gemspec

data/{README.md → README.org}

@@ -1,4 +1,4 @@
-# TheMerger
+* TheMerger
 
 A mail merge gem which allows you to do the following;
 - link to a table eg: clients. 
@@ -8,10 +8,10 @@ A mail merge gem which allows you to do the following;
 - manages bulk emails
 - manages scheduled emails (optional)
 
-## Demo app
+** Demo app
 There is a demo app here: https://github.com/map7/mailout
 
-## Installation
+** Installation
 
 Add this line to your application's Gemfile:
 
@@ -25,7 +25,7 @@ Or install it yourself as:
 
     $ gem install the_merger
 
-## Configure
+** Configure
 
 When using TheMerger in a controller you have to add the following line to the top
     
@@ -47,15 +47,17 @@ Where you need to insert fields (I usually create a 'letters' table) put the fol
     <%= field_selection %>
 
 
-## Usage
+** Usage
 
 Currently it's just one method and this is how you pass it information
 
-    body = "Dear [firstname] [lastname], Please update your listing, from Mick"
-    TheMerger.merge_fields(body, "firstname", "lastname")
+    TheMerger.mail_merge(
+		from: "from@example.com",
+		subject: "update_listing",
+		body: "Dear [firstname] [lastname], Please update your listing, from Mick")
 
 
-## Contributing
+** Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -63,12 +65,14 @@ Currently it's just one method and this is how you pass it information
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## TODO
-
- - DONE - Get all users from the users table
- - DONE - Mail merge and output to the screen
- - DONE - Make the table a variable
- - DONE - Create a method to get all fields from the selected table.
- - DONE - Create a helper method to have a dropdown of fields
- - DONE - Turn this into an engine so that I can include asset pipeline javascript.
- - DONE - Get the Email all button to work
+** Tasks
+*** DONE Get all users from the users table
+*** DONE Mail merge and output to the screen
+*** DONE Make the table a variable
+*** DONE Create a method to get all fields from the selected table.
+*** DONE Create a helper method to have a dropdown of fields
+*** DONE Turn this into an engine so that I can include asset pipeline javascript.
+*** DONE Get the Email all button to work
+
+*** TODO Write tests
+*** TODO Schedule repetitive mail outs

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/the_merger/version.rb

@@ -1,3 +1,3 @@
 module TheMerger
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/the_merger.rb

@@ -7,45 +7,57 @@ module TheMerger
   # - merge_model:   User
   #
 
-  def merge_fields(subject,original_body)
-    parse_config
-    
-    @merge_model.constantize.all.each do |user|
-      body = original_body.dup
+  #
+  # Merge the fields into the body and send emails
+  #
+  def mail_merge(options={})
+    # For all users
+    model.all.each do |user|
+      
+      # Merge fields for this user into the body
+      body = merge_fields(options[:body].dup, user)
       
-      model_fields.each do |field|
-        newbody = body.gsub!("[#{field}]", user.send(field))
-        body = newbody unless newbody.nil?
-      end
-
       # Send the emails
-      mailer = TheMerger::Mailer.batch_mail("from@example.com", subject, body, user)
-      mailer.deliver
-
+      TheMerger::Mailer.batch_mail(options[:from], options[:subject], body, user).deliver
     end
   end
+  
+  #
+  # Replace fields which are in square brackets with data from the chosen model.
+  #
+  def merge_fields(body,user)
+    fields.each do |field|
+      body = body.gsub!("[#{field}]", user.send(field)) || body
+    end
+    body
+  end
 
+  #
+  # View Helper method (Optional)
+  #
+  # Selection box with fields from your model and an insert button
+  #
   def field_selection
-    body = select_tag :field, options_for_select(model_fields)
+    body = select_tag :field, options_for_select(fields)
     body += button_tag "Insert", class: "insert_field"
     content_tag(:div, body, class: "merge_field")
   end
 
-  def model_fields
-    parse_config
-    @merge_model.constantize.attribute_names.reject{|x| %w[created_at updated_at id].include?(x)}
+  #
+  # Return all the fields from your configured model except created_at, updated_at & id
+  #
+  def fields
+    model.attribute_names.reject{|x| %w[created_at updated_at id].include?(x)}
   end
   
   private
 
-  def parse_config
-    path = "#{Rails.root}/config/the_merger.yml"
-    
-    if File.exists?(path)
+  def model
+    if File.exists?(path = "#{Rails.root}/config/the_merger.yml")
       conf=YAML::load(IO.read(path))
-      @merge_model = conf["merge_model"]
+      conf["merge_model"].constantize
     else
-      @merge_model = "User"
+      User
     end
   end  
 end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  create_table "letters", :force => true do |t|
+    t.string   "subject"
+    t.string   "body"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "firstname"
+    t.string   "lastname"
+    t.string   "email"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+end

data/spec/internal/log/.gitignore

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

data/spec/lib/the_merger_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+include TheMerger
+
+class User < ActiveRecord::Base
+  attr_accessible :email, :firstname, :lastname
+end
+
+describe TheMerger do
+
+  before do
+    @user = User.create(firstname: "Michael", lastname: "Pope", email: "map7777@gmail.com")
+  end
+
+  describe "#merge_fields" do
+    context "body is set to Dear [firstname] [lastname]" do
+      it "replaces [firstname] & [lastname] with Michael & Pope respectively" do
+        merge_fields("Dear [firstname] [lastname]",@user).should eq("Dear Michael Pope")
+      end
+    end
+
+    context "body is set to Dear [firstname] [lastname], [address]" do
+      it "replaces fields which exist in the model" do
+        merge_fields("Dear [firstname] [lastname], [address]",@user).should eq("Dear Michael Pope, [address]")
+      end
+    end
+  end
+
+  describe "#fields" do
+    it "returns fields for the model excluding created_at, updated_at & id" do
+      fields.should eq(%w[firstname lastname email])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+
+Combustion.initialize! :action_view, :action_mailer, :active_record, :sprockets
+
+require 'rspec/rails'
+
+# RSpec.configure do |config|
+#   config.use_transactional_fixtures = true
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_merger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies: []
 description: Mail merge a table of fields into a standard letter
 email:
@@ -21,16 +21,23 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.org
 - Rakefile
 - app/assets/javascript/jquery.caret.1.02.js
 - app/assets/javascript/the_merger/application.js.coffee
 - app/assets/javascript/the_merger/insert_field.js.coffee
 - app/mailer/the_merger/mailer.rb
+- config.ru
 - lib/the_merger.rb
 - lib/the_merger/engine.rb
 - lib/the_merger/version.rb
-- lib/the_merger/view_helpers/field_selector.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/the_merger_spec.rb
+- spec/spec_helper.rb
 - the_merger.gemspec
 homepage: https://github.com/map7/the_merger
 licenses: []
@@ -44,16 +51,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1235780733984697328
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1235780733984697328
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Mail Merge
-test_files: []
+test_files:
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/the_merger_spec.rb
+- spec/spec_helper.rb

data/lib/the_merger/view_helpers/field_selector.rb

@@ -1,9 +0,0 @@
-module TheMerger
-  module ViewHelpers
-    class FieldSelector
-      def select_field
-        "<b>Select field box</b>"
-      end
-    end
-  end
-end