Add name field to shapes (#314)

Author: mullermp

gems/smithy-schema/lib/smithy-schema/shapes.rb

@@ -8,13 +8,17 @@ module Shapes
       class Shape
         def initialize(options = {})
           @id = options[:id]
+          @name = options[:name]
           @traits = options[:traits] || {}
           @metadata = {}
         end
 
-        # @return [String, nil] Absolute shape ID from model
+        # @return [String] Absolute shape ID from model
         attr_accessor :id
 
+        # @return [String] Shape name
+        attr_accessor :name
+
         # @return [Hash<String, Object>]
         attr_accessor :traits
 
@@ -40,13 +44,13 @@ def initialize(options = {})
         end
 
         # @return [Shape]
-        attr_reader :shape
+        attr_accessor :shape
 
         # @return [String, nil]
-        attr_reader :member_name
+        attr_accessor :member_name
 
         # @return [Hash<String, Object>]
-        attr_reader :traits
+        attr_accessor :traits
 
         # @return [Object]
         def [](key)
@@ -268,10 +272,10 @@ def initialize(options = {})
         attr_accessor :members
 
         # @return [Hash<Symbol, Class>]
-        attr_reader :member_types
+        attr_accessor :member_types
 
         # @return [Hash<Class, [String, ShapeRef]>]
-        attr_reader :members_by_type
+        attr_accessor :members_by_type
 
         # @return [Class]
         attr_accessor :type

gems/smithy-schema/sig/smithy-schema/shapes.rbs

@@ -4,7 +4,8 @@ module Smithy
       class Shape
         def initialize: (?Hash[Symbol, untyped]) ?{ (self) -> void } -> void
 
-        attr_accessor id: String?
+        attr_accessor id: String
+        attr_accessor name: String
         attr_accessor traits: Hash[String, untyped]
         def []: (Symbol) -> Object
         def []=: (Symbol, Object) -> void
@@ -13,9 +14,9 @@ module Smithy
       class ShapeRef
         def initialize: (?Hash[Symbol, untyped]) -> void
 
-        attr_reader shape: Shape
-        attr_reader member_name: String?
-        attr_reader traits: Hash[String, untyped]
+        attr_accessor shape: Shape
+        attr_accessor member_name: String?
+        attr_accessor traits: Hash[String, untyped]
         def []: (Symbol) -> Object
         def []=: (Symbol, Object) -> void
       end

gems/smithy-schema/spec/smithy-schema/shapes_spec.rb

@@ -14,8 +14,13 @@ module Shapes
           end
 
           it 'can set id' do
-            subject = Shape.new(id: 'foo')
-            expect(subject.id).to eq('foo')
+            subject = Shape.new(id: 'my.namespace#ShapeId')
+            expect(subject.id).to eq('my.namespace#ShapeId')
+          end
+
+          it 'can set name' do
+            subject = Shape.new(name: 'ShapeName')
+            expect(subject.name).to eq('ShapeName')
           end
 
           it 'defaults traits to empty hash' do

gems/smithy/lib/smithy/views/client/schema.rb

@@ -156,17 +156,14 @@ def initialize(service, id, shape)
             @shape = shape
             @type = shape['type']
             @traits = shape.fetch('traits', {}).except(*OMITTED_TRAITS)
+            @name = (@service.dig('rename', @id) || Model::Shape.name(@id)).camelize
           end
 
-          attr_reader :type, :id
-
-          def name
-            (@service.dig('rename', @id) || Model::Shape.name(@id)).camelize
-          end
+          attr_reader :type, :id, :name
 
           def initializer
             traits_str = ", traits: #{@traits}" unless @traits.empty?
-            "Smithy::Schema::Shapes::#{SHAPE_CLASS_MAP[@type]}.new(id: '#{@id}'#{traits_str})"
+            "Smithy::Schema::Shapes::#{SHAPE_CLASS_MAP[@type]}.new(id: '#{@id}', name: '#{@name}'#{traits_str})"
           end
         end
 

projections/shapes/lib/shapes/schema.rb

@@ -6,27 +6,27 @@ module ShapeService
   # This module contains a schema composed of shapes used by the client.
   module Schema
 
-    BigDecimal = Smithy::Schema::Shapes::BigDecimalShape.new(id: 'smithy.ruby.tests#BigDecimal', traits: {"smithy.ruby.tests#shape" => {}})
-    BigInteger = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#BigInteger', traits: {"smithy.ruby.tests#shape" => {}})
-    Blob = Smithy::Schema::Shapes::BlobShape.new(id: 'smithy.ruby.tests#Blob', traits: {"smithy.ruby.tests#shape" => {}})
-    Boolean = Smithy::Schema::Shapes::BooleanShape.new(id: 'smithy.ruby.tests#Boolean', traits: {"smithy.ruby.tests#shape" => {}})
-    Byte = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Byte', traits: {"smithy.ruby.tests#shape" => {}})
-    Document = Smithy::Schema::Shapes::DocumentShape.new(id: 'smithy.ruby.tests#Document', traits: {"smithy.ruby.tests#shape" => {}})
-    Double = Smithy::Schema::Shapes::FloatShape.new(id: 'smithy.ruby.tests#Double', traits: {"smithy.ruby.tests#shape" => {}})
-    Enum = Smithy::Schema::Shapes::EnumShape.new(id: 'smithy.ruby.tests#Enum', traits: {"smithy.ruby.tests#shape" => {}})
-    Float = Smithy::Schema::Shapes::FloatShape.new(id: 'smithy.ruby.tests#Float', traits: {"smithy.ruby.tests#shape" => {}})
-    IntEnum = Smithy::Schema::Shapes::IntEnumShape.new(id: 'smithy.ruby.tests#IntEnum', traits: {"smithy.ruby.tests#shape" => {}})
-    Integer = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Integer', traits: {"smithy.ruby.tests#shape" => {}})
-    List = Smithy::Schema::Shapes::ListShape.new(id: 'smithy.ruby.tests#List', traits: {"smithy.ruby.tests#shape" => {}})
-    Long = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Long', traits: {"smithy.ruby.tests#shape" => {}})
-    Map = Smithy::Schema::Shapes::MapShape.new(id: 'smithy.ruby.tests#Map', traits: {"smithy.ruby.tests#shape" => {}})
-    OperationInput = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#OperationInput')
-    OperationOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#OperationOutput')
-    Short = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Short', traits: {"smithy.ruby.tests#shape" => {}})
-    String = Smithy::Schema::Shapes::StringShape.new(id: 'smithy.ruby.tests#String', traits: {"smithy.ruby.tests#shape" => {}})
-    Structure = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#Structure', traits: {"smithy.ruby.tests#shape" => {}})
-    Timestamp = Smithy::Schema::Shapes::TimestampShape.new(id: 'smithy.ruby.tests#Timestamp', traits: {"smithy.ruby.tests#shape" => {}})
-    Union = Smithy::Schema::Shapes::UnionShape.new(id: 'smithy.ruby.tests#Union', traits: {"smithy.ruby.tests#shape" => {}})
+    BigDecimal = Smithy::Schema::Shapes::BigDecimalShape.new(id: 'smithy.ruby.tests#BigDecimal', name: 'BigDecimal', traits: {"smithy.ruby.tests#shape" => {}})
+    BigInteger = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#BigInteger', name: 'BigInteger', traits: {"smithy.ruby.tests#shape" => {}})
+    Blob = Smithy::Schema::Shapes::BlobShape.new(id: 'smithy.ruby.tests#Blob', name: 'Blob', traits: {"smithy.ruby.tests#shape" => {}})
+    Boolean = Smithy::Schema::Shapes::BooleanShape.new(id: 'smithy.ruby.tests#Boolean', name: 'Boolean', traits: {"smithy.ruby.tests#shape" => {}})
+    Byte = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Byte', name: 'Byte', traits: {"smithy.ruby.tests#shape" => {}})
+    Document = Smithy::Schema::Shapes::DocumentShape.new(id: 'smithy.ruby.tests#Document', name: 'Document', traits: {"smithy.ruby.tests#shape" => {}})
+    Double = Smithy::Schema::Shapes::FloatShape.new(id: 'smithy.ruby.tests#Double', name: 'Double', traits: {"smithy.ruby.tests#shape" => {}})
+    Enum = Smithy::Schema::Shapes::EnumShape.new(id: 'smithy.ruby.tests#Enum', name: 'Enum', traits: {"smithy.ruby.tests#shape" => {}})
+    Float = Smithy::Schema::Shapes::FloatShape.new(id: 'smithy.ruby.tests#Float', name: 'Float', traits: {"smithy.ruby.tests#shape" => {}})
+    IntEnum = Smithy::Schema::Shapes::IntEnumShape.new(id: 'smithy.ruby.tests#IntEnum', name: 'IntEnum', traits: {"smithy.ruby.tests#shape" => {}})
+    Integer = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Integer', name: 'Integer', traits: {"smithy.ruby.tests#shape" => {}})
+    List = Smithy::Schema::Shapes::ListShape.new(id: 'smithy.ruby.tests#List', name: 'List', traits: {"smithy.ruby.tests#shape" => {}})
+    Long = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Long', name: 'Long', traits: {"smithy.ruby.tests#shape" => {}})
+    Map = Smithy::Schema::Shapes::MapShape.new(id: 'smithy.ruby.tests#Map', name: 'Map', traits: {"smithy.ruby.tests#shape" => {}})
+    OperationInput = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#OperationInput', name: 'OperationInput')
+    OperationOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#OperationOutput', name: 'OperationOutput')
+    Short = Smithy::Schema::Shapes::IntegerShape.new(id: 'smithy.ruby.tests#Short', name: 'Short', traits: {"smithy.ruby.tests#shape" => {}})
+    String = Smithy::Schema::Shapes::StringShape.new(id: 'smithy.ruby.tests#String', name: 'String', traits: {"smithy.ruby.tests#shape" => {}})
+    Structure = Smithy::Schema::Shapes::StructureShape.new(id: 'smithy.ruby.tests#Structure', name: 'Structure', traits: {"smithy.ruby.tests#shape" => {}})
+    Timestamp = Smithy::Schema::Shapes::TimestampShape.new(id: 'smithy.ruby.tests#Timestamp', name: 'Timestamp', traits: {"smithy.ruby.tests#shape" => {}})
+    Union = Smithy::Schema::Shapes::UnionShape.new(id: 'smithy.ruby.tests#Union', name: 'Union', traits: {"smithy.ruby.tests#shape" => {}})
 
     Enum.add_member(:foo, Smithy::Schema::Shapes::ShapeRef.new(shape: Smithy::Schema::Shapes::Prelude::Unit, member_name: 'FOO', traits: {"smithy.api#enumValue" => "bar"}))
     IntEnum.add_member(:baz, Smithy::Schema::Shapes::ShapeRef.new(shape: Smithy::Schema::Shapes::Prelude::Unit, member_name: 'BAZ', traits: {"smithy.api#enumValue" => 1}))

projections/weather/lib/weather/schema.rb

@@ -6,18 +6,18 @@ module Weather
   # This module contains a schema composed of shapes used by the client.
   module Schema
 
-    CityCoordinates = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#CityCoordinates')
-    CityId = Smithy::Schema::Shapes::StringShape.new(id: 'example.weather#CityId', traits: {"smithy.api#pattern" => "^[A-Za-z0-9 ]+$"})
-    CitySummaries = Smithy::Schema::Shapes::ListShape.new(id: 'example.weather#CitySummaries')
-    CitySummary = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#CitySummary', traits: {"smithy.api#references" => [{"resource" => "example.weather#City"}]})
-    GetCityInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCityInput')
-    GetCityOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCityOutput')
-    GetCurrentTimeOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCurrentTimeOutput')
-    GetForecastInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetForecastInput')
-    GetForecastOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetForecastOutput')
-    ListCitiesInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#ListCitiesInput')
-    ListCitiesOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#ListCitiesOutput')
-    NoSuchResource = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#NoSuchResource', traits: {"smithy.api#error" => "client"})
+    CityCoordinates = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#CityCoordinates', name: 'CityCoordinates')
+    CityId = Smithy::Schema::Shapes::StringShape.new(id: 'example.weather#CityId', name: 'CityId', traits: {"smithy.api#pattern" => "^[A-Za-z0-9 ]+$"})
+    CitySummaries = Smithy::Schema::Shapes::ListShape.new(id: 'example.weather#CitySummaries', name: 'CitySummaries')
+    CitySummary = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#CitySummary', name: 'CitySummary', traits: {"smithy.api#references" => [{"resource" => "example.weather#City"}]})
+    GetCityInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCityInput', name: 'GetCityInput')
+    GetCityOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCityOutput', name: 'GetCityOutput')
+    GetCurrentTimeOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetCurrentTimeOutput', name: 'GetCurrentTimeOutput')
+    GetForecastInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetForecastInput', name: 'GetForecastInput')
+    GetForecastOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#GetForecastOutput', name: 'GetForecastOutput')
+    ListCitiesInput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#ListCitiesInput', name: 'ListCitiesInput')
+    ListCitiesOutput = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#ListCitiesOutput', name: 'ListCitiesOutput')
+    NoSuchResource = Smithy::Schema::Shapes::StructureShape.new(id: 'example.weather#NoSuchResource', name: 'NoSuchResource', traits: {"smithy.api#error" => "client"})
 
     CityCoordinates.add_member(:latitude, Smithy::Schema::Shapes::ShapeRef.new(shape: Smithy::Schema::Shapes::Prelude::Float, member_name: 'latitude', traits: {"smithy.api#required" => {}}))
     CityCoordinates.add_member(:longitude, Smithy::Schema::Shapes::ShapeRef.new(shape: Smithy::Schema::Shapes::Prelude::Float, member_name: 'longitude', traits: {"smithy.api#required" => {}}))