aws-sdk-code-generator 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd7b6eb0cfae166558e734fdb8e7c9236f7f14d6
+  data.tar.gz: 8cad3f3e2213a13d558259216831b08e1e4d5323
+SHA512:
+  metadata.gz: c970544cd6c87e3794260f4dda931f717c9e7ef9dfb43693b35c0d22f0a3b1ec850b3ff281b7e9e825591905a2a45b19168337521c8039c2e648db3e66b1d525
+  data.tar.gz: 6a927656fc80f7df13cc27c03f1675a81fb3f000bcec4b6fb3ba6d672ad1e37a74296ccaff8b37137e3ce4912780bf1a1818f4b7c03e13ca3b8781f9a7375ade

data/lib/aws-sdk-code-generator.rb

@@ -0,0 +1,91 @@
+require_relative 'aws-sdk-code-generator/apply_docs'
+require_relative 'aws-sdk-code-generator/helper'
+require_relative 'aws-sdk-code-generator/service'
+require_relative 'aws-sdk-code-generator/underscore'
+require_relative 'aws-sdk-code-generator/view'
+
+require_relative 'aws-sdk-code-generator/code_builder'
+require_relative 'aws-sdk-code-generator/gem_builder'
+
+# views
+require_relative 'aws-sdk-code-generator/views/features/env'
+require_relative 'aws-sdk-code-generator/views/features/step_definitions'
+require_relative 'aws-sdk-code-generator/views/gemspec'
+require_relative 'aws-sdk-code-generator/views/service_module'
+require_relative 'aws-sdk-code-generator/views/spec/spec_helper'
+require_relative 'aws-sdk-code-generator/views/version'
+
+module AwsSdkCodeGenerator
+
+  autoload :Errors, 'aws-sdk-code-generator/errors'
+  autoload :HashFormatter, 'aws-sdk-code-generator/hash_formatter'
+  autoload :Helper, 'aws-sdk-code-generator/helper'
+
+  module Dsl
+    autoload :AccessControlStatement, 'aws-sdk-code-generator/dsl/access_control_statement'
+    autoload :AutoloadStatement, 'aws-sdk-code-generator/dsl/autoload_statement'
+    autoload :AttributeAccessor, 'aws-sdk-code-generator/dsl/attribute_accessor'
+    autoload :AttributeReader, 'aws-sdk-code-generator/dsl/attribute_reader'
+    autoload :AttributeWriter, 'aws-sdk-code-generator/dsl/attribute_writer'
+    autoload :BlockParam, 'aws-sdk-code-generator/dsl/block_param'
+    autoload :Class, 'aws-sdk-code-generator/dsl/class'
+    autoload :CodeLiteral, 'aws-sdk-code-generator/dsl/code_literal'
+    autoload :CodeObject, 'aws-sdk-code-generator/dsl/code_object'
+    autoload :Docstring, 'aws-sdk-code-generator/dsl/docstring'
+    autoload :Eigenclass, 'aws-sdk-code-generator/dsl/eigenclass'
+    autoload :ExtendStatement, 'aws-sdk-code-generator/dsl/extend_statement'
+    autoload :IncludeStatement, 'aws-sdk-code-generator/dsl/include_statement'
+    autoload :Main, 'aws-sdk-code-generator/dsl/main'
+    autoload :Method, 'aws-sdk-code-generator/dsl/method'
+    autoload :Module, 'aws-sdk-code-generator/dsl/module'
+    autoload :OptionTag, 'aws-sdk-code-generator/dsl/option_tag'
+    autoload :Param, 'aws-sdk-code-generator/dsl/param'
+    autoload :ParamList,  'aws-sdk-code-generator/dsl/param_list'
+    autoload :ReturnTag, 'aws-sdk-code-generator/dsl/return_tag'
+    autoload :TagDocstring, 'aws-sdk-code-generator/dsl/tag_docstring'
+    autoload :TagDefault, 'aws-sdk-code-generator/dsl/tag_default'
+    autoload :TagType, 'aws-sdk-code-generator/dsl/tag_type'
+  end
+
+  module Generators
+    autoload :ClientApiModule, 'aws-sdk-code-generator/generators/client_api_module'
+    autoload :ClientClass, 'aws-sdk-code-generator/generators/client_class'
+    autoload :ClientOperationDocumentation, 'aws-sdk-code-generator/generators/client_operation_documentation'
+    autoload :ErrorsModule, 'aws-sdk-code-generator/generators/errors_module'
+    autoload :TypesModule, 'aws-sdk-code-generator/generators/types_module'
+    autoload :RootResourceClass, 'aws-sdk-code-generator/generators/root_resource_class'
+    autoload :ResourceClass, 'aws-sdk-code-generator/generators/resource_class'
+    autoload :ResponseStructureExample, 'aws-sdk-code-generator/generators/response_structure_example'
+    autoload :ServiceDocumentation, 'aws-sdk-code-generator/generators/service_documentation'
+    autoload :SharedExample, 'aws-sdk-code-generator/generators/shared_example'
+    autoload :StructureTypeClass, 'aws-sdk-code-generator/generators/structure_type_class'
+    autoload :SyntaxExample, 'aws-sdk-code-generator/generators/syntax_example'
+    autoload :WaiterClass, 'aws-sdk-code-generator/generators/waiter_class'
+    autoload :WaitersModule, 'aws-sdk-code-generator/generators/waiters_module'
+
+    module Resource
+      autoload :Action, 'aws-sdk-code-generator/generators/resource/action'
+      autoload :BatchBuilder, 'aws-sdk-code-generator/generators/resource/batch_builder'
+      autoload :Builder, 'aws-sdk-code-generator/generators/resource/builder'
+      autoload :ClientGetter,  'aws-sdk-code-generator/generators/resource/client_getter'
+      autoload :ClientRequest,  'aws-sdk-code-generator/generators/resource/client_request'
+      autoload :ClientRequestParams,  'aws-sdk-code-generator/generators/resource/client_request_params'
+      autoload :ClientRequestDocs,  'aws-sdk-code-generator/generators/resource/client_request_docs'
+      autoload :CollectionClass,  'aws-sdk-code-generator/generators/resource/collection_class'
+      autoload :DataMethod, 'aws-sdk-code-generator/generators/resource/data_method'
+      autoload :DataAttributeGetter, 'aws-sdk-code-generator/generators/resource/data_attribute_getter'
+      autoload :DataLoadedMethod, 'aws-sdk-code-generator/generators/resource/data_loaded_method'
+      autoload :ExistsMethod, 'aws-sdk-code-generator/generators/resource/exists_method'
+      autoload :ExtractIdentifierMethod, 'aws-sdk-code-generator/generators/resource/extract_identifier_method'
+      autoload :HasAssociation, 'aws-sdk-code-generator/generators/resource/has_association'
+      autoload :HasManyAssociation, 'aws-sdk-code-generator/generators/resource/has_many_association'
+      autoload :InitializeMethod, 'aws-sdk-code-generator/generators/resource/initialize_method'
+      autoload :IdentifiersMethod, 'aws-sdk-code-generator/generators/resource/identifiers_method'
+      autoload :IdentifierGetter, 'aws-sdk-code-generator/generators/resource/identifier_getter'
+      autoload :LoadMethod, 'aws-sdk-code-generator/generators/resource/load_method'
+      autoload :ValueSource, 'aws-sdk-code-generator/generators/resource/value_source'
+      autoload :WaiterMethod, 'aws-sdk-code-generator/generators/resource/waiter_method'
+    end
+  end
+
+end

data/lib/aws-sdk-code-generator/apply_docs.rb

@@ -0,0 +1,37 @@
+module AwsSdkCodeGenerator
+  class ApplyDocs
+
+    def initialize(api)
+      @api = api
+    end
+
+    # @param [Hash, nil] docs
+    def apply(docs)
+      if docs
+        apply_docs(docs)
+      end
+    end
+
+    private
+
+    def apply_docs(docs)
+      @api['documentation'] = docs['service']
+      docs['operations'].each do |name, docstring|
+        @api['operations'][name]['documentation'] = docstring
+      end
+      docs['shapes'].each do |shape_name, shape_docs|
+        @api['shapes'][shape_name]['documentation'] = shape_docs['base']
+        shape_docs['refs'].each do |ref, ref_docs|
+          ref_shape, ref_member = ref.split('$')
+          case @api['shapes'][ref_shape]['type']
+          when 'structure'
+            @api['shapes'][ref_shape]['members'][ref_member]['documentation'] = ref_docs
+          when 'list', 'map'
+            @api['shapes'][ref_shape][ref_member]['documentation'] = ref_docs
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/aws-sdk-code-generator/code_builder.rb

@@ -0,0 +1,201 @@
+module AwsSdkCodeGenerator
+  class CodeBuilder
+
+    # @api private
+    GENERATED_SRC_WARNING = <<-WARNING
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+    WARNING
+
+    include Helper
+
+    # @option options [required, Service] :service
+    def initialize(options)
+      @service = options.fetch(:service)
+      # TODO : remove these
+      @add_plugins = @service.add_plugins
+      @remove_plugins = @service.remove_plugins
+      @gem_dependencies = @service.gem_dependencies
+      @module_names = @service.module_name.split('::')
+      @api = @service.api
+      @paginators = @service.paginators
+      @waiters = @service.waiters
+      @resources = @service.resources
+      @examples = @service.examples
+    end
+
+    def source
+      svc_mod = new_svc_module
+      @gem_dependencies.each { |gem_name, _| svc_mod.require(gem_name) }
+      svc_mod.docstring(service_docstring)
+      each_module do |mod, _|
+        svc_mod.add(mod)
+      end
+      @callback.call(svc_mod) if @callback
+      svc_mod.root.to_s
+    end
+
+    # @option options [String] :prefix
+    # @return [Enumerable<String<path>, String<code>>]
+    def source_files(options = {})
+      prefix = options.fetch(:prefix, nil)
+      prefix ||= @module_names.map { |n| underscore(n) }.join('/')
+      # prefix should always be the gemname. The service-module (the first
+      # item yielded below) should be moved from here into the gem builder
+      # The source code builder should simply yield the empty module
+      Enumerator.new do |y|
+        y.yield("#{prefix}.rb", Views::ServiceModule.new(service: @service, prefix: prefix).render)
+        y.yield("#{prefix}/customizations.rb", '')
+        each_module do |mod, type, code|
+          case type
+          when :unwrapped
+            filename = File.join(prefix, underscore(mod.name) + '.rb')
+            y.yield(filename, GENERATED_SRC_WARNING + wrap(mod))
+          when :wrapped # dsl module
+            filename = File.join(prefix, underscore(mod.name) + '.rb')
+            y.yield(filename, GENERATED_SRC_WARNING + mod.root.to_s)
+          else
+            raise "expected :wrapped or :unwrapped"
+          end
+        end
+      end
+    end
+
+    private
+
+    def each_module(&block)
+      yield(types_module, :unwrapped)
+      yield(client_api_module, :unwrapped)
+      yield(client_class, :wrapped)
+      yield(errors_module, :unwrapped)
+      yield(waiters_module, :wrapped) if @waiters
+      yield(root_resource_class, :unwrapped)
+      if @resources
+        @resources['resources'].keys.sort.each do |name|
+          yield(resource_class(name, @resources['resources'][name]), :unwrapped)
+        end
+      end
+    end
+
+    def new_svc_module
+      @module_names.inject(Dsl::Main.new) do |mod, module_name|
+        mod.module(module_name)
+      end
+    end
+
+    def wrap(mod)
+      svc_mod = new_svc_module
+      svc_mod.add(mod)
+      svc_mod.root.to_s
+    end
+
+    def service_module(autoload_prefix)
+      autoloads = Generators::ServiceAutoloads.new(
+        prefix: autoload_prefix,
+        resources: @resources,
+        waiters: !!@waiters
+      )
+      svc_mod = new_svc_module
+      @gem_dependencies.each { |gem_name, _| svc_mod.require(gem_name) }
+      svc_mod.docstring(service_docstring)
+      svc_mod.code("GEM_VERSION = '#{@service.gem_version}'")
+      autoloads.apply(svc_mod)
+      @callback.call(svc_mod) if @callback
+      svc_mod.root.to_s
+    end
+
+    def types_module
+      Generators::TypesModule.new(api: @api)
+    end
+
+    def client_api_module
+      Generators::ClientApiModule.new(api: @api, paginators:@paginators)
+    end
+
+    def client_class(svc_mod = new_svc_module)
+      klass = Generators::ClientClass.new(
+        parent: svc_mod,
+        identifier: @module_names.last.downcase,
+        api: @api,
+        waiters: @waiters,
+        examples: @examples,
+        add_plugins: @add_plugins,
+        remove_plugins: @remove_plugins,
+        gem_name: @service.gem_name,
+        gem_version: @service.gem_version,
+      )
+      svc_mod.add(klass)
+      klass
+    end
+
+    def errors_module
+      Generators::ErrorsModule.new(api: @api)
+    end
+
+    def waiters_module(svc_mod = new_svc_module)
+      klass = Generators::WaitersModule.new(
+        parent: svc_mod,
+        waiters: @waiters
+      )
+      svc_mod.add(klass)
+      klass
+    end
+
+    def root_resource_class
+      Generators::RootResourceClass.new({
+        api: @api,
+        resources: @resources,
+        paginators: @paginators,
+        var_name: underscore(@module_names.last),
+      })
+    end
+
+    def resource_class(resource_name, resource_definition)
+      Generators::ResourceClass.new(
+        api: @api,
+        name: resource_name,
+        resource: resource_definition,
+        paginators: @paginators,
+        waiters: @waiters,
+      )
+    end
+
+    def service_docstring
+      metadata = @api['metadata'] || {}
+      Generators::ServiceDocumentation.new(
+        product_name: metadata['serviceFullName'] || @module_names.last,
+        namespace: @module_names.join('::'),
+        api: @api
+      ).docstring
+    end
+
+    # @api private
+    # This method can be removed if move to used the combined API and
+    # docs JSON document.
+    def apply_docs(api, docs)
+      api['documentation'] = docs['service']
+      docs['operations'].each do |name, docstring|
+        api['operations'][name]['documentation'] = docstring
+      end
+      docs['shapes'].each do |shape_name, shape_docs|
+        api['shapes'][shape_name]['documentation'] = shape_docs['base']
+        shape_docs['refs'].each do |ref, ref_docs|
+          ref_shape, ref_member = ref.split('$')
+          case api['shapes'][ref_shape]['type']
+          when 'structure'
+            api['shapes'][ref_shape]['members'][ref_member]['documentation'] = ref_docs
+          when 'list', 'map'
+            api['shapes'][ref_shape][ref_member]['documentation'] = ref_docs
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/aws-sdk-code-generator/dsl/access_control_statement.rb

@@ -0,0 +1,23 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class AccessControlStatement
+
+      include Dsl::CodeObject
+
+      def initialize(access)
+        if [:public, :protected, :private].include?(access)
+          @access = access
+        else
+          raise ArgumentError, "expected :public, :protected, or :private"
+        end
+      end
+
+      attr_reader :access
+
+      def lines
+        [access.to_s]
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-code-generator/dsl/attribute_accessor.rb

@@ -0,0 +1,43 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class AttributeAccessor
+
+      include Dsl::CodeObject
+
+      # @option options [Boolean] :api_private (false)
+      def initialize(name, options = {}, &block)
+        @name = name
+        @tags = []
+        yield(self) if block
+        api_private! if options.fetch(:api_private, false)
+      end
+
+      attr_reader :name
+
+      def returns(type, options = {})
+        @tags << ReturnTag.new(options.merge(type:type))
+      end
+
+      def api_private!
+        @tags << "# @api private"
+      end
+
+      def documented?
+        !@tags.empty?
+      end
+
+      def lines
+        lines = []
+        @tags.each do |tag|
+          lines.concat(tag.lines.to_a)
+        end
+        lines + ["#{macro} :#{@name}"]
+      end
+
+      def macro
+        "attr_accessor"
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-code-generator/dsl/attribute_reader.rb

@@ -0,0 +1,11 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class AttributeReader < AttributeAccessor
+
+      def macro
+        "attr_reader"
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-code-generator/dsl/attribute_writer.rb

@@ -0,0 +1,11 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class AttributeWriter < AttributeAccessor
+
+      def macro
+        "attr_writer"
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-code-generator/dsl/autoload_statement.rb

@@ -0,0 +1,15 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class AutoloadStatement
+
+      include Dsl::CodeObject
+
+      def initialize(const_name, path)
+        @lines = ["autoload :#{const_name}, '#{path}'"]
+      end
+
+      attr_reader :lines
+
+    end
+  end
+end