cs-bdd 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e38a42a921fdc0a1307703e4189a74192a35c6ae
-  data.tar.gz: 15b44bd418b4855ab0159ed539d336f077d62579
+  metadata.gz: e520c9c43c7d3a85a0caa2b8f9ab6a906de0e882
+  data.tar.gz: bf35813d182a41587e491050199114e8de3e0381
 SHA512:
-  metadata.gz: 5b97da3a3559e75cf7f2b269177055067c6a27c5a73b1a9f7f608046350ba5397c500922b5349ee5fa19444accf65127ab39501759c8b0aaf34dffa4d5fa64fd
-  data.tar.gz: a40f6ca84b956b0fc230680ab0a2351f0ce6efb586d60d3cfc55e2b4b2a88bb4219af27146c28f4da18b31ccf3828ab03186fa1da116695d740891614d1d7783
+  metadata.gz: be9e5f19148f6d64b59cc4142a209168bd590f54a6ad5cb7674b9d9b691d543779d18717d71f878c0c9436d379bd469a3f9a5b487cc6ae58116200b31b430783
+  data.tar.gz: 241a8fd3ff44a757bb1e36a82a6d51c9b006740cef07839d5a560e9acc2220b850a90dab9d09651bc4e5ee53a83af9f73955c9d464834d244668b6c9b4128c84

data/README.md

@@ -2,6 +2,22 @@
 
 A simple gem to generate all the files needed to create a project that will support calabash for Android and iOS.
 
+[Calabash](http://calaba.sh/) uses cucumber to support functional tests in Android and iOS and has one gem for each Platform:
+
+  > calabash-android (for Android) [(link)](https://github.com/calabash/calabash-android)
+  
+  > calabash-cucumber (for iOS) [(link)](https://github.com/calabash/calabash-ios)
+
+The project structure is based on [this site](http://rubygemtsl.com/2014/01/06/designing-maintainable-calabash-tests-using-screen-objects-2). This structure is based on three layers: the features, the steps and the screens.
+
+  1. Features: Contains all the features of the project, this features are Platform independent and will run when testing both Android and iOS;
+  2. Steps: Contains all the steps implementation of the features. This steps are Platform independent and will run when testing both Android and iOS;
+  3. Screens: Contains all the screens definition. A screen definition must contain an identification, the declaration of all the elements of the screen and the declaration of its actions. This layer is Platform dependent. This occurs because, in almost every project, the identification of the elements of the screens varies between the Platforms. One example is that in Android almost all elements have an id, but in iOS is most common to identify the elements by accessibility label. The Platform dependent screens must has the same name and same methods. This will allow your steps to be unique between platforms
+
+  > One example of this structure can be found in the generated files (see Usage) on the file base_steps.rb. This file implements some common steps to help you start your tests and show you how to uses the Platform dependent screens
+  
+  > In my experience with tests I saw some cases that we will need to test features that are Platform dependent, like screens that send SMS which will only happen in Android. For this to happen, the generated structure has Features and Steps that are Platform dependent and can be found inside the folder `features/android` and `features/ios` of the generated project.
+
 ## Installation
 
 Install it as:
@@ -10,7 +26,83 @@ Install it as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem works only in the terminal, so for help, type:
+
+```
+  cs-bdd
+  cs-bdd generate
+```
+
+To see the gem version type:
+
+```
+  cs-bdd version
+```
+
+To generate a structure of one project that can support both Android and iOS features for Calabash type:
+
+```
+  cs-bdd new ProjectName
+```
+
+This command will create a folder named ProjectName in the current directory and will create all the files needed. This gem support localizations. To create a localized project, in Portuguese, type:
+
+```
+  cs-bdd new ProjectName --lang=pt
+```
+
+  > The default language is English ('en'). The elements of Gherkin such as Given, When, Than, And, Scenario will be translated to all Gherkin supported languages, but the generators accept only a little quantity of languages(see than in the folder: `lib/cs/bdd/locales`). 
+  
+  > **CS-BDD doesn't support your mother language?** No problem make a fork, create your yml translation file, uses the en.yml file as a template. Translate it and make a pull request. There are only 15 lines to be translated, this will take no time.
+  
+  > **Don't know how to identify your yml file?** See the Gherkin supported languages [here](https://github.com/cucumber/gherkin/blob/master/lib/gherkin/i18n.json).
+
+Once the project is created, opens the folder (`cd ProjectName`). 
+
+> **The generators commands ONLY WORK in the ROOT FOLDER of the project**.
+
+There are nine generators that are responsible to create the templates for Features, Step definitions and Screens.
+
+For Features you can type:
+
+```
+  cs-bdd generate feature FeatureName
+  cs-bdd generate aFeature AndroidFeatureName
+  cs-bdd generate iFeature iOSFeatureName
+```
+
+  > The feature generator will create a Platform independent feature and its files. So this command will create the FeatureName.feature file in the folder `feature`, the file FeatureName_steps.rb in the folder `features/step_definitions`, the the files FeatureName_screen.rb in the folders `features/android/screens` and `features/ios/screens`.
+
+  > The aFeature and iFeature generator will create and Platform dependent feature so, for example, the aFeature generator will create the AndroidFeatureName.feature file in the folder `features/android/features`, the file AndroidFeatureName_steps.rb in the folder `features/androd/step_definitions` and the screen file AndroidFeatureName_screen.rb in the folder `features/android/screens`.
+
+Don't forget about internationalization. All the generators accept the option `--lang=pt` or with some other language.
+
+For Steps definitions you can type:
+
+```
+  cs-bdd generate step StepName
+  cs-bdd generate aStep AndroidStepName
+  cs-bdd generate iStep iOSStepName
+```
+
+  > The step generator will create a Platform independent step file named StepName_steps.rb in the folder `features/step_definitions`
+  
+  > The aStep generator will create an Android step file named AndroidStepName_steps.rb in the folder `features/android/step_definitions`
+  
+  > The iStep generator will create an iOS step file name iOSStepName_steps.rb in the folder `features/ios/step_definitions`
+
+For Screens type:
+
+```
+  cs-bdd generate screen ScreenName
+  cs-bdd generate aScreen AndroidScreenName
+  cs-bdd generate iScreen iOSScreenName
+```
+
+  > The screen generator will create both Platform dependent screens in the folders `features/android/screens` and `features/ios/screens`.
+  
+  > The aScreen and iScreen will create only the Android and iOS dependent screens respectively.
+
 
 ## Contributing
 

data/bin/cs-bdd

@@ -73,6 +73,15 @@ module CS
         create_steps_file name, 'IOS'
       end
 
+      desc "screen [RESOURCE_NAME]", "Generates the Android and iOS dependent screens"
+      option :lang, :banner => "any of the gherkin supported languages", :default => :en
+      def screen name
+        I18n.config.default_locale = options[:lang]
+        in_root_project_folder?
+        create_screen_file name, 'Android'
+        create_screen_file name, 'IOS'  
+      end
+
       desc "aScreen [RESOURCE_NAME]", "Generates an Android dependent screen"
       option :lang, :banner => "any of the gherkin supported languages", :default => :en
       def aScreen name

data/lib/cs/bdd/version.rb

@@ -1,5 +1,5 @@
 module CS
   module BDD
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/skeleton/features/ios/support/01_launch.rb

@@ -90,6 +90,10 @@ def reinstall_app
     # You can either pass it as a parameter in the cucumber command or set it here
     #ENV["APP_BUNDLE_ID"] = "bundle_id"
 
+    # Booting the device to avoid problems with the app installation
+    %x(open -a "iOS Simulator" --args -CurrentDeviceUDID #{ENV['DEVICE_TARGET']} > /dev/null)
+    sleep(7)
+
     # Reinstalling the app using terminal commands
     system( "echo 'Installing the app...'" )
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cs-bdd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Oscar Tanner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,13 +110,13 @@ files:
 - lib/skeleton/config/scripts/ios/run_tests_all_devices.sh
 - lib/skeleton/features/android/android_screen_base.rb
 - lib/skeleton/features/android/features/.gitkeep
-- lib/skeleton/features/android/steps_definition/.gitkeep
+- lib/skeleton/features/android/step_definitions/.gitkeep
 - lib/skeleton/features/android/support/app_installation_hooks.rb
 - lib/skeleton/features/android/support/app_life_cycle_hooks.rb
 - lib/skeleton/features/android/support/hooks.rb
 - lib/skeleton/features/ios/features/.gitkeep
 - lib/skeleton/features/ios/ios_screen_base.rb
-- lib/skeleton/features/ios/steps_definition/.gitkeep
+- lib/skeleton/features/ios/step_definitions/.gitkeep
 - lib/skeleton/features/ios/support/01_launch.rb
 - lib/skeleton/features/ios/support/02_pre_stop_hooks.rb
 - lib/skeleton/features/support/env.rb