raml-rb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c055a6b5ac11a427a84bf58f3dd22d1d366c91d
-  data.tar.gz: efeb25b9f8bb5004c9f5f65d50264285739c1bee
+  metadata.gz: f32149c287b8afb783fe1e9505634c1d913d0a5e
+  data.tar.gz: c4cff4f2e32605588cd5495eb72509cef3387b1c
 SHA512:
-  metadata.gz: 0ceb137a50546a1a0ebbd5cdd3b30f3f62214cf46dc3084a5da2bdc3717b042c49a45b584e483089f64db07c5941a26425d1471e2535cf6facf92a86e3879687
-  data.tar.gz: 561a64c167180a4b151e644692730197c0b565c1d76342387e269a0c341c839ce189734eb14e28eb565cd55f9372dc23add0764ce069d62d49bf92785844ea56
+  metadata.gz: c88c819e3af6f4b49c1e13cb9dac144f0be1f0c999bc6502638e7e2bc100088d1cc2fc40d66ae2850bb1c6163646ebbf32c41320bcf8da0cec9c4bbd1c7c9bbb
+  data.tar.gz: 77596856bd5b3383fb42e33761b2708d78bd634b7ea228f4c1940bd2e00e7a63b145c9cdbfeb0f66291030e08b7f8263ba9ffb8b82beaf78ff57ab3f8f2e2aec

data/README.md

@@ -2,18 +2,25 @@
 
 A RAML parser, implemented in Ruby.
 
-## Usage
+## Installation
 
 ```
+gem install raml-rb
+```
+
+## Usage
+
+```Ruby
 raml = Raml::Parser.parse("#%RAML 0.8\ntitle: World Music API\nbaseUri: http://example.api.com/{version}")
-raml = Rank::Parser.parse_file('path/to/file.raml')
+raml = Raml::Parser.parse_file('path/to/file.raml')
 ```
 
 ## Todo
 
 0. Parameters for Resource Types and Traits.
 0. Ensure all attributes are supported.
-0. Add documentation generator.
+0. Documentation generator.
+0. RAML file generator.
 
 ## Author
 

data/lib/core_ext/hash.rb

@@ -0,0 +1,6 @@
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_, left, right| left.is_a?(Hash) && right.is_a?(Hash) ? left.merge(right, &merger) : right }
+    self.merge(second, &merger)
+  end
+end

data/lib/raml/body.rb

@@ -1,9 +1,9 @@
 module Raml
   class Body
-    attr_accessor :type, :schema
+    attr_accessor :content_type, :schema
 
-    def initialize(type)
-      @type = type
+    def initialize(content_type)
+      @content_type = content_type
     end
 
   end

data/lib/raml/method.rb

@@ -9,5 +9,21 @@ module Raml
       @query_parameters = []
     end
 
+    def response_codes
+      [].tap do |codes|
+        responses.each do |response|
+          codes << response.code
+        end
+      end
+    end
+
+    def content_types
+      [].tap do |types|
+        responses.each do |response|
+          types << response.content_types
+        end
+      end.flatten.uniq
+    end
+
   end
 end

data/lib/raml/parser.rb

@@ -9,13 +9,26 @@ require 'raml/parser/query_parameter'
 module Raml
   class Parser
 
+    def initialize
+      Psych.add_domain_type 'include', 'include' do |_, value|
+        File.read(value)
+      end
+    end
+
     def parse(yaml)
       raml = YAML.load(yaml)
       Raml::Parser::Root.new.parse(raml)
     end
 
     def parse_file(path)
-      parse File.read(path)
+      # Change directories so that relative file !includes work properly
+      wd = Dir.pwd
+      Dir.chdir File.dirname(path)
+
+      raml = parse File.read(File.basename(path))
+
+      Dir.chdir wd
+      raml
     end
 
     def self.parse(yaml)

data/lib/raml/parser/method.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'core_ext/hash'
 require 'raml/method'
 require 'raml/parser/response'
 require 'raml/parser/query_parameter'
@@ -25,6 +26,7 @@ module Raml
         @attributes = prepare_attributes(attributes)
 
         apply_parents_traits
+        apply_traits
         parse_attributes
 
         method
@@ -32,13 +34,11 @@ module Raml
 
       private
 
-        def parse_attributes(attributes = @attributes)
+        def parse_attributes
           attributes.each do |key, value|
             case key
             when *BASIC_ATTRIBUTES
               method.send("#{key}=".to_sym, value)
-            when 'is'
-              apply_traits(value)
             when 'responses'
               parse_responses(value)
             when 'query_parameters'
@@ -62,19 +62,23 @@ module Raml
         end
 
         def apply_parents_traits
-          apply_traits(parent.trait_names) if !parent.trait_names.nil? && parent.trait_names.length
+          parent.trait_names.each do |name|
+            apply_trait(name)
+          end if parent.trait_names.respond_to?(:each)
         end
 
-        def apply_traits(names)
-          names.each do |name|
+        def apply_traits
+          attributes['is'].each do |name|
             apply_trait(name)
-          end
+          end if attributes['is'].respond_to?(:each)
+
+          attributes.delete('is')
         end
 
         def apply_trait(name)
           unless traits[name].nil?
             trait_attributes = prepare_attributes(traits[name])
-            parse_attributes(trait_attributes)
+            @attributes = trait_attributes.deep_merge(attributes)
           end
         end
 

data/lib/raml/parser/resource.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'core_ext/hash'
 require 'raml/resource'
 require 'raml/parser/method'
 require 'raml/parser/util'
@@ -24,13 +25,14 @@ module Raml
         @parent_node = parent_node
         @resource = Raml::Resource.new(@parent_node, uri_partial)
         @attributes = prepare_attributes(attributes)
+        apply_resource_type
         parse_attributes
         resource
       end
 
       private
 
-        def parse_attributes(attributes = @attributes)
+        def parse_attributes
           attributes.each do |key, value|
             key = underscore(key)
             case key
@@ -38,8 +40,6 @@ module Raml
               resources << Raml::Parser::Resource.new(self).parse(resource, key, value)
             when *METHODS
               resource.methods << Raml::Parser::Method.new(self).parse(key, value)
-            when 'type'
-              apply_resource_type(value)
             when 'is'
               @trait_names = value
             else
@@ -48,10 +48,12 @@ module Raml
           end if attributes
         end
 
-        def apply_resource_type(name)
-          unless resource_types[name].nil?
+        def apply_resource_type
+          name = attributes['type']
+          if name and !resource_types[name].nil?
             resource_attributes = prepare_attributes(resource_types[name])
-            parse_attributes(resource_attributes)
+            @attributes.delete('type')
+            @attributes = resource_attributes.deep_merge(attributes)
           end
         end
 

data/lib/raml/parser/root.rb

@@ -15,6 +15,7 @@ module Raml
 
       def initialize
         @traits = {}
+        @resource_types = {}
       end
 
       def parse(attributes)

data/lib/raml/parser/util.rb

@@ -7,19 +7,11 @@ module Raml
         def prepare_attributes(attributes)
           hash = {}
           attributes.each do |key, value|
-            hash[underscore(key)] = parse_value(value)
+            hash[underscore(key)] = value
           end if attributes.respond_to?(:each)
           hash
         end
 
-        def parse_value(value)
-          if value.is_a?(String) && value.strip.start_with?('include!')
-            File.read value.match(/include!(.*)/)[1].strip
-          else
-            value
-          end
-        end
-
         def underscore(string)
           string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
             .gsub(/([a-z\d])([A-Z])/,'\1_\2')

data/lib/raml/resource.rb

@@ -8,6 +8,10 @@ module Raml
       @methods = []
     end
 
+    def path
+      File.join(parent.path, uri_partial)
+    end
+
     def uri
       File.join(parent.uri, uri_partial)
     end

data/lib/raml/response.rb

@@ -7,5 +7,13 @@ module Raml
       @bodies = []
     end
 
+    def content_types
+      [].tap do |types|
+        bodies.each do |body|
+          types << body.content_type
+        end
+      end.uniq
+    end
+
   end
 end

data/lib/raml/root.rb

@@ -11,5 +11,9 @@ module Raml
       base_uri.sub('{version}', version.to_s)
     end
 
+    def path
+      ''
+    end
+
   end
 end

data/lib/raml/version.rb

@@ -1,3 +1,3 @@
 module Raml
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/raml-rb.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Raml::VERSION
   spec.authors       = ['James Brennan']
   spec.email         = ['james@jamesbrennan.ca']
-  spec.summary       = %q{A RAML parser implemented in Ruby}
+  spec.summary       = 'A RAML parser implemented in Ruby'
   spec.homepage      = 'https://github.com/jpb/raml-rb'
   spec.license       = 'MIT'
 

data/spec/lib/core_ext/hash_spec.rb

@@ -0,0 +1,25 @@
+require 'core_ext/hash'
+
+describe Hash do
+
+  describe '#deep_merge' do
+    subject { { key: 'left' }.deep_merge({ key: 'right'}) }
+    it { should == { key: 'right' } }
+
+    context 'nested hash' do
+      subject { { key: { key: { key: 'left' } } }.deep_merge({ key: { key: { key: 'right' } } }) }
+      it { should == { key: { key: { key: 'right' } } } }
+    end
+
+    context 'nested hash with nil on original hash' do
+      subject { { key: { key: { key: nil } } }.deep_merge({ key: { key: { key: 'right' } } }) }
+      it { should == { key: { key: { key: 'right' } } } }
+    end
+
+    context 'nested hash with nil on merged hash' do
+      subject { { key: { key: { key: 'left' } } }.deep_merge({ key: { key: { key: nil } } }) }
+      it { should == { key: { key: { key: nil } } } }
+    end
+  end
+
+end

data/spec/lib/raml/body_spec.rb

@@ -3,19 +3,19 @@ require 'raml/body'
 describe Raml::Body do
 
   describe '.new' do
-    subject { Raml::Body.new('the type') }
-    its(:type) { should == 'the type' }
+    subject { Raml::Body.new('the content_type') }
+    its(:content_type) { should == 'the content_type' }
   end
 
-  describe '#type' do
-    let(:body) { Raml::Body.new('the type') }
-    before { body.type = 'type' }
-    subject { body.type }
-    it { should == 'type' }
+  describe '#content_type' do
+    let(:body) { Raml::Body.new('the content_type') }
+    before { body.content_type = 'content_type' }
+    subject { body.content_type }
+    it { should == 'content_type' }
   end
 
   describe '#schema' do
-    let(:body) { Raml::Body.new('the type') }
+    let(:body) { Raml::Body.new('the content_type') }
     before { body.schema = 'schema' }
     subject { body.schema }
     it { should == 'schema' }

data/spec/lib/raml/method_spec.rb

@@ -14,4 +14,7 @@ describe Raml::Method do
     it { should == 'the title' }
   end
 
+  describe '#response_code' do
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raml-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - James Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/core_ext/hash.rb
 - lib/raml-rb.rb
 - lib/raml.rb
 - lib/raml/body.rb
@@ -102,6 +103,7 @@ files:
 - raml-rb.gemspec
 - spec/fixtures/all-the-things.raml
 - spec/fixtures/basic.raml
+- spec/lib/core_ext/hash_spec.rb
 - spec/lib/raml/body_spec.rb
 - spec/lib/raml/documentation_spec.rb
 - spec/lib/raml/method_spec.rb
@@ -145,6 +147,7 @@ summary: A RAML parser implemented in Ruby
 test_files:
 - spec/fixtures/all-the-things.raml
 - spec/fixtures/basic.raml
+- spec/lib/core_ext/hash_spec.rb
 - spec/lib/raml/body_spec.rb
 - spec/lib/raml/documentation_spec.rb
 - spec/lib/raml/method_spec.rb