smashing_docs 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22b7029c0973147b6d3a28e53a5f3cab6c77b9a0
-  data.tar.gz: 0d6744dbb8ebdd8a92dccc1302bdd51c2100ddc9
+  metadata.gz: 51d3931b8339c80e86f365d38579ca206aaec9e6
+  data.tar.gz: ef9f7460e973252cf1d722423d5b201de50ec238
 SHA512:
-  metadata.gz: bf8e59d70429b63875b0a3f405f26b598d644fd3dfc9a0cb8bc8f6dc0dd45e25d99711a11ba4ccb2a7b6e9260b56e31b2f5e37e267fa6d4e4df668437d11677b
-  data.tar.gz: 9ad103afe3b8f88ffa85ab7df2c0b716d9169f2134022b147855bb0e00d7d971e28220d6d66464d21880b12a9cc55834b2fad439ad477285cfd4f96e2a58fb9a
+  metadata.gz: d9d6a0a33ee29cdbf5b22ba8b2fbd7235274cb36b4e81b96a4e6af76de8bf72d19f7acf474369c1de77ee2eb245d36ee626c910d785ee13ffb3d7e7d8722c18e
+  data.tar.gz: 2e8b0895112ea255a09a3cbebed9a747fbdd2a19e4ff7d7864dcb5d1aa9de4f238481119addd7c3c8b2a2a8801e7105ced9ed558f90e361e7d97ecece0dd8c5c

data/.rspec

@@ -1 +1,2 @@
 --color
+--default-path gem_rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smashing_docs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    smashing_docs (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  generator_spec
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  smashing_docs!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -6,16 +6,26 @@
 
 In your gemfile add the following to your test group:
 
-`gem 'smashing_docs', git: 'https://github.com/smashingboxes/smashing_docs.git'`
+`gem 'smashing_docs', '~> 0.0.3'`
 
 Installation differs for RSpec/Minitest, so scroll to the appropriate section for guidance.
 
-## Rspec Installation
+## Automatic Installation (RSpec only!)
+
+After you bundle, run:
+
+`rails generate smashing_documentation:install`
+
+SmashingDocs will be configured to run on all your controller tests with the default
+template, whenever you run your tests. Your API documentation will appear in the smashing_docs
+folder in the root of your Rails app.
+
+## Manual RSpec Installation
 
 Add this to your `rails_helper.rb` It should go outside of other blocks
 (Do not place it inside the `RSpec.configure` block).
 ```ruby
-SmarfDoc.config do |c|
+SmashingDocs.config do |c|
   c.template_file = 'spec/template.md.erb'
   c.output_file   = 'api_docs.md'
 end
@@ -61,7 +71,7 @@ it "responds with 200" do
 end
 ```
 
-## Minitest Installation
+## Manual Minitest Installation
 
 Add the code from below to `test_helper.rb`:
 ```ruby

data/{spec → gem_rspec}/base_spec.rb

@@ -39,12 +39,14 @@ RSpec.describe SmashingDocs do
   end
 
   describe ".finish!" do
-    it "creates the docs file with output from the template" do
-      SmashingDocs.run!(first, response)
-      SmashingDocs.run!(last, response)
-      SmashingDocs.finish!
-      expect(File).to exist(file)
-      expect(File.read(file)).to include("You can use ERB")
+    context "when there are tests" do
+      it "creates the docs file with output from the template" do
+        SmashingDocs.run!(first, response)
+        SmashingDocs.run!(last, response)
+        SmashingDocs.finish!
+        expect(File).to exist(file)
+        expect(File.read(file)).to include("You can use ERB")
+      end
     end
   end
 
@@ -86,7 +88,7 @@ RSpec.describe SmashingDocs do
       SmashingDocs.aside("I am an aside")
       SmashingDocs.run!(first, response)
       expect(tests.first.compile_template).to include("<aside class='notice'>")
-      expect(tests.first.compile_template).to include("I am an aside")      
+      expect(tests.first.compile_template).to include("I am an aside")
     end
   end
 end

data/{spec → gem_rspec}/conf_spec.rb

@@ -3,15 +3,15 @@ require 'spec_helper'
 RSpec.describe SmashingDocs::Conf do
   let!(:config) {
     SmashingDocs.config do |c|
-      c.template_file = "spec/template.md.erb"
+      c.template_file = "gem_spec/fake_template.md.erb"
       c.output_file   = "api_docs.md"
     end
   }
-  it "sets the template file" do
+  it "sets the output file" do
     expect(SmashingDocs::Conf.output_file).to eq("api_docs.md")
   end
 
-  it "sets the output file" do
-    expect(SmashingDocs::Conf.template_file).to eq("spec/template.md.erb")
+  it "sets the template file" do
+    expect(SmashingDocs::Conf.template_file).to eq("gem_spec/fake_template.md.erb")
   end
 end

data/gem_rspec/install_generator_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'generator_spec'
+require 'generators/smashing_documentation/install_generator'
+RSpec.describe SmashingDocumentation::Generators::InstallGenerator, type: :generator do
+  let(:rails_helper) { "spec/rails_helper.rb" }
+  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
+      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")
+      end
+
+      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)")
+      end
+    end
+
+    describe "#generate_docs_template" do
+      it "generates the default docs template" do
+        run_generator
+        expect(File).to exist(docs_template)
+        expect(File.read(docs_template)).to include("request.method")
+        expect(File.read(docs_template)).to include("response.body")
+      end
+    end
+  end
+  
+  context "when rspec is not installed" do
+    it "does not install smashing_docs" do
+      File.rename('spec', 's') if Dir.exists?('spec')
+      run_generator
+      expect(File).to_not exist(rails_helper)
+      File.rename('s', 'spec') if Dir.exists?('s')
+
+      # STDOUT is not tested here because it is suppressed in generator tests
+    end
+  end
+end

data/gem_rspec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'smashing_docs'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.before(:each) do
+    SmashingDocs.config do |c|
+      c.template_file = 'gem_rspec/fake_template.md.erb'
+      c.output_file   = 'gem_rspec/fake_output.md'
+    end
+  end
+  config.after(:each) do
+    SmashingDocs.finish!
+  end
+end
+
+# Include some fake structs that act like response/request objects.
+Request  = Struct.new :method, :params, :path
+Response = Struct.new :body, :success?
+
+def request
+  Request.new("GET", {id: 12}, 'api/users')
+end
+
+def response
+  Response.new('{"id": 12, "name": "rick"}', true)
+end

data/lib/generators/smashing_documentation/install_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators'
+module SmashingDocumentation
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../templates/", __FILE__)
+
+      def install
+        if Dir.exists?('spec')
+          update_rails_helper
+          update_spec_helper
+          generate_docs_template
+        else
+          puts "It does not appear that you have RSpec installed in your app"
+          puts "Please set up RSpec before running this installer"
+        end
+      end
+
+      private
+
+      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"\
+          "end"
+          ) unless File.readlines(destination).grep(/SmashingDocs.config/).any?
+      end
+
+      def update_spec_helper
+        destination = "spec/spec_helper.rb"
+        if File.exist?(destination)
+          insert_into_file(
+            destination,
+            "\n  config.after(:each, type: :controller) do\n"\
+            "    SmashingDocs.run!(request, response)\n"\
+            "  end\n"\
+            "  config.after(:suite) { SmashingDocs.finish! }",
+            after: "RSpec.configure do |config|"
+          ) unless File.readlines(destination).grep(/SmashingDocs.finish/).any?
+        end
+      end
+
+      def generate_docs_template
+        source = "real_template.md"
+        destination = "smashing_docs/template.md"
+        copy_file(source, destination) unless File.exist?(destination)
+      end
+    end
+  end
+end

data/lib/templates/real_template.md

@@ -0,0 +1,16 @@
+#### <%= request.method %> <%= request.path %>
+
+<%= information[:note] %>
+
+| Param | Value |
+| ----- | ----- |
+<%= table_entries = []
+  request.params.except(:controller, :action, :format).each do |param, value|
+    table_entries << "| #{param} | #{value} |"
+  end
+  table_entries.join("\n") %>
+
+Response: <%= response.status %>
+```json
+<%= JSON.pretty_generate(JSON.parse(response.body)) %>
+```

data/smashing_docs.gemspec

@@ -10,9 +10,10 @@ 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 = '0.0.2'
+  s.version = '0.1.0'
 
   s.add_development_dependency "bundler", "~> 1.11"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "generator_spec"
 end

data/spec/spec_helper.rb

@@ -1,29 +1,2 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'smashing_docs'
-
 RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-  config.before(:each) do
-    SmashingDocs.config do |c|
-      c.template_file = 'spec/fake_template.md.erb'
-      c.output_file   = 'spec/fake_output.md'
-    end
-  end
-  config.after(:each) do
-    SmashingDocs.finish!
-  end
-end
-
-# Include some fake structs that act like response/request objects.
-Request  = Struct.new :method, :params, :path
-Response = Struct.new :body, :success?
-
-def request
-  Request.new("GET", {id: 12}, 'api/users')
-end
-
-def response
-  Response.new('{"id": 12, "name": "rick"}', true)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smashing_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Tyler Rockwell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: Write API documentation using existing controller tests.
 email: 
 executables: []
@@ -62,21 +76,27 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - api_docs.md
 - documentation.md
+- gem_rspec/base_spec.rb
+- gem_rspec/conf_spec.rb
+- gem_rspec/fake_output.md
+- gem_rspec/fake_template.md.erb
+- gem_rspec/install_generator_spec.rb
+- gem_rspec/spec_helper.rb
+- gem_rspec/test_case_spec.rb
 - lib/base.rb
 - lib/conf.rb
+- lib/generators/smashing_documentation/install_generator.rb
 - lib/smashing_docs.rb
+- lib/templates/real_template.md
 - lib/test_case.rb
 - smashing_docs.gemspec
-- spec/base_spec.rb
-- spec/conf_spec.rb
-- spec/fake_output.md
-- spec/fake_template.md.erb
 - spec/spec_helper.rb
-- spec/test_case_spec.rb
 homepage: https://github.com/smashingboxes/smashing_docs
 licenses:
 - MIT
@@ -97,14 +117,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Uses your test cases to write example documentation for your API.
 test_files:
-- spec/base_spec.rb
-- spec/conf_spec.rb
-- spec/fake_output.md
-- spec/fake_template.md.erb
 - spec/spec_helper.rb
-- spec/test_case_spec.rb