furikake 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dc24060cb48d20f318e9708bdca79670973133a24bf84d12469d06bf6fb3da4
-  data.tar.gz: d3fca279477b44a2c9fc7d01433233e7835604dca80c06febde9400a30c85ce8
+  metadata.gz: ce60a7c44eb3ad74187dcba6f5f774088b871d7322754e228783adcf18e987ad
+  data.tar.gz: beae7b1859b739092d464d876c05fd180e160d0727bf348a758bf9174a9fd6b9
 SHA512:
-  metadata.gz: 63487ae727c37dc63f5536e1e55ab85ef5cb575a584d9d50eb8e0d87cb6ae2300532198ed3da9a1a81ab98c3bdc4e431e87545e4ad1c39f8c87b6bf6c0e8e723
-  data.tar.gz: cc0d57546d963fc12cb4d751832f41291abb08123c0833f5deb38b6552490546fe1b6534e3c312a07694082dd3e913202d9e10b500d6e4ddccf03851134e6452
+  metadata.gz: 5a7dcc762d3dee0acd881c952c70c0453fc1fef651a94ccd5300141dc441125fd768593a75b8b0942782563dfd1813ae3bc993f2f96bd9bb3ecee7a68a546355
+  data.tar.gz: 8bd4226cdb20aeb9dcef8525565f2553bc3919d72973909932e7855230ee3d10e2a38fa8d58342ffe9d89100e5b2f6ee3a53e1073c17698251841d0c1eeac0ac

data/Gemfile.lock

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

data/README.md

@@ -99,9 +99,38 @@ bundle exec furikake publish
 
 ## Tips
 
-### リソース追加
+### 検索対象リソース追加 (addons ディレクトリ)
 
-`lib/furikake/resources/` 以下に任意のファイル名でコードを追加することで, ドキュメント化する対象のリソースを追加することが出来ます.
+furikake コマンドを実行するカレントディレクトリに `addons` ディレクトリを作成し, 以下のようなコードを指定されたファイル名で作成することで, 検索対象リソースに追加することが可能です. (`setup` コマンドで自動的に生成することも可能です.)
+
+```ruby
+module Furikake::Resources
+  module Addons
+    class Example
+      def self.report(format = nil)
+        values = [['value1', 'value2'], ['value3', 'value4']]
+        contents = {
+          title: 'Example',
+          resources: [
+            {
+               subtitle: '',
+               header: ['Title1', 'Title2'],
+               resource: values
+            }
+          ]
+        }
+        Furikake::Formatter.shaping(format, contents)
+      end
+    end
+  end
+end
+```
+
+このスクリプトを `addons/furikake-resource-addon-${downcase_class_name}.rb` というファイル名で保存する必要があります.
+
+### 検索対象リソース追加
+
+`lib/furikake/resources/` 以下に任意のファイル名でコードを追加することで, ドキュメント化する対象のリソースを追加することが可能です.
 
 ```ruby
 module Furikake

data/lib/furikake/config.rb

@@ -1,7 +1,16 @@
 module Furikake
   module Config
     def read_furikake_yaml
-      open('.furikake.yml', 'r') { |f| YAML.load(f) }
+      # open('.furikake.yml', 'r') { |f| YAML.load(f) }
+      begin
+        YAML.load_file('.furikake.yml')
+      rescue Errno::ENOENT
+        puts '.furikake.yml が存在していません.'
+        exit 1
+      rescue => ex
+        puts '.furikake.yml の読み込みに失敗しました. ' + ex.message
+        exit 1
+      end
     end
   end
 end

data/lib/furikake/resource.rb

@@ -10,9 +10,15 @@ module Furikake
           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")
+          begin
+            require "furikake/resources/#{type}"
+            eval "documents.concat(Furikake::Resources::#{type.camelize}.report)"
+            documents.concat("\n\n")
+          rescue LoadError
+            puts "リソースタイプ: #{type} を読み込めませんでした."
+          rescue
+            puts "リソースタイプ: #{type} の情報を取得出来ませんでした."
+          end
         end
       end
       documents
@@ -20,14 +26,44 @@ module Furikake
 
     def self.load_resource_type
       type = []
+      config_defined_resources = load_config_resource_type
+      default_resources = load_default_resource_type
+      if default_resources == config_defined_resources
+        type.push(default_resources)
+      else
+        type.push(config_defined_resources)
+      end
+      type.push(load_addons_resource_type)
+      type.flatten
+    end
+
+    def self.load_default_resource_type
+      default_resource_type = []
       Dir.glob(File.dirname(__FILE__) + '/resources/*').each do |r|
-        type << File.basename(r, '.rb') unless r.include?('stub')
+        default_resource_type << File.basename(r, '.rb') unless r.include?('stub')
       end
+      default_resource_type.sort
+    end
 
+    def self.load_addons_resource_type
+      addons_resource_type = []
       Dir.glob(Dir.pwd + '/addons/furikake-resource-addon-*').each do |r|
-        type << File.basename(r, '.rb')
+        addons_resource_type << File.basename(r, '.rb')
+      end
+      addons_resource_type.sort
+    end
+
+    def self.load_config_resource_type(path = nil)
+      path = '.furikake.yml' if path.nil?
+      begin
+        config = YAML.load_file(path)
+        config['resources']['aws'].sort
+      rescue Errno::ENOENT
+        puts '.furikake.yml が存在していません.'
+      rescue => ex
+        puts '.furikake.yml の読み込みに失敗しました. ' + ex.message
+        exit 1
       end
-      type
     end
   end
 end

data/lib/furikake/setup.rb

@@ -4,11 +4,12 @@ module Furikake
       puts '[setup] creating .furikake.yml...'
       create_furikake_yaml unless File.exist?('.furikake.yml')
       puts '[setup] .furikake.yml already exists.'
+      setup_addons
       exit
     end
 
     def self.create_furikake_yaml
-      resource_type = Furikake::Resource.load_type
+      resource_type = Furikake::Resource.load_default_resource_type
       yaml_contents = <<"EOS"
 resources:
   aws:
@@ -40,5 +41,56 @@ EOS
       puts '[setup] .furikake.yml created.'
       exit
     end
+
+    def self.setup_addons
+      puts '[setup] create `addons` directory? [y/n]'
+      response = STDIN.gets.chomp
+      case response
+      when /^[yY]/
+        self.create_addons_directory unless FileTest.exist?('addons')
+        puts '[setup] `addons` directory already exists.'
+        exit
+      when /^[nN]/, /^$/
+        puts '[setup] `addons` directory not created.'
+        exit 0
+      else
+        puts 'Please input y(Y) or n(N)'
+        setup_addons
+      end
+    end
+
+    def self.create_addons_directory
+      puts '[setup] creating `addons` directory.'
+      FileUtils.mkdir_p('addons')
+      f = File.open('addons/furikake-resource-addon-example.rb', 'w')
+      f.print <<EOS
+module Furikake::Resources
+  module Addons
+    class Example
+      def self.report(format = nil)
+        values = [['value1', 'value2'], ['value3', 'value4']]
+        contents = {
+          title: 'Example',
+          resources: [
+            {
+               subtitle: '',
+               header: ['Title1', 'Title2'],
+               resource: values
+            }
+          ]
+        }
+        Furikake::Formatter.shaping(format, contents)
+      end
+
+      def self.get_resources
+        ... Please implement ...
+      end
+    end
+  end
+end
+EOS
+      puts '[setup] `addons` directory created.'
+      exit
+    end
   end
 end

data/lib/furikake/version.rb

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

metadata

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