aws-sdk-code-generator 0.1.0.pre

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

@@ -0,0 +1,167 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class Module < Dsl::Main
+
+      include Dsl::CodeObject
+
+      # @option options [Main, Module] :parent (nil)
+      def initialize(name, options = {}, &block)
+        @name = name
+        @code_objects = []
+        @access = :public
+        @parent = options.fetch(:parent, nil)
+        @docstring = Dsl::Docstring.new(nil)
+        yield(self) if block
+      end
+
+      attr_reader :name
+
+      def add(*code_objects)
+        code_objects.each do |code_object|
+          if Dsl::Method === code_object && code_object.access != @access
+            add(AccessControlStatement.new(code_object.access))
+          elsif Dsl::AccessControlStatement === code_object
+            @access = code_object.access
+          end
+          super(code_object)
+        end
+      end
+
+      def require_statement(path)
+        root.require(path)
+      end
+      alias require require_statement
+
+      def docstring(docstring = nil)
+        @docstring ||= Dsl::Docstring.new
+        @docstring.append(docstring) unless docstring.nil?
+        @docstring
+      end
+
+      def require_relative(path)
+        root.require_relative(path)
+      end
+
+      def constructor(options = {}, &block)
+        method(:initialize, options, &block)
+      end
+
+      def attr_accessor(name, options = {}, &block)
+        a = Dsl::AttributeAccessor.new(name, options)
+        yield(a) if block
+        add(a)
+      end
+
+      def autoload(const_name, path)
+        @code_objects << AutoloadStatement.new(const_name, path)
+      end
+
+      def attr_reader(name, options = {}, &block)
+        a = Dsl::AttributeReader.new(name, options)
+        yield(a) if block
+        add(a)
+      end
+
+      def attr_writer(name, &block)
+        a = Dsl::AttributeWriter.new(name)
+        yield(a) if block
+        add(a)
+      end
+
+      def eigenclass(&block)
+        m = Dsl::Eigenclass.new
+        yield(m) if block
+        add(m)
+      end
+
+      def lines
+        code = []
+        code.concat(@docstring.lines)
+        code += open_module
+        code << :newline if padded?(0)
+
+        @code_objects.each.with_index do |code_object, n|
+          code << code_object.lines
+          code << :newline if separator?(n)
+        end
+
+        if @code_objects.empty?
+          code[-1] += "; end"
+        else
+          code += close_module
+        end
+        code
+      end
+
+      private
+
+      def open_module
+        ["module #{@name}"]
+      end
+
+      def close_module
+        ["end"]
+      end
+
+      def padded?(n)
+        !@code_objects[n].kind_of?(Dsl::Module) &&
+        !(
+          @code_objects.all? { |obj| autoload_statement?(obj) } ||
+          @code_objects.all? { |obj| mixin?(obj) } ||
+          @code_objects.all? { |obj| undocumented_attr_macro?(obj) }
+        )
+      end
+
+      def separator?(n)
+        if last?(n)
+          padded?(@code_objects.size - 1)
+        elsif grouped_statements?(n)
+          false
+        else
+          true
+        end
+      end
+
+      def last?(n)
+        @code_objects.size == n + 1
+      end
+
+      def grouped_statements?(n)
+        two_autoloads?(n) ||
+        two_mixins?(n) ||
+        two_undocumented_attr_macros?(n)
+      end
+
+      def two_autoloads?(n)
+        @code_objects[n + 1] &&
+        autoload_statement?(@code_objects[n + 1]) &&
+        autoload_statement?(@code_objects[n])
+      end
+
+      def two_mixins?(n)
+        @code_objects[n + 1] &&
+        mixin?(@code_objects[n + 1]) &&
+        mixin?(@code_objects[n])
+      end
+
+      def two_undocumented_attr_macros?(n)
+        @code_objects[n + 1] &&
+        undocumented_attr_macro?(@code_objects[n + 1]) &&
+        undocumented_attr_macro?(@code_objects[n])
+      end
+
+      def autoload_statement?(code_object)
+        Dsl::AutoloadStatement === code_object
+      end
+
+      def mixin?(code_object)
+        Dsl::IncludeStatement === code_object
+      end
+
+      def undocumented_attr_macro?(code_object)
+        Dsl::AttributeAccessor === code_object && !code_object.documented?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class OptionTag
+
+      # @option options [required, String] :name
+      # @option options [required, String] :type
+      # @option options [String] :param ('options')
+      # @option options [Boolean] :required (false)
+      # @option options [String, nil] :docstring (nil)
+      # @option options [Object] :default
+      def initialize(options)
+        @name = options.fetch(:name)
+        @type = options.fetch(:type)
+        @param = options.fetch(:param, 'options')
+        @required = options.fetch(:required, false) ? 'required, ' : ''
+        @docstring = Dsl::TagDocstring.new(options.fetch(:docstring, nil))
+        @default = Dsl::TagDefault.new(options.fetch(:default, nil))
+      end
+
+      def lines
+        [first_line] + @docstring.lines
+      end
+
+      private
+
+      def first_line
+        "# @option #{@param} [#{@required}#{@type}] :#{@name}#{yard_default}"
+      end
+
+      def yard_default
+        @default.empty? ? '' : " (#{@default})"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    class Param
+
+      # @option options [String] :type
+      # @option options [Object] :default
+      # @option options [String] :docstring
+      # @option options [Boolean] :documented (true)
+      def initialize(name, options = {})
+        @name = name.to_s
+        @type = TagType.new(options.fetch(:type, nil))
+        @default = TagDefault.new(options.fetch(:default, nil))
+        @docstring = TagDocstring.new(options.fetch(:docstring, nil))
+        @documented = options.fetch(:documented, true)
+      end
+
+      attr_reader :name, :default
+
+      def documented?
+        !!@documented
+      end
+
+      def tag
+        if [@type, @default, @docstring].all?(&:empty?)
+          []
+        else
+          [first_line] + @docstring.lines
+        end
+      end
+
+      private
+
+      def first_line
+        "# @param#{@type} #{@name}#{yard_default}"
+      end
+
+      def yard_default
+        @default.empty? ? '' : " (#{@default})"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    # @api private
+    class ParamList
+
+      def initialize(params)
+        @params = params
+      end
+
+      def signature
+        if @params.empty?
+          nil
+        else
+          "(#{@params.map { |p| param_signature(p) }.join(', ')})"
+        end
+      end
+
+      def tags
+        lines = []
+        @params.each do |param|
+          lines.concat(param.tag) if param.documented?
+        end
+        lines
+      end
+
+      private
+
+      def param_signature(param)
+        if param.default.empty?
+          param.name
+        else
+          "#{param.name} = #{param.default}"
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    # @api private
+    class ReturnTag
+
+      # @option options [required, String] :type
+      # @option options [String] :docstring
+      def initialize(options)
+        @type = Dsl::TagType.new(options.fetch(:type))
+        @docstring = Dsl::TagDocstring.new(options.fetch(:docstring, nil))
+      end
+
+      def lines
+        ["# @return#{@type}"] + @docstring.lines
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    # @api private
+    class TagDefault
+
+      def initialize(default)
+        @default = default
+      end
+
+      def to_s
+        @default.inspect
+      end
+
+      def empty?
+        @default.nil?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    # @api private
+    class TagDocstring
+
+      def initialize(docstring)
+        @lines = docstring.to_s.strip.lines.inject([]) do |lines, line|
+          line = line.rstrip
+          if line.empty?
+            lines << "#"
+          else
+            lines << "#   #{line.rstrip}"
+          end
+        end
+      end
+
+      # @return Array<String>
+      attr_reader :lines
+
+      # @return [Boolean]
+      def empty?
+        @lines.empty?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module AwsSdkCodeGenerator
+  module Dsl
+    # @api private
+    class TagType < String
+
+      def self.new(type)
+        if type
+          types = Array(type)
+          types = types.map { |t| t.nil? ? 'nil' : t.to_s }
+          super(types.empty? ? '' : " [#{types.join(', ')}]")
+        else
+          super('')
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module AwsSdkCodeGenerator
+  module Errors
+
+    # Raised when generating resource classes that attempt to redefine
+    # a method. This can happen when any of the following have the
+    # same name:
+    #
+    # * attributes (as defined in the resource shape members)
+    # * actions
+    # * has associations
+    # * has many associations
+    # * waiters
+    # * batch actions
+    #
+    # Additionally this can happen if the resource attempts to
+    # redefine methods from Ruby Object.
+    class ResourceMethodConflict < RuntimeError
+
+      # @option options [required, String] :resource_name
+      # @option options [required, String] :method_name
+      def initialize(options)
+        resource_name = options.fetch(:resource_name)
+        method_name = options.fetch(:method_name)
+        super("#{resource_name} is attempting to redefine ##{method_name}")
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,71 @@
+module AwsSdkCodeGenerator
+  class GemBuilder
+
+    # @param [Hash] options
+    # @option options [required, Service] :service
+    def initialize(options)
+      @options = options
+      @service = options.fetch(:service)
+    end
+
+    # @return [Hash]
+    attr_reader :options
+
+    def each(&block)
+      Enumerator.new do |y|
+        y.yield(gemspec_path, gemspec_file)
+        y.yield(features_env_path, features_env_file)
+        y.yield(features_step_definitions_path, features_step_definitions_file)
+        y.yield(spec_helper_path, spec_helper_file)
+        y.yield(version_path, version_file)
+        code = CodeBuilder.new(@options)
+        code.source_files(prefix: @service.gem_name).each do |path, code|
+          y.yield("lib/#{path}", code)
+        end
+      end.each(&block)
+    end
+
+    private
+
+    def gemspec_path
+      "#{@service.gem_name}.gemspec"
+    end
+
+    def gemspec_file
+      Views::Gemspec.new(options).render
+    end
+
+    def features_env_path
+      'features/env.rb'
+    end
+
+    def features_env_file
+      Views::Features::Env.new(options).render
+    end
+
+    def features_step_definitions_path
+      'features/step_definitions.rb'
+    end
+
+    def features_step_definitions_file
+      Views::Features::StepDefinitions.new(options).render
+    end
+
+    def spec_helper_path
+      'spec/spec_helper.rb'
+    end
+
+    def spec_helper_file
+      Views::Spec::SpecHelper.new(options).render
+    end
+
+    def version_path
+      'VERSION'
+    end
+
+    def version_file
+      Views::Version.new(options).render
+    end
+
+  end
+end