quickdraw 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51f90e243e29a4b80d81e1d21012cae4fa8e02dc
-  data.tar.gz: 970effdf3f87cfe12b67618bac1b9d5dd02fcc03
+SHA256:
+  metadata.gz: 5d4d16d42b91edb328fb30254cd55b985f8b6fb946eca6d95c12b6bb06edeea3
+  data.tar.gz: c3f4efb7868749f81a4b33c733297344a229871ece2e4cb9b420cb66a1c6cc5e
 SHA512:
-  metadata.gz: 9fc8e5530408ad1cc5d7bde5933b64309d26afb6b9c8097574f33a206d7a3a6a10db8da3dbe6f5acff293095e0b6bfcecd533c9be6eab4f4a4b29181ffb1d6bd
-  data.tar.gz: 410c09bb7122a33a7ee99be3146bafac7b561143a03b0b26d2663e6172a3b2d7107231e33f2415439caaa31fe0709dd27c534ba1098e3996e9d7fbde031581bf
+  metadata.gz: a7df8e690a53fe6a6ce32b718e89f897ecacb6b9506ff723589042e3535a51f6d8075f0341f57b641bb88bf8a1b9b5f45622cc61870b5f142643d504bdf3259f
+  data.tar.gz: 05a13bace7aed487bbf8ff0b3d32a1303b86c142867e1c675ea80dad8d6f05846feafeeb44f6318092e0e9a860f2a597ee523a54f5a4f47d29c6a5b8d2b6257b

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from:
+  - "https://www.goodcop.style/rubocop.yml"
+  - "https://www.goodcop.style/tabs.yml"
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Lint/RescueException:
+  Enabled: false
+
+Lint/Void:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/YodaCondition:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1
+3.3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel@drapper.me. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in quickdraw.gemspec
 gemspec
+
+gem "rubocop"
+gem "simplecov"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    quickdraw (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.4.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
+
+DEPENDENCIES
+  quickdraw!
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 Bryan Morris
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2023 Joel Drapper
 
-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:
+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 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.
+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

@@ -1,50 +1,121 @@
 # Quickdraw
 
-The idea for Quickdraw comes from the 'shopify_theme' gem. I use a lot of code from them.
+Quickdraw is currently in development. You should almost definitely not use it in a project until `1.0` is released.
 
-### Features
+> [!TIP]
+> Your test files are executed in an anonymous class, so you can define methods and constants at the top level without worrying about collisions. If you’re testing something that references `Class.name`, you may have to define those classes as fixtures somewhere else.
 
-- Compatible with Ruby 2.0 and 2.1
-- MUCH faster downloads and uploads. Unfortunately, Shopify API call limits will slow you down. But in short bursts (10-20 files), Quickdraw is as much as 10x faster or more!
-- Quickdraw supports using ERB templates which are compiled then uploaded to shopify. This can save you time when making templates with redundant code.
-
-## Installation
+## Getting Started
 
 Add this line to your application's Gemfile:
 
-    gem 'quickdraw'
+```ruby
+gem 'quickdraw'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+bundle install
+```
+
+Now create a file called `config/quickdraw.rb`.
 
-Or install it yourself as:
+To run tests, execute:
+```bash
+bundle exec qt
+```
 
-    $ gem install quickdraw
+It stands for "quickdraw tests".
 
 ## Usage
 
-1. Create a project folder and open a terminal
-2. run ````quickdraw configure````
-3. run ````quickdraw download````
-4. run ````quickdraw watch````
+Quickdraw searches for files that end with `.test.rb`. You can put these anywhere. Some people like to put them under `/tests` or `/spec`. Others like to put them next to the code they're testing.
+
+### `.test`
+Use the `test` method to define a test. The description is optional — sometimes you don’t need it.
+
+```ruby
+test { assert true }
+```
+
+You can pass `skip: true` to skip the test. Skipped tests are still run; they pass if they fail and fail they pass.
+
+```ruby
+test(skip: true) { assert false }
+```
+
+### `.describe`
+You can optionally wrap tests in any number of `describe` blocks, which can take a description as a string or module/class.
+
+```ruby
+describe Thing do
+  # your Thing tests here
+end
+```
+
+### `#assert`
+`assert` takes a value and passes if it’s truthy.
+
+```ruby
+test "something" do
+  assert true
+end
+```
+
+You can pass a custom failure message as a block. Using blocks for the failure messages means we don’t waste time constructing them unless the test fails. You don’t need to worry about expensive failure messages slowing down your tests.
+
+```ruby
+test "something" do
+	assert(false) { "This is a custom failure message" }
+end
+```
+
+### `#refute`
+`refute` is just like `assert`, but it passes if the value is falsy.
+
+```ruby
+test "something" do
+  refute false
+end
+```
+
+### `expect` matchers
+`expect` takes either a value or a block and returns an expectation object, which you can call matchers on.
+
+#### `==` and `!=`
+
+```ruby
+test "equality" do
+  expect(Thing.foo) == "foo"
+  expect(Thing.bar) != "foo"
+end
+```
 
-### Workflow
+#### `to_raise`
 
-Quickdraw creates two folders in your project, ````theme```` and ````src````.
-When ````quickdraw watch```` is running, files added/changed/deleted in the ````theme```` folder will be mirrored to Shopify automatically.
-To use ERB create a copy of the ````.liquid```` file you want to use, add an ````.erb```` extension to the end, and move it to the ````src```` folder.
+```ruby
+test "raises" do
+  expect { Thing.bar! }.to_raise(ArgumentError) do |error|
+    expect(error.message) == "Foo bar"
+  end
+end
+```
 
-#####Example
-    project/theme/templates/index.liquid
-    project/src/templates/index.liquid.erb
+#### `to_receive`
 
-When the ````project/src/templates/index.liquid.erb```` is modified, Quickdraw will render it, overwriting ````project/theme/templates/index.liquid````, and uploading the result to Shopify.
+```ruby
+test "mocks and spies" do
+  expect(Thing).to_receive(:foo) do |a, b, c|
+    # The block receives arguments and can make assertions about them.
+    expect(a) == 1
+    expect(b) != 1
+    assert(c)
 
-## Contributing
+    # Either return a mock response or call the original via `@super`
+    @super.call
+  end
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+  Thing.foo(1, 2, 3)
+end
+```

data/config/quickdraw.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../test/support/matchers/pass_fail"
+
+module BazMatcher
+	def baz?
+		success!
+	end
+end
+
+Quickdraw.configure do |config|
+	config.matcher Matchers::PassFail, Proc
+	config.matcher BazMatcher, String
+end
+
+# SimpleCov.start

data/exe/qt

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "etc"
+require_relative "../lib/quickdraw"
+require File.expand_path("config/quickdraw")
+
+Quickdraw::Run.new(
+	number_of_processes: Etc.nprocessors,
+	number_of_threads: 2,
+	test_files: Dir.glob("./**/*.test.rb")
+).call

data/lib/quickdraw/cluster.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "etc"
+
+class Quickdraw::Cluster
+	def self.call(n = Etc.nprocessors, &)
+		spawn(n, &).wait
+	end
+
+	def self.spawn(n = Etc.nprocessors, &block)
+	  new.tap do |cluster|
+			n.times { cluster.fork(&block) }
+		end
+	end
+
+	def initialize
+		@workers = []
+	end
+
+	def fork(&)
+		@workers << Quickdraw::Worker.fork(&)
+	end
+
+	def wait
+		@workers.map(&:wait)
+	end
+end

data/lib/quickdraw/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Quickdraw::Configuration
+	def initialize
+		@registry = Quickdraw::Registry.new
+	end
+
+	attr_reader :registry
+
+	def matcher(matcher, *types)
+		@registry.register(matcher, *types)
+	end
+end

data/lib/quickdraw/context.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+class Quickdraw::Context
+	DEFAULT_MATCHERS = [
+		Quickdraw::Matchers::Boolean,
+		Quickdraw::Matchers::CaseEquality,
+		Quickdraw::Matchers::Change,
+		Quickdraw::Matchers::Equality,
+		Quickdraw::Matchers::Include,
+		Quickdraw::Matchers::Predicate,
+		Quickdraw::Matchers::RespondTo,
+		Quickdraw::Matchers::ToBeA,
+		Quickdraw::Matchers::ToHaveAttributes,
+		Quickdraw::Matchers::ToRaise,
+		Quickdraw::Matchers::ToReceive,
+	].freeze
+
+	class << self
+		def run(result = Quickdraw::Runner.new, path = [])
+			new(result, path).run(@tests) if @tests
+
+			if defined?(@sub_contexts)
+				@sub_contexts.each do |(context, desc)|
+					context.run(result, [*path, desc])
+				end
+			end
+		end
+
+		def use(*new_matchers)
+			new_matchers.each { |m| matchers << m }
+		end
+
+		def matchers
+			@matchers ||= if superclass < Quickdraw::Context
+				superclass.matchers.dup
+			else
+				Set.new(DEFAULT_MATCHERS)
+			end
+		end
+
+		def describe(description, &block)
+			unless defined?(@sub_contexts)
+				@sub_contexts = []
+			end
+
+			@sub_contexts << [Class.new(self, &block), description]
+		end
+
+		alias_method :context, :describe
+
+		def test(name = nil, skip: false, &block)
+			unless defined?(@tests)
+				@tests = []
+			end
+
+			@tests << [name, skip, block]
+		end
+	end
+
+	def initialize(run, path)
+		@run = run
+		@path = path
+		@expectations = []
+		@matchers = self.class.matchers
+
+		@name = nil
+		@skip = false
+	end
+
+	def run(tests)
+		tests.each do |(name, skip, block)|
+			@name = name
+			@skip = skip
+
+			instance_exec(&block)
+
+			resolve
+		end
+	end
+
+	def expect(value = Quickdraw::Null, &block)
+		type = Quickdraw::Null == value ? block : value
+
+		expectation_class = Quickdraw::Config.registry.expectation_for(
+			type, matchers: @matchers
+		)
+
+		expectation = expectation_class.new(self, value, &block)
+		@expectations << expectation
+		expectation
+	end
+
+	def resolve
+		@expectations.each(&:resolve)
+	ensure
+		@expectations.clear
+	end
+
+	def assert(value)
+		if value
+			success!
+		elsif block_given?
+			failure! { yield(value) }
+		else
+			failure! { "expected #{value.inspect} to be truthy" }
+		end
+	end
+
+	def refute(value)
+		if !value
+			success!
+		elsif block_given?
+			failure! { yield(value) }
+		else
+			failure! { "expected #{value.inspect} to be falsy" }
+		end
+	end
+
+	def success!
+		if @skip
+			@run.failure!(full_path) { "The skipped test `#{@name}` started passing." }
+		else
+			@run.success!(@name)
+		end
+	end
+
+	def failure!(&)
+		if @skip
+			@run.success!(@name)
+		else
+			@run.failure!(full_path, &)
+		end
+	end
+
+	def full_path
+		[*@path, @name]
+	end
+end

data/lib/quickdraw/expectation.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class Quickdraw::Expectation
+	def initialize(context, value = Quickdraw::Null, &block)
+		if block && Quickdraw::Null != value
+			raise Quickdraw::ArgumentError.new(
+				"You must only provide a value or a block to `expect`."
+			)
+		end
+
+		@context = context
+		@value = value
+		@block = block
+		@made_expectations = false
+	end
+
+	def success!
+		@context.success!
+		@made_expectations = true
+	end
+
+	def failure!(&)
+		@context.failure!(&)
+		@made_expectations = true
+	end
+
+	def resolve
+		if !@made_expectations
+			failure! { "You didn't make any expectations." }
+		end
+	end
+
+	private
+
+	def assert(value, &)
+		value ? success! : failure!(&)
+	end
+
+	def refute(value, &)
+		value ? failure!(&) : success!
+	end
+
+	def value
+		if @block
+			raise Quickdraw::ArgumentError.new(
+				"You must pass a value rather than a block when using the #{caller_locations.first.label} matcher."
+			)
+		else
+			@value
+		end
+	end
+
+	def block
+		if @block
+			@block
+		else
+			raise Quickdraw::ArgumentError.new(
+				"You must pass a block rather than a value when using the #{caller_locations.first.label} matcher."
+			)
+		end
+	end
+end

data/lib/quickdraw/map.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Quickdraw::Map
+	include Enumerable
+
+	def initialize
+		@hash = {}
+		@mutex = Mutex.new
+	end
+
+	def [](value)
+		@hash[value]
+	end
+
+	def []=(key, value)
+		@mutex.synchronize do
+			@hash[key] = value
+		end
+	end
+
+	def each(&)
+		@hash.each(&)
+	end
+
+	def clear
+		@mutex.synchronize do
+			@hash.clear
+		end
+	end
+end