parlour 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88487f0d150090c2b0877343e66efc37d0643892fd3b99966f0d4cca992d29e1
-  data.tar.gz: eb2f33d58f3606186d9691845d50071d456107d9a913947f70b89cfa2c9a6492
+  metadata.gz: 2d1c171ba47259b6a4ed2a996851cefddaf27fc263dee7cf36e5402dd0825ed7
+  data.tar.gz: e65db27b829a76f965aa09b01c7725496efef8aa4e7000618c7df6e058a91c81
 SHA512:
-  metadata.gz: 8ae0f4def7984b641df8b45000eddbafcf10048ccc772f4802d413e79b8e1431afc58963f2c1e40533b99729dad4801c3f328fc3a6f35cb654ad9c7b092a493c
-  data.tar.gz: ad6f1e9bd34f9b56aaa4ae1eb8ac30cded890f2b5f64672d9bdc5f3ca82d18ec4ee2b55cea1c7abd65ba32cd03d874715d470f4cd72c2a733d2ba209a7b06755
+  metadata.gz: a59f7d8291d718af02b7bf8885deae8891149ad73f39ba5ff6b92cd19df9738c5e49b7202ab49509a7ac1a719381b88bf67a80df12756a8cf80af939b7e18166
+  data.tar.gz: 357c2364280f8656372294799e879384019ef706c0b7bccf67b0491c7ea24d018a7af557a0791627810c7956770979708ee6f7b91f67771e4e1a242738695a73

data/CHANGELOG.md

@@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.2.1] - 2019-07-08
+### Added
+- Added the `add_comment_to_next_child` method to namespaces.
+
+## [0.2.0] - 2019-07-07
+### Added
+- Add support for plugins using the `parlour` command-line tool.
+- Comments can now be added using `add_comment`.
+- Attribute readers, writers and accessors can now be created, using the `create_attr_...` methods.
+- All objects are now YARD documented.
+
+### Changed
+- The `RbiObject`, which is core to Parlour's internals, is now an abstract class rather than an interface.
+- `ConflictResolver` now recurses to child namespaces.
+- `create_method` now takes an initializer block like other `create_` methods.
+
 ## [0.1.1] - 2019-07-05
 ### Added
 - Initial release!

data/lib/parlour/rbi_generator/namespace.rb

@@ -43,6 +43,7 @@ module Parlour
         @extends = []
         @includes = []
         @constants = []
+        @next_comments = []
         yield_self(&block)
       end
 
@@ -69,6 +70,27 @@ module Parlour
       # @return [Array<(String, String)>]
       attr_reader :constants
 
+      sig { params(comment: T.any(String, T::Array[String])).void }
+      # Adds one or more comments to the next child RBI object to be created.
+      #
+      # @example Creating a module with a comment.
+      #   namespace.add_comment_to_next_child('This is a module')
+      #   namespace.create_module('M')
+      #
+      # @example Creating a class with a multi-line comment.
+      #   namespace.add_comment_to_next_child(['This is a multi-line comment!', 'It can be as long as you want!'])
+      #   namespace.create_class('C')
+      #
+      # @param comment [String, Array<String>] The new comment(s).
+      # @return [void]
+      def add_comment_to_next_child(comment)
+        if comment.is_a?(String)
+          @next_comments << comment
+        elsif comment.is_a?(Array)
+          @next_comments.concat(comment)
+        end
+      end
+
       sig do
         params(
           name: String,
@@ -95,6 +117,7 @@ module Parlour
       # @return [ClassNamespace]
       def create_class(name, superclass: nil, abstract: false, &block)
         new_class = ClassNamespace.new(generator, name, superclass, abstract, &block)
+        move_next_comments(new_class)
         children << new_class
         new_class
       end
@@ -123,6 +146,7 @@ module Parlour
       # @return [ModuleNamespace]
       def create_module(name, interface: false, &block)
         new_module = ModuleNamespace.new(generator, name, interface, &block)
+        move_next_comments(new_module)
         children << new_module
         new_module
       end
@@ -171,6 +195,7 @@ module Parlour
           class_method: class_method,
           &block
         )
+        move_next_comments(new_method)
         children << new_method
         new_method
       end
@@ -207,6 +232,7 @@ module Parlour
           type,
           &block
         )
+        move_next_comments(new_attribute)
         children << new_attribute
         new_attribute
       end
@@ -371,6 +397,16 @@ module Parlour
 
         result
       end
+
+      sig { params(object: RbiObject).void }
+      # Copies the comments added with {#add_comment_to_next_child} into the
+      # given object, and clears the list of pending comments.
+      # @param object [RbiObject] The object to move the comments into.
+      # @return [void]
+      def move_next_comments(object)
+        object.comments.prepend(*@next_comments)
+        @next_comments.clear
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/rbi_object.rb

@@ -48,7 +48,8 @@ module Parlour
       attr_reader :comments
 
       sig { params(comment: T.any(String, T::Array[String])).void }
-      # Adds one or more comments to this RBI object.
+      # Adds one or more comments to this RBI object. Comments always go above 
+      # the definition for this object, not in the definition's body.
       #
       # @example Creating a module with a comment.
       #   namespace.create_module('M') do |m|

data/lib/parlour/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 module Parlour
   # The library version.
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Aaron Christiansen