rspec-api-docs 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45bd45a0a13f8512cf26c3406b17a461de6a6844
-  data.tar.gz: 545d0fe44c9de8c1a33c3fe5285fb716ea611ee2
+  metadata.gz: a857b455227b03c4d95835fd82d250be2cc4435b
+  data.tar.gz: 85108372a0fd8bdd440ad098959cadd4acc979ce
 SHA512:
-  metadata.gz: 4e2cd0a674337ac2e8683d5f9116a85f5bf01726482fd9300173653cd643ce3ae772edc6499dab21e62d701a9d2e6debcb706c5c4619b34c98283cf7ed8fcb4d
-  data.tar.gz: 30877036d873b254345a13678b9f339c4c2972876e3b5e76de3dd0a6aed946a7347c63cd70b29417b5b50e588ab9b8510f951d74bd2feb746f2bdd6fcb602e62
+  metadata.gz: 6ecce2a07476e855f8b5f483818f672bda0af1d535f6f99f07c550db6dfa097e29b0122da85fd32e6097add999d1a10e96ef2524f0dca0b5d0cc533a9eba4eb8
+  data.tar.gz: d139049350af5da882800943f9078735bc49ccd90df096244b04dc766820c2e481afda8ac76d7a33b7d70c5730b82632f7e4a7f9826d21b9b5c7a13d01b9fa59

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'rspec_api_docs/rake_task'
 
 RSpec::Core::RakeTask.new :rspec do |task|
   task.verbose = false
@@ -15,4 +16,14 @@ task :generate_integration_docs do
   exit $?.exitstatus
 end
 
+RspecApiDocs::RakeTask.new do |task|
+  task.verbose = false
+  task.rspec_opts = [
+    '--require ./spec/integration/json_helper.rb',
+    '--format progress',
+  ]
+  task.pattern = 'spec/integration/rspec_api_docs_spec.rb'
+  task.existing_file = 'spec/integration/output/json/index.json'
+end
+
 task default: [:rspec, :rubocop, :generate_integration_docs]

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

@@ -1,3 +1,5 @@
+require 'rspec_api_docs/formatter/resource/example/request_headers'
+
 module RspecApiDocs
   class Resource
     class Example
@@ -93,19 +95,8 @@ module RspecApiDocs
         metadata.fetch(:requests, []).reject { |pair| pair.any?(&:nil?) }
       end
 
-      # http://stackoverflow.com/a/33235714/826820
       def request_headers(env)
-        headers = Hash[
-          *env.select { |k,v| k.start_with? 'HTTP_' }
-            .collect { |k,v| [k.sub(/^HTTP_/, ''), v] }
-            .collect { |k,v| [k.split('_').collect(&:capitalize).join('-'), v] }
-            .sort.flatten
-        ]
-
-        # TODO: Extract, test, and document
-        headers.reject do |k, v|
-          RspecApiDocs.configuration.exclude_request_headers.include?(k)
-        end
+        RequestHeaders.call(env)
       end
 
       def request_path(request)

data/lib/rspec_api_docs/formatter/resource/example/request_headers.rb

@@ -0,0 +1,39 @@
+module RspecApiDocs
+  class Resource
+    class Example
+      class RequestHeaders
+        attr_reader :env
+
+        def self.call(*args)
+          new(*args).call
+        end
+
+        def initialize(env)
+          @env = env
+        end
+
+        def call
+          headers.reject do |k, v|
+            excluded_headers.include?(k)
+          end
+        end
+
+        private
+
+        # http://stackoverflow.com/a/33235714/826820
+        def headers
+          Hash[
+            *env.select { |k, v| k.start_with? 'HTTP_' }
+            .collect { |k, v| [k.sub(/^HTTP_/, ''), v] }
+            .collect { |k, v| [k.split('_').collect(&:capitalize).join('-'), v] }
+            .sort.flatten
+          ]
+        end
+
+        def excluded_headers
+          RspecApiDocs.configuration.exclude_request_headers
+        end
+      end
+    end
+  end
+end

data/lib/rspec_api_docs/rake_task.rb

@@ -0,0 +1,91 @@
+require 'pry'
+require 'rake'
+require 'rspec'
+require 'json'
+require 'rspec_api_docs/config'
+
+module RspecApiDocs
+  class RakeTask < ::Rake::TaskLib
+    module RSpecMatchers
+      extend RSpec::Matchers
+    end
+
+    attr_reader :name
+
+    attr_accessor \
+      :verbose,
+      :pattern,
+      :rspec_opts,
+      :existing_file,
+      :dir
+
+    def initialize(name = nil, &block)
+      @name = name || :'docs:ensure_updated'
+      @verbose = true
+      @pattern = 'spec/requests/**/*_spec.rb'
+      @rspec_opts = []
+      @existing_file = 'docs/index.json'
+
+      block.call(self)
+
+      define
+    end
+
+    private
+
+    def define
+      desc 'Ensure API docs are up to date'
+      task name do
+        @dir = Dir.mktmpdir
+
+        rspec_task.run_task(verbose)
+
+        configure_rspec
+
+        RSpecMatchers.expect(generated).to RSpecMatchers.eq(existing)
+
+        remove_dir
+      end
+    end
+
+    def generated
+      JSON.parse(File.read(Pathname.new(dir) + 'index.json'))
+    end
+
+    def existing
+      JSON.parse(File.read(existing_file))
+    end
+
+    def rspec_task
+      RSpec::Core::RakeTask.new.tap do |task|
+        task.pattern = pattern
+        task.rspec_opts = rspec_opts + [
+          '--format RspecApiDocs::Formatter',
+          '--order defined',
+          "--require #{spec_helper.path}",
+        ]
+      end
+    end
+
+    def spec_helper
+      tempfile = Tempfile.new(['shoebox', '.rb'])
+      tempfile.write <<-EOF
+        RspecApiDocs.configure do |config|
+          config.output_dir = '#{dir}'
+        end
+      EOF
+      tempfile.close
+      tempfile
+    end
+
+    def configure_rspec
+      RSpec.configure do |config|
+        config.color = true
+      end
+    end
+
+    def remove_dir
+      FileUtils.remove_entry dir
+    end
+  end
+end

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,8 +149,10 @@ files:
 - 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/example.rb
+- lib/rspec_api_docs/formatter/resource/example/request_headers.rb
 - lib/rspec_api_docs/formatter/resource/parameter.rb
 - lib/rspec_api_docs/formatter/resource/response_field.rb
+- lib/rspec_api_docs/rake_task.rb
 - lib/rspec_api_docs/version.rb
 - rspec-api-docs.gemspec
 homepage: https://github.com/twe4ked
@@ -173,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generate API documentation using RSpec