termichunk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad131750d4441fca0c07991e20172f31c4e8913
-  data.tar.gz: a8483fbdd3bb0ac4e1b4d1ee82831b012cf7ae6c
+  metadata.gz: 47c94a272fd0424effa802c0c4fae6e86c21d0ee
+  data.tar.gz: 4c6dbcd6deb94d9cce9def3308d250150be3ad92
 SHA512:
-  metadata.gz: 9b169c877a4180c690d16dc661d710cf8362b4abecbbb9db47da9ccd4c24d83c64ddae769e97435e07f1811865b11ce5055bfe6d9bbfe36dc3e1cae71115b3bb
-  data.tar.gz: 59b24ace38179967425d6e0415b3741b102f342bcea9ed4f54315e3d4e7b515c974348293f145f69bd7b8607f6da1e5b746f8d90afc5f239db8b8f2b382f2513
+  metadata.gz: 13a3f1aa0487eb528d026d0a15ea24c01c28a35c182a5184703b88205a45395a8044d3603d23de6bba5ae07d6974972d1b04cb713f2b3c153bec79957151b6ba
+  data.tar.gz: c438a0ec2be02cc3d2f395edd37d16c2b13c3aa461eb9d84c779896fa61cb19e3b3da4a65e838c883f5ed3fa83c80175301c06ac1ff5e9f602d985e606c4fd02

data/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/lib/termichunk/report.rb

@@ -8,6 +8,11 @@ module TermiChunk
 
     attr_reader :title, :padding, :rows
 
+    # Create a new report.
+    # @param title [String] the title to frame the report with
+    # @param padding [Integer] the amount of padding to put around the text within the report
+    # @yield [self] if a block is provided, the new report will be yielded to it
+    # @return [Report]
     def initialize(title:, padding: nil)
       @title = title
       @padding = padding || 0
@@ -15,6 +20,8 @@ module TermiChunk
       yield self if block_given?
     end
 
+    # Add a new entry to the report
+    # @param item [String, Report] the entry to add (a single-line string, a multi-line string, a sub-report)
     def <<(item)
       lines = item.to_s.lines
       if item.is_a?(self.class) && padding.nonzero?
@@ -24,6 +31,8 @@ module TermiChunk
       lines.each { |l| rows << l }
     end
 
+    # Retrieve a string-representation of the report.
+    # @return [String]
     def to_s
       y = padding.times.map { Y }
       [titlebar(TL), *y, body, *y, titlebar(BL)].compact.join("\n")

data/lib/termichunk/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module TermiChunk
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/termichunk.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: termichunk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin McDonald
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Organize chunks of text within terminals
 email:
 - kevinstuffandthings@gmail.com
@@ -107,6 +121,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt