watir-ng 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daffebcf1004af9928c5d468d28bd07722574d11
-  data.tar.gz: 21fab3bcbda254b190279a8588e56bbb5e8d6b30
+  metadata.gz: e244c588c9457a7795771827961a9e0b4bd373a3
+  data.tar.gz: 15cd2d67ff0705e6f84fcd6a17a760c80109237a
 SHA512:
-  metadata.gz: eb78ff0b2eaac8d750d3b57572b79693ce55b1f7e80c5be24e4aff09606baa209611ac3fe5bf9f1e0610086727f44832699506ab39df4f448a25a1440bc6cf2c
-  data.tar.gz: 26a63b760614a571c629d6e15fc851e43adcd8106ea79f9d779b75e0a2e55f308e5da88c2292ded778a60d52f8df243cba6dc20412518209e203425892f56cf6
+  metadata.gz: 932b756b7e15874008d5180fbb27aa81040f32b0af650d4ff0c3a49a7416e1bbe9e5e1972a127d25a9dfc0c0aeb03056fadeab934ba8e7b93dd9368d89803388
+  data.tar.gz: 4edd75c60cc563aab5e9a89276fe14767e19d5d25a4fe3fd26be08af32be0c7d0277534654c3b23a812e23d31646cf56e445dde2c7b9505922257ca63cbe78ae

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v2.0.0 (Feb 24 2016)
+- Patch browser objects with `WatirNg.patch!`
+- Add custom directive identifiers with `WatirNg.register`
+
 ## v1.1.0 (Sep 18 2015)
 - Register custom attributes for identifying elements
 - Thanks Yehuda Miller (@pittgoose) for the idea

data/README.md

@@ -6,23 +6,34 @@ Identify [watir-webdriver](http://github.com/watir/watir-webdriver) elements wit
 
 ## Usage
 
-Require `watir-ng` anywhere you'd instantiate a browser instance and `watir-ng` will patch directive identifiers onto `Watir::HTMLElement`.
+When identifying elements, use the `ng` directives like you would `id`, `class`, etc. Be sure to use underscores instead of dashes though!
+
+```ruby
+# To find and click this HTML element:
+#     <button ng-click="foo">Submit</button>
+
+submit_button = @browser.button(ng_click: "foo")
+submit_button.click
+```
+
+To ensure your browser objects have access to the ng identifiers, run `patch!` before instantiating. 
 
 ```ruby
-require 'watir-webdriver'
 require 'watir-ng'
 
-browser = Watir::Browser.new :chrome
+WatirNg.patch!
+
+@browser = Watir::Browser.new
 ```
 
-When identifying elements, use the `ng` directives like you would `id`, `class`, etc. Be sure to use underscores instead of dashes though!
+You can identify elements with custom directives by registering them before patching the browser. 
 
 ```ruby
-# To find and click this HTML element:
-#     <button ng-click="foo">Submit</button>
+require 'watir-ng'
 
-submit_button = browser.button(ng_click: "foo")
-submit_button.click
+WatirNg.register(:ng_foo, :ng_bar).patch!
+
+@browser = Watir::Browser.new
 ```
 
 ## Installation
@@ -49,5 +60,5 @@ Or install it yourself with:
 
 ## Questions, Comments, Concerns
 
-Find me on Twitter ([@jpdenen](http://twitter.com/jpdenen)) or write up an issue.
+Find me on Twitter ([@jpdenen](http://twitter.com/jpdenen)), gitter ([@jdenen](http://gitter.im/jdenen)) or write up an [issue](https://github.com/jdenen/watir-ng/issues/new).
 

data/lib/watir-ng.rb

@@ -5,57 +5,63 @@ require "watir-ng/version"
 # Adds AngularJS `ng` directives as identifiers for `Watir::Webdriver` elements.
 #
 module WatirNg
-
-  #
-  # All the ng directives from the AngularJS documentation.
-  #
-  # @see `https://docs.angularjs.org/api/ng/directive`
-  #
-  NG_STRINGS = %w(ng_jq ng_app ng_href ng_src ng_srcset ng_disabled ng_checked ng_readonly 
-                  ng_selected ng_open ng_form ng_value ng_bind ng_bind_template ng_bind_html 
-                  ng_change ng_class ng_class_odd ng_class_even ng_cloak ng_controller ng_csp 
-                  ng_click ng_dblclick ng_mousedown ng_mouseup ng_mouseover ng_mouseenter 
-                  ng_mouseleave ng_mousemove ng_keydown ng_keyup ng_keypress ng_submit ng_focus
-                  ng_blur ng_copy ng_cut ng_paste ng_if ng_include ng_init ng_list ng_model 
-                  ng_model_options ng_non_bindable ng_options ng_pluralize ng_repeat ng_show 
-                  ng_hide ng_style ng_switch ng_transclude
-                 )
-
-  #
-  # Inserts `NG_STRINGS` and `custom_directives` into `cls.attributes` as symbols when
-  #  included in the class.
-  #
-  # @param cls [Class]
-  # @return [nil]
-  #
-  def self.included cls
-    if cls.respond_to? :attributes
-      ng_directives.push(*custom_directives).each { |ng| cls.attributes << ng }
+  class << self
+    
+    #
+    # Register custom directives as element identifiers.
+    #
+    # @example
+    #   WatirNg.register "ng_foo", :ng_bar
+    #
+    # @param custom_directives [Symbol, String]
+    # @return [WatirNg]
+    #
+    def register *args
+      tap { |ng| ng.custom_directives.push *args }
     end
-  end
 
-  #
-  # Converts `NG_STRINGS` into an array of symbols.
-  #
-  # @api private
-  # @return [Array<Symbol>] directives
-  #
-  def self.ng_directives
-    @ng_directives ||= NG_STRINGS.map(&:to_sym)
-  end
+    #
+    # Patch Watir::HTMLElements with ng and custom directives.
+    #
+    # @example
+    #   require 'watir-webdriver'
+    #   require 'watir-ng'
+    #   WatirNg.patch!
+    #   browser = Watir::Browser.start
+    #
+    # @return [Array]
+    #
+    def patch!
+      attributes = directives.push *custom_directives.map(&:to_sym)
+      Watir::HTMLElement.attributes.push *attributes
+    end
 
-  #
-  # Collect custom defined directives.
-  #
-  # @return [Array]
-  #
-  def self.custom_directives
-    @custom_directives ||= []
-  end
-end
+    # @api private
+    #
+    # Return array of ng directives.
+    #
+    # @return [Array<Symbol>]
+    #
+    def directives
+      %w(ng_jq ng_app ng_href ng_src ng_srcset ng_disabled ng_checked ng_readonly 
+         ng_selected ng_open ng_form ng_value ng_bind ng_bind_template ng_bind_html 
+         ng_change ng_class ng_class_odd ng_class_even ng_cloak ng_controller ng_csp 
+         ng_click ng_dblclick ng_mousedown ng_mouseup ng_mouseover ng_mouseenter 
+         ng_mouseleave ng_mousemove ng_keydown ng_keyup ng_keypress ng_submit ng_focus
+         ng_blur ng_copy ng_cut ng_paste ng_if ng_include ng_init ng_list ng_model 
+         ng_model_options ng_non_bindable ng_options ng_pluralize ng_repeat ng_show 
+         ng_hide ng_style ng_switch ng_transclude).map(&:to_sym)
+    end
 
-module Watir
-  class HTMLElement
-    include WatirNg
+    # @api private
+    #
+    # Return array of custom directives.
+    #
+    # @return [Array]
+    #
+    def custom_directives
+      @custom_directives ||= []
+    end
+    
   end
 end

data/lib/watir-ng/version.rb

@@ -1,4 +1,4 @@
 module WatirNg
-  # @api private
-  VERSION = "1.1.0"
+  # :nodoc:
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir-ng
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Johnson Denen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver