email_doc 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +23 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +29 -0
- data/Rakefile +2 -0
- data/email_doc.gemspec +26 -0
- data/lib/email_doc.rb +22 -0
- data/lib/email_doc/document.rb +46 -0
- data/lib/email_doc/documents.rb +23 -0
- data/lib/email_doc/version.rb +3 -0
- data/spec/helper.rb +3 -0
- data/spec/lib/email_doc/document_spec.rb +40 -0
- data/spec/lib/email_doc_spec.rb +4 -0
- metadata +130 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: e8a9370ee79c954f607460ed10b7a8714ee7d4ba
|
4
|
+
data.tar.gz: 321218962558236afffc9e5827f4eec0406fe71b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0935a3435413720ad1765c568f16c77a3d7234950c3401dd0cb073093bcf3723d8fe5e51b19c2fedd610318d66348502ca290b1bdaae46068c70ef83fdf87688
|
7
|
+
data.tar.gz: b2f74445a10d9a06b35c16a99ef91530a4a46ec557e74da029a5e41f2152516ad0fe674cdcdda6c85579c1b837d91f63e333923318e3e82d1e88188ce8b0b921
|
data/.gitignore
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
.yardoc
|
6
|
+
Gemfile.lock
|
7
|
+
InstalledFiles
|
8
|
+
_yardoc
|
9
|
+
coverage
|
10
|
+
doc/
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
18
|
+
vendor/bundle
|
19
|
+
*.bundle
|
20
|
+
*.so
|
21
|
+
*.o
|
22
|
+
*.a
|
23
|
+
mkmf.log
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 mizokami
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# EmailDoc
|
2
|
+
|
3
|
+
TODO: Write a gem description
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'email_doc'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install email_doc
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
TODO: Write usage instructions here
|
22
|
+
|
23
|
+
## Contributing
|
24
|
+
|
25
|
+
1. Fork it ( https://github.com/[my-github-username]/email_doc/fork )
|
26
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
27
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
28
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
29
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
data/email_doc.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'email_doc/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "email_doc"
|
8
|
+
spec.version = EmailDoc::VERSION
|
9
|
+
spec.authors = ["mizokami"]
|
10
|
+
spec.email = ["suzunatsu@yahoo.com"]
|
11
|
+
spec.summary = %q{Generate email documentation from your mailer-specs.}
|
12
|
+
spec.homepage = "https://github.com/mizoR/email_doc"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files -z`.split("\x0")
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_dependency "rspec", "~> 3.0"
|
21
|
+
spec.add_dependency "activesupport"
|
22
|
+
spec.add_dependency "actionmailer"
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
25
|
+
spec.add_development_dependency "rake"
|
26
|
+
end
|
data/lib/email_doc.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
require "email_doc/version"
|
2
|
+
require 'email_doc/documents'
|
3
|
+
require 'email_doc/document'
|
4
|
+
require 'rspec'
|
5
|
+
require 'action_mailer'
|
6
|
+
|
7
|
+
module EmailDoc
|
8
|
+
def self.documents
|
9
|
+
@documents ||= EmailDoc::Documents.new
|
10
|
+
end
|
11
|
+
|
12
|
+
def self.included(base)
|
13
|
+
RSpec.configuration.after(:each, email_doc: true) do
|
14
|
+
mail = ActionMailer::Base.deliveries.last
|
15
|
+
EmailDoc.documents.append(self, mail, RSpec.current_example)
|
16
|
+
end
|
17
|
+
|
18
|
+
RSpec.configuration.after(:suite) do
|
19
|
+
EmailDoc.documents.write
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'email_doc'
|
2
|
+
require 'forwardable'
|
3
|
+
|
4
|
+
module EmailDoc
|
5
|
+
class Document
|
6
|
+
extend Forwardable
|
7
|
+
|
8
|
+
attr_reader :mail, :context, :ex
|
9
|
+
|
10
|
+
def_delegators :mail, :subject, :from, :to, :reply_to, :body
|
11
|
+
def_delegators :context, :described_class
|
12
|
+
|
13
|
+
def initialize(context, mail, ex)
|
14
|
+
@context = context
|
15
|
+
@mail = mail
|
16
|
+
@ex = ex
|
17
|
+
end
|
18
|
+
|
19
|
+
def render
|
20
|
+
ERB.new(<<-MD_END).result(binding)
|
21
|
+
# #{described_class}
|
22
|
+
|
23
|
+
## #{ex.description}
|
24
|
+
|
25
|
+
```
|
26
|
+
From: #{from}
|
27
|
+
Subject: #{subject}
|
28
|
+
To: #{to}
|
29
|
+
Reply to: #{reply_to}
|
30
|
+
```
|
31
|
+
|
32
|
+
```
|
33
|
+
#{body.encoded}
|
34
|
+
```
|
35
|
+
MD_END
|
36
|
+
end
|
37
|
+
|
38
|
+
def pathname
|
39
|
+
@pathname ||= begin
|
40
|
+
dir = './doc/mail/'
|
41
|
+
path = ex.file_path.gsub(%r<\./spec/mailers/(.+)_spec\.rb>, '\1.md')
|
42
|
+
Pathname.new(dir + path)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
require 'email_doc'
|
2
|
+
|
3
|
+
module EmailDoc
|
4
|
+
class Documents
|
5
|
+
def initialize
|
6
|
+
@table = Hash.new {|table, key| table[key] = []}
|
7
|
+
end
|
8
|
+
|
9
|
+
def append(context, mail, example)
|
10
|
+
document = EmailDoc::Document.new(context.clone, mail.clone, example.clone)
|
11
|
+
@table[document.pathname] << document
|
12
|
+
end
|
13
|
+
|
14
|
+
def write
|
15
|
+
@table.each do |pathname, documents|
|
16
|
+
pathname.parent.mkpath
|
17
|
+
pathname.open("w") do |file|
|
18
|
+
file << documents.map(&:render).join("\n")
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
data/spec/helper.rb
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
require 'helper'
|
2
|
+
|
3
|
+
describe EmailDoc::Document do
|
4
|
+
let :mailer_class do
|
5
|
+
Class.new(ActionMailer::Base) do
|
6
|
+
def welcome(email)
|
7
|
+
mail \
|
8
|
+
to: email,
|
9
|
+
from: 'from@example.org',
|
10
|
+
reply_to: 'noreply@example.org',
|
11
|
+
subject: 'WELCOME',
|
12
|
+
body: 'Welcome to my site.'
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
let(:to) { 'to@example.com' }
|
18
|
+
|
19
|
+
let(:mail) { mailer_class.welcome(to) }
|
20
|
+
|
21
|
+
let(:ex) { RSpec.current_example }
|
22
|
+
|
23
|
+
describe '#render' do
|
24
|
+
subject { described_class.new(self, mail, ex).render }
|
25
|
+
|
26
|
+
it 'should render document' do
|
27
|
+
document_patterns = [
|
28
|
+
%r<# #{described_class}>,
|
29
|
+
%r<## #{ex.description}>,
|
30
|
+
%r<To: \["#{to}"\]>,
|
31
|
+
%r<From: \["from@example.org"\]>,
|
32
|
+
%r<Reply to: \["noreply@example.org"\]>,
|
33
|
+
%r<Subject: WELCOME>,
|
34
|
+
%r<Welcome to my site>,
|
35
|
+
]
|
36
|
+
|
37
|
+
document_patterns.each { |regexp| should match regexp }
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
metadata
ADDED
@@ -0,0 +1,130 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: email_doc
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- mizokami
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-11-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rspec
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: activesupport
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: actionmailer
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.6'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.6'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- suzunatsu@yahoo.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- Gemfile
|
92
|
+
- LICENSE.txt
|
93
|
+
- README.md
|
94
|
+
- Rakefile
|
95
|
+
- email_doc.gemspec
|
96
|
+
- lib/email_doc.rb
|
97
|
+
- lib/email_doc/document.rb
|
98
|
+
- lib/email_doc/documents.rb
|
99
|
+
- lib/email_doc/version.rb
|
100
|
+
- spec/helper.rb
|
101
|
+
- spec/lib/email_doc/document_spec.rb
|
102
|
+
- spec/lib/email_doc_spec.rb
|
103
|
+
homepage: https://github.com/mizoR/email_doc
|
104
|
+
licenses:
|
105
|
+
- MIT
|
106
|
+
metadata: {}
|
107
|
+
post_install_message:
|
108
|
+
rdoc_options: []
|
109
|
+
require_paths:
|
110
|
+
- lib
|
111
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
112
|
+
requirements:
|
113
|
+
- - ">="
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: '0'
|
116
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
117
|
+
requirements:
|
118
|
+
- - ">="
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '0'
|
121
|
+
requirements: []
|
122
|
+
rubyforge_project:
|
123
|
+
rubygems_version: 2.5.1
|
124
|
+
signing_key:
|
125
|
+
specification_version: 4
|
126
|
+
summary: Generate email documentation from your mailer-specs.
|
127
|
+
test_files:
|
128
|
+
- spec/helper.rb
|
129
|
+
- spec/lib/email_doc/document_spec.rb
|
130
|
+
- spec/lib/email_doc_spec.rb
|