Moved explanation up to top of endpoint documentatino

and changed curl to use shell formatter in slate.

Author: rpocklin

lib/rspec_api_documentation/views/slate_example.rb

@@ -6,12 +6,6 @@ def initialize(example, configuration)
         self.template_name = "rspec_api_documentation/slate_example"
       end
 
-      def curl_with_linebreaks
-        requests.map {|request| request[:curl].lines }.flatten.map do |line|
-          line.rstrip.gsub("\t", '  ').gsub(' ', ' ').gsub('\\', '\')
-        end.join "<br>"
-      end
-
       def explanation_with_linebreaks
         explanation.gsub "\n", "<br>\n"
       end
@@ -21,13 +15,13 @@ def write
 
           sections.each do |section|
             file.write "# #{section[:resource_name]}\n\n"
-          end
 
-          section[:examples].examples.sort_by!(&:description) unless configuration.keep_source_order
+            section[:examples].examples.sort_by!(&:description) unless configuration.keep_source_order
 
-          section[:examples].examples.each do |example|
-            markup_example = markup_example_class.new(example, configuration)
-            file.write markup_example.render
+            section[:examples].examples.each do |example|
+              markup_example = markup_example_class.new(example, configuration)
+              file.write markup_example.render
+            end
           end
         end
       end

spec/views/slate_example_spec.rb

@@ -10,50 +10,6 @@
   let(:configuration) { RspecApiDocumentation::Configuration.new }
   let(:slate_example) { described_class.new(rad_example, configuration) }
 
-  describe '#curl_with_linebreaks' do
-    subject { slate_example.curl_with_linebreaks }
-
-    before(:each) { allow(slate_example).to receive(:requests).and_return requests }
-
-    context 'marshaling' do
-      let(:requests) { [{curl: 'One'}, {curl: "Two \nThree" }, {curl: 'Four   '}] }
-
-      it 'joins all the Curl requests with linebreaks, stripping trailing whitespace' do
-        expect(subject).to be == [
-          'One', 'Two', 'Three', 'Four'
-        ].join('<br>')
-      end
-    end
-
-    context 'escaping' do
-      let(:requests) { [{curl: string}] }
-
-      context 'spaces' do
-        let(:string) { 'a b' }
-
-        it 'replaces them with nonbreaking spaces' do
-          expect(subject).to be == 'a&nbsp;b'
-        end
-      end
-
-      context 'tabs' do
-        let(:string) { "a\tb" }
-
-        it 'replaces them with two nonbreaking spaces' do
-          expect(subject).to be == 'a&nbsp;&nbsp;b'
-        end
-      end
-
-      context 'backslashes' do
-        let(:string) { 'a\\b'}
-
-        it 'replaces them with an HTML entity' do
-          expect(subject).to be == 'a&#92;b'
-        end
-      end
-    end
-  end
-
   describe '#explanation_with_linebreaks' do
     it 'returns the explanation with HTML linebreaks' do
       explanation = "Line 1\nLine 2\nLine 3\Line 4"

templates/rspec_api_documentation/slate_example.mustache

@@ -1,5 +1,10 @@
 ## {{ description }}
 
+{{# explanation }}
+
+{{{ explanation_with_linebreaks }}}
+{{/ explanation }}
+
 ### Request
 
 #### Endpoint
@@ -13,11 +18,6 @@
 
 `{{ http_method }} {{ route }}`
 
-{{# explanation }}
-
-{{{ explanation_with_linebreaks }}}
-{{/ explanation }}
-
 #### Parameters
 
 {{# requests}}
@@ -78,9 +78,8 @@ None known.
 {{/ has_response_fields? }}
 
 {{# curl }}
-
-### cURL
-
-<code>{{{ curl_with_linebreaks }}}</code>
+```shell
+{{{ curl }}}
+```
 {{/ curl }}
 {{/ requests}}