decidim 0.0.1.alpha9 → 0.0.1

data/decidim-dev/decidim-dev.gemspec

@@ -6,26 +6,30 @@ require_relative "../decidim-core/lib/decidim/core/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
+  Decidim.add_default_gemspec_properties(s)
+
   s.name        = "decidim-dev"
-  s.version     = Decidim.version
-  s.authors     = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
-  s.email       = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]
-  s.homepage    = ""
   s.summary     = "Decidim Dev tools"
   s.description = "Utilities and tools we need to develop Decidim"
-  s.license     = "AGPLv3"
 
   s.files = Dir["{app,config,db,lib,vendor}/**/*", "LICENSE.txt", "Rakefile", "README.md"]
 
   s.add_dependency "factory_girl_rails"
   s.add_dependency "database_cleaner", "~> 1.5.0"
-  s.add_dependency "capybara", "~> 2.10.0"
+  s.add_dependency "capybara", "~> 2.11.0"
+  s.add_dependency "capybara-screenshot", "~> 1.0.14"
   s.add_dependency "rspec-rails", "~> 3.5"
+  s.add_dependency "rspec-repeat", "~> 1.0.2"
   s.add_dependency "byebug"
   s.add_dependency "wisper-rspec"
   s.add_dependency "listen", "~> 3.1.0"
   s.add_dependency "launchy"
   s.add_dependency "i18n-tasks", "~> 0.9.6"
-  s.add_dependency "bullet", "~> 5"
+  s.add_dependency "bullet", "~> 5.4.3"
   s.add_dependency "faker", "~> 1.6.6"
+  s.add_dependency "poltergeist", "~> 1.12.0"
+  s.add_dependency "rails-controller-testing", "~> 1.0.1"
+  s.add_dependency "simplecov", "~> 0.12"
+  s.add_dependency "codecov", "~> 0.1.9"
+  s.add_dependency "rubocop", "~> 0.46"
 end

data/decidim-dev/lib/decidim/common_rake.rb

@@ -1,14 +1,28 @@
 # frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 require_relative "../generators/decidim/dummy_generator"
 
+engine_path = Dir.pwd
+engine_name = engine_path.split("/").last
+dummy_app_path = File.expand_path(File.join(engine_path, "spec", "#{engine_name}_dummy_app"))
+
 desc "Generates a dummy app for testing"
-namespace :common do
-  task :test_app do |_t, _args|
-    Decidim::Generators::DummyGenerator.start [
-      "--engine_path=#{ENV["ENGINE_PATH"]}",
+task :generate_test_app do
+  Decidim::Generators::DummyGenerator.start(
+    [
+      "--engine_path=#{engine_path}",
       "--migrate=true",
       "--quiet"
     ]
-    FileUtils.cd(ENV["ENGINE_PATH"])
-  end
+  )
+
+  require File.join(dummy_app_path, "config", "application")
+  Rails.application.load_tasks
+  Rake.application["assets:precompile"].invoke
+
+  FileUtils.cd(engine_path)
 end
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:generate_test_app, :spec]

data/decidim-dev/lib/decidim/dummy_authorization_handler.rb

@@ -1,18 +1,25 @@
 # frozen_string_literal: true
 module Decidim
-  # A n example implementation of an AuthorizationHandler to be used in tests.
+  # An example implementation of an AuthorizationHandler to be used in tests.
   class DummyAuthorizationHandler < AuthorizationHandler
     attribute :document_number, String
     attribute :birthday, Date
 
     validates :document_number, presence: true
+    validate :valid_document_number
 
     def authorized?
-      valid? && document_number.end_with?("X")
+      valid?
     end
 
     def metadata
       super.merge(document_number: document_number)
     end
+
+    private
+
+    def valid_document_number
+      errors.add(:document_number, :invalid) unless document_number.to_s.end_with?("X")
+    end
   end
 end

data/decidim-dev/lib/decidim/test/base_spec_helper.rb

@@ -1,23 +1,42 @@
 # frozen_string_literal: true
 ENV["RAILS_ENV"] ||= "test"
 
+engine_name = ENV["ENGINE_NAME"]
+dummy_app_path = File.expand_path(File.join(Dir.pwd, "spec", "#{engine_name}_dummy_app"))
+
 if ENV["CI"]
   require "simplecov"
-  SimpleCov.start
+  SimpleCov.start do
+    filters.clear
+    add_filter "/test/"
+    add_filter "/spec/"
+    add_filter "bundle.js"
+    add_filter "/vendor/"
+
+    add_filter do |src|
+      !(src.filename =~ /^#{ENV["TRAVIS_BUILD_DIR"]}/)
+    end
+  end
 
   require "codecov"
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
+require "rails"
+require "active_support/core_ext/string"
+require "decidim/core"
+
+require "#{File.dirname(__FILE__)}/rspec_support/feature.rb"
+
 begin
-  dummy_app_path = "#{ENV["ENGINE_NAME"]}_dummy_app/config/environment"
-  require dummy_app_path
+  require "#{dummy_app_path}/config/environment"
 rescue LoadError
-  puts "Could not load dummy application. Please ensure you have run `bundle exec rake test_app`"
+  puts "Could not load dummy application. Please ensure you have run `bundle exec rake generate_test_app`"
   puts "Tried to load it from #{dummy_app_path}"
-  exit
+  exit(-1)
 end
 
+require "rails-controller-testing"
 require "rspec/rails"
 require "factory_girl_rails"
 require "database_cleaner"
@@ -28,7 +47,7 @@ require "rectify/rspec"
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/rspec_support/**/*.rb"].each { |f| require f }
-Dir[File.join(File.dirname(__FILE__), "..", "..", "..", "..", ENV["ENGINE_NAME"], "spec", "support", "**", "*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), "..", "..", "..", "..", engine_name, "spec", "support", "**", "*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
   config.color = true

data/decidim-dev/lib/decidim/test/i18n_spec.rb

@@ -2,7 +2,7 @@
 require "i18n/tasks"
 
 RSpec.describe "I18n" do
-  let(:i18n) { I18n::Tasks::BaseTask.new }
+  let(:i18n) { I18n::Tasks::BaseTask.new(locales: ["en"]) }
   let(:missing_keys) { i18n.missing_keys }
   let(:unused_keys) { i18n.unused_keys }
 

data/decidim-dev/lib/decidim/test/rspec_support/capybara.rb

@@ -1,19 +1,80 @@
 # frozen_string_literal: true
-def switch_to_host(host = "lvh.me")
-  app_host = (host ? "http://#{host}" : nil)
-  Capybara.app_host = app_host
+
+require "capybara/poltergeist"
+require "capybara-screenshot/rspec"
+
+module Decidim
+  # Helpers meant to be used only during capybara test runs.
+  module CapybaraTestHelpers
+    def switch_to_host(host = "lvh.me")
+      unless /lvh\.me$/ =~ host
+        raise "Can't switch to a custom host unless it really exists. Use `whatever.lvh.me` as a workaround."
+      end
+
+      app_host = (host ? "http://#{host}" : nil)
+      Capybara.app_host = app_host
+    end
+
+    def switch_to_default_host
+      Capybara.app_host = nil
+    end
+  end
 end
 
-def switch_to_default_host
-  switch_to_host nil
+node_modules_path = File.join(
+  File.dirname(__FILE__), "..", "..", "..", "..", "..", "node_modules"
+)
+
+capybara_options = {
+  phantomjs: File.expand_path(
+    File.join(node_modules_path, ".bin", "phantomjs")
+  ),
+  extensions: [
+    File.expand_path(
+      File.join(node_modules_path, "promise-polyfill", "promise.js")
+    ),
+    File.expand_path(
+      File.join(node_modules_path, "phantomjs-polyfill", "bind-polyfill.js")
+    ),
+    File.expand_path(
+      File.join(node_modules_path, "phantomjs-polyfill-object-assign", "object-assign-polyfill.js")
+    )
+  ],
+  js_errors: true,
+  url_whitelist: ["http://*.lvh.me", "localhost", "127.0.0.1"]
+}
+
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, capybara_options)
 end
 
+Capybara.register_driver :debug do |app|
+  Capybara::Poltergeist::Driver.new(app, capybara_options.merge(inspector: true))
+end
+
+Capybara::Screenshot.prune_strategy = :keep_last_run
+Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = true
+
 Capybara.configure do |config|
   config.always_include_port = true
+  config.default_driver = :poltergeist
+  config.always_include_port = true
 end
 
 RSpec.configure do |config|
   config.before :each, type: :feature do
+    Capybara.current_session.driver.reset!
     switch_to_default_host
   end
+
+  config.include Decidim::CapybaraTestHelpers, type: :feature
+
+  if ENV["CI"]
+    require "rspec/repeat"
+
+    config.include RSpec::Repeat
+    config.around :each, type: :feature do |example|
+      repeat example, 5.times, wait: 1, verbose: true
+    end
+  end
 end

data/decidim-dev/lib/decidim/test/rspec_support/database_cleaner.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 RSpec.configure do |config|
   config.before(:suite) do
-    DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with :truncation
   end
 
   config.around(:each) do |example|

data/decidim-dev/lib/decidim/test/rspec_support/feature.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  # Dummy engine to be able to test components.
+  class DummyEngine < Rails::Engine
+    engine_name "dummy"
+
+    routes do
+      root to: proc { [200, {}, ["DUMMY ENGINE"]] }
+    end
+  end
+end
+
+Decidim.register_feature(:dummy) do |feature|
+  feature.engine = Decidim::DummyEngine
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Decidim.find_feature_manifest(:dummy).reset_hooks!
+  end
+end

data/decidim-dev/lib/decidim/test/rspec_support/feature_context.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+RSpec.shared_context "feature" do
+  let!(:manifest_name) { raise NotImplementedError }
+  let(:manifest) { Decidim.find_feature_manifest(manifest_name) }
+
+  let!(:organization) { create(:organization) }
+
+  let(:participatory_process) do
+    create(:participatory_process, organization: organization)
+  end
+
+  let!(:feature) do
+    create(:feature,
+           manifest: manifest,
+           participatory_process: participatory_process)
+  end
+
+  before do
+    switch_to_host(organization.host)
+  end
+
+  def visit_feature
+    visit decidim.feature_path(participatory_process, feature)
+  end
+end
+
+RSpec.shared_context "feature admin" do
+  include_context "feature"
+  let(:user) { create(:user, :confirmed, organization: organization) }
+
+  before do
+    Decidim::Admin::ParticipatoryProcessUserRole.create!(
+      role: :admin,
+      user: user,
+      participatory_process: participatory_process
+    )
+
+    login_as user, scope: :user
+  end
+
+  def visit_feature_admin
+    visit decidim_admin.manage_feature_path(participatory_process, feature)
+  end
+end

data/decidim-dev/lib/decidim/test/rspec_support/helpers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Helpers that get automatically included in feature specs.
+module Decidim::FeatureTestHelpers
+  def within_user_menu
+    within ".topbar__user__logged" do
+      find("a", text: user.name).hover
+      yield
+    end
+  end
+
+  def within_language_menu
+    within ".topbar__dropmenu.language-choose" do
+      find("ul.dropdown.menu").hover
+      yield
+    end
+  end
+
+  def click_icon(name = nil)
+    classes = ["icon"]
+    classes << ["icon--#{name}"] if name
+    find(".#{classes.join(".")}").click
+  end
+
+  def stripped(text)
+    Nokogiri::HTML(text).text
+  end
+
+  def within_flash_messages
+    within ".flash.callout" do
+      yield
+    end
+  end
+end
+
+def stripped(text)
+  Nokogiri::HTML(text).text
+end
+
+RSpec.configure do |config|
+  config.include Decidim::FeatureTestHelpers, type: :feature
+end

data/decidim-dev/lib/decidim/test/rspec_support/translation_helpers.rb

@@ -9,4 +9,67 @@ module TranslationHelpers
   def translated(field, locale: I18n.locale)
     field.try(:[], locale.to_s)
   end
+
+  # Checks that the current page has some translated content. It strips the
+  # HTML tags from the field (in case there are any).
+  #
+  # field - the field that holds the translations
+  # locale - the ID of the locale to check
+  def have_i18n_content(field, locale: I18n.locale)
+    have_content(stripped(translated(field, locale: locale)))
+  end
+
+  # Handles how to fill in i18n form fields.
+  #
+  # field - the name of the field that should be filled, without the
+  #   locale-related part (e.g. `:participatory_process_title`)
+  # tab_slector - a String representing the ID of the HTML element that holds
+  #   the tabs for this input. It ususally is `"#<attribute_name>-tabs" (e.g.
+  #   "#title-tabs")
+  # localized_values - a Hash where the keys are the locales IDs and the values
+  #   are the values that will be entered in the form field.
+  def fill_in_i18n(field, tab_selector, localized_values)
+    fill_in_i18n_fields(field, tab_selector, localized_values) do |locator, value|
+      fill_in locator, with: value
+    end
+  end
+
+  # Handles how to fill in i18n form fields which uses a WYSIWYG editor.
+  #
+  # field - the name of the field that should be filled, without the
+  #   locale-related part (e.g. `:participatory_process_title`)
+  # tab_slector - a String representing the ID of the HTML element that holds
+  #   the tabs for this input. It ususally is `"#<attribute_name>-tabs" (e.g.
+  #   "#title-tabs")
+  # localized_values - a Hash where the keys are the locales IDs and the values
+  #   are the values that will be entered in the form field.
+  def fill_in_i18n_editor(field, tab_selector, localized_values)
+    fill_in_i18n_fields(field, tab_selector, localized_values) do |locator, value|
+      fill_in_editor locator, with: value
+    end
+  end
+
+  # Handles how to fill a WYSIWYG editor.
+  #
+  # locator - The input field ID. The DOM element is selected using jQuery.
+  # params  - A Hash of options
+  #          :with - A String value that will be entered in the form field. (required)
+  def fill_in_editor(locator, params = {})
+    raise ArgumentError if params[:with].blank?
+    page.execute_script <<-SCRIPT
+      $('##{locator}').siblings('.editor-container').find('.ql-editor')[0].innerHTML = "#{params[:with]}";
+      $('##{locator}').val("#{params[:with]}")
+    SCRIPT
+  end
+
+  private
+
+  def fill_in_i18n_fields(field, tab_selector, localized_values)
+    localized_values.each do |locale, value|
+      within tab_selector do
+        click_link I18n.t(locale, scope: "locales")
+      end
+      yield "#{field}_#{locale}", value
+    end
+  end
 end