appium_thor 1.1.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6566a07c7807fb22a8e9404fb880595c380f765c7da639fd702fe60bc58afe
-  data.tar.gz: 69861affb47ecb5cda3220ddfe3bb76d4ade05a8c689bfbf739e7a69e09d5512
+  metadata.gz: cf2076f3692848707a188c8fd4894f6db4be3e9a3846c7ec968956bcff35996d
+  data.tar.gz: 9f7ae671336d09075b901b9d156d2472950ef6bf7bd576895aeb4e85600b83eb
 SHA512:
-  metadata.gz: 97baa0a76b30b5e8af8d73c41a4b84a7dfa8104ef536e89bba76a04392f719f2914935b0878112c0cb6009a5ebf3cefd7061f891aec9d58267e306d64a525697
-  data.tar.gz: f1b0d482be9d18761a0137558b327afd74641b411d59d0d172a29adef641283e7cca4983764ae22d4befcc6bbb506162a81035f290cf4e49abee10e5c027d86a
+  metadata.gz: cecba2f6985427e8c22512f1111a01d84f981e1ddb290d07af18e3a3aa91b5b9024e93742fa9ee9a61672b84a4022f9b587f5251c5251153630036f7d68fbec4
+  data.tar.gz: 63fe0809f01b8d8dc6ea4db7dd340a4644299199b7e673df187cccd748f88b1cb769637a32f75c3738bd6a9bdd9dacf96f161f373fd567d9d3fdb40a98306327

data/README.md

@@ -14,10 +14,8 @@ Appium::Thor::Config.set do
   gem_name     'appium_thor'
   github_owner 'appium'
   github_name  'appium_thor'
+       branch  'master'
   version_file 'lib/appium_thor/version.rb'
-  docs_block do
-    run 'docs/helpers_docs.md', globs('/lib/appium_thor/helpers.rb')
-  end
 end
 
 # Must use '::' otherwise Default will point to Thor::Sandbox::Default
@@ -35,14 +33,16 @@ end
 
 # Defaults
 
-      Option | Default
-          --:|:--
-gem_name     | must be provided
-github_owner | `appium`
-github_name  | `#{gem_name}`
-version_file | `lib/#{gem_name}/version.rb`
-docs_block   | no docs are generated
+|Option | Default|
+|---:|:---|
+|gem_name     | must be provided|
+|github_owner | `appium`|
+|github_name  | `#{gem_name}`|
+|branch       | `master`|
+|version_file | `lib/#{gem_name}/version.rb`|
 
+`branch` customises the target branch to push changes.
+Defaults to `master`
 
 --
 
@@ -56,7 +56,6 @@ thor bump           # Bump the z version number and update the date.
 thor bumpx          # Bump the x version number, set y & z to zero, update the date.
 thor bumpy          # Bump the y version number, set z to zero, update the date.
 thor byte           # Remove non-ascii bytes from all *.rb files in the current dir
-thor docs           # Update docs
 thor gem_install    # Install gem
 thor gem_uninstall  # Uninstall gem
 thor info           # prints config info for this gem
@@ -64,19 +63,3 @@ thor notes          # Update release notes
 thor publish        # Build and release a new gem to rubygems.org
 thor release        # Build and release a new gem to rubygems.org (same as publish)
 ```
-
---
-
-# docs_block
-
-The `docs_block` method runs within the `docs.rb` context. Here's a more complex example:
-
-```ruby
-common_globs  = '/lib/appium_lib/*.rb', '/lib/appium_lib/device/*.rb', '/lib/appium_lib/common/**/*.rb'
-android_globs = common_globs + ['/lib/appium_lib/android/**/*.rb']
-ios_globs     = common_globs + ['/lib/appium_lib/ios/**/*.rb']
-
-run 'docs/android_docs.md', globs(android_globs)
-
-run 'docs/ios_docs.md', globs(ios_globs)
-```

data/Thorfile

@@ -3,7 +3,4 @@ require File.expand_path '../lib/appium_thor', __FILE__
 Appium::Thor::Config.set do
   appium_thor = 'appium_thor'
   gem_name     appium_thor
-  docs_block do
-    run 'docs/helpers_docs.md', globs("/lib/#{appium_thor}/helpers.rb")
-  end
-end
+end

data/appium_thor.gemspec

@@ -1,7 +1,7 @@
 require_relative 'lib/appium_thor/version'
 
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 3.0'
 
   s.name          = 'appium_thor'
   s.version       = Appium::Thor::VERSION
@@ -13,8 +13,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'redcarpet', '~> 3.1', '>= 3.1.2'
-  s.add_runtime_dependency 'posix-spawn', '~> 0.3', '>= 0.3.8'
-  s.add_runtime_dependency 'yard', '~> 0.9.11'
 
   s.files = `git ls-files`.split "\n"
 end

data/docs/helpers_docs.md

@@ -1,4 +1,4 @@
-##### [_build_gem](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L6) common
+##### [_build_gem](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L6) common
 
 > def _build_gem
 
@@ -7,7 +7,7 @@ Runs gem build gemspec
 
 --
 
-##### [tag_exists](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L12) common
+##### [tag_exists](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L12) common
 
 > def tag_exists(tag_name)
 
@@ -15,7 +15,7 @@ Returns true if the tag exists on the master branch.
 
 --
 
-##### [sh](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L18) common
+##### [sh](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L18) common
 
 > def sh(command)
 
@@ -23,7 +23,7 @@ Runs command. Raises an exception if the command doesn't execute successfully.
 
 --
 
-##### [version_rgx](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L30) common
+##### [version_rgx](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L30) common
 
 > def version_rgx
 
@@ -31,7 +31,7 @@ Used to parse the version number from version_file
 
 --
 
-##### [version](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L35) common
+##### [version](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L35) common
 
 > def version
 
@@ -39,7 +39,7 @@ Returns the version number from version_file as a string
 
 --
 
-##### [_bump](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L46) common
+##### [_bump](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L46) common
 
 > def _bump(value)
 
@@ -55,7 +55,7 @@ __Parameters:__
 
 --
 
-##### [update_release_notes](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L86) common
+##### [update_release_notes](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L86) common
 
 > def update_release_notes
 
@@ -64,7 +64,7 @@ Note that the first tag won't contain notes.
 
 --
 
-##### [_install](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L150) common
+##### [_install](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L150) common
 
 > def _install
 
@@ -76,7 +76,7 @@ Installs the local gem. It's fast due to the flags
 
 --
 
-##### [_uninstall](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L157) common
+##### [_uninstall](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L157) common
 
 > def _uninstall
 
@@ -84,7 +84,7 @@ Uninstalls all versions of the gem
 
 --
 
-##### [_publish](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L168) common
+##### [_publish](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L168) common
 
 > def _publish
 
@@ -96,7 +96,7 @@ Publishes the gem to rubygems
 
 --
 
-##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50/lib/appium_thor/helpers.rb#L200) common
+##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee/lib/appium_thor/helpers.rb#L200) common
 
 > def remove_non_ascii_from_cwd
 

data/lib/appium_thor/commands/commands.rb

@@ -6,6 +6,7 @@ class Default < Thor
     gem_name: #{gem_name}
  github_name: #{github_name}
 github_owner: #{github_owner}
+      branch: #{branch}
 version_file: #{version_file}
     MSG
   end
@@ -54,11 +55,6 @@ version_file: #{version_file}
     _install
   end
 
-  desc 'docs', 'Update docs'
-  def docs
-    instance_eval &docs_block if docs_block
-  end
-
   desc 'notes', 'Update release notes'
   def notes
     update_release_notes
@@ -68,4 +64,8 @@ version_file: #{version_file}
   def byte
     remove_non_ascii_from_cwd
   end
-end
+
+  def self.exit_on_failure?
+    true
+  end
+end

data/lib/appium_thor/commands/init.rb

@@ -2,7 +2,6 @@
 class Default < Thor
   extend Forwardable
   include Appium::Thor::Helpers
-  include Appium::Thor::Docs
 
   # For each possible option method, delegate calls to the config instance
   no_commands do

data/lib/appium_thor/config.rb

@@ -11,6 +11,8 @@ module Appium
           @version_file ||= "lib/#{@gem_name}/version.rb"
         end
 
+        @branch ||= 'master'
+
         @github_owner ||= 'appium'
 
         # ensure all options are set
@@ -19,21 +21,14 @@ module Appium
         raise "version file doesn't exist #{@version_file}" unless File.exist?(@version_file)
       end
 
-      # block of code to execute that contains documentation
-      # generation logic
-      def docs_block(&block)
-        return @docs_block if @docs_block
-        @docs_block = block
-      end
-
       # Returns all options as symbols. Required for defining delegators in init.rb
       def self.options
-        string_options + [:docs_block]
+        string_options
       end
 
       # the subset of options that operate on strings
       def self.string_options
-        %w[gem_name github_name github_owner version_file].map(&:to_sym)
+        %w[gem_name github_name github_owner branch version_file].map(&:to_sym)
       end
 
       string_options.each do |option|
@@ -51,6 +46,7 @@ module Appium
       #   gem_name     'appium_thor'
       #   github_owner 'appium'
       #   github_name  'appium_thor'
+      #        branch  'master'
       #   version_file 'path/to/version.rb'
       # end
       def self.set(&block)

data/lib/appium_thor/helpers.rb

@@ -11,19 +11,20 @@ module Appium
       # Returns true if the tag exists on the master branch.
       def tag_exists(tag_name)
         cmd = %Q(git branch -a --contains "#{tag_name}")
-        POSIX::Spawn::Child.new(cmd).out.include? '* master'
+        stdout, status = Open3.capture2(cmd)
+        stdout.include? "* #{branch}"
+
       end
 
       # Runs command. Raises an exception if the command doesn't execute successfully.
       def sh(command)
-        process = POSIX::Spawn::Child.new command
+        stdout, stderr, status = Open3.capture3(command)
 
-        unless process.success?
-          raise "Command #{command} failed. out: #{process.out}\nerr: #{process.err}"
+        unless status.success?
+          raise "Command #{command} failed. out: #{stdout}\nerr: #{stderr}"
         end
 
-        out = process.out
-        out ? out.strip : out
+        stdout.strip
       end
 
       # Used to parse the version number from version_file
@@ -166,8 +167,8 @@ module Appium
       # Builds the gem
       # Publishes the gem to rubygems
       def _publish
-        unless `git branch`.include? '* master'
-          puts 'Master branch required to release.'
+        unless `git branch`.include? "* #{branch}"
+          puts "'#{branch}' branch required to release."
           exit!
         end
 
@@ -187,9 +188,8 @@ module Appium
 
         # update notes now that there's a new tag
         notes rescue notes_failed = true
-        docs
         sh "git commit --allow-empty -am 'Update release notes'" unless notes_failed
-        sh 'git push origin master'
+        sh "git push origin #{branch}"
         sh "git push origin #{tag_name}"
         _build_gem
         puts "Please run 'gem push #{gem_name}-#{version}.gem'"

data/lib/appium_thor/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Thor
-    VERSION = '1.1.6' unless defined? ::Appium::Thor::VERSION
-    DATE    = '2019-11-08' unless defined? ::Appium::Thor::DATE
+    VERSION = '2.0.0' unless defined? ::Appium::Thor::VERSION
+    DATE    = '2024-04-26' unless defined? ::Appium::Thor::DATE
   end
 end

data/lib/appium_thor.rb

@@ -2,15 +2,13 @@
 require 'forwardable' # commands.rb
 require 'singleton'   # config.rb
 require 'fileutils'
+require 'open3'
 
 # gems
 require 'rubygems'
-require 'yard'        # docs.rb
-require 'posix-spawn' # helpers.rb
 require 'date'        # helpers.rb Date.today
 
 # internal
-require_relative 'appium_thor/docs'
 require_relative 'appium_thor/helpers'
 require_relative 'appium_thor/version'
 require_relative 'appium_thor/config'

data/release_notes.md

@@ -1,3 +1,17 @@
+#### v2.0.0 2024-04-26
+
+- [e83d36e](https://github.com/appium/appium_thor/commit/e83d36e65c48dcfc71b00d28837a4c57517cc6b2) Release 2.0.0
+- [021199b](https://github.com/appium/appium_thor/commit/021199b3bb179432cac93709292a275470f4bca7) chore: remove posix-spawn
+- [11848db](https://github.com/appium/appium_thor/commit/11848db549003ba9b267622eb3e2677c4b9a004d) chore: use ruby 3+
+- [3b3cf1d](https://github.com/appium/appium_thor/commit/3b3cf1d278ec18923875c5469e4e1da31df92472) feat: remove docs (#8)
+
+
+#### v1.2.0 2020-06-14
+
+- [5c7025a](https://github.com/appium/appium_thor/commit/5c7025a14e9a6dba1ff0f69b733983d965e9c2ee) Release 1.2.0
+- [d334d3a](https://github.com/appium/appium_thor/commit/d334d3af298f2bde9dd828d015ac8fd6a096a8e4) feat: Allow to customise the target branch (#7)
+
+
 #### v1.1.6 2019-11-08
 
 - [014fa19](https://github.com/appium/appium_thor/commit/014fa19e5a2cf8d2d8d85fbd3d139b9c7d67fb50) Release 1.1.6

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_thor
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.0.0
 platform: ruby
 authors:
 - code@bootstraponline.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -30,40 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.2
-- !ruby/object:Gem::Dependency
-  name: posix-spawn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.8
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
 description: Thor tasks for Appium gems.
 email:
 - code@bootstraponline.com
@@ -82,7 +48,6 @@ files:
 - lib/appium_thor/commands/commands.rb
 - lib/appium_thor/commands/init.rb
 - lib/appium_thor/config.rb
-- lib/appium_thor/docs.rb
 - lib/appium_thor/helpers.rb
 - lib/appium_thor/version.rb
 - release_notes.md
@@ -90,7 +55,7 @@ homepage: https://github.com/appium/appium_thor
 licenses:
 - http://www.apache.org/licenses/LICENSE-2.0.txt
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,15 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Thor tasks for Appium gems.
 test_files: []

data/lib/appium_thor/docs.rb

@@ -1,82 +0,0 @@
-module Appium
-  module Thor
-    module Docs
-      def space amount
-        ' ' * amount
-      end
-
-      def last_sha
-        `git rev-parse --verify HEAD`.strip
-      end
-
-      def mobj_to_md obj
-        out = ''
-        # skip objects without method signatures
-        sig = obj.signature
-        return out unless sig
-
-        # skip class vars
-        if sig.start_with?('@@') ||
-            # skip methods marked private
-            obj.tag('private') ||
-            # skip date and version from version.rb
-            obj.name.match(/DATE|VERSION/)
-
-          return out
-        end
-
-        method_path = obj.file.split('/lib/').last
-        os = method_path.downcase.match(/ios|android/) || 'common'
-        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")
-        out.concat("> #{obj.signature}\n\n")
-        out.concat("#{obj.docstring}\n\n")
-
-
-        indent = space 5
-        params = obj.tags.select { |tag| tag.tag_name == 'param' }
-        unless params.empty?
-          out.concat("__Parameters:__\n\n")
-          params.each do |param|
-            out.concat("#{indent}[#{param.types.join(', ') unless param.types.nil?}] ")
-            out.concat("#{param.name} - #{param.text}\n\n")
-          end
-        end
-
-        ret = obj.tag 'return'
-        if ret
-          out.concat("__Returns:__\n\n")
-          out.concat("#{indent}[#{ret.types.join(', ') unless ret.types.nil?}] #{ret.text}\n\n")
-        end
-        out.concat("--\n\n")
-
-        out
-      end
-
-      def run(out_file, globs)
-        YARD::Registry.clear
-        puts "Globbing: #{globs}"
-        puts "Writing: #{out_file}"
-        FileUtils.mkdir_p File.dirname out_file
-        YARD::Parser::SourceParser.parse globs
-        File.open(out_file, 'w') do |file|
-          entries        = YARD::Registry.entries
-          entries_length = entries.length
-          puts "Processing: #{entries_length} entries"
-          raise 'No entries to process' if entries_length <= 0
-          YARD::Registry.entries.each do |entry|
-            file.write mobj_to_md entry
-          end
-        end
-
-        raise 'Empty file generated' if File.size(out_file) <= 0
-      end
-
-      def globs(paths)
-        # Convert single string to array for map
-        paths = [paths] unless paths.kind_of? Array
-        # Adjust path based on system
-        paths.map! { |path| "#{Dir.pwd}#{path}" }
-      end
-    end
-  end
-end