yard2steep 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6288038fd78f492af6aa413b15c40ac3c6f3ada8068e56a3cf4ec252cfccec1d
-  data.tar.gz: 9fb5f345434b127bd61f96f1081874b8157698a8f7eaf5a8e6779ff891480642
+  metadata.gz: 2d4e6a8130a1312dc38b74c326380d9e23f5e15ef536f5486b335694af8adc4e
+  data.tar.gz: be238532e8c75224380d54a5494b27cf3578122b4fe59f4f454609bbf309ada2
 SHA512:
-  metadata.gz: 478577c07127351b4080ccbcf48f87656b65cafd6481ebd188bf3d110d26fc04da2513d520d6e99182981bbb84450ebab1c9651ce14569dd6ca3c1941684afaa
-  data.tar.gz: 8146d573e9f52dbac2309df6651c7b39733f3e5a6d267ec279985a6ec6459866bc61f84e4c4061aa75257444443a03eabbb91c192aadeae13ad62c8307bb02b6
+  metadata.gz: 7b52ffb2e6478def16ea64c5d9e68d46d54084f318376fbe2dc38f7f1be5fe87ae2750cf31d37c1edc76473ba2cd42257c43aba53df9453d8991c047e84c3d72
+  data.tar.gz: 778099a6c15f9fa648921f909236eebf5fceae28b2b2455188370269144e23f1b0c079377942666452b7dbb682f763ffc03d3c285c8fdfd0ac61b5037c36af46

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
+- 2.5.1
+before_install:
+- gem install bundler -v 1.16.1
+script:
+- bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yard2steep (0.1.3)
+    yard2steep (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,11 @@
 # Yard2steep
 
+[![Build Status](https://travis-ci.org/south37/yard2steep.svg?branch=master)](https://travis-ci.org/south37/yard2steep)
+[![Gem Version](https://badge.fury.io/rb/yard2steep.svg)](https://badge.fury.io/rb/yard2steep)
+
 Generate [steep](https://github.com/soutaro/steep) type definition file from yard annotation.
 
-:warning: **This is highly experimental project. Current version is 0.1.2.**
+:warning: **This is highly experimental project.**
 
 ## Installation
 

data/example/sample1/lib/example1.rb

@@ -13,9 +13,11 @@ end
 # @param [Array] contents
 
 class SomeClass
-  # @dynamic index, comment
+  # @dynamic index, index=, comment, count, count=
   attr_reader :index
+  attr_writer :index
   attr_reader("comment")
+  attr_accessor :count
 end
 
 module SomeModule

data/example/sample1/sig/example1.rbi

@@ -1,8 +1,12 @@
 class SomeClass
   @index: any
   @comment: any
+  @count: any
   def index: -> any
+  def index=: (any) -> any
   def comment: -> any
+  def count: -> any
+  def count=: (any) -> any
 end
 class MyClass
   def self.name: -> String

data/lib/yard2steep/ast/class_node.rb

@@ -28,14 +28,15 @@ module Yard2steep
           parent.is_a?(AST::ClassNode) ||
           (parent == nil && c_name == 'main')
         }
-        @kind      = kind
-        @c_name    = c_name
-        @super_c   = super_c
-        @c_list    = []  # list of constants
-        @m_list    = []  # list of methods
-        @ivar_list = []  # list of instance variables
-        @children  = []  # list of child classes
-        @parent    = parent
+        @kind       = kind
+        @c_name     = c_name
+        @super_c    = super_c
+        @c_list     = []  # list of constants
+        @m_list     = []  # list of methods
+        @ivar_list  = []  # list of instance variables
+        @ivarname_s = Set.new
+        @children   = []  # list of child classes
+        @parent     = parent
       end
 
       # @param [AST::ConstantNode] c
@@ -53,7 +54,10 @@ module Yard2steep
       # @param [AST::IVarNode] ivar
       # @return [void]
       def append_ivar(ivar)
-        @ivar_list.push(ivar)
+        if !@ivarname_s.include?(ivar.name)
+          @ivar_list.push(ivar)
+          @ivarname_s << ivar.name
+        end
       end
 
       # @param [AST::ClassNode] child

data/lib/yard2steep/parser.rb

@@ -516,11 +516,9 @@ module Yard2steep
         when "attr_reader"
           parse_attr_reader(parse_command_args_add_block(r_ast[2]))
         when "attr_writer"
-          # TODO(south37) Impl
-          # parse_attr_writer(parse_command_args_add_block(r_ast[2]))
+          parse_attr_writer(parse_command_args_add_block(r_ast[2]))
         when "attr_accessor"
-          # TODO(south37) Impl
-          # parse_attr_accessor(parse_command_args_add_block(r_ast[2]))
+          parse_attr_accessor(parse_command_args_add_block(r_ast[2]))
         end
 
         # Do nothing for other case
@@ -605,17 +603,15 @@ module Yard2steep
         when "attr_reader"
           parse_attr_reader(parse_command_args_add_block(r_ast[2][1]))
         when "attr_writer"
-          # TODO(south37) Impl
-          # parse_attr_writer(parse_command_args_add_block(r_ast[2][1]))
+          parse_attr_writer(parse_command_args_add_block(r_ast[2][1]))
         when "attr_accessor"
-          # TODO(south37) Impl
-          # parse_attr_accessor(parse_command_args_add_block(r_ast[2][1]))
+          parse_attr_accessor(parse_command_args_add_block(r_ast[2][1]))
         end
         # Do nothing for other case
       end
     end
 
-    # @param [Array<String>] vars
+    # @param [Array<String>] ivars
     # @return [void]
     def parse_attr_reader(ivars)
       ivars.each do |ivarname|
@@ -625,17 +621,71 @@ module Yard2steep
           )
         )
 
-        # NOTE: Attr reader should add getter method
-        @current_class.append_m(
-          AST::MethodNode.new(
-            p_list: [],
-            r_type: ANY_TYPE,
-            m_name: ivarname,
+        # NOTE: attr_reader should add a getter method
+        @current_class.append_m(getter_method_node(ivarname))
+      end
+    end
+
+    # @param [Array<String>] ivars
+    # @return [void]
+    def parse_attr_writer(ivars)
+      ivars.each do |ivarname|
+        @current_class.append_ivar(
+          AST::IVarNode.new(
+            name: ivarname
+          )
+        )
+
+        # NOTE: attr_writer should add a setter method
+        @current_class.append_m(setter_method_node(ivarname))
+      end
+    end
+
+    # @param [Array<String>] ivars
+    # @return [void]
+    def parse_attr_accessor(ivars)
+      ivars.each do |ivarname|
+        @current_class.append_ivar(
+          AST::IVarNode.new(
+            name: ivarname
           )
         )
+
+        # NOTE: attr_accessor should add getter and setter methods
+        @current_class.append_m(getter_method_node(ivarname))
+        @current_class.append_m(setter_method_node(ivarname))
       end
     end
 
+    # @param [String] ivarname
+    # @return [AST::MethodNode]
+    def getter_method_node(ivarname)
+      AST::MethodNode.new(
+        p_list: [],
+        r_type: ANY_TYPE,
+        m_name: ivarname,
+      )
+    end
+
+    # @param [String] ivarname
+    # @return [AST::MethodNode]
+    def setter_method_node(ivarname)
+      AST::MethodNode.new(
+        p_list: [
+          AST::PNode.new(
+            type_node: AST::PTypeNode.new(
+              p_type: ANY_TYPE,
+              p_name: '',
+              kind:   AST::PTypeNode::KIND[:normal],
+            ),
+            style: AST::PNode::STYLE[:normal],
+          )
+        ],
+        r_type: ANY_TYPE,
+        m_name: "#{ivarname}=",
+      )
+    end
+
     ##
     # Helper
 

data/lib/yard2steep/version.rb

@@ -1,3 +1,3 @@
 module Yard2steep
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/sig/steep-scaffold/td.rbi

@@ -49,6 +49,10 @@ class Yard2steep::Parser
   def parse_command_args_add_block: (any) -> any
   def parse_method_add_arg: (any) -> void
   def parse_attr_reader: (any) -> any
+  def parse_attr_writer: (any) -> any
+  def parse_attr_accessor: (any) -> any
+  def getter_method_node: (any) -> any
+  def setter_method_node: (any) -> any
   def debug_print!: (any) -> void
   def type_node: (any) -> any
   def block_type_node: (any) -> any
@@ -163,6 +167,7 @@ class Yard2steep::AST::ClassNode
   @c_list: any
   @m_list: any
   @ivar_list: any
+  @ivarname_s: any
   @children: any
   @parent: any
   @long_name: any
@@ -170,7 +175,7 @@ class Yard2steep::AST::ClassNode
   def initialize: (kind: any, c_name: any, super_c: any, parent: any) -> any
   def append_constant: (any) -> any
   def append_m: (any) -> any
-  def append_ivar: (any) -> any
+  def append_ivar: (any) -> void
   def append_child: (any) -> any
   def long_name: () -> any
   def long_super: () -> any

data/sig/yard2steep/yard2steep/parser.rbi

@@ -19,7 +19,11 @@ class Yard2steep::Parser
   def parse_command: (Array<any>) -> void
   def parse_command_args_add_block: (Array<any>) -> Array<String>
   def parse_method_add_arg: (Array<any>) -> void
-  def parse_attr_reader: (any) -> void
+  def parse_attr_reader: (Array<String>) -> void
+  def parse_attr_writer: (Array<String>) -> void
+  def parse_attr_accessor: (Array<String>) -> void
+  def getter_method_node: (String) -> AST::MethodNode
+  def setter_method_node: (String) -> AST::MethodNode
   def debug_print!: (String) -> void
   def type_node: (String) -> AST::PTypeNode
   def block_type_node: (String) -> AST::PTypeNode

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard2steep
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Nao Minami
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler