watchdocs-rails 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 623cd0977c17c12f52dcb6d73669296483905b9b
-  data.tar.gz: 25b282a6b8cb5cb0b969e6aed7265b22b0156ec9
+  metadata.gz: 3c9fb1e8ab7a57922c4fe9a91887f91fcb6a823d
+  data.tar.gz: dff08d2ed4c6fcbf6074125bed97330208824c96
 SHA512:
-  metadata.gz: 0c19e929f480150be5276579d777247c472759e68abba1ff740e25820894c482aced4af0bc2d86e63e1761723c22bcf052568cb8141d1814629fe35617a63286
-  data.tar.gz: f2860ed94519961867e5ec9fe329415684fe0a0d1cfaf87b347f98ed670016d2a932de6351c30bba187764612eaac13bc792e4b42a513bf192c46beb227c605e
+  metadata.gz: 1b2d9370b160061c26ddd88b8e72072732fdee4ecf9b5c11f12e1c707b1251739b3f6535da05057736c6e2a77cf9da2c9ed96c23a94754cf36cb9cc4be99d6c7
+  data.tar.gz: 387cea833226ed95d6419bfa8e0231cc255fa69b543b301ec949876277b3b2b487acd0be379aaa48267770fdb3c47e495fa0b61bff2c53333e055c6ef09f2fb9

data/README.md

@@ -18,19 +18,27 @@ and run
 bundle
 ```
 
+and then fire the installation script
+
+```
+rails g watchdocs:install --app_id your_app_id --app_secret your_app_secret
+```
+
+and your are good to go! Go to the usage section to for details.
+
+
 ## Configuration
 
-Create `config/initializers/watchdocs.rb` and configure the gem with your project credentials:
+After running installation script you can change the configuration in `config/initializers/watchdocs.rb` which looks like that:
 
 ```ruby
   Watchdocs::Rails.configure do |c|
-    c.app_id = 'YourAPPid'
-    c.app_secret = 'YourAPPsecret'
+    c.app_id = 'your_app_id'
+    c.app_secret = 'your_app_secret'
   end
 ```
 
-You can get them from your project's Settings page.
-All configuration settings are listed below.
+All configuration options are listed below.
 
 ### buffer_size
 
@@ -68,7 +76,9 @@ App Secret key which you can get for your Watchdocs project in settings section.
 
 You can enable Watchdocs to record request while executing specs or making manual tests. You can of course do both at the same time if you want.
 
-### Tests
+**NOTE:**: If you've fired installation script, you don't have to copy any code from this section as the script gracefully did it for you.
+
+### Specs
 
 If you have some requests specs or features specs that call JSON API then add this line to your `config/environments/test.rb`.
 
@@ -128,6 +138,13 @@ VCR.configure do |c|
 end
 ```
 
+#### Running specs
+
+Run your specs as usual. Watchdocs will let you know about recorderd API calls.
+
+**NOTE:** Watchdocs doesn't work with controller specs as they don't actually make full reqests (that's why we don't recommend them). If you have controllers specs only don't worry and go to the next section to see how you can use Watchdocs in your project.
+
+
 ### Development (manual tests)
 
 If you don't have any request specs yet, you can add the following line to `config/environments/development.rb`.

data/lib/generators/watchdocs/install_generator.rb

@@ -30,8 +30,8 @@ module Watchdocs
       end
 
       def install_with_specs
-        if yes?('Do you have any request specs? Would you like to use Watchdocs with them in test environment? [y,n]')
-          application(nil, env: 'test') do
+        if yes?('Do you want to generate docs on your test run? (requires feature/request specs) [y,n]')
+          environment(nil, env: 'test') do
             'config.middleware.insert(0, Watchdocs::Rails::Middleware)'
           end
           if yes?('  Do you test with RSpec? [y,n]')
@@ -78,8 +78,8 @@ module Watchdocs
       end
 
       def install_with_runtime
-        if yes?('Do you want to record your API endpoints in developent environment? [y,n]')
-          application(nil, env: 'development') do
+        if yes?('Do you want to generate docs from your local API calls? (in development env) [y,n]')
+          environment(nil, env: 'development') do
             'config.middleware.insert(0, Watchdocs::Rails::Middleware)'
           end
           if yes?('  Do you use Procfile to run your app? [y,n]')
@@ -104,8 +104,31 @@ module Watchdocs
           END
           puts info.light_blue
         end
-        puts 'Setup is completed. Now run your app and make some requests!
-        Check app.watchdocs.io after a minute or so.'.green
+        puts 'Setup is completed. Now run your app and make some requests! Check app.watchdocs.io after a minute or so.'.green
+      end
+
+      private
+
+      def environment(data = nil, options = {})
+        sentinel = /class [a-z_:]+ < Rails::Application/i
+        env_file_sentinel = /\.configure do/
+        data = yield if !data && block_given?
+
+        in_root do
+          if options[:env].nil?
+            inject_into_file 'config/application.rb',
+                             "\n    #{data}",
+                             after: sentinel,
+                             verbose: false
+          else
+            Array(options[:env]).each do |env|
+              inject_into_file "config/environments/#{env}.rb",
+                               "\n  #{data}",
+                               after: env_file_sentinel,
+                               verbose: false
+            end
+          end
+        end
       end
     end
   end

data/lib/watchdocs/rails/version.rb

@@ -1,5 +1,5 @@
 module Watchdocs
   module Rails
-    VERSION = '0.11.0'
+    VERSION = '0.11.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchdocs-rails
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - mazikwyry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler