clockwork-mocks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ed0bbc20a2a75a27c1bfdf71396fb9ef4568dcc
+  data.tar.gz: a1d8eb6db6fb3e5d54eb4de9b9da4a2bc80f61c3
+SHA512:
+  metadata.gz: 8f5f84d7e61fb64a4bf732cc55fbed41ff7b22936688fcd44699c7d13d781503212c7fb95fde24d007ecaf26a20c15849e270c7c77aa9ac734565ff46cbd65f5
+  data.tar.gz: 1cc93a02c58ffbf717f003983d407ff5e70a8de04fd964a8f430f8d91fa52b248c1fdcdcf0baec49e93afd285351c121198c58f5c139229eb04c6adeb39c03ca

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'db/schema.rb'
+    - 'bin/*'
+
+Layout/EmptyLines:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.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 david.poetzsch-heffter@twail.net. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clockwork-mocks.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Poetzsch-Heffter
+
+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,119 @@
+# ClockworkMocks
+
+This gem provides **helpers for integration testing with clockwork**.
+[Clockwork](https://github.com/Rykian/clockwork) provides a cron-like utility for ruby.
+It works especially well in combination with [timecop](https://github.com/travisjeffery/timecop).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clockwork-mocks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clockwork-mocks
+
+## Usage
+
+### Initialization with RSpec
+
+```ruby
+RSpec.describe ... do
+  let!(:clockwork_scheduler) { ClockworkMocks::Scheduler.init_rspec(->(a) { allow a }, ->(a) { receive a }, 'path/to/clock.rb') }
+end
+```
+
+If you do not pass a clock file path to `ClockworkMocks::Scheduler.new` and you are in a rails environment it will assume `"#{Rails.root}/clock.rb"` by default.
+This reloads the `clock.rb` file in every test.
+If you care about that performance leak, there is a more verbose initialization option:
+
+```ruby
+RSpec.describe ... do
+  clockwork_scheduler = nil
+  
+  before do
+    clockwork_scheduler ||= ClockworkMocks::Scheduler.init_rspec(->(a) { allow a }, ->(a) { receive a }, 'path/to/clock.rb')
+    clockwork_scheduler.reset!
+  end
+end
+```
+
+### General Initialization
+
+```ruby
+clockwork_scheduler = ClockworkMocks::Scheduler.new
+
+# ...
+
+clockwork_scheduler.every(1.day, 'some task', at: '23:00') do
+  # something
+end
+```
+
+Using this interface, you can use any stub provider to stub `Clockwork.every` and call `clockwork_scheduler.every` instead, e.g. with rspec-mock:
+
+```ruby
+allow.call(Clockwork).to receive.call(:every) do |interval, name, hash, &block|
+  clockwork_scheduler.every interval, name, hash, &block
+end
+
+load 'path/to/clock.rb'
+```
+
+### Executing clockwork tasks
+
+At any time you can call `clockwork_scheduler.work` to execute all tasks that are due.
+This works especially well in combination with timecop (although the latter is not a requirement):
+
+```ruby
+Timecop.freeze(2.days.from_now) do
+  clockwork_scheduler.work
+end
+```
+
+Tasks will be executed in correct order.
+If enough time passed, tasks will be executed multiple times:
+
+```ruby
+clockwork_scheduler.every(1.second, 'often') { puts 'often' }
+clockwork_scheduler.every(2.seconds, 'not-so-often') { puts 'not so often' }
+
+Timecop.freeze(3.seconds.from_now) do
+  clockwork_scheduler.work
+end
+```
+
+outputs
+
+```
+often
+often
+not-so-often
+often
+```
+
+## 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/dpoetzsch/clockwork-mocks.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ClockworkMocks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dpoetzsch/clockwork-mocks/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clockwork/mocks"
+
+# 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/clockwork-mocks.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clockwork_mocks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clockwork-mocks'
+  spec.version       = ClockworkMocks::VERSION
+  spec.authors       = ['David Poetzsch-Heffter']
+  spec.email         = ['davidpoetzsch@web.de']
+
+  spec.summary       = 'Helpers for manual scheduling of clockwork tasks for integration testing'
+  spec.description   = 'clockwork provides a cron-like utility for ruby. ' \
+    'This gem adds the possibility to create integration tests for these tasks'
+  spec.homepage      = 'https://github.com/dpoetzsch/clockwork-mocks'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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_dependency 'clockwork', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop'
+end

data/lib/clockwork_mocks/clockwork_task.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ClockworkMocks
+  class ClockworkTask
+    def initialize(interval, name, hash, block)
+      @interval = interval
+      @name = name
+      @hash = hash || {}
+      @block = block
+
+      @due = calc_due
+    end
+
+    def reset!
+      @due = Time.now
+      @due = calc_due
+    end
+
+    def perform
+      @block.call
+      @due = calc_due
+    end
+
+    attr_reader :due
+
+    private
+
+    def calc_due
+      ndue = Time.at((due || Time.now).to_f + @interval)
+
+      return ndue unless @hash[:at]
+
+      at_split = @hash[:at].split(':').map(&:to_i)
+      new_due = ndue.change(hour: at_split[0], minute: at_split[1])
+
+      new_due < ndue ? new_due : (new_due - 1.day)
+    end
+  end
+end

data/lib/clockwork_mocks/scheduler.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ClockworkMocks
+  class Scheduler
+    attr_reader :tasks
+
+    def initialize()
+      @tasks = []
+    end
+
+    def self.init_rspec(allow, receive, clock_file = nil)
+      scheduler = Scheduler.new
+
+      allow.call(Clockwork).to receive.call(:every) do |interval, name, hash, &block|
+        scheduler.every interval, name, hash, &block
+      end
+
+      if block_given?
+        yield
+      else
+        unless clock_file
+          rails = Object.const_get('Rails')
+          clock_file = "#{rails.root}/clock.rb" if rails
+        end
+
+        load clock_file if clock_file
+      end
+
+      scheduler
+    end
+
+    def work
+      loop do
+        t = @tasks.min_by(&:due)
+
+        break if t.nil? || t.due > Time.now
+
+        t.perform
+      end
+    end
+
+    def reset!
+      @tasks.each(&:reset!)
+    end
+
+    def every(interval, name, hash = {}, &block)
+      @tasks.push ClockworkTask.new(interval, name, hash, block)
+    end
+  end
+end

data/lib/clockwork_mocks/version.rb

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

data/lib/clockwork_mocks.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'clockwork'
+
+require 'clockwork_mocks/version'
+require 'clockwork_mocks/clockwork_task'
+require 'clockwork_mocks/scheduler'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: clockwork-mocks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Poetzsch-Heffter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clockwork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+description: clockwork provides a cron-like utility for ruby. This gem adds the possibility
+  to create integration tests for these tasks
+email:
+- davidpoetzsch@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clockwork-mocks.gemspec
+- lib/clockwork_mocks.rb
+- lib/clockwork_mocks/clockwork_task.rb
+- lib/clockwork_mocks/scheduler.rb
+- lib/clockwork_mocks/version.rb
+homepage: https://github.com/dpoetzsch/clockwork-mocks
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Helpers for manual scheduling of clockwork tasks for integration testing
+test_files: []