decidim 0.10.1 → 0.11.0.pre1

data/bin/decidim

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../lib/generators/decidim/app_generator"
-
-Decidim::Generators::AppGenerator.start

data/docs/advanced/features.md

@@ -1,60 +0,0 @@
-# Features
-
-Features are the core contract between external modules and the core. They're used to define pieces of functionality that are pluggable to participatory processes and can be enabled or disabled by the administrator.
-
-## How do I create a new feature?
-
-Features are just gems with one or more Rails engines included in it. You can use as an example [decidim-pages](https://github.com/decidim/decidim/tree/master/decidim-pages).
-
-Check out the `lib/decidim/pages` folder: It includes several files, the most important of which is `feature.rb`.
-
-## Defining a feature manifest
-
-Features are defined in a manifest, along with its engine and admin engine counterpart.
-
-There's a DSL available to describe all this:
-
-```ruby
-# :my_feature is the unique name of the feature that will be globally registered.
-Decidim.register_feature(:my_feature) do |feature|
-  # The user will be redirected to the feature's engine when accessing it through
-  # the public page of a participatory process. A feature's engine is isolated
-  # from the outside so it can deal with its own dependencies without having to
-  # know its render path or its parent resources.
-  feature.engine = MyFeature::Engine
-
-  # A component's admin engine will get rendered on the admin panel and follows
-  # the same principles as the engine. It's isolated from the outside and
-  # doesn't care about external dependencies. It only needs to care about its
-  # underlying `feature`.
-  feature.admin_engine = MyFeature::AdminEngine
-
-  # Feature hooks get called whenever relevant lifecycle events happen, like
-  # adding a new feature o destroying it. You always get passed the instance
-  # so you can act on it. Creating or destroying a comoponent is transactional
-  # along with its hooks, so you can decide to halt the transaction by raising
-  # an exception.
-  #
-  # Valid hook names are :create and :destroy.
-  feature.on(:create) do |feature|
-    MyFeature::DoSomething.with(feature)
-  end
-
-  # Export definitions allow features to declare any number of exportable files.
-  #
-  # An export definition needs a unique name, a collection, and a Serializer. If
-  # no serializer is provided, a default, naive one will be used.
-  #
-  # Exports are then exposed via the UI, so the implementer only needs to care
-  # about the export definitions.
-  feature.exports :feature_resources do |exports|
-    exports.collection do |feature|
-      MyFeature::Resource.where(feature: feature)
-    end
-
-    exports.serializer MyFeature::ResourceSerializer
-  end
-end
-```
-
-Every model in a feature doesn't have to (and should not) know about its parent participatory process, but instead should be scoped to the features.

data/lib/generators/decidim/app_generator.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler"
-require "rails/generators"
-require "rails/generators/rails/app/app_generator"
-require "decidim/version"
-require_relative "install_generator"
-
-module Decidim
-  module Generators
-    # Generates a Rails app and installs decidim to it. Uses the default Rails
-    # generator for most of the work.
-    #
-    # Remember that, for how generators work, actions are executed based on the
-    # definition order of the public methods.
-    class AppGenerator < Rails::Generators::AppGenerator
-      hide!
-
-      def source_paths
-        [
-          File.expand_path("templates", __dir__),
-          Rails::Generators::AppGenerator.source_root
-        ]
-      end
-
-      source_root File.expand_path("templates", __dir__)
-
-      class_option :path, type: :string,
-                          default: nil,
-                          desc: "Path to the gem"
-
-      class_option :edge, type: :boolean,
-                          default: false,
-                          desc: "Use GitHub's edge version from master branch"
-
-      class_option :branch, type: :string,
-                            default: nil,
-                            desc: "Use a specific branch from GitHub's version"
-
-      class_option :recreate_db, type: :boolean,
-                                 default: false,
-                                 desc: "Recreate test database"
-
-      class_option :seed_db, type: :boolean,
-                             default: false,
-                             desc: "Seed test database"
-
-      class_option :skip_bundle, type: :boolean,
-                                 default: true,
-                                 desc: "Don't run bundle install"
-
-      class_option :skip_gemfile, type: :boolean,
-                                  default: false,
-                                  desc: "Don't generate a Gemfile for the application"
-
-      class_option :demo, type: :boolean,
-                          default: false,
-                          desc: "Generate a demo authorization handler"
-
-      def database_yml
-        template "database.yml.erb", "config/database.yml", force: true
-      end
-
-      def decidim_controller
-        template "decidim_controller.rb.erb", "app/controllers/decidim_controller.rb", force: true
-      end
-
-      def docker
-        template "Dockerfile.erb", "Dockerfile"
-        template "docker-compose.yml.erb", "docker-compose.yml"
-      end
-
-      def cable_yml
-        template "cable.yml.erb", "config/cable.yml", force: true
-      end
-
-      def readme
-        template "README.md.erb", "README.md", force: true
-      end
-
-      def gemfile
-        return if options[:skip_gemfile]
-
-        template target_gemfile, "Gemfile", force: true
-        template "#{target_gemfile}.lock", "Gemfile.lock", force: true
-
-        gem_modifier = if options[:path]
-                         "path: \"#{options[:path]}\""
-                       elsif options[:edge]
-                         "git: \"https://github.com/decidim/decidim.git\""
-                       elsif options[:branch]
-                         "git: \"https://github.com/decidim/decidim.git\", branch: \"#{options[:branch]}\""
-                       else
-                         "\"#{Decidim.version}\""
-                       end
-
-        gsub_file "Gemfile", /gem "#{current_gem}".*/, "gem \"#{current_gem}\", #{gem_modifier}"
-        gsub_file "Gemfile", /gem "decidim-dev".*/, "gem \"decidim-dev\", #{gem_modifier}" if current_gem == "decidim"
-
-        Bundler.with_original_env { run "bundle install" }
-      end
-
-      def add_ignore_uploads
-        append_file ".gitignore", "\n# Ignore public uploads\npublic/uploads" unless options["skip_git"]
-      end
-
-      def remove_default_error_pages
-        remove_file "public/404.html"
-        remove_file "public/500.html"
-      end
-
-      def authorization_handler
-        template "initializer.rb", "config/initializers/decidim.rb"
-
-        template "example_authorization_handler.rb", "app/services/example_authorization_handler.rb" if options[:demo]
-      end
-
-      def install
-        Decidim::Generators::InstallGenerator.start(
-          [
-            "--recreate_db=#{options[:recreate_db]}",
-            "--seed_db=#{options[:seed_db]}",
-            "--app_name=#{app_name}"
-          ]
-        )
-      end
-
-      private
-
-      def current_gem
-        return "decidim" unless options[:path]
-
-        File.read(gemspec).match(/name\s*=\s*['"](?<name>.*)["']/)[:name]
-      end
-
-      def gemspec
-        File.expand_path(Dir.glob("*.gemspec", base: expanded_path).first, expanded_path)
-      end
-
-      def target_gemfile
-        root = if options[:path]
-                 expanded_path
-               else
-                 decidim_root
-               end
-
-        File.join(root, "Gemfile")
-      end
-
-      def expanded_path
-        File.expand_path(options[:path])
-      end
-
-      def decidim_root
-        File.expand_path(File.join("..", "..", ".."), __dir__)
-      end
-    end
-  end
-end

data/lib/generators/decidim/install_generator.rb

@@ -1,138 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/base"
-require "securerandom"
-
-module Decidim
-  module Generators
-    # Installs `decidim` to a Rails app by adding the needed lines of code
-    # automatically to important files in the Rails app.
-    #
-    # Remember that, for how generators work, actions are executed based on the
-    # definition order of the public methods.
-    class InstallGenerator < Rails::Generators::Base
-      desc "Install decidim"
-      source_root File.expand_path("templates", __dir__)
-
-      class_option :app_name, type: :string, default: nil,
-                              desc: "The name of the app"
-      class_option :recreate_db, type: :boolean, default: false,
-                                 desc: "Recreate db after installing decidim"
-      class_option :seed_db, type: :boolean, default: false,
-                             desc: "Seed db after installing decidim"
-
-      def install
-        route "mount Decidim::Core::Engine => '/'"
-      end
-
-      def add_seeds
-        append_file "db/seeds.rb", <<~RUBY
-          # You can remove the 'faker' gem if you don't want Decidim seeds.
-          Decidim.seed!
-        RUBY
-      end
-
-      def copy_initializer
-        template "carrierwave.rb", "config/initializers/carrierwave.rb"
-        template "social_share_button.rb", "config/initializers/social_share_button.rb"
-      end
-
-      def secrets
-        template "secrets.yml.erb", "config/secrets.yml", force: true
-      end
-
-      def remove_layout
-        remove_file "app/views/layouts/application.html.erb"
-        remove_file "app/views/layouts/mailer.text.erb"
-      end
-
-      def append_assets
-        append_file "app/assets/javascripts/application.js", "//= require decidim"
-        gsub_file "app/assets/javascripts/application.js", %r{//= require turbolinks\n}, ""
-        inject_into_file "app/assets/stylesheets/application.css",
-                         before: "*= require_tree ." do
-          "*= require decidim\n "
-        end
-
-        template "decidim.scss.erb", "app/assets/stylesheets/decidim.scss", force: true
-      end
-
-      def configure_js_compressor
-        gsub_file "config/environments/production.rb", "config.assets.js_compressor = :uglifier", "config.assets.js_compressor = Uglifier.new(:harmony => true)"
-      end
-
-      def smtp_environment
-        inject_into_file "config/environments/production.rb",
-                         after: "config.log_formatter = ::Logger::Formatter.new" do
-          cut <<~RUBY
-            |
-            |  config.action_mailer.smtp_settings = {
-            |    :address        => Rails.application.secrets.smtp_address,
-            |    :port           => Rails.application.secrets.smtp_port,
-            |    :authentication => Rails.application.secrets.smtp_authentication,
-            |    :user_name      => Rails.application.secrets.smtp_username,
-            |    :password       => Rails.application.secrets.smtp_password,
-            |    :domain         => Rails.application.secrets.smtp_domain,
-            |    :enable_starttls_auto => Rails.application.secrets.smtp_starttls_auto,
-            |    :openssl_verify_mode => 'none'
-            |  }
-          RUBY
-        end
-      end
-
-      def copy_migrations
-        rails "railties:install:migrations"
-        recreate_db if options[:recreate_db]
-      end
-
-      def letter_opener_web
-        letter_opener_route = cut <<~RUBY
-          |
-          |  if Rails.env.development?
-          |    mount LetterOpenerWeb::Engine, at: "/letter_opener"
-          |  end
-        RUBY
-
-        route letter_opener_route
-
-        inject_into_file "config/environments/development.rb",
-                         after: "config.action_mailer.raise_delivery_errors = false" do
-          cut <<~RUBY
-            |
-            |  config.action_mailer.delivery_method = :letter_opener_web
-            |  config.action_mailer.default_url_options = { port: 3000 }
-          RUBY
-        end
-      end
-
-      private
-
-      def recreate_db
-        soft_rails "db:environment:set", "db:drop"
-        rails "db:create"
-        rails "db:migrate"
-        rails "db:seed" if options[:seed_db]
-        rails "db:test:prepare"
-      end
-
-      # Runs rails commands in a subprocess, and aborts if it doesn't suceeed
-      def rails(*args)
-        abort unless system("bin/rails", *args)
-      end
-
-      # Runs rails commands in a subprocess silencing errors, and ignores status
-      def soft_rails(*args)
-        system("bin/rails", *args, err: File::NULL)
-      end
-
-      def scss_variables
-        variables = File.join(Gem.loaded_specs["decidim-core"].full_gem_path, "app", "assets", "stylesheets", "decidim", "_variables.scss")
-        File.read(variables).split("\n").map { |line| "// #{line}".gsub(" !default", "") }.join("\n")
-      end
-
-      def cut(text)
-        text.gsub(/^ *\|/, "").rstrip
-      end
-    end
-  end
-end

data/lib/generators/decidim/templates/Dockerfile.erb

@@ -1 +0,0 @@
-FROM decidim/decidim:<%= Decidim.version %>

data/lib/generators/decidim/templates/README.md.erb

@@ -1,22 +0,0 @@
-# <%= app_name %>
-
-Citizen Participation and Open Government application.
-
-This is the open-source repository for <%= app_name %>, based on [Decidim](https://github.com/decidim/decidim).
-
-## Setting up the application
-
-You will need to do some steps before having the app working properly once you've deployed it:
-
-1. Open a Rails console in the server: `bundle exec rails console`
-2. Create a System Admin user:
-```ruby
-user = Decidim::System::Admin.new(email: <email>, password: <password>, password_confirmation: <password>)
-user.save!
-```
-3. Visit `<your app url>/system` and login with your system admin credentials
-4. Create a new organization. Check the locales you want to use for that organization, and select a default locale.
-5. Set the correct default host for the organization, otherwise the app will not work properly. Note that you need to include any subdomain you might be using.
-6. Fill the rest of the form and submit it.
-
-You're good to go!

data/lib/generators/decidim/templates/cable.yml.erb

@@ -1,9 +0,0 @@
-development:
-  adapter: async
-
-test:
-  adapter: async
-
-production:
-  adapter: redis
-  url: <%%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>

data/lib/generators/decidim/templates/carrierwave.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# Default CarrierWave setup.
-#
-CarrierWave.configure do |config|
-  config.permissions = 0o666
-  config.directory_permissions = 0o777
-  config.storage = :file
-  config.enable_processing = !Rails.env.test?
-end
-
-# Setup CarrierWave to use Amazon S3. Add `gem "fog-aws" to your Gemfile.
-#
-# CarrierWave.configure do |config|
-#   config.storage = :fog
-#   config.fog_provider = 'fog/aws'                                             # required
-#   config.fog_credentials = {
-#     provider:              'AWS',                                             # required
-#     aws_access_key_id:     Rails.application.secrets.aws_access_key_id,     # required
-#     aws_secret_access_key: Rails.application.secrets.aws_secret_access_key, # required
-#     region:                'eu-west-1',                                       # optional, defaults to 'us-east-1'
-#     host:                  's3.example.com',                                  # optional, defaults to nil
-#     endpoint:              'https://s3.example.com:8080'                      # optional, defaults to nil
-#   }
-#   config.fog_directory  = 'name_of_directory'                                 # required
-#   config.fog_public     = false                                               # optional, defaults to true
-#   config.fog_attributes = { 'Cache-Control' => "max-age=#{365.day.to_i}" }    # optional, defaults to {}
-# end

data/lib/generators/decidim/templates/database.yml.erb

@@ -1,87 +0,0 @@
-# PostgreSQL. Versions 9.1 and up are supported.
-#
-# Install the pg driver:
-#   gem install pg
-# On OS X with Homebrew:
-#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
-# On OS X with MacPorts:
-#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
-# On Windows:
-#   gem install pg
-#       Choose the win32 build.
-#       Install PostgreSQL and put its /bin directory on your path.
-#
-# Configure Using Gemfile
-# gem 'pg'
-#
-# On Linux, the 'host: "localhost"' line below should be commented out to avoid 'password required' error.
-#
-default: &default
-  adapter: postgresql
-  encoding: unicode
-  # For details on connection pooling, see rails configuration guide
-  # http://guides.rubyonrails.org/configuring.html#database-pooling
-  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
-  host: <%%= ENV.fetch("DATABASE_HOST") { "localhost" } %>
-  username: <%%= ENV.fetch("DATABASE_USERNAME") { "" } %>
-  password: <%%= ENV.fetch("DATABASE_PASSWORD") { "" } %>
-
-development:
-  <<: *default
-  database: <%%= ENV.fetch("DEV_DATABASE_NAME") { "<%= app_name %>_development" } %>
-
-  # The specified database role being used to connect to postgres.
-  # To create additional roles in postgres see `$ createuser --help`.
-  # When left blank, postgres will use the default role. This is
-  # the same name as the operating system user that initialized the database.
-  #username: <%= app_name %>
-
-  # The password associated with the postgres role (username).
-  #password:
-
-  # Connect on a TCP socket. Omitted by default since the client uses a
-  # domain socket that doesn't need configuration. Windows does not have
-  # domain sockets, so uncomment these lines.
-  #host: localhost
-
-  # The TCP port the server listens on. Defaults to 5432.
-  # If your server runs on a different port number, change accordingly.
-  #port: 5432
-
-  # Schema search path. The server defaults to $user,public
-  #schema_search_path: myapp,sharedapp,public
-
-  # Minimum log levels, in increasing order:
-  #   debug5, debug4, debug3, debug2, debug1,
-  #   log, notice, warning, error, fatal, and panic
-  # Defaults to warning.
-  #min_messages: notice
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  <<: *default
-  database: <%%= ENV.fetch("TEST_DATABASE_NAME") { "<%= app_name %>_test" } %>
-
-# As with config/secrets.yml, you never want to store sensitive information,
-# like your database password, in your source code. If your source code is
-# ever seen by anyone, they now have access to your database.
-#
-# Instead, provide the password as a unix environment variable when you boot
-# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
-# for a full rundown on how to provide these environment variables in a
-# production deployment.
-#
-# On some platform providers, you may have a full connection URL
-# available as an environment variable. For example:
-#
-#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
-#
-# You can use this database configuration with:
-#
-#   production:
-#     url: <%%= ENV['DATABASE_URL'] %>
-#
-production:
-  url: <%%= ENV['DATABASE_URL'] %>