page_object_stubs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89267a772ad21e08e93bed62d7b14fbd80980ced
+  data.tar.gz: 0ab37018da064df14bbd8ddb30355067c12940ef
+SHA512:
+  metadata.gz: 56e0a0f78722d2d942e6d3db246c02101379e09e437a7cc196a1d2cc862ca254a3a236370a6170bcb85a7b099931f114a539857d773243f5d991dac22ffb4596
+  data.tar.gz: 8a55b50cd2b826cc007063bfd17ae66dba18ba8607dbad6c46242a5e563a941dae338000d17c05fac2b17037219914c1c9f7fb86c381c95ff623d420d16a37ff

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+spec/actual_stub/

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rspec
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in page_object_stubs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,27 @@
+# PageObjectStubs [![Build Status](https://travis-ci.org/bootstraponline/page_object_stubs.svg?branch=master)](https://travis-ci.org/bootstraponline/page_object_stubs)
+
+PageObject stub generator for RubyMine.
+
+```ruby
+targets = Dir.glob(File.join(__dir__, '..', 'page', '*_page.rb'))
+output = File.join(__dir__, '..', 'stub')
+PageObjectStubs.generate targets: targets, output: output
+```
+
+```ruby
+# Creates stubs from target Ruby files in output folder with the format
+# target_filename_stub.rb
+#
+# @param [Hash] opts
+# @option opts [File] :targets Array of target files to create stubs from
+# @option opts [Dir] :output_folder Folder to create stubs in
+def generate opts={}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/bootstraponline/page_object_stubs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/Thorfile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'appium_thor'
+
+Appium::Thor::Config.set do
+  gem_name 'page_object_stubs'
+  github_owner 'bootstraponline'
+end
+
+# Must use '::' otherwise Default will point to Thor::Sandbox::Default
+# Debug by calling Thor::Base.subclass_files via Pry
+#
+# https://github.com/erikhuda/thor/issues/484
+#
+class ::Default < Thor
+  desc 'spec', 'Run RSpec tests'
+  def spec
+    exec 'rspec spec'
+  end
+end

data/debug.md

@@ -0,0 +1,54 @@
+AST debugging info.
+
+```ruby
+=begin
+    (send nil :page_url
+      (str "http://www.thegymnasium.com/"))
+
+      page_url 'http://www.thegymnasium.com/'
+
+    # ---
+
+    (send nil :button
+      (sym :sign_in)
+      (hash
+        (pair
+          (sym :xpath)
+          (str "//*[@id=\"drop001\"]"))))
+
+    button :sign_in, xpath: '//*[@id="drop001"]'
+
+    # ---
+
+    (send nil :text_field
+      (sym :user_name)
+      (hash
+        (pair
+          (sym :id)
+          (str "user_name"))))
+
+    text_field :user_name, :id => 'user_name'
+
+    # ---
+
+    (send nil :text_field
+      (sym :password)
+      (hash
+        (pair
+          (sym :css)
+          (str "#loginfrm > fieldset > div.col > #user_pass"))))
+
+    text_field :password, :css => '#loginfrm > fieldset > div.col > #user_pass'
+
+    # ---
+
+    (send nil :button
+      (sym :submit_sign_in)
+      (hash
+        (pair
+          (sym :css)
+          (str "#loginfrm > fieldset > div.btn-holder > input.btn"))))))]
+
+    button :submit_sign_in, css: '#loginfrm > fieldset > div.btn-holder > input.btn'
+=end
+```

data/lib/page_object_stubs.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'parser/current'
+
+require 'fileutils'
+
+require_relative 'page_object_stubs/version'
+require_relative 'page_object_stubs/ast_processor'
+require_relative 'page_object_stubs/page_object_stubs'

data/lib/page_object_stubs/ast_processor.rb

@@ -0,0 +1,69 @@
+module PageObjectStubs
+
+  class ProcessPageObjects < Parser::AST::Processor
+
+    attr_reader :name_type_pairs
+
+    def initialize
+      @name_type_pairs = []
+      super
+    end
+
+    # page-object/lib/page-object/elements/*.rb plus page_url
+    @@valid_elements = %w[area audio button canvas check_box div element file_field form heading hidden_field image
+label link list_item media option ordered_list paragraph radio_button select_list span table
+table_cell table_row text_area text_field unordered_list video] + %w[page_url]
+
+    def is_valid child
+      # child may be a symbol or a string
+      @@valid_elements.include?(child.to_s)
+    end
+
+    def _print_children children_array
+      # `def on_send` receives AST::Node send
+      # the children array of that node is sent to _print_children
+      # -> symbol :page_url
+      # inside print children, the element type is found (page_url)
+      # -> AST::Node str/symbol
+      # once we know the type, we look for an AST::Node that contains the element name
+
+      pair = []
+
+      find_element_name = false
+      element_name      = nil # symbol or string
+      children_array.each do |child|
+        if find_element_name && child.is_a?(AST::Node)
+          first = child.children.first
+          if first.class == Symbol || first.class == String
+            element_name = first.to_s
+            # puts "element_name: #{element_name}"
+            pair << element_name
+            break
+          end
+        end
+
+        if is_valid child
+          # puts "element_type: #{child}"
+          pair << child.to_s # element_type
+          find_element_name = true
+        end unless find_element_name
+      end
+
+      @name_type_pairs << pair if pair.length == 2
+    end
+
+    def generate_send node
+      c = node.children
+
+      return unless c
+      _print_children c
+      # node.type is send
+      # the rest of the data is in the children.
+    end
+
+    def on_send node
+      generate_send node
+      super
+    end
+  end
+end

data/lib/page_object_stubs/page_object_stubs.rb

@@ -0,0 +1,90 @@
+module PageObjectStubs
+  class << self
+    # Creates stubs from target Ruby files in output folder with the format
+    # target_filename_stub.rb
+    #
+    # ```ruby
+    # targets = Dir.glob(File.join(__dir__, '..', 'page', '*_page.rb'))
+    # output = File.join(__dir__, '..', 'stub')
+    # PageObjectStubs.generate targets: targets, output: output
+    # ```
+    #
+    # @param [Hash] opts
+    # @option opts [File] :targets Array of target files to create stubs from (required)
+    # @option opts [Dir] :output_folder Folder to create stubs in (required)
+    # @option opts [Boolean] :angularjs Enable angularjs support (optional, default false)
+    def generate opts={}
+      angularjs = !!opts.fetch(:angularjs, false)
+      targets   = opts.fetch(:targets)
+      targets   = targets.select do |target|
+        File.file?(target) && File.readable?(target)
+      end
+
+      output_folder = File.expand_path(opts.fetch(:output_folder))
+      FileUtils.mkdir_p output_folder
+
+      targets.each do |f|
+        ast          = Parser::CurrentRuby.parse File.read f
+        page_objects = ProcessPageObjects.new
+
+        page_objects.process ast
+
+        file_name        = File.basename(f, '.*')
+        file_module_name = file_name.split('_').map(&:capitalize).join
+        file_method_name = file_name.downcase
+        output_prefix    = <<R
+module Stub
+  module #{file_module_name}
+    class << self
+R
+        output = ''
+
+        def wrap method_name
+          ' ' * 6 + "def #{method_name}; fail('stub called!'); end" + "\n"
+        end
+
+        page_objects.name_type_pairs.each do |pair|
+          element_type = pair.first
+          if element_type == 'page_url'
+            output += wrap 'goto'
+            # visit loads goto then runs the Protractor waitForAngular JavaScript
+            output += wrap 'visit' if angularjs
+            next
+          end
+
+          element_name = pair.last
+
+          output += wrap "#{element_name}"
+          output += wrap "#{element_name}_element"
+          output += wrap "#{element_name}?"
+
+          output += wrap "#{element_name}=" if element_type == 'text_field'
+        end
+
+
+        stub_file = File.join(output_folder, file_name + '_stub.rb')
+
+        output_postfix = <<R
+    end
+  end
+end
+
+module Kernel
+  def #{file_method_name}
+    Stub::#{file_module_name}
+  end
+end unless Kernel.respond_to? :#{file_method_name}
+R
+
+        output = output_prefix + output + output_postfix
+
+        File.open(stub_file, 'w') do |file|
+          file.write output.strip
+        end
+      end
+
+# if 'page_url' exists, then we need `def goto`
+# for all others, we need the name of the element to generate the remaining methods.
+    end
+  end
+end

data/lib/page_object_stubs/version.rb

@@ -0,0 +1,4 @@
+module PageObjectStubs
+  VERSION = '0.0.1' unless defined? ::PageObjectStubs::VERSION
+  DATE    = '2015-05-09' unless defined? ::PageObjectStubs::DATE
+end

data/page_object_stubs.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/page_object_stubs/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.name    = 'page_object_stubs'
+  spec.version = PageObjectStubs::VERSION
+  spec.date    = PageObjectStubs::DATE
+  spec.license = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  spec.authors = spec.email = ['code@bootstraponline.com']
+
+  spec.summary     = spec.description = 'PageObject stub generator for RubyMine'
+  spec.description += '.' # avoid identical warning
+  spec.homepage    = 'https://github.com/bootstraponline/page_object_stubs'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'parser', '~> 2.2.2.2'
+
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'appium_thor', '~> 0.0.7'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: page_object_stubs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- code@bootstraponline.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: appium_thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: PageObject stub generator for RubyMine.
+email:
+- code@bootstraponline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Thorfile
+- debug.md
+- lib/page_object_stubs.rb
+- lib/page_object_stubs/ast_processor.rb
+- lib/page_object_stubs/page_object_stubs.rb
+- lib/page_object_stubs/version.rb
+- page_object_stubs.gemspec
+homepage: https://github.com/bootstraponline/page_object_stubs
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: PageObject stub generator for RubyMine
+test_files: []
+has_rdoc: