furikake 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +51 -11
- data/lib/furikake/resource.rb +17 -5
- data/lib/furikake/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1dc24060cb48d20f318e9708bdca79670973133a24bf84d12469d06bf6fb3da4
|
4
|
+
data.tar.gz: d3fca279477b44a2c9fc7d01433233e7835604dca80c06febde9400a30c85ce8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63487ae727c37dc63f5536e1e55ab85ef5cb575a584d9d50eb8e0d87cb6ae2300532198ed3da9a1a81ab98c3bdc4e431e87545e4ad1c39f8c87b6bf6c0e8e723
|
7
|
+
data.tar.gz: cc0d57546d963fc12cb4d751832f41291abb08123c0833f5deb38b6552490546fe1b6534e3c312a07694082dd3e913202d9e10b500d6e4ddccf03851134e6452
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -9,20 +9,31 @@
|
|
9
9
|
|
10
10
|
## Install
|
11
11
|
|
12
|
-
|
12
|
+
Add this line to your application's Gemfile:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
gem 'furikake'
|
16
|
+
```
|
17
|
+
|
18
|
+
And then execute:
|
13
19
|
|
14
20
|
```sh
|
15
|
-
$
|
16
|
-
$ bundle install --path vendor/bundle
|
21
|
+
$ bundle
|
17
22
|
```
|
18
23
|
|
19
|
-
|
24
|
+
Or install it yourself as:
|
20
25
|
|
21
|
-
|
26
|
+
```sh
|
27
|
+
$ gem install furikake
|
28
|
+
```
|
29
|
+
|
30
|
+
## Getting Started
|
31
|
+
|
32
|
+
### Step 1: Create Wiki Page
|
22
33
|
|
23
34
|
* Backlog の wiki を作成し, wiki ID を控えておく (後の .furikake.yml で利用する)
|
24
35
|
|
25
|
-
### Write .envrc
|
36
|
+
### Step 2: Write .envrc
|
26
37
|
|
27
38
|
とりあえずは, direnv と組み合わせて利用することを想定しており, AWS のクレデンシャル情報は .envrc に記載して下さい.
|
28
39
|
|
@@ -31,11 +42,30 @@ export AWS_PROFILE=your-profile
|
|
31
42
|
export AWS_REGION=ap-northeast-1
|
32
43
|
```
|
33
44
|
|
34
|
-
###
|
45
|
+
### Step 3: Generate && Modify .frikake.yml
|
35
46
|
|
36
|
-
|
47
|
+
If you're starting on a fresh furikake project, you can use furikake to generate your .furikake.yml:
|
48
|
+
|
49
|
+
```sh
|
50
|
+
bundle exec furikake setup
|
51
|
+
```
|
52
|
+
|
53
|
+
以下のように .furikake.yml が生成されるので, 環境に応じて必要な箇所を修正して下さい.
|
37
54
|
|
38
55
|
```yaml
|
56
|
+
resources:
|
57
|
+
aws:
|
58
|
+
- clb
|
59
|
+
- vpc_endpoint
|
60
|
+
- security_group
|
61
|
+
- ec2
|
62
|
+
- kinesis
|
63
|
+
- lambda
|
64
|
+
- alb
|
65
|
+
- directory_service
|
66
|
+
- elasticsearch_service
|
67
|
+
- vpc
|
68
|
+
- rds
|
39
69
|
backlog:
|
40
70
|
projects:
|
41
71
|
- space_id: 'your-backlog-space-id'
|
@@ -45,11 +75,19 @@ backlog:
|
|
45
75
|
wiki_name: 'your-wiki-name'
|
46
76
|
header: >
|
47
77
|
# Test Header
|
78
|
+
|
79
|
+
[toc]
|
80
|
+
|
81
|
+
## Sub Header
|
48
82
|
footer: >
|
49
|
-
|
83
|
+
## Test Footer
|
84
|
+
|
85
|
+
### Sub Footer
|
50
86
|
```
|
51
87
|
|
52
|
-
|
88
|
+
`resources` キー以下の属性値については, ドキュメント化する対象のリソースとなります.
|
89
|
+
|
90
|
+
### Step 4: Run
|
53
91
|
|
54
92
|
```sh
|
55
93
|
# ドキュメント化する情報を標準出力に出力する
|
@@ -95,7 +133,9 @@ module Furikake
|
|
95
133
|
...
|
96
134
|
```
|
97
135
|
|
98
|
-
report メソッドには, 一覧化する際のヘッダを `header` に配列で指定します.
|
136
|
+
report メソッドには, 一覧化する際のヘッダを `header` に配列で指定します.
|
137
|
+
|
138
|
+
尚, get_resources メソッドにドキュメント化したいリソースの一覧を取得する為の処理を追加します. 戻り値は, 以下のようなフォーマットになるように実装して下さい.
|
99
139
|
|
100
140
|
```
|
101
141
|
[['ID', 'Name', 'Status'], ['ID', 'Name', 'Status'], ['ID', 'Name', 'Status']]
|
data/lib/furikake/resource.rb
CHANGED
@@ -2,19 +2,31 @@ module Furikake
|
|
2
2
|
class Resource
|
3
3
|
def self.generate
|
4
4
|
documents = ''
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
5
|
+
load_resource_type.each do |type|
|
6
|
+
if type.include?('addon')
|
7
|
+
$LOAD_PATH.push(Dir.pwd + '/addons')
|
8
|
+
require "#{type}"
|
9
|
+
type_name = type.split('-')[-1]
|
10
|
+
eval "documents.concat(Furikake::Resources::Addons::#{type_name.camelize}.report)"
|
11
|
+
documents.concat("\n\n")
|
12
|
+
else
|
13
|
+
require "furikake/resources/#{type}"
|
14
|
+
eval "documents.concat(Furikake::Resources::#{type.camelize}.report)"
|
15
|
+
documents.concat("\n\n")
|
16
|
+
end
|
9
17
|
end
|
10
18
|
documents
|
11
19
|
end
|
12
20
|
|
13
|
-
def self.
|
21
|
+
def self.load_resource_type
|
14
22
|
type = []
|
15
23
|
Dir.glob(File.dirname(__FILE__) + '/resources/*').each do |r|
|
16
24
|
type << File.basename(r, '.rb') unless r.include?('stub')
|
17
25
|
end
|
26
|
+
|
27
|
+
Dir.glob(Dir.pwd + '/addons/furikake-resource-addon-*').each do |r|
|
28
|
+
type << File.basename(r, '.rb')
|
29
|
+
end
|
18
30
|
type
|
19
31
|
end
|
20
32
|
end
|
data/lib/furikake/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: furikake
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- inokappa
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-11-
|
11
|
+
date: 2018-11-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|