marty_rspec 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a66ed63853c3aaa6307a27d2e8926054d8d1ce
-  data.tar.gz: 7bd7daa4ebf6a9a609cd8a03f96adf1a65b63fa3
+  metadata.gz: f5f5f84a781635900e1ceef086b902ee8b92db76
+  data.tar.gz: 1ac4b61457b1d88cb89565135bd4f20e5316a5eb
 SHA512:
-  metadata.gz: e6298731dd50d8b1db4e5bee9b6f364932f66bb2cf748657ea7590885baaccc30689220f65e00045d805e7e806cf191f4dd110b185e656a9baf8fca376586462
-  data.tar.gz: 2a96e0b2aefa3368621a28f00e0e403c151d37ca4212730308b41052bc7456c6b3e28704d31a897b9fda67410b5b9cff57585431cf4bd9dcddcec5020611abb1
+  metadata.gz: 427b2d76f37f080a4eeed3c95661f65e7c2784f5236e61c81e89b1a1d3791add97500542c3b38750a40e1eae8d903dad0f519f98a505e3e7ff2e0007aa40429f
+  data.tar.gz: 8f918c4a5e0005b8291bb379dd1af1ffcabd9a3836210fd713d2418b15cc33c55f7369cd78bda9d4815584127827b9c5de681938fd569f6b9581297aceb3dc21

data/README.md

@@ -1,8 +1,51 @@
-# MartyRspec
+# Marty RSpec
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/marty_rspec`. To experiment with that code, run `bin/console` for an interactive prompt.
+is a set of helper methods for integration/feature testing for the [Marty](https://github.com/arman000/marty) framework. In particular, it primarily maps javascript functions to provide Capybara-like behavior for Netzke/ExtJS components. 
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+On the macro-level, Marty RSpec functionality can be broken up into 6 pieces. 
+
+1. General Utility functions
+
+examples include log_in, press(button)
+
+2. Wait functions
+
+because netzke/extjs requires execute_scripts all over the place, and because this causes intermittent timing failures
+
+3. Netzke Component Utility functions
+  
+  first, call `c = netzke_find(name, component_type)`
+  note that this doesn't actually 'find' the component a la Capybara. Instead, it prepares the javascript to be used for the particular component helper method. So, in order for any javascript to run, you would need to call (on a grid), for example, `c.row_count`
+
+  1. component_type = 'gridpanel' 
+
+    this is the default
+
+  2. component_type = 'combobox'
+
+4. Custom Capybara selectors
+
+for using Capybara find on commonly used netzke/extjs DOM items
+
+5. Custom RSpec Matchers
+
+6. RSpec-by formatter 
+
+  this is actually an external gem that provides verbose RSpec formatter with benchmarking capabilities. You can wrap bits of longer feature tests in a block. RSpec will print the messages out with how many seconds each block took to complete. 
+
+  ```
+  # the beginning of your awesome test
+  by 'your output message here' do
+    # some test stuff here
+  end
+
+  and_by 'your next step' do
+    # some other test stuff here
+  end
+  # the rest of your awesome test
+  ```
 
 ## Installation
 
@@ -14,25 +57,15 @@ gem 'marty_rspec'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install marty_rspec
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/marty_rspec.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sleepn247/marty_rspec.
 
 
 ## License

data/lib/marty_rspec/components/netzke_combobox.rb

@@ -0,0 +1,58 @@
+require 'capybara/dsl'
+require 'rspec/matchers'
+
+module MartyRSpec
+  module Components
+    class NetzkeCombobox
+      include Util
+      include Capybara::DSL
+      include RSpec::Matchers
+
+      attr_reader :name, :combobox
+
+      def initialize(name)
+        @name = name
+        if /^\d+$/.match(name)
+          @combobox = ext_find('combobox', nil, name)
+        else
+          @combobox = ext_combo(name)
+        end
+      end
+
+      def select_values(values)
+        run_js <<-JS
+        var values = #{values.split(/,\s*/)};
+        #{combobox}
+        var arr = new Array();
+        for(var i=0; i < values.length; i++) {
+          arr[i] = combo.findRecordByDisplay(values[i]);
+        }
+        combo.select(arr);
+        if (combo.isExpanded) {
+          combo.onTriggerClick();
+        };
+        return true;
+        JS
+      end
+
+      def get_values
+        run_js <<-JS
+        var values = [];
+        #{combobox}
+        combo.getStore().each(
+          function(r) { values.push(r.data.text || r.data.field1); });
+        return values;
+      JS
+      end
+
+      def click
+        run_js <<-JS
+        #{combobox}
+        combo.onTriggerClick();
+        return true;
+        JS
+        wait_for_element { !ajax_loading? }
+      end
+    end
+  end
+end

data/lib/marty_rspec/{netzke_grid.rb → components/netzke_grid.rb}

@@ -2,24 +2,21 @@ require 'capybara/dsl'
 require 'rspec/matchers'
 
 module MartyRSpec
-  module NetzkeGrid
-    def netzke_find(name, grid_type = 'gridpanel')
-      NetzkeGridNode.new(name, grid_type)
-    end
-
-    class NetzkeGridNode
+  module Components
+    class NetzkeGrid
       include Util
       include Capybara::DSL
       include RSpec::Matchers
 
       attr_reader :name, :grid
 
-      def initialize(name, grid_type)
+      def initialize(name, c_type)
+        # for now, also allows treepanel
         @name = name
         if /^\d+$/.match(name)
-          @grid = ext_find(grid_type, nil, name)
+          @grid = ext_find(c_type, nil, name)
         else
-          @grid = ext_find(ext_arg(grid_type, name: name))
+          @grid = ext_find(ext_arg(c_type, name: name))
         end
       end
 
@@ -38,12 +35,7 @@ module MartyRSpec
         res.to_i
       end
 
-      def row_total
-        res = run_js <<-JS
-          return #{grid}.getStore().getTotalCount();
-        JS
-        res.to_i
-      end
+      alias :row_total :row_count
 
       def row_modified_count
         res = run_js <<-JS
@@ -66,8 +58,8 @@ module MartyRSpec
         JS
       end
 
-      def col_values(col, cnt, init=0)
-        #does not validate the # of rows
+      def col_values(col, cnt=row_count, init=0)
+        # NOTE: does not validate the # of rows
         run_js <<-JS
           var result = [];
           for (var i = #{init}; i < #{init.to_i + cnt.to_i}; i++) {

data/lib/marty_rspec/util.rb

@@ -2,15 +2,6 @@ module MartyRSpec
   module Util
     MAX_WAIT_TIME = 5.0
 
-    # essentially works as documentation & wait
-    def by message, level=0
-      wait_for_ready(10)
-      pending(message) unless block_given?
-      yield
-    end
-
-    alias and_by by
-
     # navigation helpers
     def ensure_on(path)
       visit(path) unless current_path == path
@@ -61,6 +52,15 @@ module MartyRSpec
       find(:xpath, '//img[contains(@class, "x-tool-close")]', wait: 5).click
     end
 
+    def zoom_out
+      el = find(:body, match: :first)
+      el.native.send_keys([:control, '0'])
+      el.native.send_keys([:control, '-'])
+      el.native.send_keys([:control, '-'])
+      el.native.send_keys([:control, '-'])
+    end
+
+    #####
     def wait_for_ready wait_time = nil
       if wait_time
         find(:status, 'Ready', wait: wait_time)
@@ -81,14 +81,6 @@ module MartyRSpec
     JS
     end
 
-    def zoom_out
-      el = find(:body, match: :first)
-      el.native.send_keys([:control, '0'])
-      el.native.send_keys([:control, '-'])
-      el.native.send_keys([:control, '-'])
-      el.native.send_keys([:control, '-'])
-    end
-
     def wait_for_element(seconds_to_wait = 2.0, sleeptime = 0.1)
       res = nil
       start_time = current_time = Time.now
@@ -104,6 +96,18 @@ module MartyRSpec
       res
     end
 
+    #####
+    # note that netzke_find doesn't actually find the component (as in Capybara)
+    # instead, it prepares the javascript to be run on the component object
+    def netzke_find(name, c_type = 'gridpanel')
+      case c_type
+      when 'combobox'
+        MartyRSpec::Components::NetzkeCombobox.new(name)
+      else
+        MartyRSpec::Components::NetzkeGrid.new(name, c_type)
+      end
+    end
+
     def run_js js_str, seconds_to_wait = MAX_WAIT_TIME, sleeptime = 0.1
       result = wait_for_element(seconds_to_wait, sleeptime) do
         page.document.synchronize { @res = page.execute_script(js_str) }
@@ -144,9 +148,11 @@ module MartyRSpec
       result.split(' ')[1].to_i
     end
 
+    private
     def simple_escape! text
       text.gsub!(/(\r\n|\n)/, "\\n")
       text.gsub!(/\t/, "\\t")
+      text.gsub!(/"/, '\"')
     end
 
     def paste text, textarea
@@ -157,6 +163,7 @@ module MartyRSpec
       run_js <<-JS
       #{ext_var(ext_find(ext_arg('textarea', name: textarea)), 'area')}
       area.setValue("#{text}");
+      return true;
     JS
     end
 
@@ -167,7 +174,24 @@ module MartyRSpec
       !res[:class].match(/disabled/).nil?
     end
 
-    # Netzke component lookups, arguments for helper methods below
+    # Field edit/Key in Helpers
+    def type_in(type_s, el_id)
+      el = find_by_id("#{el_id}")
+      el.native.clear()
+      type_s.each_char do |key|
+        el.native.send_keys(key)
+      end
+      el.send_keys(:enter)
+    end
+
+    def press_key_in(key, el_id)
+      kd = key.downcase
+      use_key = ['enter', 'return'].include?(kd) ? kd.to_sym : key
+      el = find_by_id("#{el_id}")
+      el.native.send_keys(use_key)
+    end
+
+    # Netzke component lookups, arguments for helper methods 
     # (i.e. component) require JS scripts instead of objects
     def ext_arg(component, c_args = {})
       res = component
@@ -233,25 +257,13 @@ module MartyRSpec
     JS
     end
 
-    # Field edit/Key in Helpers
-    def type_in(type_s, el_id)
-      el = find_by_id("#{el_id}")
-      el.native.clear()
-      type_s.each_char do |key|
-        el.native.send_keys(key)
-      end
-      el.send_keys(:enter)
-    end
-
-    def press_key_in(key, el_id)
-      kd = key.downcase
-      use_key = ['enter', 'return'].include?(kd) ? kd.to_sym : key
-      el = find_by_id("#{el_id}")
-      el.native.send_keys(use_key)
-    end
+    ##############
+    # DEPRECATED #
+    ##############
 
-    # Combobox Helpers
+    # Combobox Helpers, now separate component, like grid
     def select_combobox(values, combo_label)
+      warn "[DEPRECATED] use netzke_find('#{combo_label}', 'combobox').select_values(values)"
       run_js <<-JS
       var values = #{values.split(/,\s*/)};
       #{ext_combo(combo_label)}
@@ -261,11 +273,15 @@ module MartyRSpec
         arr[i] = combo.findRecordByDisplay(values[i]);
       }
       combo.select(arr);
-      if (combo.isExpanded) { combo.onTriggerClick(); }
+      if (combo.isExpanded) {
+        combo.onTriggerClick();
+        return true;
+      };
     JS
     end
 
     def combobox_values(combo_label)
+      warn "[DEPRECATED] use netzke_find('#{combo_label}', 'combobox').get_values"
       run_js <<-JS
       #{ext_combo(combo_label)}
       var values = [];
@@ -276,16 +292,18 @@ module MartyRSpec
     end
 
     def click_combobox combo_label
+      warn "[DEPRECATED] use netzke_find('#{combo_label}', 'combobox').click"
       run_js <<-JS
       #{ext_combo(combo_label)}
       combo.onTriggerClick();
+      return true;
     JS
       wait_for_element { !ajax_loading? }
     end
 
     def custom_selectors
-      # DEPRECATED: Selectors are automatically loaded now
-      warn "[DEPRECATED] no longer needed to manually load selectors"
+      # automatically loaded now
+      warn "[DEPRECATED] automatically loaded"
     end
   end
 end

data/lib/marty_rspec/version.rb

@@ -1,3 +1,3 @@
 module MartyRSpec
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/marty_rspec.rb

@@ -1,5 +1,7 @@
 require 'marty_rspec/version'
 require 'marty_rspec/util'
-require 'marty_rspec/netzke_grid'
+require 'marty_rspec/components/netzke_grid'
+require 'marty_rspec/components/netzke_combobox'
 require 'marty_rspec/custom_matchers'
 require 'marty_rspec/custom_selectors'
+require 'rspec/by'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marty_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Masaki Matsuo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-by
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: masaki.matsuo@pnmac.com
 executables: []
@@ -36,9 +50,10 @@ files:
 - README.md
 - Rakefile
 - lib/marty_rspec.rb
+- lib/marty_rspec/components/netzke_combobox.rb
+- lib/marty_rspec/components/netzke_grid.rb
 - lib/marty_rspec/custom_matchers.rb
 - lib/marty_rspec/custom_selectors.rb
-- lib/marty_rspec/netzke_grid.rb
 - lib/marty_rspec/util.rb
 - lib/marty_rspec/version.rb
 - spec/marty_rspec_spec.rb