appium_thor 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19859e26beeb391e168bcf06a81bd175d96d075c
-  data.tar.gz: 73097fc74b2952caf94895b08d102ab61929df64
+  metadata.gz: 50b6ffdbb5b811a315cb71b3cf7b50d081e40c31
+  data.tar.gz: e583839ebde160f7c544e58f72d9d0349512f015
 SHA512:
-  metadata.gz: fbe246799d8a02f5fbaa8723922375ef7450d934463718808c11dd1733b57fca391c532f293575b562a620ba7db8c4e9d504a55b7079ce56b66b741ae4c2c2ea
-  data.tar.gz: dc8181f546c0083bce4321d15303c381221efc2c6a72252b15f59748fe2dfd08230b4fee685e31d9c1c9b06464a878a1d6f654a839135ab83c31d7024a6445ec
+  metadata.gz: 50717847face8f220298419a29642488ab6420cd336f36c4df7c06485c77c054f0b98d803a065ceecb3896ce1483b7e5dbc03a3b14ff17149d41ce802ca8cbc6
+  data.tar.gz: 872aa18a67538845b4eacfcafa8ed7a6f7845494057b5017f46e4c37d46f664493c4bf07ebd217d1fc7e02be13abe45a11ed858c933520a94492579b529cf3c1

data/README.md

@@ -10,6 +10,7 @@ Appium Thor helpers for appium's gems (appium_lib, appium_capybara).
 ```ruby
 Appium::Thor::Config.set do
   gem_name     'appium_thor'
+  github_owner 'appium'
   github_name  'appium_thor'
   version_file 'lib/appium_thor/version.rb'
   docs_block do
@@ -18,11 +19,22 @@ Appium::Thor::Config.set do
 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
+
+
 --
 
 # Available tasks
 
-Note to see gem warnings, run `gem build appium_thor.gemspec` and replace `appium_thor.gemspec` with the gemspec of your gem.
+Note to see gem warnings, run `gem build your_gem_name.gemspec`
 
 ```
 thor build          # Build a new gem
@@ -53,4 +65,4 @@ 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

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

data/docs/helpers_docs.md

@@ -1,4 +1,4 @@
-##### [_build_gem](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L6) 
+##### [_build_gem](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L6) 
 
 > def _build_gem
 
@@ -7,7 +7,7 @@ Runs gem build gemspec
 
 --
 
-##### [tag_exists](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L12) 
+##### [tag_exists](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L12) 
 
 > 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/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L18) 
+##### [sh](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L18) 
 
 > 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/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L30) 
+##### [version_rgx](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L30) 
 
 > def version_rgx
 
@@ -31,7 +31,7 @@ Used to parse the version number from version_file
 
 --
 
-##### [version](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L35) 
+##### [version](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L35) 
 
 > def version
 
@@ -39,7 +39,7 @@ 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) 
+##### [_bump](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L46) 
 
 > def _bump value
 
@@ -55,7 +55,7 @@ __Parameters:__
 
 --
 
-##### [update_release_notes](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L86) 
+##### [update_release_notes](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L86) 
 
 > 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/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L141) 
+##### [_install](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L141) 
 
 > 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/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L148) 
+##### [_uninstall](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L148) 
 
 > def _uninstall
 
@@ -84,7 +84,7 @@ Uninstalls all versions of the gem
 
 --
 
-##### [_publish](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L159) 
+##### [_publish](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L159) 
 
 > def _publish
 
@@ -96,7 +96,7 @@ Publishes the gem to rubygems
 
 --
 
-##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/b6659a4ea55c99cf68707f75d02ef29062760a00/lib/appium_thor/helpers.rb#L188) 
+##### [remove_non_ascii_from_cwd](https://github.com/appium/appium_thor/blob/e36ab29971eb4ccc0b5b4527f23dbb34bf590107/lib/appium_thor/helpers.rb#L188) 
 
 > def remove_non_ascii_from_cwd
 

data/lib/appium_thor/commands/commands.rb

@@ -2,9 +2,10 @@
 class Default < Thor
   desc 'info', 'prints config info for this gem'
   def info
-    puts "    gem_name: #{gem_name}\n"    +
-         " github_name: #{github_name}\n" +
-         "version_file: #{version_file}"
+    puts "     gem_name: #{gem_name}\n"    +
+         "  github_name: #{github_name}\n" +
+         " github_owner: #{github_owner}\n"
+         " version_file: #{version_file}"
   end
 
   desc 'bumpx', 'Bump the x version number, set y & z to zero, update the date.'

data/lib/appium_thor/config.rb

@@ -4,30 +4,19 @@ module Appium
       include Singleton
 
       # Returns true if all options are truthy
-      def validate
-        raise 'Must set gem_name, github_name, version_file' unless @gem_name && @github_name && @version_file
-        raise "version file doesn't exist #{@version_file}" unless File.exist?(@version_file)
-      end
+      def init_and_validate
+        # set default values
+        if @gem_name
+          @github_name  ||= @gem_name
+          @version_file ||= "lib/#{@gem_name}/version.rb"
+        end
 
-      # Returns option value if it's set otherwise
-      # sets the option value to string
-      def gem_name string=nil
-        return @gem_name if @gem_name
-        @gem_name = string
-      end
-
-      # Returns option value if it's set otherwise
-      # sets the option value to string
-      def github_name string=nil
-        return @github_name if @github_name
-        @github_name = string
-      end
+        @github_owner ||= 'appium'
 
-      # Returns option value if it's set otherwise
-      # sets the option value to string
-      def version_file string=nil
-        return @version_file if @version_file
-        @version_file = string
+        # ensure all options are set
+        all_set = @gem_name && @github_name && @github_owner && @version_file
+        raise 'Must set gem_name, github_name, github_owner, version_file' unless all_set
+        raise "version file doesn't exist #{@version_file}" unless File.exist?(@version_file)
       end
 
       # block of code to execute that contains documentation
@@ -37,22 +26,37 @@ module Appium
         @docs_block = block
       end
 
-      # all config.rb options as a symbol array
+      # Returns all options as symbols. Required for defining delegators in init.rb
       def self.options
-        %w[gem_name github_name version_file docs_block].map(&:to_sym)
+        string_options + [:docs_block]
+      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)
+      end
+
+      string_options.each do |option|
+        class_eval %Q(
+         def #{option} string=nil
+          return @#{option} if @#{option}
+          @#{option} = string
+         end
+        )
       end
 
       # Enables setting config in the Thorfile
       #
       # Appium::Thor::Config.set do
       #   gem_name     'appium_thor'
+      #   github_owner 'appium'
       #   github_name  'appium_thor'
       #   version_file 'path/to/version.rb'
       # end
       def self.set &block
         config = self.instance
         config.instance_eval &block
-        config.validate
+        config.init_and_validate
         config
       end
     end # module Config

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/#{github_name}/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
+        out         += "##### [#{obj.name.to_s}](https://github.com/#{github_owner}/#{github_name}/blob/#{last_sha}/lib/#{method_path}#L#{obj.line}) #{os}\n\n"
         out         += "> #{obj.signature}\n\n"
         out         += "#{obj.docstring}\n\n"
 

data/lib/appium_thor/helpers.rb

@@ -122,7 +122,7 @@ module Appium
             # use first 7 chars to match GitHub
             comment = line.gsub(hex, '').strip
             next if comment == 'Update release notes'
-            new_data += "- [#{hex[0...7]}](https://github.com/appium/#{github_name}/commit/#{hex}) #{comment}\n"
+            new_data += "- [#{hex[0...7]}](https://github.com/#{github_owner}/#{github_name}/commit/#{hex}) #{comment}\n"
           end
           data  = new_data + "\n"
 

data/lib/appium_thor/version.rb

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

data/release_notes.md

@@ -1,3 +1,15 @@
+#### v0.0.7 2014-08-04
+
+- [e36ab29](https://github.com/appium/appium_thor/commit/e36ab29971eb4ccc0b5b4527f23dbb34bf590107) Release 0.0.7
+- [b7cc396](https://github.com/appium/appium_thor/commit/b7cc3965b33020e599e83188efafbd946472f728) Release 0.0.7
+- [d8c695e](https://github.com/appium/appium_thor/commit/d8c695e344c2cddd315c644c0363176e01fac323) Fix delegators
+- [a68604a](https://github.com/appium/appium_thor/commit/a68604a1f76827fb3b4b3fcbedd8a1eacc818005) Fix delegators
+- [494e083](https://github.com/appium/appium_thor/commit/494e08359e8dcff04cf85d06b6a13ce6043f8c8b) Document default values
+- [5085c84](https://github.com/appium/appium_thor/commit/5085c849829a770e34e7e1f2a70a1dba61ef229d) Add default values
+- [2cea23d](https://github.com/appium/appium_thor/commit/2cea23dbc055006d17ceb8aef2f25341ea765aa4) Add github_owner
+- [e117e5d](https://github.com/appium/appium_thor/commit/e117e5dead6c67a9dc47fbf697358d91246ad414) Update README.md
+
+
 #### v0.0.6 2014-07-31
 
 - [b6659a4](https://github.com/appium/appium_thor/commit/b6659a4ea55c99cf68707f75d02ef29062760a00) Release 0.0.6

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_thor
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet