decidim-dev 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb6caf2afbc815dd893523f38c345953f2b04fdc
+  data.tar.gz: f4fd8e3949a62bed4f24a03c790163a0ae4d2da8
+SHA512:
+  metadata.gz: b9714a35ff2d96b5b9d258ffbc1bbeb2623d3ef856555d72688f8a4db31895c57acf8d5879900a6d49221138e049c63ecef813164957e34f8c65db4a54cab0e0
+  data.tar.gz: 5fcb703af373cbb6585a37a223dad32b326fb457ab11fcd13472b9637d5364420ed9872e6f5be256d953f7f6fefc1403f4f6c2ba5b481b4d90f89ef70668d63d

data/README.md

@@ -0,0 +1,24 @@
+# Decidim::Dev
+
+This gem allows local development of decidim's features and other features.
+
+## Usage
+TODO: Write docs.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-dev'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
+
+## License
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"

data/app/views/decidim/dummy_resource/_linked_dummys.html.erb

@@ -0,0 +1,5 @@
+<ul>
+  <% resources.each do |dummy| %>
+    <li><%= dummy.title %></li>
+  <% end %>
+</ul>

data/config/i18n-tasks.yml

@@ -0,0 +1,4 @@
+base_locale: en
+locales: [en]
+ignore_unused:
+- "decidim.resource_links.test_link.*"

data/config/locales/ca.yml

@@ -0,0 +1,5 @@
+ca:
+  decidim:
+    resource_links:
+      test_link:
+        dummy_resource_dummy: Fictici relacionat

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  decidim:
+    resource_links:
+      test_link:
+        dummy_resource_dummy: Related dummy

data/config/locales/es.yml

@@ -0,0 +1,5 @@
+es:
+  decidim:
+    resource_links:
+      test_link:
+        dummy_resource_dummy: Ficticio relacionado

data/config/locales/eu.yml

@@ -0,0 +1,5 @@
+eu:
+  decidim:
+    resource_links:
+      test_link:
+        dummy_resource_dummy: Honekin lotutako ????

data/config/locales/fi.yml

@@ -0,0 +1,5 @@
+fi:
+  decidim:
+    resource_links:
+      test_link:
+        dummy_resource_dummy: Liittyvät dummy

data/lib/decidim/dev.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "letter_opener_web"
+
+module Decidim
+  # Decidim::Dev holds all the convenience logic and libraries to be able to
+  # create external libraries that create test apps and test themselves against
+  # them.
+  module Dev
+    # Public: Finds an asset.
+    #
+    # Returns a String with the path for a particular asset.
+    def self.asset(name)
+      File.join(
+        File.dirname(__FILE__),
+        "dev",
+        "assets",
+        name
+      )
+    end
+  end
+end

data/lib/decidim/dev/common_rake.rb

@@ -0,0 +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"
+task :generate_test_app do
+  Decidim::Generators::DummyGenerator.start(
+    [
+      "--engine_path=#{engine_path}",
+      "--migrate=true",
+      "--quiet"
+    ]
+  )
+
+  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/lib/decidim/dev/dummy_authorization_handler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Decidim
+  # An example implementation of an AuthorizationHandler to be used in tests.
+  class DummyAuthorizationHandler < AuthorizationHandler
+    attribute :document_number, String
+    attribute :postal_code, String
+    attribute :birthday, Date
+
+    validates :document_number, presence: true
+    validate :valid_document_number
+
+    def metadata
+      super.merge(document_number: document_number)
+    end
+
+    def unique_id
+      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/lib/decidim/dev/test/authorization_shared_examples.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+RSpec.shared_examples "an authorization handler" do
+  before do
+    unless respond_to?(:handler)
+      raise "You need to define `handler` (an instance of the authorization handler) in order to run the shared examples."
+    end
+  end
+
+  describe "to_partial_path" do
+    subject { handler.to_partial_path }
+    it { is_expected.to be_kind_of(String) }
+  end
+
+  describe "handler_name" do
+    subject { handler.handler_name }
+    it { is_expected.to be_kind_of(String) }
+  end
+
+  describe "metadata" do
+    subject { handler.metadata }
+    it { is_expected.to be_kind_of(Hash) }
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+ENV["RAILS_ENV"] ||= "test"
+
+engine_name = ENV["ENGINE_NAME"]
+engine_spec_dir = File.join(Dir.pwd, "spec")
+dummy_app_path = File.expand_path(File.join(engine_spec_dir, "#{engine_name}_dummy_app"))
+
+if ENV["CI"]
+  require "simplecov"
+  SimpleCov.root(ENV["TRAVIS_BUILD_DIR"])
+
+  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 "decidim/core/test"
+require "#{File.dirname(__FILE__)}/rspec_support/feature.rb"
+
+begin
+  require "#{dummy_app_path}/config/environment"
+rescue LoadError
+  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(-1)
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{engine_spec_dir}/support/**/*.rb"].each { |f| require f }
+Dir["#{engine_spec_dir}/shared/**/*.rb"].each { |f| require f }
+
+require_relative "spec_helper"
+require_relative "i18n_spec"

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require "i18n/tasks"
+
+RSpec.describe "I18n" do
+  let(:i18n) { I18n::Tasks::BaseTask.new(locales: [I18n.default_locale]) }
+  let(:missing_keys) { i18n.missing_keys }
+  let(:unused_keys) { i18n.unused_keys }
+
+  it "does not have missing keys" do
+    expect(missing_keys).to be_empty,
+                            "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing` to show them"
+  end
+
+  it "does not have unused keys" do
+    expect(unused_keys).to be_empty,
+                           "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused` to show them"
+  end
+
+  it "is normalized" do
+    previous_locale_hashes = locale_hashes
+    i18n.normalize_store!
+    new_locale_hashes = locale_hashes
+
+    expect(previous_locale_hashes).to eq(new_locale_hashes),
+                                      "Please normalize your locale files with `i18n-tasks normalize`"
+  end
+
+  def locale_hashes
+    Dir.glob("config/locales/**/*.yml").inject({}) do |results, file|
+      md5 = Digest::MD5.file(file).hexdigest
+      results.merge(file => md5)
+    end
+  end
+end

data/lib/decidim/dev/test/rspec_support/action_mailer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require "nokogiri"
+
+RSpec.configure do |config|
+  config.before(:each) { clear_emails }
+end
+
+# A set of helpers meant to make your life easier when testing
+# emails, especially given the fact that ActionMailer's API can
+# be a bit inconsistent.
+module MailerHelpers
+  def emails
+    ActionMailer::Base.deliveries
+  end
+
+  def clear_emails
+    ActionMailer::Base.deliveries.clear
+  end
+
+  def last_email
+    emails.last
+  end
+
+  def last_email_body
+    email_body(last_email)
+  end
+
+  def email_body(email)
+    (email.try(:html_part).try(:body) || email.body).encoded
+  end
+
+  def last_email_link
+    Nokogiri::HTML(last_email_body).css("table.content a").last["href"]
+  end
+
+  def last_email_first_link
+    Nokogiri::HTML(last_email_body).css("table.content a").first["href"]
+  end
+
+  def wait_for_email(options = {})
+    options[:max_attempts] ||= 3
+    attempts = 0
+    loop do
+      if attempts >= options[:max_attempts]
+        raise StandardError, "An email with subject containing '#{options[:subject]}' wasn't sent.'"
+      end
+
+      return if last_email&.subject&.include? options[:subject]
+
+      sleep 1
+      attempts += 1
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include MailerHelpers
+end
+
+RSpec.configure do |config|
+  config.before :example, perform_enqueued: true do
+    @old_perform_enqueued_jobs = ActiveJob::Base.queue_adapter.perform_enqueued_jobs
+    @old_perform_enqueued_at_jobs = ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+  end
+
+  config.after :example, perform_enqueued: true do
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = @old_perform_enqueued_jobs
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = @old_perform_enqueued_at_jobs
+  end
+end

data/lib/decidim/dev/test/rspec_support/active_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include ActiveJob::TestHelper
+
+  config.before(:each) do
+    clear_enqueued_jobs
+  end
+end
+
+ActiveJob::Base.queue_adapter = :test

data/lib/decidim/dev/test/rspec_support/authenticated_controller_context.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+RSpec.shared_context "authenticated user" do
+  let(:user) { create(:user, :confirmed) }
+
+  before do
+    @request.env["decidim.current_organization"] = user.organization
+    sign_in user, scope: :user
+  end
+end

data/lib/decidim/dev/test/rspec_support/authorization_handlers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "decidim/dev/dummy_authorization_handler"
+RSpec.configure do |config|
+  config.before(:each) do
+    Decidim.config.authorization_handlers = [Decidim::DummyAuthorizationHandler]
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+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
+
+capybara_options = {
+  extensions: [
+    File.expand_path(
+      File.join(File.dirname(__FILE__), "phantomjs_polyfills", "promise.js")
+    ),
+    File.expand_path(
+      File.join(File.dirname(__FILE__), "phantomjs_polyfills", "bind-polyfill.js")
+    ),
+    File.expand_path(
+      File.join(File.dirname(__FILE__), "phantomjs_polyfills", "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