travel_to_javascript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18d4fa7a967206118bffb572e13ff639e049a37e2bc69c9588ba7c0812a2036c
+  data.tar.gz: 150deea5b3cb92491a87edc0a6ebff7ca45629e0baf1518baaf4a83f09223f91
+SHA512:
+  metadata.gz: 6a4f483e314ff142f6ad09446dd12866982acadebf5f20b08439fa259c1cd26c439e0c623cd90e1b8f65748478b50577f0e9a1ecea9a3ea5f057c18711fd8c5e
+  data.tar.gz: d47e3d22f504178abe42e086ab16032db8ca1e49fd94cb7d97017c6f9dd1ec29e5de38a85bea311e3304c3027a3ef1626980b888fbf3a4c3ea493b8b6bce08b9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  TargetRubyVersion: 2.7.1
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/spec_helper.rb'
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 90
+  Exclude:
+    - 'travel_to_javascript.gemspec'
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+---
+dist: trusty
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+addons:
+  chrome: stable
+  apt:
+    packages:
+      - chromium-chromedriver
+before_install:
+  - export TZ=Asia/Tokyo
+  - gem install bundler -v 2.1.4
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at madogiwa0124@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in travel_to_javascript.gemspec
+gemspec
+
+gem 'minitest'
+gem 'rake', '~> 12.0'
+gem 'rspec'
+gem 'rubocop'
+gem 'sinatra'

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    travel_to_javascript (0.1.0)
+      capybara
+      webdrivers (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    capybara (3.32.1)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    childprocess (3.0.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.1.0)
+      ast (~> 2.4.0)
+    public_suffix (4.0.4)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    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.1)
+      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)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    rubyzip (2.3.0)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    webdrivers (4.2.0)
+      nokogiri (~> 1.6)
+      rubyzip (>= 1.3.0)
+      selenium-webdriver (>= 3.0, < 4.0)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake (~> 12.0)
+  rspec
+  rubocop
+  sinatra
+  travel_to_javascript!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Madogiwa
+
+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.md

@@ -0,0 +1,99 @@
+# TravelToJavascript
+
+This gem provides a helper `travel_to_javascript` that locks time in javascript.
+It supports `rspec` and `minitest` using capybara.
+
+Override `Date` and `Date.now` in JavaScript by args.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'travel_to_javascript'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install travel_to_javascript
+
+## Usage
+
+`travel_to_javascript` can be used by include `TravelToJavascript`.
+
+By passing the object of `Capybara::Session`(ex. `page`) and the date and time to the argument of `travel_to_javascript`, the time of JavaScript in the block can be fixed at the time of the argument.
+
+### Rspec
+
+``` ruby
+require 'spec_helper'
+require 'travel_to_javascript'
+
+RSpec.describe 'SampleFeatureSpec', type: :feature do
+  include TravelToJavascript
+
+  it 'sample spec' do
+   # NOTE: Use a JavaScript enabled driver.
+    page = Capybara::Session.new(:headless_chrome, TestApp)
+    travel_to_javascript(page, DateTime.parse('2000-01-01 1:11:11.111+9:00')) do
+      page.execute_script('console.error(Date.now(), new Date())')
+      pp page.driver.browser.manage.logs.get(:browser).map(&:message)
+      # locks time by args in block.
+      # => ["console-api 2:32 946656671111 Sat Jan 01 2000 01:11:11 GMT+0900"]
+    end
+    page.execute_script('console.error(Date.now(), new Date())')
+    pp page.driver.browser.manage.logs.get(:browser).map(&:message)
+    # restore time outside block.
+    # => ["console-api 2:32 1586652460142 Sun Apr 12 2020 09:47:40 GMT+0900"]
+  end
+end
+```
+
+### Minitest
+
+``` ruby
+require 'test_helper'
+require 'travel_to_javascript'
+
+class SampleFeatureTest < Minitest::Test
+  include TravelToJavascript
+
+  def test_sample
+     # NOTE: Use a JavaScript enabled driver.
+    page = Capybara::Session.new(:headless_chrome, TestApp)
+    travel_to_javascript(page, DateTime.parse('2000-01-01 1:11:11.111+9:00')) do
+      page.execute_script('console.error(Date.now(), new Date())')
+      pp page.driver.browser.manage.logs.get(:browser).map(&:message)
+      # locks time by args in block.
+      # => ["console-api 2:32 946656671111 Sat Jan 01 2000 01:11:11 GMT+0900"]
+    end
+    page.execute_script('console.error(Date.now(), new Date())')
+    pp page.driver.browser.manage.logs.get(:browser).map(&:message)
+    # restore time outside block.
+    # => ["console-api 2:32 1586652460142 Sun Apr 12 2020 09:47:40 GMT+0900"]
+  end
+end
+```
+
+## 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/Madogiwa0124/travel_to_javascript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Madogiwa0124/travel_to_javascript/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TravelToJavascript project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Madogiwa0124/travel_to_javascript/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'travel_to_javascript'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/travel_to_javascript.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'travel_to_javascript/version'
+
+module TravelToJavascript
+  def travel_to_javascript(page, datetime)
+    page.execute_script time_stop_javascript(datetime)
+    yield
+    page.execute_script time_undo_javsctipt
+  end
+
+  private
+
+  def time_stop_javascript(rb_datetime)
+    <<~JS
+      originDate = Date;
+      Date = #{time_stop_js_function_for_date(rb_datetime)};
+      Date.now = #{time_stop_js_function_for_date_now(rb_datetime)};
+    JS
+  end
+
+  def time_undo_javsctipt
+    'Date = originDate;'
+  end
+
+  def time_stop_js_function_for_date(rb_datetime)
+    <<~JS
+      function (datetime) {
+        if (datetime) {
+          return new originDate(datetime);
+        } else {
+          return new originDate("#{rb_datetime.iso8601(6)}");
+        }
+      }
+    JS
+  end
+
+  def time_stop_js_function_for_date_now(rb_datetime)
+    <<~JS
+      function (datetime) {
+        if (datetime) {
+          return new originDate(datetime).getTime();
+        } else {
+          return new originDate("#{rb_datetime.iso8601(6)}").getTime();
+        }
+      }
+    JS
+  end
+end

data/lib/travel_to_javascript/version.rb

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

data/travel_to_javascript.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/travel_to_javascript/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'travel_to_javascript'
+  spec.version       = TravelToJavascript::VERSION
+  spec.authors       = ['Madogiwa']
+  spec.email         = ['madogiwa0124@gmail.com']
+
+  spec.summary       = 'This gem provides a helper `travel_to_javascript` that locks time in javascript.'
+  spec.description   = 'It supports rspec and minitest using capybara.Override Date and Date.now in JavaScript by args.'
+  spec.homepage      = 'https://github.com/Madogiwa0124/travel_to_javascript'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'capybara'
+  spec.add_runtime_dependency 'webdrivers', '~> 4.0'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: travel_to_javascript
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Madogiwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: It supports rspec and minitest using capybara.Override Date and Date.now
+  in JavaScript by args.
+email:
+- madogiwa0124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/travel_to_javascript.rb
+- lib/travel_to_javascript/version.rb
+- travel_to_javascript.gemspec
+homepage: https://github.com/Madogiwa0124/travel_to_javascript
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Madogiwa0124/travel_to_javascript
+  source_code_uri: https://github.com/Madogiwa0124/travel_to_javascript
+  changelog_uri: https://github.com/Madogiwa0124/travel_to_javascript
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This gem provides a helper `travel_to_javascript` that locks time in javascript.
+test_files: []