Support VERSION and CHANGELOG.md files (#323)

Author: mullermp

README.md

@@ -15,12 +15,12 @@ For previous pre-release, Java based Smithy-Ruby, see: [smithy-ruby/main](https:
 ### Smithy Build
 local build using smithy cli
 ```
-bundle exec smithy build --debug
+cd projections && bundle exec smithy build --debug
 ```
 
 local build using smithy-ruby executable:
 ```
-SMITHY_PLUGIN_DIR=build/smithy/source/smithy-ruby bundle exec smithy-ruby smith client --gem-name weather --gem-version 1.0.0 --destination-root projections/weather <<< $(smithy ast model/weather.smithy)
+cd projections && SMITHY_PLUGIN_DIR=build/smithy/source/smithy-ruby bundle exec smithy-ruby smith client --gem-name weather --gem-version 1.0.0 --destination-root weather <<< $(smithy ast model/weather.smithy)
 ```
 
 ### IRB

gems/smithy/lib/smithy/generators/client.rb

@@ -13,7 +13,10 @@ def initialize(plan)
 
       def generate
         gem_files.each_with_object([]) do |(file, content), files|
-          next if file == "lib/#{@gem_name}/customizations.rb" && should_skip_customizations?
+          if persisted_file?(file)
+            say_status :skip, "Skipping #{file} because it already exists", :yellow unless @plan.quiet
+            next
+          end
 
           create_file file, content
           files << file
@@ -29,6 +32,8 @@ def source
       # rubocop:disable Metrics/AbcSize
       def gem_files
         Enumerator.new do |e|
+          e.yield 'VERSION', Views::Client::Version.new(@plan).render
+          e.yield 'CHANGELOG.md', Views::Client::ChangelogMd.new.render
           e.yield "#{@gem_name}.gemspec", Views::Client::Gemspec.new(@plan).render
           e.yield '.rubocop.yml', Views::Client::RubocopYml.new(@plan).render
 
@@ -92,8 +97,11 @@ def code_generated_plugins
         end
       end
 
-      def should_skip_customizations?
-        Dir["#{destination_root}/**/*"].any? { |f| f.include?('/customizations.rb') }
+      def persisted_file?(path)
+        keep = %W[lib/#{@gem_name}/customizations.rb VERSION CHANGELOG.md]
+        return false unless keep.include?(path)
+
+        File.exist?(File.join(destination_root, path))
       end
     end
   end

gems/smithy/lib/smithy/generators/schema.rb

@@ -13,7 +13,10 @@ def initialize(plan)
 
       def generate
         gem_files.each_with_object([]) do |(file, content), files|
-          next if file == "lib/#{@gem_name}/customizations.rb" && should_skip_customizations?
+          if persisted_file?(file)
+            say_status :skip, "Skipping #{file} because it already exists", :yellow unless @plan.quiet
+            next
+          end
 
           create_file file, content
           files << file
@@ -26,8 +29,11 @@ def source
 
       private
 
+      # rubocop:disable Metrics/AbcSize
       def gem_files
         Enumerator.new do |e|
+          e.yield 'VERSION', Views::Client::Version.new(@plan).render
+          e.yield 'CHANGELOG.md', Views::Client::ChangelogMd.new.render
           e.yield "#{@gem_name}.gemspec", Views::Client::Gemspec.new(@plan).render
           e.yield '.rubocop.yml', Views::Client::RubocopYml.new(@plan).render
 
@@ -52,9 +58,13 @@ def rbs_files
           e.yield "sig/#{@gem_name}/schema.rbs", Views::Client::SchemaRbs.new(@plan).render
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
-      def should_skip_customizations?
-        Dir["#{destination_root}/**/*"].any? { |f| f.include?('/customizations.rb') }
+      def persisted_file?(path)
+        keep = %W[lib/#{@gem_name}/customizations.rb VERSION CHANGELOG.md]
+        return false unless keep.include?(path)
+
+        File.exist?(File.join(destination_root, path))
       end
     end
   end

gems/smithy/lib/smithy/templates/client/changelog_md.erb

@@ -0,0 +1,2 @@
+Unreleased Changes
+------------------

gems/smithy/lib/smithy/templates/client/gemspec.erb

@@ -4,10 +4,11 @@
 
 Gem::Specification.new do |spec|
   spec.name        = '<%= gem_name %>'
-  spec.version     = '<%= gem_version %>'
+  spec.version     = File.read(File.expand_path('../VERSION', __FILE__))
   spec.summary     = 'Generated gem using Smithy'
   spec.authors     = ['Smithy Ruby']
-  spec.files       = Dir['lib/**/*.rb', base: __dir__]
+  spec.files       = Dir['VERSION', 'CHANGELOG.md', 'lib/**/*.rb', base: __dir__]
+  spec.license     = 'Apache-2.0'
 
 <% dependencies.each do |dependency, version| -%>
   spec.add_dependency('<%= dependency %>', '<%= version %>')

gems/smithy/lib/smithy/templates/client/version.erb

@@ -0,0 +1 @@
+<%= gem_version %>

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

@@ -21,6 +21,7 @@ module Client; end
 require_relative 'client/auth_parameters_rbs'
 require_relative 'client/auth_resolver'
 require_relative 'client/auth_resolver_rbs'
+require_relative 'client/changelog_md'
 require_relative 'client/client'
 require_relative 'client/client_rbs'
 require_relative 'client/customizations'
@@ -43,4 +44,5 @@ module Client; end
 require_relative 'client/spec_helper'
 require_relative 'client/types'
 require_relative 'client/types_rbs'
+require_relative 'client/version'
 require_relative 'client/waiters'

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Views
+    module Client
+      # @api private
+      class ChangelogMd < View; end
+    end
+  end
+end

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

@@ -14,10 +14,6 @@ def gem_name
           @plan.gem_name
         end
 
-        def gem_version
-          @plan.gem_version
-        end
-
         def dependencies
           dependencies = @plan.welds.map(&:add_dependencies).reduce({}, :merge)
           dependencies = dependencies.except(@plan.welds.map(&:remove_dependencies).reduce([], :+))

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

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