kinchan 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b82350b04e5a9b22807db0d79b214df3361e9bd0dd265d8935bddf7c8d14a2fa
-  data.tar.gz: 861f6d1aa58b7f540973b429ab077e8e466f5240215d283dfdcb4847afb0dc96
+  metadata.gz: 93bc12b281b802a4d65f633687ea807eaa65fbb9002f1c4a7600a98ce39549e2
+  data.tar.gz: 6f9ff2796e4462c4f6d918dd602a0a348fde0783bcb2395a7832bb787df9b976
 SHA512:
-  metadata.gz: 985cef26ece162e52e2f64ed860712b1412ab2895b11198de1755f0f03e33549f8a82c67d8da394c17d46e4443f92ced9b12675662ed5c64f0d2d988fd8fc0be
-  data.tar.gz: 5959195c6d85c7e9ad7d32deb56a83d56c47dcdd92e3897857cc863a63c7272d7011d364725c7e95f2ec69a34da796078e28c16337754029bc0e1db7588b7c07
+  metadata.gz: 6951b48f5e47c2934295b49c7126d58b06f30970c3e59655f5b44ca5be7d916a5a2d3153994d9b874b3ae9a134e4c4cc2032f8ca057a1f614179b54cc181cbbf
+  data.tar.gz: ea72cab859176ca0c0d5cc16aa9c890c43cd33e68e4c36075bd7030ccf3d12f9345c22f549e48ba1ba59a5331141574f6416951b32a5908b82b5225fc4f6f01b

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 .idea
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in kinchan.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -9,10 +9,24 @@ GEM
   remote: https://rubygems.org/
   specs:
     childprocess (3.0.0)
-    rake (12.3.2)
+    diff-lcs (1.3)
+    rake (13.0.1)
     require_all (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rubyzip (2.0.0)
-    selenium-webdriver (3.142.6)
+    selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
 
@@ -21,7 +35,8 @@ PLATFORMS
 
 DEPENDENCIES
   kinchan!
-  rake (~> 12.0)
+  rake (~> 13.0)
+  rspec (~> 3.9.0)
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -1,5 +1,5 @@
 # [Kinchan](https://itazuranakiss.fandom.com/wiki/Kinnosuke_Ikezawa)
-## Composable browser automation for Ruby.
+## Composable browser automation with Ruby.
 
 ### Requirements
 
@@ -77,7 +77,7 @@ That's all it takes to run a task. Kinchan handles the rest.
 
 ### Passing Data to a Task
 
-A task's initialize function can accept options, just don't forget to call super
+A task's initialize method can accept options, just don't forget to call super
 
 e.g.
 
@@ -119,12 +119,14 @@ end
 
 Task's do not need to be in the same scope, as long as the task exists Kinchan will find and run it when appropriate
 
+### [Examples](https://github.com/sosodev/kinchan-examples)
+
 ### Setting Selenium Browser Options
 
 before running your task you can modify the selenium browser options like so
 
 ```ruby
-Kinchan::Task.browser = :chrome
-Kinchan::Task.browser_options = Selenium::WebDriver::Chrome::Options.new
-Kinchan::Task.browser_options.add_argument('--headless')
+Kinchan.browser = :chrome
+Kinchan.browser_options = Selenium::WebDriver::Chrome::Options.new
+Kinchan.browser_options.add_argument('--headless')
 ```

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/kinchan.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'selenium-webdriver', ['~> 3.142.6']
   spec.add_runtime_dependency 'require_all', ['~> 3.0.0']
+
+  spec.add_development_dependency 'rspec', ['~> 3.9.0']
 end

data/lib/kinchan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kinchan
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/kinchan.rb

@@ -5,21 +5,37 @@ require 'selenium-webdriver'
 require 'require_all'
 
 module Kinchan
-  class Error < StandardError; end
+  @browser = :chrome
+  @browser_options = nil
+
+  def self.browser
+    @browser
+  end
+
+  def self.browser= b
+    @browser = b
+  end
+
+  def self.browser_options
+    @browser_options
+  end
+
+  def self.browser_options= bo
+    @browser_options = bo
+  end
 
   class Task
     singleton_class.send(:attr_accessor, :browser)
     singleton_class.send(:attr_accessor, :browser_options)
     singleton_class.send(:attr_reader, :descendants)
     @descendants = []
-    @browser = :chrome
-    @browser_options = nil
-    @@browser_webdriver = nil
 
     def initialize(**options)
       @before_tasks = []
       @after_tasks = []
       @options = options
+
+      Task.start_browser
     end
 
     def self.inherited(subclass)
@@ -30,24 +46,24 @@ module Kinchan
       Task.descendants.select { |task| task.name.split('::').last.downcase == task_symbol.to_s.downcase }[0]
     end
 
+    def self.start_browser
+      if Kinchan.browser_options.nil?
+        @@browser_webdriver = Selenium::WebDriver.for Kinchan.browser
+      else
+        @@browser_webdriver = Selenium::WebDriver.for(Kinchan.browser, options: Kinchan.browser_options)
+      end
+    end
+
     def self.restart_browser
       unless @@browser_webdriver.nil?
         @@browser_webdriver.close
-        @@browser_webdriver = Selenium::WebDriver.for Task.browser
+        @@browser_webdriver = Selenium::WebDriver.for Kinchan.browser
       end
     end
 
     def execute(browser); end
 
     def run
-      if @@browser_webdriver.nil?
-        if Task.browser_options.nil?
-          @@browser_webdriver = Selenium::WebDriver.for Task.browser
-        else
-          @@browser_webdriver = Selenium::WebDriver.for(Task.browser, options: Task.browser_options)
-        end
-      end
-
       @before_tasks.each do |task_hash|
         task = Task.find_task(task_hash[:task])
         task.new(**task_hash[:options]).public_send('run') unless task.nil?
@@ -63,4 +79,4 @@ module Kinchan
   end
 end
 
-require_all 'tasks'
+require_all 'tasks' if File.directory?('tasks')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinchan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyle McGough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 description: Composable browser automation with Ruby. Create, compose, and run tasks
   that automate the browser with Selenium.
 email:
@@ -48,12 +62,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rakeTasks"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bundle
 - bin/console
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
 - bin/setup
 - kinchan.gemspec
 - lib/kinchan.rb