empirical 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5f02cbba70ea2ac807d23f7a60cdd1e7bbd35f8df0b4fd0c9bd7e7d38dd18f
-  data.tar.gz: 927a9d036d77e2974b1dbe6d3ea1ab922a234627a653c50c5746bde132a4045b
+  metadata.gz: 7fede1fc1d6079a9a1b13ae0875ac41bf61a6b7fe812688ca06e8ccd4e1cb9f5
+  data.tar.gz: cadaa32b10e496014d25418b594dd0195958e8aa15eee50f45549a1390cf9012
 SHA512:
-  metadata.gz: c9237b1059fa32b97c00cab01ff5d66a1131db3bca172abe55fddb44f13277496f921ede321421eb55672628c4666ad84a2077b3a6f87a5ab0e7f3041871a379
-  data.tar.gz: aa14bc1a19ab39363c500bf0c4d012f39e6c48cdb9b7221f7cfce9b748eafea147df40733eae240729f9b96378cba94f1a64c4cde378cc3dd258c12b57935253
+  metadata.gz: 8a5371864bd72f10a9a65648ea13227af2e621978018f151d6d4dae360d08dd909d105663d0954a98f378c2d464b1d46fc5cca098ae547c5148319f7f6acac95
+  data.tar.gz: 6fa32faa04f2e919616ee06a0e4fe60e3c0b316eb5e07936eb16dac1a5fd6200aace0e8b821b43c62bf5902a3eb7a65b6f0d3af5646d478ea182dca34beba808

data/README.md

@@ -1,8 +1,27 @@
 # Empirical
 
+> (_adjective_) based on what is experienced or seen rather than on theory \
+> (_noun_) enhancements for Ruby with a runtime type system
+
+Empirical catches bugs early and makes your code self-documenting by enhancing Ruby with beautiful syntax to define runtime type assertions.
+
+```ruby
+fun word_frequency(text: String) => _Hash(String, Integer) do
+  text
+    .downcase
+    .scan(/\w+/)
+    .tally
+    .sort_by { |word, count| -count }
+    .first(10)
+    .to_h
+end
+```
+
+(see [below](#runtime-typing)).
+
 ## Setup
 
-Install the gem by adding it to your `Gemfile` and running `bundle install`. You’ll probably want to set it to `require: false` here because you should require it manually at precisely the right moment.
+Install the gem by adding it to your <kbd>Gemfile</kbd> and running <kbd>bundle install</kbd>. You’ll probably want to set it to `require: false` here because you should require it manually at precisely the right moment.
 
 ```ruby
 gem "empirical", require: false

data/lib/empirical/class_callbacks_processor.rb

@@ -13,11 +13,11 @@ class Class
 end
 
 class Empirical::ClassCallbacksProcessor < Empirical::BaseProcessor
-	def visit_class_node(node)
-		@annotations << [node.end_keyword_loc.start_offset, 0, ";class_defined();"]
-	end
+	# def visit_class_node(node)
+	# 	@annotations << [node.end_keyword_loc.start_offset, 0, ";class_defined();"]
+	# end
 
-	def visit_module_node(node)
-		@annotations << [node.end_keyword_loc.start_offset, 0, ";module_defined();"]
-	end
+	# def visit_module_node(node)
+	# 	@annotations << [node.end_keyword_loc.start_offset, 0, ";module_defined();"]
+	# end
 end

data/lib/empirical/signature_processor.rb

@@ -56,7 +56,7 @@ class Empirical::SignatureProcessor < Empirical::BaseProcessor
 			case signature
 			# parameterless method defs (e.g. `fun foo` or `fun foo()`)
 			in Prism::LocalVariableReadNode | Prism::ConstantReadNode
-				# no-op
+			# no-op
 			# parameterful method defs (e.g. `fun foo(a: Type)` or `fun foo(a = Type)`)
 			in Prism::CallNode
 				raise SyntaxError if signature.block
@@ -107,6 +107,20 @@ class Empirical::SignatureProcessor < Empirical::BaseProcessor
 					in Prism::KeywordHashNode
 						argument.elements.each do |argument|
 							name = argument.key.unescaped
+
+							nilable = false
+
+							if name.end_with?("?")
+								name = name[0..-2]
+								nilable = true
+
+								@annotations << [
+									argument.key.location.end_offset - 2,
+									1,
+									"",
+								]
+							end
+
 							typed_param = argument.value
 
 							case typed_param
@@ -131,10 +145,20 @@ class Empirical::SignatureProcessor < Empirical::BaseProcessor
 								case typed_param
 								# Keyword with default
 								in Prism::CallNode[name: :|, receiver: type, arguments: Prism::ArgumentsNode[arguments: [default]]]
-									type_slice = type.slice
+									type_slice = if nilable
+										"::Literal::_Nilable(#{type.slice})"
+									else
+										type.slice
+									end
+
 									default_string = default.slice
 								else
-									type_slice = typed_param.slice
+									type_slice = if nilable
+										"::Literal::_Nilable(#{typed_param.slice})"
+									else
+										typed_param.slice
+									end
+
 									default_string = "nil"
 								end
 
@@ -229,7 +253,7 @@ class Empirical::SignatureProcessor < Empirical::BaseProcessor
 				[
 					node.location.end_offset,
 					0,
-					");(raise ::Empirical::TypeError.return_type_error(value: __literally_returning__, expected: #{@return_type}, method_name: __method__, context: self) unless #{@return_type} === __literally_returning__);return(__literally_returning__))",
+					");(raise ::Empirical::TypeError.return_type_error(value: __literally_returning__, expected: #{@return_type.slice}, method_name: __method__, context: self) unless #{@return_type.slice} === __literally_returning__);return(__literally_returning__))",
 				]
 			)
 		end

data/lib/empirical/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Empirical
-	VERSION = "0.0.2"
+	VERSION = "0.0.3"
 end

data/lib/rubocop/cop/empirical/no_defs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class RuboCop::Cop::Empirical::NoDefs < RuboCop::Cop::Base
+	MSG = "Use `fun` method definitions instead of `def` method definitions."
+
+	def on_def(node)
+		add_offense(node) unless node.arguments.any?(&:forward_args_type?)
+	end
+
+	def on_defs(node)
+		add_offense(node) unless node.arguments.any?(&:forward_args_type?)
+	end
+end

data/lib/rubocop/cop/empirical.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+	module Cop
+		module Empirical; end
+	end
+end
+
+require_relative "empirical/no_defs"

data/lib/rubocop-empirical.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require_relative "rubocop/cop/empirical"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: empirical
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Joel Drapper
@@ -56,6 +56,7 @@ description: Based on, concerned with, or verifiable by observation or experienc
   rather than theory or pure logic.
 email:
 - joel@drapper.me
+- stephen.margheim@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,6 +73,9 @@ files:
 - lib/empirical/signature_processor.rb
 - lib/empirical/type_error.rb
 - lib/empirical/version.rb
+- lib/rubocop-empirical.rb
+- lib/rubocop/cop/empirical.rb
+- lib/rubocop/cop/empirical/no_defs.rb
 - lib/ruby_lsp/empirical/addon.rb
 homepage: https://github.com/yippee-fun/empirical
 licenses: