paraduct 1.0.0.beta6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba1ed4f5fbdbe3c7eb441c902d19898ae379bd8
-  data.tar.gz: 6e32754a0c902d9da9e2f9f221747bde855a2f61
+  metadata.gz: c7bca8c964aef5d616debd095e941a6c245054f5
+  data.tar.gz: 15cf9dfab4ca0740cae11ad468c59552ad866cb6
 SHA512:
-  metadata.gz: 457ae25a822ca9b9ec1ae823bd7622fb240a408bd96c76ac05b11bac29b1bf81ce6a106d4f6b6b8a98502c900a6fdcfdbca6ffc5313c12965885564239b32ccc
-  data.tar.gz: 1b8146e9246f13f894f6d26dcb8150b9811f502c532f8978066e7a85aae4f7b0620955c7f7bab8ec6382441d539247e2949f41f4dbdd032c7ad188e8d2bc16b9
+  metadata.gz: f3ef3f5048a86bfdd8319c8727bef4bed0cb7a006ab5f1b854d29ab7cb43ef3f6d83bf1fa11f06917152da6e8e9a9046444d08b7f8937d8b8cb503f9b35f9d49
+  data.tar.gz: c1faecc0467be7f3de7dea14e037de127b32ad63a3bf283ca28732438612a136e7476ed4a3ce0d811fab55a987506640add8eb47e9e27042091a676ae1297555

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.onkcop.yml

@@ -0,0 +1,223 @@
+# target_version:
+#   rubocop v0.37.1
+
+# 自動生成されるものはチェック対象から除外する
+AllCops:
+  Exclude:
+    - "vendor/**/*" # rubocop config/default.yml
+    - "db/schema.rb"
+  DisplayCopNames: true
+
+##################### Style ##################################
+
+# レキシカルスコープの扱いが alias_method の方が自然。
+# https://ernie.io/2014/10/23/in-defense-of-alias/ のように
+# 問題になる場合は自分で緩める。
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# redirect_to xxx and return のイディオムを維持したい
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+# 日本語のコメントを許可する
+Style/AsciiComments:
+  Enabled: false
+
+# do .. end から更にメソッドチェーンすると見づらいので
+# auto-correct せず、自分で修正する
+# spec 内は見た目が綺麗になるので許可
+Style/BlockDelimiters:
+  AutoCorrect: false
+  Exclude:
+    - "spec/**/*"
+
+# option 等、明示的にハッシュにした方が分かりやすい場合もある
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# scope が違うとか親 module の存在確認が必要とかデメリットはあるが、
+# namespace 付きのクラスはかなり頻繁に作るので簡単に書きたい。
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Style/CollectionMethods 自体は無効になっているのだが、
+#   https://github.com/bbatsov/rubocop/issues/1084
+#   https://github.com/bbatsov/rubocop/issues/1334
+# Performance/Detect がこの設定値を見るので PreferredMethods だけ変更しておく。
+#
+# デフォルト値から変えたのは
+#   find -> detect
+#     ActiveRecord の find と間違えやすいため
+#   reduce -> inject
+#     detect, reject, select と並べたときに韻を踏んでいるため。
+#     collect -> map を維持しているのは文字数が圧倒的に少ないため。
+Style/CollectionMethods:
+  PreferredMethods:
+    detect: "detect"
+    find: "detect"
+    inject: "inject"
+    reduce: "inject"
+
+# Hash#has_key? は許可したい
+Style/DeprecatedHashMethods:
+  Enabled: false
+
+# ドキュメントの無い public class を許可する
+Style/Documentation:
+  Enabled: false
+
+# !! のイディオムは積極的に使う
+Style/DoubleNegation:
+  Enabled: false
+
+# メソッドチェーンの改行は末尾に . を入れる
+# REPL に貼り付けた際の暴発を防ぐため
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# 明示的に else で nil を返すのは分かりやすいので許可する
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# 桁揃えが綺麗にならないことが多いので migration は除外
+Style/ExtraSpacing:
+  Exclude:
+    - "db/migrate/*.rb"
+
+# いずれかに揃えるのならば `sprintf` や `format` より String#% が好きです
+Style/FormatString:
+  EnforcedStyle: percent
+
+# まだ対応するには早い
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# if 文の中に 3 行程度のブロックを書くぐらいは許容した方が現実的
+# NOTE: https://github.com/bbatsov/rubocop/commit/29945958034db13af9e8ff385ec58cb9eb464596
+#       の影響で、if 文の中身が 1 行の場合に警告されるようになっている。
+#       Style/IfUnlessModifier の設定見てくれないかなぁ？ (v0.36.0)
+Style/GuardClause:
+  MinBodyLength: 5
+
+# rake タスクの順序の hash は rocket を許可する
+Style/HashSyntax:
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+
+# 平たくしてしまうと条件のグルーピングが脳内モデルとズレやすい
+Style/IfInsideElse:
+  Enabled: false
+
+# 条件式の方を意識させたい場合には後置の if/unless を使わない方が分かりやすい
+Style/IfUnlessModifier:
+  Enabled: false
+
+# special_inside_parentheses (default) と比べて
+# * 横に長くなりづらい
+# * メソッド名の長さが変わったときに diff が少ない
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+# ({ と hash を開始した場合に ( の位置にインデントさせる
+# そもそも {} が必要ない可能性が高いが Style/BracesAroundHashParameters はチェックしないことにしたので
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+# private/protected は一段深くインデントする
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+# scope 等は複数行でも lambda ではなく ->{} で揃えた方が見た目が綺麗
+Style/Lambda:
+  Enabled: false
+
+# 1_000_000 と区切り文字が 2 個以上必要になる場合のみ _ 区切りを必須にする
+Style/NumericLiterals:
+  MinDigits: 7
+
+# 正規表現にマッチさせた時の特殊変数の置き換えは Regex.last_match ではなく
+# 名前付きキャプチャを使って参照したいので auto-correct しない
+Style/PerlBackrefs:
+  AutoCorrect: false
+
+# has_ から始まるメソッドは許可する
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - "is_"
+    - "have_"
+  NamePrefix:
+    - "is_"
+    - "have_"
+
+# 特に model 内において、ローカル変数とメソッド呼び出しの区別をつけた方が分かりやすい場合が多い
+Style/RedundantSelf:
+  Enabled: false
+
+# 受け取り側で multiple assignment しろというのを明示
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# spec 内は見た目が綺麗になるので許可
+Style/Semicolon:
+  Exclude:
+    - "spec/**/*"
+
+# * 式展開したい場合に書き換えるのが面倒
+# * 文章ではダブルクォートよりもシングルクォートの方が頻出する
+# ことから EnforcedStyle: double_quotes 推奨
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# auto-correct 時に Style/StringLiterals とカニバって無限ループになる (v0.28.0)
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# いくらなんでも inject { |a, e| } は短すぎるので分かりやすい名前をつけたい
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# 複数行の場合はケツカンマを入れる
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+##################### Lint ##################################
+
+# * 同名のメソッドがある場合にローカル変数に `_` を付ける
+# * 一時変数として `_` を付ける
+# というテクニックは頻出する
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# 子クラスで実装させるつもりのメソッドで引っかかるので
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+##################### Metrics ##################################
+
+# 30 まではギリギリ許せる範囲だった
+Metrics/AbcSize:
+  Max: 30
+
+# 6 は強すぎるので緩める
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# * 警告 120文字
+# * 禁止 160文字
+# のイメージ
+Metrics/LineLength:
+  Max: 160
+  Exclude:
+    - "db/migrate/*.rb"
+
+# 20 行超えるのは migration ファイル以外滅多に無い
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - "db/migrate/*.rb"
+
+# 分岐の数。ガード句を多用しているとデフォルト 7 だと厳しい
+Metrics/PerceivedComplexity:
+  Max: 8

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: ".onkcop.yml"
+
+Style/WordArray:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/MethodLength:
+  Max: 40

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## master
-[full changelog](http://github.com/sue445/paraduct/compare/v0.0.3...master)
+[full changelog](http://github.com/sue445/paraduct/compare/v1.0.0...master)
+
+## v1.0.0
+[full changelog](http://github.com/sue445/paraduct/compare/v0.0.3...v1.0.0)
 
 ### Breaking changes :bomb:
 * Stop convert key capitalize
@@ -15,9 +18,10 @@
 * Add start command logging
   * https://github.com/sue445/paraduct/pull/89
 
-### some refactorings
+### Refactorings
 * https://github.com/sue445/paraduct/pull/79
 * https://github.com/sue445/paraduct/pull/80
+* https://github.com/sue445/paraduct/pull/90
 
 ## v0.0.3
 [full changelog](http://github.com/sue445/paraduct/compare/v0.0.2...v0.0.3)

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in paraduct.gemspec
 gemspec

data/README.md

@@ -62,9 +62,9 @@ $ paraduct test
 ## .paraduct.yml Format
 ```yaml
 script: |-
-  echo "NAME1=${NAME1}, NAME2=${NAME2}"
+  echo "[START] NAME1=${NAME1}, NAME2=${NAME2}"
 after_script: |-
-  echo "Build is finished"
+  echo "[END] NAME1=${NAME1}, NAME2=${NAME2}"
 work_dir: tmp/paraduct_workspace
 variables:
   NAME1:

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'yard'
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/paraduct

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'paraduct/cli'
+require "paraduct/cli"
 
 Paraduct::CLI.start

data/lib/paraduct.rb

@@ -2,24 +2,24 @@ require "active_support"
 require "active_support/deprecation"
 require "active_support/core_ext"
 require "pathname"
-require 'paraduct/version'
+require "paraduct/version"
 require "colorize"
 
 module Paraduct
-  autoload :ColoredLabelLogger, 'paraduct/colored_label_logger'
-  autoload :Configuration     , 'paraduct/configuration'
-  autoload :Errors            , 'paraduct/errors'
-  autoload :ParallelRunner    , 'paraduct/parallel_runner'
-  autoload :Runner            , 'paraduct/runner'
-  autoload :SyncUtils         , 'paraduct/sync_utils'
-  autoload :TestResponse      , 'paraduct/test_response'
-  autoload :VariableConverter , 'paraduct/variable_converter'
+  autoload :ColoredLabelLogger, "paraduct/colored_label_logger"
+  autoload :Configuration,      "paraduct/configuration"
+  autoload :Errors,             "paraduct/errors"
+  autoload :ParallelRunner,     "paraduct/parallel_runner"
+  autoload :Runner,             "paraduct/runner"
+  autoload :SyncUtils,          "paraduct/sync_utils"
+  autoload :TestResponse,       "paraduct/test_response"
+  autoload :VariableConverter,  "paraduct/variable_converter"
 
   class << self
     def configuration
       Paraduct::Configuration.instance
     end
-    alias :config :configuration
+    alias_method :config, :configuration
 
     def logger
       @logger ||= ActiveSupport::Logger.new(STDOUT)

data/lib/paraduct/cli.rb

@@ -1,5 +1,5 @@
-require 'paraduct'
-require 'thor'
+require "paraduct"
+require "thor"
 
 module Paraduct
   class CLI < Thor

data/lib/paraduct/colored_label_logger.rb

@@ -20,7 +20,7 @@ module Paraduct
       :light_magenta,
       :light_red,
       :light_blue,
-    ]
+    ].freeze
     def self.next_color
       @color_index ||= -1
       @color_index = (@color_index + 1) % COLORS.length

data/lib/paraduct/configuration.rb

@@ -62,8 +62,8 @@ module Paraduct
 
     private
 
-    def config_data
-      @config_data ||= YAML.load_file(config_file).with_indifferent_access
-    end
+      def config_data
+        @config_data ||= YAML.load_file(config_file).with_indifferent_access
+      end
   end
 end

data/lib/paraduct/parallel_runner.rb

@@ -23,7 +23,7 @@ START matrix test
           runner = Paraduct::Runner.new(
             params:       params,
             base_job_dir: base_job_dir,
-            job_id:       index + 1,
+            job_id:       index + 1
           )
           pool.process do
             runner.logger.info "[START] params: #{runner.formatted_params}"
@@ -44,7 +44,7 @@ START matrix test
               params:           runner.params,
               formatted_params: runner.formatted_params,
               successful:       successful,
-              stdout:           stdout,
+              stdout:           stdout
             )
           end
         end
@@ -67,7 +67,7 @@ START matrix test
       runner.logger.error "exitstatus=#{e.status}, #{e.inspect}"
       [e.message, false]
 
-    rescue Exception => e
+    rescue => e
       runner.logger.error "Unknown error: #{e.inspect}"
       runner.logger.error e.backtrace.join("\n")
       [nil, false]

data/lib/paraduct/runner.rb

@@ -25,7 +25,7 @@ module Paraduct
     # @raise [Paraduct::Errors::ProcessError] command exited error status
     def perform(script)
       export_variables = @params.reverse_merge("PARADUCT_JOB_ID" => @job_id, "PARADUCT_JOB_NAME" => job_name)
-      variable_string = export_variables.map{ |key, value| %(export #{key}="#{value}";) }.join(" ")
+      variable_string = export_variables.map { |key, value| %(export #{key}="#{value}";) }.join(" ")
 
       Array.wrap(script).inject("") do |stdout, command|
         stdout << run_command("#{variable_string} #{command}")
@@ -38,11 +38,11 @@ module Paraduct
     end
 
     def job_name
-      @params.map { |key, value| "#{key}_#{value}" }.join("_").gsub(%r([/ ]), "_")
+      @params.map { |key, value| "#{key}_#{value}" }.join("_").gsub(%r{[/ ]}, "_")
     end
 
     def formatted_params
-      @params.map{ |key, value| "#{key}=#{value}" }.join(", ")
+      @params.map { |key, value| "#{key}=#{value}" }.join(", ")
     end
 
     def logger
@@ -57,31 +57,31 @@ module Paraduct
 
     private
 
-    def run_command(command)
-      full_stdout = ""
-      exit_status = nil
-
-      logger.info "run_command: #{command}"
-
-      PTY.spawn(command) do |stdin, stdout, pid|
-        stdout.close_write
-        stdin.sync = true
-
-        begin
-          stdin.each do |line|
-            line.strip!
-            logger.info line
-            full_stdout << "#{line}\n"
+      def run_command(command)
+        full_stdout = ""
+        exit_status = nil
+
+        logger.info "run_command: #{command}"
+
+        PTY.spawn(command) do |stdin, stdout, pid|
+          stdout.close_write
+          stdin.sync = true
+
+          begin
+            stdin.each do |line|
+              line.strip!
+              logger.info line
+              full_stdout << "#{line}\n"
+            end
+          rescue Errno::EIO # rubocop:disable Lint/HandleExceptions
+          ensure
+            _, exit_status = Process.waitpid2(pid)
           end
-        rescue Errno::EIO
-        ensure
-          _, exit_status = Process.waitpid2(pid)
         end
-      end
 
-      raise Paraduct::Errors::ProcessError.new(full_stdout, exit_status) unless exit_status.success?
+        raise Paraduct::Errors::ProcessError.new(full_stdout, exit_status) unless exit_status.success?
 
-      full_stdout
-    end
+        full_stdout
+      end
   end
 end