bbq-rails 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd0caa0a02094191f18c2205ed1dc410a204286c5a7b78a5487ec6452186c0c1
+  data.tar.gz: 59f1db4707fca3399699e1ccfbc78b7b26145307b85035baf98c3ad6ddc82ada
+SHA512:
+  metadata.gz: 5b5078597acca0c8a25a1dc51458353ec7ff03e2f25d7ea298037fa5419055e64257412b30d4db2db70969706dfb03cfb9823d158bd1d83b6b0254bc66b02229
+  data.tar.gz: 11fd3d2c626fe28eca1147988f95d52946743b5daf12950b66676ff94d64487da88315a0037683ad17173e2394defeac150ae618a3272937a0a3efb06d3309a0

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/Gemfile*.lock

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.4
+  - rbx-19mode
+
+gemfile:
+  - Gemfile.rails3_0
+  - Gemfile.rails3_1
+  - Gemfile.rails3_2
+  - Gemfile.rails4_0
+  - Gemfile.rails4_1
+  - Gemfile.rails4_2

data/Gemfile.rails3_0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails',    '~> 3.0.0'
+gem 'minitest', '~> 4.0'

data/Gemfile.rails3_1

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails',    '~> 3.1.0'
+gem 'minitest', '~> 4.0'

data/Gemfile.rails3_2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails', '~> 4.0.0'

data/Gemfile.rails4_0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails', '~> 4.0'

data/Gemfile.rails4_1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails', '~> 4.1.0'

data/Gemfile.rails4_2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'bbq-core', github: 'drugpl/bbq-core'
+gem 'rails', '~> 4.2.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paweł Pacana
+
+MIT License
+
+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,54 @@
+# Bbq::Rails
+
+[![Build Status](https://secure.travis-ci.org/drugpl/bbq-rails.png)](http://travis-ci.org/drugpl/bbq-rails) [![Dependency Status](https://gemnasium.com/drugpl/bbq-rails.png)](https://gemnasium.com/drugpl/bbq-rails) [![Code Climate](https://codeclimate.com/github/drugpl/bbq-rails.png)](https://codeclimate.com/github/drugpl/bbq-rails) [![Gem Version](https://badge.fury.io/rb/bbq-rails.png)](http://badge.fury.io/rb/bbq-rails)
+
+## Quick start
+
+Add following to your Gemfile:
+
+```ruby
+gem 'bbq-rails', require: 'bbq/rails'
+
+```
+
+You may also run `rails generate bbq:install` to have a basic configuration generated.
+
+## Features
+
+### Test integration
+
+Your Rails application hooks up to `Bbq::Core.app` in tests automatically. Thus `Bbq::Core::TestUser` and `Bbq::Core::TestClient` can run against it.
+
+### Generators
+
+Generators help you kickstart Bbq test environment.
+
+At the beginning of your journey with Bbq you can use `rails generate bbq:install`. It'll create directory for acceptance test files and give you basic TestUser class for customization.
+
+There's also `rails generate bbq:test` which creates new test files for you which have Bbq goodies baked in (DSL and test actor session pool handling).
+
+### Rake integration
+
+Provided you've created `spec/acceptance` or `test/acceptance` directory, there we'll be following tasks for running acceptance tests available: `bundle exec rake spec:acceptance` or `bundle exec rake test:acceptance` respectively.
+
+### Routes
+
+When you require 'bbq/rails/routes' you can then `include Bbq::Rails::Routes` in TestActor to have access to Rails url helpers. While convenient it's not recommended in general. Testing routes is part of acceptance test. Use links and buttons in order to get to other pages in your app.
+
+```ruby
+require 'bbq/rails/routes'
+
+class TestUser < Bbq::TestUser
+  include Bbq::Rails::Routes
+end
+```
+
+## Development
+
+We develop and test against multiple Rails versions. When working with legacy software a test toolkit should be the last to require special attention.
+
+```sh
+for gemfile in `ls Gemfile* | grep -v lock`; do
+  BUNDLE_GEMFILE=$gemfile bundle install
+  BUNDLE_GEMFILE=$gemfile bundle exec rake test
+done

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs    = %w(lib test)
+  t.pattern = 'test/*_test.rb'
+end
+
+task default: :test

data/bbq-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bbq/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbq-rails"
+  spec.version       = Bbq::Rails::VERSION
+  spec.authors       = ["DRUG - Dolnośląska Grupa Użytkowników Ruby"]
+  spec.email         = ["all@drug.org.pl"]
+  spec.summary       = %q{Rails integration for Bbq.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bbq-core", ">= 0.0"
+
+  spec.add_development_dependency "bundler",  "~> 1.7"
+  spec.add_development_dependency "rake",     "~> 10.0"
+  spec.add_development_dependency "rails",    ">= 3.0"
+  spec.add_development_dependency "minitest", ">= 4.0"
+end

data/lib/bbq/rails.rb

@@ -0,0 +1,2 @@
+require "bbq/rails/version"
+require "bbq/rails/railtie"

data/lib/bbq/rails/railtie.rb

@@ -0,0 +1,24 @@
+require 'rails/railtie'
+require 'rails/generators'
+require 'bbq/core'
+
+module Bbq
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+      initializer "bqq.set_app" do
+        Bbq::Core.app = ::Rails.application
+      end
+
+      rake_tasks do
+        load File.expand_path(File.join(File.dirname(__FILE__), '../../tasks/bbq.rake'))
+      end
+
+      helper_generators = %w(test_unit rspec).flat_map do |test_framework|
+        ["#{test_framework}:bbq_test", "#{test_framework}:bbq_install"]
+      end
+      ::Rails::Generators.hide_namespaces *helper_generators
+
+    end
+  end
+end

data/lib/bbq/rails/routes.rb

@@ -0,0 +1,14 @@
+module Bbq
+  module Rails
+    module Routes
+      def self.included(klass)
+        klass.send(:include, ::ActionDispatch::Routing::UrlFor)
+        klass.send(:include, ::Rails.application.routes.url_helpers)
+
+        unless ::Rails.version < "3.1"
+          klass.send(:include, ::ActionDispatch::Routing::RouteSet::MountedHelpers)
+        end
+      end
+    end
+  end
+end

data/lib/bbq/rails/version.rb

@@ -0,0 +1,5 @@
+module Bbq
+  module Rails
+    VERSION = "0.3.0"
+  end
+end

data/lib/generators/bbq/install_generator.rb

@@ -0,0 +1,5 @@
+module Bbq
+  class InstallGenerator < ::Rails::Generators::Base
+    hook_for :test_framework, :aliases => "-t", :as => "bbq_install"
+  end
+end

data/lib/generators/bbq/test_generator.rb

@@ -0,0 +1,5 @@
+module Bbq
+  class TestGenerator < ::Rails::Generators::NamedBase
+    hook_for :test_framework, :aliases => "-t", :as => "bbq_test"
+  end
+end

data/lib/generators/rspec/bbq_install_generator.rb

@@ -0,0 +1,18 @@
+module Rspec
+  class BbqInstallGenerator < Rails::Generators::Base
+    source_root File.expand_path(File.join(File.dirname(__FILE__), '../rspec/templates'))
+
+    def create_directory
+      empty_directory "spec/acceptance"
+    end
+
+    def generate_test_user
+      empty_directory "spec/support"
+      template "test_user.rb", "spec/support/test_user.rb"
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+  end
+end

data/lib/generators/rspec/bbq_test_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class BbqTestGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path(File.join(File.dirname(__FILE__), '../rspec/templates'))
+
+    def create_test
+      template "bbq_spec.rb", "spec/acceptance/#{name.underscore}_spec.rb"
+    end
+  end
+end

data/lib/generators/rspec/templates/README

@@ -0,0 +1,5 @@
+
+To finish setup, place in your spec/spec_helper.rb the following:
+
+  require 'bbq/rspec'
+

data/lib/generators/rspec/templates/bbq_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+feature "<%= name.underscore.capitalize.gsub(/_/, ' ') %>" do
+  scenario "the truth" do
+    assert true
+  end
+end

data/lib/generators/rspec/templates/test_user.rb

@@ -0,0 +1,5 @@
+require "bbq/test_user"
+
+class TestUser < Bbq::TestUser
+  # FIXME: explain here how to extend TestUser
+end

data/lib/generators/test_unit/bbq_install_generator.rb

@@ -0,0 +1,18 @@
+module TestUnit
+  class BbqInstallGenerator < Rails::Generators::Base
+    source_root File.expand_path(File.join(File.dirname(__FILE__), '../test_unit/templates'))
+
+    def create_directory
+      empty_directory "test/acceptance"
+    end
+
+    def generate_test_user
+      empty_directory "test/support"
+      template "test_user.rb", "test/support/test_user.rb"
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+  end
+end

data/lib/generators/test_unit/bbq_test_generator.rb

@@ -0,0 +1,9 @@
+module TestUnit
+  class BbqTestGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path(File.join(File.dirname(__FILE__), '../test_unit/templates'))
+
+    def create_test
+      template "bbq_test_case.rb", "test/acceptance/#{name.underscore}_test.rb"
+    end
+  end
+end

data/lib/generators/test_unit/templates/README

@@ -0,0 +1,9 @@
+
+To finish setup, place in your test/test_helper.rb the following:
+
+  require 'bbq/test_unit'
+
+Also make sure that you require there support files:
+
+  # Load support files
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/lib/generators/test_unit/templates/bbq_test_case.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class <%= name.classify %>Test < Bbq::TestCase
+  scenario "the truth" do
+    assert true
+  end
+end

data/lib/generators/test_unit/templates/test_user.rb

@@ -0,0 +1,5 @@
+require "bbq/test_user"
+
+class TestUser < Bbq::TestUser
+  # FIXME: explain here how to extend TestUser
+end

data/lib/tasks/bbq.rake

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+
+Rake::TestTask.new("test:acceptance") do |t|
+  t.libs << 'test'
+  t.pattern = 'test/acceptance/**/*_test.rb'
+  t.verbose = false
+end if File.exists?('test/acceptance')
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new('spec:acceptance') do |spec|
+    spec.pattern = FileList['spec/acceptance/**/*_spec.rb']
+  end if File.exists?('spec/acceptance')
+rescue LoadError
+end

data/test/bbq_install_generator_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+require "rails/generators/test_case"
+require "generators/bbq/install_generator"
+
+class BbqInstallGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path(File.join(File.dirname(__FILE__), '../tmp'))
+  setup :prepare_destination
+
+  tests Bbq::InstallGenerator
+
+  def test_creating_test_unit_test_directories
+    run_generator %w(-t test_unit)
+
+    assert_directory "test/acceptance"
+    assert_directory "test/support"
+  end
+
+  def test_creating_rspec_test_directories
+    run_generator %w(-t rspec)
+
+    assert_directory "spec/acceptance"
+    assert_directory "spec/support"
+  end
+
+  def test_creating_test_unit_test_user_stub
+    run_generator %w(-t test_unit)
+
+    assert_file "test/support/test_user.rb", /class TestUser < Bbq::TestUser/
+  end
+
+  def test_creating_rspec_test_user_stub
+    run_generator %w(-t rspec)
+
+    assert_file "spec/support/test_user.rb", /class TestUser < Bbq::TestUser/
+  end
+end

data/test/bbq_test_generator_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+require "rails/generators/test_case"
+require "generators/bbq/test_generator"
+
+class BbqTestGeneratorTest < ::Rails::Generators::TestCase
+  destination File.expand_path(File.join(File.dirname(__FILE__), '../tmp'))
+  setup :prepare_destination
+
+  tests Bbq::TestGenerator
+
+  def test_creating_test_unit_feature_file
+    run_generator %w(MySuperThing -t test_unit)
+
+    assert_file "test/acceptance/my_super_thing_test.rb", /class MySuperThingTest < Bbq::TestCase/
+    assert_file "test/acceptance/my_super_thing_test.rb", /require "test_helper"/
+  end
+
+  def test_creating_rspec_feature_file
+    run_generator %w(MySuperThing -t rspec)
+
+    assert_file "spec/acceptance/my_super_thing_spec.rb", /feature "My super thing" do/
+    assert_file "spec/acceptance/my_super_thing_spec.rb", /require "spec_helper"/
+  end
+end

data/test/rails_integration_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+require 'bbq/core/test_user'
+
+class RailsIntegration < TestCase
+
+  def test_rails_integration
+    user = Bbq::Core::TestUser.new
+    user.visit('/')
+
+    assert user.has_content?('dummy')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'bbq/rails'
+require 'action_controller/railtie'
+
+TestCase = begin
+  Minitest::Test
+rescue NameError
+  MiniTest::Unit::TestCase
+end
+
+class DummyApplication < ::Rails::Application
+  config.eager_load   = false
+  config.secret_token = SecureRandom.hex(30)
+end
+
+class DummyController < ActionController::Base
+  def index
+    render text: 'dummy'
+  end
+end
+
+DummyApplication.initialize!
+DummyApplication.routes.draw { root to: 'dummy#index' }
+DummyApplication.routes.default_url_options[:host] = 'example.com'

data/test/test_user_routes_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+require 'bbq/core/test_user'
+require 'bbq/rails/routes'
+
+class TestUserRoutesTest < TestCase
+  class TestUserWithRoutes < Bbq::Core::TestUser
+    include ::Bbq::Rails::Routes
+
+    def visit_test_page
+      visit(root_url)
+    end
+  end
+
+  def test_routes_integration
+    user = TestUserWithRoutes.new
+    user.visit_test_page
+
+    assert user.has_content?('dummy')
+  end
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: bbq-rails
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- DRUG - Dolnośląska Grupa Użytkowników Ruby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bbq-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rails
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Rails integration for Bbq.
+email:
+- all@drug.org.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile.rails3_0
+- Gemfile.rails3_1
+- Gemfile.rails3_2
+- Gemfile.rails4_0
+- Gemfile.rails4_1
+- Gemfile.rails4_2
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbq-rails.gemspec
+- lib/bbq/rails.rb
+- lib/bbq/rails/railtie.rb
+- lib/bbq/rails/routes.rb
+- lib/bbq/rails/version.rb
+- lib/generators/bbq/install_generator.rb
+- lib/generators/bbq/test_generator.rb
+- lib/generators/rspec/bbq_install_generator.rb
+- lib/generators/rspec/bbq_test_generator.rb
+- lib/generators/rspec/templates/README
+- lib/generators/rspec/templates/bbq_spec.rb
+- lib/generators/rspec/templates/test_user.rb
+- lib/generators/test_unit/bbq_install_generator.rb
+- lib/generators/test_unit/bbq_test_generator.rb
+- lib/generators/test_unit/templates/README
+- lib/generators/test_unit/templates/bbq_test_case.rb
+- lib/generators/test_unit/templates/test_user.rb
+- lib/tasks/bbq.rake
+- test/bbq_install_generator_test.rb
+- test/bbq_test_generator_test.rb
+- test/rails_integration_test.rb
+- test/test_helper.rb
+- test/test_user_routes_test.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Rails integration for Bbq.
+test_files:
+- test/bbq_install_generator_test.rb
+- test/bbq_test_generator_test.rb
+- test/rails_integration_test.rb
+- test/test_helper.rb
+- test/test_user_routes_test.rb