xcfit 2.0.4 → 2.0.6

data/XCFit.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{XCFit is a full stack BDD framework in Xcode for iOS and macOS apps with Swift using Cucumberish and Fitnesse. Native Xcode implementation, No Appium, No Calabash, No Ruby or any other non iOS language. Checkout XCFIT POD}
   spec.homepage      = "https://github.com/Shashikant86/XCFit"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|XCFitDemo|XCFitnesse|spec|features|_Pods.xcodeproj)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|XCFit2Demo|XCFitnesse|spec|features|_Pods.xcodeproj|Sources|Tests|XCFit.xcodeproj)/}) }
   spec.files.reject! { |fn| fn.include? "_Pods.xcodeproj" }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/XCFit.podspec

@@ -11,16 +11,24 @@ XCFit is a full stack BDD framework for iOS and macOS apps with Swift using Cucu
   # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
   s.author           = { 'Shashikant86' => 'shashikant.jagtap@icloud.com' }
-  s.source           = { :git => 'https://github.com/Shashikant86/XCFit.git', :tag => '0.1.0' }
+  s.source           = { :git => 'https://github.com/Shashikant86/XCFit.git', :tag => "#{s.version}"}
 
   s.social_media_url = 'https://twitter.com/Shashikant86'
 
-  s.ios.deployment_target = '8.0'
-
-  s.source_files = 'XCFit/Classes/**/*'
-
-
-  # s.public_header_files = 'Pod/Classes/**/*.h'
-  # s.frameworks = 'UIKit', 'MapKit'
-   s.dependency 'OCSlimProject'
+  s.ios.deployment_target = '9.0'
+  s.source_files  = 'XCFit/Classes/Cucumberish/*.{h,m}', 'XCFit/Classes/Cucumberish/Core/Managers/*.{h,m}', 'XCFit/Classes/Cucumberish/Core/Models/*.{h,m}', 'XCFit/Classes/Cucumberish/Utils/*.{h,m}', 'XCFit/Classes/Cucumberish/Dependencies/Gherkin', 'XCFit/Classes/Cucumberish/Core/CCIBlockDefinitions.h'
+  s.public_header_files =
+    'XCFit/Classes/Cucumberish/Cucumberish.h',
+    'XCFit/Classes/Cucumberish/Core/Managers/CCIStepsManager.h',
+    'XCFit/Classes/Cucumberish/Core/CCIBlockDefinitions.h',
+    'XCFit/Classes/Cucumberish/Core/Models/CCIScenarioDefinition.h',
+    'XCFit/Classes/Cucumberish/Core/Models/CCIExample.h',
+    'XCFit/Classes/Cucumberish/Core/Models/CCIStep.h',
+    'XCFit/Classes/Cucumberish/Core/Models/CCILocation.h',
+    'XCFit/Classes/Cucumberish/Core/Models/CCIArgument.h'
+  s.resource_bundles = {
+    'GherkinLanguages' => ['XCFit/Classes/Cucumberish/Dependencies/Gherkin/gherkin-languages.json'],
+  }
+   s.framework  = "XCTest"
+   s.xcconfig = { "GCC_PREPROCESSOR_DEFINITIONS" => "SRC_ROOT=@\\\"$(SRCROOT)\\\"" }
 end

data/XCFit/Classes/Cucumberish/Core/CCIBlockDefinitions.h

@@ -0,0 +1,400 @@
+//
+//  CCIBlockDefinitions.h
+//  Pods
+//
+//  Created by Ahmed Ali on 23/01/16.
+//
+//
+
+#import <Foundation/Foundation.h>
+@class CCIScenarioDefinition;
+
+extern const NSString * kDataTableKey;
+extern const NSString * kDocStringKey;
+extern const NSString * kXCTestCaseKey;
+
+#pragma mark - Block types
+/**
+ You pass this block when ever you define an implementation for a step.
+ 
+ @param args strings array which corresponds to your regular express capturing groups.
+ @param userInfo is a dictionary that currently can have one of two keys kDataTableKey or kDocStringKey. If your step definition is expected to match a data table or a doc string, then you can expect this user info dictionary to contain kDataTableKey or kDocStringKey key respectively. Moreover, it will contain the key kXCTestCaseKey which will hold reference to the XCTestCase that currently executing this step. The value of kXCTestCaseKey will be nil if the step is being executed by a call of "step" or "SStep" C functions and you did not pass a reference to the XCTestCase.
+ */
+typedef void(^CCIStepBody)(NSArray <NSString *>* args, NSDictionary * userInfo);
+
+/**
+ This block is passed to all the hocks (except around hock).
+ @param scenario the scenario the current scenario
+ */
+typedef void (^CCIScenarioHockBlock)(CCIScenarioDefinition * scenario);
+
+/**
+ This block is passed to around hocks.
+ @param scenario the scenario the current scenario.
+ @param scenarioExectionBlock the block that will execute the scenario. If you did not call it, the scenario will never bee executed.
+ */
+typedef void (^CCIScenarioExecutionHockBlock)(CCIScenarioDefinition * scenario, void (^scenarioExectionBlock)(void) );
+
+
+#pragma mark - Step definitions and prepositions
+
+@class CCIStep;
+@class CCIStepDefinition;
+
+/**
+ Defines a Given implementations.
+ 
+ @code
+ Given(@"the app is running" ,  ^void(NSArray *args, id userInfo) {
+     //Your step implementation goes here
+     //The definition string in this case will match only the following step
+     //Given the app is running
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void Given(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines a When step implementations.
+ 
+ @b Example:
+ @code
+ When(@"^I tap (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //When I tap the "MyButton" button
+     //When I tap "MyButton" button
+     //When I tap "Header" view
+     //When I tap "FAQ" label
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void When(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines a Then step implementations.
+ 
+ @b Example:
+ @code
+ Then(@"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //Then I should see "Button Title" in "MyButton" button
+     //Then I should see "Button Title" in the "MyButton" Button
+     //Then I should see "The Screen Title" in "Header" view
+     //Then I should see "FAQ" in "FAQ" label
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void Then(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines an And step implementations.
+ 
+ @b Example:
+ @code
+ And(@"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //And I should see "Button Title" in "MyButton" button
+     //And I should see "Button Title" in the "MyButton" Button
+     //And I should see "The Screen Title" in "Header" view
+     //And I should see "FAQ" in "FAQ" label
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void And(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines a But step implementations.
+ 
+ @code
+ But(@"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //But I should see "Button Title" in "MyButton" button
+     //But I should see "Button Title" in the "MyButton" Button
+     //But I should see "The Screen Title" in "Header" view
+     //But I should see "FAQ" in "FAQ" label
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void But(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines a step implementations that will be registered with When, Then, And, and But.
+ The implementation of this function simply calls:
+ @code
+ When(definitionString, body);
+ Then(definitionString, body);
+ And(definitionString, body);
+ But(definitionString, body);
+ @endcode
+ Which concluds that the registered definitions will be checked with any of these four prepositions.
+ 
+ @b Example:
+ @code
+ MatchAll(@"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //When I should see "Button Title" in "MyButton" button
+     //Then I should see "Button Title" in "MyButton" button
+     //And I should see "Button Title" in "MyButton" button
+     //But I should see "Button Title" in "MyButton" button
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void MatchAll(NSString * definitionString, CCIStepBody body);
+
+/**
+ Defines a step implementations that will be registered with specified prepositions.
+ 
+ @b Example:
+ @code
+ Match(@[@"When", @"And", @"Then"], @"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //The definition string in this case can match all the following steps
+     //When I should see "Button Title" in "MyButton" button
+     //And I should see "Button Title" in "MyButton" button
+     //Then I should see "Button Title" in "MyButton" button
+ });
+ @endcode
+ 
+ @Note
+ Step definitions are checked in a "Last In First Out" order. If it happens that there are more than one definition matches a step, the last registered definition will be used.
+ 
+ @param prepositions array of strings to be used as the preposition of the step definiton
+ @param definitionString the regular expression that will checked against each Given step line.
+ @param body the code block that will be executed if match is occured.
+ */
+OBJC_EXTERN void Match(NSArray *prepositions, NSString * definitionString, CCIStepBody body);
+
+/**
+ Step implementation can be also a useable code.
+ If it the case that you want to call a previously defined step implementation, you can call this definition using this special step function.
+ 
+ @Note
+ Using this function, you do not need to worry about the preposition of the step; you just pass in the step line without defining the preposition.
+ 
+ @b Example:
+ @code
+     //The first step definiton
+ Match(@[@"When", @"And", @"Then"], @"^I should see \"([^\\\"]*)\" in (?:the )?\"([^\\\"]*)\" (?:button|view|label)$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+ });
+ 
+     //The another step definiton that will make use of the previousely defined step
+ When(@"^I write \"([^\\\"]*)\" (?:in|into) \"([^\\\"]*)\" field$" ,  ^void(NSArray *args, id userInfo) {
+     //Step implementation goes here
+     //Here you can call the previously defined step.
+ step(@"I should see \"%@\" in the \"%@\" label", args[0], args[1]);
+ });
+ @endcode
+
+ @param testCase the test case that will execute this step. Can be nil.
+ @param stepLine the step line string to be executed
+ */
+OBJC_EXPORT void step(id testCase, NSString * stepLine, ...);
+
+/**
+ Swift alias for step(stepLine) function.
+ @param testCase the test case that will execute this step. Can be nil.
+ @param stepLine the step line string to be executed
+ */
+OBJC_EXTERN void SStep(id testCase, NSString * stepLine);
+
+
+#pragma mark - Hocks
+/**
+ C function that registers a code block to be called only once before executing any test case.
+ You can call this function as much as you want, but only the last registerd code block will be used.
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @param beforeStartBlock code block that will be executed once before any test cases.
+ */
+OBJC_EXTERN void beforeStart(void(^beforeStartBlock)(void));
+
+
+/**
+ C function that registers a code block to be called only once after executing all test cases.
+ You can call this function as much as you want, but only the last registerd code block will be used.
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @param afterFinishBlock code block that will be executed once after all test cases finish execution.
+ */
+OBJC_EXTERN void afterFinish(void(^afterFinishBlock)(void));
+
+
+/**
+ C function that registers a code block to be called before each scenario.
+ Code blocks registerd with this function will run before each scenario in the same order they were orignally registered; that's it, FIFO (First In First Out).
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @param beforeEachBlock code block that will be executed before executing the scenario, this block receives an instance of the scenario that will be executed.
+ */
+OBJC_EXTERN void before(CCIScenarioHockBlock beforeEachBlock);
+
+
+/**
+ C function that registers a code block to be called after each scenario.
+ Code blocks registerd with this function will run after each scenario in reversed order compared to the order they were orignally registered; that's it, LIFO (Last In First Out)
+ 
+ @Note
+ All code blocks registerd with this function, will run regardless the scenario has been passed or not
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @param afterEachBlock code block that will be executed after executing the scenario, this block receives an instance of the scenario that has been executed.
+ */
+OBJC_EXTERN void after(CCIScenarioHockBlock afterEachBlock);
+
+
+/**
+ C function that registers a code block to be called before each scenario that has one or more tag that matches one or more tags passed to this function.
+ Code blocks registerd with this function will run before each matching scenario in the same order they were orignally registered; that's it, FIFO (First In First Out)
+ 
+ @Note
+ Do not prefix any tag you pass with @ symbol
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @param tags array of strings that will be used to match specific scenarios
+ @param beforeTaggedBlock code block that will be executed before executing the scenario, this block receives an instance of the scenario that will be executed.
+ */
+OBJC_EXTERN void beforeTagged(NSArray * tags, CCIScenarioHockBlock beforeTaggedBlock);
+
+
+/**
+ C function that registers a code block to be called after each scenario that has one or more tag that matches one or more tags passed to this function.
+ Code blocks registerd with this function will run after each matching scenario in reversed order compared to the order they were orignally registered; that's it, LIFO (Last In First Out)
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ @Note
+ All code blocks registerd with this function, will run regardless the matching scenario has been passed or not
+ 
+ @Note
+ Do not prefix any tag you pass with @ symbol
+ 
+ @param tags array of strings that will be used to match specific scenarios
+ @param afterTaggedBlock code block that will be executed after executing the scenario, this block receives an instance of the scenario that has been executed.
+ */
+OBJC_EXTERN void afterTagged(NSArray * tags, CCIScenarioHockBlock afterTaggedBlock);
+
+
+/**
+ C function that registers a code block to be used to call the scenario execution block.
+ Code blocks registerd with this function will receive two parameters: scenario instance and scenario execution block as a parameter.
+ 
+ If more than one code block matches the scenario, you are still required to call the scenario execution from each registered code block. However, your scenario will be executed once as it is supposed to be.
+ 
+ Matching against around blocks happens in FIFO (First In First Out) order; in case more than one block has matched the same scenario, then they are nested.
+ 
+ @Note
+ Failing to call the scenario execution block, will prevent the scenario from being executed.
+ 
+ @b Example of more than one match
+ 
+ There are three registerd blocks with tags that matches the same scenario, the followin nesting calls will happen:
+ 
+ @code
+ Third Around Match
+ Block = contains code block that executes the Second Around Match
+ Second Around Match
+ Block = contains code block that executes the First Around Match
+ First Around Match
+ Block = A call Scenario Exection Block@endcode
+ 
+ 
+ @Note
+ Do not prefix any tag you pass with @@ symbol
+ 
+ @Note
+ This function should not be called after calling @a beginExecution.
+ 
+ 
+ @param tags array of strings that will be used to match specific scenarios
+ @param aroundScenarioBlock code block that will be executed for each scneario, this block receives an instance of the scenario and the scenario execution block.
+ */
+OBJC_EXTERN void around(NSArray * tags, CCIScenarioExecutionHockBlock aroundScenarioBlock);
+
+#pragma mark - Assertion and Errors
+/**
+ Boolean assertion function. Use it where you usually use NSAssert or assert.
+ 
+ Using this assertion function in your step implementations, guarantees proper error reporting
+ 
+ @param expression boolean expression
+ @param failureMessage formatted a string describe what went wrong in case expression is evaluated to false
+ */
+OBJC_EXTERN void CCIAssert(BOOL expression, NSString * failureMessage, ...);
+
+/**
+ Swift alias for CCIAssert
+ @param expression boolean expression
+ @param failureMessage a string describe what went wrong in case expression is evaluated to false
+ */
+OBJC_EXTERN void CCISAssert(BOOL expression, NSString * failureMessage);
+
+
+/**
+ Throws an exception with the specified reason.
+ Cucumberish will handle this exception and show it as an issue with executing the current step
+ 
+ @param reason the failure reason
+ */
+
+OBJC_EXTERN void throwCucumberishException(NSString *reason, ...);
+
+
+/**
+ Swift alias for throwCucumberishException;
+ @param reason the failure reason
+ */
+OBJC_EXTERN void SThrowCucumberishException(NSString *reason);
+

data/XCFit/Classes/Cucumberish/Core/Managers/CCIFeaturesManager.h

@@ -0,0 +1,72 @@
+//
+//  CCIFeaturesManager.h
+
+//
+//  Created by Ahmed Ali on 02/01/16.
+//  Copyright © 2016 Ahmed Ali. All rights reserved.
+//
+//
+// 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.
+
+#import <Foundation/Foundation.h>
+@class CCIFeature;
+
+/**
+ CCIFeaturesManager is a singleton class and its main purpose is to parse feature files and map them to their associated Classes.
+ This class is utilized by Cucumberish main class. Useually you do not need to deal with it manually.
+ */
+@interface CCIFeaturesManager : NSObject
+
+/**
+ After calling parseFeatureFiles:withTags: this array will contain all the parsed features.
+ */
+@property (nonatomic, readonly) NSArray<CCIFeature *> * features;
+
+/**
+ Returns the singleton class of CCIFeaturesManager
+ */
++ (instancetype)instance;
+
+/**
+ Parses the feature files that matches one or more of the passed tags if any.
+ 
+ @Note tags should not be prefixed with @@ symbole
+ 
+ @param featureFiles array of NSURL that presents the feature file paths
+ @param tags array of strings to filter which the features that will be parsed to be executed, if nil then all feature files will be parsed.
+ @param tags array of string to filter which features should not be executed.
+ 
+ @Note tags in featureTags parameter should not exist in the execludedTags parameter as it doesn't make any sense.
+ */
+- (void)parseFeatureFiles:(NSArray *)featureFiles bundle:(NSBundle *)bundle withTags:(NSArray *)tags execludeFeaturesWithTags:(NSArray *)execludedFeatures;
+
+/**
+ Associates the passed class with the passed feature instance for later usage.
+ It is mainly used to eliminate the need create a class for a feature multiple times.
+ @param class
+ @param feature
+ */
+- (void)setClass:(Class)klass forFeature:(CCIFeature *)feature;
+
+/**
+ Returns the passed class that is associated with the passed feature.
+ @param class
+ */
+- (CCIFeature *)getFeatureForClass:(Class)klass;
+@end