brujula 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 627bde01017a2c5a99bb77c5888f7658675204c5
-  data.tar.gz: 09b0aa8cd8ef8373365e39215c72ac2caadaee6b
+  metadata.gz: 728af83883cc6088ff24fc157a824221a04668fe
+  data.tar.gz: bb27ac407bb64ef0840073ad168cc1abb30e0184
 SHA512:
-  metadata.gz: 56b5d1e7b3f629efc13cd78921795dd1d0ffd30383b42d209b62258453a12ba1c708662f6853196d9bbe7be6ae6e301b41f5f256fe57d85e6870f68a99ec690e
-  data.tar.gz: 3ab91bd63e736f10fae5fdd6e5c116dd177cf56a9a270c1b3e2da214f517b3a338db8adbd2f4ff09901d8926650eb4b1bb47d62a9b5e8f59997d3bb208132dab
+  metadata.gz: 146647cbd16918d460e3c036b8c886940488fddf4bc6cd9e2edddad732bc61612320fd925fe5c103eb4505b5103ebba629e753cd419d3d524d07d014a631b225
+  data.tar.gz: c531af198a63ffbeb311213b7cdb12c9e494b3332e5f8adefc1a158c91e056b6717b866c7fcf29a700f2b8cde6a359099de9e263934de249f53d48da1d3a6ac5

data/README.md

@@ -3,7 +3,7 @@ Brújula
 
 [![Build Status](https://travis-ci.org/nogates/brujula.svg?branch=master)](https://travis-ci.org/nogates/brujula)
 [![Code Climate](https://codeclimate.com/github/nogates/brujula/badges/gpa.svg)](https://codeclimate.com/github/nogates/brujula)
-[![Test Coverage](https://codeclimate.com/github/nogates/brujula/badges/coverage.svg)](https://codeclimate.com/github/nogates/brujula)
+[![Test Coverage](https://codeclimate.com/github/nogates/brujula/badges/coverage.svg)](https://codeclimate.com/github/nogates/brujula/coverage)
 
 _Yet another Ruby RAML parser aiming for version 1.0 fully support_
 
@@ -18,11 +18,11 @@ Install the gem `brujula` via your preferred method, and use `parse_file` to loa
 ```ruby
 require 'brujula'
 
-root = Brujula.parse_file('path/my_example_api.raml')
+raml = Brujula.parse_file('path/my_example_api.raml')
 
 # Alternatively
 
-raml = <<-RAML
+raml_string = <<-RAML
 # version 1.0
 title: 'My example API'
 /examples:
@@ -30,20 +30,20 @@ title: 'My example API'
 
 RAML
 
-root = Brujula.parse(raml)
+raml = Brujula.parse(raml_string)
 ```
 
 As expected, the properties of the root object can be accessed from the root object
 
 ```ruby
-root.title
+raml.root.title
 => 'My example API'
 ```
 
 Object collections, such as Resources, Methods or Security Schemes, inherits from `Brujula::MapObject`, which implements the `Enumerable` module. Thus, you can use any of this module's method to get collection objects.
 
 ```ruby
-root.resources.each_with_object([]) do |resource, resource_names|
+raml.root.resources.each_with_object([]) do |resource, resource_names|
   resource_names << resource.name
 end
 ```
@@ -51,7 +51,7 @@ end
 Alternatively, you can you use hash methods such as `[]` or `fetch` to get specific objects by its key name
 
 ```ruby
-root.resources['/examples']
+raml.root.resources['/examples']
 ```
 
 
@@ -61,4 +61,24 @@ Pull request are kindly requested. Specially in the form of RAML examples. If yo
 
 ## License
 
-See [LICENSE](https://raw.githubusercontent.com/lonelyplanet/brujula/master/LICENSE).
+The MIT License (MIT)
+
+Copyright (c) 2014 David
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/SPEC_SUPPORT.md

@@ -139,10 +139,10 @@ Feature | status | comments
 ---|---|---
 Query Parameters, Responses, and Headers collection mergin | :white_check_mark: |
 usage description | :white_check_mark: |
-Optional properties (`/^?/`) | :warning: | Needs testing and real examples
-Algorithm of Merging Traits With Methods | :warning: | Needs testing and real examples
-Parameters (both custom and reserved parameters) | :x: |
-Modifier functions | :x: |
+Optional properties (`/^?/`) | :white_check_mark: :warning: | Needs testing and real examples
+Algorithm of Merging Traits With Methods | :white_check_mark: :warning: | Needs testing and real examples
+Parameters (both custom and reserved parameters) | :white_check_mark: |
+Modifier functions | :white_check_mark: |
 
 
 * [Security Schemes](https://github.com/raml-org/raml-spec/blob/raml-10-rc2/versions/raml-10/raml-10.md#security-schemes)

data/lib/brujula.rb

@@ -6,6 +6,7 @@ require_relative 'brujula/initializers/yaml_include'
 
 require_relative 'brujula/object_parser'
 require_relative 'brujula/object_builder'
+require_relative 'brujula/referrer'
 require_relative 'brujula/scheme'
 require_relative 'brujula/raml'
 require_relative 'brujula/object'
@@ -14,6 +15,11 @@ require_relative 'brujula/key'
 require_relative 'brujula/basic_type'
 require_relative 'brujula/raml/exceptions'
 
+# parameters for trait and resource types
+require_relative 'brujula/parameters/transformer'
+require_relative 'brujula/parameters/parser'
+require_relative 'brujula/parameters/builder'
+
 # data transformers
 require_relative 'brujula/data_transformers/property_declaration'
 require_relative 'brujula/data_transformers/security_scheme_settings_declaration'

data/lib/brujula/mergers/merger.rb

@@ -11,17 +11,20 @@ module Brujula
       def call
         case
         when superinstance.is_a?(Brujula::MapObject)
-          MapObjectMerger.new(
-            instance: instance, superinstance: superinstance
-          ).call
+          MapObjectMerger.new(merger_options).call
         when superinstance.is_a?(Brujula::Object)
-          ObjectMerger.new(
-            instance: instance, superinstance: superinstance
-          ).call
+          ObjectMerger.new(merger_options).call
         else
           superinstance.dup
         end
       end
+
+      def merger_options
+        {
+          instance:      instance,
+          superinstance: superinstance
+        }
+      end
     end
   end
 end

data/lib/brujula/mergers/object_merger.rb

@@ -13,10 +13,10 @@ module Brujula
         instance.dup.tap do |object|
           each_inheritable_attributes do |name, attribute|
             original_item = object.instance_variable_get("@#{ name }")
-            thing = Merger.new(
+            merged_item   = Merger.new(
               instance: original_item, superinstance: attribute
             ).call
-            object.instance_variable_set("@#{ name }", thing)
+            object.instance_variable_set("@#{ name }", merged_item)
           end
         end
       end

data/lib/brujula/object_builder.rb

@@ -11,8 +11,7 @@ module Brujula
 
     def call
       return nil if key_data.nil?
-      return object_reference if is_object_reference?
-      return map_object_reference if is_map_object_reference?
+      return object_reference if key.referrable
 
       object_class.new(new_object_arguments).expand
     end
@@ -41,48 +40,16 @@ module Brujula
       end
     end
 
-    def ramelize_name
-      Inflecto.ramelize(key.expression.to_s)
-    end
-
-    def is_object_reference?
-      key.referrable? &&
-      key_data.is_a?(String) &&
-      object_class < Brujula::Object
-    end
-
-    def is_map_object_reference?
-      key.referrable? &&
-      key_data.is_a?(Array) &&
-      object_class == Brujula::MapObject
-    end
-
     def object_reference
-      case
-      when object_class == Brujula::Raml::V1_0::ResourceType
-        definition.root.resource_types.fetch(key_data)
-      else
-        raise "Invalid reference"
-      end
+      @object_reference ||= Brujula::Referrer.new(
+        name:       key.name,
+        data:       key_data,
+        definition: definition
+      ).call
     end
 
-    def map_object_reference
-      case
-      when key.expression == :secured_by
-        key_data.map do |security_scheme_ref|
-          if security_scheme_ref.nil? # NullSecuritySchema
-            Brujula::Raml::V1_0::NullSecuritySchema.new
-          else
-            definition.root.security_schemes.fetch(security_scheme_ref)
-          end
-        end
-      when key.expression == :is
-        key_data.map do |trait_ref|
-          definition.root.traits.fetch(trait_ref)
-        end
-      else
-        raise "Invalid reference"
-      end
+    def ramelize_name
+      Inflecto.ramelize(key.expression.to_s)
     end
 
     def object_class

data/lib/brujula/parameters/builder.rb

@@ -0,0 +1,51 @@
+module Brujula
+  module Parameters
+    class Builder
+
+      attr_reader :object
+
+      def initialize(object:)
+        @object  = object
+      end
+
+      def resource_params(resource)
+        object_parameters.merge(resource_parameters(resource))
+      end
+
+      def method_params(resource, method)
+        object_parameters.merge(
+          resource_parameters(resource)
+        ).merge(
+          method_parameters(method)
+        )
+      end
+
+      private
+
+      def object_parameters
+        object.instance_variable_get("@parameters") || {}
+      end
+
+      def method_parameters(method)
+        {
+          "methodName" => method.name,
+        }
+      end
+
+      def resource_parameters(resource)
+        {
+          "resourcePath"     => resource_path(resource),
+          "resourcePathName" => resource_path_name(resource)
+        }
+      end
+
+      def resource_path(resource)
+        resource.name
+      end
+
+      def resource_path_name(resource)
+        resource.name.split('/').last.gsub(/[\{\}]/, "")
+      end
+    end
+  end
+end

data/lib/brujula/parameters/parser.rb

@@ -0,0 +1,72 @@
+module Brujula
+  module Parameters
+    class Parser
+      attr_reader :object, :parameters
+
+      def initialize(object:, parameters:)
+        @object     = object
+        @parameters = parameters
+      end
+
+      def call
+        parametize(object)
+      end
+
+      private
+
+      def parametize(extend_object)
+        extend_object.dup.tap do |definition|
+          applicable_attributes(definition).each do |attribute|
+            property          = definition.instance_variable_get(attribute)
+            extended_property = parse_attribute(property)
+
+            definition.instance_variable_set(attribute, extended_property)
+          end
+        end
+      end
+
+      def parse_attribute(definition)
+        case
+        when definition.is_a?(Brujula::Object)
+          parametize(definition)
+        when definition.is_a?(Brujula::MapObject)
+          parametize_map_object(definition)
+        when definition.is_a?(::String)
+          parametize_string(definition)
+        else
+          definition
+        end
+      end
+
+      def parametize_map_object(definition)
+        definition.dup.tap do |map_object|
+          items = map_object.instance_variable_get("@collection")
+          items = items.each_with_object({}) do |(name, item), collection|
+            collection.merge!(parametize_string(name) => parametize(item))
+          end
+          map_object.instance_variable_set("@collection", items)
+        end
+      end
+
+      def parametize_string(string)
+        string.gsub(/<<(.*?)>>/) do |expression|
+          parameter_transformer.call(expression)
+        end
+      end
+
+      def parameter_transformer
+        @parameter_transformer = Brujula::Parameters::Transformer.new(
+          parameters: parameters
+        )
+      end
+
+      def applicable_attributes(object)
+        object.instance_variables - excluded_attributes
+      end
+
+      def excluded_attributes
+        %i( @parent @parameters )
+      end
+    end
+  end
+end

data/lib/brujula/parameters/transformer.rb

@@ -0,0 +1,92 @@
+module Brujula
+  module Parameters
+    class Transformer
+
+      attr_reader :parameters
+
+      def initialize(parameters:)
+        @parameters = parameters
+      end
+
+      def call(string)
+        content = string.match(/<<(.*?)>>/)[1]
+
+        apply_functions(content)
+      end
+
+      private
+
+      def apply_functions(string)
+        value, function_names = extract_functions(string)
+
+        return value if function_names.empty?
+
+        function_names.inject(value) do |result, function|
+          call_function(result, function)
+        end
+      end
+
+      def call_function(value, function)
+        function_ref = get_function_name(function)
+
+        send function_ref, value
+      end
+
+      def extract_functions(string)
+        expression_chain = string.split('|')
+        parameter_name   = expression_chain.first.strip
+        value            = parameters.fetch(parameter_name)
+
+        [ value, expression_chain[1..-1].map(&:strip) ]
+      end
+
+      def get_function_name(function)
+        name = Inflecto.underscore(function).gsub(/^!/, '').to_sym
+
+        return name if private_methods.include?(name)
+
+        raise "Invalid trasformer function #{ function }"
+      end
+
+      def singularize(string)
+        Inflecto.singularize(string)
+      end
+
+      def pluralize(string)
+        Inflecto.pluralize(string)
+      end
+
+      def uppercase(string)
+        string.upcase
+      end
+
+      def lowercase(string)
+        string.downcase
+      end
+
+      def lowercamelcase(string)
+        Inflecto.ramelize(string)
+      end
+
+      def uppercamelcase(string)
+        Inflecto.camelize(string)
+      end
+
+      def lowerunderscorecase(string)
+        Inflecto.underscore(string)
+      end
+
+      def upperunderscorecase(string)
+        Inflecto.underscore(string).upcase
+      end
+
+      def lowerhyphencase(string)
+        Inflecto.dasherize(Inflecto.underscore(string)).downcase
+      end
+
+      def upperhyphencase(string)
+        Inflecto.dasherize(Inflecto.underscore(string)).upcase
+      end
+    end
+  end
+end

data/lib/brujula/referrer.rb

@@ -0,0 +1,71 @@
+module Brujula
+  class Referrer
+
+    attr_reader :name, :definition, :data
+
+    def initialize(name:, definition:, data:)
+      @name       = name
+      @definition = definition
+      @data       = data
+    end
+
+    def call
+      object_to_reference(data)
+    end
+
+    private
+
+    def object_to_reference(reference)
+      case reference
+      when String
+        string_reference(reference)
+      when Array
+        map_object_reference(reference)
+      when Hash
+        object_reference(reference)
+      when NilClass
+        nil_reference(reference)
+      else
+        raise "Invalid reference"
+      end
+    end
+
+    def map_object_reference(reference)
+      data.each_with_object([]) do |reference, collection|
+        collection << object_to_reference(reference)
+      end
+    end
+
+    def object_reference(reference_hash) # TODO validate parameters name
+      reference, params = reference_hash.first
+
+      string_reference(reference).tap do |object|
+        parameters = object.instance_variable_get("@parameters") || {}
+        parameters.merge!(params)
+        object.instance_variable_set("@parameters", parameters)
+      end
+    end
+
+    def nil_reference(reference)
+      case name
+      when "secured_by"
+        Brujula::Raml::V1_0::NullSecuritySchema.new
+      else
+        raise "The reference from key #{ key } cannot be nil"
+      end
+    end
+
+    def string_reference(reference)
+      case name
+      when "secured_by"
+        definition.root.security_schemes.fetch(reference)
+      when "type"
+        definition.root.resource_types.fetch(reference)
+      when "is"
+        definition.root.traits.fetch(reference)
+      else
+        raise "Invalid reference"
+      end.dup
+    end
+  end
+end

data/lib/brujula/type_extender/method.rb

@@ -1,6 +1,7 @@
 module Brujula
   module TypeExtender
     class Method
+
       attr_reader :definition
 
       def initialize(definition:)
@@ -20,10 +21,27 @@ module Brujula
       def apply_inherit_chain
         definition.is.inject(definition.dup) do |object, trait|
           Brujula::Mergers::ObjectMerger.new(
-            superinstance: trait, instance: object
+            superinstance: parametized_trait(trait), instance: object
           ).call
         end
       end
+
+      def parametized_trait(trait)
+        Brujula::Parameters::Parser.new(
+          object:     trait,
+          parameters: parameter_builder(trait).method_params(resource, definition)
+        ).call
+      end
+
+      def parameter_builder(object)
+        Brujula::Parameters::Builder.new(
+          object: object
+        )
+      end
+
+      def resource
+        definition.parent.parent
+      end
     end
   end
 end

data/lib/brujula/type_extender/resource.rb

@@ -26,7 +26,8 @@ module Brujula
 
       def apply_type(object)
         Brujula::Mergers::ObjectMerger.new(
-          superinstance: definition.type, instance: object
+          superinstance: parametized_type,
+          instance:      object,
         ).call
       end
 
@@ -43,10 +44,30 @@ module Brujula
       def apply_traits_to_method(method)
         definition.is.inject(method.dup) do |object, trait|
           Brujula::Mergers::ObjectMerger.new(
-            superinstance: trait, instance: object
+            superinstance: parametized_trait(trait, object), instance: object
           ).call
         end
       end
+
+      def parametized_trait(trait, method)
+        Brujula::Parameters::Parser.new(
+          object:     trait,
+          parameters: parameter_builder(trait).method_params(definition, method)
+        ).call
+      end
+
+      def parametized_type
+        Brujula::Parameters::Parser.new(
+          object:     definition.type,
+          parameters: parameter_builder(definition.type).resource_params(definition)
+        ).call
+      end
+
+      def parameter_builder(object)
+        Brujula::Parameters::Builder.new(
+          object: object
+        )
+      end
     end
   end
 end

data/lib/brujula/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brujula
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - David Tapiador
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -164,6 +164,9 @@ files:
 - lib/brujula/object.rb
 - lib/brujula/object_builder.rb
 - lib/brujula/object_parser.rb
+- lib/brujula/parameters/builder.rb
+- lib/brujula/parameters/parser.rb
+- lib/brujula/parameters/transformer.rb
 - lib/brujula/raml.rb
 - lib/brujula/raml/definition.rb
 - lib/brujula/raml/exceptions.rb
@@ -190,7 +193,9 @@ files:
 - lib/brujula/raml/v1_0/trait.rb
 - lib/brujula/raml/v1_0/uri_parameter.rb
 - lib/brujula/raml/v1_0/uri_template.rb
+- lib/brujula/referrer.rb
 - lib/brujula/scheme.rb
+- lib/brujula/transformer_functions.rb
 - lib/brujula/type_extender/method.rb
 - lib/brujula/type_extender/resource.rb
 - lib/brujula/type_extender/resource_type.rb