partial_testcase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b326a452a8bcbe4197962d15f048bbae6709705
+  data.tar.gz: 55ac96987f288f880fa8336c7d4f2b927a8c4c56
+SHA512:
+  metadata.gz: a4171512b7f46beb7d6f08a175bf83f089aec748439d74bf96eb2c067e722914444758bc57d0a01ccace187120e88f277c9c42883632c983c54cf7e3d7e6b896
+  data.tar.gz: b6ef53eb3d301a474c9b08ecb684ab0e631004fbf69a196e8af55b4ec59866691abe6397de37ba208bf7db91d446b40fb1b5e4f98ff6e9979c3f25fca9769669

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Julien Meichelbeck
+
+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,122 @@
+# PartialTestcase
+PartialTestcase is a gem providing unit tests for your partials.
+
+![](https://api.travis-ci.org/julien-meichelbeck/partial_testcase.svg?branch=master)
+
+## Why?
+* Integration tests are slow.
+* Controller tests are deprecated in favor of integration tests.
+* If well written, a partial can be seen as just a simple method returning HTML. That sounds like something that can be easily tested.
+* Partials can become messy, even bloated. With simple units test, it is possible to test all the variants of your view layer. How many times did you break something because your forgot to test a branch of your template?
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partial_testcase'
+```
+
+You're ready to go!
+
+## Simple example
+Let's test the following partial:
+
+```erb
+<div>
+  <span class="username"><%= user.name %></span>
+</div>
+```
+
+```ruby
+class SampleTest < PartialTestcase::Base
+  setup do
+    @user = User.new('Clark')
+  end
+
+  test 'just an example' do
+    html = render_partial('sample/user', user: @user)
+
+    # Use the same selectors as in your Controller tests
+    assert_select 'span.username', text: 'Clark'
+
+    # Or directly test the html
+    expected_html = <<~HTML
+      <div>
+        <span class="username">Clark</span>
+      </div>
+    HTML
+    assert_equal expected_html, html
+  end
+end
+
+```
+
+## Documentation
+### How to specify the partial path?
+You can just specify the partial at each render:
+```ruby
+render_partial('sample/users', foo: 'bar')
+```
+
+Otherwise, if you test the same partial every time, use the `partial_path` method:
+```ruby
+class SampleTest < PartialTestcase::Base
+  partial_path 'sample/users'
+
+  test 'sample test' do
+    render_partial(foo: 'bar')
+  end
+end
+```
+
+### How to declare instance variables?
+Use `assign` before rendering the partial.
+```ruby
+  assign(user: @user) # This will make @user available in the partial
+  render_partial
+```
+
+### How to include helpers and module?
+Use `with_module`:
+```ruby
+class SampleTest < PartialTestcase::Base
+  with_module UsersHelper
+end
+```
+
+### How to stub methods?
+If you want to add specific methods for one test:
+
+```ruby
+test 'sample test' do
+  render_partial('sample/user') do
+    def format_address
+      # ...
+    end
+  end
+end
+```
+
+If you need the same methods for every test, use the `with_helpers` method:
+```ruby
+class SampleTest < PartialTestcase::Base
+  with_helpers do
+    def country
+      :us
+    en
+
+    def format_address(address, city)
+      # ...
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julien-meichelbeck/partial_testcase.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+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    = 'PartialTestcase'
+  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/partial_testcase/base.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+module PartialTestcase
+  class Base < ::ActionView::TestCase
+    include Rails::Dom::Testing::Assertions
+
+    attr_reader :html_body
+    class_attribute :partial, :helpers_context, :modules
+    self.modules = []
+
+    def setup
+      super
+      setup_view
+    end
+
+    def self.partial_path(partial)
+      self.partial = partial
+    end
+
+    def self.with_helpers(&block)
+      self.helpers_context = block
+    end
+
+    def self.with_module(mod)
+      modules << mod
+    end
+
+    def assign(**assigns)
+      @_assigns.merge!(assigns)
+    end
+
+    protected
+
+    def setup_view
+      @html_body = nil
+      @_assigns = {}
+
+      @_action_view_class =
+        Class.new(::ActionView::Base) do
+          def view_cache_dependencies; end
+
+          def combined_fragment_cache_key(key)
+            [:views, key]
+          end
+        end
+    end
+
+    def document_root_element
+      Nokogiri::XML(@html_body.to_s)
+    end
+
+    def render_partial(*args, &block)
+      @view = @_action_view_class.new(ApplicationController.view_paths, @_assigns)
+
+      add_to_context(self.class.helpers_context)
+      add_to_context(block)
+      self.class.modules.each do |mod|
+        @_action_view_class.include(mod)
+      end
+
+      options = args.extract_options!
+      partial_path = args[0] || self.class.partial
+
+      if partial_path.nil?
+        raise "You must specify the path of the partial you are testing. Call the class method 'partial_path'"
+      end
+
+      @html_body = @view.render(partial: partial_path, locals: options)
+    end
+
+    def add_to_context(block)
+      return if block.nil?
+      mod = Module.new
+      mod.class_eval(&block)
+      @_action_view_class.include(mod)
+    end
+  end
+end

data/lib/partial_testcase/version.rb

@@ -0,0 +1,3 @@
+module PartialTestcase
+  VERSION = '0.1.0'
+end

data/lib/partial_testcase.rb

@@ -0,0 +1,5 @@
+require 'partial_testcase/base'
+
+module PartialTestcase
+  # Your code goes here...
+end

data/lib/tasks/partial_testcase_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :partial_testcase do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: partial_testcase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Meichelbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  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: PartialTestcase is a gem providing unit tests for your partials.
+email:
+- julien.meichelbeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/partial_testcase.rb
+- lib/partial_testcase/base.rb
+- lib/partial_testcase/version.rb
+- lib/tasks/partial_testcase_tasks.rake
+homepage: https://github.com/julien-meichelbeck/partial_testcase
+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.1
+signing_key: 
+specification_version: 4
+summary: Unit test your view layer
+test_files: []