decidim 0.1.0 → 0.2.0

data/decidim-system/app/commands/decidim/system/create_admin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A command with all the business logic when creating a new admin in

data/decidim-system/app/commands/decidim/system/create_default_pages.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A command with all the business logic when creating a new organization in

data/decidim-system/app/commands/decidim/system/register_organization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A command with all the business logic when creating a new organization in

data/decidim-system/app/commands/decidim/system/update_admin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A command with all the business logic when updating an admin in

data/decidim-system/app/commands/decidim/system/update_organization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A command with all the business logic when creating a new organization in

data/decidim-system/app/controllers/decidim/system/admins_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_dependency "decidim/system/application_controller"
 
 module Decidim

data/decidim-system/app/controllers/decidim/system/application_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # The main application controller that inherits from Rails.
@@ -10,6 +11,8 @@ module Decidim
       helper Decidim::TranslationsHelper
       helper Decidim::DecidimFormHelper
       helper Decidim::ReplaceButtonsHelper
+
+      helper Decidim::System::MenuHelper
     end
   end
 end

data/decidim-system/app/controllers/decidim/system/dashboard_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_dependency "decidim/system/application_controller"
 
 module Decidim

data/decidim-system/app/controllers/decidim/system/devise/passwords_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     module Devise

data/decidim-system/app/controllers/decidim/system/devise/sessions_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     module Devise

data/decidim-system/app/controllers/decidim/system/organizations_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_dependency "decidim/system/application_controller"
 
 module Decidim

data/decidim-system/app/forms/decidim/system/admin_form.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # A form object used to create organizations from the system dashboard.

data/decidim-system/app/forms/decidim/system/register_organization_form.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "decidim/translatable_attributes"
 
 module Decidim

data/decidim-system/app/forms/decidim/system/update_organization_form.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "decidim/translatable_attributes"
 
 module Decidim

data/decidim-system/app/helpers/decidim/system/application_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # Custom helpers, scoped to the system panel.

data/decidim-system/app/helpers/decidim/system/menu_helper.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Decidim
+  module System
+    # This module includes helpers to manage menus in system layout
+    module MenuHelper
+      # Public: Returns the main menu presenter object
+      def main_menu
+        @main_menu ||= MenuPresenter.new(:system_menu, self)
+      end
+    end
+  end
+end

data/decidim-system/app/jobs/decidim/system/application_job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # Custom ApplicationJob scoped to the system panel.

data/decidim-system/app/mailers/decidim/system/application_mailer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # Custom application mailer, scoped to the system mailer.

data/decidim-system/app/models/decidim/system/admin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # Admins are the users in charge of managing a Decidim installation.

data/decidim-system/app/models/decidim/system/application_record.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Decidim
   module System
     # Custom ApplicationRecord scoped to the system panel.

data/decidim-system/app/views/layouts/decidim/system/_sidebar.html.erb

@@ -6,10 +6,6 @@
   </h1>
 </div>
 
-<nav class="main-menu">
-  <%= active_link_to t("menu.dashboard", scope: "decidim.system"), root_path, active: :exact %>
-  <%= active_link_to t("menu.organizations", scope: "decidim.system"), organizations_path, active: :inclusive %>
-  <%= active_link_to t("menu.admins", scope: "decidim.system"), admins_path, active: :inclusive %>
-</nav>
+<%= main_menu.render %>
 
 <%= render partial: 'layouts/decidim/system/login_items' %>

data/decidim-system/bin/rails

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 # This command will automatically be run when you run "rails" with Rails gems
 # installed from the root of your application.
 

data/decidim-system/config/i18n-tasks.yml

@@ -2,8 +2,7 @@
 
 # The "main" locale.
 base_locale: en
-## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
-locales: [en]
+
 ## Reporting locale, default: en. Available: en, ru.
 # internal_locale: en
 
@@ -48,9 +47,10 @@ data:
 
 # Find translate calls
 search:
-  ## Paths or `File.find` patterns to search in:
-  # paths:
-  #  - app/
+  # Paths or `File.find` patterns to search in:
+  paths:
+   - app/
+   - lib/
 
   ## Root directories for relative keys resolution.
   # relative_roots:
@@ -71,7 +71,7 @@ search:
   # only: ["*.rb", "*.html.slim"]
 
   ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
-  # strict: true
+  strict: false
 
   ## Multiple scanners can be used. Their results are merged.
   ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.

data/decidim-system/config/locales/eu.yml

@@ -5,6 +5,7 @@ eu:
         confirm_destroy: Ziur hau ezabatu nahi duzula?
         destroy: Ezabatu
         edit: Editatu
+        new: Berria
         save: Gorde
         title: Ekintzak
       admins:
@@ -15,9 +16,11 @@ eu:
           success: Administratzailea zuzen sortu da
         edit:
           title: Editatu administratzailea
+          update: Eguneratu
         index:
           title: Administratzaileak
         new:
+          create: Sortu
           title: Administratzaile berria
         update:
           error: Errorea gertatu da administratzaile hau eguneratzean.

data/decidim-system/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Decidim::System::Engine.routes.draw do
   devise_for :admins,
              class_name: "Decidim::System::Admin",

data/decidim-system/db/seeds.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 if !Rails.env.production? || ENV["SEED"]
   Decidim::System::Admin.create!(
     email: "system@example.org",

data/decidim-system/lib/decidim/system.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "decidim/system/engine"
 
 module Decidim

data/decidim-system/lib/decidim/system/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rails"
 require "active_support/all"
 
@@ -27,6 +28,25 @@ module Decidim
       initializer "decidim_system.assets" do |app|
         app.config.assets.precompile += %w(decidim_system_manifest.js)
       end
+
+      initializer "decidim_system.menu" do
+        Decidim.menu :system_menu do |menu|
+          menu.item I18n.t("menu.dashboard", scope: "decidim.system"),
+                    decidim_system.root_path,
+                    position: 1,
+                    active: ["decidim/system/dashboard" => :show]
+
+          menu.item I18n.t("menu.organizations", scope: "decidim.system"),
+                    decidim_system.organizations_path,
+                    position: 2,
+                    active: :inclusive
+
+          menu.item I18n.t("menu.admins", scope: "decidim.system"),
+                    decidim_system.admins_path,
+                    position: 3,
+                    active: :inclusive
+        end
+      end
     end
   end
 end

data/decidim-system/spec/commands/decidim/system/create_admin_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 module Decidim

data/decidim-system/spec/commands/decidim/system/create_default_pages_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 module Decidim

data/decidim-system/spec/commands/decidim/system/register_organization_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 module Decidim

data/decidim-system/spec/commands/decidim/system/update_organization_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 module Decidim

data/decidim-system/spec/factories.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "decidim/core/test/factories"
 
 FactoryGirl.define do

data/decidim-system/spec/features/sessions_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 describe "Sessions", type: :feature do

data/decidim-system/spec/helpers/menu_helper_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  module System
+    describe MenuHelper do
+      describe "main_menu" do
+        let(:default_main_menu) { helper.main_menu.render }
+
+        it "renders the default main menu" do
+          expect(default_main_menu).to \
+            have_selector("li", count: 3) &
+            have_link("Dashboard", href: "/system/") &
+            have_link("Organizations", href: "/system/organizations") &
+            have_link("Admins", href: "/system/admins")
+        end
+
+        it "selects the correct default active option" do
+          allow(view).to \
+            receive(:params).and_return(controller: "decidim/system/dashboard", action: "show")
+
+          expect(default_main_menu).to have_selector(".active", text: "Dashboard")
+        end
+      end
+    end
+  end
+end

data/decidim-system/spec/i18n_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "decidim/dev/test/i18n_shared_examples"
+
+RSpec.describe "I18n sanity" do
+  include_examples "I18n sanity"
+end

data/decidim-system/spec/models/admin_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 module Decidim

data/decidim-system/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ENV["ENGINE_NAME"] = File.dirname(File.dirname(__FILE__)).split("/").last
 require "decidim/dev/test/base_spec_helper"
 

data/docs/features_and_components.md

@@ -39,6 +39,21 @@ Decidim.register_feature(:my_feature) do |feature|
   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
 ```
 

data/docs/getting_started.md

@@ -133,3 +133,13 @@ And make sure you get all the latest migrations:
 $ bin/rails decidim:upgrade
 $ bin/rails db:migrate
 ```
+
+You can also make sure new translations are complete for all languages in your
+application with:
+
+```
+$ bin/rails decidim:check_locales
+```
+
+Be aware that this task might not be able to detect everything, so make sure you
+also manually check your application before uprading.

data/docs/how_to_create_a_plugin.md

@@ -19,19 +19,16 @@
     Gem::Specification.new do |s|
       Decidim.add_default_gemspec_properties(s)
 
+      s.name        = "decidim-<engine_name>"
+      s.summary     = "<engine_description>"
+      s.description = s.summary
+
       s.files = Dir["{app,config,db,lib,vendor}/**/*", "Rakefile", "README.md"]
 
       s.add_dependency "decidim-core", Decidim.version
       s.add_dependency "rails", *Decidim.rails_version
 
       s.add_development_dependency "decidim-dev", Decidim.version
-
-      # Add more dependencies as needed:
-      s.add_dependency "foundation-rails", "~> 6.2.4.0"
-      s.add_dependency "autoprefixer-rails", ["~> 6.7", ">= 6.7.4"]
-      s.add_dependency "sass-rails", "~> 5.0.0"
-      s.add_dependency "jquery-rails", "~> 4.0"
-      s.add_dependency "foundation_rails_helper", "~> 2.0.0"
     end
     ```
 
@@ -54,9 +51,7 @@
     require "rails/engine/commands"
     ```
 
-1. Change `lib/decidim/<engine_name>.rb`
-
-    Add this
+1. Replace `lib/decidim/<engine_name>.rb` with this:
 
     ```ruby
     # frozen_string_literal: true
@@ -73,15 +68,10 @@
     require "active_support/all"
 
     require "decidim/core"
-    require "jquery-rails"
-    require "sass-rails"
-    require "foundation-rails"
-    require "foundation_rails_helper"
-    require "autoprefixer-rails"
 
     module Decidim
       module <EngineName>
-        # Decidim's core Rails Engine.
+        # Decidim's <EngineName> Rails Engine.
         class Engine < ::Rails::Engine
           isolate_namespace Decidim::<EngineName>
 
@@ -150,6 +140,7 @@
 1. Add `spec/spec_helper.rb` with:
 
     ```ruby
+    # frozen_string_literal: true
     ENV["ENGINE_NAME"] = File.dirname(File.dirname(__FILE__)).split("/").last
     require "decidim/test/base_spec_helper"
     ```