email_doc 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8a9370ee79c954f607460ed10b7a8714ee7d4ba
+  data.tar.gz: 321218962558236afffc9e5827f4eec0406fe71b
+SHA512:
+  metadata.gz: 0935a3435413720ad1765c568f16c77a3d7234950c3401dd0cb073093bcf3723d8fe5e51b19c2fedd610318d66348502ca290b1bdaae46068c70ef83fdf87688
+  data.tar.gz: b2f74445a10d9a06b35c16a99ef91530a4a46ec557e74da029a5e41f2152516ad0fe674cdcdda6c85579c1b837d91f63e333923318e3e82d1e88188ce8b0b921

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_doc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mizokami
+
+MIT License
+
+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,29 @@
+# EmailDoc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'email_doc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_doc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/email_doc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/email_doc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_doc"
+  spec.version       = EmailDoc::VERSION
+  spec.authors       = ["mizokami"]
+  spec.email         = ["suzunatsu@yahoo.com"]
+  spec.summary       = %q{Generate email documentation from your mailer-specs.}
+  spec.homepage      = "https://github.com/mizoR/email_doc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "actionmailer"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/email_doc.rb

@@ -0,0 +1,22 @@
+require "email_doc/version"
+require 'email_doc/documents'
+require 'email_doc/document'
+require 'rspec'
+require 'action_mailer'
+
+module EmailDoc
+  def self.documents
+    @documents ||= EmailDoc::Documents.new
+  end
+
+  def self.included(base)
+    RSpec.configuration.after(:each, email_doc: true) do
+      mail = ActionMailer::Base.deliveries.last
+      EmailDoc.documents.append(self, mail, RSpec.current_example)
+    end
+
+    RSpec.configuration.after(:suite) do
+      EmailDoc.documents.write
+    end
+  end
+end

data/lib/email_doc/document.rb

@@ -0,0 +1,46 @@
+require 'email_doc'
+require 'forwardable'
+
+module EmailDoc
+  class Document
+    extend Forwardable
+
+    attr_reader :mail, :context, :ex
+
+    def_delegators :mail, :subject, :from, :to, :reply_to, :body
+    def_delegators :context, :described_class
+
+    def initialize(context, mail, ex)
+      @context = context
+      @mail    = mail
+      @ex      = ex
+    end
+
+    def render
+      ERB.new(<<-MD_END).result(binding)
+# #{described_class}
+
+## #{ex.description}
+
+```
+    From: #{from}
+ Subject: #{subject}
+      To: #{to}
+Reply to: #{reply_to}
+```
+
+```
+#{body.encoded}
+```
+MD_END
+    end
+
+    def pathname
+      @pathname ||= begin
+        dir  = './doc/mail/'
+        path = ex.file_path.gsub(%r<\./spec/mailers/(.+)_spec\.rb>, '\1.md')
+        Pathname.new(dir + path)
+      end
+    end
+  end
+end

data/lib/email_doc/documents.rb

@@ -0,0 +1,23 @@
+require 'email_doc'
+
+module EmailDoc
+  class Documents
+    def initialize
+      @table = Hash.new {|table, key| table[key] = []}
+    end
+ 
+    def append(context, mail, example)
+      document = EmailDoc::Document.new(context.clone, mail.clone, example.clone)
+      @table[document.pathname] << document
+    end
+ 
+    def write
+      @table.each do |pathname, documents|
+        pathname.parent.mkpath
+        pathname.open("w") do |file|
+          file << documents.map(&:render).join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/email_doc/version.rb

@@ -0,0 +1,3 @@
+module EmailDoc
+  VERSION = "0.0.2"
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'email_doc'
+require 'active_support/rescuable'

data/spec/lib/email_doc/document_spec.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+describe EmailDoc::Document do
+  let :mailer_class do
+    Class.new(ActionMailer::Base) do
+      def welcome(email)
+        mail \
+          to:       email,
+          from:     'from@example.org',
+          reply_to: 'noreply@example.org',
+          subject:  'WELCOME',
+          body:     'Welcome to my site.'
+      end
+    end
+  end
+
+  let(:to) { 'to@example.com' }
+
+  let(:mail) { mailer_class.welcome(to) }
+
+  let(:ex) { RSpec.current_example }
+
+  describe '#render' do
+    subject { described_class.new(self, mail, ex).render }
+
+    it 'should render document' do
+      document_patterns = [
+        %r<# #{described_class}>,
+        %r<## #{ex.description}>,
+        %r<To: \["#{to}"\]>,
+        %r<From: \["from@example.org"\]>,
+        %r<Reply to: \["noreply@example.org"\]>,
+        %r<Subject: WELCOME>,
+        %r<Welcome to my site>,
+      ]
+
+      document_patterns.each { |regexp| should match regexp }
+    end
+  end
+end

data/spec/lib/email_doc_spec.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+describe EmailDoc do
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: email_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- mizokami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- suzunatsu@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_doc.gemspec
+- lib/email_doc.rb
+- lib/email_doc/document.rb
+- lib/email_doc/documents.rb
+- lib/email_doc/version.rb
+- spec/helper.rb
+- spec/lib/email_doc/document_spec.rb
+- spec/lib/email_doc_spec.rb
+homepage: https://github.com/mizoR/email_doc
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generate email documentation from your mailer-specs.
+test_files:
+- spec/helper.rb
+- spec/lib/email_doc/document_spec.rb
+- spec/lib/email_doc_spec.rb