test_selector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fc605136ce5d55d5833d229f09affee57ddbd3fd743c2f0160aadc3c60197da
+  data.tar.gz: 7149ad57815f1bbf594441a94d627e370d60fb52a09faca9e6d4efe002e193a5
+SHA512:
+  metadata.gz: 48d26f850c21c63ac9f44f84ec32fd6a7ea4e0cb728b32e59c6a507a20553a53f526d8ea459be4729f70c1a3c98149f9599240bdc20a3fdbd9a2edccd806ccf8
+  data.tar.gz: 3e0c2c5fb284e5115422aff736eefca6b14287dd4d386b24de3cd00c1a71ec2e3e906b4c8e01d6baeb8abb935f6d4b176fd3c9f6201f2e623b3612237821faf5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 FatboyPunk
+
+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,65 @@
+# TestSelector
+Based on [TestSelector](https://github.com/DefactoSoftware/test_selector) for
+Elixir, a gem that adds a `test-selector` to the HTML so it can be found in the
+tests.
+
+## Usage
+After installing this gem the views have a helper method `test_selector` that
+can be used as:
+
+```erb
+<!--- app/views/some/view.erb --->
+<p <%= test_selector "description", 1 %>the description of entity 1</p>
+
+<p <%= test_selector "description", 2 %>the description of entity 2</p>
+```
+
+That will result in:
+
+```HTML
+<p test-selector="_app_views_some_view_erb__description" test-value="1">the description of entity 1</p>
+
+<p test-selector="_app_views_some_view_erb__description" test-value="2">the description of entity 2</p>
+```
+
+In the test this can be found with:
+
+```rb
+it "assert the second description" do
+  ... # some setup
+
+  test_part = test_selector(path, "description", 1)
+  expect(find_test_selector page.body, test_part).to have_content "the description of entity 2"
+end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+- dependencie: rails
+
+Add to `:development` and `:test` in the `Gemfile`
+```ruby
+gem 'test_selector'
+```
+
+Execute:
+```bash
+$ bundle
+```
+
+`include` in the test framework you're using, for RSpec:
+```erb
+require 'test_selector'
+
+RSpec.configure do |config|
+  ...
+
+  config.include TestSelector::TestHelpers
+end
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TestSelector'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/test_selector.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'action_view'
+require 'test_selector/railtie'
+require 'test_selector/test_helper'
+require 'test_selector/html_helper'
+
+module TestSelector
+end
+

data/lib/test_selector/html_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TestSelector
+  module HTMLHelper
+    def test_selector(name = nil, value = nil)
+      return if disable?
+
+      called_by = caller
+      setup_test_selector(called_by, name, value)
+    end
+
+    private
+
+    def setup_test_selector(called_by, name = nil, value = nil)
+      return if disable?
+
+      if name && value
+        "test-selector=#{get_selector(called_by)}__#{name} test-value=#{value}"
+      elsif name
+        "test-selector=#{get_selector(called_by)}__#{name}"
+      else
+        "test-selector=#{get_selector(called_by)}"
+      end
+    end
+
+    def get_selector(called_by)
+      return if disable?
+
+      first_line = called_by.split('/n').first.first
+      file_hash = first_line.split('`').second
+      file_under_path = "#{file_hash.split('_erb__').first}_erb"
+    end
+
+    def disable?
+      Rails.env == 'production'
+    end
+  end
+end
+
+ActionView::Base.send :include, TestSelector::HTMLHelper

data/lib/test_selector/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TestSelector
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/test_selector/test_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module TestSelector
+  module TestHelper
+    def test_selector(path, name = nil, value = nil)
+      underscore_path = path.gsub(%r{/|\.}, '_')
+
+      if name && value
+        "test-selector=_#{underscore_path}__#{name} test-value=#{value}"
+      elsif name
+        "test-selector=_#{underscore_path}__#{name}"
+      else
+        "test-selector=_#{underscore_path}"
+      end
+    end
+
+    def find_test_selector(html, selector)
+      test_selector = selector.split(' ').first
+      test_value = selector.split(' ').second
+      doc = Nokogiri::HTML(html).css("[#{test_selector}]")
+      if test_value
+        doc.css("[#{test_value}]").to_s
+      else
+        doc.to_s
+      end
+    end
+  end
+end

data/lib/test_selector/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: test_selector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcel Horlings
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+description: test_selector can be used to find specific elements in your tests without
+  adding css variables or other html elements to your production environment
+email:
+- marcel@devrain.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/test_selector.rb
+- lib/test_selector/html_helper.rb
+- lib/test_selector/railtie.rb
+- lib/test_selector/test_helper.rb
+- lib/test_selector/version.rb
+homepage: https://github.com/fatboypunk/test_selector
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Add test_selectors to rails views and use them in tests
+test_files: []