lap 0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2175fa843ad4fa64403068441af0c6ca2be15b930746aa3af383dab7ed670822
-  data.tar.gz: d28106befda1f37218423c1ba046934cc31e73025fdd60a1c96e45db646913f1
+  metadata.gz: ea16dd85703fad45b818f07cd284255e743d266f56e63bc77467b2194a79ca08
+  data.tar.gz: cb063132aa918f79858f1724fe05b43549778ae0d77c7b95e6b90f7e69d6b6e0
 SHA512:
-  metadata.gz: 355d4a32d74d86d51cfa2dd9a263c6f72301486a53012fa1873c66e6054d8a90080d1c7b75a6fb9ad1818767f00c72972f880a62979f8c8e14f9e1d26f515b61
-  data.tar.gz: 1f63b97bc3a9c19ca9d5f45d159a6166c842ad19bb2f95f04f6b217165a3d9fdc428fa2ea05aa761a2e46100e13b9aaae28a7067b37accab85d849390959f436
+  metadata.gz: ddc0a9ce6cedb86d32bc7bf8028fd97f43400fe2bcb0ad0f5bdc4ebc5f4afbc2d19c21ee998cccbf6d81b556968438eb9e652bcdc0a92caac105fa67c4064336
+  data.tar.gz: d4e403af9411531c95fb10379ff4e6fc1c3fcd96efb141e3f3b143d2e191ef971631434fb3443db74b914d4c55bd5b872fd312bbf2f7a19b28e58165d3a4411b

data/Gemfile.lock

@@ -1,23 +1,48 @@
 PATH
   remote: .
   specs:
-    lap (0.2)
+    lap (0.2.1)
       rbs
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    ast_utils (0.3.0)
+      parser (~> 2.4)
+      thor (>= 0.19)
     byebug (11.1.3)
     coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
+    ffi (1.13.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.15.0.1)
+    listen (3.3.3)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
+    minitest (5.14.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
+    rainbow (3.0.0)
     rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rbs (0.17.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -32,6 +57,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    steep (0.36.0)
+      activesupport (>= 5.1)
+      ast_utils (~> 0.3.0)
+      language_server-protocol (~> 3.15.0.1)
+      listen (~> 3.0)
+      parser (~> 2.7.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 0.17.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -41,6 +79,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)
+  steep
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -23,6 +23,8 @@ module Bank
     attr_reader owner: Bank::Customer
     attr_reader balance: Float
 
+    def initialize: (Bank::Customer owner, Float interest_rate, ?Float balance) -> void
+
     type date_or_dt = Date | DateTime
 
     # can optionally specify when the transaction should take place
@@ -51,10 +53,8 @@ module Bank
     attr_reader :owner
     attr_reader :balance
 
-    def initialize(owner, interest_rate, balance)
-        @owner = owner
-        @interest_rate = interest_rate
-        @balance = balance
+    def initialize(owner, interest_rate, balance = nil)
+      # returns void
     end
 
     # can optionally specify when the transaction should take place
@@ -84,7 +84,7 @@ module Bank
     attr_reader :owner
     attr_reader :balance
 
-    def initialize(owner, interest_rate, balance)
+    def initialize(owner, interest_rate, balance = 0)
         @owner = owner
         @interest_rate = interest_rate
         @balance = balance
@@ -110,12 +110,33 @@ end
 
 From here, you now have some ruby code which you can [type check](https://github.com/soutaro/steep)!
 
+### Experimental:
+
+There is an experimental feature which allows you to specify some ruby logic *within* your rbs files
+for your methods. You specify it between `@!begin` and `@!end`, eg.:
+
+```ruby
+# take some moeny out of the customers account
+# @!begin
+#   @balance -= amount
+# @!end
+def withdraw(Float amount) -> Float
+```
+This would produce:
+
+```ruby
+# take some moeny out of the customers account
+def withdraw(amount)
+  @balance -= amount
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cutter'
+gem 'lap'
 ```
 
 And then execute:
@@ -124,7 +145,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install cutter
+    $ gem install lap
 
 ## Configuration
 
@@ -132,7 +153,9 @@ You can specify preferences in a `.lap.yml` file in your project directory. Exam
 
 ```yml
 indent: 4 # default is 2
-# this is it for now, more to come
+frozen_string_literals: false # add 'frozen_string_literal: true' to top of file; default is true
+# preferred line length in characters; default is 100. Note "preferred" - not always a guarantee
+preferred_line_length: 80
 ```
 
 ## Coverage
@@ -163,27 +186,6 @@ procs|⚠️
 constants|⚠️
 interfaces|⚠️
 
-### Experimental:
-
-There is an experimental feature which allows you to specify some ruby logic *within* your rbs files
-for your methods. You specify it between `@!begin` and `@!end`, eg.:
-
-```ruby
-# take some moeny out of the customers account
-# @!begin
-#   @balance -= amount
-# @!end
-def withdraw(Float amount) -> Float
-```
-This would produce:
-
-```ruby
-# take some moeny out of the customers account
-def withdraw(amount)
-  @balance -= amount
-end
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Steepfile

@@ -0,0 +1,10 @@
+target :app do
+  signature "sig"
+
+  library "rbs"
+  library "pathname"
+  library "set"
+  library "logger"
+
+  check "lib"
+end

data/lap.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "rbs"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "steep"
 end

data/lib/lap.rb

@@ -44,7 +44,9 @@ module Lap
       end
 
       puts FROZEN_STRING_COMMENT if Lap::Config[:frozen_string_literals]
-      puts output.join("\n")
+      out = output.join("\n")
+      puts out
+      out
     end
   end
 end

data/lib/lap/class.rb

@@ -22,35 +22,35 @@ module Lap
     def contents
       @contents ||= begin
         if @has_contents
-          member_indent = Lap::Config[:indent] * (@indent_level + 1)
-          members = @node.members.map do |m|
-            case m
+          member_indent = (Lap::Config[:indent] * (@indent_level + 1)).to_i
+          members = @node.members.map do |member|
+            case member
             when RBS::AST::Members::MethodDefinition
-              Lap::Method.new(m, @indent_level + 1).render
+              Lap::Method.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Class
-              self.class.new(m, @indent_level + 1).render
+              self.class.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Module
-              Lap::Module.new(m, @indent_level + 1).render
+              Lap::Module.new(member, @indent_level + 1).render
             when RBS::AST::Members::AttrReader
-              with_comment(m, "attr_reader :#{m.name}").indent(member_indent)
+              with_comment(member, "attr_reader :#{member.name}").indent(member_indent)
             when RBS::AST::Members::AttrWriter
-              with_comment(m, "attr_writer :#{m.name}").indent(member_indent)
+              with_comment(member, "attr_writer :#{member.name}").indent(member_indent)
             when RBS::AST::Members::AttrAccessor
-              with_comment(m, "attr_accessor :#{m.name}").indent(member_indent)
+              with_comment(member, "attr_accessor :#{member.name}").indent(member_indent)
             when RBS::AST::Members::Public
               "public\n".indent(member_indent)
             when RBS::AST::Members::Private
               "private\n".indent(member_indent)
             when RBS::AST::Members::Include
-              with_comment(m, "include #{m.name}").indent(member_indent)
+              with_comment(member, "include #{member.name}").indent(member_indent)
             when RBS::AST::Members::Extend
-              with_comment(m, "extend #{m.name}").indent(member_indent)
+              with_comment(member, "extend #{member.name}").indent(member_indent)
             when RBS::AST::Declarations::Constant
-              Lap::Constant.new(m, @indent_level + 1).render
+              Lap::Constant.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Alias
               # no-op: not present in ruby
             else
-              warn "Unsupported member for classes: #{m}"
+              warn "Unsupported member for classes: #{member}"
             end
           end
           "\n#{members.compact.join("\n")}"

data/lib/lap/constant.rb

@@ -8,7 +8,7 @@ module Lap
     end
 
     def render
-      "#{name} = #{value}\n".indent(Lap::Config[:indent] * @indent_level)
+      "#{name} = #{value}\n".indent((Lap::Config[:indent] * @indent_level).to_i)
     end
 
     private

data/lib/lap/helpers.rb

@@ -8,11 +8,36 @@ module Lap
 
     def args(rp, rkw, op, okw)
       if [rp, rkw, op, okw].any? { |arg| arg.length.positive? }
+        arg_counter = 1
         contents = [
-          rp.map { |pos| pos.name || pos.type.name.name.downcase },
-          op.map { |pos| "#{pos.name || pos.type.name.name.downcase} = #{CLASS_TO_LITERAL[pos.type.name.name] || "nil"}" },
+          rp.map do |pos|
+            arg_counter += 1
+            pos.name || begin
+              if pos.type.respond_to?(:name)
+                pos.type.name.name.downcase
+              else
+                "arg#{arg_counter}"
+              end
+            end
+          end,
+          op.map do |pos|
+            name = nil
+            value = "nil"
+            if pos.name
+              name = pos.name
+            elsif pos.type.respond_to?(:name)
+              name = pos.type.name.name.downcase
+              value = CLASS_TO_LITERAL[pos.type.name.name]
+            else
+              name = "arg#{arg_counter}"
+            end
+            "#{name} = #{value}"
+          end,
           rkw.map { |name, _| "#{name}:" },
-          okw.map { |name, t| "#{name}: #{CLASS_TO_LITERAL[t.type.name.name]}" },
+          okw.map do |name, tipe|
+            value = tipe.type.respond_to?(:name) ? CLASS_TO_LITERAL[tipe.type.name.name] : "nil"
+            "#{name}: #{value}"
+          end,
         ].reject(&:empty?).flatten.join(", ")
         "(#{contents})"
       end
@@ -20,7 +45,7 @@ module Lap
 
     def with_comment(node, output)
       if (comment = node.comment&.string)
-        "#{comment.lines.map { |l| "# #{l}" }.join}#{output}"
+        "#{comment.lines.map { |line| "# #{line}" }.join}#{output}"
       else
         output
       end
@@ -33,10 +58,10 @@ module Lap
                   .string
                   .lines
       comment = []
-      lines.each do |l|
-        break if l.start_with? "@!begin"
+      lines.each do |line|
+        break if line.start_with? "@!begin"
 
-        comment << "# #{l}"
+        comment << "# #{line}"
       end
 
       comment.join

data/lib/lap/method.rb

@@ -16,19 +16,19 @@ module Lap
           #{body}
         end
       METHOD
-      result.indent(Lap::Config[:indent] * @indent_level)
+      result.indent((Lap::Config[:indent] * @indent_level).to_i)
     end
 
     private
 
-    def return_type(t)
-      case t
+    def return_type(tipe)
+      case tipe
       when RBS::Types::Literal
-        t
-      when ->(t) { t.class.to_s.start_with? "RBS::Types::Bases" }
-        "# returns #{t}"
+        tipe.inspect
+      when ->(tp) { tp.class.to_s.start_with? "RBS::Types::Bases" }
+        "# returns #{tipe}"
       else
-        "# TODO: return #{t.name.name}"
+        "# TODO: return #{tipe.name.name}"
       end
     end
 
@@ -48,7 +48,6 @@ module Lap
         comment = @node.comment
         logic = ""
         if comment
-          real_comment = []
           logic = []
           has_logic = false
           comment.string.lines.each do |line|
@@ -58,12 +57,9 @@ module Lap
               logic << line
             elsif line.lstrip.start_with? "@!begin"
               has_logic = true
-            else
-              real_comment << line
             end
           end
           logic = logic.join
-          comment = real_comment.join
         end
         if logic.length.positive?
           logic

data/lib/lap/module.rb

@@ -21,20 +21,20 @@ module Lap
     def contents
       @contents ||= begin
         if @has_contents
-          members = @node.members.map do |m|
-            case m
+          members = @node.members.map do |member|
+            case member
             when RBS::AST::Members::MethodDefinition
-              Lap::Method.new(m, @indent_level + 1).render
+              Lap::Method.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Class
-              Lap::Class.new(m, @indent_level + 1).render
+              Lap::Class.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Module
-              self.class.new(m, @indent_level + 1).render
+              self.class.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Constant
-              Lap::Constant.new(m, @indent_level + 1).render
+              Lap::Constant.new(member, @indent_level + 1).render
             when RBS::AST::Declarations::Alias
               # no-op: not present in ruby
             else
-              warn "Unsupported member for modules: #{m}"
+              warn "Unsupported member for modules: #{member}"
             end
           end
           "\n#{members.join("\n")}"

data/lib/lap/version.rb

@@ -1,3 +1,3 @@
 module Lap
-  VERSION = "0.2"
+  VERSION = "0.2.1"
 end

data/sig/lap.rbs

@@ -1,23 +1,26 @@
-require "rbs"
-require "pathname"
-require "yaml"
-require "lap/version"
-require "lap/helpers"
-require "lap/class"
-require "lap/method"
-require "lap/module"
-require "lap/constant"
-require "core_ext/string"
+# require "rbs"
+# require "pathname"
+# require "yaml"
+# require "lap/version"
+# require "lap/helpers"
+# require "lap/class"
+# require "lap/method"
+# require "lap/module"
+# require "lap/constant"
+# require "core_ext/string"
 
 module Lap
-  CONFIG_FILENAME = ".lap.yml"
-  DEFAULT_CONFIG = {
-    indent: 2,
-    frozen_string_literals: true,
-    preferred_line_length: 100
+  CONFIG_FILENAME: ".lap.yml"
+  type config = {
+    indent: Integer,
+    frozen_string_literals: bool,
+    preferred_line_length: Integer
   }
-  FROZEN_STRING_COMMENT = "# frozen_string_literal: true\n\n"
-  Config = DEFAULT_CONFIG
+  DEFAULT_CONFIG: config
+  FROZEN_STRING_COMMENT: "# frozen_string_literal: true
+
+"
+  Config: config
 
   class Output
     # @!begin

data/sig/lap/constant.rbs

@@ -0,0 +1,15 @@
+module Lap
+  class Constant
+    def initialize: (RBS::AST::Declarations::Constant node, Integer indent_level) -> void
+
+    def render: () -> String
+
+    private
+
+    def name: () -> String
+
+    def value: () -> String
+
+    def record_contents: (Hash[Symbol, untyped] hsh) -> String
+  end
+end

data/sig/lap/helpers.rbs

@@ -22,7 +22,20 @@ module Lap
       Hash[Symbol, RBS::Types::Function::Param] rkw,
       Array[RBS::Types::Function::Param] op,
       Hash[Symbol, RBS::Types::Function::Param] okw
-    ) -> String
+    ) -> (String | nil)
+
+    type commentable = RBS::AST::Declarations::t |
+      RBS::AST::Members::InstanceVariable |
+      RBS::AST::Members::ClassInstanceVariable |
+      RBS::AST::Members::ClassVariable |
+      RBS::AST::Members::Include |
+      RBS::AST::Members::Extend |
+      RBS::AST::Members::Prepend |
+      RBS::AST::Members::MethodDefinition |
+      RBS::AST::Members::AttrReader |
+      RBS::AST::Members::AttrWriter |
+      RBS::AST::Members::AttrAccessor |
+      RBS::AST::Members::Alias
 
     # @!begin
     #   if (comment = node.comment&.string)
@@ -31,7 +44,7 @@ module Lap
     #     output
     #   end
     # @!end
-    def with_comment: (RBS::AST node, String output) -> String
+    def with_comment: (commentable node, String output) -> String
 
     # @!begin
     #   return nil unless node.comment
@@ -48,6 +61,6 @@ module Lap
     #
     #   comment.join
     # @!end
-    def get_comment: (RBS::AST node) -> String
+    def get_comment: (commentable node) -> (String | nil)
   end
 end

data/sig/lap/method.rbs

@@ -31,7 +31,7 @@ module Lap
     #     "# TODO: return #{t.name.name}"
     #   end
     # @!end
-    def return_type: (RBS::Types type) -> String
+    def return_type: (RBS::Types::t t) -> String
 
     # @!begin
     #   @arguments ||= begin
@@ -43,7 +43,7 @@ module Lap
     #     args(rp, rkw, op, okw)
     #   end
     # @!end
-    def arguments: () -> String
+    def arguments: () -> (String | nil)
 
     # @!begin
     #   @body ||= begin

data/sig/lap/version.rbs

@@ -1,3 +1,3 @@
 module Lap
-  VERSION: "0.2"
+  VERSION: "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lap
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
 - Joseph Johansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Don't write your code, and rbs types! Write the rbs types first, then
   generate a template to fill in with business logic.
 email:
@@ -56,6 +70,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - exe/lap
@@ -73,6 +88,7 @@ files:
 - sig/core_ext/string.rbs
 - sig/lap.rbs
 - sig/lap/class.rbs
+- sig/lap/constant.rbs
 - sig/lap/helpers.rbs
 - sig/lap/method.rbs
 - sig/lap/module.rbs