automaildoc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e2aee9768896ee327fc454752fc826e7121ca4c
-  data.tar.gz: 1607512fc35ea229cc242a3fa143dd2b9ed56b92
+  metadata.gz: 7dcf5243373c83e1fb94b1498d2b665c431271c4
+  data.tar.gz: 58d0b68aa9b9346ab6568e2699a60abd143771fb
 SHA512:
-  metadata.gz: fb80f8fd9d306dadde60b47a0b6d22fee6229e8bae4b61b0bebc530bba6ec844675916592a4cc0a0d16f83edfbf595c2144143bcb6a7ef32681214e6ba3b2a30
-  data.tar.gz: b2a4e6073171cb5a480af43a0002be58ed800a69be92fb142e380c61d6a61caf71df5feda5838ee61109572e04d646bc438fd4dc97e5c8889636f0486bc1e095
+  metadata.gz: d173fcc0cd49abf00ae5eab30e854d84419d32c9daff30efff2ea569d4924d9fe497f6a42206c04b68409547117227ed107d345a95c03667e486df5f372077e3
+  data.tar.gz: 95e185fc0374c3d78f168577e84fe282a3565f9ece1629008c8e733647b0ba97ac76d9f249270df7c70a659f61ec646b89b6a645027331fc0514e494527ca09f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Change Log
 
+### 0.1.1
+
+#### Improvements
+
+- Custom description is available now.
+- Table of content shows not each subject but each mail's description. 
+
 ### 0.1.0
 
 - First release

data/README.md

@@ -1,5 +1,6 @@
 # Automaildoc
 
+[![Gem Version](https://badge.fury.io/rb/automaildoc.svg)](https://badge.fury.io/rb/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.
@@ -57,6 +58,18 @@ That's it. Then Automaildoc generates an HTML file to `./doc/mails`. The file sh
 
 You can see `spec/dummy/doc/toc.html` in this repository, which is auto-generated one from mail specs in `spec/mails`.
 
+### Custom description
+
+You can write descriptions with let(:description).
+
+```ruby
+describe 'Sign up mail', automaildoc: true do
+  let(:description) { 'Sign up mail for newly signed up user' }
+
+  # examples follow
+end
+```
+
 ### Configuration
 
 - path - [String] location to put files (default: `./doc/mails`)

data/lib/automaildoc/document.rb

@@ -16,7 +16,11 @@ module Automaildoc
     end
 
     def description
-      @example.full_description
+      if @context.respond_to?(:description)
+        @context.description.strip
+      else
+        @example.full_description
+      end
     end
 
     def mail

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

@@ -92,7 +92,7 @@
           <ul>
             <% @mails.each do |mail| %>
               <li>
-                <a href="#<%= mail.id %>"><%= mail.subject %></a>
+                <a href="#<%= mail.id %>"><%= mail.description %></a>
               </li>
             <% end %>
           </ul>

data/lib/automaildoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: automaildoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Masato Ohba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-02 00:00:00.000000000 Z
+date: 2017-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec