rspec-api-docs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6e7c92209d8f94e43eb1a790f207e172304477e
-  data.tar.gz: 4cd8916ae2205054cf17803fc987b098261a09ef
+  metadata.gz: 2e9892448884eff6e7ab9f869c5358595e25af95
+  data.tar.gz: 11968fb9bb7a942b6859c8f13029ab37765c936c
 SHA512:
-  metadata.gz: 99b1b8b472fcb9ea6c0e459e69ab99e27ab9d69c5117a2eaf90c0e5d5c95e37eb6249af8d305ea66f85e2dbd05cec52675b756db3eafbdbcf1c4f28ff46cbac0
-  data.tar.gz: 67d2c88fad377d95d1b2a076cf07a57793cb0e925d9f22c34339d97ea220df58bbc5c5c11d540a2c4051e3457db55f24488f24370317b0933f7bf08aa07494fb
+  metadata.gz: 0dd30dcf52b5df54ba6ac7179e315619bec8f6652679291fcc12ff0a974d98b184ca97b61da3e6eda8dabed7abd420c4814f32edc86d0fcec00d7441803497dc
+  data.tar.gz: f313600b62164dfae76b321187860fb894eed9c8b6732249c060418c7daa6c8072fbc22b590dbaf9f4ed13b2a8ea44fcde1ffcf7bbd8dcdeb01d29bc428cac97

data/README.md

@@ -42,11 +42,12 @@ end
 The `doc` method stores data in a hash on the RSpec example metadata.
 
 The second stage is the formatter (`RspecApiDocs::Formatter`). The formatter
-parses the hash stored on each RSpec example and uses a renderer
-(lib/rspec_api_docs/formatter/renderer/) to write out your documentation.
+parses the hash stored on each RSpec example and uses a
+[renderer](lib/rspec_api_docs/formatter/renderer/README.md) to write out your
+documentation.
 
 ```
-bundle exec rspec spec/requests/characters_spec.rb --formatter=RspecApiDocs::Formatter
+$ rspec spec/requests/characters_spec.rb --formatter=RspecApiDocs::Formatter
 ```
 
 ### DSL
@@ -246,7 +247,7 @@ git commits and tags, and push the `.gem` file to [rubygems.org].
 Regenerate this project's integration spec docs locally:
 
 ```
-./bin/generate_integration_docs
+$ ./bin/generate_integration_docs
 ```
 
 ## TODO

data/lib/rspec_api_docs/formatter/renderer/README.md

@@ -0,0 +1,30 @@
+# Renderers
+
+Included renders:
+
+- JSON renderer for https://github.com/twe4ked/api-docs
+- Raddocs renderer for https://github.com/smartlogic/raddocs
+- Slate renderer for https://github.com/lord/slate
+
+## Protocol
+
+A renderer gets initialized with an array of `Resource`s and then the `render`
+instance method is called.
+
+## Example
+
+``` ruby
+class ExampleRenderer
+  def initialize(resources)
+    @resources = resources
+  end
+
+  def render
+    puts @resources.map(&:name).join("\n")
+  end
+end
+
+RspecApiDocs.configure do |config|
+  config.renderer = ExampleRenderer
+end
+```

data/lib/rspec_api_docs/formatter/renderer/json_renderer.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'active_support/core_ext/hash/keys'
 require 'rspec_api_docs/formatter/renderer/json_renderer/name'
 require 'rspec_api_docs/formatter/renderer/json_renderer/resource_serializer'
 
@@ -24,20 +23,33 @@ module RspecApiDocs
 
       def output
         resources.map do |resource|
-          format_hash ResourceSerializer.new(resource).to_h
+          recursive_format_hash ResourceSerializer.new(resource).to_h
         end
       end
 
-      def format_hash(hash)
-        hash.deep_transform_keys do |key|
-          if key =~ /\A[a-z]/
-            key.to_s.camelize(:lower).to_sym
-          else
-            key
-          end
+      def recursive_format_hash(hash)
+        case hash
+        when Hash
+          Hash[
+            hash.map do |key, v|
+              [
+                key.is_a?(Symbol) && key =~ /\A[a-z]/ ? lower_camel_case(key.to_s).to_sym : key,
+                recursive_format_hash(v),
+              ]
+            end
+          ]
+        when Enumerable
+          hash.map { |value| recursive_format_hash(value) }
+        else
+          hash
         end
       end
 
+      def lower_camel_case(string)
+        string = string.split('_').collect(&:capitalize).join
+        string[0].downcase + string[1..-1]
+      end
+
       def output_file
         Pathname.new(RspecApiDocs.configuration.output_dir) + 'index.json'
       end

data/lib/rspec_api_docs/formatter/renderer/raddocs_renderer/link.rb

@@ -3,7 +3,7 @@ module RspecApiDocs
     class RaddocsRenderer
       class Link
         def self.call(resource_name, example_name)
-          "#{resource_name.parameterize.underscore}/#{example_name.parameterize.underscore}.json"
+          "#{resource_name.downcase.gsub(/[^a-z]/, '_')}/#{example_name.downcase.gsub(/[^a-z]/, '_')}.json"
         end
       end
     end

data/lib/rspec_api_docs/formatter/resource.rb

@@ -1,4 +1,3 @@
-require 'active_support/inflector'
 require 'rspec_api_docs/formatter/resource/example'
 require 'rspec_api_docs/formatter/resource/parameter'
 require 'rspec_api_docs/formatter/resource/response_field'

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/rspec-api-docs.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport'
-
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Odin Dutton
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2017-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +136,7 @@ files:
 - lib/rspec_api_docs/dsl/doc_proxy.rb
 - lib/rspec_api_docs/dsl/request_store.rb
 - lib/rspec_api_docs/formatter.rb
+- lib/rspec_api_docs/formatter/renderer/README.md
 - lib/rspec_api_docs/formatter/renderer/json_renderer.rb
 - lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb
 - lib/rspec_api_docs/formatter/renderer/json_renderer/name.rb