smashing_docs 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2273885225ce2b5c9814c5b84d15656801a9102c
-  data.tar.gz: 6f2daad5d6fa014ee9cdc06e4771bcee7cc21641
+  metadata.gz: 0809fc6581579eaf8ff1e180d884f6b3ffc46b08
+  data.tar.gz: f6e7337a0b38d97ee845fc4406bb02ebe1aba3b1
 SHA512:
-  metadata.gz: 1b09843efd0e3b0c004c7bf294166163217eaa0049b7e9c400b77b828009e84c74e7ad33c7a5574fdf695b0bb55fa0d479d59e4bcde4398065b2bcbf708d87b4
-  data.tar.gz: 48982149bc959da7efc80d9ffe4a7f670ed6b22724e7e9cf6fdd0d5426c3df9d1605f665fc0ccd68cb38229b0e4b934d42e439f4c16397eb902cd8d87e8c410b
+  metadata.gz: 4553669d45deb07c858190c8e50d31394b4df68aa401570919f9d5ac977f340dab366794f79933b8e06f99315d474bbd184695f15e28727ecb2cd204c85bb008
+  data.tar.gz: b97a4348ab97f69df777043d1f9397c308485436a3e8e4e93dc019e16969ba96f203831b40241c7bad0ccad49a4284ece0bc6cc1e562ed541199399adc416b85

data/README.md

@@ -6,7 +6,7 @@
 
 In your gemfile add the following to your test group:
 
-`gem 'smashing_docs', '~> 0.0.3'`
+`gem 'smashing_docs', '~> 1.3.1'`
 
 Installation differs for RSpec/Minitest, so scroll to the appropriate section for guidance.
 
@@ -14,7 +14,7 @@ Installation differs for RSpec/Minitest, so scroll to the appropriate section fo
 
 After you bundle, run:
 
-`rails generate smashing_documentation:install`
+`rails g docs:install`
 
 SmashingDocs will be configured to run on all your controller tests with the default
 template.
@@ -25,7 +25,7 @@ If you're using RSpec and you haven't required `rails_helper` in your tests, do
 
 #### 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 docs:build_docs`, and your docs will be waiting for you in the `smashing_docs` folder.
 
 ## Manual RSpec Installation
 
@@ -37,6 +37,7 @@ SmashingDocs.config do |c|
   c.output_file   = 'smashing_docs/api_docs.md'
   c.run_all       = true
   c.auto_push     = false
+  c.wiki_folder   = nil
 end
 ```
 
@@ -59,10 +60,9 @@ end
 Set the `c.run_all` line to `false` in `rails_helper.rb`
 ```ruby
 SmashingDocs.config do |c|
-  c.template_file = 'smashing_docs/template.md'
-  c.output_file   = 'smashing_docs/api_docs.md'
+  # configs
   c.run_all       = false
-  c.auto_push     = false
+  # configs
 end
 ```
 
@@ -86,6 +86,7 @@ class ActiveSupport::TestCase
     c.output_file   = 'smashing_docs/api_docs.md'
     c.run_all       = true
     c.auto_push     = false
+    c.wiki_folder   = nil
   end
   # More code
 end
@@ -103,10 +104,9 @@ MiniTest::Unit.after_tests { SmashingDocs.finish! }
 Set the `c.run_all` line to `false` in `test_helper.rb`
 ```ruby
 SmashingDocs.config do |c|
-  c.template_file = 'smashing_docs/template.md'
-  c.output_file   = 'smashing_docs/api_docs.md'
+  # configs
   c.run_all       = false
-  c.auto_push     = false
+  # configs
 end
 ```
 
@@ -176,20 +176,30 @@ SmashingDocs can automatically push your generated docs to your project wiki.
 
   Your folder structure should be
 
-    ../projects/my_rails_app
+    ../projects/rails_app
 
     ../projects/my_rails_app.wiki
 
-  2. Set auto_push to true in `rails_helper.rb` or `test_helper.rb`
+  2. Set the name of your wiki folder (do **not** include '.wiki')
+
+    ``` ruby
+      SmashingDocs.config do |c|
+        # configs
+        c.wiki_folder = "my_rails_app"
+      end
+    ```
+
+  3. Set auto_push to true in `rails_helper.rb` or `test_helper.rb`
 
     ``` ruby
       SmashingDocs.config do |c|
         # configs
         c.auto_push = true
+        # configs
       end
     ```
 
-  3. Build your docs with `rails g smashing_documentation:build_docs`
+  4. Build your docs with `rails g docs:build_docs`
 
 #### Generate Docs on Every Test Suite Run
 

data/gem_rspec/base_spec.rb

@@ -117,8 +117,16 @@ RSpec.describe SmashingDocs do
   end
 
   describe "#app_name" do
-    it "returns the name of the app it is installed in" do
-      expect(SmashingDocs.current.send(:app_name)).to eq("smashing_docs")
+    context "when wiki_folder config is set" do
+      let!(:config) { SmashingDocs.config { |c| c.wiki_folder = "different_folder" } }
+      it "returns the name of the wiki folder" do
+        expect(SmashingDocs.current.send(:app_name)).to eq("different_folder")
+      end
+    end
+    context "when wiki_folder config is nil" do
+      it "returns the name of the app it is installed in" do
+        expect(SmashingDocs.current.send(:app_name)).to eq("smashing_docs")
+      end
     end
   end
 

data/lib/base.rb

@@ -114,6 +114,7 @@ end
 private
 
 def app_name
+  return self.class::Conf.wiki_folder if self.class::Conf.wiki_folder
   directory = `pwd`
   directory.match(/\w+\n/).to_s.gsub(/\n/, "")
 end

data/lib/conf.rb

@@ -1,8 +1,8 @@
 class SmashingDocs::Conf
   class << self
-    attr_accessor :template_file, :output_file, :auto_push, :run_all
+    attr_accessor :template_file, :output_file, :auto_push, :run_all, :wiki_folder
     @output_file = 'documentation.md'
-    
+
     def template
       raise 'You must set a template file.' unless template_file
       File.read(template_file)

data/lib/generators/{smashing_documentation → docs}/build_docs_generator.rb

@@ -1,5 +1,5 @@
 require 'rails/generators'
-module SmashingDocumentation
+module Docs
   module Generators
     class BuildDocsGenerator < Rails::Generators::Base
       source_root File.expand_path("../../../templates/", __FILE__)

data/lib/generators/{smashing_documentation → docs}/install_generator.rb

@@ -1,5 +1,5 @@
 require 'rails/generators'
-module SmashingDocumentation
+module Docs
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../../templates/", __FILE__)
@@ -75,6 +75,7 @@ module SmashingDocumentation
                  "  c.output_file   = 'smashing_docs/api_docs.md'\n"\
                  "  c.run_all       = true\n"\
                  "  c.auto_push     = false\n"\
+                 "  c.wiki_folder     = nil\n"\
                  "end\n"
         if using_minitest?
           insert_into_file(@config_file, config, after: "class ActiveSupport::TestCase\n")

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.2.1'
+  s.version = '1.3.1'
 
   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.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Tyler Rockwell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,8 +90,8 @@ files:
 - gem_rspec/test_case_spec.rb
 - lib/base.rb
 - lib/conf.rb
-- lib/generators/smashing_documentation/build_docs_generator.rb
-- lib/generators/smashing_documentation/install_generator.rb
+- lib/generators/docs/build_docs_generator.rb
+- lib/generators/docs/install_generator.rb
 - lib/smashing_docs.rb
 - lib/templates/real_template.md
 - lib/test_case.rb