cellophane 0.1.0

data/.cellophane.yaml

@@ -0,0 +1 @@
+cucumber: --format progress --no-profile

data/.cellophane.yaml.sample

@@ -0,0 +1,7 @@
+cucumber: --format progress --no-profile
+feature_path: cuke/features
+step_path: cuke/steps
+# step_path: 
+#   nested_in: step_definitions
+requires:
+  - cuke/support

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+bin/*
+- 
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Phillip Koebbe
+
+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.textile

@@ -0,0 +1,269 @@
+h1. Cellophane
+
+Cellophane is a thin wrapper around "Cucumber":http://github.com/aslakhellesoy/cucumber that is intended to make it easier to structure projects in ways that make sense to the people working on them. It has been tested with Cucumber 0.10.0 on Ruby 1.8.7-p302 and Ruby 1.9.2-p0.
+
+h3. Installation
+
+@gem install cellophane@
+
+h3. History
+
+By default, Cucumber expects features to live in @features@ and step definitions to live in @features/step_definitions@. When running a feature, all step definitions are loaded unless you explicitly require just the ones you want. If you structure your project differently, you have to require files explicitly, which gets old real fast.
+
+After some experimenting with different directory structures, I settled on the following for my own projects:
+
+<pre>
+my_project
+	- app
+	- config
+	- cuke
+		- features
+		- steps
+		- support
+	- db
+	- lib
+	- etc, etc
+</pre>
+
+It's based on the structure of the @spec@ directory and I find that it fits my brain pretty well. There are three organizational strategies that I found myself following:
+
+# separation of features in subdirectories
+# keeping feature specific steps in files that are named according to the feature
+# keeping all shared steps in files that are named in a more generalized fashion
+
+For example, a project my look like this:
+
+<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>
+
+If the features in @cuke/features/admin/reports@ had any steps that were specific to them, they would live @cuke/steps/admin/reports@. Any steps that are shared between two or more features would go in files in @cuke/support@.
+
+To use this structure in Cucumber requires explicitly requiring the files/directories with every run. To run all of the features in @cuke/features/admin/reports@, I would enter the command
+
+<pre>
+cucumber -r cuke/support -r cuke/steps/admin/reports cuke/features/admin/reports
+</pre>
+
+I got weary of doing that all the time, so I experimented with aliases and profiles, neither of which really met my needs. So I created Cellophane. With it, the same features could be as easy as:
+
+<pre>
+cellophane admin/*
+</pre>
+
+As time went on, more patterns began to emerge from my workflow, and with them, Cellophane gained abilities.
+
+h3. Configuration
+
+Cellophane is configured by a @.cellophane.yaml@ file that lives in the root of your project. In it, you can define where your features are located, where your steps are located, any other files/directories that should be required by Cucumber, and any default options you want to pass to Cucumber. It looks like
+
+<pre>
+cucumber: --format progress --no-profile
+feature_path: cuke/features
+step_path: cuke/steps
+requires: [cuke/support, cuke/steps/shared]
+</pre>
+
+This is the configuration used to support the project structure described above.
+
+@step_path@ can be one of two values
+
+# a directory relative to the project root
+# a hash that indicates steps are nested under the feature directories
+
+For the first, 
+
+<pre>
+feature_path: features
+step_path: features/step_definitions
+</pre>
+
+would be used for a Cucumber default directory structure:
+
+<pre>
+my_project
+	- app
+	- config
+	- features
+		- step_definitions
+		- support
+	- db
+	- lib
+	- etc, etc
+</pre>
+
+This is the default in Cellophane. If your cukes are structured like this, you need not do anything else and it should work.
+
+For the second style,
+
+<pre>
+feature_path: features
+step_path:
+  nested_in: step_definitions
+</pre>
+
+would be used if you nest your step definitions under each feature subdirectory, such as:
+
+<pre>
+my_project
+	- app
+	- config
+	- features
+		- admin
+			- step_definitions
+		- user
+			- step_definitions
+		- visitor
+			- step_definitions
+		- support
+	- db
+	- lib
+	- etc, etc
+</pre>
+
+@requires@ is an array of files/directories that Cucumber should require. If this is defined:
+
+<pre>
+requires: [cuke/support, /Users/me/shared/cool_library]
+</pre>
+
+@-r cuke/support -r /Users/me/shared/cool_library@ will be passed to Cucumber.
+
+h3. Operation
+
+Cellophane has the following command line options:
+
+<pre>
+Usage: cellophane [options] PATTERN
+    -r, --regexp                     PATTERN is a regular expression. Default is false.
+    -t, --tags TAGS                  Tags to include/exclude.
+    -c, --cucumber OPTIONS           Options to pass to cucumber.
+    -p, --print                      Echo the command instead of calling cucumber.
+    -d, --debug                      Require ruby-debug.
+    -h, --help                       Display this screen.
+</pre>
+
+PATTERN is the pattern of feature files that you are interested in. By default PATTERN is a glob, but by using the @-r/--regexp@ switch, you can pass a Ruby regular expression instead (no slashes necessary). When using a glob, you can specify that files matching the pattern are to be excluded by preceeding the pattern with a tilde (~). You can also combine include and exclude patterns in the same call. See below for examples.
+
+If you need to pass something through to Cucumber, such as a formatter, use the @-c/--cucumber@ switch. Depending on what it is you are passing through, you might need to enclose it in quotes. Do keep in mind that @-c/--cucumber@ on the command line overrides that defined in the YAML file.
+
+@-d/--debug@ is only useful for Cellophane development and will have no effect on Cucumber.
+
+h3. Examples and Notes
+
+h4. Features
+
+Feature path is relative to the project root. Consider the example project above:
+
+<pre>
+# run all features
+cellophane
+
+# run everything in admin
+cellophane admin/*
+
+# run everything in admin, except the reports
+cellophane admin/*,~admin/reports/*
+
+# run everything, except the admin reports
+cellophane ~admin/reports/*
+
+# run all user_maintenance features regardless of where they are
+cellophane */user_maintenance/*
+
+# run all features in files with email in the name
+cellophane **/*email*
+
+# or use a regular expression
+cellophane -r email
+</pre>
+
+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@.
+
+h4. Tags
+
+You don't need to use @. You can you want, but it's not necessary.
+
+Cellophane supports OR, AND, and NOT tags. Examples will probably illustrate better than words.
+
+OR
+
+<pre>
+cellophane -t one,two
+cucumber -t @one,@two
+</pre>
+
+AND
+
+<pre>
+cellophane -t one,+two
+cucumber -t @one -t @two
+</pre>
+
+NOT
+
+<pre>
+cellophane -t one,~two
+cucumber -t @one -t ~@two
+</pre>
+
+Mixed tags in a logical order
+
+<pre>
+cellophane -t one,two,~three,+four
+cucumber -t @one,@two -t @four -t ~@three
+</pre>
+
+Mixed tags not in a logical order
+
+<pre>
+cellophane -t +four,one,~three,two
+cucumber -t @one,@two -t @four -t ~@three
+</pre>
+
+I like to tag my scenarios with numeric values so I can easily run a specific scenario at any give time. It may sound a bit unusual, but I find it very handy.
+
+Numeric OR ranges
+
+<pre>
+cellophane -t 1-3
+cucumber -t @1,@2,@3
+</pre>
+
+Numeric NOT ranges
+
+<pre>
+cellophane -t ~1-3
+cucumber -t ~@1 -t ~@2 -t ~@3
+</pre>
+
+Numeric OR range with a NOT
+
+<pre>
+cellophane -t 1-3,~2
+cucumber -t @1,@3
+</pre>
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cellophane"
+  gem.homepage = "http://github.com/phillipkoebbe/cellophane"
+  gem.license = "MIT"
+  gem.summary = "A thin wrapper around Cucumber."
+  gem.description = "Cellophane is a thin wrapper around Cucumber, making it easier to be creative when running features."
+  gem.email = "phillip@livingdoor.net"
+  gem.authors = ["Phillip Koebbe"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cellophane #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/cellophane

@@ -0,0 +1,14 @@
+#! /usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+require 'cellophane/main'
+
+begin
+	Cellophane::Main.new.run
+rescue SystemExit
+	# noop
+rescue Exception => e
+	STDERR.puts("#{e.message} (#{e.class})")
+	STDERR.puts(e.backtrace.join("\n"))
+	Kernel.exit(1)
+end

data/features/feature_paths.feature

@@ -0,0 +1,29 @@
+Feature: Feature paths
+
+@1
+Scenario: Standard feature path
+
+Given a project directory with the following structure
+ | type      | path                      |
+ | directory | features                  |
+ | directory | features/step_definitions |
+When Cellophane is called with ""
+Then the command should not include "features"
+And the command should not include "-r features/step_definitions"
+
+@2
+Scenario: Non-standard feature path
+
+Given a project directory with the following structure
+ | type      | path          |
+ | directory | cuke/features |
+ | directory | cuke/steps    |
+And a project options file with the following options
+ | option                      |
+ | feature_path: cuke/features |
+ | step_path: cuke/steps       |
+ | requires: [cuke/support]    |
+When Cellophane is called with ""
+Then the command should include "cuke/features"
+And the command should include "-r cuke/steps"
+And the command should include "-r cuke/support"

data/features/glob_pattern.feature

@@ -0,0 +1,173 @@
+Feature: Glob Pattern
+
+Background:
+
+Given a project directory with the following structure
+ | type      | path                                     |
+ | directory | features                                 |
+ | directory | features/admin                           |
+ | directory | features/user                            |
+ | directory | features/admin/comm                      |
+ | directory | features/user/comm                       |
+ | file      | features/one.feature                     |
+ | file      | features/two.feature                     |
+ | file      | features/three.feature                   |
+ | file      | features/four.feature                    |
+ | file      | features/admin/one.feature               |
+ | file      | features/admin/two.feature               |
+ | file      | features/admin/three.feature             |
+ | file      | features/admin/four.feature              |
+ | file      | features/admin/comm/auto_email.feature   |
+ | file      | features/admin/comm/manual_email.feature |
+ | file      | features/user/one.feature                |
+ | file      | features/user/two.feature                |
+ | file      | features/user/three.feature              |
+ | file      | features/user/four.feature               |
+ | file      | features/user/comm/auto_email.feature    |
+ | file      | features/user/comm/manual_email.feature  |
+
+@1
+Scenario: No files match the pattern
+
+When Cellophane is called with "somebadglobpattern"
+Then the message should include "No features matching PATTERN were found"
+
+@2
+Scenario: Specific files in feature root
+
+When Cellophane is called with "t*"
+Then the command should include "features/two.feature"
+And the command should include "features/three.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/admin/one.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/admin/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"
+
+@3
+Scenario: Specific files in any subdirectory
+
+When Cellophane is called with "**/t*"
+Then the command should include "features/two.feature"
+And the command should include "features/three.feature"
+And the command should include "features/admin/two.feature"
+And the command should include "features/admin/three.feature"
+And the command should include "features/user/two.feature"
+And the command should include "features/user/three.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/admin/one.feature"
+And the command should not include "features/admin/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/four.feature"
+
+@4
+Scenario: Specific files containing a string in the name
+
+When Cellophane is called with "**/*email*"
+Then the command should include "features/admin/comm/auto_email.feature"
+And the command should include "features/admin/comm/manual_email.feature"
+And the command should include "features/user/comm/auto_email.feature"
+And the command should include "features/user/comm/manual_email.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/admin/one.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/admin/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"
+
+@5
+Scenario: All files in a directory
+
+When Cellophane is called with "admin/*"
+Then the command should include "features/admin/one.feature"
+And the command should include "features/admin/two.feature"
+And the command should include "features/admin/three.feature"
+And the command should include "features/admin/four.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"
+
+@6
+Scenario: Exclude specific files in feature root
+
+When Cellophane is called with "~t*"
+Then the command should include "features/one.feature"
+And the command should include "features/four.feature"
+And the command should include "features/admin/one.feature"
+And the command should include "features/admin/two.feature"
+And the command should include "features/admin/three.feature"
+And the command should include "features/admin/four.feature"
+And the command should include "features/user/one.feature"
+And the command should include "features/user/two.feature"
+And the command should include "features/user/three.feature"
+And the command should include "features/user/four.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+
+@7
+Scenario: Exclude specific files in any subdirectory
+
+When Cellophane is called with "~**/t*"
+Then the command should include "features/one.feature"
+And the command should include "features/four.feature"
+And the command should include "features/admin/one.feature"
+And the command should include "features/admin/four.feature"
+And the command should include "features/user/one.feature"
+And the command should include "features/user/four.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+
+@8
+Scenario: Exclude all files in a directory
+
+When Cellophane is called with "~admin/*"
+Then the command should include "features/one.feature"
+And the command should include "features/two.feature"
+And the command should include "features/three.feature"
+And the command should include "features/four.feature"
+And the command should include "features/user/one.feature"
+And the command should include "features/user/two.feature"
+And the command should include "features/user/three.feature"
+And the command should include "features/user/four.feature"
+And the command should not include "features/admin/one.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/admin/four.feature"
+
+@9
+Scenario: Include some, exclude others
+
+When Cellophane is called with "admin/*,~admin/three"
+Then the command should include "features/admin/one.feature"
+And the command should include "features/admin/two.feature"
+And the command should include "features/admin/four.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"

data/features/project_options.feature

@@ -0,0 +1,29 @@
+Feature: Project Options
+
+@1
+Scenario: Load project specific options from a file
+
+Given a project directory with the following structure
+ | type      | path                      |
+ | directory | features                  |
+ | directory | features/step_definitions |
+And a project options file with the following options
+ | option                                   |
+ | cucumber: --format progress --no-profile |
+When Cellophane is called with ""
+Then the command should include "--format progress --no-profile"
+
+@2
+Scenario: Override with command line
+
+Given a project directory with the following structure
+ | type      | path                      |
+ | directory | features                  |
+ | directory | features/step_definitions |
+And a project options file with the following options
+ | option                                   |
+ | cucumber: --format progress --no-profile |
+When Cellophane is called with "-c --format=pretty"
+Then the command should include "--format=pretty"
+And the command should not include "progress"
+And the command should not include "--no-profile"

data/features/regular_expression_pattern.feature

@@ -0,0 +1,94 @@
+Feature: Regular Expression Pattern
+
+Background:
+
+Given a project directory with the following structure
+ | type      | path                                     |
+ | directory | features                                 |
+ | directory | features/admin                           |
+ | directory | features/user                            |
+ | directory | features/admin/comm                      |
+ | directory | features/user/comm                       |
+ | file      | features/one.feature                     |
+ | file      | features/two.feature                     |
+ | file      | features/three.feature                   |
+ | file      | features/four.feature                    |
+ | file      | features/admin/one.feature               |
+ | file      | features/admin/two.feature               |
+ | file      | features/admin/three.feature             |
+ | file      | features/admin/four.feature              |
+ | file      | features/admin/comm/auto_email.feature   |
+ | file      | features/admin/comm/manual_email.feature |
+ | file      | features/user/one.feature                |
+ | file      | features/user/two.feature                |
+ | file      | features/user/three.feature              |
+ | file      | features/user/four.feature               |
+ | file      | features/user/comm/auto_email.feature    |
+ | file      | features/user/comm/manual_email.feature  |
+
+@1
+Scenario: Features that match the pattern do not exist
+
+When Cellophane is called with "-r somebadregularexpression"
+Then the message should include "No features matching PATTERN were found"
+
+@2
+Scenario: An invalid regular expression is submitted
+
+When Cellophane is called with "-r "
+Then the message should include "Invalid regular expression provided"
+
+@3
+Scenario: Specific files
+
+When Cellophane is called with "-r (?:one|four)"
+Then the command should include "features/one.feature"
+And the command should include "features/four.feature"
+And the command should include "features/admin/one.feature"
+And the command should include "features/admin/four.feature"
+And the command should include "features/user/one.feature"
+And the command should include "features/user/four.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+
+@4
+Scenario: Specific files containing a string in the name
+
+When Cellophane is called with "-r email"
+Then the command should include "features/admin/comm/auto_email.feature"
+And the command should include "features/admin/comm/manual_email.feature"
+And the command should include "features/user/comm/auto_email.feature"
+And the command should include "features/user/comm/manual_email.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/admin/one.feature"
+And the command should not include "features/admin/two.feature"
+And the command should not include "features/admin/three.feature"
+And the command should not include "features/admin/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"
+
+@5
+Scenario: All files in a directory
+
+When Cellophane is called with "-r \/admin\/"
+And the command should include "features/admin/one.feature"
+And the command should include "features/admin/two.feature"
+And the command should include "features/admin/three.feature"
+And the command should include "features/admin/four.feature"
+And the command should not include "features/one.feature"
+And the command should not include "features/two.feature"
+And the command should not include "features/three.feature"
+And the command should not include "features/four.feature"
+And the command should not include "features/user/one.feature"
+And the command should not include "features/user/two.feature"
+And the command should not include "features/user/three.feature"
+And the command should not include "features/user/four.feature"