goodall 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzA5NTMzYTExNzgxNmNkODAyZWE2ZTY5OTI2NTA0NzgxOGUwNWI0YQ==
+  data.tar.gz: !binary |-
+    NjBkZTI1ODFlNTNiNWYwYzk4ZjJkOWY3ZDUwMzY5ZTgxZjAxZWJhMA==
+SHA512:
+  metadata.gz: !binary |-
+    Y2JkMGI2MmM0NDcxZDU4Yzg3ZjAyYjMxZDViYWQ3MGM3OWJmZjkyNTFmZWY3
+    N2U0MDc2NTNmZWJiMDBhZDc1MmYzMjA1ZTFkODkxMzllODM1YmU0NTYxZjFm
+    NTA3OWVmOTI0ZGEyNzZkOTM1Mzg4ZmMxZDE1N2JmNzk0ZmQ4MjI=
+  data.tar.gz: !binary |-
+    YWQ2YmEwOWVhZjVjNjkwNGZiMTllYTM1MWFmZTQwNGQ2OGYyYmViZDkwZDg3
+    ODdlNDY0YTE2ZTczNWU1MjRkNzkwMzMyNDE1NmMzYWVlMWM4NjZiMmEwODcx
+    MWEzOGY4Y2IxYzU2YjIyMWQ2M2FhMGVjNGZhMmYzMzE5NjFlNDA=

data/.gitignore

@@ -1,3 +1,6 @@
+.rvmrc
+.ruby-version
+.ruby-gemset
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -143,6 +143,18 @@ The steps "I get (.+)" and "the response should be valid json" are steps I
 will use in almost every scenario, so it is the perfect place for the Goodall
 calls. Using Goodall in these frequently used steps is key for ease-of-use.
 
+You can tell Goodall to not document a cucumber scenario by using the
+`@dont-document` tag:
+
+```Gherkin
+  Scenario: this will be documented
+    Given some steps
+
+  @dont-document
+  Scenario: this will not be documented
+    Given some steps
+```
+
 _IMPORTANT NOTE_: Using the cucumber helpers, Goodall will NOT log unless
 executed via the rake task "rake cucumber:document". To force Goodall to
 log, please set the environment variable 'ENABLE_GOODALL' to a non-nil
@@ -240,7 +252,7 @@ automatically set the output file and triggers the tests.
 
 ```ruby
   # Rakefile
-  require 'goodall/rake_task'
+  require 'goodall/rake_task' if %w[development test].include? Rails.env
 ```
 
 This unlocks the following rake commands:

data/lib/goodall.rb

@@ -9,6 +9,7 @@ class Goodall
   include Singleton
 
   @@enabled = false                #:nodoc:
+  @@skipping = false                #:nodoc:
   @@output_path = './api_docs.txt' #:nodoc:
   @@registered_handlers = {}       #:nodoc:
   
@@ -47,6 +48,26 @@ class Goodall
     self.enabled = false
   end
 
+  # Flag to denote that documenting temporarily disabled?
+  def self.skipping?
+    @@skipping
+  end
+
+  # Enable the temporarily disable documenting flag
+  def self.skipping_on!
+    self.skipping = true
+  end
+
+  # Disable the temporarily disable documenting flag
+  def self.skipping_off!
+    self.skipping = false
+  end
+
+  # set the skipping value explicity
+  def self.skipping=(val)
+    @@skipping=!!val
+  end
+
   # write to the currently open output file
   def self.write(str)
     writer.write(str) if enabled?
@@ -58,7 +79,7 @@ class Goodall
   # * +:path+   - a string of the path (URL/URI) of the request
   # * +:payload+ - the parameters sent, e.g. post body. Usually a hash.
   def self.document_request(method, path, payload=nil)
-    return unless enabled?
+    return unless should_document?
 
     str = "#{method.to_s.upcase}: #{path}"
 
@@ -75,7 +96,7 @@ class Goodall
   #
   # * +:payload - the data returned from the request, e.g. response.body. `payload` will be run through the current handler and be pretty-printed to the output file.
   def self.document_response(payload, status=nil)
-    return unless enabled?
+    return unless should_document?
 
     if payload
       payload = current_handler.parse_payload(payload)
@@ -127,6 +148,11 @@ class Goodall
     @@registered_handlers.map{|k,v| [k,v]}
   end
 
+  # Is goodall enabled and are NOT in skipping mode?
+  def self.should_document?
+    enabled? && !skipping?
+  end
+
 private
 
   def self.current_handler

data/lib/goodall/cucumber.rb

@@ -2,6 +2,14 @@ require 'goodall'
 require 'goodall/command_line_enable'
 
 Before do |scenario|
+
+  # skip scenarios that have the '@dont-document' tag
+  if scenario.source_tags.map(&:name).include?('@dont-document')
+    Goodall.skipping_on!
+  end
+
+  next if Goodall.skipping?
+
   if scenario.feature != $current_feature
     $current_feature = scenario.feature
     Goodall.write("\n")
@@ -10,4 +18,8 @@ Before do |scenario|
   Goodall.write("\n")
   Goodall.write("Scenario: #{scenario.name}")
   Goodall.write("\n")
+end
+
+After do |scenario|
+  Goodall.skipping_off! if Goodall.skipping?
 end

data/lib/goodall/version.rb

@@ -1,3 +1,3 @@
 class Goodall
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/goodall_spec.rb

@@ -16,6 +16,7 @@ describe Goodall do
 
   after(:each) do
     Goodall.disable
+    Goodall.skipping_off!
   end
 
   describe ".output_path" do
@@ -42,6 +43,19 @@ describe Goodall do
     end
   end
 
+  describe ".skipping?" do
+    it "must be true if goodall is in skipping mode" do
+      klass.skipping_on!
+
+      expect(klass.skipping?).to be_true
+    end
+    it "must be false if goodall is in not skipping mode" do
+      klass.skipping_off!
+
+      expect(klass.skipping?).to be_false
+    end
+  end
+
   describe ".write" do
     context "Goodall is enabled" do
       before(:each) { klass.enable; }
@@ -217,4 +231,37 @@ describe Goodall do
       end
     end
   end
+
+  describe ".should_document?" do
+
+    context "enabled is true" do
+      before(:each) { klass.enable }
+
+      context "skipping is false" do
+        before(:each) { klass.skipping=false }
+
+        it "should be true" do
+          expect(klass.should_document?).to be_true
+        end
+      end
+
+      context "skipping is true" do
+        before(:each) { klass.skipping=true }
+
+        it "should be false" do
+          expect(klass.should_document?).to be_false
+        end
+      end
+
+    end
+
+    context "enabled is false" do
+      before(:each) { klass.disable }
+
+      it "should be false" do
+        expect(klass.should_document?).to be_false
+      end
+    end
+
+  end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: goodall
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Matthew Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: tolerate_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +91,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -128,27 +116,26 @@ files:
 homepage: http://github.com/xunker/goodall
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Goodall provides an easy interface for documenting your API while you write
   your tests. It is compatible with Rspec, Cucumber and test-unit, as well as others.
   Goodall is named after Jane Goodall who has spent her life observing and documenting

data/.rvmrc

@@ -1,3 +0,0 @@
-rvm --create use 1.9.3@goodall
-#rvm --create use ree@goodall
-#rvm --create use 2.0.0@goodall