smithy 2.0.0.pre0 → 2.0.0.pre1

data/lib/smithy/views/client/shape_to_hash.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      module ShapeToHash
+        class << self
+          def transform_value(model, value, shape)
+            return value if value.nil?
+
+            case shape['type']
+            when 'structure', 'union' then structure(model, shape, value)
+            when 'list' then list(model, shape, value)
+            when 'map' then map(model, shape, value)
+            when 'float', 'double' then float(value, shape)
+            when 'timestamp' then timestamp(value)
+            else
+              value
+            end
+          end
+
+          private
+
+          def map(model, shape, value)
+            member_shape = Model.shape(model, shape['value']['target'])
+            value.transform_values do |v|
+              transform_value(model, v, member_shape)
+            end
+          end
+
+          def list(model, shape, value)
+            member_shape = Model.shape(model, shape['member']['target'])
+            value.map { |v| transform_value(model, v, member_shape) }
+          end
+
+          def structure(model, shape, value)
+            value.each_with_object({}) do |(k, v), o|
+              member_shape = Model.shape(model, shape['members'][k]['target'])
+              o[k.underscore.to_sym] = transform_value(model, v, member_shape)
+            end
+          end
+
+          def timestamp(value)
+            return value if nil?
+
+            CodegenValue.new(value, :timestamp)
+          end
+
+          def float(value, _shape)
+            case value
+            when 'Infinity' then CodegenValue.new(Float::INFINITY, :float)
+            when '-Infinity' then CodegenValue.new(-Float::INFINITY, :float)
+            when 'NaN' then CodegenValue.new(Float::NAN, :float)
+            else
+              value
+            end
+          end
+        end
+
+        # @api private
+        class CodegenValue
+          def initialize(value, shape)
+            @value = value
+            @shape = shape
+          end
+
+          def inspect
+            case @shape
+            when :float then float
+            when :timestamp then timestamp
+            else @value.inspect
+            end
+          end
+
+          private
+
+          def timestamp
+            if @value.is_a?(String)
+              "Time.parse(#{@value})"
+            else
+              "Time.at(#{@value})"
+            end
+          end
+
+          def float
+            if @value.nan?
+              'Float::NAN'
+            elsif @value.infinite?
+              "#{'-' if @value.negative?}Float::INFINITY"
+            else
+              @value.inspect
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smithy/views/client/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class SpecHelper < View
+        def initialize(plan)
+          @plan = plan
+          super()
+        end
+
+        def gem_name
+          @plan.gem_name
+        end
+      end
+    end
+  end
+end

data/lib/smithy/views/client/types.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class Types < View
+        def initialize(plan)
+          @plan = plan
+          @model = plan.model
+          super()
+        end
+
+        def module_name
+          @plan.module_name
+        end
+
+        def types
+          Model::ServiceIndex
+            .new(@model)
+            .shapes_for(@plan.service)
+            .select { |_key, shape| %w[enum intEnum structure union].include?(shape['type']) }
+            .map { |id, shape| build_type(id, shape) }
+        end
+
+        private
+
+        def build_type(id, shape)
+          args = [@plan.service, @model, id, shape]
+          case shape['type']
+          when 'enum', 'intEnum' then EnumType.new(*args)
+          when 'structure' then StructureType.new(*args)
+          when 'union' then UnionType.new(*args)
+          end
+        end
+
+        # @api private
+        class Type
+          def initialize(service, model, id, shape)
+            _, @service = service.first
+            @model = model
+            @shape = shape
+            @type = shape['type']
+            @name = (@service.dig('rename', id) || Model::Shape.name(id)).camelize
+            @traits = shape.fetch('traits', {})
+            @members = build_members(shape['members'])
+          end
+
+          attr_reader :type, :name, :members
+
+          def docstrings
+            lines = []
+            lines.concat(documentation_docstrings)
+            lines.concat(deprecated_docstrings)
+            lines.concat(external_documentation_docstrings)
+            lines.concat(sensitive_docstrings)
+            lines.concat(since_docstrings)
+            lines.concat(unstable_docstrings)
+            lines
+          end
+
+          private
+
+          def documentation_docstrings
+            @traits.fetch('smithy.api#documentation', '').split("\n")
+          end
+
+          def deprecated_docstrings
+            return [] unless @traits.key?('smithy.api#deprecated')
+
+            message = @traits['smithy.api#deprecated'].fetch('message', '')
+            since = @traits['smithy.api#deprecated'].fetch('since', '')
+            Model::YARD.deprecated_docstrings(message, since)
+          end
+
+          def external_documentation_docstrings
+            return [] unless @traits.key?('smithy.api#externalDocumentation')
+
+            hash = @traits.fetch('smithy.api#externalDocumentation', {})
+            Model::YARD.external_documentation_docstrings(hash)
+          end
+
+          def sensitive_docstrings
+            return [] unless @traits.key?('smithy.api#sensitive')
+
+            [Model::YARD.sensitive_docstring]
+          end
+
+          def since_docstrings
+            return [] unless @traits.key?('smithy.api#since')
+
+            [Model::YARD.since_docstring(@traits['smithy.api#since'])]
+          end
+
+          def unstable_docstrings
+            return [] unless @traits.key?('smithy.api#unstable')
+
+            [Model::YARD.unstable_docstring]
+          end
+        end
+
+        # @api private
+        class EnumType < Type
+          private
+
+          def build_members(members)
+            members.map { |name, member| EnumMember.new(@service, @model, name, member) }
+          end
+        end
+
+        # @api private
+        class StructureType < Type
+          def input?
+            @traits.key?('smithy.api#input')
+          end
+
+          def defaults
+            @members.select { |member| member if member.default? }
+          end
+
+          def attribute_docstrings
+            lines = []
+            members.each do |member|
+              lines.concat(member.docstrings)
+            end
+            lines
+          end
+
+          private
+
+          def build_members(members)
+            members.map { |name, member| StructMember.new(@service, @model, name, member) }
+          end
+        end
+
+        # @api private
+        class UnionType < Type
+          def attribute_docstrings
+            lines = []
+            members.each do |member|
+              lines.concat(member.docstrings)
+            end
+            lines
+          end
+
+          private
+
+          def build_members(members)
+            members.map { |name, member| StructMember.new(@service, @model, name, member) }
+          end
+        end
+
+        # @api private
+        class Member
+          def initialize(service, model, name, member)
+            @service = service
+            @model = model
+            @name = name
+            @member = member
+            @traits = member.fetch('traits', {})
+            @target = Model.shape(model, member['target'])
+          end
+
+          attr_reader :name
+
+          def docstrings
+            lines = []
+            lines.concat(documentation_docstrings)
+            lines.concat(deprecated_docstrings)
+            lines.concat(external_documentation_docstrings)
+            lines.concat(since_docstrings)
+            lines.concat(unstable_docstrings)
+            lines
+          end
+
+          def documentation_docstrings
+            lines = @member.fetch('traits', {}).fetch('smithy.api#documentation', '').split("\n")
+            return lines unless lines.empty?
+
+            @target.fetch('traits', {}).fetch('smithy.api#documentation', '').split("\n")
+          end
+
+          def deprecated_docstrings
+            return [] unless @traits.key?('smithy.api#deprecated')
+
+            message = @traits['smithy.api#deprecated'].fetch('message', '')
+            since = @traits['smithy.api#deprecated'].fetch('since', '')
+            Model::YARD.deprecated_docstrings(message, since)
+          end
+
+          def external_documentation_docstrings
+            return [] unless @traits.key?('smithy.api#externalDocumentation')
+
+            hash = @traits.fetch('smithy.api#externalDocumentation', {})
+            Model::YARD.external_documentation_docstrings(hash)
+          end
+
+          def since_docstrings
+            return [] unless @traits.key?('smithy.api#since')
+
+            [Model::YARD.since_docstring(@traits['smithy.api#since'])]
+          end
+
+          def unstable_docstrings
+            return [] unless @traits.key?('smithy.api#unstable')
+
+            [Model::YARD.unstable_docstring]
+          end
+        end
+
+        # @api private
+        class EnumMember < Member
+          def value
+            value = @traits['smithy.api#enumValue']
+            case value
+            when String then "'#{value}'"
+            else value
+            end
+          end
+
+          def documentation_docstrings
+            @member.fetch('traits', {}).fetch('smithy.api#documentation', '').split("\n")
+          end
+        end
+
+        # @api private
+        class StructMember < Member
+          def docstrings # rubocop:disable Metrics/AbcSize
+            lines = ["@!attribute #{@name.underscore}"]
+            lines.concat(indented_docstrings(documentation_docstrings))
+            lines.concat(indented_docstrings(deprecated_docstrings))
+            lines.concat(indented_docstrings(external_documentation_docstrings))
+            lines.concat(indented_docstrings(recommended_docstrings))
+            lines.concat(indented_docstrings(since_docstrings))
+            lines.concat(indented_docstrings(unstable_docstrings))
+            lines.concat(indented_docstrings(return_docstrings))
+            lines
+          end
+
+          def default?
+            traits = @member.fetch('traits', {})
+            traits.key?('smithy.api#default') && !traits.key?('smithy.api#clientOptional')
+          end
+
+          def default
+            default = @member.dig('traits', 'smithy.api#default')
+            case @target['type']
+            when 'blob' then "Base64.strict_decode64('#{default}')"
+            when 'bigDecimal' then "BigDecimal('#{default}')"
+            when 'document' then document_default(default)
+            when 'enum', 'string' then "'#{default}'"
+            when 'timestamp' then timestamp_default(default)
+            else default
+            end
+          end
+
+          private
+
+          def indented_docstrings(docstrings)
+            docstrings.map { |docstring| "  #{docstring}" }
+          end
+
+          def recommended_docstrings
+            return [] unless @traits.key?('smithy.api#recommended')
+
+            reason = @traits['smithy.api#recommended'].fetch('reason', '')
+            Model::YARD.recommended_docstrings(reason)
+          end
+
+          def return_docstrings
+            [Model::YARD.return_docstring(@service, @model, @member['target'], @target)]
+          end
+
+          def document_default(default)
+            case default
+            when nil then 'nil'
+            when String then "'#{default}'"
+            else default
+            end
+          end
+
+          def timestamp_default(default)
+            case default
+            when Integer then "Time.at(#{default})"
+            when String then "Time.parse('#{default}')"
+            else default
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smithy/views/client/types_rbs.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class TypesRbs < View
+        def initialize(plan)
+          @plan = plan
+          @model = plan.model
+          super()
+        end
+
+        def module_name
+          @plan.module_name
+        end
+
+        def types
+          Model::ServiceIndex
+            .new(@model)
+            .shapes_for(@plan.service)
+            .select { |_key, shape| %w[enum intEnum structure union].include?(shape['type']) }
+            .map { |id, structure| Type.new(@model, id, structure) }
+        end
+
+        # @api private
+        class Type
+          def initialize(model, id, shape)
+            @model = model
+            @id = id
+            @shape = shape
+            @type = shape['type']
+            @members = build_members(shape['members'])
+          end
+
+          attr_reader :type, :members
+
+          def name
+            Model::Shape.name(@id).camelize
+          end
+
+          private
+
+          def build_members(members)
+            members.map { |name, member| Member.new(@model, name, member) }
+          end
+        end
+
+        # @api private
+        class Member
+          def initialize(model, name, member)
+            @model = model
+            @name = name
+            @id = member['target']
+            @target = Model.shape(@model, member['target'])
+          end
+
+          attr_reader :name
+
+          def rbs_type
+            Model::RBS.type(@model, @id, @target)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smithy/views/client/waiters.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class Waiters < View
+        def initialize(plan)
+          @plan = plan
+          @model = @plan.model
+          super()
+        end
+
+        def module_name
+          @plan.module_name
+        end
+
+        def waiters
+          waiters = []
+          operations = Model::ServiceIndex.new(@model).operations_for(@plan.service)
+          operations.each do |operation_id, operation|
+            waiters_from_trait = waitable_trait(operation)
+            next if waiters_from_trait.empty?
+
+            operation_name = Model::Shape.name(operation_id).underscore
+            waiters_from_trait.map do |waiter_name, waiter|
+              waiters << Waiter.new(operation_name, waiter_name, waiter)
+            end
+          end
+          waiters.sort_by(&:name)
+        end
+
+        private
+
+        def waitable_trait(operation)
+          operation.fetch('traits', {}).fetch('smithy.waiters#waitable', {})
+        end
+
+        # @api private
+        class Waiter
+          def initialize(operation_name, name, waiter)
+            @operation_name = operation_name
+            @name = name
+            @documentation = waiter.fetch('documentation', '')
+            @acceptors = formatted_acceptors(waiter['acceptors'])
+            @min_delay = waiter['minDelay'] || 2
+            @max_delay = waiter['maxDelay'] || 120
+            @deprecated = waiter['deprecated']
+          end
+
+          attr_reader :operation_name, :name, :documentation, :acceptors, :min_delay, :max_delay
+
+          def docstrings
+            @documentation.split("\n")
+          end
+
+          def formatted_acceptors(acceptors)
+            acceptors.each { |acceptor| preprocess_acceptor(acceptor) }
+
+            Util::HashFormatter.new(
+              wrap: false,
+              inline: false,
+              quote_strings: true
+            ).format(acceptors: acceptors).split("\n")
+          end
+
+          def preprocess_acceptor(acceptor)
+            if (matcher = acceptor['matcher']['output'] || acceptor['matcher']['inputOutput'])
+              matcher['path'] = Util::Underscore.underscore_jmespath(matcher['path'])
+            elsif (error_type = acceptor['matcher']['errorType'])
+              acceptor['matcher']['errorType'] = Model::Shape.name(error_type)
+            end
+          end
+
+          def deprecated?
+            !!@deprecated
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smithy/views/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    # @api private
+    module Client; end
+  end
+end
+
+# helper classes
+require_relative 'client/auth_parameter'
+require_relative 'client/endpoint_parameter'
+require_relative 'client/operation_examples'
+require_relative 'client/plugin'
+require_relative 'client/plugin_list'
+require_relative 'client/request_response_example'
+require_relative 'client/shape_to_hash'
+
+# views
+require_relative 'client/auth_parameters'
+require_relative 'client/auth_parameters_rbs'
+require_relative 'client/auth_plugin'
+require_relative 'client/auth_resolver'
+require_relative 'client/auth_resolver_rbs'
+require_relative 'client/client'
+require_relative 'client/client_rbs'
+require_relative 'client/customizations'
+require_relative 'client/endpoint_parameters'
+require_relative 'client/endpoint_parameters_rbs'
+require_relative 'client/endpoint_plugin'
+require_relative 'client/endpoint_provider'
+require_relative 'client/endpoint_provider_rbs'
+require_relative 'client/endpoint_provider_spec'
+require_relative 'client/errors'
+require_relative 'client/errors_rbs'
+require_relative 'client/gemspec'
+require_relative 'client/module'
+require_relative 'client/module_rbs'
+require_relative 'client/paginators'
+require_relative 'client/protocol_spec'
+require_relative 'client/rubocop_yml'
+require_relative 'client/schema'
+require_relative 'client/schema_rbs'
+require_relative 'client/spec_helper'
+require_relative 'client/types'
+require_relative 'client/types_rbs'
+require_relative 'client/waiters'

data/lib/smithy/views/view.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Smithy
+  module Views
+    # @api private
+    class View
+      class << self
+        TEMPLATE_DIR = File.expand_path('../templates', __dir__.to_s)
+
+        def inherited(subclass)
+          parts = (subclass.name || '').split('::')
+          parts.shift(2) #=> remove Smithy::Views
+          type = parts.shift #=> remove Client/Server
+          parts.unshift(type) #=> add <Type>
+          path = File.join(parts.map(&:underscore))
+          subclass.template_file = File.join(TEMPLATE_DIR, "#{path}.erb")
+          super
+        end
+
+        attr_accessor :template_file
+      end
+
+      def render
+        ERB.new(File.read(self.class.template_file), trim_mode: '-').result(binding)
+      end
+    end
+  end
+end

data/lib/smithy/views.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Smithy
+  # @api private
+  module Views; end
+end
+
+require_relative 'views/view'
+require_relative 'views/client'