decidim-pages 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab78619392592e129e5832c0a779ef5283722b6a
+  data.tar.gz: 32f49164085f41b9f788ff173ddb1b1f1339726f
+SHA512:
+  metadata.gz: cabddfa8a9fc6812b2bc7f41580bb2e01d5fc48307fb56f959295667bf4dd5cd04ac412606284151dc2db15c31a95088ea89e80719d42b1c6ff9a52fbc254778
+  data.tar.gz: 7553a56a6e9268c7f2bf87fd009b3a46b3edd99d905762deda8abb6443200ce4e978fa78fb0fc9777c43af179f92d59d17d40bb0489432c465c49b5d62026623

data/README.md

@@ -0,0 +1,24 @@
+# Decidim::Pages
+
+The Pages module adds static page capabilities to any participatory process. It basically provides an interface to include arbitrary HTML content to any step.
+
+## Usage
+Pages will be available as a Feature for a Participatory Process.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-pages'
+```
+
+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 "decidim/common_rake"

data/app/commands/decidim/pages/admin/update_page.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    module Admin
+      # This command is executed when the user changes a Page from the admin
+      # panel.
+      class UpdatePage < Rectify::Command
+        # Initializes a UpdatePage Command.
+        #
+        # form - The form from which to get the data.
+        # page - The current instance of the page to be updated.
+        def initialize(form, page)
+          @form = form
+          @page = page
+        end
+
+        # Updates the page if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          update_page
+          broadcast(:ok)
+        end
+
+        private
+
+        def update_page
+          @page.update_attributes!(
+            title: @form.title,
+            body: @form.body,
+            commentable: @form.commentable
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/pages/create_page.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # Command that gets called whenever a feature's page has to be created. It
+    # usually happens as a callback when the feature itself is created.
+    class CreatePage < Rectify::Command
+      def initialize(feature)
+        @feature = feature
+      end
+
+      def call
+        @page = Page.new(
+          title: @feature.name,
+          feature: @feature
+        )
+
+        @page.save ? broadcast(:ok) : broadcast(:invalid)
+      end
+    end
+  end
+end

data/app/commands/decidim/pages/destroy_page.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # Command that gets called when the page of this feature needs to be
+    # destroyed. It usually happens as a callback when the feature is removed.
+    class DestroyPage < Rectify::Command
+      def initialize(feature)
+        @feature = feature
+      end
+
+      def call
+        Page.where(feature: @feature).destroy_all
+        broadcast(:ok)
+      end
+    end
+  end
+end

data/app/controllers/decidim/pages/admin/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Pages
+    module Admin
+      # Base controller for the administration of this module. It inherits from
+      # Decidim's admin base controller in order to inherit the layout and other
+      # convenience methods relevant to a this component.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

data/app/controllers/decidim/pages/admin/pages_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    module Admin
+      # This controller allows the user to update a Page.
+      class PagesController < Admin::ApplicationController
+        def edit
+          @form = form(Admin::PageForm).from_model(page)
+        end
+
+        def update
+          @form = form(Admin::PageForm).from_params(params)
+
+          Admin::UpdatePage.call(@form, page) do
+            on(:ok) do
+              flash[:notice] = I18n.t("pages.update.success", scope: "decidim.pages.admin")
+              redirect_to parent_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("pages.update.invalid", scope: "decidim.pages.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        private
+
+        def page
+          @page ||= Pages::Page.find_by(feature: current_feature)
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/pages/application_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Pages
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Features::Basecontroller`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+      def show
+        @page = Page.find_by(feature: current_feature)
+      end
+    end
+  end
+end

data/app/forms/decidim/pages/admin/page_form.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    module Admin
+      # This class holds a Form to update pages from Decidim's admin panel.
+      class PageForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :title, String
+        translatable_attribute :body, String
+        attribute :commentable, Boolean
+
+        validates :title, translatable_presence: true
+      end
+    end
+  end
+end

data/app/helpers/decidim/pages/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # Custom helpers, scoped to the pages engine.
+    #
+    module ApplicationHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/app/models/decidim/pages/application_record.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/pages/page.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # The data store for a Page in the Decidim::Pages component. It stores a
+    # title, description and any other useful information to render a custom page.
+    class Page < Pages::ApplicationRecord
+      validates :title, :feature, presence: true
+      belongs_to :feature, foreign_key: "decidim_feature_id", class_name: Decidim::Feature
+      has_one :organization, through: :feature
+    end
+  end
+end

data/app/views/decidim/pages/admin/pages/_form.html.erb

@@ -0,0 +1,5 @@
+<div class="field">
+  <%= form.translated :text_field, :title, autofocus: true, label: t("models.components.title", scope: "decidim.pages.admin") %>
+  <%= form.translated :editor, :body, toolbar: :full, lines: 30, label: t("models.components.body", scope: "decidim.pages.admin")  %>
+  <%= form.check_box :commentable, label: t("models.components.commentable", scope: "decidim.pages.admin") %>
+</div>

data/app/views/decidim/pages/admin/pages/edit.html.erb

@@ -0,0 +1,9 @@
+<h3><%= t ".title" %></h3>
+
+<%= form_for(@form, url: page_path, method: :post) do |form| %>
+  <%= render partial: 'form', object: form %>
+
+  <div class="actions">
+    <%= form.submit t(".save") %>
+  </div>
+<% end %>

data/app/views/decidim/pages/application/show.html.erb

@@ -0,0 +1,16 @@
+<% content_for(:title, translated_attribute(@page.title)) %>
+<div class="row column">
+  <div class="row">
+    <div class="columns medium-7 mediumlarge-8">
+      <div class="section">
+        <%== translated_attribute @page.body %>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%= content_for :expanded do %>
+  <% if @page.commentable? %>
+    <%= comments_for @page, arguable: true %>
+  <% end %>
+<% end %>

data/config/i18n-tasks.yml

@@ -0,0 +1,4 @@
+base_locale: en
+locales: [en]
+ignore_unused:
+- "decidim.features.pages.name"

data/config/locales/ca.yml

@@ -0,0 +1,19 @@
+ca:
+  decidim:
+    features:
+      pages:
+        name: Pàgina
+    pages:
+      admin:
+        models:
+          components:
+            body: Cos
+            commentable: Habilitar comentaris per a aquesta pàgina
+            title: Títol
+        pages:
+          edit:
+            save: Desa la pàgina
+            title: Editar pàgina
+          update:
+            invalid: Hi ha hagut errors en desar la pàgina.
+            success: Pàgina guardada correctament.

data/config/locales/en.yml

@@ -0,0 +1,20 @@
+---
+en:
+  decidim:
+    features:
+      pages:
+        name: Page
+    pages:
+      admin:
+        models:
+          components:
+            body: Body
+            commentable: Enable comments for this page
+            title: Title
+        pages:
+          edit:
+            save: Save page
+            title: Edit page
+          update:
+            invalid: There's been errors when saving the page.
+            success: Page saved successfully.

data/config/locales/es.yml

@@ -0,0 +1,19 @@
+es:
+  decidim:
+    features:
+      pages:
+        name: Página
+    pages:
+      admin:
+        models:
+          components:
+            body: Cuerpo
+            commentable: Habilitar comentarios para esta página
+            title: Título
+        pages:
+          edit:
+            save: Guardar página
+            title: Editar página
+          update:
+            invalid: Ha habido errores al guardar la página.
+            success: Página guardada correctamente.

data/db/migrate/20161116121353_create_decidim_pages.rb

@@ -0,0 +1,11 @@
+class CreateDecidimPages < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_pages_pages do |t|
+      t.jsonb :title
+      t.jsonb :body
+      t.references :decidim_feature, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20161214150429_add_commentable_to_pages.rb

@@ -0,0 +1,5 @@
+class AddCommentableToPages < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_pages_pages, :commentable, :boolean, null: false, default: false
+  end
+end

data/lib/decidim/pages.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require "decidim/pages/admin"
+require "decidim/pages/engine"
+require "decidim/pages/admin_engine"
+require "decidim/pages/feature"
+
+module Decidim
+  # This namespace holds the logic of the `Pages` component. This component
+  # allows the admins to create a custom page for a participatory process.
+  module Pages
+  end
+end

data/lib/decidim/pages/admin.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # This module contains all the domain logic associated to Decidim's Pages
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/pages/admin_engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # This is the admin interface for `decidim-pages`. It lets you edit and
+    # configure the page associated to a participatory process.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Pages::Admin
+
+      paths["db/migrate"] = nil
+
+      routes do
+        post "/", to: "pages#update", as: :page
+        root to: "pages#edit"
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/pages/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Decidim
+  module Pages
+    # This is the engine that runs on the public interface of `decidim-pages`.
+    # It mostly handles rendering the created page associated to a participatory
+    # process.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Pages
+
+      routes do
+        root to: "application#show"
+      end
+    end
+  end
+end

data/lib/decidim/pages/feature.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/features/namer"
+
+Decidim.register_feature(:pages) do |feature|
+  feature.engine = Decidim::Pages::Engine
+  feature.admin_engine = Decidim::Pages::AdminEngine
+
+  feature.on(:create) do |instance|
+    Decidim::Pages::CreatePage.call(instance) do
+      on(:invalid) { raise "Can't create page" }
+    end
+  end
+
+  feature.on(:destroy) do |instance|
+    Decidim::Pages::DestroyPage.call(instance) do
+      on(:error) { raise "Can't destroy page" }
+    end
+  end
+
+  feature.seeds do
+    Decidim::ParticipatoryProcess.all.each do |process|
+      next unless process.steps.any?
+
+      feature = Decidim::Feature.create!(
+        name: Decidim::Features::Namer.new(process.organization.available_locales, :pages).i18n_name,
+        manifest_name: :pages,
+        participatory_process: process
+      )
+
+      Decidim::Pages::Page.create!(
+        feature: feature,
+        title: Decidim::Faker::Localized.sentence(2),
+        body: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        commentable: true
+      )
+    end
+  end
+end

data/lib/tasks/decidim/pages_tasks.rake

@@ -0,0 +1 @@
+# frozen_string_literal: true

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: decidim-pages
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josep Jaume Rey Peroy
+- Marc Riera Casals
+- Oriol Gual Oliva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: decidim-comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rectify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: decidim-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: A pages component for decidim's participatory processes.
+email:
+- josepjaume@gmail.com
+- mrc2407@gmail.com
+- oriolgual@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/commands/decidim/pages/admin/update_page.rb
+- app/commands/decidim/pages/create_page.rb
+- app/commands/decidim/pages/destroy_page.rb
+- app/controllers/decidim/pages/admin/application_controller.rb
+- app/controllers/decidim/pages/admin/pages_controller.rb
+- app/controllers/decidim/pages/application_controller.rb
+- app/forms/decidim/pages/admin/page_form.rb
+- app/helpers/decidim/pages/application_helper.rb
+- app/models/decidim/pages/application_record.rb
+- app/models/decidim/pages/page.rb
+- app/views/decidim/pages/admin/pages/_form.html.erb
+- app/views/decidim/pages/admin/pages/edit.html.erb
+- app/views/decidim/pages/application/show.html.erb
+- config/i18n-tasks.yml
+- config/locales/ca.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- db/migrate/20161116121353_create_decidim_pages.rb
+- db/migrate/20161214150429_add_commentable_to_pages.rb
+- lib/decidim/pages.rb
+- lib/decidim/pages/admin.rb
+- lib/decidim/pages/admin_engine.rb
+- lib/decidim/pages/engine.rb
+- lib/decidim/pages/feature.rb
+- lib/tasks/decidim/pages_tasks.rake
+homepage: https://github.com/AjuntamentdeBarcelona/decidim
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A pages component for decidim's participatory processes.
+test_files: []