appium_thor 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d1d0f080406f2da8c05f39343a93e947a8174d
-  data.tar.gz: 87516acc6dec119bae6364d6830ec09c3fd85cc8
+  metadata.gz: 19859e26beeb391e168bcf06a81bd175d96d075c
+  data.tar.gz: 73097fc74b2952caf94895b08d102ab61929df64
 SHA512:
-  metadata.gz: d82c5278ead5cb6df2e4ff2e7659b13446f690e4d4e1938cc0f2e7096564e7310e74b60dfad87639c62e3b2976056b63ff331a929450924fc18fa4912f497af1
-  data.tar.gz: 8936f8d2a5d79ce40bf3b4c8d1ad02cea21f9598bd1259b1f7e243fc3e7c555ebe7cce4c35823f77351009850762f56a8aeae663e2313935be3601e40504501a
+  metadata.gz: fbe246799d8a02f5fbaa8723922375ef7450d934463718808c11dd1733b57fca391c532f293575b562a620ba7db8c4e9d504a55b7079ce56b66b741ae4c2c2ea
+  data.tar.gz: dc8181f546c0083bce4321d15303c381221efc2c6a72252b15f59748fe2dfd08230b4fee685e31d9c1c9b06464a878a1d6f654a839135ab83c31d7024a6445ec

data/README.md

@@ -1,34 +1,56 @@
 # appium_thor [![Gem Version](https://badge.fury.io/rb/appium_thor.svg)](http://badge.fury.io/rb/appium_thor)[![Dependency Status](https://gemnasium.com/appium/appium_thor.svg)](https://gemnasium.com/appium/appium_thor)
 
 
-Appium Thor helpers for appium's gems (appium_lib, appium_capybara)
+Appium Thor helpers for appium's gems (appium_lib, appium_capybara).
 
 --
 
-Example configuration
+# Example configuration
 
 ```ruby
 Appium::Thor::Config.set do
-  gem_name 'appium_lib'
-  github_name 'ruby_lib'
-  version_file 'path/to/version.rb'
+  gem_name     'appium_thor'
+  github_name  'appium_thor'
+  version_file 'lib/appium_thor/version.rb'
+  docs_block do
+    run 'docs/helpers_docs.md', globs('/lib/appium_thor/helpers.rb')
+  end
 end
 ```
 
-Available tasks
+--
+
+# Available tasks
+
+Note to see gem warnings, run `gem build appium_thor.gemspec` and replace `appium_thor.gemspec` with the gemspec of your gem.
 
 ```
-thor build      # Build a new gem (same as gem task)
-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 ...
-thor bumpy      # Bump the y version number, set z to zero, update the date
-thor byte       # Remove non-ascii bytes
-thor dev        # Install gems required for release task
-thor docs       # Update android and iOS docs
-thor gem        # Build a new gem
-thor install    # Install gem
-thor notes      # Update release notes
-thor publish    # Build and release a new gem to rubygems.org (same as rele...
-thor release    # Build and release a new gem to rubygems.org
-thor uninstall  # Uninstall gem
+thor build          # Build a new gem
+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 android and iOS docs
+thor gem_install    # Install gem
+thor gem_uninstall  # Uninstall gem
+thor info           # prints config info for this gem
+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

@@ -4,4 +4,7 @@ Appium::Thor::Config.set do
   gem_name     'appium_thor'
   github_name  'appium_thor'
   version_file 'lib/appium_thor/version.rb'
+  docs_block do
+    run 'docs/helpers_docs.md', globs('/lib/appium_thor/helpers.rb')
+  end
 end

data/docs/helpers_docs.md

@@ -0,0 +1,107 @@
+##### [_build_gem](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L6) 
+
+> def _build_gem
+
+Sets the permissions on the gem credentials
+Runs gem build gemspec
+
+--
+
+##### [tag_exists](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L12) 
+
+> def tag_exists tag_name
+
+Returns true if the tag exists on the master branch.
+
+--
+
+##### [sh](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L18) 
+
+> def sh command
+
+Runs command. Raises an exception if the command doesn't execute successfully.
+
+--
+
+##### [version_rgx](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L30) 
+
+> def version_rgx
+
+Used to parse the version number from version_file
+
+--
+
+##### [version](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L35) 
+
+> def version
+
+Returns the version number from version_file as a string
+
+--
+
+##### [_bump](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L46) 
+
+> def _bump value
+
+Updates the date and version in version_file.
+Prints the new version and date to the console.
+The date is not printed if it hasn't changed.
+
+x.y.z
+
+__Parameters:__
+
+     [symbol] value - value is either :x, :y, or :z. Default is z.
+
+--
+
+##### [update_release_notes](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L86) 
+
+> def update_release_notes
+
+Creates release_notes.md based on changes between tags.
+Note that the first tag won't contain notes.
+
+--
+
+##### [_install](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L141) 
+
+> def _install
+
+Installs the local gem. It's fast due to the flags
+
+--no-rdoc = skip rdoc
+--no-ri   = skip ri
+--local   = only install from the local disk
+
+--
+
+##### [_uninstall](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L148) 
+
+> def _uninstall
+
+Uninstalls all versions of the gem
+
+--
+
+##### [_publish](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L159) 
+
+> def _publish
+
+Publishes the master branch to github
+Creates a version tag
+Updates release notes and documentation
+Builds the gem
+Publishes the gem to rubygems
+
+--
+
+##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L188) 
+
+> def remove_non_ascii_from_cwd
+
+Remove non-ascii bytes from all rb files in the current working directory.
+Used to purge byte order marks that mess up YARD
+
+--
+

data/lib/appium_thor.rb

@@ -1,6 +1,7 @@
 # stdlib
 require 'forwardable' # commands.rb
 require 'singleton'   # config.rb
+require 'fileutils'
 
 # gems
 require 'rubygems'

data/lib/appium_thor/commands/commands.rb

@@ -51,9 +51,9 @@ class Default < Thor
     _install
   end
 
-  desc 'docs', 'Update android and iOS docs'
+  desc 'docs', 'Update docs'
   def docs
-    docks_block.call if docs_block
+    instance_eval &docs_block if docs_block
   end
 
   desc 'notes', 'Update release notes'

data/lib/appium_thor/docs.rb

@@ -26,7 +26,7 @@ module Appium
 
         method_path = obj.file.split('/lib/').last
         os          = method_path.downcase.match /ios|android/
-        out         += "##### [#{obj.name.to_s}](https://github.com/appium/ruby_lib/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
+        out         += "##### [#{obj.name.to_s}](https://github.com/appium/#{github_name}/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
         out         += "> #{obj.signature}\n\n"
         out         += "#{obj.docstring}\n\n"
 
@@ -55,6 +55,7 @@ module Appium
         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

data/lib/appium_thor/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Thor
-    VERSION = '0.0.5' unless defined? ::Appium::Thor::VERSION
+    VERSION = '0.0.6' unless defined? ::Appium::Thor::VERSION
     DATE    = '2014-07-31' unless defined? ::Appium::Thor::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v0.0.6 2014-07-31
+
+- [b6659a4](https://github.com/appium/appium_thor/commit/b6659a4ea55c99cf68707f75d02ef29062760a00) Release 0.0.6
+- [4650a68](https://github.com/appium/appium_thor/commit/4650a68713b0f7937cf3be6f96e06916c0f78bb4) Fix docs link
+- [1586f47](https://github.com/appium/appium_thor/commit/1586f4789aa8db3284f8f274eaf57b50f94f6d0e) Fix thor docs
+- [938f87e](https://github.com/appium/appium_thor/commit/938f87ea1bd081297af0b1e94e427409f0e3c9d0) Update README.md
+
+
 #### v0.0.5 2014-07-31
 
 - [1934e8f](https://github.com/appium/appium_thor/commit/1934e8f05cf7eb9b2c8e0da76eb1ebb895511f2f) Release 0.0.5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_thor
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -83,6 +83,7 @@ files:
 - README.md
 - Thorfile
 - appium_thor.gemspec
+- docs/helpers_docs.md
 - lib/appium_thor.rb
 - lib/appium_thor/commands/commands.rb
 - lib/appium_thor/commands/init.rb