watir_shot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e0f9a09acfd2c9c0b1c603a150c5576ac894c98
+  data.tar.gz: 7161a0927e1194a3b848497656fc62291d2d4cc2
+SHA512:
+  metadata.gz: 6b00d6170190797637a6a75365545f22a19466ac0ad522654281db3178b7d0d0f1176b64de2eeb05bc156b739011793f354c10eba4936345b4947de6faf3b476
+  data.tar.gz: c68ebe45b0e4884e166fd7430e34f7badbe75858dc2e44e3fd813b0557ca84416b2f0f45ecf17f6b938241ef63500b1ab1828e0623b26f071f43f848f0be8fb6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= WatirShot
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WatirShot'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails/railtie'
+require 'watir_shot'
+
+module WatirShot
+  class Railtie < ::Rails::Railtie
+    config.watir_shot = ActiveSupport::OrderedOptions.new
+    config.eager_load_namespaces << WatirShot
+
+    generators do
+      require 'watir_shot/generator'
+    end
+
+
+    rake_tasks do
+      load 'tasks/watir_shot_tasks.rake'
+    end
+  end
+end

data/lib/tasks/watir_shot_tasks.rake

@@ -0,0 +1,46 @@
+namespace :watir_shot do
+  desc "Create config/watir_shot.yml"
+  task create_yml: :environment do
+    require 'watir_shot/generator'
+    WatirShot::WatirShotGenerator.new.create_routes_yml
+  end
+
+  desc "Capture screenshot by watir.(Ex. rake watir_shot:capture[chrome])"
+  task :capture, "browser_type"
+  task capture: :environment do |_, args|
+    require "watir"
+    require "watir-webdriver"
+    browser_type = args.browser_type.to_sym if args.browser_type.present?
+    browser_type ||= :firefox
+    watir_shot_yml_path = Rails.root.join("config/watir_shot.yml")
+    unless File.exist? watir_shot_yml_path
+      raise Exception.new("config/watir_shot.yml not found.\nCreate config/watir_shot.yml(rake watir_shot:create_yml)")
+    end
+    watir_shot_pages = YAML.load_file(watir_shot_yml_path)["pages"]
+    raise Exception.new("Need default key in watir_shot.yml") unless watir_shot_pages.keys.include?('default')
+    # generate browser
+    browser = case browser_type
+                when :chrome
+                  Watir::Browser.new :chrome, switches: %w[--test-type --ignore-certificate-errors --disable-popup-blocking --disable-translate]
+                else
+                  Watir::Browser.new(browser_type)
+              end
+
+    watir_shot_pages.keys.each do |key|
+      # prepare saved screenshot directory
+      tmp_dir = Rails.root.join("tmp/watir_shot/#{browser.driver.browser.to_s}/#{key}")
+      FileUtils.mkdir_p tmp_dir unless Dir.exist? tmp_dir
+      # clean screenshot directory before capture.
+      FileUtils.rm(Dir.glob(tmp_dir.to_s + '/**/*.png'))
+      # do pre-processing
+      WatirShot.befores[key.to_sym].call(browser) unless WatirShot.befores[key.to_sym]
+      watir_shot_pages[key].each.with_index(1) do |page, index|
+        browser.goto WatirShot.base_url + page['path']
+        browser.screenshot.save "#{tmp_dir}/#{sprintf('%04d', index)}-#{page['title']}.png"
+      end
+      # do post-processing
+      WatirShot.afters[key.to_sym].call(browser) unless WatirShot.afters[key.to_sym]
+    end
+    browser.close
+  end
+end

data/lib/watir_shot/generator.rb

@@ -0,0 +1,69 @@
+module WatirShot
+  class WatirShotGenerator < Rails::Generators::Base
+    desc "Initialize WatirShot"
+    def create_initializer_file
+      initializer "watir_shot.rb" do
+        <<-FILE.strip_heredoc
+WatirShot.configure do |config|
+  config.default_url_options = {schema: "http", host: "localhost:3000"}
+
+  config.before :default do |browser|
+    # Please input setup.
+    # (Ex: Sign in)
+    #
+    # browser.goto WatirShot.base_url + '/user/login'
+    # browser.text_field(:id, "user_email").set("foo@example.com")
+    # browser.text_field(:id, "user_password").set("something")
+    # browser.button(:value, "Sign In").click
+  end
+
+  config.after :default do |browser|
+    # Please input after.
+    # (Ex: Sign out)
+    #
+    # browser.link(:text, "Sign Out").click
+  end
+
+  # If you want to capture in various situations, make a new symbol.
+  # And you should add new element in watir_shot.yml
+  # (Ex. Admin user)
+  #
+  # config.before :admin_user do |browser|
+  #   # Something
+  # end
+  #
+  # config.after :admin_user do |browser|
+  #   # Something
+  # end
+  #
+  # Sample watir_shot.yml
+  # ---
+  # pages:
+  #   default:
+  #     -
+  #        title: 'TopPage'
+  #        path: '/'
+  #   admin_user:
+  #     -
+  #        title: 'TopPage'
+  #        path: '/'
+end
+        FILE
+      end
+      create_routes_yml
+    end
+
+    def create_routes_yml
+      all_routes = Rails.application.routes.routes
+      require 'action_dispatch/routing/inspector'
+      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+      routes = inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER']).split("\n")
+      method_get_routes = routes.select{|route| route =~ /GET/ }.map{|route| route.strip }
+      paths = method_get_routes.map{|route| route.gsub(/\s+/, ' ').split(' ')[2].gsub('(.:format)', '')}
+      routes_yml = {'pages' =>
+           {'default' => paths.map{|path| {'title' => '', 'path' => path}} }
+      }.to_yaml
+      create_file "config/watir_shot.yml", routes_yml
+    end
+  end
+end

data/lib/watir_shot/version.rb

@@ -0,0 +1,3 @@
+module WatirShot
+  VERSION = "0.0.1"
+end

data/lib/watir_shot.rb

@@ -0,0 +1,30 @@
+module WatirShot
+
+  mattr_accessor :default_url_options
+  @@default_url_options
+
+  def self.configure
+    yield self
+  end
+
+  mattr_accessor :befores
+  @@befores = {}
+
+  def self.before(key, &block)
+    @@befores[key] = block
+  end
+
+  mattr_accessor :afters
+  @@afters = {}
+
+  def self.after(key, &block)
+    @@afters[key] = block
+  end
+
+  def self.base_url
+    schema = @@default_url_options[:schema] || 'http'
+    host = @@default_url_options[:host] || 'localhost:3000'
+    "#{schema}://#{host}"
+  end
+end
+require 'railtie'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: watir_shot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toyoaki Oko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+description: Capture screenshot by watir.
+email:
+- chariderpato@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/railtie.rb
+- lib/tasks/watir_shot_tasks.rake
+- lib/watir_shot.rb
+- lib/watir_shot/generator.rb
+- lib/watir_shot/version.rb
+homepage: https://github.com/patorash/watir_shot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capture screenshot by watir.
+test_files: []