lazy_mail 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 thomas floch
+
+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,109 @@
+= Lazy Mail
+
+lazy_mail is a lazy and quick way to use the function mail and offers configurations to write less code.
+
+== Installation
+
+<b>This Gem works only for Rails 3</b>
+
+Add this to your Gemfile and run the +bundle+ command.
+
+  gem 'lazy_mail'
+
+== Usage
+
+=== 1. Basics
+
+Your mailer before was:
+
+  class UserMailer < ActionMailer::Base
+    default :from => 'test@test.com'
+  
+    def confirmation(user)
+      @user = user
+      mail(:to => user.email, :subject => 'confirm')
+    end
+  end
+
+With lazy_mail you just write less code.
+lazy_mail set +user+ as an instance variable <tt>@user</tt> by default.
+
+  class UserMailer < ActionMailer::Base
+    def confirmation(user)
+      lazy_mail user
+    end
+  end
+
+And you email view doesn't change:
+
+  Hello <%= @user.username %>
+
+You can still use the options of mail:
+
+  lazy_mail user, { :to => 'another@test.com', :subject => 'my subject' }
+  
+
+You can pass many arguments as you like:
+
+  def confirmation(user, post, author)
+    lazy_mail user, post, author
+  end
+
+and just use in your mail view <tt>@user</tt>, <tt>@post</tt>, <tt>@autor</tt>.
+
+
+=== 2. Configurations
+
+=== Mailer Views
+
+The views are now located in a different folder: +app/views/notifications/mailer_name/current_locale/+
+For example your locale is english the path will be:
+
+  views/notifications/user_mailer/en/confirmation.text.erb
+
+You can set the path you want in your initializer with:
+  
+  LazyMail.mailer_templates_path = 'notification'
+
+If you set it to +nil+ it will take the default rails path
+
+=== Option :to
+
+The mail option :to is set by default, but you have to configure it in your initializer:
+
+  Lazy.user_model = User
+
+Just put the name of the model you want to use to set the :to.
+
+By default it will call the method email, if you have another name change it in your initializer.
+
+  LazyMail.email_field = :email
+
+=== I18n subject
+
+The subject is a scope: <tt>[:mailer, :mailer_name, :action_name]</tt>, you can change it:
+  
+  LazyMail.i18n_scope = [:mailer, :class_name, :action_name]
+  => 'mailer.user_mailer.confirmation.subject'
+  
+If you prefer to use the rails default just set it to +nil+
+
+=== Option :from
+
+Set the option :from in the initializer
+
+  LazyMail.default_no_reply = 'no-reply@test.com'
+  
+=== Development
+
+For the development phase, you can set an option :to by default to overwrite +user.email+
+
+  LazyMail.development_mail = 'my_mail@test.com'
+
+If you use Git:
+
+  LazyMail.development_mail = :git
+  
+lazy_mail will take your git <tt>git config user.email</tt>
+
+You can find the initializer file {here}[https://github.com/arkes/lazy_mail/wiki/initializer]

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LazyMail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/lazy_mail.rb

@@ -0,0 +1,102 @@
+require 'lazy_mail/git'
+
+module LazyMail
+
+  class << self
+    class_attribute :mailer_templates_path, :default_no_reply, :user_model,
+                    :email_field, :development_mail, :i18n_scope
+    
+    self.mailer_templates_path = 'notifications'
+    self.default_no_reply = 'no-reply@set-the-no-reply.com'
+    self.user_model = nil
+    self.email_field = :email
+    self.development_mail = :git
+    self.i18n_scope = [:mailer, :class_name, :action_name]
+  end
+
+  def self.included(base)
+    base.class_eval do
+      include LazyMail::Git
+      include LazyMail::InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+
+    def lazy_mail(*args)
+      setup_mail(args)
+      mail headers_for
+    end
+
+    private
+
+    def setup_mail(args)
+      @options = args.extract_options!
+      set_resources(args)
+      @class_name = self.class.name.underscore
+      @action_name = self.action_name
+    end
+    
+    def set_resources(args)
+      if LazyMail.user_model.nil?
+        raise ArgumentError, 'lazy_mail: you need to define a user_model or use option :to'
+      end
+      args.each do |arg|
+        variable_name = arg.class.name.underscore
+        variable_name = set_valid_name("#{variable_name}", 2) if instance_variable_defined?("@#{variable_name}")
+        instance_variable_set("@#{variable_name}", arg)
+      end
+      if !instance_variable_defined?("@#{user_model.to_s.downcase}") and !@options.has_key?(:to)
+        raise ArgumentError, "lazy_mail should have an instance of #{user_model.to_s} or an option :to"
+      end
+    end
+    
+    def set_valid_name(variable_name, count)
+      return set_valid_name("#{variable_name}", count + 1) if instance_variable_defined?("@#{variable_name}_#{count}")
+      return "#{variable_name}_#{count}"
+    end
+    
+    def headers_for
+      headers = {
+        :subject       => @options.has_key?(:subject) ? @options[:subject] : translate_subject,
+        :from          => @options.has_key?(:from) ? @options[:from] : LazyMail.default_no_reply,
+        :to            => @options.has_key?(:to) ? @options[:to] : get_email,
+        :template_path => @options.has_key?(:template_path) ? @options[:template_path] : template_path
+      }
+      headers
+    end
+
+    def template_path
+      unless LazyMail.mailer_templates_path.nil?
+        File.join(LazyMail.mailer_templates_path, @class_name, I18n.locale.to_s)
+      end
+    end
+
+    def translate_subject
+      return nil if LazyMail.i18n_scope.nil?
+      i18n_scope = LazyMail.i18n_scope.map { |key| instance_variable_defined?("@#{key}") ? instance_variable_get("@#{key}") : key }
+      I18n.t(:subject, :scope => i18n_scope)
+    end
+    
+    def user_model
+      LazyMail.user_model
+    end
+    
+    def get_email
+      if Rails.env == 'development'
+        return development_mail if development_mail.is_a?(String)
+        return send("#{development_mail}_email") if development_mail.is_a?(Symbol)
+        raise ArgumentError, 'option development_mail should be a String or a Symbol'
+      else
+        instance_variable_get("@#{user_model.to_s.downcase}").send(LazyMail.email_field)
+      end
+    end
+    
+    def development_mail
+      LazyMail.development_mail
+    end
+    
+  end
+end
+
+ActionMailer::Base.send :include, LazyMail

data/lib/lazy_mail/git.rb

@@ -0,0 +1,21 @@
+module LazyMail
+  module Git
+    
+    def git_email
+      email = user_email
+      return email.chomp unless email.blank?
+      message_no_email
+    end
+    
+    private
+
+    def user_email
+      `git config user.email`
+    end
+
+    def message_no_email
+      warn "* You have not configured your git with user.email"
+    end
+
+  end
+end

data/lib/lazy_mail/version.rb

@@ -0,0 +1,3 @@
+module LazyMail
+  VERSION = "0.1.0"
+end

data/spec/db/models.rb

@@ -0,0 +1,11 @@
+class User < ActiveRecord::Base
+  attr_accessible :email, :username
+end
+
+class Client < ActiveRecord::Base
+  attr_accessible :email, :username
+end
+
+class Other < ActiveRecord::Base
+  attr_accessible :test_mail, :username
+end

data/spec/db/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :users, :force => true do |t|
+    t.string  :username
+    t.string  :email
+  end
+  
+  create_table :clients, :force => true do |t|
+    t.string  :username
+    t.string  :email
+  end
+  
+  create_table :others, :force => true do |t|
+    t.string  :username
+    t.string  :test_mail
+  end
+  
+end

data/spec/db/seeds.rb

@@ -0,0 +1,4 @@
+User.create!(:email => 'tom@test.com', :username => 'tom')
+User.create!(:email => 'tomtom@test.com', :username => 'tomtom')
+Client.create!(:email => 'bob@test.com', :username => 'bob')
+Other.create!(:test_mail => 'plop@test.com', :username => 'plop')

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.