rspec-situations 0.0.2

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'bundler'
+gem 'growl'
+gem 'debugger'
+gem 'guard'
+gem 'guard-bundler'
+gem 'guard-rspec'
+

data/Guardfile

@@ -0,0 +1,12 @@
+
+guard 'bundler' do
+	watch 'Gemfile'
+	watch /^.+\.gemspec/
+end
+
+
+guard :rspec do
+	watch %r{^spec/.+_spec\.rb$}
+	watch( %r{^lib/.+\.rb$} ){ 'spec' }
+	watch( 'spec/spec_helper.rb' ){ 'spec' }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, 2012, 2013 by Brett Richardson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+Using Rspec Situations
+======================
+
+Using Rspec Situations is super simple.
+
+
+Define a situation with the 'situation' method.
+Add a symbol key to identify the situation, and add an optional description if you like, and pass in a block creating the situation.
+
+
+Describe a set of 1 or more situations with the 'describe_situation' method, and treat it just like a normal describe call.
+
+
+```ruby
+describe Apple do
+    subject( :apple ){ create :apple }
+
+    situation( :bought ){ subject.bought_by = create :user }
+    situation( :red    ){ subject.color = :Red }
+
+    situation( :1yr_old, 'a year old' ){ subject.created_at = 2.years.ago }
+
+    describe_situation :stolen, :red do
+        it{ should be_tasty }
+    end
+
+    describe_situation :stolen, :1yr_old do
+        it{ should_not be_tasty }
+    end
+end
+```

data/lib/rspec/situations/class_extensions.rb

@@ -0,0 +1,65 @@
+require 'rspec/situations/situation'
+
+module RSpec::Situations
+	module ClassExtensions
+
+		# Public API method for defining a situation
+		def situation( key, description = nil, &block ) # RSpec extention method to add a Situation object to the hash cache
+			_rsits_hash[key] = Situation.new( key, description, &block )
+		end
+
+
+		# Public API method for describing a set of situations
+		def describe_situation( *keys, &block ) # Describe and invoke all relevant situations
+			if keys.last.kind_of? String # If the last argument is a string
+				description = keys.last # Use it as the description
+				keys = keys[0..-1]
+			else
+				description = _rsits_describe_name *keys # Otherwise, generate a description
+			end
+
+			describe description do
+				before do
+					_rsits( *keys ).each do |situation| # For each situation we request,
+						example.instance_eval &situation.block # Execute its block in the context of an example
+					end
+				end
+
+				instance_eval &block # Execute the describe block in the current context
+			end
+		end
+
+
+		# Get situations defined by the given keys
+		def _rsits( *keys ) # Array of all situation objects pertaining to current context
+			if keys.length > 0
+				_rsits_combined_hash.select{ |k,v| keys.include? k }
+			else
+				_rsits_combined_hash
+			end
+		end
+
+
+		# Combine each situation's description into a string
+		def _rsits_describe_name( *keys )
+			'when ' + _rsits( *keys ).map{ |k,v| v.description }.join( ' and ' )
+		end
+
+
+		# ========================================================================
+			private
+		# ========================================================================
+
+
+		def _rsits_combined_hash
+			_rsits_hash # TODO: Combine with parents, not needed until you want parent and local situations to interact directly with each other.
+		end
+
+
+		# Getter / setter for the hash that stores all our situations
+		def _rsits_hash # Cache by key of all situations in the current describe/context block.
+			@_rsits_hash ||= {}
+		end
+
+	end
+end

data/lib/rspec/situations/configure.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+
+RSpec.configure do |c|
+	c.extend  RSpec::Situations::ClassExtensions
+	c.include RSpec::Situations::InstanceExtensions
+end

data/lib/rspec/situations/instance_extensions.rb

@@ -0,0 +1,31 @@
+module RSpec::Situations::InstanceExtensions
+
+	# Generate a string for describe_situation call
+	def _rsits_describe_name
+		self.class._rsits_describe_name
+	end
+
+
+	# Get an array of situations (from the combined hash) depending on the keys we provide
+	def _rsits( *keys ) # Go up the example parents and get the situations requested, whereever they may be defined
+		_rsits_combined_hash.select do |key, _|
+			keys.include? key # Then filter out only the keys we are using
+		end.map{ |_, situation| situation } # Now return an array of situations instead of a hash
+	end
+
+
+	# ===========================================================================
+		private
+	# ===========================================================================
+
+
+	# A hash of the current context, merged with parent contexts
+	def _rsits_combined_hash
+		self.class.instance_variable_get(
+			:@parent_groups # For each item in @parent_groups
+		).reduce( {} ) do |final, pg|
+			final.merge pg._rsits # Merge the _rsits hash into 'final'
+		end
+	end
+
+end

data/lib/rspec/situations/situation.rb

@@ -0,0 +1,15 @@
+module RSpec::Situations
+
+	class Situation
+		attr_reader :description, :block
+
+		def initialize( key, description = nil, &block )
+			@key         = key
+			@description = description || key.to_s
+			@block       = block
+		end
+
+		def to_s; @description; end
+	end
+
+end

data/lib/rspec/situations/version.rb

@@ -0,0 +1,13 @@
+module RSpec
+	module Situations
+
+		VERSION_NUMBERS = [
+			VERSION_MAJOR = 0,
+			VERSION_MINOR = 0,
+			VERSION_BUILD = 2,
+		]
+
+		VERSION = VERSION_NUMBERS.join(".")
+
+	end
+end

data/lib/rspec/situations.rb

@@ -0,0 +1,10 @@
+module RSpec
+	module Situations
+	end
+end
+
+require 'rspec/situations/version'
+require 'rspec/situations/situation'
+require 'rspec/situations/class_extensions'
+require 'rspec/situations/instance_extensions'
+require 'rspec/situations/configure'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rspec-situations
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brett Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds a super simple method to describe RSpec situations in terms of smaller
+  situation blocks.
+email:
+- Brett.Richardson.NZ@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/situations/class_extensions.rb
+- lib/rspec/situations/configure.rb
+- lib/rspec/situations/instance_extensions.rb
+- lib/rspec/situations/situation.rb
+- lib/rspec/situations/version.rb
+- lib/rspec/situations.rb
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+homepage: http://www.dablweb.com
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Situations for chained Rspec conditions
+test_files: []