cellophane 0.1.2 → 0.1.3

data/.cellophane.yaml.sample

@@ -1,3 +1,7 @@
+cuke_command: cucumber
+# cuke_command: bundle exec cucumber
+# cuke_command: script/cucumber
+# cuke_command: cuke # shell alias
 cucumber: --format progress --no-profile
 feature_path: cuke/features
 step_path: cuke/steps
@@ -5,3 +9,6 @@ step_path: cuke/steps
 #   nested_in: step_definitions
 requires:
   - cuke/support
+  - cuke/steps/shared
+shared: false # turn off auto-loading of step files named shared_steps.rb
+# shared: global # auto-load shared steps in files named global_steps.rb

data/README.textile

@@ -57,11 +57,11 @@ Location of your step definitions. Defaults to @features/step_definitions@. It c
 # nested in each feature directory
 
 *Examples*
-@step_path: cuke/steps@
-<pre>
+<pre><code>
+step_path: cuke/steps
 step_path:
   nested_in: step_definition
-</pre>
+</code></pre>
 
 *Notes*
 Use the first method if your step defitions follow the structure of your features. For example:
@@ -110,6 +110,71 @@ my_project
 	- etc, etc
 </pre>
 
+*Directive*
+@shared@
+
+*Explanation*
+Automatically load steps named shared_steps.rb in all directories that comprise the step path for the current feature file. Defaults to true. This option allows you to share steps among features while keeping them organized according to scope.
+
+*Examples*
+@shared: global@ # instead of looking for shared_steps.rb, look for global_steps.rb
+@shared: false@ # don't automatically require shared steps
+
+*Notes*
+Consider the following project structure:
+
+<pre>
+my_project
+	- app
+	- config
+	- cuke
+		- features
+			- admin
+				- reports
+				- user_maintenance
+			- user
+				- communication
+				- profile
+		- steps
+			- admin
+				- reports
+				- user_maintenance
+			- user
+				- communication
+				- profile
+		- support
+	- db
+	- lib
+	- etc, etc
+</pre>
+
+When you run a feature in @features/admin/reports/weekly.feature@, Cellophane will automatically require shared steps found in the following locations:
+
+@steps/admin/reports/shared_steps.rb@ # steps specific to admin reports
+@steps/admin/shared_steps.rb@ # steps specific to admin
+@steps/shared_steps.rb@ # steps used by the whole application
+
+If your steps are nested, Cellophane will look for shared steps *only* in the nested step location. For example, if your project looks like
+
+<pre>
+my_project
+	- app
+	- config
+	- features
+		- admin
+			- step_definitions
+		- user
+			- step_definitions
+		- visitor
+			- step_definitions
+		- support
+	- db
+	- lib
+	- etc, etc
+</pre>
+
+and you run a feature in @features/admin/email.feature@, Cellophane will look for @features/admin/step_definitions/shared_steps.rb@.
+
 *Directive*
 @requires@
 
@@ -248,13 +313,13 @@ cellophane -r email
 
 h4. Step Definitions
 
-Cellophane does assume that your steps are defined in files that follow the naming of your features. For each feature file that is found, Cellophane will look for a step file with the same name and automatically require it. To require shared step definitions, put them in a folder and include that folder in the @requires@ section of @.cellophane.yaml@.
+Cellophane does assume that your steps are defined in files that follow the naming of your features. For each feature file that is found, Cellophane will look for a step file with the same name and automatically require it. To require shared step definitions, put them in a folder and include that folder in the @requires@ section of @.cellophane.yaml@. Also look into the @shared@ directive of the configuration file, which allows more fine-grained control of shared steps.
 
 For example, if you have a feature defined in @<feature path>/admin/user/account_maintenance.feature@, Cellophane will automatically require a step definition file located in @<step path>/admin/user/account_maintenance_steps.rb@. Unless you are using nested step definitions in @.cellophane.yaml@ (@step_path: {nested_in: steps }@, in which case Cellophane will automatically require @<feature path>/admin/user/steps/account_maintenance_steps.rb@ if it exists.
 
 h4. Tags
 
-You don't need to use @. You can you want, but it's not necessary.
+You don't need to use @. You can if you want, but it's not necessary.
 
 Cellophane supports OR, AND, and NOT tags. Examples will probably illustrate better than words.
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/cellophane.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cellophane}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phillip Koebbe"]
-  s.date = %q{2011-01-11}
+  s.date = %q{2011-01-12}
   s.default_executable = %q{cellophane}
   s.description = %q{Cellophane is a thin wrapper around Cucumber, making it easier to be creative when running features.}
   s.email = %q{phillip@livingdoor.net}

data/features/step_definitions.feature

@@ -45,3 +45,105 @@ And a project options file with the following options
 When Cellophane is called with "admin/one"
 Then the command should include "features/admin/one.feature"
 And the command should include "-r features/admin/step_definitions/one_steps.rb"
+
+@4
+Scenario: Automatically loading shared_steps.rb in simple project
+
+Given a project directory with the following structure
+ | type      | path                                      |
+ | directory | features                                  |
+ | directory | features/step_definitions                 |
+ | file      | features/one.feature                      |
+ | file      | features/two.feature                      |
+ | file      | features/step_definitions/one_steps.rb    |
+ | file      | features/step_definitions/shared_steps.rb |
+When Cellophane is called with "one"
+Then the command should include "features/one.feature"
+And the command should include "-r features/step_definitions/one_steps.rb"
+And the command should include "-r features/step_definitions/shared_steps.rb"
+
+@5
+Scenario: Automatically loading shared_steps.rb in complex project
+
+Given a project directory with the following structure
+ | type      | path                                            |
+ | directory | features                                        |
+ | directory | features/admin                                  |
+ | directory | features/user                                   |
+ | directory | features/step_definitions                       |
+ | directory | features/step_definitions/admin                 |
+ | directory | features/step_definitions/user                  |
+ | file      | features/admin/one.feature                      |
+ | file      | features/admin/two.feature                      |
+ | file      | features/user/one.feature                       |
+ | file      | features/user/two.feature                       |
+ | file      | features/step_definitions/shared_steps.rb       |
+ | file      | features/step_definitions/admin/one_steps.rb    |
+ | file      | features/step_definitions/admin/shared_steps.rb |
+ | file      | features/step_definitions/user/one_steps.rb     |
+ | file      | features/step_definitions/user/shared_steps.rb  |
+When Cellophane is called with "admin/one"
+Then the command should include "features/admin/one.feature"
+And the command should include "-r features/step_definitions/admin/one_steps.rb"
+And the command should include "-r features/step_definitions/shared_steps.rb"
+And the command should include "-r features/step_definitions/admin/shared_steps.rb"
+And the command should not include "-r features/step_definitions/user/one_steps.rb"
+And the command should not include "-r features/step_definitions/user/shared_steps.rb"
+
+@6
+Scenario: Automatically loading shared_steps.rb when steps are nested
+
+Given a project directory with the following structure
+ | type      | path                                            |
+ | directory | features                                        |
+ | directory | features/admin                                  |
+ | directory | features/admin/step_definitions                 |
+ | file      | features/admin/one.feature                      |
+ | file      | features/admin/two.feature                      |
+ | file      | features/admin/step_definitions/one_steps.rb    |
+ | file      | features/admin/step_definitions/shared_steps.rb |
+And a project options file with the following options
+ | option                                   |
+ | step_path: {nested_in: step_definitions} |
+When Cellophane is called with "admin/one"
+Then the command should include "features/admin/one.feature"
+And the command should include "-r features/admin/step_definitions/one_steps.rb"
+And the command should include "-r features/admin/step_definitions/shared_steps.rb"
+
+@7
+Scenario: Automatically loading shared steps in files named differently
+
+Given a project directory with the following structure
+ | type      | path                                      |
+ | directory | features                                  |
+ | directory | features/step_definitions                 |
+ | file      | features/one.feature                      |
+ | file      | features/two.feature                      |
+ | file      | features/step_definitions/one_steps.rb    |
+ | file      | features/step_definitions/global_steps.rb |
+And a project options file with the following options
+ | option         |
+ | shared: global |
+When Cellophane is called with "one"
+Then the command should include "features/one.feature"
+And the command should include "-r features/step_definitions/one_steps.rb"
+And the command should include "-r features/step_definitions/global_steps.rb"
+
+@8
+Scenario: Turning off automatically loading shared steps
+
+Given a project directory with the following structure
+ | type      | path                                      |
+ | directory | features                                  |
+ | directory | features/step_definitions                 |
+ | file      | features/one.feature                      |
+ | file      | features/two.feature                      |
+ | file      | features/step_definitions/one_steps.rb    |
+ | file      | features/step_definitions/shared_steps.rb |
+And a project options file with the following options
+ | option        |
+ | shared: false |
+When Cellophane is called with "one"
+Then the command should include "features/one.feature"
+And the command should include "-r features/step_definitions/one_steps.rb"
+And the command should not include "-r features/step_definitions/shared_steps.rb"

data/lib/cellophane/main.rb

@@ -4,7 +4,7 @@ require 'cellophane/options'
 
 module Cellophane
 	
-	VERSION = '0.1.2'
+	VERSION = '0.1.3'
 	PROJECT_OPTIONS_FILE = '.cellophane.yaml'
 	
 	class Main
@@ -46,9 +46,8 @@ module Cellophane
 				@features.each do |file|
 					file_parts = split_feature(file)
 					features << construct_feature_file(file_parts[:path], file_parts[:name])
-					steps << construct_step_file(file_parts[:path], file_parts[:name])
+					steps += search_for_step_files(file_parts[:path], file_parts[:name])
 				end
-				
 			else
 				# if there are no features explicitly identified, then cucumber will run all. However,
 				# if we are using non-standard locations for features or step definitions, we must tell
@@ -67,11 +66,50 @@ module Cellophane
 			"#{@options[:feature_path]}/#{path}/#{file}.feature".gsub('//', '/')
 		end
 		
-		def construct_step_file(path, file)
-			step_path = @options[:step_path].is_a?(Hash) ? "#{@options[:feature_path]}/#{path}/#{@options[:step_path][:nested_in]}" : "#{@options[:step_path]}/#{path}"
+		def search_for_step_files(path, file)
+			steps = []
+			
+			steps_nested = @options[:step_path].is_a?(Hash)
+			nested_path = "#{@options[:feature_path]}/#{path}/#{@options[:step_path][:nested_in]}" if steps_nested
+			non_nested_path = "#{@options[:step_path]}/#{path}" unless steps_nested
+			
+			step_path = steps_nested ? nested_path : non_nested_path
 			step_file = "#{step_path}/#{file}_steps.rb".gsub('//', '/')
-			return File.exist?(step_file) ? step_file : nil
-		end
+			steps << step_file if File.exist?(step_file)
+
+			# now lets see if we need to load shared step files
+			
+			if @options[:shared]
+				if steps_nested
+					step_file = "#{step_path}/#{@options[:shared]}_steps.rb".gsub('//', '/')
+					steps << step_file if File.exist?(step_file)
+				else
+					# don't want to look in the directories that make up the step root
+					step_path.sub!(@options[:step_path_regexp], '')
+					
+					# make an array of the parts of the path that remain
+					step_path_parts = step_path.split('/')
+				
+					# if there are any unnecessary slashes, step_path_parts will have empty elements...get rid of them
+					step_path_parts.delete_if { |part| (part || '').strip.empty? }
+					
+					# for each path, look for a shared step file
+					while step_path_parts.any? do
+						step_file = "#{@options[:step_path]}/#{step_path_parts.join('/')}/#{@options[:shared]}_steps.rb"
+						steps << step_file if File.exist?(step_file)
+					
+						# get rid of the last path part
+						step_path_parts.pop
+					end
+					
+					# now look in the step path root
+					step_file = "#{@options[:step_path]}/#{@options[:shared]}_steps.rb"
+					steps << step_file if File.exist?(step_file)
+				end # steps are not netsted
+			end # if @options[:shared]
+
+			return steps
+		end # search_for_step_files
 		
 		def split_feature(file)
 			name = File.basename(file, '.feature')

data/lib/cellophane/options.rb

@@ -70,7 +70,7 @@ module Cellophane
 				if File.exist?(Cellophane::PROJECT_OPTIONS_FILE)
 					yaml_options = YAML.load_file(Cellophane::PROJECT_OPTIONS_FILE)
 					
-					['cucumber', 'cuke_command', 'feature_path', 'feature_path_regexp', 'step_path', 'requires'].each do |key|
+					['cuke_command', 'cucumber', 'feature_path', 'feature_path_regexp', 'step_path', 'shared', 'requires'].each do |key|
 						project_options[key.to_sym] = yaml_options[key] if yaml_options.has_key?(key)
 					end
 				end
@@ -87,6 +87,8 @@ module Cellophane
 					:feature_path => 'features',
 					:feature_path_regexp => nil,
 					:step_path => 'features/step_definitions',
+					:step_path_regexp => nil,
+					:shared => 'shared',
 					:requires => []
 				}
 			end
@@ -125,6 +127,11 @@ module Cellophane
 			# make a regexp out of the features path if there isn't one already. we need to escape slashes so the
 			# regexp can be made
 			tmp_options[:feature_path_regexp] = Regexp.new(tmp_options[:feature_path].gsub('/', '\/')) unless tmp_options[:feature_path_regexp]
+
+			# need to make a regexp out of the step path for use when looking for shared steps
+			if !tmp_options[:step_path].is_a?(Hash)
+				tmp_options[:step_path_regexp] = Regexp.new(tmp_options[:step_path].gsub('/', '\/')) unless tmp_options[:step_path_regexp]
+			end
 			
 			# just in case someone sets necessary values to nil, let's go back to defaults
 			tmp_options[:regexp] ||= defaults[:regexp]
@@ -133,6 +140,19 @@ module Cellophane
 			tmp_options[:requires] ||= defaults[:requires]
 			tmp_options[:cuke_command] ||= defaults[:cuke_command]
 			
+			# let's make sure :shared is something we can work with
+			shared = tmp_options[:shared].nil? ? 'shared' : tmp_options[:shared].to_s.strip
+			shared = 'shared' if shared.strip == ''
+			
+			if ['true', ''].include?(shared.downcase)
+				shared == 'shared'
+			elsif shared.downcase == 'false'
+				shared = false
+			end
+			# anything else, just leave it as is
+			
+			tmp_options[:shared] = shared
+			
 			# do what needs to be done on the pattern
 			unless tmp_options[:pattern].nil?
 				tmp_options[:pattern] = tmp_options[:pattern].strip

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Phillip Koebbe
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -06:00
+date: 2011-01-12 00:00:00 -06:00
 default_executable: cellophane
 dependencies: []