cucumber_analytics 0.0.7 → 0.0.8

data/History.rdoc

@@ -1,9 +1,18 @@
+=== Version 0.0.8 / 2013-02-24
+
+* Bug fix: Replaced some destructive method calls with non-destructive
+  equivalents.
+* Bug fix: Fixed some parsing bugs based around whitespace.
+* Subdirectories within a directory are now modeled.
+* Directory collection added
+
+
 === Version 0.0.7 / 2013-02-01
 
 * Bug fix: Feature collection no longer returns nil values for feature files
   that do not contain features.
 * Elements now know the element that contains them.
-* Adjusted the default logging level so tht logging does not occur by default.
+* Adjusted the default logging level so that logging does not occur by default.
 
 
 === Version 0.0.6 / 2013-01-07

data/features/analysis/directory_collection.feature

@@ -0,0 +1,25 @@
+Feature: Directories can be collected from arbitrary parts of the codebase.
+
+
+  Acceptance criteria
+
+  Directories containing feature files can be collected from:
+    1. directories
+
+
+  Background: Setup test codebase
+    Given a directory "feature_directory"
+    And a directory "feature_directory/nested_directory_1"
+    And a directory "feature_directory/nested_directory_1/nested_directory_2"
+    When the directory "feature_directory" is read
+    And the directory "feature_directory/nested_directory_1" is read
+    And the directory "feature_directory/nested_directory_1/nested_directory_2" is read
+
+
+  Scenario: Directories can be collected from directories
+    Then the directories collected from directory "1" are as follows:
+      | nested_directory_1 |
+      | nested_directory_2 |
+    And the directories collected from directory "2" are as follows:
+      | nested_directory_2 |
+    And there are no directories collected from directory "3"

data/features/modeling/background_modeling.feature

@@ -14,7 +14,7 @@ Feature: Background elements can be modeled.
     Feature: The test feature name.
       Some more feature description.
 
-      Background: Some general test setup stuff.
+      Background:Some general test setup stuff.
        My big hunk of perfectly valid description:
           |
 

data/features/modeling/directory_modeling.feature

@@ -7,6 +7,7 @@ Feature: Directories can be modeled.
     1. the directory's name
     2. the directory's full path
     3. all feature files contained
+    4. all directories contained
 
 
   Background: Setup test directories
@@ -68,23 +69,40 @@ Feature: Directories can be modeled.
     When the directory "feature_directory" is read
     And the directory "feature_directory/nested_directory" is read
 
+  Scenario: The directory's name is  modeled.
+    Then directory "1" is found to have the following properties:
+      | name | feature_directory |
+    And directory "2" is found to have the following properties:
+      | name | nested_directory |
+
+  Scenario: The directory's full path is modeled.
+    Then directory "1" is found to have the following properties:
+      | path | path_to/feature_directory |
+    And directory "2" is found to have the following properties:
+      | path | path_to/feature_directory/nested_directory |
+
   Scenario: The directory's feature files are modeled.
     Then directory "1" is found to have the following properties:
-      | name               | feature_directory         |
-      | path               | path_to/feature_directory |
-      | feature_file_count | 3                         |
+      | feature_file_count | 3 |
     And directory "1" feature files are as follows:
       | test_file_1.feature |
       | test_file_2.feature |
       | test_file_3.feature |
     Then directory "2" is found to have the following properties:
-      | name               | nested_directory                           |
-      | path               | path_to/feature_directory/nested_directory |
-      | feature_file_count | 2                                          |
+      | feature_file_count | 2 |
     And directory "2" feature files are as follows:
       | test_file_4.feature |
       | test_file_5.feature |
 
+  Scenario: The directory's directories are modeled.
+    Then directory "1" is found to have the following properties:
+      | directory_count | 1 |
+    And directory "1" directories are as follows:
+      | nested_directory |
+    Then directory "2" is found to have the following properties:
+      | directory_count | 0 |
+    And directory "2" has no directories
+
   Scenario Outline: Directory models pass all other specifications
   Exact specifications detailing the API for directory models.
     Given that there are "<additional specifications>" detailing models

data/features/modeling/example_modeling.feature

@@ -25,15 +25,15 @@ Feature: Example elements can be modeled.
           | <param2> |
         Then I don't really need another step
 
-      Examples: text describing the significance of the examples
+      Examples:text describing the significance of the examples
           Anything besides the | that starts a row should be valid
           description at this point in the test. YMMV
-        | param1 | param2 | extra param |
+        |param1| param2 | extra param |
         #A more random comment
-        | x      | y      |      ?      |
-        | 1      | 2      |      3      |
+        |x     | y      |      ?      |
+        |1     | 2      |      3      |
         @example_tag @another_one
-      Examples: some examples with different significance and a tag
+      Examples:some examples with different significance and a tag
 
         Words, words, words, words,
 

data/features/modeling/feature_modeling.feature

@@ -21,7 +21,7 @@ Feature: Features can be modeled.
     #Or any line that is a comment, really.
     @a_feature_level_tag @and_another@and_another
 
-    Feature: The test feature name.
+     Feature:The test feature name.
       Some more feature description.
 
       And some more.
@@ -44,7 +44,7 @@ Feature: Features can be modeled.
         # freeform text for some reason.
 
 
-      Background: Some general test setup stuff.
+      Background:Some general test setup stuff.
         A little more information.
         * some setup step
 

data/features/modeling/outline_modeling.feature

@@ -20,7 +20,7 @@ Feature: Scenario Outline elements can be modeled.
       Some more feature description.
 
       @outline_tag
-      Scenario Outline: The scenario outline's name.
+      Scenario Outline:The scenario outline's name.
         My big hunk of perfectly valid description:
           |
 
@@ -62,7 +62,7 @@ Feature: Scenario Outline elements can be modeled.
         \"\"\"
         Then *lots* *of* *parameters*
 
-      Examples: text describing the significance of the examples
+      Examples:text describing the significance of the examples
           Anything besides the | that starts a row should be valid
           description at this point in the test. YMMV
         | param1 | param2 |

data/features/modeling/scenario_modeling.feature

@@ -21,7 +21,7 @@ Feature: Scenario elements can be modeled.
       @a_tag
 
       @another_tag@yet_another_tag
-      Scenario: The first scenario's name.
+      Scenario:The first scenario's name.
         My big hunk of perfectly valid description:
           |
 

data/features/step_definitions/directory_steps.rb

@@ -18,3 +18,21 @@ When /^(?:the )?directory(?: "([^"]*)")? feature files are as follows:$/ do |dir
 
   assert actual_files.flatten.sort == files.raw.flatten.sort
 end
+
+When /^(?:the )?directory(?: "([^"]*)")? directories are as follows:$/ do |directory, directories|
+  directory ||= 1
+
+  expected = directories.raw.flatten.sort
+  actual = @parsed_directories[directory - 1].feature_directories.collect { |sub_directory| sub_directory.name }
+
+  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
+end
+
+When /^(?:the )?directory(?: "([^"]*)")? has no directories$/ do |directory|
+  directory ||= 1
+
+  expected = []
+  actual = @parsed_directories[directory - 1].feature_directories
+
+  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
+end

data/features/step_definitions/feature_steps.rb

@@ -11,9 +11,10 @@ Then /^(?:the )?feature(?: "([^"]*)")? is found to have the following properties
 end
 
 Then /^the descriptive lines of feature "([^"]*)" are as follows:$/ do |file, lines|
-  expected_description = lines.raw.flatten
+  expected = lines.raw.flatten
+  actual = @parsed_files[file - 1].feature.description
 
-  assert @parsed_files[file - 1].feature.description == expected_description
+  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
 end
 
 Then /^feature "([^"]*)" is found to have the following tags:$/ do |file, tags|

data/features/step_definitions/test_steps.rb

@@ -49,7 +49,10 @@ Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? is found to have the
   file ||= 1
   test ||= 1
 
-  assert @parsed_files[file - 1].feature.tests[test - 1].tags == tags.raw.flatten
+  expected = tags.raw.flatten
+  actual = @parsed_files[file - 1].feature.tests[test - 1].tags
+
+  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
 end
 
 Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? is found to have the following applied tags:$/ do |file, test, tags|

data/features/step_definitions/world_steps.rb

@@ -157,3 +157,20 @@ Then /^the files collected from directory "([^"]*)" are as follows:$/ do |direct
 
   assert actual_files.flatten.sort == files.raw.flatten.sort
 end
+
+Then /^the directories collected from directory "([^"]*)" are as follows:$/ do |directory, directories|
+  directory ||= 1
+
+  expected = directories.raw.flatten.sort
+  actual = CucumberAnalytics::World.directories_in(@parsed_directories[directory - 1]).collect { |sub_directory| sub_directory.name }
+
+  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
+end
+
+Then /^there are no directories collected from directory "([^"]*)"$/ do |directory|
+  directory ||= 1
+
+  actual_directories = CucumberAnalytics::World.directories_in(@parsed_directories[directory - 1])
+
+  assert actual_directories.flatten == []
+end

data/lib/cucumber_analytics/outline_example.rb

@@ -56,7 +56,7 @@ module CucumberAnalytics
 
     # Returns all tags which are applicable to the scenario.
     def all_tags
-      applied_tags.concat(@tags)
+      applied_tags + @tags
     end
 
     private

data/lib/cucumber_analytics/parsed_directory.rb

@@ -30,6 +30,11 @@ module CucumberAnalytics
       @directory
     end
 
+    # Returns the number of sub-directories contained in the directory.
+    def directory_count
+      @feature_directories.count
+    end
+
     # Returns the number of features files contained in the directory.
     def feature_file_count
       @feature_files.count

data/lib/cucumber_analytics/parsed_feature.rb

@@ -85,7 +85,7 @@ module CucumberAnalytics
 
       source_lines.delete_if { |line| World.ignored_line?(line) }
 
-      until source_lines.first =~ /^\s*(?:(?:Scenario: )|(?:Scenario Outline: )|(?:Background: )|(?:@ ))/ or
+      until source_lines.first =~ /#{World::TEST_ELEMENT_START_PATTERN}/ or
           source_lines.empty?
 
         @description << source_lines.first.strip

data/lib/cucumber_analytics/parsed_file.rb

@@ -52,7 +52,7 @@ module CucumberAnalytics
       File.open(@file, 'r') { |file| file_lines = file.readlines }
 
       # collect feature tag lines
-      until file_lines.first =~ /^s*Feature:/ or
+      until file_lines.first =~ /^\s*Feature:/ or
           file_lines.empty?
 
         feature_lines << file_lines.first
@@ -60,7 +60,7 @@ module CucumberAnalytics
       end
 
       # collect everything else until the end of the feature section
-      until file_lines.first =~ /^\s*(?:@|Background:|Scenario:|(?:Scenario Outline:))/ or
+      until file_lines.first =~ /#{World::TEST_ELEMENT_START_PATTERN}/ or
           file_lines.empty?
 
         feature_lines << file_lines.first

data/lib/cucumber_analytics/parsed_scenario.rb

@@ -30,7 +30,7 @@ module CucumberAnalytics
 
     # Returns all tags which are applicable to the scenario.
     def all_tags
-      applied_tags.concat(@tags)
+      applied_tags + @tags
     end
 
 

data/lib/cucumber_analytics/parsed_scenario_outline.rb

@@ -37,7 +37,7 @@ module CucumberAnalytics
 
     # Returns all tags which are applicable to the scenario.
     def all_tags
-      applied_tags.concat(@tags)
+      applied_tags + @tags
     end
 
 

data/lib/cucumber_analytics/version.rb

@@ -1,3 +1,3 @@
 module CucumberAnalytics
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/cucumber_analytics/world.rb

@@ -4,6 +4,7 @@ module CucumberAnalytics
 
     SANITARY_STRING = '___!!!___'
     STEP_KEYWORD_PATTERN = '\s*(?:Given|When|Then|And|But|\*)\s*'
+    TEST_ELEMENT_START_PATTERN = '\s*(?:@|Background:|Scenario:|(?:Scenario Outline:))'
 
 
     # Returns the left delimiter, which is used to mark the beginning of a step
@@ -56,6 +57,13 @@ module CucumberAnalytics
       end
     end
 
+    # Returns all directories found in the passed container.
+    def self.directories_in(container)
+      Array.new.tap do |accumulated_directories|
+        collect_directories(accumulated_directories, container)
+      end
+    end
+
     # Returns all feature files found in the passed container.
     def self.files_in(container)
       Array.new.tap do |accumulated_files|
@@ -134,6 +142,17 @@ module CucumberAnalytics
       end
     end
 
+    # Recursively gathers all directories found in the passed container.
+    def self.collect_directories(accumulated_directories, container)
+      accumulated_directories.concat container.feature_directories if container.respond_to?(:feature_directories)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_directories(accumulated_directories, child_container)
+        end
+      end
+    end
+
     # Recursively gathers all feature files found in the passed container.
     def self.collect_files(accumulated_files, container)
       accumulated_files.concat container.feature_files if container.respond_to?(:feature_files)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber_analytics
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -90,6 +90,7 @@ files:
 - README.rdoc
 - Rakefile
 - cucumber_analytics.gemspec
+- features/analysis/directory_collection.feature
 - features/analysis/feature_collection.feature
 - features/analysis/feature_file_collection.feature
 - features/analysis/step_collection.feature
@@ -164,6 +165,7 @@ specification_version: 3
 summary: This gem provides an API to programmatically break down Cucumber feature
   files so that they can be inspected and analyzed in a straightforward manner.
 test_files:
+- features/analysis/directory_collection.feature
 - features/analysis/feature_collection.feature
 - features/analysis/feature_file_collection.feature
 - features/analysis/step_collection.feature