lotus-mailer 0.0.0 → 0.1.0

data/lib/lotus/mailer/rendering/template_name.rb

@@ -0,0 +1,52 @@
+require 'lotus/utils/string'
+
+module Lotus
+  module Mailer
+    module Rendering
+      # @since 0.1.0
+      # @api private
+      #
+      # TODO this is identical to Lotus::View, consider to move into Lotus::Utils
+      class TemplateName
+        # @since 0.1.0
+        # @api private
+        NAMESPACE_SEPARATOR = '::'.freeze
+
+        # @since 0.1.0
+        # @api private
+        def initialize(name, namespace)
+          @name = name
+          compile!(namespace)
+        end
+
+        # @since 0.1.0
+        # @api private
+        def to_s
+          @name
+        end
+
+        private
+        # @since 0.1.0
+        # @api private
+        def compile!(namespace)
+          tokens(namespace) { |token| replace!(token) }
+          @name = Utils::String.new(@name).underscore
+        end
+
+        # @since 0.1.0
+        # @api private
+        def tokens(namespace)
+          namespace.to_s.split(NAMESPACE_SEPARATOR).each do |token|
+            yield token
+          end
+        end
+
+        # @since 0.1.0
+        # @api private
+        def replace!(token)
+          @name.gsub!(%r{\A#{ token }#{ NAMESPACE_SEPARATOR }}, '')
+        end
+      end
+    end
+  end
+end

data/lib/lotus/mailer/rendering/templates_finder.rb

@@ -0,0 +1,133 @@
+require 'lotus/mailer/template'
+
+module Lotus
+  module Mailer
+    module Rendering
+      # Find templates for a mailer
+      #
+      # @api private
+      # @since 0.1.0
+      #
+      # @see Mailer::Template
+      class TemplatesFinder
+        # Default format
+        #
+        # @api private
+        # @since 0.1.0
+        FORMAT    = '*'.freeze
+
+        # Default template engines
+        #
+        # @api private
+        # @since 0.1.0
+        ENGINES   = '*'.freeze
+
+        # Recursive pattern
+        #
+        # @api private
+        # @since 0.1.0
+        RECURSIVE = '**'.freeze
+
+        # Initialize a finder
+        #
+        # @param mailer [Class] the mailer class
+        #
+        # @api private
+        # @since 0.1.0
+        def initialize(mailer)
+          @mailer = mailer
+        end
+
+        # Find all the associated templates to the mailer.
+        # It recursively looks for templates under the root path of the mailer,
+        # that are matching the template name
+        #
+        # @return [Hash] the templates
+        #
+        # @api private
+        # @since 0.1.0
+        #
+        # @see Lotus::Mailer::Dsl#root
+        # @see Lotus::Mailer::Dsl#templates
+        #
+        # @example
+        #   require 'lotus/mailer'
+        #
+        #   module Mailers
+        #     class Welcome
+        #       include Lotus::Mailer
+        #     end
+        #   end
+        #
+        #   Mailers::Welcome.root     # => "/path/to/templates"
+        #   Mailers::Welcome.templates # => {[:html] => "welcome"}
+        #
+        #   # This mailer has a template:
+        #   #
+        #   #   "/path/to/templates/welcome.html.erb"
+        #
+        #   Lotus::Mailer::Rendering::TemplatesFinder.new(Mailers::Welcome).find
+        #     # => [#<Lotus::Mailer::Template:0x007f8a0a86a970 ... @file="/path/to/templates/welcome.html.erb">]
+        def find
+          templates = Hash.new
+          _find.map do |template|
+            name = File.basename(template)
+            format = (( name.split(".") )[-2]).to_sym
+            templates[ format ] = Mailer::Template.new(template)
+          end
+          templates
+        end
+
+        protected
+
+        # @api private
+        # @since 0.1.0
+        def _find(lookup = search_path)
+          Dir.glob( "#{ [root, lookup, template_name].join(separator) }.#{ format }.#{ engines }" )
+        end
+
+        # @api private
+        # @since 0.1.0
+        def template_name
+          Rendering::TemplateName.new(@mailer.template, @mailer.configuration.namespace).to_s
+        end
+
+        # @api private
+        # @since 0.1.0
+        def root
+          @mailer.configuration.root
+        end
+
+        # @api private
+        # @since 0.1.0
+        def search_path
+          recursive
+        end
+
+        # @api private
+        # @since 0.1.0
+        def recursive
+          RECURSIVE
+        end
+
+        # @api private
+        # @since 0.1.0
+        def separator
+          ::File::SEPARATOR
+        end
+
+        # @api private
+        # @since 0.1.0
+        def format
+          FORMAT
+        end
+
+        # @api private
+        # @since 0.1.0
+        def engines
+          ENGINES
+        end
+      end
+    end
+  end
+end

data/lib/lotus/mailer/template.rb

@@ -0,0 +1,40 @@
+require 'tilt'
+
+module Lotus
+  module Mailer
+    # A logic-less template.
+    #
+    # @api private
+    # @since 0.1.0
+    #
+    # TODO this is identical to Lotus::View, consider to move into Lotus::Utils
+    class Template
+      def initialize(template)
+        @_template = Tilt.new(template)
+      end
+
+      # Render the template within the context of the given scope.
+      #
+      # @param scope [Class] the rendering scope
+      # @param locals [Hash] set of objects passed to the constructor
+      #
+      # @return [String] the output of the rendering process
+      #
+      # @api private
+      # @since 0.1.0
+      def render(scope = Object.new, locals = {})
+        @_template.render(scope, locals)
+      end
+
+      # Get the path to the template
+      #
+      # @return [String] the pathname
+      #
+      # @api private
+      # @since 0.1.0
+      def file
+        @_template.file
+      end
+    end
+  end
+end

data/lib/lotus/mailer/version.rb

@@ -1,5 +1,6 @@
 module Lotus
   module Mailer
-    VERSION = '0.0.0'
+    # @since 0.1.0
+    VERSION = '0.1.0'.freeze
   end
 end

data/lotus-mailer.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lotus/mailer/version'
@@ -6,8 +5,8 @@ require 'lotus/mailer/version'
 Gem::Specification.new do |spec|
   spec.name          = 'lotus-mailer'
   spec.version       = Lotus::Mailer::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
+  spec.authors       = ['Luca Guidi', 'Ines Coelho', 'Rosa Faria']
+  spec.email         = ['me@lucaguidi.com', 'ines.opcoelho@gmail.com', 'rosa1853@live.com']
 
   spec.summary       = %q{Mail for Ruby applications.}
   spec.description   = %q{Mail for Ruby applications and Lotus mailers}
@@ -26,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'lotus-utils', '~> 0.5'
+  spec.add_dependency 'tilt',        '~> 2.0', '>= 2.0.1'
+  spec.add_dependency 'mail',        '~> 2.5'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake',    '~> 10.0'

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lotus-mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Luca Guidi
+- Ines Coelho
+- Rosa Faria
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -24,6 +26,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +105,8 @@ dependencies:
 description: Mail for Ruby applications and Lotus mailers
 email:
 - me@lucaguidi.com
+- ines.opcoelho@gmail.com
+- rosa1853@live.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -76,7 +114,13 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- lib/lotus-mailer.rb
 - lib/lotus/mailer.rb
+- lib/lotus/mailer/configuration.rb
+- lib/lotus/mailer/dsl.rb
+- lib/lotus/mailer/rendering/template_name.rb
+- lib/lotus/mailer/rendering/templates_finder.rb
+- lib/lotus/mailer/template.rb
 - lib/lotus/mailer/version.rb
 - lotus-mailer.gemspec
 homepage: http://lotusrb.org
@@ -100,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Mail for Ruby applications.