sord 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e12cbfdebd498098bf0c5b788427151a4c213f4f8767dc670b5629d104d00f4
-  data.tar.gz: 4344e6cb822d1ca3c98961948915ee67244c093ab6a1f9f248cdeb51f439dbe2
+  metadata.gz: 48989b3587651b3576af45f8ba0664eb5e49696e6c8e9e18deb2bce33d78651e
+  data.tar.gz: 2b0f10c99524c00ebe89d76eecab495bd38c55dc5a84a0e707b888030a07caf9
 SHA512:
-  metadata.gz: 1ab1acfb5ca6537b46304e2dfb3e57d199668b475ea30d1519c4af19b9d088880d9518f531f9f8355dbdb21aa1774793f56b8665984691fe977aaf9ac2afb575
-  data.tar.gz: b1db635647176c5771478b8465d127f1f1e15212163490cdf616921c2aced669a2d76d8cad08188ed4e79a76f50b270abf0e2edb3e6c2972bd3aafe11dcd0e7e
+  metadata.gz: 6350ec6144be3d60d8056c0d25af71ad17c0960a1931e30cedb12fb1820461ed922fbad188b7ad6f8a3009a804311e6b2f63aae6bd938b7f036cfb00441db9ba
+  data.tar.gz: 2fffdecb428ab937948eebefa56aac39da39d4b1972ddc98d8d7d2d4ef37ee3f1fedecaa95146286d53707d8b8ccc16fa30d2aec9dcbe4eeb39369f2b4f4280c

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create an issue to report a bug
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Include the code for your method, class or module definition(s) where Sord is doing something incorrectly.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen. It may be useful to write your own expected RBI for your code.
+
+**Actual behavior**
+A description of what actually happened. Please post any incorrectly-generated RBI signatures, as well as the command-line output of Sord.
+
+**Additional information**
+Add any other information about the problem here.

data/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.vscode/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sord (0.2.0)
+    sord (0.2.1)
       colorize
       sorbet-runtime
       yard

data/README.md

@@ -99,20 +99,34 @@ class Example::Person
 end
 ```
 
+## Things to be aware of
+
+The general rule of thumb for type conversions is:
+
+  - If Sord understands the YARD type, then it is converted into the Sorbet type.
+  - If the YARD type is missing, Sord fills in `T.untyped`.
+  - If the YARD type can't be understood, Sord creates an undefined Ruby constant
+    with a similar name to the unknown YARD type. For example, the obviously
+    invalid YARD type `A%B` will become a constant called `SORD_ERROR_AB`.
+    You should search through your resulting RBI to find and fix and 
+    `SORD_ERROR`s.
+
 ## Things to work on
 
+  - No support whatsoever for blocks (they appear to cause syntax errors in RBI
+    currently)
   - I'm not 100% sure how this handles undocumented methods and classes.
   - More inference systems would be nice.
   - This won't generate type parameter definitions for things which mix-in
     `Enumerable`.
   - Module scoping is an issue - if `Example::Person` is replaced with `Person`
     in the YARD comments in the above example, Sorbet won't be able to resolve
-    it.
+    it. _This can be solved by making definitions syntactically heirarchical._
   - Tests!!
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sord. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/AaronC81/sord. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -120,4 +134,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Sord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sord/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Sord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AaronC81/sord/blob/master/CODE_OF_CONDUCT.md).

data/lib/sord/rbi_generator.rb

@@ -59,7 +59,17 @@ module Sord
         count_object
 
         parameter_list = meth.parameters.map do |name, default|
-          "#{name}#{default && " = #{default}"}"
+          # Handle these three main cases:
+          # - def method(param) or def method(param:)
+          # - def method(param: 'default')
+          # - def method(param = 'default')
+          if default.nil?
+            "#{name}"
+          elsif !default.nil? && name.end_with?(':')
+            "#{name} #{default}"
+          else
+            "#{name} = #{default}"
+          end
         end.join(", ")
 
         # This is better than iterating over YARD's "@param" tags directly 
@@ -88,9 +98,13 @@ module Sord
               getter.tags('return').flat_map(&:types), meth)
             
             Logging.infer("inferred type of parameter #{name.inspect} as #{inferred_type} using getter's return type", meth)
+            # Get rid of : on keyword arguments.
+            name = name.chop if name.end_with?(':')
             "#{name}: #{inferred_type}"
           else
             Logging.omit("no YARD type given for #{name.inspect}, using T.untyped", meth)
+            # Get rid of : on keyword arguments.
+            name = name.chop if name.end_with?(':')
             "#{name}: T.untyped"
           end
         end.join(", ")
@@ -106,9 +120,10 @@ module Sord
 
         prefix = meth.scope == :class ? 'self.' : ''
 
-        rbi_contents << "  sig { params(#{sig_params_list}).#{returns} }"
+        sig = sig_params_list.empty? ? "  sig { #{returns} }" : "  sig { params(#{sig_params_list}).#{returns} }"
+        rbi_contents << sig
 
-        rbi_contents << "  def #{prefix}#{meth.name}(#{parameter_list}) end"
+        rbi_contents << "  def #{prefix}#{meth.name}(#{parameter_list}); end"
       end
     end
 
@@ -154,4 +169,4 @@ module Sord
       end
     end
   end
-end
+end

data/lib/sord/type_converter.rb

@@ -58,16 +58,22 @@ module Sord
     #   will lead to less informative log messages.
     def self.yard_to_sorbet(yard, item=nil)
       case yard
-      when nil
+      when nil # Type not specified
         "T.untyped"
-      when  "bool", "Bool", "boolean", "Boolean", ["true", "false"], ["false", "true"]
+      when  "bool", "Bool", "boolean", "Boolean", "true", "false"
         "T::Boolean"
+      when 'self'
+        item.parent.path
       when Array
         # If there's only one element, unwrap it, otherwise allow for a
         # selection of any of the types
-        yard.length == 1 \
-          ? yard_to_sorbet(yard.first, item)
-          : "T.any(#{yard.map { |x| yard_to_sorbet(x, item) }.join(', ')})"
+        types = yard
+          .reject { |x| x == 'nil' }
+          .map { |x| yard_to_sorbet(x, item) }
+          .uniq
+        result = types.length == 1 ? types.first : "T.any(#{types.join(', ')})"
+        result = "T.nilable(#{result})" if yard.include?('nil')
+        result
       when /^#{SIMPLE_TYPE_REGEX}$/
         # If this doesn't begin with an uppercase letter, warn
         if /^[_a-z]/ === yard

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Aaron Christiansen
@@ -130,6 +130,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature-request.md"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md