brujula 0.0.1

data/lib/brujula/raml/v1_0/resource_type.rb

@@ -0,0 +1,15 @@
+module Brujula
+  module Raml
+    module V1_0
+      class ResourceType < Brujula::Object
+        scheme do
+          key :display_name, as: :string
+          key :description, as: :markdown
+          key /^(get|patch|put|post|delete|options|header)[?]*$/,
+              as: :map_object, children: :method, accessor: :methods
+          key :type, as: :string
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/response.rb

@@ -0,0 +1,16 @@
+module Brujula
+  module Raml
+    module V1_0
+      class Response < Brujula::Object
+        scheme do
+          key :display_name, as: :string
+          key :description, as: :markdown
+          key :headers, as: :map_object, children: :header,
+              data_transformer: :property_declaration
+          key :body, as: :map_object, children: :body,
+              data_transformer: :body_declaration
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/root.rb

@@ -0,0 +1,30 @@
+module Brujula
+  module Raml
+    module V1_0
+      class Root < Brujula::Object
+        scheme do
+          key :title, as: :string
+          key :description, as: :markdown
+          key :version, as: :string
+          key :base_uri, as: :uri_template
+          key :base_uri_parameters, as: :query_parameter
+          key :media_type, as: :media_type
+          key :security_schemes, as: :map_object, children: :security_scheme
+          key :secured_by, as: :map_object, referrable: true
+          key :protocols, as: :map_object, children: :string
+          key :types, as: :map_object, children: :raml_type
+          key :resource_types, as: :map_object, children: :resource_type
+          key :traits, as: :map_object, children: :trait
+          key /^\/(.*)/, as: :map_object, children: :resource, accessor: :resources
+        end
+
+        attr_reader :base_dir
+
+        def initialize(data:, name:, base_dir:)
+          @base_dir = base_dir
+          super(data: data, name: name)
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/security_scheme.rb

@@ -0,0 +1,15 @@
+module Brujula
+  module Raml
+    module V1_0
+      class SecurityScheme < Brujula::Object
+        scheme do
+          key :type, as: :string, required: true
+          key :description, as: :markdown
+          key :described_by, as: :security_scheme_part
+          key :settings, as: :security_scheme_settings,
+              data_transformer: :security_scheme_settings_declaration
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/security_scheme_part.rb

@@ -0,0 +1,18 @@
+module Brujula
+  module Raml
+    module V1_0
+      class SecuritySchemePart < Brujula::Object
+        scheme do
+          key :display_name, as: :string
+          key :description, as: :markdown
+          key :responses, as: :map_object, children: :response
+          key :headers, as: :map_object, children: :header,
+              data_transformer: :property_declaration
+          key :query_parameters, as: :map_object, children: :query_parameter,
+              data_transformer: :property_declaration
+          key :query_string, as: :string
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/security_scheme_settings.rb

@@ -0,0 +1,24 @@
+module Brujula
+  module Raml
+    module V1_0
+      class SecuritySchemeSettings < Brujula::Object
+        scheme typed: true do
+          key :type,   as: :string
+
+          # When security scheme is OAuth 1.0
+          key :request_token_uri, as: :string, for_types: [ 'OAuth 1.0' ]
+          key :token_credentials_uri, as: :string, for_types: [ 'OAuth 1.0' ]
+
+          # When security scheme is OAuth 2.0
+          key :access_token_uri, as: :string, for_types: [ 'OAuth 2.0' ]
+          key :authorization_uri, as: :string, for_types: [ 'OAuth 2.0' ]
+          key :authorization_grants, as: :array, for_types: [ 'OAuth 2.0' ]
+          key :scopes, as: :array, for_types: [ 'OAuth 2.0' ]
+
+          # When security scheme is either OAuth 1.0
+          key :authorization_uri, as: :string, for_types: [ 'OAuth 1.0', 'OAuth 2.0' ]
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/string.rb

@@ -0,0 +1,8 @@
+module Brujula
+  module Raml
+    module V1_0
+      class String < ::String
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/trait.rb

@@ -0,0 +1,17 @@
+module Brujula
+  module Raml
+    module V1_0
+      class Trait < Brujula::Object
+        scheme do
+          key :usage, as: :markdown
+          key :description, as: :markdown
+          # key :parameters
+          key :query_parameters, as: :map_object, children: :query_parameter
+          key :headers, as: :map_object, children: :header,
+              data_transformer: :property_declaration
+          key :responses, as: :map_object, children: :response
+        end
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/uri_parameter.rb

@@ -0,0 +1,9 @@
+module Brujula
+  module Raml
+    module V1_0
+      class UriParameter < Brujula::Object
+        scheme as: :property
+      end
+    end
+  end
+end

data/lib/brujula/raml/v1_0/uri_template.rb

@@ -0,0 +1,8 @@
+module Brujula
+  module Raml
+    module V1_0
+      class UriTemplate < String
+      end
+    end
+  end
+end

data/lib/brujula/scheme.rb

@@ -0,0 +1,77 @@
+module Brujula
+  class Scheme
+    attr_reader :keys, :typed, :default_type, :reference,
+                :store_for_reference, :allow_any
+
+    alias :typed? :typed
+    alias :store_object_for_reference? :store_for_reference
+    alias :allow_any? :allow_any
+
+    def initialize(klass, options = {}, block = nil)
+      @klass               = klass
+      @options             = options
+      @keys                = {}
+      @typed               = !!options[:typed]
+      @default_type        = options[:default_type] || :string
+      @store_for_reference = !!options[:store_for_reference]
+      @allow_any           = !!options[:allow_any]
+
+      if options[:as]
+        block = Brujula::Raml::V1_0.const_get(
+          Inflecto.camelize(options[:as])
+        ).block
+      end
+
+      instance_exec(&block)
+    end
+
+    def key_collection
+      @keys.values
+    end
+
+    def validate_data!(data)
+      valid_keys?(data) || raise(Brujula::Raml::RequiredProperty) # && enough_data?(data))
+    end
+
+    def typed_keys(type)
+      keys.values.select do |brujula_key|
+        brujula_key.valid_for_type?(type)
+      end
+    end
+
+    private
+
+    attr_reader :klass
+
+    def key(name, options = {})
+      store_key(name, options)
+    end
+
+    def valid_keys?(data)
+      (ramelized_required_keys - data.keys).empty?
+    end
+
+    def ramelized_required_keys
+      @ramelized_required_keys ||= keys_for_type.values
+        .select(&:required?).select(&:fixed?)
+        .map { |object| ramelize_key(object.expression) }
+    end
+
+    def keys_for_type
+      return keys unless typed
+
+      keys.select { |key| key.include_in_type?() }
+    end
+
+    def ramelize_key(key)
+      Inflecto.ramelize(key.to_s)
+    end
+
+    def store_key(name, options)
+      key = Brujula::Key.new(name, options)
+      klass.class_eval { attr_reader key.accessor_name }
+
+      @keys.merge!(key.accessor_name => key)
+    end
+  end
+end

data/lib/brujula/type_extender/method.rb

@@ -0,0 +1,29 @@
+module Brujula
+  module TypeExtender
+    class Method
+      attr_reader :definition
+
+      def initialize(definition:)
+        @definition = definition
+      end
+
+      def call
+        return definition if definition.is.nil?
+
+        extended_object
+      end
+
+      def extended_object
+        @extended_object ||= apply_inherit_chain
+      end
+
+      def apply_inherit_chain
+        definition.is.inject(definition.dup) do |object, trait|
+          Brujula::Mergers::ObjectMerger.new(
+            superinstance: trait, instance: object
+          ).call
+        end
+      end
+    end
+  end
+end

data/lib/brujula/type_extender/resource.rb

@@ -0,0 +1,52 @@
+module Brujula
+  module TypeExtender
+    class Resource
+      attr_reader :definition
+
+      def initialize(definition:)
+        @definition = definition
+      end
+
+      def call
+        return definition if definition.type.nil? && definition.is.nil?
+
+        extended_object
+      end
+
+      def extended_object
+        @extended_object ||= apply_inherit_chain
+      end
+
+      def apply_inherit_chain
+        object = definition.dup
+        object = apply_type(object) unless definition.type.nil?
+        object = apply_traits(object) unless definition.is.nil?
+        object
+      end
+
+      def apply_type(object)
+        Brujula::Mergers::ObjectMerger.new(
+          superinstance: definition.type, instance: object
+        ).call
+      end
+
+      def apply_traits(object)
+        return object if definition.methods.nil?
+
+        object.methods.each do |method|
+          new_method = apply_traits_to_method(method)
+          object.methods.merge(new_method.name, new_method)
+        end
+        object
+      end
+
+      def apply_traits_to_method(method)
+        definition.is.inject(method.dup) do |object, trait|
+          Brujula::Mergers::ObjectMerger.new(
+            superinstance: trait, instance: object
+          ).call
+        end
+      end
+    end
+  end
+end

data/lib/brujula/type_extender/resource_type.rb

@@ -0,0 +1,36 @@
+module Brujula
+  module TypeExtender
+    class ResourceType
+      attr_reader :definition
+
+      def initialize(definition:)
+        @definition = definition
+      end
+
+      def call
+        return definition if definition.type.nil?
+
+        extended_object
+      end
+
+      def parent_definition
+        if within_root_resource_types?  # maybe its not preload
+          definition.parent.fetch(definition.type)
+        else
+          definition.root.resource_types.fetch(definition.type)
+        end
+      end
+
+      def extended_object
+        @extended_object ||= Brujula::Mergers::ObjectMerger.new(
+          superinstance: parent_definition, instance: definition
+        ).call
+      end
+
+      def within_root_resource_types?
+        definition.parent.is_a?(Brujula::MapObject) &&
+        definition.parent.parent.is_a?(Brujula::Raml::V1_0::Root)
+      end
+    end
+  end
+end

data/lib/brujula/version.rb

@@ -0,0 +1,3 @@
+module Brujula
+  VERSION = "0.0.1"
+end

data/lib/brujula/yaml_parser.rb

@@ -0,0 +1,67 @@
+# TODO
+require 'psych'
+
+# `stolen` from:
+# http://stackoverflow.com/questions/29462856/loading-yaml-with-line-number-for-each-key
+
+class Psych::Nodes::Node
+  attr_accessor :_brujula_line
+end
+
+class Psych::Visitors::ToRuby
+  def revive_hash hash, o
+    o.children.each_slice(2) { |k,v|
+      key = accept(k)
+      val = accept(v)
+
+      # TODO
+      # This is not working because instead of returning a `val`, which could
+      # be an string for example, it's returning a hash
+      # Actually, I am not really interested in adding the line number to
+      # object values. I am only interested in adding the lines to the object
+      # itself, probably, as some kind of raml anotation, so it could be used
+      # as another anotated property, and thus, displayed in the documentation
+      # TODO
+
+      if v.is_a? ::Psych::Nodes::Scalar
+        val = { "value" => val, "_brujula_line" => v._brujula_line + 1} # line is 0 based, so + 1
+      end
+
+      # Code dealing with << (for merging hashes) omitted.
+      # If you need this you will probably need to copy it
+      # in here. See the method:
+      # https://github.com/tenderlove/psych/blob/v2.0.13/lib/psych/visitors/to_ruby.rb#L333-L365
+
+      hash[key] = val
+    }
+    hash
+  end
+end
+
+module Brujula
+  class LineNumberHandler < Psych::TreeBuilder
+    attr_accessor :parser
+
+    def scalar value, anchor, tag, plain, quoted, style
+      mark = parser.mark
+      s = super
+      s._brujula_line = mark.line
+      s
+    end
+  end
+
+  class YamlParser
+    class << self
+      def load(string)
+       handler = Brujula::LineNumberHandler.new
+       parser  = Psych::Parser.new(handler)
+
+       handler.parser = parser
+
+       parser.parse string
+
+       handler.root.to_ruby.first
+      end
+    end
+  end
+end