decode 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ca1745dcb76b54a61777388aba926d1262967dc51ca7ad633debc369f67d9f
-  data.tar.gz: 4164ca61971b6573b8604767cfdf35766605893f8d63cba44a516d705c0d5093
+  metadata.gz: 813979836080a611db0650430359874b554250326fc391d453405b01a6137fc5
+  data.tar.gz: a0335e5e13a888f0b19a06f3010063bf840be1cf399134e37d112dcdba98dd9b
 SHA512:
-  metadata.gz: 7b247bcd2d6b0eaacf1bbaa444cd98df314251bca958914793ad455521c9f379233f737e6afeeb31197b76f0ce9876de1887304203eb5487fda113fa4b8eea11
-  data.tar.gz: 72b714cf3ad9b0f7969e23be899ca10186994661d6dbc0bb91bd27a200a6ce4ee18815bca5a7cc355316ea5f53b6ed2d818073b28f61a41caca0dbbf52196623
+  metadata.gz: f155904d306e546b857cca49e8ef25590de20253febff28f82a390ee6dd09e5bd412a5966578f4cf419848bc7282a34c64d1b8c98ce9ce28f6a92a821c46b298
+  data.tar.gz: 3e65b213a410b83b48dc30e1a89f49f5a013b0eeb414bd41d91510d9069921b95f7bfb74195b011ab42c1c7dc6c8ddb53935f40bdf97d068e2c3d8a79b07f5b1

data/README.md

@@ -2,9 +2,15 @@
 
 A Ruby code analysis tool and documentation generator.
 
+[![Development](https://github.com/ioquatix/decode/workflows/Development/badge.svg)](https://github.com/ioquatix/decode/actions?workflow=Development)
+
+## Motivation
+
+As part of my effort to build [better project documentation](https://github.com/socketry/utopia-project), I needed a better code analysis tool. While less featured than some of the more mature alternatives, this library focuses on the needs of documentation generation, including speed, cross-referencing and (eventually) multi-language support.
+
 ## Usage
 
-Please see the <a href="https://ioquatix.github.io/decode">project documentation</a> or run it locally using `bake utopia:project:serve`.
+Please see the <a href="https://ioquatix.github.io/decode/">project documentation</a> or run it locally using `bake utopia:project:serve`.
 
 ## Contributing
 

data/decode.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_development_dependency 'build-files'
 	spec.add_development_dependency 'bake-bundler'
-	spec.add_development_dependency 'utopia-wiki'
+	spec.add_development_dependency 'utopia-project'
 	spec.add_development_dependency 'covered'
 	spec.add_development_dependency 'bundler'
 	spec.add_development_dependency 'rspec'

data/gems.rb

@@ -1,5 +1,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem 'utopia-project', path: '../../socketry/utopia-project'

data/lib/decode/definition.rb

@@ -57,6 +57,13 @@ module Decode
 			self.long_form
 		end
 		
+		# Whether the definition spans multiple lines.
+		#
+		# @return [Boolean]
+		def multiline?
+			false
+		end
+		
 		# The full text of the definition.
 		#
 		# @return [String | nil]

data/lib/decode/documentation.rb

@@ -21,7 +21,7 @@
 module Decode
 	# Structured access to a set of comment lines.
 	class Documentation
-		# Initialize the documenation with an array of comments, within a specific language.
+		# Initialize the documentation with an array of comments, within a specific language.
 		#
 		# @param comments [Array(String)] An array of comment lines.
 		# @param language [Language] The language in which the comments were extracted.

data/lib/decode/language/ruby/definition.rb

@@ -35,10 +35,25 @@ module Decode
 				# The parser syntax tree node.
 				attr :node
 				
+				def multiline?
+					@node.location.line != @node.location.last_line
+				end
+				
 				# The source code associated with the definition.
 				# @return [String]
 				def text
-					@node.location.expression.source
+					expression = @node.location.expression
+					lines = expression.source.lines
+					if lines.count == 1
+						return lines.first
+					else
+						indentation = expression.source_line[/\A\s+/]
+						
+						# Remove all the indentation:
+						lines.each{|line| line.sub!(indentation, '')}
+						
+						return lines.join
+					end
 				end
 			end
 		end

data/lib/decode/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Decode
-	VERSION = "0.8.0"
+	VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: utopia-wiki
+  name: utopia-project
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -120,8 +120,8 @@ files:
 - ".rspec"
 - README.md
 - decode.gemspec
-- examples/decode-index/extract.rb
 - gems.rb
+- guides/extract-symbols/extract.rb
 - lib/decode.rb
 - lib/decode/definition.rb
 - lib/decode/documentation.rb