furikake 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13019f9eef46690bb9dbafa5c2af53c97ecb893913a290ea954163a99b626482
-  data.tar.gz: 02dc922dd8548ad1722ca5e125ca51e40f34fc610c9ee6330627f1a0d8974f8a
+  metadata.gz: 1dc24060cb48d20f318e9708bdca79670973133a24bf84d12469d06bf6fb3da4
+  data.tar.gz: d3fca279477b44a2c9fc7d01433233e7835604dca80c06febde9400a30c85ce8
 SHA512:
-  metadata.gz: c65c43ecea3c630f79609f122007183759db5807a327b74026ec1824f71f96b31499c29547a91f2b3df0cf3d85df910d05acb61d9940e11fcb2b131c01aeeeed
-  data.tar.gz: 8d332b838b0f19dcb45c0e4f855d3bacae4490f592f332327a00d7f9f0cc8291348174e7af9f46994e26bbe07cf1fb29ab2c00510bba5ed250db66d0a6caa4e8
+  metadata.gz: 63487ae727c37dc63f5536e1e55ab85ef5cb575a584d9d50eb8e0d87cb6ae2300532198ed3da9a1a81ab98c3bdc4e431e87545e4ad1c39f8c87b6bf6c0e8e723
+  data.tar.gz: cc0d57546d963fc12cb4d751832f41291abb08123c0833f5deb38b6552490546fe1b6534e3c312a07694082dd3e913202d9e10b500d6e4ddccf03851134e6452

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    furikake (0.0.2)
+    furikake (0.0.3)
       aws-sdk
       backlog_kit
       markdown-tables

data/README.md

@@ -9,20 +9,31 @@
 
 ## Install
 
-とりあえずは, `git clone` してきて `bundle install` する感じでお願い致します.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'furikake'
+```
+
+And then execute:
 
 ```sh
-$ git clone git@github.com:inokappa/furikake.git
-$ bundle install --path vendor/bundle
+$ bundle
 ```
 
-## Usage
+Or install it yourself as:
 
-### Create Wiki Page
+```sh
+$ gem install furikake
+```
+
+## Getting Started
+
+### Step 1: Create Wiki Page
 
 * Backlog の wiki を作成し, wiki ID を控えておく (後の .furikake.yml で利用する)
 
-### Write .envrc
+### Step 2: Write .envrc
 
 とりあえずは, direnv と組み合わせて利用することを想定しており, AWS のクレデンシャル情報は .envrc に記載して下さい.
 
@@ -31,11 +42,30 @@ export AWS_PROFILE=your-profile
 export AWS_REGION=ap-northeast-1
 ```
 
-### Write .frikake.yml
+### Step 3: Generate && Modify .frikake.yml
 
-カレントディレクトリに, 以下のような内容で .furikake.yml を作成して下さい.
+If you're starting on a fresh furikake project, you can use furikake to generate your .furikake.yml:
+
+```sh
+bundle exec furikake setup
+```
+
+以下のように .furikake.yml が生成されるので, 環境に応じて必要な箇所を修正して下さい.
 
 ```yaml
+resources:
+  aws:
+    - clb
+    - vpc_endpoint
+    - security_group
+    - ec2
+    - kinesis
+    - lambda
+    - alb
+    - directory_service
+    - elasticsearch_service
+    - vpc
+    - rds
 backlog:
   projects:
     - space_id: 'your-backlog-space-id'
@@ -45,11 +75,19 @@ backlog:
       wiki_name: 'your-wiki-name'
       header: >
         # Test Header
+
+        [toc]
+
+        ## Sub Header
       footer: >
-        # Test Footer
+        ## Test Footer
+
+        ### Sub Footer
 ```
 
-### Run
+`resources` キー以下の属性値については, ドキュメント化する対象のリソースとなります.
+
+### Step 4: Run
 
 ```sh
 # ドキュメント化する情報を標準出力に出力する
@@ -95,7 +133,9 @@ module Furikake
 ...
 ```
 
-report メソッドには, 一覧化する際のヘッダを `header` に配列で指定します. get_resources メソッドにドキュメント化したいリソースの一覧を取得する為の処理を追加します. 戻り値は, 以下のようなフォーマットになるように実装して下さい.
+report メソッドには, 一覧化する際のヘッダを `header` に配列で指定します.
+
+尚, get_resources メソッドにドキュメント化したいリソースの一覧を取得する為の処理を追加します. 戻り値は, 以下のようなフォーマットになるように実装して下さい.
 
 ```
 [['ID', 'Name', 'Status'], ['ID', 'Name', 'Status'], ['ID', 'Name', 'Status']]

data/lib/furikake/resource.rb

@@ -2,19 +2,31 @@ module Furikake
   class Resource
     def self.generate
       documents = ''
-      load_type.each do |type|
-        require "furikake/resources/#{type}"
-        eval "documents.concat(Furikake::Resources::#{type.camelize}.report)"
-        documents.concat("\n")
+      load_resource_type.each do |type|
+        if type.include?('addon')
+          $LOAD_PATH.push(Dir.pwd + '/addons')
+          require "#{type}"
+          type_name = type.split('-')[-1]
+          eval "documents.concat(Furikake::Resources::Addons::#{type_name.camelize}.report)"
+          documents.concat("\n\n")
+        else
+          require "furikake/resources/#{type}"
+          eval "documents.concat(Furikake::Resources::#{type.camelize}.report)"
+          documents.concat("\n\n")
+        end
       end
       documents
     end
 
-    def self.load_type
+    def self.load_resource_type
       type = []
       Dir.glob(File.dirname(__FILE__) + '/resources/*').each do |r|
         type << File.basename(r, '.rb') unless r.include?('stub')
       end
+
+      Dir.glob(Dir.pwd + '/addons/furikake-resource-addon-*').each do |r|
+        type << File.basename(r, '.rb')
+      end
       type
     end
   end

data/lib/furikake/version.rb

@@ -1,3 +1,3 @@
 module Furikake
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furikake
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - inokappa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-18 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler