rspec-api-docs 0.1.0 → 0.2.0

data/lib/rspec_api_docs/formatter/resource/parameter.rb

@@ -0,0 +1,39 @@
+module RspecApiDocs
+  class Resource
+    class Parameter
+      attr_reader :name, :parameter
+
+      def initialize(name, parameter)
+        @name = name
+        @parameter = parameter
+      end
+
+      # The scope of the parameter
+      #
+      # @return [String]
+      def scope
+        parameter[:scope].join
+      end
+
+      # If the parameter is required
+      #
+      # @return [String]
+      def required
+        !!parameter[:required]
+      end
+
+      # The description of the parameter
+      #
+      # @return [String]
+      def description
+        parameter[:description]
+      end
+
+      # @return [true, false]
+      def ==(other)
+        name == other.name &&
+          parameter == other.parameter
+      end
+    end
+  end
+end

data/lib/rspec_api_docs/formatter/resource/response_field.rb

@@ -0,0 +1,39 @@
+module RspecApiDocs
+  class Resource
+    class ResponseField
+      attr_reader :name, :field
+
+      def initialize(name, field)
+        @name = name
+        @field = field
+      end
+
+      # The scope of the response field
+      #
+      # @return [String]
+      def scope
+        field[:scope].join
+      end
+
+      # The type of the response field
+      #
+      # @return [String]
+      def type
+        field[:type]
+      end
+
+      # The description of the response field
+      #
+      # @return [String]
+      def description
+        field[:description]
+      end
+
+      # @return [true, false]
+      def ==(other)
+        name == other.name &&
+          field == other.field
+      end
+    end
+  end
+end

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/rspec-api-docs.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'sinatra', '2.0.0.beta2'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,33 +108,62 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - odindutton@gmail.com
 executables:
+- generate_integration_docs
 - setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/generate_integration_docs
 - bin/setup
 - lib/rspec_api_docs.rb
 - lib/rspec_api_docs/after.rb
+- lib/rspec_api_docs/after/type_checker.rb
+- lib/rspec_api_docs/config.rb
 - lib/rspec_api_docs/dsl.rb
 - 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/index_serializer.rb
-- lib/rspec_api_docs/formatter/renderers/json_renderer.rb
+- 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
+- lib/rspec_api_docs/formatter/renderer/json_renderer/resource_serializer.rb
+- lib/rspec_api_docs/formatter/renderer/raddocs_renderer.rb
+- lib/rspec_api_docs/formatter/renderer/raddocs_renderer/index_serializer.rb
+- lib/rspec_api_docs/formatter/renderer/raddocs_renderer/link.rb
+- lib/rspec_api_docs/formatter/renderer/raddocs_renderer/resource_serializer.rb
+- lib/rspec_api_docs/formatter/renderer/slate_renderer.rb
+- lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
 - lib/rspec_api_docs/formatter/resource.rb
-- lib/rspec_api_docs/formatter/resource_serializer.rb
+- lib/rspec_api_docs/formatter/resource/example.rb
+- lib/rspec_api_docs/formatter/resource/parameter.rb
+- lib/rspec_api_docs/formatter/resource/response_field.rb
 - lib/rspec_api_docs/version.rb
 - rspec-api-docs.gemspec
 homepage: https://github.com/twe4ked

data/lib/rspec_api_docs/formatter/index_serializer.rb

@@ -1,37 +0,0 @@
-class IndexSerializer
-  class ResourceSerializer
-    attr_reader :resource
-
-    def initialize(resource)
-      @resource = resource
-    end
-
-    def to_h
-      {
-        description: resource.example_name,
-        link: resource.link,
-        groups: resource.groups,
-        route: resource.path,
-        method: resource.http_method.downcase,
-      }
-    end
-  end
-
-  attr_reader :resources
-
-  def initialize(resources)
-    @resources = resources.group_by(&:name)
-  end
-
-  def to_h
-    {
-      resources: resources.map do |name, examples|
-        {
-          name: name,
-          explanation: nil,
-          examples: examples.map { |resource| ResourceSerializer.new(resource).to_h },
-        }
-      end
-    }
-  end
-end

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

@@ -1,34 +0,0 @@
-require 'rspec_api_docs/formatter/index_serializer'
-require 'rspec_api_docs/formatter/resource_serializer'
-
-module RspecApiDocs
-  class JSONRender
-    attr_reader :resources
-
-    def initialize(resources)
-      @resources = resources
-    end
-
-    def render
-      FileUtils.mkdir_p output_dir
-
-      File.open(output_dir + 'index.json', 'w') do |f|
-        f.write JSON.pretty_generate(IndexSerializer.new(resources).to_h) + "\n"
-      end
-
-      resources.each do |resource|
-        FileUtils.mkdir_p output_dir + Pathname.new(resource.link).dirname
-
-        File.open(output_dir + resource.link, 'w') do |f|
-          f.write JSON.pretty_generate(ResourceSerializer.new(resource).to_h) + "\n"
-        end
-      end
-    end
-
-    private
-
-    def output_dir
-      Pathname.new RspecApiDocs.configuration.output_dir
-    end
-  end
-end

data/lib/rspec_api_docs/formatter/resource_serializer.rb

@@ -1,21 +0,0 @@
-class ResourceSerializer
-  attr_reader :resource
-
-  def initialize(resource)
-    @resource = resource
-  end
-
-  def to_h
-    {
-      resource: resource.name,
-      resource_explanation: nil,
-      http_method: resource.http_method,
-      route: resource.path,
-      description: resource.example_name,
-      explanation: resource.description,
-      parameters: resource.parameters,
-      response_fields: resource.response_fields,
-      requests: resource.requests,
-    }
-  end
-end