grape-markdown 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e78a882d691c6608a8cc6772a6d26d495671c9e2
-  data.tar.gz: 95194bf0b6ac4004f4fb8d6d04d802c97e2dc9e5
+  metadata.gz: 23c66a58fc6dbd66c82241230455c5f2cb22dcae
+  data.tar.gz: c516acd4dcba953c7b5d90bd1553aa5ea344ffba
 SHA512:
-  metadata.gz: 3da325418b11617847ba3d7f3f8cf4848aded3e3a2a9b33dd0ff351d229e02df49272f8991a46cd03150b97e1a7df1f124a6d603cc64b486c29df8446fc1100b
-  data.tar.gz: 14fba51ade118c7b5f5ec4ae4a30934915d8649c687548a3dffc5358739519896ac9252b1b07649014dc1ab455386924a37d4eb34986dfd1f29ec1a6085f8193
+  metadata.gz: c38c1468ba6b71342d5330f534a858fdea4c43ce7f484134070747916ed142dd9dfb0166ffd40fa9d0f1395b3fe64d6cce175dc9fcdea5bb70a50db296013433
+  data.tar.gz: 12530734727aa1e69062043254b019369bfbe9b773d62948da103934ac7f367b38a6500970d22347b6b5cbc841d223f4f03791c154b79630c9a89e4b355fe49b

data/lib/grape-markdown/{config.rb → configuration.rb}

@@ -1,5 +1,5 @@
 module GrapeMarkdown
-  class Config
+  class Configuration
     SETTINGS = [
       :name,
       :description,
@@ -13,6 +13,10 @@ module GrapeMarkdown
     class << self
       attr_accessor(*SETTINGS)
 
+      def extend(setting)
+        self.class.send :attr_accessor, setting
+      end
+
       def request_headers
         @request_headers ||= []
       end

data/lib/grape-markdown/document.rb

@@ -2,7 +2,10 @@ module GrapeMarkdown
   class Document
     attr_reader :api_class, :document_template, :properties_template
 
-    delegate(*GrapeMarkdown::Config::SETTINGS, to: 'GrapeMarkdown::Config')
+    delegate(
+      *GrapeMarkdown::Configuration::SETTINGS,
+      to: 'GrapeMarkdown::Configuration'
+    )
 
     def initialize(api_class)
       @api_class           = api_class
@@ -11,7 +14,7 @@ module GrapeMarkdown
     end
 
     def generate
-      ERB.new(document_template, nil, '-').result(binding)
+      render(document_template, binding)
     end
 
     def write
@@ -35,15 +38,15 @@ module GrapeMarkdown
     end
 
     def properties_table(resource)
-      ERB.new(properties_template, nil, '-').result(resource.resource_binding)
+      render(properties_template, resource.resource_binding)
     end
 
     def formatted_request_headers
-      formatted_headers(GrapeMarkdown::Config.request_headers)
+      formatted_headers(GrapeMarkdown::Configuration.request_headers)
     end
 
     def formatted_response_headers
-      formatted_headers(GrapeMarkdown::Config.response_headers)
+      formatted_headers(GrapeMarkdown::Configuration.response_headers)
     end
 
     def show_request_sample?(route)
@@ -52,6 +55,10 @@ module GrapeMarkdown
 
     private
 
+    def render(template, binding = nil)
+      ERB.new(template, nil, '-').result(binding)
+    end
+
     def template_for(name)
       directory = File.dirname(File.expand_path(__FILE__))
       path = File.join(directory, "./templates/#{name}.md.erb")

data/lib/grape-markdown/parameter.rb

@@ -37,7 +37,7 @@ module GrapeMarkdown
         type:           'uuid',
         desc:           "the `id` of the `#{model}`",
         documentation:  {
-          example:      GrapeMarkdown::Config.generate_id
+          example:      GrapeMarkdown::Configuration.generate_id
         }
       }
     end

data/lib/grape-markdown/resource.rb

@@ -32,12 +32,12 @@ module GrapeMarkdown
       "#{title} #{route.route_type} [#{route.route_path_without_format}]"
     end
 
-    def sample_request
-      sample_generator.request
+    def sample_request(pretty = true)
+      sample_generator.request(pretty: pretty)
     end
 
-    def sample_response(route)
-      sample_generator.response(route.list?)
+    def sample_response(route, pretty = true)
+      sample_generator.response(list: route.list?, pretty: pretty)
     end
 
     def unique_params

data/lib/grape-markdown/route.rb

@@ -45,6 +45,10 @@ module GrapeMarkdown
       %w(GET POST).include?(route_method) && !route_path.include?(':id')
     end
 
+    def route_binding
+      binding
+    end
+
     private
 
     def request_body?

data/lib/grape-markdown/sample_generator.rb

@@ -18,28 +18,38 @@ module GrapeMarkdown
 
       hash = Hash[array.compact]
 
-      hash = hash.reverse_merge(id: Config.generate_id) if id
-      hash = { root => hash } if Config.include_root
+      hash = hash.reverse_merge(id: Configuration.generate_id) if id
+      hash = { root => hash } if Configuration.include_root
 
       hash
     end
 
-    def request
+    def request(opts = {})
       hash = sample
 
       return unless hash.present?
 
-      JSON.pretty_generate(hash)
+      json(hash, opts[:pretty])
     end
 
-    def response(list = false)
+    def response(opts = {})
       hash = sample(true)
 
       return unless hash.present?
 
-      hash = [hash] if list
+      hash = [hash] if opts[:list]
 
-      JSON.pretty_generate(hash)
+      json(hash, opts[:pretty])
+    end
+
+    private
+
+    def json(hash, pretty = true)
+      if pretty
+        JSON.pretty_generate(hash)
+      else
+        JSON.generate(hash)
+      end
     end
   end
 end

data/lib/grape-markdown/version.rb

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

data/lib/grape-markdown.rb

@@ -2,7 +2,7 @@ require 'grape'
 
 module GrapeMarkdown
   autoload :Version,         'grape-markdown/version'
-  autoload :Config,          'grape-markdown/config'
+  autoload :Configuration,   'grape-markdown/configuration'
   autoload :Parameter,       'grape-markdown/parameter'
   autoload :SampleGenerator, 'grape-markdown/sample_generator'
   autoload :Route,           'grape-markdown/route'
@@ -10,7 +10,7 @@ module GrapeMarkdown
   autoload :Document,        'grape-markdown/document'
 
   def self.config
-    block_given? ? yield(Config) : Config
+    block_given? ? yield(Configuration) : Configuration
   end
 end
 

data/spec/grape-markdown/{config_spec.rb → configuration_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe GrapeMarkdown::Config do
+describe GrapeMarkdown::Configuration do
   include_context 'configuration'
 
-  subject { GrapeMarkdown::Config }
+  subject { GrapeMarkdown::Configuration }
 
   it 'allows for name to be set' do
     subject.name = name
@@ -17,6 +17,18 @@ describe GrapeMarkdown::Config do
     expect(subject.description).to eq(description)
   end
 
+  context '.extend' do
+    before do
+      subject.extend(:foo)
+    end
+
+    it 'allows for adding a new setting' do
+      subject.foo = :bar
+
+      expect(subject.foo).to eq(:bar)
+    end
+  end
+
   context '.include_root' do
     it 'defaults to false' do
       expect(subject.include_root).to be(false)

data/spec/grape-markdown/document_spec.rb

@@ -42,8 +42,10 @@ describe GrapeMarkdown::Document do
   end
 
   it 'exposes configuration settings' do
-    GrapeMarkdown::Config::SETTINGS.each do |setting|
-      expect(subject.send(setting)).to eq(GrapeMarkdown.config.send(setting))
+    GrapeMarkdown::Configuration::SETTINGS.each do |setting|
+      value = GrapeMarkdown.config.send(setting)
+
+      expect(subject.send(setting)).to eq(value)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Allen
@@ -169,7 +169,7 @@ files:
 - Rakefile
 - grape-markdown.gemspec
 - lib/grape-markdown.rb
-- lib/grape-markdown/config.rb
+- lib/grape-markdown/configuration.rb
 - lib/grape-markdown/document.rb
 - lib/grape-markdown/parameter.rb
 - lib/grape-markdown/resource.rb
@@ -179,7 +179,7 @@ files:
 - lib/grape-markdown/templates/properties.md.erb
 - lib/grape-markdown/version.rb
 - lib/grape/markdown.rb
-- spec/grape-markdown/config_spec.rb
+- spec/grape-markdown/configuration_spec.rb
 - spec/grape-markdown/document_spec.rb
 - spec/grape-markdown/resource_spec.rb
 - spec/grape-markdown/route_spec.rb
@@ -212,7 +212,7 @@ signing_key:
 specification_version: 4
 summary: Allows for generating a Markdown document from you Grape API
 test_files:
-- spec/grape-markdown/config_spec.rb
+- spec/grape-markdown/configuration_spec.rb
 - spec/grape-markdown/document_spec.rb
 - spec/grape-markdown/resource_spec.rb
 - spec/grape-markdown/route_spec.rb