appium_thor 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/helpers_docs.md +13 -36
- data/lib/appium_thor/docs.rb +11 -10
- data/lib/appium_thor/version.rb +1 -1
- data/release_notes.md +6 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7b275e2ce84713246f2944abc0cfe173098e040e
|
4
|
+
data.tar.gz: 453c7c98eb25c8a47f04b77c5d0897c320b1e04d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4ba54510f787bc52d22a9f52ee6c86acaa37ca9919226fe184a6c249fa5312aa1b93810c78b3f1c90f53b5a494d198f454bebfd187eccaba991253006b8038cb
|
7
|
+
data.tar.gz: 75561dd764db0b687134239748304cf63f7fd2ba2fecc8d65f314f8073c404c2d98fc5f1082da561ccdcf2aeb7af73e5abe12c1bf4e6c986a8ee1757523d00e0
|
data/docs/helpers_docs.md
CHANGED
@@ -1,45 +1,35 @@
|
|
1
|
-
##### [_build_gem](https://github.com/appium/appium_thor/blob/
|
1
|
+
##### [_build_gem](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L6) common
|
2
2
|
|
3
3
|
> def _build_gem
|
4
4
|
|
5
5
|
Sets the permissions on the gem credentials
|
6
6
|
Runs gem build gemspec
|
7
7
|
|
8
|
-
|
9
|
-
|
10
|
-
##### [tag_exists](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L12)
|
8
|
+
--\n\n##### [tag_exists](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L12) common
|
11
9
|
|
12
10
|
> def tag_exists(tag_name)
|
13
11
|
|
14
12
|
Returns true if the tag exists on the master branch.
|
15
13
|
|
16
|
-
|
17
|
-
|
18
|
-
##### [sh](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L18)
|
14
|
+
--\n\n##### [sh](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L18) common
|
19
15
|
|
20
16
|
> def sh(command)
|
21
17
|
|
22
18
|
Runs command. Raises an exception if the command doesn't execute successfully.
|
23
19
|
|
24
|
-
|
25
|
-
|
26
|
-
##### [version_rgx](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L30)
|
20
|
+
--\n\n##### [version_rgx](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L30) common
|
27
21
|
|
28
22
|
> def version_rgx
|
29
23
|
|
30
24
|
Used to parse the version number from version_file
|
31
25
|
|
32
|
-
|
33
|
-
|
34
|
-
##### [version](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L35)
|
26
|
+
--\n\n##### [version](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L35) common
|
35
27
|
|
36
28
|
> def version
|
37
29
|
|
38
30
|
Returns the version number from version_file as a string
|
39
31
|
|
40
|
-
|
41
|
-
|
42
|
-
##### [_bump](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L46)
|
32
|
+
--\n\n##### [_bump](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L46) common
|
43
33
|
|
44
34
|
> def _bump(value)
|
45
35
|
|
@@ -49,22 +39,16 @@ The date is not printed if it hasn't changed.
|
|
49
39
|
|
50
40
|
x.y.z
|
51
41
|
|
52
|
-
__Parameters:__
|
53
|
-
|
54
|
-
[symbol] value - value is either :x, :y, or :z. Default is z.
|
42
|
+
__Parameters:__\n\n [symbol] value - value is either :x, :y, or :z. Default is z.
|
55
43
|
|
56
|
-
|
57
|
-
|
58
|
-
##### [update_release_notes](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L86)
|
44
|
+
--\n\n##### [update_release_notes](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L86) common
|
59
45
|
|
60
46
|
> def update_release_notes
|
61
47
|
|
62
48
|
Creates release_notes.md based on changes between tags.
|
63
49
|
Note that the first tag won't contain notes.
|
64
50
|
|
65
|
-
|
66
|
-
|
67
|
-
##### [_install](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L150)
|
51
|
+
--\n\n##### [_install](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L150) common
|
68
52
|
|
69
53
|
> def _install
|
70
54
|
|
@@ -74,17 +58,13 @@ Installs the local gem. It's fast due to the flags
|
|
74
58
|
--no-ri = skip ri
|
75
59
|
--local = only install from the local disk
|
76
60
|
|
77
|
-
|
78
|
-
|
79
|
-
##### [_uninstall](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L157)
|
61
|
+
--\n\n##### [_uninstall](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L157) common
|
80
62
|
|
81
63
|
> def _uninstall
|
82
64
|
|
83
65
|
Uninstalls all versions of the gem
|
84
66
|
|
85
|
-
|
86
|
-
|
87
|
-
##### [_publish](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L168)
|
67
|
+
--\n\n##### [_publish](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L168) common
|
88
68
|
|
89
69
|
> def _publish
|
90
70
|
|
@@ -94,14 +74,11 @@ Updates release notes and documentation
|
|
94
74
|
Builds the gem
|
95
75
|
Publishes the gem to rubygems
|
96
76
|
|
97
|
-
|
98
|
-
|
99
|
-
##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/7e1ac01f1398a10f22b36bd230ea8ea74937cbed/lib/appium_thor/helpers.rb#L200)
|
77
|
+
--\n\n##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/b04599e462699083201e21ae6d7e4a0b4e90a1e9/lib/appium_thor/helpers.rb#L200) common
|
100
78
|
|
101
79
|
> def remove_non_ascii_from_cwd
|
102
80
|
|
103
81
|
Remove non-ascii bytes from all rb files in the current working directory.
|
104
82
|
Used to purge byte order marks that mess up YARD
|
105
83
|
|
106
|
-
|
107
|
-
|
84
|
+
--\n\n
|
data/lib/appium_thor/docs.rb
CHANGED
@@ -17,15 +17,16 @@ module Appium
|
|
17
17
|
|
18
18
|
# skip class vars
|
19
19
|
if sig.start_with?('@@') ||
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
20
|
+
# skip methods marked private
|
21
|
+
obj.tag('private') ||
|
22
|
+
# skip date and version from version.rb
|
23
|
+
obj.name.match(/DATE|VERSION/)
|
24
|
+
|
24
25
|
return out
|
25
26
|
end
|
26
27
|
|
27
28
|
method_path = obj.file.split('/lib/').last
|
28
|
-
os = method_path.downcase.match
|
29
|
+
os = method_path.downcase.match(/ios|android/) || 'common'
|
29
30
|
out.concat("##### [#{obj.name.to_s}](https://github.com/#{github_owner}/#{github_name}/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n")
|
30
31
|
out.concat("> #{obj.signature}\n\n")
|
31
32
|
out.concat("#{obj.docstring}\n\n")
|
@@ -34,19 +35,19 @@ module Appium
|
|
34
35
|
indent = space 5
|
35
36
|
params = obj.tags.select { |tag| tag.tag_name == 'param' }
|
36
37
|
unless params.empty?
|
37
|
-
out.concat(
|
38
|
+
out.concat('__Parameters:__\n\n')
|
38
39
|
params.each do |param|
|
39
|
-
out.concat("#{indent}[#{param.types.join
|
40
|
+
out.concat("#{indent}[#{param.types.join(', ') unless param.types.nil?}] ")
|
40
41
|
out.concat("#{param.name} - #{param.text}\n\n")
|
41
42
|
end
|
42
43
|
end
|
43
44
|
|
44
45
|
ret = obj.tag 'return'
|
45
46
|
if ret
|
46
|
-
out.concat(
|
47
|
-
out.concat("#{indent}[#{ret.types.join
|
47
|
+
out.concat('__Returns:__\n\n')
|
48
|
+
out.concat("#{indent}[#{ret.types.join(', ') unless ret.types.nil?}] #{ret.text}\n\n")
|
48
49
|
end
|
49
|
-
out.concat(
|
50
|
+
out.concat('--\n\n')
|
50
51
|
|
51
52
|
out
|
52
53
|
end
|
data/lib/appium_thor/version.rb
CHANGED
data/release_notes.md
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
#### v1.1.2 2018-11-12
|
2
|
+
|
3
|
+
- [b04599e](https://github.com/appium/appium_thor/commit/b04599e462699083201e21ae6d7e4a0b4e90a1e9) Release 1.1.2
|
4
|
+
- [6aee88a](https://github.com/appium/appium_thor/commit/6aee88afb1467b39bdfea06a9e5e8f3cad3a879d) fix gen doc issues
|
5
|
+
|
6
|
+
|
1
7
|
#### v1.1.1 2018-11-12
|
2
8
|
|
3
9
|
- [7e1ac01](https://github.com/appium/appium_thor/commit/7e1ac01f1398a10f22b36bd230ea8ea74937cbed) Release 1.1.1
|