Promote smithy model classes to their own gem (#275)

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Test
         run: bundle exec rake smithy:spec
 
-  smithy-test-rbs:
+  smithy-rbs:
     needs: [smithy-test]
     runs-on: ubuntu-latest
 

.rubocop.yml

@@ -40,6 +40,7 @@ Naming/FileName:
     - '**/spec/**/*.rb'
     - 'gems/smithy-client/lib/smithy-client.rb'
     - 'gems/smithy-server/lib/smithy-server.rb'
+    - 'gems/smithy-model/lib/smithy-model.rb'
 
 Style/BlockComments:
   Exclude:

Gemfile

@@ -7,6 +7,7 @@ gem 'rake', require: false
 gem 'smithy', path: 'gems/smithy'
 gem 'smithy-client', path: 'gems/smithy-client'
 # gem 'smithy-server', path: 'gems/smithy-server'
+gem 'smithy-model', path: 'gems/smithy-model'
 
 group :development do
   gem 'byebug', platforms: :ruby

Rakefile

@@ -20,7 +20,7 @@ namespace :smithy do
     include_paths = []
     plans = []
     rbs_targets = %w[Smithy Smithy::* Smithy::Client]
-    sig_paths = ['gems/smithy-client/sig']
+    sig_paths = %w[gems/smithy-client/sig gems/smithy-model/sig]
     Dir.glob('gems/smithy/spec/fixtures/endpoints/*/model.json') do |model_path|
       test_name = model_path.split('/')[-2]
       test_module = test_name.gsub('-', '').camelize
@@ -108,7 +108,7 @@ namespace 'smithy-client' do
 
   desc 'Run RBS validation.'
   task 'rbs:validate' do
-    sh('bundle exec rbs -I gems/smithy-client/sig validate')
+    sh('bundle exec rbs -I gems/smithy-client/sig -I gems/smithy-model/sig validate')
   end
 
   desc 'Run RBS spy tests on all unit tests.'
@@ -117,8 +117,8 @@ namespace 'smithy-client' do
       'RUBYOPT' => '-r bundler/setup -r rbs/test/setup',
       'RBS_TEST_RAISE' => 'true',
       'RBS_TEST_LOGLEVEL' => 'error',
-      'RBS_TEST_OPT' => '-I gems/smithy-client/sig',
-      'RBS_TEST_TARGET' => '"Smithy,Smithy::*,Smithy::Client"',
+      'RBS_TEST_OPT' => '-I gems/smithy-client/sig -I gems/smithy-model/sig',
+      'RBS_TEST_TARGET' => '"Smithy::Client,Smithy::Client::*"',
       'RBS_TEST_DOUBLE_SUITE' => 'rspec'
     }
     sh(env,
@@ -127,5 +127,36 @@ namespace 'smithy-client' do
   end
 
   desc 'Run RBS validation and spy tests.'
-  task 'rbs' => ['rbs:validate', 'rbs:test']
+  task 'rbs' => %w[rbs:validate rbs:test]
+end
+
+namespace 'smithy-model' do
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = 'gems/smithy-model/spec/**/*_spec.rb'
+    t.ruby_opts = '-I gems/smithy-model/spec'
+    t.rspec_opts = '--format documentation'
+  end
+
+  desc 'Run RBS validation.'
+  task 'rbs:validate' do
+    sh('bundle exec rbs -I gems/smithy-model/sig validate')
+  end
+
+  desc 'Run RBS spy tests on all unit tests.'
+  task 'rbs:test' do
+    env = {
+      'RUBYOPT' => '-r bundler/setup -r rbs/test/setup',
+      'RBS_TEST_RAISE' => 'true',
+      'RBS_TEST_LOGLEVEL' => 'error',
+      'RBS_TEST_OPT' => '-I gems/smithy-client/sig',
+      'RBS_TEST_TARGET' => '"Smithy::Model,Smithy::Model::*"',
+      'RBS_TEST_DOUBLE_SUITE' => 'rspec'
+    }
+    sh(env,
+       'bundle exec rspec gems/smithy-model/spec -I gems/smithy-model/lib -I gems/smithy-model/spec ' \
+       "--require spec_helper --tag '~rbs_test:skip'")
+  end
+
+  desc 'Run RBS validation and spy tests.'
+  task 'rbs' => %w[rbs:validate rbs:test]
 end

gems/smithy-client/lib/smithy-client.rb

@@ -2,22 +2,28 @@
 
 require 'jmespath'
 
+require 'smithy-model'
+
 # client
 
 require_relative 'smithy-client/block_io'
 require_relative 'smithy-client/configuration'
 require_relative 'smithy-client/endpoint_rules'
+require_relative 'smithy-client/errors'
 require_relative 'smithy-client/handler'
 require_relative 'smithy-client/handler_builder'
 require_relative 'smithy-client/handler_context'
 require_relative 'smithy-client/handler_list'
 require_relative 'smithy-client/handler_list_entry'
 require_relative 'smithy-client/managed_file'
 require_relative 'smithy-client/networking_error'
+require_relative 'smithy-client/param_converter'
+require_relative 'smithy-client/param_validator'
 require_relative 'smithy-client/plugin'
 require_relative 'smithy-client/plugin_list'
 require_relative 'smithy-client/input'
 require_relative 'smithy-client/output'
+require_relative 'smithy-client/base'
 
 # client http
 
@@ -27,17 +33,6 @@
 require_relative 'smithy-client/net_http/connection_pool'
 require_relative 'smithy-client/net_http/handler'
 
-# model
-
-require_relative 'smithy-client/base'
-require_relative 'smithy-client/errors'
-require_relative 'smithy-client/schema'
-require_relative 'smithy-client/shapes'
-require_relative 'smithy-client/structure'
-require_relative 'smithy-client/union'
-require_relative 'smithy-client/param_converter'
-require_relative 'smithy-client/param_validator'
-
 # codecs
 
 require_relative 'smithy-client/cbor'

gems/smithy-client/lib/smithy-client/base.rb

@@ -150,9 +150,9 @@ def plugins
           Array(@plugins).freeze
         end
 
-        # @return [Schema]
+        # @return [Model::Schema]
         def schema
-          @schema ||= Schema.new
+          @schema ||= Model::Schema.new
         end
 
         # @param [Schema] schema

gems/smithy-client/lib/smithy-client/codecs/cbor.rb

@@ -12,7 +12,7 @@ module Codecs
       #   * Update implementation to handle event streams
       #   * Handle query_compatible trait
       class CBOR
-        include Shapes
+        include Model::Shapes
 
         def initialize(options = {}); end
 

gems/smithy-client/lib/smithy-client/param_converter.rb

@@ -10,7 +10,7 @@ module Smithy
   module Client
     # @api private
     class ParamConverter
-      include Smithy::Client::Shapes
+      include Model::Shapes
 
       @mutex = Mutex.new
       @converters = Hash.new { |h, k| h[k] = {} }
@@ -50,7 +50,7 @@ def structure(shape, values)
 
       def union(shape, values)
         values = c(shape, values)
-        if values.is_a?(Union) || values.is_a?(Hash)
+        if values.is_a?(Model::Union) || values.is_a?(Hash)
           values.each_pair do |k, v|
             next if v.nil?
             next unless shape.member?(k)
@@ -246,7 +246,7 @@ def each_base_class(shape_class, &)
       end
 
       add(UnionShape, Hash) { |h, _| h.dup }
-      add(UnionShape, Union)
+      add(UnionShape, Model::Union)
     end
   end
 end

gems/smithy-client/lib/smithy-client/param_validator.rb

@@ -6,7 +6,7 @@ module Smithy
   module Client
     # @api private
     class ParamValidator
-      include Smithy::Client::Shapes
+      include Smithy::Model::Shapes
 
       EXPECTED_GOT = 'expected %s to be %s, got class %s instead.'
 

gems/smithy-client/sig/smithy-client/codec/cbor.rbs

@@ -4,10 +4,9 @@ module Smithy
       class CBOR
         def initialize: (?::Hash[untyped, untyped] options) -> void
 
-        def serialize: (untyped data, Shapes::Shape shape) -> (nil | String)
-
-        def deserialize: (String bytes, Shapes::Shape shape, ?Struct[untyped] target) -> (Hash[untyped, untyped] | Object)
+        def serialize: (untyped data, Model::Shapes::Shape shape) -> (nil | String)
 
+        def deserialize: (String bytes, Model::Shapes::Shape shape, ?Struct[untyped] target) -> (Hash[untyped, untyped] | Object)
       end
     end
   end

gems/smithy-client/sig/smithy-client/handler_context.rbs

@@ -3,7 +3,7 @@ module Smithy
     class HandlerContext
       def initialize: (?::Hash[untyped, untyped] options) -> void
       attr_accessor operation_name: (Symbol | String)?
-      attr_accessor operation: Shapes::OperationShape?
+      attr_accessor operation: Model::Shapes::OperationShape?
       attr_accessor client: Base?
       attr_accessor params: Hash[Symbol | String, untyped]
       attr_accessor config: Struct[untyped]?

gems/smithy-client/smithy-client.gemspec

@@ -12,5 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('jmespath', '~> 1', '>= 1.6.1') # necessary for secure jmespath JSON parsing
 
+  spec.add_dependency('smithy-model', '1.0.0.pre0')
+
   spec.required_ruby_version = '>= 3.3'
 end

gems/smithy-client/spec/smithy-client/base_spec.rb

@@ -3,7 +3,7 @@
 module Smithy
   module Client
     describe Base do
-      let(:schema) { Schema.new }
+      let(:schema) { Model::Schema.new }
       let(:client_class) { Base.define(schema: schema) }
       let(:plugin_a) { Plugin.new }
       let(:plugin_b) { Plugin.new }
@@ -46,7 +46,7 @@ module Client
         let(:input) { subject.build_input(:operation) }
 
         before(:each) do
-          schema.add_operation(:operation, Shapes::OperationShape.new)
+          schema.add_operation(:operation, Model::Shapes::OperationShape.new)
         end
 
         it 'returns an Input' do
@@ -101,7 +101,7 @@ module Client
         let(:input) { Input.new }
 
         before(:each) do
-          schema.add_operation(:operation, Shapes::OperationShape.new)
+          schema.add_operation(:operation, Model::Shapes::OperationShape.new)
           allow(subject).to receive(:build_input).and_return(input)
           allow(input).to receive(:send_request)
         end
@@ -237,13 +237,13 @@ module Client
 
       describe '.schema' do
         it 'defaults to a Schema' do
-          expect(client_class.schema).to be_kind_of(Schema)
+          expect(client_class.schema).to be_kind_of(Model::Schema)
         end
       end
 
       describe '.schema=' do
         it 'can be set' do
-          schema = Schema.new
+          schema = Model::Schema.new
           client_class.schema = schema
           expect(client_class.schema).to be(schema)
         end
@@ -256,7 +256,7 @@ module Client
         end
 
         it 'sets the schema on the client class' do
-          schema = Schema.new
+          schema = Model::Schema.new
           client_class = Base.define(schema: schema)
           expect(client_class.schema).to be(schema)
         end

gems/smithy-client/spec/smithy-client/codecs/cbor_spec.rb

@@ -4,29 +4,29 @@ module Smithy
   module Client
     module Codecs
       describe CBOR do
-        let(:string_shape) { Shapes::StringShape.new(id: 'string') }
+        let(:string_shape) { Model::Shapes::StringShape.new(id: 'string') }
 
         let(:list_shape) do
-          shape = Shapes::ListShape.new(id: 'list')
-          shape.set_member(Shapes::Prelude::String)
+          shape = Model::Shapes::ListShape.new(id: 'list')
+          shape.set_member(Model::Shapes::Prelude::String)
           shape
         end
 
         let(:map_shape) do
-          shape = Shapes::MapShape.new(id: 'map')
-          shape.set_key(Shapes::Prelude::String)
-          shape.set_value(Shapes::Prelude::Blob)
+          shape = Model::Shapes::MapShape.new(id: 'map')
+          shape.set_key(Model::Shapes::Prelude::String)
+          shape.set_value(Model::Shapes::Prelude::Blob)
           shape
         end
 
         let(:typed_struct) do
           Struct.new(:s, :l, :m, keyword_init: true) do
-            include Smithy::Client::Structure
+            include Model::Structure
           end
         end
 
         let(:structure_shape) do
-          struct = Shapes::StructureShape.new(id: 'structure')
+          struct = Model::Shapes::StructureShape.new(id: 'structure')
           struct.add_member(:s, string_shape)
           struct.add_member(:l, list_shape)
           struct.add_member(:m, map_shape)
@@ -35,7 +35,7 @@ module Codecs
         end
 
         it 'serializes returns nil when given shape is Prelude::Unit' do
-          expect(subject.serialize('', Shapes::Prelude::Unit)).to be_nil
+          expect(subject.serialize('', Model::Shapes::Prelude::Unit)).to be_nil
         end
 
         it 'deserializes returns an empty hash when given bytes are empty' do

gems/smithy-client/spec/smithy-client/handler_context_spec.rb

@@ -22,7 +22,7 @@ module Client
         end
 
         it 'can be set in the constructor' do
-          operation = Shapes::OperationShape.new
+          operation = Model::Shapes::OperationShape.new
           context = HandlerContext.new(operation: operation)
           expect(context.operation).to be(operation)
         end