couch_visible 0.0.1 → 0.0.2

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/features/configuration.feature

@@ -0,0 +1,57 @@
+Feature: Configuration
+  As a programmer
+  I want to specify whether or not a model's documents are shown or hidden by default
+  So that I can configure the functionality of this gem for my own evil purposes
+  
+  Scenario: Resetting the configuration
+    Given I have edited the global configuration
+    When I run the following code: 
+      """
+        CouchVisible.reset!
+      """
+    Then the configuration of the CouchVisible gem should be reset to its defaults
+
+  Scenario: The "show_by_default" global setting should default to false
+    When I run the following code: 
+      """
+        CouchVisible.show_by_default?
+      """
+    Then I should get false
+    When I run the following code:
+      """
+        CouchVisible.show_by_default!
+      """
+    And I run the following code:
+      """
+        CouchVisible.show_by_default?
+      """
+    Then I should get true
+
+  Scenario: Globally setting the default visibility of documents
+    When I run the following code:
+      """
+        CouchVisible.show_by_default!
+      """
+    Then any documents I create should be visible by default
+    When I run the following code:
+      """
+        CouchVisible.hide_by_default!
+      """
+    Then any documents I create should be hidden by default
+
+  Scenario: The visibility of documents should default to the global setting
+    Given a model that includes CouchVisible
+    When I create an instance of my model
+    Then it should be hidden
+    Given I set the global configuration of CouchVisible to shown by default
+    When I create an instance of my model
+    Then it should be shown
+  
+  Scenario: Setting the default visibility of documents on the model 
+    Given a model that includes CouchVisible
+    When I call "show_by_default!" on it
+    And I create an instance of my model
+    Then it should be shown
+    When I call "hide_by_default!" on it
+    And I create an instance of my model
+    Then it should be hidden

data/features/hide.feature

@@ -0,0 +1,29 @@
+Feature: Hiding a document
+  As a programmer
+  I want the ability to hide a document
+  So that I can flag a document as hidden
+  
+  Scenario: Hide a document
+    Given a document that includes CouchVisible
+    When I call the "hide!" method on the document
+    Then the document should be marked as hidden
+
+  Scenario: Determining if a document is hidden
+    Given a document that is shown
+    When I call the "hidden?" method on the document
+    Then I should get false
+    When I call the "hide!" method on the document
+    And I call the "hidden?" method on the document
+    Then I should get true
+
+  Scenario: Getting the list of all hidden documents
+    Given there are several hidden and visible documents
+    When I call the "by_hidden" method on my document model
+    Then I should receive the hidden documents
+    And I should not receive the shown documents
+
+  @focus
+  Scenario: Getting the count of all hidden documents
+    Given there are several hidden and visible documents
+    When I call the "count_hidden" method on my document model
+    Then I should receive the count of hidden documents

data/features/memories_integration.feature

@@ -0,0 +1,9 @@
+Feature: Integration with the Memories gem
+  As a programmer
+  I want the couch_visible gem to integrate with the memories gem
+  So that the visibility of my documents isn't versioned
+
+  Scenario: mixing CouchVisible into an object that already includes Memories
+    Given I have a model that includes Memories
+    When I mix CouchVisible into that model
+    Then the "couch_visible" property should not be versioned

data/features/show.feature

@@ -0,0 +1,29 @@
+Feature: Showing a document
+  As a programmer
+  I want the ability to show a document
+  So that I can flag a document as visible for viewing
+
+  Scenario: Show a document
+    Given a document that includes CouchVisible
+    When I call the "show!" method on the document
+    Then the document should be marked as shown
+
+  Scenario: Determining if a document is shown
+    Given a document that is not shown
+    When I call the "shown?" method on the document
+    Then I should get false
+    When I call the "show!" method on the document
+    And I call the "shown?" method on the document
+    Then I should get true
+    
+  Scenario: Getting the list of all shown documents
+    Given there are several hidden and visible documents
+    When I call the "by_shown" method
+    Then I should receive the shown documents
+    And I should not receive the hidden documents
+
+  @focus
+  Scenario: Getting the count of all shown documents
+    Given there are several hidden and visible documents
+    When I call the "count_shown" method on my document model
+    Then I should receive the count of shown documents

data/features/step_definitions/configuration_steps.rb

@@ -0,0 +1,57 @@
+Given /^I have edited the global configuration$/ do
+  CouchVisible.show_by_default?.should be(false)
+  CouchVisible.show_by_default!
+  CouchVisible.show_by_default?.should be(true)
+end
+
+When /^I run the following code:$/ do |string|
+  @result = eval string
+end
+
+Then /^the configuration of the CouchVisible gem should be reset to its defaults$/ do
+  CouchVisible.show_by_default?.should be(false)
+end
+
+Then /^I should get false$/ do
+  @result.should == false
+end
+
+Then /^any documents I create should be visible by default$/ do
+  Document.create.shown?.should be(true)
+  Document.create.hidden?.should be(false)
+end
+
+Then /^any documents I create should be hidden by default$/ do
+  Document.create.hidden?.should be(true)
+  Document.create.shown?.should be(false)
+end
+
+Given /^a model that includes CouchVisible$/ do
+  class MyModel < CouchRest::Model::Base
+    include CouchVisible
+  end
+end
+
+When /^I create an instance of my model$/ do
+  @instance = MyModel.create
+end
+
+Then /^it should be hidden$/ do
+  @instance.hidden?.should be(true)
+end
+
+Given /^I set the global configuration of CouchVisible to shown by default$/ do
+  CouchVisible.show_by_default!
+end
+
+Then /^it should be shown$/ do
+  @instance.shown?.should be(true)
+end
+
+When /^I call "([^"]*)" on it$/ do |method|
+  MyModel.send method
+end
+
+Then /^I should get true$/ do
+  @result.should be(true)
+end

data/features/step_definitions/configuration_steps.rbc

@@ -0,0 +1,1500 @@
+!RBIX
+17831730954501249321
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+340
+5
+7
+0
+13
+70
+9
+19
+15
+44
+43
+1
+7
+2
+78
+49
+3
+2
+6
+0
+56
+4
+47
+50
+5
+1
+15
+5
+7
+6
+13
+70
+9
+45
+15
+44
+43
+1
+7
+7
+78
+49
+3
+2
+6
+6
+56
+8
+47
+50
+9
+1
+15
+5
+7
+10
+13
+70
+9
+71
+15
+44
+43
+1
+7
+11
+78
+49
+3
+2
+6
+10
+56
+12
+47
+50
+13
+1
+15
+5
+7
+14
+13
+70
+9
+97
+15
+44
+43
+1
+7
+15
+78
+49
+3
+2
+6
+14
+56
+16
+47
+50
+13
+1
+15
+5
+7
+17
+13
+70
+9
+123
+15
+44
+43
+1
+7
+18
+78
+49
+3
+2
+6
+17
+56
+19
+47
+50
+13
+1
+15
+5
+7
+20
+13
+70
+9
+149
+15
+44
+43
+1
+7
+21
+78
+49
+3
+2
+6
+20
+56
+22
+47
+50
+13
+1
+15
+5
+7
+23
+13
+70
+9
+175
+15
+44
+43
+1
+7
+24
+78
+49
+3
+2
+6
+23
+56
+25
+47
+50
+5
+1
+15
+5
+7
+26
+13
+70
+9
+201
+15
+44
+43
+1
+7
+27
+78
+49
+3
+2
+6
+26
+56
+28
+47
+50
+9
+1
+15
+5
+7
+29
+13
+70
+9
+227
+15
+44
+43
+1
+7
+30
+78
+49
+3
+2
+6
+29
+56
+31
+47
+50
+13
+1
+15
+5
+7
+32
+13
+70
+9
+253
+15
+44
+43
+1
+7
+33
+78
+49
+3
+2
+6
+32
+56
+34
+47
+50
+5
+1
+15
+5
+7
+35
+13
+70
+9
+279
+15
+44
+43
+1
+7
+36
+78
+49
+3
+2
+6
+35
+56
+37
+47
+50
+13
+1
+15
+5
+7
+38
+13
+70
+9
+305
+15
+44
+43
+1
+7
+39
+78
+49
+3
+2
+6
+38
+56
+40
+47
+50
+9
+1
+15
+5
+7
+41
+13
+70
+9
+331
+15
+44
+43
+1
+7
+42
+78
+49
+3
+2
+6
+41
+56
+43
+47
+50
+13
+1
+15
+2
+11
+I
+4
+I
+0
+I
+0
+I
+0
+n
+p
+44
+n
+x
+6
+Regexp
+s
+40
+^I have edited the global configuration$
+x
+3
+new
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+39
+45
+0
+1
+49
+2
+0
+5
+3
+47
+49
+3
+1
+49
+4
+1
+15
+45
+0
+5
+49
+6
+0
+15
+45
+0
+7
+49
+2
+0
+5
+2
+47
+49
+3
+1
+49
+4
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+8
+x
+12
+CouchVisible
+n
+x
+16
+show_by_default?
+x
+2
+be
+x
+6
+should
+n
+x
+16
+show_by_default!
+n
+p
+7
+I
+0
+I
+2
+I
+10
+I
+3
+I
+17
+I
+4
+I
+27
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+x
+5
+Given
+n
+s
+27
+^I run the following code:$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+14
+57
+19
+0
+15
+5
+20
+0
+47
+49
+0
+1
+38
+1
+11
+I
+4
+I
+1
+I
+1
+I
+1
+n
+p
+2
+x
+4
+eval
+x
+7
+@result
+p
+5
+I
+0
+I
+7
+I
+4
+I
+8
+I
+e
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+1
+x
+6
+string
+x
+4
+When
+n
+s
+75
+^the configuration of the CouchVisible gem should be reset to its defaults$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+16
+45
+0
+1
+49
+2
+0
+5
+3
+47
+49
+3
+1
+49
+4
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+5
+x
+12
+CouchVisible
+n
+x
+16
+show_by_default?
+x
+2
+be
+x
+6
+should
+p
+3
+I
+0
+I
+c
+I
+10
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+x
+4
+Then
+n
+s
+20
+^I should get false$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+9
+39
+0
+49
+1
+0
+3
+83
+2
+11
+I
+3
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+3
+x
+7
+@result
+x
+6
+should
+x
+2
+==
+p
+3
+I
+0
+I
+10
+I
+9
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+53
+^any documents I create should be visible by default$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+38
+45
+0
+1
+49
+2
+0
+49
+3
+0
+5
+2
+47
+49
+4
+1
+49
+5
+1
+15
+45
+0
+6
+49
+2
+0
+49
+7
+0
+5
+3
+47
+49
+4
+1
+49
+5
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+8
+x
+8
+Document
+n
+x
+6
+create
+x
+6
+shown?
+x
+2
+be
+x
+6
+should
+n
+x
+7
+hidden?
+p
+5
+I
+0
+I
+14
+I
+13
+I
+15
+I
+26
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+52
+^any documents I create should be hidden by default$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+38
+45
+0
+1
+49
+2
+0
+49
+3
+0
+5
+2
+47
+49
+4
+1
+49
+5
+1
+15
+45
+0
+6
+49
+2
+0
+49
+7
+0
+5
+3
+47
+49
+4
+1
+49
+5
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+8
+x
+8
+Document
+n
+x
+6
+create
+x
+7
+hidden?
+x
+2
+be
+x
+6
+should
+n
+x
+6
+shown?
+p
+5
+I
+0
+I
+19
+I
+13
+I
+1a
+I
+26
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+36
+^a model that includes CouchVisible$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+33
+99
+7
+0
+45
+1
+2
+43
+3
+43
+4
+65
+49
+5
+3
+13
+99
+12
+7
+6
+12
+7
+7
+12
+65
+12
+49
+8
+4
+15
+49
+6
+0
+11
+I
+7
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+9
+x
+7
+MyModel
+x
+9
+CouchRest
+n
+x
+5
+Model
+x
+4
+Base
+x
+10
+open_class
+x
+14
+__class_init__
+M
+1
+n
+n
+x
+7
+MyModel
+i
+11
+5
+66
+5
+45
+0
+1
+47
+49
+2
+1
+11
+I
+2
+I
+0
+I
+0
+I
+0
+n
+p
+3
+x
+12
+CouchVisible
+n
+x
+7
+include
+p
+3
+I
+2
+I
+1f
+I
+b
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+0
+I
+1e
+I
+21
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+34
+^I create an instance of my model$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+9
+45
+0
+1
+49
+2
+0
+38
+3
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+7
+MyModel
+n
+x
+6
+create
+x
+9
+@instance
+p
+3
+I
+0
+I
+24
+I
+9
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+21
+^it should be hidden$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+15
+39
+0
+49
+1
+0
+5
+2
+47
+49
+2
+1
+49
+3
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+9
+@instance
+x
+7
+hidden?
+x
+2
+be
+x
+6
+should
+p
+3
+I
+0
+I
+28
+I
+f
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+68
+^I set the global configuration of CouchVisible to shown by default$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+7
+45
+0
+1
+49
+2
+0
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+3
+x
+12
+CouchVisible
+n
+x
+16
+show_by_default!
+p
+3
+I
+0
+I
+2c
+I
+7
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+20
+^it should be shown$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+15
+39
+0
+49
+1
+0
+5
+2
+47
+49
+2
+1
+49
+3
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+9
+@instance
+x
+6
+shown?
+x
+2
+be
+x
+6
+should
+p
+3
+I
+0
+I
+30
+I
+f
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+n
+s
+24
+^I call "([^"]*)" on it$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+13
+57
+19
+0
+15
+45
+0
+1
+20
+0
+49
+2
+1
+11
+I
+4
+I
+1
+I
+1
+I
+1
+n
+p
+3
+x
+7
+MyModel
+n
+x
+4
+send
+p
+5
+I
+0
+I
+33
+I
+4
+I
+34
+I
+d
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+1
+x
+6
+method
+n
+s
+19
+^I should get true$
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+12
+39
+0
+5
+2
+47
+49
+1
+1
+49
+2
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+3
+x
+7
+@result
+x
+2
+be
+x
+6
+should
+p
+3
+I
+0
+I
+38
+I
+c
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0
+p
+27
+I
+0
+I
+1
+I
+1a
+I
+7
+I
+34
+I
+b
+I
+4e
+I
+f
+I
+68
+I
+13
+I
+82
+I
+18
+I
+9c
+I
+1d
+I
+b6
+I
+23
+I
+d0
+I
+27
+I
+ea
+I
+2b
+I
+104
+I
+2f
+I
+11e
+I
+33
+I
+138
+I
+37
+I
+154
+x
+89
+/Users/mparker/work/github/couch_visible/features/step_definitions/configuration_steps.rb
+p
+0