Add rake task to scrape rubocop documentation

This adds the `docs:scrape` rake task which will pull down the rubocop
repo and scrape all of the cops for class documentation and insert it
into markdown files.

This uses regular expresses to extract and manipulate the class
documentation since working with YARD and RDoc like this isn't
straightforward.

Author: BlakeWilliams

.gitignore

@@ -4,13 +4,17 @@ WORKDIR /usr/src/app
 COPY Gemfile /usr/src/app/
 COPY Gemfile.lock /usr/src/app/
 
-RUN apk --update add ruby ruby-dev ruby-bundler build-base && \
+RUN apk --update add ruby ruby-dev ruby-bundler build-base git && \
     bundle install -j 4 && \
     apk del build-base && rm -fr /usr/share/ri
 
 RUN adduser -u 9000 -D app
+COPY . /usr/src/app
+RUN chown -R app:app /usr/src/app
+
 USER app
 
-COPY . /usr/src/app
+RUN cd /usr/src/app && \
+    rake docs:scrape
 
 CMD ["/usr/src/app/bin/codeclimate-rubocop"]

Dockerfile

@@ -59,6 +59,3 @@ DEPENDENCIES
   rake
   rubocop
   rubocop-rspec
-
-BUNDLED WITH
-   1.10.6

Gemfile.lock

@@ -1,5 +1,7 @@
 require 'rake/testtask'
 
+Rake.add_rakelib 'lib/tasks'
+
 Rake::TestTask.new do |t|
   t.test_files = Dir.glob('spec/**/*_spec.rb')
   t.libs = %w[lib spec]

Rakefile

@@ -7,8 +7,8 @@ machine:
 
 test:
   override:
-    - bundle exec rake
     - docker build -t=$PRIVATE_REGISTRY/$CIRCLE_PROJECT_REPONAME:b$CIRCLE_BUILD_NUM .
+    - docker run $PRIVATE_REGISTRY/$CIRCLE_PROJECT_REPONAME:b$CIRCLE_BUILD_NUM bundle exec rake
 
 deployment:
   registry:

circle.yml

@@ -0,0 +1 @@
+*.md

config/contents/.gitignore

@@ -0,0 +1,41 @@
+namespace :docs do
+  desc "Scrapes documentation from the rubocop gem"
+  task :scrape do
+    TAG = "v0.34.2"
+    COP_FOLDERS = %w[lint metrics performance rails style]
+
+    %x{git clone https://github.com/bbatsov/rubocop.git rubocop-git}
+    %x{cd rubocop-git && git checkout tags/#{TAG}}
+
+    files = Dir.glob("./rubocop-git/lib/rubocop/cop/{#{COP_FOLDERS.join(',')}}/**.rb")
+
+    documentation = files.each_with_object({}) do |file, hash|
+      content = File.read(file)
+      class_doc = content.match(/(\s+#.*)+/).to_s
+      doc_lines = class_doc.
+        gsub(/^\n/,"").
+        split("\n").
+        map { |line| line.gsub(/\s+#\s?/, "") }.
+        join("\n")
+      hash[file] = doc_lines
+    end
+
+    documentation.each do |file_path, documentation|
+      namespace = file_path.split('/').slice(-2, 1).join('/')
+      file_name = File.basename(file_path, '.rb')
+
+      folder_path = "./config/contents/#{namespace}"
+      write_path = "#{folder_path}/#{file_name}.md"
+
+      puts "Writing documentation to #{write_path}"
+
+
+      FileUtils.mkdir_p(folder_path)
+      File.open(write_path, 'w') do |file|
+        file.write(documentation)
+      end
+    end
+
+    %x{rm -rf rubocop-git}
+  end
+end