page-objectify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae357f04a6463e9ce9ca859ef3b35dd972bf2273
-  data.tar.gz: d8ccb8ea92acc03c956ed4c417b181d2ecade5c6
+  metadata.gz: 2e417ae16edad20693749b84059c88413fae8636
+  data.tar.gz: 4db57673c01f2bf12050c57e06f2a9ab6304af44
 SHA512:
-  metadata.gz: f39e6a878b561ea68ad3ecedcf18f0e46cf190a64952ef4c0b7505ab2c8d4e66e26bb298ef89650464739e9224a7c2516ab4aa9156e604f4c584aba2b2fe437e
-  data.tar.gz: de9a4634a70803745848cebc3b9526998fe4f3b6a9a8a5951649b0559477cbd4c4109c42f0d4bc421c3cdedc9b783058d65b0e05af417d11d96eee4aa1f6aff5
+  metadata.gz: 6f6785027783a751977dad1bde51b0028bac70eb94e43a269dcec69e12cf53df3fc7bd9094b6e056441be647589246d882a0a1073e608543fca1ab874ffbc2ea
+  data.tar.gz: d9c093ed86d7f5a1396783e5ffee3df5306b010a34df03d8231270a8b6583c60a8e110831c63cde95162f388f69e72a5b47ac22cfca755b1fde8ce9eafefdc3a

data/README.md

@@ -51,16 +51,10 @@ require "page-objectify/generator"
 require "watir-webdriver"
 
 class GooglePageGenerator < PageObjectify::Generator
-  # Overriding the constructor here is optional
-  def initialize
-    super(file: "path/to/pages-dir/google_page.rb")
-  end
-
   def visit
     @browser = Watir::Browser.new :chrome
     @browser.goto "www.google.com"
-    # TODO: write a #wait_for_ajax helper
-    sleep 1
+    sleep 1 # Use `wait_for_ajax` instead of `sleep`, if jQuery is available on the page!
   end
 end
 ```
@@ -69,15 +63,16 @@ end
 # Rakefile
 require "generators/google_page_generator"
 
-namespace :po do
-  task :generate do
-    GooglePageGenerator.new.generate!
+namespace :generate do
+  task :po do
+    # Specifying file path is optional
+    GooglePageGenerator.new(file: "path/to/pages-dir/google_page.rb").generate!
     # and any other pages you want to generate programmatically
   end
 end
 ```
 
-Then, upon executing the rake task `$ bundle exec rake po:generate`, the following file will be generated:
+Then, upon executing the rake task `$ bundle exec rake generate:po`, the following file will be generated:
 
 ```ruby
 class GooglePage < BasePage
@@ -104,7 +99,15 @@ PageObjectify::Logging.logger.level = 0
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+To release a new version, I must:
+
+0. Update the version number in `version.rb`.
+0. Run `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).
+0. Run `rake changelog`, which will auto-generate a changelog of the PRs merged/Issues resolved in the newest release.
 
 ## Contributing
 

data/Rakefile

@@ -17,5 +17,9 @@ Cucumber::Rake::Task.new(:cucumber_wip) do |t|
   t.cucumber_opts = "-p wip"
 end
 
+task :changelog do
+  sh "github_changelog_generator smoll/page-objectify"
+end
+
 task test: [:spec, :cucumber]
 task default: :test

data/lib/page-objectify/config.rb

@@ -1,12 +1,13 @@
 module PageObjectify
   class Config
-    attr_reader :page, :base, :file
+    attr_reader :generator_class, :page, :base, :file
 
     def initialize(**keywords)
-      truncated = keywords[:generator_class].chomp("Generator")
-      @page = keywords[:page] || truncated
+      @generator_class = keywords[:generator_class] # => "GooglePageGenerator"
+      truncated = @generator_class.chomp("Generator")
+      @page = keywords[:page] || truncated # => "GooglePage"
       @base = keywords[:base] || "BasePage"
-      @file = keywords[:file] || "#{underscorize(truncated)}.rb"
+      @file = keywords[:file] || "#{underscorize(truncated)}.rb" # => google_page.rb
       validate_configs
     end
 

data/lib/page-objectify/generator.rb

@@ -29,7 +29,7 @@ module PageObjectify
       @code.each_line { |line| logger.debug line.chomp }
       logger.debug "** END GENERATED CODE **"
 
-      File.open(@config.file, 'w') { |file| file.write(@code) }
+      write_to_disk
 
       teardown
     end
@@ -38,8 +38,37 @@ module PageObjectify
       @browser.quit
     end
 
+    # Wait until the number of pending AJAX requests drops to zero. Assumes
+    # jQuery is available on the page; behavior is undefined if it's not.
+    #
+    # Raises Watir::Wait::TimeoutError exception if timeout is exceeded.
+    # Raises Selenium::WebDriver::Error::UnknownError: { "errorMessage":"Can't find variable: jQuery", ... } if jQuery is not loaded on page.
+    def wait_for_ajax(timeout = 3, interval = 0.5)
+      require "watir-webdriver/wait" unless defined?(Watir)
+      (timeout / interval).to_i.times do
+        return true if @browser.execute_script('return jQuery.active').to_i == 0
+        sleep interval
+      end
+
+      raise Watir::Wait::TimeoutError, "Timeout of #{timeout} seconds exceeded on waiting for Ajax."
+    end
+
     private
 
+    def write_to_disk
+      final = <<-BANNER.gsub(/^\s*\|/, '')
+              |# This configuration was generated by calling:
+              |# #{@config.generator_class}.new.generate!
+              |# on #{Time.now} using PageObjectify version #{PageObjectify::VERSION}.
+              |# Note that changes to the underlying page that this page class is modeling, or
+              |# new versions of PageObjectify, may require this file to be generated again.
+              BANNER
+      final << @code
+      File.open(@config.file, 'w') do |file|
+        file.write(final)
+      end
+    end
+
     def execute_runtime_checks
       fail "@browser variable must be a Watir::Browser instance! @browser=#{@browser.inspect}" unless @browser.is_a?(Watir::Browser)
       fail "Cannot get current page HTML!" unless @browser.respond_to?(:html)

data/lib/page-objectify/version.rb

@@ -1,3 +1,3 @@
 module PageObjectify
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/page-objectify.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "aruba", "~> 0.10.0"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "chromedriver-helper", "~> 1.0"
+  spec.add_development_dependency "github_changelog_generator", "~> 1.9"
   spec.add_development_dependency "phantomjs", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page-objectify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shujon Mollah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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: phantomjs
   requirement: !ruby/object:Gem::Requirement