neuroncheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48bfd036b69c0f6d509363762c39a3fda0dc97f4
+  data.tar.gz: 49471c3dd25296b6527572ec6fbf37aa6a896784
+SHA512:
+  metadata.gz: 35c0916e4421893c8f1d175585f08586fd8e66f43d4b93a4ac10a99c65c4cee556c2c4ae49d030b1b23274eceab3a592b8e04182a857fc7405ec71a3b2495f5f
+  data.tar.gz: 7f07bda2153ba07a262fae2afd1b3c6e6e078ff197aab19df8a9bb8445c54043cb3713676c380c4d553c33e997956603781a188c3547e53bab5f97c728175037

data/Rakefile.rb

@@ -0,0 +1,54 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+Rake.application.instance_variable_get('@tasks').delete('release')
+
+desc 'Run test_unit based test'
+task :test do
+  Dir.glob('test/**/test_*.rb') do |path|
+    cmd = "bundle exec ruby #{path}"
+    puts cmd
+    system cmd
+  end
+end
+
+%w(example example_dev).each do |base_dir_name|
+
+  example_dests = []
+  directory "#{base_dir_name}/"
+  Dir.glob("#{base_dir_name}_src/**/*.rb") do |src|
+    # サブディレクトリを持っているかどうかで処理を分岐
+    dest_dir = "#{base_dir_name}/"
+    if src =~ %r|/.+?/| then
+      dest_dir = File.dirname(src).sub(/^example_src/, 'example')
+    end
+
+    # 出力先を取得
+    dest = src.sub(/^#{base_dir_name}_src/, base_dir_name)
+    example_dests << dest
+
+    # タスク定義
+    directory dest_dir
+    desc '-'
+    file dest => [src, dest_dir, __FILE__] + FileList['lib/**/*.rb'] do
+      # NeuronCheckを使用してスクリプト実行
+      cmd = %Q|bundle exec ruby -I lib #{src}|
+      puts cmd
+      system cmd, [:out, :err] => ['_example_out.txt', 'w']
+
+      # スクリプトの実行の結果、出力された内容を、コメントとして後ろに結合したうえで書き込む
+      # ただしこの際、ファイルパスを置換するなどの加工もかける
+      output_lines = File.readlines('_example_out.txt')
+      output = output_lines.map{|x| "#   #{x}"}.join.sub('#  ', '#=>')
+      output.gsub!(Dir.pwd, '.')
+      output.gsub!(src, 'script.rb')
+
+      File.write(dest, File.read(src) + "\n" + output)
+      $stderr.puts "-> #{dest}"
+    end
+  end
+
+
+  desc 'make example code'
+  task base_dir_name => example_dests
+
+end

data/lib/neuroncheck.rb

@@ -0,0 +1 @@
+require 'neuroncheck/kernel'

data/lib/neuroncheck/builtin_keyword.rb

@@ -0,0 +1,165 @@
+require 'neuroncheck/plugin'
+
+# 組み込みキーワードの定義
+
+# respondable: 指定した名前のメソッドが定義されている（メソッド呼び出しに応答可能である）ことを表す。Duck Typing用
+NeuronCheckSystem::Plugin.add_keyword(:respondable) do
+  def on_call(*method_names)
+		@method_names = method_names
+  end
+
+  def match?(value)
+    @method_names.all?{|x| value.respond_to?(x)}
+  end
+
+  def expected_caption
+		in_cap = NeuronCheckSystem::Utils.string_join_using_or_conjunction(@method_names.map{|x| "##{x}"})  # 複数の文字列を結合し、orを使ったフレーズの形にするUtilityメソッド。 ['A', 'B', 'C'] => "A, B or C"
+		"respondable to #{in_cap}"
+  end
+
+	def expected_short_caption
+    'respondable(' + @method_names.map{|x| x.inspect}.join(', ') + ')'
+  end
+
+	def get_params_as_json
+		{'expected' => @method_names.map(&:to_s)}
+	end
+
+	def self.builtin_keyword?
+		true
+	end
+end
+
+# respond_to, res: respondableのエイリアス
+NeuronCheckSystem::Plugin.alias_keyword(:res, :respondable)
+
+# any: すべての値を受け付ける
+NeuronCheckSystem::Plugin.add_keyword(:any) do
+  def on_call
+  end
+
+  def match?(value)
+    true # 常にtrue
+  end
+
+  def expected_caption
+    "any value"
+  end
+
+	def expected_short_caption
+    "any"
+  end
+
+	def get_params_as_json
+		{}
+	end
+
+	def self.builtin_keyword?
+		true
+	end
+end
+
+# block: ブロック引数用の特殊なキーワード。[Proc, nil]と同じ
+NeuronCheckSystem::Plugin.add_keyword(:block) do
+  def on_call
+  end
+
+  def match?(value)
+    @api.expected_value_match?(value, [Proc, nil])
+  end
+
+  def expected_caption
+    "block or nil"
+  end
+
+	def self.builtin_keyword?
+		true
+	end
+end
+
+
+# except: 指定した値以外を許可 (否定 / NOT)
+NeuronCheckSystem::Plugin.add_keyword(:except) do
+  def on_call(target)
+		@target = target
+  end
+
+  def match?(value)
+    not @api.expected_value_match?(value, @target)
+  end
+
+  def expected_caption
+    "any value except #{@api.get_expected_value_caption(@target)}"
+  end
+
+	def expected_short_caption
+    "except(#{@api.get_expected_value_short_caption(@target)})"
+  end
+
+	def get_params_as_json
+		{'target' => @api.get_expected_value_meta_info_as_json(@target)}
+	end
+
+	def self.builtin_keyword?
+		true
+	end
+end
+
+
+# array_of: 指定した種類の値のみを格納した配列であることを表す
+NeuronCheckSystem::Plugin.add_keyword(:array_of) do
+  def on_call(item_expected)
+		@item_expected = item_expected
+  end
+
+  def match?(value)
+		return false unless value.kind_of?(Array) # まずは配列であるかどうかチェック
+
+		# 配列であれば、1つ1つの値が型どおりであるかどうかをチェック
+		return value.all?{|x| @api.expected_value_match?(x, @item_expected)}
+  end
+
+  def expected_caption
+    "array of #{@api.get_expected_value_caption(@item_expected)}"
+  end
+
+	def get_params_as_json
+		{'item' => @api.get_expected_value_meta_info_as_json(@item_expected)}
+	end
+
+	def self.builtin_keyword?
+		true
+	end
+end
+
+
+# hash_of: 指定した種類のキーと値のみを格納した配列であることを表す
+NeuronCheckSystem::Plugin.add_keyword(:hash_of) do
+	def on_call(key_expected, value_expected)
+		@key_expected = key_expected
+		@value_expected = value_expected
+  end
+
+	def match?(value)
+		return false unless value.kind_of?(Hash) # まずはHashであるかどうかチェック
+
+		# ハッシュであれば、1つ1つのキーと値をチェック
+		return value.all?{|k, v| @api.expected_value_match?(k, @key_expected) and @api.expected_value_match?(v, @value_expected)}
+  end
+
+	def expected_caption
+		"hash that has keys of #{@api.get_expected_value_caption(@key_expected)} and values of #{@api.get_expected_value_caption(@value_expected)}, #{expected_short_caption}"
+  end
+
+	def expected_short_caption
+		"{#{@api.get_expected_value_short_caption(@key_expected)} => #{api.get_expected_value_short_caption(@value_expected)}}"
+  end
+
+	def get_params_as_json
+		{'key' => @api.get_expected_value_meta_info_as_json(@key_expected), 'value' => @api.get_expected_value_meta_info_as_json(@value_expected)}
+	end
+
+	def self.builtin_keyword?
+		true
+	end
+end

data/lib/neuroncheck/cond_block.rb

@@ -0,0 +1,42 @@
+module NeuronCheckSystem
+	class CondBlockContext
+		def initialize(block_name, method_self, allow_instance_method)
+			@block_name = block_name
+			@method_self = method_self
+			@allow_instance_method = allow_instance_method
+		end
+
+		def method_missing(name, *args, &block)
+			if @method_self.respond_to?(name, true) then
+				if @allow_instance_method then
+					@method_self.send(name, *args, &block)
+				else
+					raise NeuronCheckSystem::DeclarationError, "instance method `#{name}' cannot be called in #{@block_name}, it is forbidden", (NeuronCheck.debug? ? caller : caller(1))
+				end
+			else
+				super
+			end
+		end
+
+		def assert(*dummy)
+			unless block_given? then
+				raise NeuronCheckSystem::DeclarationError, "no block given for `assert' in #{@block_name}", (NeuronCheck.debug? ? caller : caller(1))
+			end
+
+			passed = yield
+
+			unless passed
+				locs = Utils.backtrace_locations_to_captions(caller(1, 1))
+
+				msg = <<MSG
+#{@block_name} assertion failed
+  asserted at: #{locs.join("\n" + ' ' * 15)}
+
+MSG
+
+				# エラーを発生させる
+				throw :neuron_check_error_tag, msg
+			end
+		end
+	end
+end

data/lib/neuroncheck/declaration.rb

@@ -0,0 +1,295 @@
+require 'neuroncheck/matcher'
+require 'neuroncheck/plugin'
+require 'neuroncheck/syntax'
+require 'neuroncheck/builtin_keyword'
+
+module NeuronCheckSystem
+	# 宣言用のメソッドやメソッド追加時の処理を定義したモジュール。NeuronCheckを行いたい対象のモジュールやクラスにextendすることで使用する
+	module DeclarationMethods
+		# 宣言を実行
+		def ndecl(*expecteds, &block)
+			# 未初期化の場合、NeuronCheck用の初期化を自動実行
+			unless @__neuron_check_initialized then
+				NeuronCheckSystem.initialize_module_for_neuron_check(self)
+			end
+
+			# メイン処理実行
+			__neuroncheck_ndecl_main(expecteds, block, caller(1, 1))
+		end
+
+		# ndeclのエイリアス
+		alias ncheck ndecl
+		alias ndeclare ndecl
+		alias nsig ndecl
+		alias ntypesig ndecl
+
+		# ndeclのメイン処理
+		def __neuroncheck_ndecl_main(expecteds, block, declared_caller_locations)
+			# 2回連続で宣言された場合はエラー
+			if @__neuron_check_last_declaration then
+				raise DeclarationError, "repeated declarations - Declaration block and method definition must correspond one-to-one"
+			end
+
+			# ブロックが渡されたかどうかで処理を分岐
+			if block then
+				# ブロックが渡された場合
+				__neuroncheck_ndecl_main_with_block(block, declared_caller_locations)
+			else
+				# 短縮記法はNeuronCheckSyntax使用可能時のみ
+				unless defined?(NeuronCheckSyntax) then
+					raise DeclarationError, "NeuronCheck shorthand syntax (without block) can be used only in Ruby 2.1 or later"
+				end
+
+				# ブロックが渡されていない場合 (短縮記法)
+				__neuroncheck_ndecl_main_without_block(expecteds, declared_caller_locations)
+			end
+		end
+
+		# ndeclの通常記法
+		def __neuroncheck_ndecl_main_with_block(block, declared_caller_locations)
+			# 宣言ブロック実行用のコンテキストを作成
+			context = NeuronCheckSystem::DeclarationContext.new
+
+			# 宣言ブロックの内容を実行
+			context.instance_eval(&block)
+
+			# 呼び出し場所を記憶
+			context.declaration.declared_caller_locations = declared_caller_locations
+
+			# 宣言の内容を「最後の宣言」として保持
+			@__neuron_check_last_declaration = context.declaration
+		end
+
+		# ndeclの短縮記法
+		def __neuroncheck_ndecl_main_without_block(expecteds, declared_caller_locations)
+			# 宣言ブロック実行用のコンテキストを作成
+			context = NeuronCheckSystem::DeclarationContext.new
+
+			# 引数の解釈
+			expected_args = nil
+			expected_return = nil
+			if expecteds.last.kind_of?(Hash) and expecteds.last.size == 1 then
+				# expectedsの最後が、値が1つだけ格納されたHashであれば、キーを最後の引数、値を戻り値と解釈する
+				# 例: String, String => Numeric
+				last_hash = expecteds.pop
+				expected_args = expecteds.concat([last_hash.keys.first])
+				expected_return = last_hash.values.first
+			else
+				# 上記以外の場合はすべて引数と見なす
+				expected_args = expecteds
+			end
+
+			# 引数1つで、かつ空配列が渡された場合は、「引数なし」と宣言されたとみなす
+			if expected_args[0].kind_of?(Array) and expected_args.size == 1 then
+				expected_args = []
+			end
+
+			# 簡易宣言を実行
+			context.instance_eval do
+				unless expected_args.empty? then
+					args *expected_args
+				end
+
+				if expected_return then
+					returns expected_return
+				end
+			end
+
+			# 短縮記法フラグON
+			context.declaration.shorthand = true
+
+			# 呼び出し場所を記憶
+			context.declaration.declared_caller_locations = declared_caller_locations
+			context.declaration.arg_matchers.each do |matcher|
+				matcher.declared_caller_locations = context.declaration.declared_caller_locations
+			end
+			if context.declaration.return_matcher then
+				context.declaration.return_matcher.declared_caller_locations = context.declaration.declared_caller_locations
+			end
+
+			# 宣言の内容を「最後の宣言」として保持 (通常のndeclと同じ)
+			@__neuron_check_last_declaration = context.declaration
+		end
+	end
+
+	class DeclarationContext
+		include Keywords
+		attr_reader :declaration
+
+		def initialize
+			@declaration = Declaration.new
+		end
+
+		def args(*expecteds)
+			declared_caller_locations = caller(1, 1)
+			@declaration.arg_matchers = expecteds.map{|x| NeuronCheckSystem.get_appropriate_matcher(x, declared_caller_locations)}
+		end
+
+		def returns(expected)
+			declared_caller_locations = caller(1, 1)
+			@declaration.return_matcher = NeuronCheckSystem.get_appropriate_matcher(expected, declared_caller_locations)
+		end
+
+		def precond(allow_instance_method: false, &cond_block)
+			@declaration.precond = cond_block
+			@declaration.precond_allow_instance_method = allow_instance_method
+		end
+
+		def postcond(allow_instance_method: false, &cond_block)
+			@declaration.postcond = cond_block
+			@declaration.postcond_allow_instance_method = allow_instance_method
+		end
+
+		def val(expected)
+			declared_caller_locations = caller(1, 1)
+			@declaration.attr_matcher = NeuronCheckSystem.get_appropriate_matcher(expected, declared_caller_locations)
+		end
+		alias must_be val
+		alias value val
+	end
+
+	class Declaration
+		attr_accessor :arg_matchers
+		attr_accessor :return_matcher
+		attr_accessor :attr_matcher
+
+		attr_accessor :precond
+		attr_accessor :precond_allow_instance_method
+		attr_accessor :postcond
+		attr_accessor :postcond_allow_instance_method
+
+		attr_accessor :assigned_class_or_module
+		attr_accessor :assigned_method
+		attr_accessor :assigned_singleton_original_class
+		attr_accessor :assigned_attribute_name
+		attr_accessor :shorthand
+		attr_accessor :declared_caller_locations
+
+
+		def initialize
+			@arg_matchers = []
+			@return_matcher = nil
+			@attr_matcher = nil
+			@precond = nil
+			@precond_allow_instance_method = false
+			@postcond = nil
+			@postcond_allow_instance_method = false
+
+			@assigned_class_or_module = nil
+			@assigned_method = nil
+			@assigned_singleton_original_class = nil
+			@assigned_attribute_name = nil
+
+			@shorthand = false
+			@declared_caller_locations = nil
+		end
+
+		def attribute?
+			(@assigned_attribute_name ? true : false)
+		end
+
+		def assinged_to_toplevel_method?
+			@assigned_class_or_module == Object
+		end
+		def assinged_to_singleton_method?
+			@assigned_singleton_original_class
+		end
+
+		# メソッド名/属性名の表記文字列を取得
+		def signature_caption_name_only
+			if @assigned_class_or_module and (@assigned_method or attribute?) then
+				ret = ""
+
+				# 属性、特異メソッド、インスタンスメソッドのそれぞれで処理を分岐
+				if attribute? then
+					if @assigned_class_or_module.name then
+						ret << @assigned_class_or_module.name
+					end
+
+					# 属性名出力
+					ret << "##{@assigned_attribute_name}"
+
+				elsif assinged_to_toplevel_method? then
+					# メソッド名出力
+					ret << "#{@assigned_method.name}"
+
+				elsif assinged_to_singleton_method? then
+					if @assigned_singleton_original_class.name then
+						ret << @assigned_singleton_original_class.name
+					end
+
+					# メソッド名出力
+					ret << ".#{@assigned_method.name}"
+				else
+					if @assigned_class_or_module.name then
+						ret << @assigned_class_or_module.name
+					end
+
+					# メソッド名出力
+					ret << "##{@assigned_method.name}"
+				end
+			else
+				nil
+			end
+		end
+
+		# メソッド名/属性名＋引数＋戻り値の表記文字列を取得
+		def signature_caption
+			ret = signature_caption_name_only
+			if ret then
+				if attribute? then
+
+					if @attr_matcher then
+						ret << " -> #{@attr_matcher.expected_short_caption}"
+					end
+				else
+
+					# 引数出力
+					unless @assigned_method.parameters.empty? then
+						ret << "("
+						@assigned_method.parameters.each_with_index do |param_info, i|
+							_, param_name = param_info
+							if i >= 1 then
+								ret << ", "
+							end
+
+							if (matcher = @arg_matchers[i]) then
+								ret << "#{param_name}:#{matcher.expected_short_caption}"
+							else
+								ret << "#{param_name}:any"
+							end
+						end
+						ret << ")"
+					end
+
+					if @return_matcher then
+						ret << " -> #{@return_matcher.expected_short_caption}"
+					end
+				end
+
+				return ret
+			else
+				nil
+			end
+		end
+
+		def meta_info_as_json
+			re = {}
+
+			if attribute? then
+				re['value'] = (@attr_matcher ? @attr_matcher.meta_info_as_json : nil)
+				re['signature_caption'] = signature_caption
+				re['signature_caption_name_only'] = signature_caption_name_only
+			else
+				re['args'] = @arg_matchers.map{|x| x.meta_info_as_json}
+				re['returns'] = (@return_matcher ? @return_matcher.meta_info_as_json : nil)
+				re['signature_caption'] = signature_caption
+				re['signature_caption_name_only'] = signature_caption_name_only
+			end
+			re['precond_source_location'] = (@precond ? @precond.source_location : nil)
+			re['postcond_source_location'] = (@postcond ? @postcond.source_location : nil)
+
+			re
+		end
+	end
+end