smashing_docs 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26647e5613a7de2ae48b1b45290021d6421c2fbc
-  data.tar.gz: d3895c49e8d1f5cc6703cc9fc3e03d599794068f
+  metadata.gz: 15b0e44e0f4ab5badf91ecddfefb2851bbac26f5
+  data.tar.gz: e7541a662104c2fce5e3e666fc9dc42189f2aa44
 SHA512:
-  metadata.gz: dab20613149d2467798fe72dc8fbaa72980c82514a499eed11f2bf6c079b6a79990e82b479af5d415188910ffac121937f4da5586f9a8bba7c787ef5964952a9
-  data.tar.gz: d6946b59dd25a634d646d6951d7e222affb951b2ce9fce69b90fde20aa1d09317f37b03b26419b6b27c88cace31955e13b78d62a5f7e24551721191a37eb5f0f
+  metadata.gz: 0e2ff24eaa86feeb14762486a067f92f20226b2be8ed5d3d0c983e681cc573d406e46d3af8f25e7c49cda7e12d69ee1c40bc25924c53b7598492bf672abf1767
+  data.tar.gz: 79625ae7e3b62aa49b32b4954bd1c80b5f8eecf8a8857040bd850d22ccaf37191b971e9e29450ffbbf55f2c4075d854827b7d7cf74cb73a6e39c4e3670f625a6

data/README.md

@@ -10,7 +10,7 @@ In your gemfile add the following to your test group:
 
 Installation differs for RSpec/Minitest, so scroll to the appropriate section for guidance.
 
-## Automatic Installation (RSpec only!)
+## Automatic Installation (RSpec or Minitest!)
 
 After you bundle, run:
 
@@ -19,10 +19,13 @@ After you bundle, run:
 SmashingDocs will be configured to run on all your controller tests with the default
 template.
 
+If you're using RSpec and you haven't required `rails_helper` in your tests, do that now.
+
+`require 'rails_helper'`
+
 #### To generate your docs
 
-Run `rails g smashing_documentation:build_docs`, and your docs will be waiting for you
-in the `smashing_docs` folder.
+Run `rails g smashing_documentation:build_docs`, and your docs will be waiting for you in the `smashing_docs` folder.
 
 ## Manual RSpec Installation
 
@@ -32,6 +35,7 @@ Add this to your `rails_helper.rb` It should go outside of other blocks
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
+  c.auto_push     = false
   c.run_all       = true
 end
 ```
@@ -57,6 +61,7 @@ Set the `c.run_all` line to `false` in `rails_helper.rb`
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
+  c.auto_push     = false
   c.run_all       = false
 end
 ```
@@ -79,6 +84,7 @@ class ActiveSupport::TestCase
   SmashingDocs.config do |c|
     c.template_file = 'smashing_docs/template.md'
     c.output_file   = 'smashing_docs/api_docs.md'
+    c.auto_push     = false
     c.run_all       = true
   end
   # More code
@@ -99,6 +105,7 @@ Set the `c.run_all` line to `false` in `test_helper.rb`
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
+  c.auto_push     = false
   c.run_all       = false
 end
 ```

data/gem_rspec/install_generator_spec.rb

@@ -6,18 +6,23 @@ RSpec.describe SmashingDocumentation::Generators::InstallGenerator, type: :gener
   let(:spec_helper) { "spec/spec_helper.rb" }
   let(:docs_template) { "smashing_docs/template.md" }
   context "when rspec is installed" do
-    describe "#update_spec_helper" do
+    describe "#configure_smashing_docs" do
+      let(:rails_helper) { "spec/rails_helper.rb" }
       it "appends the SmashingDocs config to rails_helper.rb" do
         run_generator
         expect(File).to exist(rails_helper)
         expect(File.read(rails_helper)).to include("SmashingDocs.config do")
+        `rm -r smashing_docs`
       end
-
+    end
+    describe "#add_rspec_hooks" do
+      let(:spec_helper) { "spec/spec_helper.rb" }
       it "appends test suite hooks inside RSpec.configure block in spec_helper.rb" do
         run_generator
         expect(File).to exist(spec_helper)
         expect(File.read(spec_helper)).to include("config.after(:each,")
         expect(File.read(spec_helper)).to include("config.after(:suite)")
+        `rm -r smashing_docs`
       end
     end
 
@@ -27,17 +32,49 @@ RSpec.describe SmashingDocumentation::Generators::InstallGenerator, type: :gener
         expect(File).to exist(docs_template)
         expect(File.read(docs_template)).to include("request.method")
         expect(File.read(docs_template)).to include("response.body")
+        `rm -r smashing_docs`
+      end
+    end
+  end
+
+  context "when minitest is installed" do
+    describe "#configure_smashing_docs" do
+      let(:test_helper) { "test/test_helper.rb" }
+      it "appends the SmashingDocs config to test_helper.rb" do
+        `mv spec s`
+        run_generator
+        expect(File).to exist(test_helper)
+        expect(File.read(test_helper)).to include("SmashingDocs.config do")
+        `rm #{test_helper}`
+        `mv s spec`
+        `rm -r smashing_docs`
+      end
+    end
+
+    describe "#add_minitest_hooks" do
+      let(:test_helper) { "test/test_helper.rb" }
+      it "appends test suite hooks inside to the test_helper.rb" do
+        `mv spec s`
+        run_generator
+        expect(File).to exist(test_helper)
+        expect(File.read(test_helper)).to include("teardown")
+        expect(File.read(test_helper)).to include("after_tests")
+        expect(File.read(test_helper)).to include("SmashingDocs")
+        `mv s spec`
+        `rm #{test_helper}`
+        `rm -r smashing_docs`
       end
     end
   end
-  context "when rspec is not installed" do
+  context "when no test suite is installed" do
     it "does not install smashing_docs" do
-      `rm -f "#{rails_helper}"`
+      `rm "#{rails_helper}"`
       File.rename('spec', 's') if Dir.exists?('spec')
+      File.rename('test', 't') if Dir.exists?('test')
       run_generator
       File.rename('s', 'spec') if Dir.exists?('s')
+      File.rename('t', 'test') if Dir.exists?('t')
       expect(File).to_not exist(rails_helper)
-
       # STDOUT is not tested here because it is suppressed in generator tests
     end
   end

data/lib/generators/smashing_documentation/install_generator.rb

@@ -6,49 +6,93 @@ module SmashingDocumentation
 
       def install
         if Dir.exists?('spec')
-          update_rails_helper
-          update_spec_helper
-          generate_docs_template
+          @config_file = "spec/rails_helper.rb"
+        elsif Dir.exists?('test')
+          @config_file = "test/test_helper.rb"
         else
-          puts "It does not appear that you have RSpec installed in your app"
-          puts "Please set up RSpec before running this installer"
+          puts "It does not appear that you have a test suite installed in your app"
+          puts "Please...please use tests"
+          return
         end
+        configure_smashing_docs
+        using_minitest? ? add_minitest_hooks : add_rspec_hooks
+        generate_docs_template
       end
 
       private
+      def configure_smashing_docs
+        create_config_file
+        add_configuration
+      end
 
-      def update_rails_helper
-        destination = "spec/rails_helper.rb"
-        create_file(destination) unless File.exist?(destination)
-        append_file(destination,
-          "SmashingDocs.config do |c|\n"\
-          "  c.template_file = 'smashing_docs/template.md'\n"\
-          "  c.output_file   = 'smashing_docs/api_docs.md'\n"\
-          "  c.auto_push     = false\n"\
-          "  c.run_all       = true\n"\
-          "end"
-          ) unless File.readlines(destination).grep(/SmashingDocs.config/).any?
-      end
-
-      def update_spec_helper
-        destination = "spec/spec_helper.rb"
-        if File.exist?(destination)
+      def add_rspec_hooks
+        helper = "spec/spec_helper.rb"
+        if File.exist?(helper)
           insert_into_file(
-            destination,
+            helper,
             "\n  config.after(:each, type: :controller) do\n"\
             "    SmashingDocs.run!(request, response, true)\n"\
             "  end\n"\
             " # config.after(:suite) { SmashingDocs.finish! }",
             after: "RSpec.configure do |config|"
-          ) unless File.readlines(destination).grep(/SmashingDocs.finish/).any?
+          ) unless test_hooks_already_setup?(helper)
         end
       end
 
+      def add_minitest_hooks
+        helper = "test/test_helper.rb"
+        append_file(
+          helper,
+          "\nclass ActionController::TestCase < ActiveSupport::TestCase\n"\
+          "  def teardown\n"\
+          "    SmashingDocs.run!(request, response, true)\n"\
+          "  end\n"\
+          "end\n"\
+          "MiniTest::Unit.after_tests { SmashingDocs.finish! }\n"
+        ) unless test_hooks_already_setup?(helper)
+      end
+
       def generate_docs_template
         source = "real_template.md"
         destination = "smashing_docs/template.md"
         copy_file(source, destination) unless File.exist?(destination)
       end
+
+      def create_config_file
+        unless File.exist?(@config_file)
+          create_file(@config_file)
+          append_file(@config_file, "class ActiveSupport::TestCase\n end\n") if using_minitest?
+        end
+      end
+
+      def add_configuration
+        setup_configuration unless config_already_setup?
+      end
+
+      def setup_configuration
+        config = "SmashingDocs.config do |c|\n"\
+                 "  c.template_file = 'smashing_docs/template.md'\n"\
+                 "  c.output_file   = 'smashing_docs/api_docs.md'\n"\
+                 "  c.auto_push     = false\n"\
+                 "end\n"
+        if using_minitest?
+          insert_into_file(@config_file, config, after: "class ActiveSupport::TestCase\n")
+        else
+          append_file(@config_file, config)
+        end
+      end
+
+      def config_already_setup?
+        File.readlines(@config_file).grep(/SmashingDocs.config/).any?
+      end
+
+      def test_hooks_already_setup?(helper)
+        File.readlines(helper).grep(/SmashingDocs\.run!/).any?
+      end
+
+      def using_minitest?
+        @config_file.include?("test")
+      end
     end
   end
 end

data/smashing_docs.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.summary = "Uses your test cases to write example documentation for your API."
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.version = '1.1.0'
+  s.version = '1.2.0'
 
   s.add_development_dependency "bundler", "~> 1.11"
   s.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smashing_docs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tyler Rockwell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,6 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- api_docs.md
 - documentation.md
 - gem_rspec/base_spec.rb
 - gem_rspec/conf_spec.rb