stimulus_reflex_testing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78135e70cab771486197a65392f65fbc585450aaf8bd58095c2777ced12834ca
+  data.tar.gz: f12fe3d40d1be2f3b90368d3ca2350f41b5b41543550cdccfcb668810975143f
+SHA512:
+  metadata.gz: 1d1d25e8419746630001c914421c2e8428f1ef3752af48ef4d02fa3aa3971acb74ec055f3e0fa0ee3a2826d096495474390cdff3bcd1511c18c204f23a40d02e
+  data.tar.gz: 04e79184baa0b5bc3c0f643b3d314143c77161bb0d42cdb54c67f965542e7535fe25831db30743bb767928c47829e4dc19c53c3243f7b59db0503df3e8510747

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "ruby.lint": {
+    "rubocop": false,
+    "standard": true
+  }
+}

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 jason@thecharnes.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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stimulus_reflex_testing.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    stimulus_reflex_testing (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  stimulus_reflex_testing!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jason Charnes
+
+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,152 @@
+# StimulusReflex Testing
+
+So, you've started using the magic that is StimulusReflex. Neat, us too!
+
+At this time, there aren't official testing helpers in the StimulusReflex library. We wanted to unit-test our reflexes, so we thought we share what we've been working on.
+
+Things we'd like to add/improve on:
+
+- MiniTest support
+- Integration style testing?
+- The ability to run assertions/expectations against the HTML re-rendered by a reflex
+  - `expect(subject.to_html).to include('Hi, I rendered from a Reflex!')`
+- Session is stubbed out (Rspec) right now, but we'd love to find a way to support sessions in testing
+- Things you find useful that we can't think of, yet
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stimulus_reflex_testing'
+```
+
+### Using 5.2 or below? Or using a version of RSpec Rails lower than 4?
+
+Both Rails 6 and RSpec Rails 4 introduce the `action-cable-testing` library. If you're using Rails 5.2 and a version of RSpec Rails lower than 4, include the `action-cable-testing` gem in your Gemfile.
+
+```ruby
+gem 'stimulus_reflex_testing'
+gem 'action-cable-testing'
+```
+
+And then execute:
+
+    $ bundle install
+
+### RSpec instructions
+
+Require the library into your `rails_helper`:
+
+```ruby
+require 'stimulus_reflex_testing/rspec'
+```
+
+Rspec tests include the reflex testing functionality when `type: :reflex` is provided. If this type is not provided, your Reflex tests won't work.
+
+## Usage
+
+### `build_reflex`
+
+To build an instance of your reflex with the required setup handled (channel, url, element, etc) you can use the `build_reflex` method.
+
+```ruby
+# With a valid URL so StimulusReflex can build the correct request
+build_reflex(url: posts_url)
+
+# Does your test rely on a `current_user` (or similar) defined in `ApplicationCable::Connection`?
+build_reflex(url: posts_url, connection: { current_user: create(:user) })
+
+# Do you rely on form params?
+build_reflex(url: edit_post_url(post), params: { post: { title: 'A new title!' } })
+
+# Need to give your element some data?
+reflex = build_reflex(url: posts_url)
+reflex.element.value = "Hello"
+reflex.element.dataset.id = "123"
+```
+
+### `#run`
+
+To unit test a reflex, we provide a method (when using `build_reflex`) called `#run`. This method takes a method name, and any arguments.
+
+```ruby
+reflex = build_reflex(url: posts_url)
+reflex.run(:method, arg1, arg2)
+```
+
+**Why can't I just call the method directly?**
+
+You're more than welcome to call the method directly. But, be advised you will lose callbacks. If you need to run `before_reflex` (etc) use the run method.
+
+_`#run` is a wrapper around the underlying `#process` method in StimulusReflex that runs callbacks._
+
+### `#get`
+
+To grab an instance variable set by a reflex, you can use the `#get` method when using a reflex built with `build_reflex`.
+
+```ruby
+# app/reflexes/post_reflex.rb
+class PostReflex < ApplicationReflex
+  def find_post
+    @post = Post.find(params[:id])
+  end
+end
+
+reflex = build_reflex(url: edit_post_url(post), params: { id: post.id })
+reflex.run(:find_post)
+reflex.get(:post) #=> returns the @post instance variable
+```
+
+## RSpec example
+
+```ruby
+# app/reflexes/post_reflex.rb
+class PostReflex < ApplicationReflex
+  def validate
+    @post = Post.find(element.dataset.post_id)
+    @post.validate
+  end
+end
+
+# spec/reflexes/post_reflex_spec.rb
+RSpec.describe PostReflex, type: :reflex do
+  let(:post) { create(:post) }
+  let(:reflex) { build_reflex(url: edit_post_url(post)) }
+
+  describe '#validate' do
+    subject { reflex.run(:validate) }
+
+    before do
+      reflex.element.dataset.post_id = post.id
+      subject
+    end
+
+    it 'should find the post' do
+      expect(reflex.get(:post)).to eq(post)
+    end
+
+    it 'should validate the post' do
+      expect(reflex.get(:post).errors).to be_present
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/podia/stimulus_reflex_testing. 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/podia/stimulus_reflex_testing/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 StimulusReflexTesting project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/podia/stimulus_reflex_testing/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stimulus_reflex_testing"
+
+# 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/rspec/rails/example/reflex_example_group.rb

@@ -0,0 +1,16 @@
+if defined?(StimulusReflex)
+  module RSpec
+    module Rails
+      module ReflexExampleGroup
+        extend ActiveSupport::Concern
+        include StimulusReflex::TestCase::Behavior
+
+        module ClassMethods
+          def reflex_class
+            described_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers/stimulus_reflex.rb

@@ -0,0 +1,11 @@
+require "rspec/matchers"
+
+RSpec::Matchers.define :have_set do |instance_variable, expected_value|
+  match do |actual|
+    actual.get(instance_variable) == expected_value
+  end
+
+  description do |actual|
+    "set #{instance_variable} to #{expected_value}, got #{actual.get(instance_variable)}"
+  end
+end

data/lib/stimulus_reflex/test_case.rb

@@ -0,0 +1,39 @@
+require "active_support"
+require "active_support/test_case"
+
+class StimulusReflex::TestCase < ActiveSupport::TestCase
+  class TestChannel < ActionCable::Channel::TestCase
+    _channel_class = StimulusReflex::Channel
+
+    def initialize(connection_opts = {})
+      super("StimulusReflex::Channel")
+      @connection = stub_connection(connection_opts.merge(env: {}))
+    end
+  end
+
+  module Behavior
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def reflex_class
+      end
+    end
+
+    def build_reflex(opts = {})
+      channel = opts.fetch(:channel, TestChannel.new(opts.fetch(:connection, {})))
+      element = opts.fetch(:element, StimulusReflex::Element.new)
+
+      self.class.reflex_class.new(
+        channel, element: element, url: opts.dig(:url), params: opts.fetch(:params, {})
+      )
+    end
+  end
+
+  include Behavior
+rescue NameError => e
+  if e.missing_name == "ActionCable::Channel::TestCase"
+    raise "Please install action-cable-testing https://github.com/palkan/action-cable-testing"
+  else
+    raise
+  end
+end

data/lib/stimulus_reflex/test_reflex_patches.rb

@@ -0,0 +1,11 @@
+module StimulusReflex::TestReflexPatches
+  def get(instance_variable)
+    instance_variable_get("@#{instance_variable}")
+  end
+
+  def run(method_name, *args)
+    process(method_name, *args)
+  end
+end
+
+StimulusReflex::Reflex.include(StimulusReflex::TestReflexPatches)

data/lib/stimulus_reflex_testing.rb

@@ -0,0 +1,3 @@
+require "stimulus_reflex_testing/version"
+require "stimulus_reflex/test_case"
+require "stimulus_reflex/test_reflex_patches"

data/lib/stimulus_reflex_testing/rspec.rb

@@ -0,0 +1,15 @@
+require "rspec/rails/example/reflex_example_group"
+require "rspec/rails/matchers/stimulus_reflex"
+
+RSpec.configure do |config|
+  if defined?(StimulusReflex)
+    config.include Rails.application.routes.url_helpers, type: :reflex
+    config.include RSpec::Rails::ReflexExampleGroup, type: :reflex
+
+    config.before type: :reflex do
+      allow_any_instance_of(ActionDispatch::Request).to(
+        receive(:session).and_return(double(:session, load!: true))
+      )
+    end
+  end
+end

data/lib/stimulus_reflex_testing/version.rb

@@ -0,0 +1,3 @@
+module StimulusReflexTesting
+  VERSION = "0.1.0"
+end

data/stimulus_reflex_testing.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/stimulus_reflex_testing/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stimulus_reflex_testing"
+  spec.version = StimulusReflexTesting::VERSION
+  spec.authors = ["Jason Charnes", "Jamie Lawrence", "Basil Khan"]
+  spec.email = ["jason@thecharnes.com", "jamie@ideasasylum.com", "basil@podia.com"]
+
+  spec.summary = "An environment and set of helpers for testing StimulusReflex."
+  spec.homepage = "https://github.com/podia/stimulus_reflex_testing"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+
+  # 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("..", __FILE__)) 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"]
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: stimulus_reflex_testing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Charnes
+- Jamie Lawrence
+- Basil Khan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jason@thecharnes.com
+- jamie@ideasasylum.com
+- basil@podia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".vscode/settings.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/rails/example/reflex_example_group.rb
+- lib/rspec/rails/matchers/stimulus_reflex.rb
+- lib/stimulus_reflex/test_case.rb
+- lib/stimulus_reflex/test_reflex_patches.rb
+- lib/stimulus_reflex_testing.rb
+- lib/stimulus_reflex_testing/rspec.rb
+- lib/stimulus_reflex_testing/version.rb
+- stimulus_reflex_testing.gemspec
+homepage: https://github.com/podia/stimulus_reflex_testing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/podia/stimulus_reflex_testing
+  source_code_uri: https://github.com/podia/stimulus_reflex_testing
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An environment and set of helpers for testing StimulusReflex.
+test_files: []