skeleton-ui 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ee835f042191dc5d9b1f8965207c85343d4f447e84e4031d253e8a5693cff84
-  data.tar.gz: 43cf9b138e3504bb241c904f83b7476f7463e9bedeebf6cb3556d89b2dbaf2c3
+  metadata.gz: c8ef2154e88b5a4fa1a97058af39362b3336a44827407110bcb8b640fa9a08fd
+  data.tar.gz: 68aaa372fa4ed72015cf96524e3d376b359249fb4a0b023e55293ab2eb99897a
 SHA512:
-  metadata.gz: f41d1362e26ef0c6ae9a01977ec6596b34c3d98015cfe8486da6634f1e22a056cb176985862d1a4f54faeb603cd93d781ba1bcf787679204cc52b17852965772
-  data.tar.gz: a2fca13369b1ca1f0c767a6e3460fb4c04fdd4e21418e9ff0f1b21a759653953eba68a34c4703371775025a3158f02a85cf69ab5b8c9c899387f7fcd09074e60
+  metadata.gz: 2412554c9d911309c6ae7c626b85c5af8a00fe4b0ac0b733129b3096527b7f3f3a7459137e2d2695def1c9ae32f8105c67e8f7bf27c5f6a387f23f0bc0c648a6
+  data.tar.gz: 5543e179d7f1a6e85f3231ff1546ba126d0cff836d5254e0f6bb94c846fab22da4f5d6e8316df7d058bc7e8e6a8eeda8bc3aa87e37b6ff9a73a41b2779356868

data/.gitignore

@@ -5,3 +5,6 @@
 /attach/
 /Attachments/
 /XCResults/
+*.png
+/.idea/
+/pkg/

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Style/Tab:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/AlignParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -5,6 +5,9 @@ CLI for fast generating multi language page objects from iOS and Android screens
 Prerequisites:
 --------
 
+#### Global
+- Install [imagemagick](http://brewformulas.org/Imagemagick).
+
 #### Android
 - Install [SDK Tools](http://developer.android.com/sdk/installing/index.html?pkg=tools).
 - SDK tools are added to your $PATH. [OSX](https://stackoverflow.com/posts/19764254/revisions)
@@ -13,7 +16,6 @@ Prerequisites:
 #### iOS
 - Install [Xcode](https://developer.apple.com/xcode/download/).
 - Install [Xcode Command Line Tools](http://railsapps.github.io/xcode-command-line-tools.html).
-- For real devices you need to sign skeleton in xcodeproj ([like appium](https://github.com/appium/appium-xcuitest-driver/blob/master/docs/real-device-config.md)).
 
 Installation:
 ------
@@ -76,6 +78,11 @@ Usage:
             EXAMPLES:
             
             skeleton clear
+            
+            OPTIONS:
+            
+            -p, --port PORT
+            Set web-server port
     
 Docs:
 ------

data/bin/skeleton

@@ -34,8 +34,10 @@ module Skeleton
 		c.syntax = 'skeleton server'
 		c.description = 'Run skeleton web-server'
 		c.example 'description', 'skeleton server'
-		c.action do |_args, _options|
-			system('cd ../html/ && ruby server.rb')
+		c.option '-p', '--port PORT', String, 'Set web-server port'
+		c.action do |_args, options|
+			options.default(port: 4567)
+			system("cd ../html/ && ruby server.rb #{options.port}")
 		end
 	end
 end

data/html/server.rb

@@ -1,5 +1,7 @@
 require 'sinatra'
 
+set :port, ARGV[0]
+
 get '/:file' do
   send_file params[:file]
 end

data/html/template.html.erb

@@ -20,12 +20,12 @@
           </div>
         </div>
         <div class="col-md-8">
-          <h4 class="mb-3">PageObjects:</h4>
+          <h4 class="mb-3">Page Objects:</h4>
           <div class="content" id="content">
             <pre><code><%= @pageobject %></code></pre>
           </div>
           <br>
-          <h4 class="mb-3">ElementsTree:</h4>
+          <h4 class="mb-3">Elements Tree:</h4>
           <div class="content" id="content">
             <pre><code><%= @elements_tree %></code></pre>
           </div>

data/lib/skeleton.rb

@@ -3,6 +3,9 @@ require 'fileutils'
 require 'nokogiri'
 require 'logger'
 require 'colorize'
+require 'mini_magick'
+require_relative 'skeleton/languages.rb'
+require_relative 'skeleton/root.rb'
 require_relative 'skeleton/version'
 require_relative 'skeleton/base'
 require_relative 'skeleton/ios'
@@ -10,8 +13,6 @@ require_relative 'skeleton/android'
 
 module Skeleton
 	class Skeleton
-		include Language
-
 	  attr_accessor :platform, :udid, :bundle_id
 
 	  def initialize(options)
@@ -30,39 +31,55 @@ module Skeleton
 	  end
 
 	  def udid=(udid)
-	    if udid.nil?
-	      raise 'Not set udid [-u arg]'
-	    end
+      raise 'Not set udid [-u arg]' if udid.nil?
 	    @udid = udid
 	  end
 
 	  def bundle_id=(bundle_id)
-	    if @platform == 'ios' && bundle_id.nil?
-	      raise 'Not set bundle_id [-b arg]'
-	    end
+      raise 'Not set bundle_id [-b arg]' if @platform == 'ios' && bundle_id.nil?
 	    @bundle_id = bundle_id
 	  end
 
-	  def run
+    def run
 			@driver.clear
 			@driver.precondition
 			@driver.skeletoner
 			fill_html
-			@driver.log.info('Get it: http://localhost:4567/index.html 😍')
-		end
+			open_url
+    end
 
 		def fill_html
-			languages = ['ruby', 'java']
-			languages.each do |lang|
-				type = language_type(lang: lang)
-				@pageobject = File.read(Dir["#{Base::PAGE_OBJECTS_FOLDER}/*.#{type}"].first)
-				@elements_tree = File.read(Dir["#{Base::PAGE_OBJECTS_FOLDER}/*.xml"].first)
-				screenshot = Dir["#{Base::ATTACHMENTS_FOLDER}/*.png"].first
-				FileUtils.cp_r(screenshot, "../html/screenshot.png")
+			language = Language.new
+			%w[ruby java].each do |lang|
+        attach_image
+				type = language.type(lang)
+        folder = Base::PAGE_OBJECTS_FOLDER
+				@pageobject = File.read(Dir["#{folder}/*.#{type}"].first)
+				@elements_tree = File.read(Dir["#{folder}/*.xml"].first)
+        if @driver.class == Android
+          @elements_tree = Nokogiri::XML(@elements_tree).to_s
+          @elements_tree.gsub!('<', '&lt;')
+          @elements_tree.gsub!('>', '&gt;')
+        end
 				template = File.read('../html/template.html.erb')
 				result = ERB.new(template).result(binding)
 				File.open("../html/#{lang}.html", 'w+') { |f| f.write(result) }
 			end
+    end
+
+    def attach_image
+      screenshot = Dir["#{Base::ATTACHMENTS_FOLDER}/*.png"].first
+      image = MiniMagick::Image.new(screenshot)
+      image.rotate(90) if image.width > image.height
+      FileUtils.cp_r(screenshot, '../html/screenshot.png')
+    rescue MiniMagick::Error => e
+      @driver.log.error(e)
+    end
+
+		def open_url
+			url = 'http://localhost:4567/index.html'
+			`open #{url}`
+			@driver.log.info("Look at your pretty page objects: #{url} 😍")
 		end
 
 	  def ios?

data/lib/skeleton/android.rb

@@ -1,16 +1,23 @@
 class Android < Base
-  RESOURCE_ID = 'resource-id'
-  CONTENT_DESC = 'content-desc'
-  TEXT = 'text'
-  ID = { java: :id }
-  XPATH = { java: :xpath }
-  CLASS = 'class'
+  RESOURCE_ID = 'resource-id'.freeze
+  CONTENT_DESC = 'content-desc'.freeze
+  TEXT = 'text'.freeze
+  CLASS = 'class'.freeze
+  ID = {
+    java: :id,
+    ruby: :id
+  }.freeze
+  XPATH = {
+    java: :xpath,
+    ruby: :xpath
+  }.freeze
 
   attr_accessor :platform, :udid
 
   def initialize(options)
     self.platform = options.platform
     self.udid = options.udid
+    @language = Language.new
   end
 
   def skeletoner
@@ -28,7 +35,7 @@ class Android < Base
     method_name.slice!(/.*id\//)
     code_generation(method_name: method_name,
                     locator_type: ID,
-                    value: line[RESOURCE_ID])
+                    locator_value: line[RESOURCE_ID])
   end
 
   def create_locator_by_content_desc(line)
@@ -37,7 +44,7 @@ class Android < Base
     locator = "//#{line[CLASS]}[@#{CONTENT_DESC}='#{line[CONTENT_DESC]}']"
     code_generation(method_name: method_name,
                     locator_type: XPATH,
-                    value: locator)
+                    locator_value: locator)
   end
 
   def create_locator_by_text(line)
@@ -46,7 +53,7 @@ class Android < Base
     locator = "//#{line[CLASS]}[@#{TEXT}='#{line[TEXT]}'"
     code_generation(method_name: method_name,
                     locator_type: XPATH,
-                    value: locator)
+                    locator_value: locator)
   end
 
   def create_locator(line)
@@ -65,9 +72,15 @@ class Android < Base
     page_source_html.css('node').each { |line| create_locator(line) }
   end
 
-  def code_generation(method_name:, locator_type:, value:)
-    java = java(method_name, locator_type, value)
+  def code_generation(method_name:, locator_type:, locator_value:)
+    java = @language.java(camel_method_name: camel_style(method_name),
+                          locator_type: locator_type,
+                          locator_value: locator_value)
+    ruby = @language.ruby(snake_method_name: snake_style(method_name),
+                          locator_type: locator_type,
+                          locator_value: locator_value)
     save(code: java, format: Language::JAVA)
+    save(code: ruby, format: Language::RUBY)
   end
 
   def page_source

data/lib/skeleton/base.rb

@@ -1,32 +1,26 @@
-require_relative 'languages.rb'
-require_relative 'root.rb'
-
 class Base
-  include Language
-
-  PAGE_OBJECTS_FOLDER = "#{ROOT_DIR}/PageObjects"
-  ATTACHMENTS_FOLDER = "#{ROOT_DIR}/Attachments"
+  PAGE_OBJECTS_FOLDER = "#{ROOT_DIR}/PageObjects".freeze
+  ATTACHMENTS_FOLDER = "#{ROOT_DIR}/Attachments".freeze
   TIMESTAMP = (Time.now.to_f * 1000).to_i
 
   def precondition
     create_logger
+    clear
+    FileUtils.rm_rf("#{ROOT_DIR}/html/screenshot.png")
     FileUtils.mkdir_p(PAGE_OBJECTS_FOLDER)
     FileUtils.mkdir_p(ATTACHMENTS_FOLDER)
   end
 
   def log
-    if @log.nil?
-      create_logger
-    end
+    create_logger if @log.nil?
     @log
   end
 
-  def skeletoner
-  end
+  def skeletoner; end
 
   def clear
-    FileUtils.rm_rf(Base::PAGE_OBJECTS_FOLDER)
-    FileUtils.rm_rf(Base::ATTACHMENTS_FOLDER)
+    FileUtils.rm_rf(PAGE_OBJECTS_FOLDER)
+    FileUtils.rm_rf(ATTACHMENTS_FOLDER)
   end
 
   protected
@@ -39,19 +33,20 @@ class Base
   def create_logger
     @log = Logger.new(STDOUT)
     @log.level = Logger::INFO
-    @log.formatter = proc do |severity, datetime, progname, msg|
+    @log.formatter = proc do |severity, datetime, _progname, msg|
       "[#{severity}] #{datetime}: " + "#{msg}\n".colorize(:light_cyan)
     end
   end
 
   def snake_style(method_name)
-    method_name.tr("@()[]'\"*!?{}:;#$^.,\/\\", '').
-                tr('-', '_').
-                gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-                gsub(/([a-z\d])([A-Z])/, '\1_\2').
-                gsub(/\s/, '_').
-                gsub(/__+/, '_').
-                downcase
+    method_name
+      .tr("@()[]'\"*!?{}:;#$^.,\/\\", '')
+      .tr('-', '_')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .gsub(/\s/, '_')
+      .gsub(/__+/, '_')
+      .downcase
   end
 
   def camel_style(method_name)
@@ -71,12 +66,9 @@ class Base
     @locator_index = @locator_index.nil? ? 1 : @locator_index + 1
   end
 
-  def screenshot
-  end
+  def screenshot; end
 
-  def page_source
-  end
+  def page_source; end
 
-  def code_generation
-  end
+  def code_generation; end
 end

data/lib/skeleton/ios.rb

@@ -1,16 +1,16 @@
 class IOS < Base
   ACC_ID = {
-             java: :AccessibilityId,
-             ruby: :accessibility_id
-           }
+    java: :AccessibilityId,
+    ruby: :accessibility_id
+  }.freeze
   NSPREDICATE = {
-                  java: :iOSNsPredicateString,
-                  ruby: :predicate
-                }
-  IDENTIFIER = 'identifier'
-  LABEL = 'label'
-  XCRESULTS_FOLDER = "#{ROOT_DIR}/XCResults"
-  XCODEPROJ_FOLDER = "#{ROOT_DIR}/xcodeproj"
+    java: :iOSNsPredicateString,
+    ruby: :predicate
+  }.freeze
+  IDENTIFIER = 'identifier'.freeze
+  LABEL = 'label'.freeze
+  XCRESULTS_FOLDER = "#{ROOT_DIR}/XCResults".freeze
+  XCODEPROJ_FOLDER = "#{ROOT_DIR}/xcodeproj".freeze
 
   attr_accessor :platform, :udid, :bundle_id
 
@@ -18,6 +18,7 @@ class IOS < Base
     self.platform = options.platform
     self.udid = options.udid
     self.bundle_id = options.bundle
+    @language = Language.new
   end
 
   def skeletoner
@@ -47,7 +48,7 @@ class IOS < Base
     method_name = locator.strip
     code_generation(method_name: method_name,
                     locator_type: ACC_ID,
-                    value: locator)
+                    locator_value: locator)
   end
 
   def create_locator_by_label(text, type)
@@ -55,7 +56,7 @@ class IOS < Base
     locator = "#{LABEL} like '#{text}'"
     code_generation(method_name: method_name,
                     locator_type: NSPREDICATE,
-                    value: locator)
+                    locator_value: locator)
   end
 
   def create_page_objects
@@ -82,11 +83,14 @@ class IOS < Base
     locator.nil? ? '' : locator[1]
   end
 
-  def code_generation(method_name:, locator_type:, value:)
-    java = java(method_name, locator_type, value)
+  def code_generation(method_name:, locator_type:, locator_value:)
+    java = @language.java(camel_method_name: camel_style(method_name),
+                          locator_type: locator_type,
+                          locator_value: locator_value)
+    ruby = @language.ruby(snake_method_name: snake_style(method_name),
+                          locator_type: locator_type,
+                          locator_value: locator_value)
     save(code: java, format: Language::JAVA)
-
-    ruby = ruby(method_name, locator_type, value)
     save(code: ruby, format: Language::RUBY)
   end
 
@@ -94,24 +98,23 @@ class IOS < Base
     if @page_source.nil?
       log.info('Getting screen source tree ⚒')
       FileUtils.rm_rf(XCRESULTS_FOLDER)
-      start_grep, end_grep = 'start_grep_tag', 'end_grep_tag'
+      start_grep = 'start_grep_tag'
+      end_grep = 'end_grep_tag'
       ios_arch = @simulator ? 'iOS Simulator' : 'iOS'
       @page_source = `xcodebuild test \
-                        -project #{XCODEPROJ_FOLDER}/Skeleton.xcodeproj \
-                        -scheme Skeleton \
-                        -destination 'platform=#{ios_arch},id=#{@udid}' \
-                        -resultBundlePath #{XCRESULTS_FOLDER} \
-                        bundle_id="#{@bundle_id}" | \
-                        awk '/#{start_grep}/,/#{end_grep}/'`
+          -project #{XCODEPROJ_FOLDER}/Skeleton.xcodeproj \
+          -scheme Skeleton \
+          -destination 'platform=#{ios_arch},id=#{@udid}' \
+          -resultBundlePath #{XCRESULTS_FOLDER} \
+          bundle_id="#{@bundle_id}" | \
+          awk '/#{start_grep}/,/#{end_grep}/'`
       @page_source.slice!(start_grep)
       @page_source.slice!(end_grep)
       if @page_source.empty?
-        log.fatal(
-            "Something went wrong.\n" \
+        log.fatal("Something went wrong.\n" \
             "1. Try to sign Skeleton in #{XCODEPROJ_FOLDER}\n" \
             "2. Check in the iOS settings that Skeleton is trust developer.\n" \
-            '3. Check your app bundle_id'
-        )
+            '3. Check your app bundle_id')
         raise
       end
       log.info('Successfully getting Screen Source Tree 🔥')
@@ -120,15 +123,13 @@ class IOS < Base
   end
 
   def check_udid
-    if @simulator.nil?
-      log.info('Checking iOS UDID 👨‍💻')
-      simulators = `xcrun simctl list`
-      @simulator = simulators.include?(@udid)
-      if !@simulator && !`instruments -s devices`.include?(@udid)
-        log.fatal("No such devices with UDID: #{@udid}")
-        raise
-      end
-    end
+    return unless @simulator.nil?
+    log.info('Checking iOS UDID 👨‍💻')
+    simulators = `xcrun simctl list`
+    @simulator = simulators.include?(@udid)
+    return if @simulator || `instruments -s devices`.include?(@udid)
+    log.fatal("No such devices with UDID: #{@udid}")
+    raise
   end
 
   def save_screenshot

data/lib/skeleton/languages.rb

@@ -1,28 +1,28 @@
-module Language
+class Language
   JAVA = 'java'
   RUBY = 'rb'
   PYTHON = 'py'
 
-  def java(method_name, locator_type, value)
+  def java(camel_method_name:, locator_type:, locator_value:)
     <<~JAVA
-      By #{camel_style(method_name)}() {
-        return MobileBy.#{locator_type[:java]}("#{value}");
+      By #{camel_method_name}() {
+        return MobileBy.#{locator_type[:java]}("#{locator_value}");
       }
 
     JAVA
   end
 
-  def ruby(method_name, locator_type, value)
+  def ruby(snake_method_name:, locator_type:, locator_value:)
     <<~RUBY
-      def #{snake_style(method_name)}
-        return :#{locator_type[:ruby]}, "#{value}"
+      def #{snake_method_name}
+        return :#{locator_type[:ruby]}, "#{locator_value}"
       end
 
     RUBY
   end
 
-  def language_type(lang:)
-    case lang
+  def type(format)
+    case format
     when 'ruby'
       RUBY
     when 'java'
@@ -30,7 +30,7 @@ module Language
     when 'python'
       PYTHON
     else
-      "I haven't this language"
+      "I haven't this language format"
     end
   end
 end

data/lib/skeleton/version.rb

@@ -1,4 +1,4 @@
 module Skeleton
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   GEM_NAME = 'skeleton-ui'
 end

data/skeleton.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   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 "mini_magick", "~> 4.8.0"
   spec.add_dependency "nokogiri", "~> 1.8.2"
   spec.add_dependency "fileutils"
   spec.add_dependency "commander"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeleton-ui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - a.alterpesotskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - ".githooks/commit-msg"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt