appium_thor 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d682101a6cfd4a4967443f57f1cfb94928cbeb22
-  data.tar.gz: 4788966e9edd1c2dc21e60358bb0354a49baf07e
+  metadata.gz: 75d1d0f080406f2da8c05f39343a93e947a8174d
+  data.tar.gz: 87516acc6dec119bae6364d6830ec09c3fd85cc8
 SHA512:
-  metadata.gz: 54f4ccf0888fb75511c6d2d4f39983643b54932d82f24eb227af3a15dbdba990687fab879b6ac553ecf2f7d2a6a5bda018881468490cc31b80640e5923896472
-  data.tar.gz: d8c804a24737dd3200aa8ffa8676b4b1bbcf30c657374c13f2ce0bdc95e0001f18d0ab5b94a521eb04a80d76bffbd9f232f7801e9e9cc1b8d10bcc90ca062f51
+  metadata.gz: d82c5278ead5cb6df2e4ff2e7659b13446f690e4d4e1938cc0f2e7096564e7310e74b60dfad87639c62e3b2976056b63ff331a929450924fc18fa4912f497af1
+  data.tar.gz: 8936f8d2a5d79ce40bf3b4c8d1ad02cea21f9598bd1259b1f7e243fc3e7c555ebe7cce4c35823f77351009850762f56a8aeae663e2313935be3601e40504501a

data/README.md

@@ -1,4 +1,5 @@
-# appium_thor
+# 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)
 
@@ -30,4 +31,4 @@ 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
-```
+```

data/appium_thor.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/appium/appium_thor'
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'redcarpet', '~> 3.1.2'
+  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.8', '>= 0.8.7.4'
 

data/lib/appium_thor/commands/commands.rb

@@ -1,5 +1,3 @@
-require_relative 'init'
-
 # Define Thor tasks in the top level Default namespace.
 class Default < Thor
   desc 'info', 'prints config info for this gem'
@@ -63,7 +61,7 @@ class Default < Thor
     update_release_notes
   end
 
-  desc 'byte', 'Remove non-ascii bytes'
+  desc 'byte', 'Remove non-ascii bytes from all *.rb files in the current dir'
   def byte
     remove_non_ascii_from_cwd
   end

data/lib/appium_thor/helpers.rb

@@ -1,16 +1,20 @@
 module Appium
   module Thor
     module Helpers
+      # Sets the permissions on the gem credentials
+      # Runs gem build gemspec
       def _build_gem
         `chmod 0600 ~/.gem/credentials`
         sh "gem build #{gem_name}.gemspec"
       end
 
+      # 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'
       end
 
+      # Runs command. Raises an exception if the command doesn't execute successfully.
       def sh command
         process = POSIX::Spawn::Child.new command
 
@@ -22,14 +26,23 @@ module Appium
         out ? out.strip : out
       end
 
+      # Used to parse the version number from version_file
       def version_rgx
         /\s*VERSION\s*=\s*'([^']+)'/m
       end
 
+      # Returns the version number from version_file as a string
       def version
         @version ||= File.read(version_file).match(version_rgx)[1]
       end
 
+      # 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
+      #
+      # @param value [symbol] value is either :x, :y, or :z. Default is z.
       def _bump value
         data = File.read version_file
 
@@ -68,6 +81,8 @@ module Appium
         File.write version_file, data
       end
 
+      # Creates release_notes.md based on changes between tags.
+      # Note that the first tag won't contain notes.
       def update_release_notes
         tag_sort = ->(tag1, tag2) do
           tag1_numbers = tag1.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
@@ -118,21 +133,29 @@ module Appium
         File.open('release_notes.md', 'w') { |f| f.write notes.to_s.strip }
       end
 
+      # 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
       def _install
         _build_gem
         _uninstall
         sh "gem install --no-rdoc --no-ri --local #{gem_name}-#{version}.gem"
       end
 
+      # Uninstalls all versions of the gem
       def _uninstall
         cmd = "gem uninstall -aIx #{gem_name}"
-        # rescue on gem not installed error.
-        begin
-          sh "#{cmd}"
-        rescue
-        end
+        # rescue from errors. avoids gem not installed error.
+        sh "#{cmd}" rescue nil
       end
 
+      # Publishes the master branch to github
+      # Creates a version tag
+      # Updates release notes and documentation
+      # Builds the gem
+      # Publishes the gem to rubygems
       def _publish
         unless `git branch`.include? '* master'
           puts 'Master branch required to release.'

data/lib/appium_thor/version.rb

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

data/lib/appium_thor.rb

@@ -1,17 +1,17 @@
 # stdlib
-
 require 'forwardable' # commands.rb
 require 'singleton'   # config.rb
 
 # gems
 require 'rubygems'
-require 'yard'
-require 'posix-spawn'
-require 'date'
+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'
+require_relative 'appium_thor/commands/init'
 require_relative 'appium_thor/commands/commands'

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v0.0.5 2014-07-31
+
+- [1934e8f](https://github.com/appium/appium_thor/commit/1934e8f05cf7eb9b2c8e0da76eb1ebb895511f2f) Release 0.0.5
+- [a590195](https://github.com/appium/appium_thor/commit/a59019548b4b3e64209b3f04fc8a21e93068c789) Fix warning gem build appium_thor.gemspec
+- [668958d](https://github.com/appium/appium_thor/commit/668958df039878e0b71ab2e74f1b1836510264d7) Document the commands
+- [b30c703](https://github.com/appium/appium_thor/commit/b30c703152ac02e8774ad30bf404982fbb62c567) Add badge fury and gemnasium to readme
+
+
 #### v0.0.4 2014-07-31
 
 - [b0f4217](https://github.com/appium/appium_thor/commit/b0f42170c7b7df3befa9651647ea8c65ecd86710) Release 0.0.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_thor
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -15,6 +15,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.2
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.2
 - !ruby/object:Gem::Dependency