adding documentation

Author: icebaker

Gemfile

@@ -6,6 +6,8 @@ gemspec
 
 group :test, :development do
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
+  gem 'rake', '~> 13.0', '>= 13.0.6'
   gem 'rubocop', '~> 1.45', '>= 1.45.1'
   gem 'rubocop-rake', '~> 0.6.0'
+  gem 'ruby-progressbar', '~> 1.8', '>= 1.8.1'
 end

Gemfile.lock

@@ -28,6 +28,7 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
+    rake (13.0.6)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rubocop (1.45.1)
@@ -53,8 +54,10 @@ PLATFORMS
 DEPENDENCIES
   lnd-client!
   pry-byebug (~> 3.10, >= 3.10.1)
+  rake (~> 13.0, >= 13.0.6)
   rubocop (~> 1.45, >= 1.45.1)
   rubocop-rake (~> 0.6.0)
+  ruby-progressbar (~> 1.8, >= 1.8.1)
 
 BUNDLED WITH
    2.4.4

README.md

@@ -5,10 +5,10 @@
 This is a low-level client library. For a better experience, you may want to check out the [Lighstorm](https://github.com/icebaker/lighstorm) abstraction.
 
 - [Usage](#usage)
-  - [Channel Arguments](#channel-arguments)
   - [Documentation](#documentation)
 - [Development](#development)
   - [Upgrading gRPC Proto Files](#upgrading-grpc-proto-files)
+  - [Generating Documentation](#generating-documentation)
   - [Publish to RubyGems](#publish-to-rubygems)
 
 ## Usage
@@ -53,71 +53,9 @@ client.router.subscribe_htlc_events do |data|
 end
 ```
 
-### Channel Arguments
-
-```ruby
-require 'lnd-client'
-
-puts LNDClient.version # => 0.0.5
-
-client = LNDClient.new(
-  certificate_path: '/lnd/tls.cert',
-  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
-  socket_address: '127.0.0.1:10009'
-)
-
-client.lightning(
-  channel_args: { 'grpc.max_receive_message_length' => 1024 * 1024 * 50 }
-)
-
-graph = client.lightning.describe_graph
-
-graph.nodes # => [...]
-graph.edges # => [...]
-```
-
 ### Documentation
 
-```ruby
-require 'lnd-client'
-
-puts LNDClient.version # => 0.0.5
-
-client = LNDClient.new(
-  certificate_path: '/lnd/tls.cert',
-  macaroon_path: '/lnd/data/chain/bitcoin/mainnet/admin.macaroon',
-  socket_address: '127.0.0.1:10009'
-)
-
-client.doc.services # => ['lightning', 'router']
-
-client.lightning.doc.available_methods # =>
-# ['abandon_channel',
-#  'add_invoice',
-#  'bake_macaroon',
-#  'batch_open_channel',
-#  'channel_acceptor',
-#  'channel_balance',
-#  'check_macaroon_permissions',
-#  'close_channel',
-#  'closed_channels',
-#  # ...
-#  'get_node_info'
-# ]
-
-client.lightning.doc.describe(:get_node_info) # =>
-# { method: 'get_node_info',
-#    input: { pub_key: '', include_channels: false},
-#   output: { node: nil, num_channels: 0, total_capacity: 0, channels: []}}
-
-client.lightning.doc.grpc(:get_node_info)
-# #<struct GRPC::RpcDesc
-#  name=:GetNodeInfo,
-#  input=Lnrpc::NodeInfoRequest,
-#  output=Lnrpc::NodeInfo,
-#  marshal_method=:encode,
-#  unmarshal_method=:decode>
-```
+Check the [full documentation](#documentation).
 
 ## Development
 
@@ -141,6 +79,17 @@ rubocop -A
 ```sh
 bundle exec rake grpc:upgrade
 ```
+
+### Generating Documentation
+
+```sh
+bundle exec rake grpc:docs
+
+npm i docsify-cli -g
+
+docsify serve ./docs
+```
+
 ### Publish to RubyGems
 
 ```sh

Rakefile

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+require_relative './controllers/documentation'
 require_relative './controllers/grpc_generator'
 
 namespace :grpc do
+  desc 'Generate gRPC Documentation'
+  task :docs do
+    require 'ruby-progressbar'
+    LNDClientInternal::DocumentationController.generate!
+  end
+
   desc 'Upgrade lnd Protocol Buffers for gGRPC'
   task :upgrade do
     LNDClientInternal::GrpcGeneratorController.upgrade!

controllers/documentation.rb

@@ -1,21 +1,100 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require_relative '../logic/string'
+require_relative '../components/grpc'
 
 module LNDClientInternal
   class DocumentationController
+    PROGRESS = true
+    PATH = 'docs/README.md'
+    KEY = '<!-- [INJECT:GRP:DOCS] -->'
+
     attr_reader :available_methods
 
-    def initialize(service)
-      @service = service
+    def self.format(code)
+      id = SecureRandom.hex(32)
+      path = "temp/#{id}.rb"
+      File.write("temp/#{id}.rb", code.gsub(', ', ",\n"))
+      `rubocop -A -c docs/.rubocop.yml #{path}`
+      output = File.read("temp/#{id}.rb")
+      File.delete("temp/#{id}.rb")
+      output.strip
+    end
+
+    def self.generate!
+      services = LNDClientInternal::GRPC::SERVICES.keys.map(&:to_sym)
+
+      if PROGRESS
+        total = services.sum do |service|
+          new(
+            LNDClientInternal::GRPC::SERVICES[service].const_get(:Service)
+          ).available_methods.size * 2
+        end
+        progressbar = ProgressBar.create(total: total, format: '%a %e |%b>>%i| %P% | %c of %C')
+      end
+
+      content = ''
+
+      services.each do |service|
+        content += "## #{service}\n"
+        doc = new(LNDClientInternal::GRPC::SERVICES[service].const_get(:Service))
+
+        doc.available_methods.each do |method_name|
+          content += "\n### #{method_name}\n"
+
+          url = "https://lightning.engineering/api-docs/api/lnd/#{service}/#{method_name.gsub('_', '-')}/index.html"
+
+          content += "\n[lightning.engineering/#{service}/#{method_name.gsub('_', '-')}](#{url})\n"
+
+          description = doc.describe(method_name)
+          content += "\n```ruby\n"
+
+          code = "client.#{service}.#{method_name}"
+
+          code += "(\n#{description[:input].inspect}\n)" if !description[:input].nil? && !description[:input].empty?
+
+          code += " do |data|\n  puts data.inspect # => { ... }\nend" if method_name =~ /^subscribe/
+
+          content += if !description[:input].nil? && !description[:input].empty?
+                       "#{self.format(code)}\n```\n"
+                     else
+                       "#{code}\n```\n"
+                     end
+
+          progressbar.increment if PROGRESS
+
+          if !description[:output].nil? && !description[:output].empty?
+            code = self.format(description[:output].inspect)
+            content += "\nOutput:\n```ruby\n#{code}\n```\n"
+          end
+
+          progressbar.increment if PROGRESS
+        end
+      end
+
+      document = File.read(PATH)
+
+      parts = document.split(KEY)
+
+      File.write(PATH, "#{parts[0]}#{KEY}\n\n#{content}\n#{KEY}#{parts[2]}")
+
+      progressbar.finish
+
+      puts "\nDocumentation updated: #{PATH}\n"
+    end
+
+    def initialize(grpc_service)
+      @grpc_service = grpc_service
       @descriptions = {}
       @grpc = {}
 
       build!
     end
 
     def build!
-      @available_methods = @service.service.rpc_descs.values.map do |desc|
+      @available_methods = @grpc_service.rpc_descs.values.map do |desc|
         method_name = LNDClientInternal::StringLogic.underscore(desc.name.to_s)
 
         build_description!(method_name, desc)

controllers/service.rb

@@ -15,7 +15,7 @@ def initialize(client, rpc, params = {})
         client.config.credentials,
         **params
       )
-      @doc = LNDClientInternal::DocumentationController.new(self)
+      @doc = LNDClientInternal::DocumentationController.new(@service)
     end
 
     def call!(method_key, desc, *args, &block)

docs/.nojekyll

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 60