automaildoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e2aee9768896ee327fc454752fc826e7121ca4c
+  data.tar.gz: 1607512fc35ea229cc242a3fa143dd2b9ed56b92
+SHA512:
+  metadata.gz: fb80f8fd9d306dadde60b47a0b6d22fee6229e8bae4b61b0bebc530bba6ec844675916592a4cc0a0d16f83edfbf595c2144143bcb6a7ef32681214e6ba3b2a30
+  data.tar.gz: b2a4e6073171cb5a480af43a0002be58ed800a69be92fb142e380c61d6a61caf71df5feda5838ee61109572e04d646bc438fd4dc97e5c8889636f0486bc1e095

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4
+script:
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Change Log
+
+### 0.1.0
+
+- First release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in automaildoc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ohbarye
+
+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,84 @@
+# Automaildoc
+
+[![Build Status](https://travis-ci.org/ohbarye/automaildoc.svg?branch=master)](https://travis-ci.org/ohbarye/automaildoc)
+
+Automaildoc is a gem to generate a list of about mails from your mail spec.
+
+![image](https://user-images.githubusercontent.com/1811616/29994119-f963a9d2-9002-11e7-990f-cf71add83b4d.png)
+
+This gem, idea, design all are completely inspired by the awesome predecessor, https://github.com/r7kamura/autodoc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'automaildoc', group: :test
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install automaildoc
+```
+
+## Usage
+
+1. Add a `automaildoc` tag to your mail spec.
+
+```ruby
+RSpec.describe 'Sign up mail', automaildoc: true do
+  let!(:user) { create(:user) }
+  let!(:mail) { SignupMailer.mail(user) }
+
+  it 'should send to a user' do
+    expect(mail.to).to eq user
+  end
+end
+```
+
+2. Run rspec test with `AUTOMAILDOC`
+
+```console
+$ AUTOMAILDOC=1 bundle exec rspec
+```
+
+That's it. Then Automaildoc generates an HTML file to `./doc/mails`. The file should be what you've wanted.
+
+![automaildoc](https://user-images.githubusercontent.com/1811616/29994112-c6dacbc6-9002-11e7-812f-a346d415d6c4.gif)
+
+### Example
+
+You can see `spec/dummy/doc/toc.html` in this repository, which is auto-generated one from mail specs in `spec/mails`.
+
+### Configuration
+
+- path - [String] location to put files (default: `./doc/mails`)
+- html_template - [String] ERB template for a mail (default: `./automaildoc/templates/mail.html.erb`)
+- toc_html_template - [String] ERB template for table of content (default: `./automaildoc/templates/toc.html.erb`)
+
+```ruby
+Automaildoc.configuration.path = "doc/mails"
+Automaildoc.configuration.html_template = File.read(File.expand_path("../automaildoc/templates/mail.html.erb", __FILE__))
+Automaildoc.configuration.toc_html_template = File.read(File.expand_path("../automaildoc/templates/toc.html.erb", __FILE__))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ohbarye/automaildoc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/automaildoc.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "automaildoc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "automaildoc"
+  spec.version       = Automaildoc::VERSION
+  spec.authors       = ["Masato Ohba"]
+  spec.email         = ["over.rye@gmail.com"]
+
+  spec.summary       = "Generate mail preview from your mail spec"
+  spec.description   = "Automaildoc is a gem to generate a list of about mails from your mail spec."
+  spec.homepage      = "https://github.com/ohbarye/automaildoc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mail"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "automaildoc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/automaildoc.rb

@@ -0,0 +1,17 @@
+require "automaildoc/configuration"
+require "automaildoc/document"
+require "automaildoc/documents"
+require "automaildoc/version"
+require "automaildoc/rspec" if ENV["AUTOMAILDOC"]
+
+module Automaildoc
+  class << self
+    def documents
+      @documents ||= Documents.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/automaildoc/configuration.rb

@@ -0,0 +1,33 @@
+module Automaildoc
+  class Configuration
+    class << self
+      def property(name, &default)
+        define_method(name) do
+          if instance_variable_defined?("@#{name}")
+            instance_variable_get("@#{name}")
+          else
+            instance_variable_set("@#{name}", instance_exec(&default))
+          end
+        end
+
+        attr_writer name
+      end
+    end
+
+    property :path do
+      "doc/mails"
+    end
+
+    property :html_template do
+      File.read(File.expand_path("../templates/mail.html.erb", __FILE__))
+    end
+
+    property :toc_html_template do
+      File.read(File.expand_path("../templates/toc.html.erb", __FILE__))
+    end
+
+    def pathname
+      Pathname.new(path)
+    end
+  end
+end

data/lib/automaildoc/document.rb

@@ -0,0 +1,46 @@
+require 'erb'
+
+module Automaildoc
+  class Document
+    def initialize(context, example)
+      @context = context
+      @example = example
+    end
+
+    def render
+      ERB.new(Automaildoc.configuration.html_template, nil, '-').result(binding)
+    end
+
+    def id
+      @example.id
+    end
+
+    def description
+      @example.full_description
+    end
+
+    def mail
+      @context.mail
+    end
+
+    def to
+      mail.to || []
+    end
+
+    def cc
+      mail.cc || []
+    end
+
+    def bcc
+      mail.bcc || []
+    end
+
+    def subject
+      mail.subject || ''
+    end
+
+    def body
+      mail.body || ''
+    end
+  end
+end

data/lib/automaildoc/documents.rb

@@ -0,0 +1,33 @@
+require "pathname"
+
+module Automaildoc
+  class Documents
+    def initialize
+      @mails = []
+    end
+
+    def append(context, example)
+      mail = Automaildoc::Document.new(context.clone, example.clone)
+      (@mails << mail).sort_by(&:subject)
+    end
+
+    def write
+      write_toc_html
+    end
+
+    private
+
+    def write_toc_html
+      toc_html_path.parent.mkpath
+      toc_html_path.open("w") {|file| file << render_toc_html }
+    end
+
+    def render_toc_html
+      ERB.new(Automaildoc.configuration.toc_html_template, nil, "-").result(binding)
+    end
+
+    def toc_html_path
+      Automaildoc.configuration.pathname + "toc.html"
+    end
+  end
+end

data/lib/automaildoc/rspec.rb

@@ -0,0 +1,9 @@
+require "rspec"
+
+RSpec.configuration.after(:each, automaildoc: true) do |example|
+  Automaildoc.documents.append(self, example) unless example.pending?
+end
+
+RSpec.configuration.after(:suite) do
+  Automaildoc.documents.write
+end

data/lib/automaildoc/templates/mail.html.erb

@@ -0,0 +1,25 @@
+<div id="<%= id %>" class="mail">
+  <h3><%= description %></h3>
+  <div class="row">
+    TO:
+    <% to.each do |mail| %>
+      <span class="badge badge-default"><%= mail %></span>
+    <% end %>
+  </div>
+  <div class="row">
+    CC:
+    <% cc.each do |mail| %>
+      <span class="badge badge-default"><%= mail %></span>
+    <% end %>
+  </div>
+  <div class="row">
+    BCC:
+    <% bcc.each do |mail| %>
+      <span class="badge badge-default"><%= mail %></span>
+    <% end %>
+  </div>
+  <pre><%= subject %></pre>
+  <pre><%= body %></pre>
+</div>
+
+<hr>

data/lib/automaildoc/templates/toc.html.erb

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html lang="ja">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <style>
+      body {
+        font-family: -apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
+      }
+      .badge-default {
+        background-color: #636c72;
+      }
+      .badge {
+        display: inline-block;
+        padding: .25em .4em;
+        font-size: 75%;
+        font-weight: 700;
+        line-height: 1;
+        color: #fff;
+        text-align: center;
+        white-space: nowrap;
+        vertical-align: baseline;
+        border-radius: .25rem;
+      }
+      h2 {
+        margin-top: 16px;
+        margin-bottom: 16px;
+        font-size: 2rem;
+        font-weight: 500;
+      }
+      h3 {
+        margin-top: 16px;
+        margin-bottom: 16px;
+        font-size: 1.75rem;
+        font-weight: 500;
+        color: gray;
+      }
+      pre {
+        word-break: break-all;
+        white-space: pre;
+        white-space: pre-wrap;
+        white-space: pre-line;
+        white-space: -pre-wrap;
+        white-space: -o-pre-wrap;
+        white-space: -moz-pre-wrap;
+        white-space: -hp-pre-wrap;
+        word-wrap: break-word;
+        background-color: rgb(247, 247, 249);
+        padding: 1em;
+        font-family: Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;
+        font-size: 90%;
+      }
+      .container {
+        padding: 24px 16px;
+      }
+      .row {
+        display: block;
+        margin: 8px 0px;
+      }
+      .container .row .col-sm-4 {
+        margin: 0px -8px;
+        padding: 0px 8px;
+        vertical-align: top;
+        display: inline-block;
+      }
+      @media screen and (min-width:768px) {
+        .container .row .col-sm-4 {
+          width: 33%;
+        }
+      }
+      .container .row .col-sm-8 {
+        margin: 0px -8px;
+        padding: 0px 8px;
+        vertical-align: top;
+        display: inline-block;
+      }
+      @media screen and (min-width:768px) {
+        .container .row .col-sm-8 {
+          width: 66%;
+        }
+      }
+      hr {
+        margin: 16px 0px
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <div class="row">
+        <div class="col-sm-4">
+          <h2>Mail List</h2>
+          <ul>
+            <% @mails.each do |mail| %>
+              <li>
+                <a href="#<%= mail.id %>"><%= mail.subject %></a>
+              </li>
+            <% end %>
+          </ul>
+        </div>
+
+        <div class="col-sm-8">
+          <h2>Mail Details</h2>
+          <% @mails.each do |mail| %>
+            <%= mail.render %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/automaildoc/version.rb

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: automaildoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masato Ohba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  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: Automaildoc is a gem to generate a list of about mails from your mail
+  spec.
+email:
+- over.rye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- automaildoc.gemspec
+- bin/console
+- bin/setup
+- lib/automaildoc.rb
+- lib/automaildoc/configuration.rb
+- lib/automaildoc/document.rb
+- lib/automaildoc/documents.rb
+- lib/automaildoc/rspec.rb
+- lib/automaildoc/templates/mail.html.erb
+- lib/automaildoc/templates/toc.html.erb
+- lib/automaildoc/version.rb
+homepage: https://github.com/ohbarye/automaildoc
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Generate mail preview from your mail spec
+test_files: []