tealrb 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901c0ceb42462821200254c78055b4953f680c46507ede5f09d751e13194e8ae
-  data.tar.gz: 2e24af5fa78eb16bc19fe298c047ed712d3536183e533b614a4474a9af89712d
+  metadata.gz: c937c416e2b2f337bdef2100c573862ed55a40e864d5a19f2cef3c737e823608
+  data.tar.gz: 0c09c2850d71f1392e0afc44943a62a0fed55153b6ef60b19700527639e43d84
 SHA512:
-  metadata.gz: b8886b2142000d91603f835032058982a50bc0fddaa81cd00e00957fb1b1c5c74ba87484deb7598a660183fa810193491cb0e7c14811b830c454befd6fd4c87b
-  data.tar.gz: b2e282ef718646af4413f6dad9a72ca70ba23d54d97108e5c34047ca5804eafecbcbe6ec822f9520b75ae18dc7fcbc57b60b33e0d4db93f5843bf580a37657f0
+  metadata.gz: 762827b72f11790427f51fd8021da4ef5ce2af3598b792b3b59b5ccf247fb1240cc9a0658482c09979167094a4337b9c93f27d025ae15ad603a32621c603123f
+  data.tar.gz: 135d42f56fdcd7520ca0677f4afb93e988b7151716fc534ba33682a0b51e1eee6ff5f0100b3ca14c2299948ab20fd9b338837e77289f2a62e6b1df8cd0c64f8d

data/lib/tealrb/abi.rb

@@ -4,8 +4,10 @@ require 'json'
 
 module TEALrb
   module ABI
-    def abi_return(data)
-      log(concat('151f7c75', data.teal).teal)
+    def abi_return(_data)
+      byte('151f7c75')
+      concat
+      log
     end
 
     class ABIDescription

data/lib/tealrb/contract.rb

@@ -11,8 +11,8 @@ module TEALrb
     attr_reader :teal
 
     class << self
-      attr_accessor :subroutines, :version, :teal_methods, :abi_method_hash, :abi_description, :debug,
-                    :disable_abi_routing
+      attr_accessor :subroutines, :version, :teal_methods, :abi_interface, :debug,
+                    :disable_abi_routing, :method_hashes
 
       private
 
@@ -20,53 +20,47 @@ module TEALrb
         klass.version = 6
         klass.subroutines = {}
         klass.teal_methods = {}
-        klass.abi_description = ABI::ABIDescription.new
-        klass.abi_method_hash = {}
+        klass.abi_interface = ABI::ABIDescription.new
+        klass.abi_interface.name = klass.to_s
+        klass.method_hashes = []
         klass.debug = false
         klass.disable_abi_routing = false
+        parse(klass)
         super
       end
-    end
 
-    # abi description for the method
-    def self.abi(desc:, args:, returns:)
-      args = args.map do |name, h|
-        h[:name] = name.to_s
-        h[:type] = h[:type].to_s.split('::').last.downcase
-        h
-      end
+      def parse(klass)
+        YARD::Tags::Library.define_tag('ABI Method', :abi)
+        YARD::Tags::Library.define_tag('Subroutine', :subroutine)
+        YARD::Tags::Library.define_tag('TEAL Method', :teal)
 
-      self.abi_method_hash = { desc: desc, args: args, returns: returns.to_s.split('::').last.downcase }
-    end
+        YARD.parse Object.const_source_location(klass.to_s).first
 
-    # specifies a TEAL subroutine that will be defined upon intialization
-    # @return [nil]
-    # @overload subroutine(name)
-    #  @param name [Symbol] name of the subroutine and the method to use as the subroutine definition
-    #
-    # @overload subroutine(name)
-    #  @param name [Symbol] name of the subroutine
-    #
-    #  @yield [*args] the definition of the subroutine
-    def self.subroutine(name, &blk)
-      @subroutines[name] = (blk || instance_method(name))
-      abi_description.add_method(**({ name: name.to_s }.merge abi_method_hash)) unless abi_method_hash.empty?
-      @abi_method_hash = {}
-      nil
-    end
+        YARD::Registry.all.each do |y|
+          next unless y.type == :method
+          next unless y.parent.to_s == klass.to_s
 
-    # specifies a method to be defined upon intialization that will be transpiled to TEAL when called
-    # @return [nil]
-    # @overload subroutine(name)
-    #  @param name [Symbol] name of the method to use as the TEAL definition
-    #
-    # @overload subroutine(name)
-    #  @param name [Symbol] name of the method
-    #
-    #  @yield [*args] the definition of the TEAL method
-    def self.teal(name, &blk)
-      @teal_methods[name] = (blk || instance_method(name))
-      nil
+          tags = y.tags.map(&:tag_name)
+
+          if tags.include?('abi') || tags.include?('subroutine')
+            method_hash = { name: y.name.to_s, desc: y.base_docstring, args: [], returns: { type: 'void' } }
+
+            y.tags.each do |t|
+              method_hash[:returns] = { type: t.types&.first } if t.tag_name == 'return'
+
+              next unless t.tag_name == 'param'
+
+              method_hash[:args] << { name: t.name, type: t.types&.first, desc: t.text }
+            end
+
+            klass.method_hashes << method_hash
+
+            klass.abi_interface.add_method(**method_hash) if tags.include? 'abi'
+          elsif tags.include? 'teal'
+            klass.teal_methods[y.name.to_s] = y
+          end
+        end
+      end
     end
 
     # sets the `#pragma version`, defines teal methods, and defines subroutines
@@ -75,18 +69,14 @@ module TEALrb
       IfBlock.id = 0
       @scratch = Scratch.new
 
-      self.class.subroutines.each_key do |name|
-        define_singleton_method(name) do |*_args|
-          callsub(name)
-        end
-      end
+      @@active_contract = self # rubocop:disable Style/ClassVars
 
-      self.class.subroutines.each do |name, blk|
-        define_subroutine name, blk
+      self.class.method_hashes.each do |mh|
+        define_subroutine(mh[:name], method(mh[:name]))
       end
 
-      self.class.teal_methods.each do |name, blk|
-        define_teal_method name, blk
+      self.class.teal_methods.each do |name, definition|
+        define_teal_method(name, definition)
       end
     end
 
@@ -155,7 +145,9 @@ module TEALrb
       comment_content = "#{name}(#{comment_params})"
       comment(comment_content, inline: true)
 
-      new_source = generate_method_source(name, definition)
+      method_hash = self.class.method_hashes.find { _1[:name] == name.to_s }
+      new_source = generate_subroutine_source(definition, method_hash)
+
       new_source = "#{new_source}retsub"
 
       eval_tealrb(new_source, debug_context: "subroutine: #{name}")
@@ -185,7 +177,7 @@ module TEALrb
 
     # the hash of the abi description
     def abi_hash
-      self.class.abi_description.to_h
+      self.class.abi_interface.to_h
     end
 
     # transpiles the given string to TEAL
@@ -207,7 +199,7 @@ module TEALrb
     private
 
     def route_abi_methods
-      self.class.abi_description.methods.each do |meth|
+      self.class.abi_interface.methods.each do |meth|
         signature = "#{meth[:name]}(#{meth[:args].map { _1[:type] }.join(',')})#{meth[:returns][:type]}"
         selector = OpenSSL::Digest.new('SHA512-256').hexdigest(signature)[..7]
 
@@ -225,7 +217,7 @@ module TEALrb
 
       scratch_names = []
       definition.parameters.reverse.each_with_index do |param, _i|
-        param_name = param.last
+        param_name = param.first
         scratch_name = [name, param_name].map(&:to_s).join(': ')
         scratch_names << scratch_name
 
@@ -233,12 +225,81 @@ module TEALrb
         pre_string.puts "#{param_name} = -> { @scratch['#{scratch_name}'] }"
       end
 
-      post_string = StringIO.new
-      scratch_names.each do |n|
-        post_string.puts "@scratch.delete '#{n}'"
+      "#{pre_string.string}#{new_source}"
+    end
+
+    def generate_subroutine_source(definition, method_hash)
+      new_source = rewrite(definition.source, method_rewriter: true)
+
+      pre_string = StringIO.new
+
+      scratch_names = []
+
+      txn_types = %w[txn pay keyreg acfg axfer afrz appl]
+
+      args = method_hash[:args] || []
+      arg_types = args.map { _1[:type] } || []
+      txn_params = arg_types.select { txn_types.include? _1 }.count
+      app_param_index = -1
+      asset_param_index = -1
+      account_param_index = 0
+      args_index = 0
+
+      if abi_hash['methods'].find { _1[:name] == method_hash[:name].to_s }
+        definition.parameters.each_with_index do |param, i|
+          param_name = param.last
+
+          scratch_name = "#{definition.original_name}: #{param_name} [#{arg_types[i] || 'any'}] #{if args[i]
+                                                                                                    args[i][:desc]
+                                                                                                  end}"
+          scratch_names << scratch_name
+
+          if txn_types.include? arg_types[i]
+            pre_string.puts "@scratch['#{scratch_name}'] = Gtxns[Txn.group_index - int(#{txn_params})]"
+            txn_params -= 1
+          elsif arg_types[i] == 'application'
+            pre_string.puts "@scratch['#{scratch_name}'] = Apps[#{app_param_index += 1}]"
+          elsif arg_types[i] == 'asset'
+            pre_string.puts "@scratch['#{scratch_name}'] = Assets[#{asset_param_index += 1}]"
+          elsif arg_types[i] == 'account'
+            pre_string.puts "@scratch['#{scratch_name}'] = Accounts[#{account_param_index += 1}]"
+          else
+            pre_string.puts "@scratch['#{scratch_name}'] = AppArgs[#{args_index += 1}]"
+          end
+
+          pre_string.puts "#{param_name} = -> { @scratch['#{scratch_name}'] }"
+        end
+
+      else
+        args.reverse!
+        arg_types.reverse!
+
+        definition.parameters.reverse.each_with_index do |param, i|
+          param_name = param.last
+
+          scratch_name = "#{definition.original_name}: #{param_name} [#{arg_types[i] || 'any'}] #{if args[i]
+                                                                                                    args[i][:desc]
+                                                                                                  end}"
+          scratch_names << scratch_name
+
+          if txn_types.include? arg_types[i]
+            pre_string.puts "@scratch['#{scratch_name}'] = Gtxns"
+          elsif arg_types[i] == 'application'
+            pre_string.puts "@scratch['#{scratch_name}'] = Applications.new"
+          elsif arg_types[i] == 'asset'
+            pre_string.puts "@scratch['#{scratch_name}'] = Assets.new"
+          elsif arg_types[i] == 'account'
+            pre_string.puts "@scratch['#{scratch_name}'] = Accounts.new"
+          else
+            pre_string.puts "@scratch.store('#{scratch_name}')"
+          end
+
+          pre_string.puts "#{param_name} = -> { @scratch['#{scratch_name}'] }"
+        end
+
       end
 
-      "#{pre_string.string}#{new_source}#{post_string.string}"
+      "#{pre_string.string}#{new_source}"
     end
 
     def rewrite_with_rewriter(string, rewriter)
@@ -254,7 +315,7 @@ module TEALrb
       end
 
       [CommentRewriter, ComparisonRewriter, WhileRewriter, InlineIfRewriter, IfRewriter, OpRewriter,
-       AssignRewriter].each do |rw|
+       AssignRewriter, InternalMethodRewriter].each do |rw|
         string = rewrite_with_rewriter(string, rw)
       end
 
@@ -289,7 +350,9 @@ module TEALrb
       @eval_tealrb_rescue_count ||= 0
 
       eval_locations = e.backtrace.select { _1[/\(eval\)/] }
-      error_line = eval_locations[@eval_tealrb_rescue_count].split(':')[1].to_i
+      if eval_locations[@eval_tealrb_rescue_count]
+        error_line = eval_locations[@eval_tealrb_rescue_count].split(':')[1].to_i
+      end
 
       warn "'#{e}' when evaluating transpiled TEALrb source" if @eval_tealrb_rescue_count.zero?
 

data/lib/tealrb/opcode_modules.rb

@@ -474,6 +474,22 @@ module TEALrb
       end
     end
 
+    module ItxnField
+      extend TxnFields
+
+      def self.opcode(field, _value)
+        ExtendedOpcodes.itxn_field field
+      end
+
+      class << self
+        TxnFields.instance_methods.each do |m|
+          define_method("#{m}=") do |value|
+            send(m, value)
+          end
+        end
+      end
+    end
+
     module Gtxn
       extend TxnFields
 
@@ -528,7 +544,12 @@ module TEALrb
       end
 
       def [](index)
-        ExtendedOpcodes.txna @field, index
+        if index.is_a? Integer
+          ExtendedOpcodes.txna @field, index
+        else
+          ExtendedOpcodes.txnas @field
+        end
+
         self
       end
     end

data/lib/tealrb/rewriters.rb

@@ -27,6 +27,29 @@ module TEALrb
       end
     end
 
+    class InternalMethodRewriter < Rewriter
+      def on_send(node)
+        teal_methods = TEALrb::Contract.class_variable_get(:@@active_contract).class.teal_methods
+
+        method_name = node.loc.selector.source.to_sym
+
+        if teal_methods.keys.include? method_name
+          param_names = teal_methods[method_name].parameters.map(&:last)
+
+          pre_string = StringIO.new
+          param_names.each_with_index do |param, i|
+            scratch_name = [method_name, param].map(&:to_s).join(': ')
+
+            pre_string.puts "@scratch.store('#{scratch_name}', #{node.children[i + 2].loc.expression.source})"
+          end
+
+          replace node.source_range, "#{pre_string.string}\n#{method_name}"
+        end
+
+        super
+      end
+    end
+
     class MethodRewriter < Rewriter
       def on_def(node)
         replace node.source_range, node.body.source
@@ -125,6 +148,12 @@ module TEALrb
         super
       end
 
+      def on_return(node)
+        replace node.loc.keyword, 'abi_return'
+
+        super
+      end
+
       OPCODE_METHODS = TEALrb::Opcodes::AllOpcodes.instance_methods.freeze
 
       def on_send(node)
@@ -149,8 +178,10 @@ module TEALrb
           @skips << node.children[2]
         elsif node.children.first&.children&.last == :@scratch && meth_name[/=$/]
           nil
-        elsif %i[@scratch Gtxn Accounts ApplicationArgs Assets Apps Logs].include? node.children.first&.children&.last
+        elsif %i[@scratch Gtxn].include? node.children.first&.children&.last
           @skips << node.children.last
+        elsif %i[Accounts ApplicationArgs Assets Apps Logs].include? node.children.first&.children&.last
+          @skips << node.children.last if node.children.last.int_type?
         end
 
         super

data/lib/tealrb.rb

@@ -2,6 +2,7 @@
 
 require 'method_source'
 require 'rubocop'
+require 'yard'
 
 require_relative 'tealrb/constants'
 require_relative 'tealrb/abi'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tealrb
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Joe Polny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -137,19 +151,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.27
+        version: 3.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.27
+        version: 3.0.2
 description: 
 email: joepolny+dev@gmail.com
 executables: []