skeleton-ui 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c301b9d52687f3843031beda4cd608a18a2fcc06734ce862b3a014bc0f2d9d2f
-  data.tar.gz: d3caaf041f46998c118ec1903cad5b9f62729a41cedddf68b3ebf32da076c7e8
+  metadata.gz: 9596dca337705a799dda4d6536bd2c35b9a218eec53feed0c003168da8d7a3b4
+  data.tar.gz: 44213fdd53bf4e2d4f7392036ebd43a99918654a1e2bba9c9687e958e8abf7d5
 SHA512:
-  metadata.gz: 499d4a571d2e945b930d9e867a94467bbdf45f05cf319e5d1c0b94b26c79c3ade9d88ae60d5c2779e2fe20c6f9fec89e0cdc9f0202585d4fba581b385bce6b3b
-  data.tar.gz: 9d46204ef237d3aab08e2c9fa7d54e8d393a7cb2de735a013f06df04c1dd07c82e189a5715fbc3f0068b175da8089f2fe71741f7d3074a385cb444e970bc5310
+  metadata.gz: 659f23915b0a111a20bf61b4c6ee406e068b88f0a3132a12478ca224b9fa4dae1e56a85559fcb83805747e81e3b709fb37623b8585370fa1bd83e6a0bb507a11
+  data.tar.gz: 26a20a7c75f94cb2d75e51d4c8a7a0bf7074a86bd965b19eee1205a1754c54e04bb20f9bccff4391e1bdd0dde86a265f7b6252e290c4dbd56a5004e262e7d176

data/.githooks/commit-msg

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+commit_regex="(ISSUE-[0-9]+|merge)"
+if ! grep -iqE "$commit_regex" "$1"; then
+  echo "You need to add github issue tag in your commit, example: 'ISSUE-33: my pretty commit'"
+  exit 1
+fi
+
+list=$(git diff --cached --name-only --diff-filter=ACRM)
+for file in $list; do
+  if [[ $file == *"root.rb"* || $file == *"project.pbxproj"* ]]; then
+    echo "You can't commit file $file. Please reset it and try again."
+    exit 1
+  fi
+done

data/.gitignore

@@ -1,7 +1,6 @@
 .DS_Store
-*.xcodeproj
 *.lock
-*.xcworkspace
+*.xcuserdatad
 /PageObjects/
 /attach/
 /Attachments/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Makefile

@@ -0,0 +1,3 @@
+init:
+	git config core.hooksPath .githooks
+	git config advice.ignoredHook false

data/README.md

@@ -21,7 +21,55 @@ Installation:
 
 Usage:
 ------
-    $ skeleton scan -h
+    $ skeleton --help
+
+    DESCRIPTION:
+
+    CLI for fast generating multi language page objects from iOS and Android screens.
+
+    COMMANDS:
+
+    clear Clear user cache
+    scan  Make screen objects
+
+    GLOBAL OPTIONS:
+
+    -h, --help
+    Display help documentation
+
+    -v, --version
+    Display version information
+
+    -t, --trace
+    Display backtrace when an error occurs
+
+        $ skeleton scan --help
+            
+            EXAMPLES:
+            
+            skeleton scan -p (ios or android) -u 749575366595763538563 -b com.my.bundle
+            
+            OPTIONS:
+            
+            -p, --platform PLATFORM
+            Set device platform: android or ios
+            
+            -u, --udid UDID
+            Set device UDID
+            
+            -b, --bundle BUNDLE
+            Set Bundle ID for your app [required for iOS]
+        
+        $ skeleton clear --help
+            
+            EXAMPLES:
+            
+            skeleton clear
+    
+Docs:
+------
+
+- [Setting up Skeleton for working with iOS real devices](https://github.com/forqa/skeleton/blob/master/docs/real-ios-device-config.md)
 
 ## License
 

data/docs/real-ios-device-config.md

@@ -0,0 +1,15 @@
+## Setting up Skeleton for working with iOS real devices
+
+### First manipulation (sign .xcodeproj)
+Open Skeleton.xcodeproj in Xcode ($GEMDIR/gems/skeleton-ui-XXX/xcodeproj/Skeleton.xcodeproj).
+For both the Skeleton and SkeletonUI targets, select "Automatically manage signing" in the "General" tab, and then select your Development Team. This should also auto select Signing Ceritificate. The outcome should look as shown below:
+![Signing XCProject](sign_xcproj.png)
+
+
+### Second manipulation (trust the developer)
+![Untrusted developer](untrusted-dev.png)
+
+If you see this pop-up, you can go to Settings => General => Device Management on the device to trust
+the developer and allow the `SkeletonUI-Runner` app to be run (see [Apple
+documentation for more information](https://support.apple.com/en-us/HT204460)).
+

data/lib/skeleton/android.rb

@@ -17,7 +17,7 @@ class Android < Base
     log.info('We starting to skeleton your screen 🚀')
     create_page_objects
     save_screenshot
-    save(page_source)
+    save(code: page_source)
     log.info('We successfully skeletoned your screen 👻')
   end
 
@@ -26,21 +26,27 @@ class Android < Base
   def create_locator_by_resouce_id(line)
     method_name = line[RESOURCE_ID]
     method_name.slice!(/.*id\//)
-    code_generation(method_name, ID, line[RESOURCE_ID])
+    code_generation(method_name: method_name,
+                    locator_type: ID,
+                    value: line[RESOURCE_ID])
   end
 
   def create_locator_by_content_desc(line)
     method_name = "#{line[CLASS]}#{increment_locator_id}"
     method_name.slice!(/.*\./)
     locator = "//#{line[CLASS]}[@#{CONTENT_DESC}='#{line[CONTENT_DESC]}']"
-    code_generation(method_name, XPATH, locator)
+    code_generation(method_name: method_name,
+                    locator_type: XPATH,
+                    value: locator)
   end
 
   def create_locator_by_text(line)
     method_name = "#{line[CLASS]}#{increment_locator_id}"
     method_name.slice!(/.*\./)
     locator = "//#{line[CLASS]}[@#{TEXT}='#{line[TEXT]}'"
-    code_generation(method_name, XPATH, locator)
+    code_generation(method_name: method_name,
+                    locator_type: XPATH,
+                    value: locator)
   end
 
   def create_locator(line)
@@ -59,14 +65,9 @@ class Android < Base
     page_source_html.css('node').each { |line| create_locator(line) }
   end
 
-  def code_generation(method_name, locator_type, value)
+  def code_generation(method_name:, locator_type:, value:)
     java = java(method_name, locator_type, value)
-    save(java, format: Language::JAVA)
-  end
-
-  def save(code, format: 'xml')
-    file_path = "#{PAGE_OBJECTS_FOLDER}/#{@platform}_#{TIMESTAMP}.#{format}"
-    File.open(file_path, 'a') { |f| f.write(code) }
+    save(code: java, format: Language::JAVA)
   end
 
   def page_source
@@ -75,7 +76,7 @@ class Android < Base
       dump = `adb -s #{@udid} shell uiautomator dump | egrep -o '/.*?xml'`
       @page_source = `adb -s #{@udid} shell cat #{dump}`
       if @page_source.empty?
-        log.fatal('Something went wrong.') # FIXME
+        log.fatal('Something went wrong. Check your device')
         Process.exit(1)
       end
       log.info('Successfully getting Screen Source Tree 🔥')

data/lib/skeleton/base.rb

@@ -1,11 +1,9 @@
 require_relative 'languages.rb'
+require_relative 'root.rb'
 
 class Base
   include Language
 
-  # ROOT_DIR_FOR_DEBUG = File.expand_path('..', Dir.pwd)
-  ROOT_DIR = "#{`gem environment gemdir`.strip}" \
-               "/gems/skeleton-ui-#{Skeleton::VERSION}"
   PAGE_OBJECTS_FOLDER = "#{ROOT_DIR}/PageObjects"
   ATTACHMENTS_FOLDER = "#{ROOT_DIR}/Attachments"
   TIMESTAMP = (Time.now.to_f * 1000).to_i
@@ -28,6 +26,11 @@ class Base
 
   protected
 
+  def save(code:, format: 'xml')
+    file_path = "#{PAGE_OBJECTS_FOLDER}/#{@platform}_#{TIMESTAMP}.#{format}"
+    File.open(file_path, 'a') { |f| f.write(code) }
+  end
+
   def create_logger
     @log = Logger.new(STDOUT)
     @log.level = Logger::INFO
@@ -58,7 +61,7 @@ class Base
     space_i = 0
     method_name[0] = method_name[0].downcase
     method_name.each_char.with_index do |char, char_i|
-      if /[ -!$%^&*()_+|~=`{}\[\]:";'<>?,.\/]/.match(char)
+      if /[ -!@#$%^&*()_+|~=`{}\[\]:";'<>?,.\/]/.match(char)
         method_name[char_i - space_i] = ''
         method_name[char_i - space_i] = method_name[char_i - space_i].capitalize
         space_i += 1
@@ -78,5 +81,4 @@ class Base
 
   def code_generation
   end
-
-end
+end

data/lib/skeleton/ios.rb

@@ -26,7 +26,7 @@ class IOS < Base
     page_source
     create_page_objects
     save_screenshot
-    save(page_source)
+    save(code: page_source)
     log.info('We successfully skeletoned your screen 👻')
   end
 
@@ -45,13 +45,17 @@ class IOS < Base
 
   def create_locator_by_id(locator)
     method_name = locator.strip
-    code_generation(method_name, ACC_ID, locator)
+    code_generation(method_name: method_name,
+                    locator_type: ACC_ID,
+                    value: locator)
   end
 
   def create_locator_by_label(text, type)
     method_name = "#{type}#{increment_locator_id}"
     locator = "#{LABEL} like '#{text}'"
-    code_generation(method_name, NSPREDICATE, locator)
+    code_generation(method_name: method_name,
+                    locator_type: NSPREDICATE,
+                    value: locator)
   end
 
   def create_page_objects
@@ -78,12 +82,12 @@ class IOS < Base
     locator.nil? ? '' : locator[1]
   end
 
-  def code_generation(method_name, locator_type, value)
+  def code_generation(method_name:, locator_type:, value:)
     java = java(method_name, locator_type, value)
-    ruby = ruby(method_name, locator_type, value)
+    save(code: java, format: Language::JAVA)
 
-    save(java, format: Language::JAVA)
-    save(ruby, format: Language::RUBY)
+    ruby = ruby(method_name, locator_type, value)
+    save(code: ruby, format: Language::RUBY)
   end
 
   def page_source
@@ -104,7 +108,7 @@ class IOS < Base
       if @page_source.empty?
         log.fatal('Something went wrong. Try to sign Skeleton ' \
                   'and to trust it in the iOS settings.')
-        Process.exit(1)
+        raise
       end
       log.info('Successfully getting Screen Source Tree 🔥')
     end
@@ -116,18 +120,13 @@ class IOS < Base
       log.info('Checking iOS UDID 👨‍💻')
       simulators = `xcrun simctl list`
       @simulator = simulators.include?(@udid)
-      if !@simulator && !`instruments -s devices`.include?("[#{@udid}]")
+      if !@simulator && !`instruments -s devices`.include?(@udid)
         log.fatal("No such devices with UDID: #{@udid}")
-        Process.exit(1)
+        raise
       end
     end
   end
 
-  def save(code, format: 'xml')
-    file_path = "#{PAGE_OBJECTS_FOLDER}/#{@platform}_#{TIMESTAMP}.#{format}"
-    File.open(file_path, 'a') { |f| f.write(code) }
-  end
-
   def save_screenshot
     log.info('Saving screenshot 📷')
     png_path = "#{XCRESULTS_FOLDER}/Attachments/*.png"

data/lib/skeleton/root.rb

@@ -0,0 +1,5 @@
+class Base
+  # ROOT_DIR_FOR_DEBUG = File.expand_path('..', Dir.pwd)
+  ROOT_DIR = "#{`gem environment gemdir`.strip}" \
+               "/gems/#{Skeleton::GEM_NAME}-#{Skeleton::VERSION}"
+end

data/lib/skeleton/version.rb

@@ -1,4 +1,4 @@
 module Skeleton
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
   GEM_NAME = 'skeleton-ui'
 end

data/skeleton.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_dependency "colorize", "~> 0.8.1"
   spec.add_dependency "nokogiri", "~> 1.8.2"
   spec.add_dependency "fileutils"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeleton-ui
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - a.alterpesotskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -102,20 +116,27 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".githooks/commit-msg"
 - ".gitignore"
+- ".rspec"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - bin/skeleton
+- docs/real-ios-device-config.md
+- docs/sign_xcproj.png
+- docs/untrusted-dev.png
 - lib/skeleton.rb
 - lib/skeleton/android.rb
 - lib/skeleton/base.rb
 - lib/skeleton/ios.rb
 - lib/skeleton/languages.rb
+- lib/skeleton/root.rb
 - lib/skeleton/version.rb
 - skeleton.gemspec
 - xcodeproj/Skeleton.xcodeproj/project.pbxproj