decidim-generators 0.11.0.pre1

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

@@ -0,0 +1,30 @@
+# Decidim::<%= component_module_name %>
+
+<%= component_description %>.
+
+## Usage
+
+<%= component_module_name %> will be available as a Component for a Participatory
+Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-<%= component_name %>
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/lib/decidim/generators/component_templates/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/lib/decidim/generators/component_templates/app/assets/images/decidim/component/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/lib/decidim/generators/component_templates/app/controllers/decidim/component/admin/application_controller.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/app/controllers/decidim/component/application_controller.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/lib/decidim/generators/component_templates/app/helpers/decidim/component/application_helper.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    # Custom helpers, scoped to the <%= component_name %> engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/lib/decidim/generators/component_templates/app/models/decidim/component/abilities/admin/admin_ability.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    module Abilities
+      module Admin
+        # Defines the abilities related to <%= component_name %> for a logged in admin user.
+        # Intended to be used with `cancancan`.
+        class AdminAbility < Decidim::Abilities::AdminAbility
+          def define_abilities
+            # can :manage, SomeResource
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/app/models/decidim/component/abilities/current_user_ability.rb.erb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    module Abilities
+      # Defines the abilities related to <%= component_name %> for a logged in user.
+      # Intended to be used with `cancancan`.
+      class CurrentUserAbility
+        include CanCan::Ability
+
+        attr_reader :user, :context
+
+        def initialize(user, context)
+          return unless user
+
+          @user = user
+          @context = context
+
+          # can :manage, SomeResource if authorized?(:some_action)
+        end
+
+        private
+
+        def authorized?(action)
+          return unless component
+
+          ActionAuthorizer.new(user, component, action).authorize.ok?
+        end
+
+        def current_settings
+          context.fetch(:current_settings, nil)
+        end
+
+        def component_settings
+          context.fetch(:component_settings, nil)
+        end
+
+        def component
+          component = context.fetch(:current_component, nil)
+          return nil unless component && component.manifest.name == :<%= component_name %>
+
+          component
+        end
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/app/models/decidim/component/application_record.rb.erb

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

data/lib/decidim/generators/component_templates/bin/rails.erb

@@ -0,0 +1,20 @@
+#!/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.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/decidim/<%= component_name %>/engine", __dir__)
+
+# Set up gems listed in the Gemfile.
+<%- if options[:external] -%>
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+<% else %>
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __dir__)
+<%- end -%>
+
+require "bundler/setup"
+
+require "rails/all"
+require "rails/engine/commands"

data/lib/decidim/generators/component_templates/config/i18n-tasks.yml.erb

@@ -0,0 +1,10 @@
+---
+
+base_locale: en
+locales: [en]
+
+ignore_unused:
+  - "decidim.components.<%= component_name %>.name"
+
+ignore_missing:
+  - decidim.participatory_processes.scopes.global

data/lib/decidim/generators/component_templates/config/locales/en.yml.erb

@@ -0,0 +1,6 @@
+---
+en:
+  decidim:
+    components:
+      <%= component_name %>:
+        name: <%= component_module_name %>

data/lib/decidim/generators/component_templates/decidim-component.gemspec.erb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require "decidim/<%= component_name %>/version"
+
+Gem::Specification.new do |s|
+  s.version = Decidim::<%= component_module_name %>.version
+  s.authors = ["<%= %x[git config user.name].chomp %>"]
+  s.email = ["<%= %x[git config user.email].chomp %>"]
+  s.license = "AGPL-3.0"
+  s.homepage = "https://github.com/decidim/decidim-module-<%= component_name %>"
+  s.required_ruby_version = ">= 2.3.1"
+
+  s.name = "decidim-<%= component_name %>"
+  s.summary = "A decidim <%= component_name %> module"
+  s.description = "<%= component_description %>."
+
+  s.files = Dir["{app,config,lib}/**/*", "LICENSE-AGPLv3.txt", "Rakefile", "README.md"]
+
+  s.add_dependency "decidim-core", Decidim::<%= component_module_name %>.version
+end

data/lib/decidim/generators/component_templates/lib/decidim/component.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/<%= component_name %>/admin"
+require "decidim/<%= component_name %>/engine"
+require "decidim/<%= component_name %>/admin_engine"
+require "decidim/<%= component_name %>/component"
+
+module Decidim
+  # This namespace holds the logic of the `<%= component_module_name %>` component. This component
+  # allows users to create <%= component_name %> in a participatory space.
+  module <%= component_module_name %>
+  end
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/admin.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    # This module contains all the domain logic associated to Decidim's <%= component_module_name %>
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/admin_engine.rb.erb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    # This is the engine that runs on the public interface of `<%= component_module_name %>`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::<%= component_module_name %>::Admin
+
+      paths["db/migrate"] = nil
+
+      routes do
+        # Add admin engine routes here
+        # resources :<%= component_name %> do
+        #   collection do
+        #     resources :exports, only: [:create]
+        #   end
+        # end
+        # root to: "<%= component_name %>#index"
+      end
+
+      initializer "decidim_<%= component_name %>.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.admin_abilities += ["Decidim::<%= component_module_name %>::Abilities::Admin::AdminAbility"]
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/component.rb.erb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/components/namer"
+
+Decidim.register_component(:<%= component_name %>) do |component|
+  component.engine = Decidim::<%= component_module_name %>::Engine
+  component.admin_engine = Decidim::<%= component_module_name %>::AdminEngine
+  component.icon = "decidim/<%= component_name %>/icon.svg"
+
+  # component.on(:before_destroy) do |instance|
+  #   # Code executed before removing the component
+  # end
+
+  # These actions permissions can be configured in the admin panel
+  # component.actions = %w()
+
+  # component.settings(:global) do |settings|
+  #   # Add your global settings
+  #   # Available types: :integer, :boolean
+  #   # settings.attribute :vote_limit, type: :integer, default: 0
+  # end
+
+  # component.settings(:step) do |settings|
+  #   # Add your settings per step
+  # end
+
+  # component.register_resource do |resource|
+  #   # Register a optional resource that can be references from other resources.
+  #   resource.model_class_name = "Decidim::<%= component_module_name %>::SomeResource"
+  #   resource.template = "decidim/<%= component_name %>/some_resources/linked_some_resources"
+  # end
+
+  # component.register_stat :some_stat do |context, start_at, end_at|
+  #   # Register some stat number to the application
+  # end
+
+  # component.seeds do |participatory_space|
+  #   # Add some seeds for this component
+  # end
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/engine.rb.erb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module <%= component_module_name %>
+    # This is the engine that runs on the public interface of <%= component_name %>.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::<%= component_module_name %>
+
+      routes do
+        # Add engine routes here
+        # resources :<%= component_name %>
+        # root to: "<%= component_name %>#index"
+      end
+
+      initializer "decidim_<%= component_name %>.assets" do |app|
+        app.config.assets.precompile += %w[decidim_<%= component_name %>_manifest.js decidim_<%= component_name %>_manifest.css]
+      end
+
+      initializer "decidim_<%= component_name %>.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.abilities += ["Decidim::<%= component_module_name %>::Abilities::CurrentUserAbility"]
+        end
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/test/factories.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :<%= component_name %>_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :<%= component_name %>).i18n_name }
+    manifest_name :<%= component_name %>
+    participatory_space { create(:participatory_process, :with_steps) }
+  end
+
+  # Add engine factories here
+end

data/lib/decidim/generators/component_templates/lib/decidim/component/version.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-meetings version.
+  module <%= component_module_name %>
+    def self.version
+      "<%= core_version %>"
+    end
+  end
+end

data/lib/decidim/generators/component_templates/spec/factories.rb.erb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/<%= component_name %>/test/factories"

data/lib/decidim/generators/component_templates/spec/spec_helper.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/dev"
+
+ENV["ENGINE_NAME"] = File.dirname(__dir__).split("/").last
+
+<%- if options[:external] -%>
+Decidim::Dev.dummy_app_path = File.expand_path(File.join("spec", "decidim_dummy_app"))
+<%- else -%>
+Decidim::Dev.dummy_app_path = File.expand_path(File.join("..", "spec", "decidim_dummy_app"))
+<%- end -%>
+
+require "decidim/dev/test/base_spec_helper"

data/lib/decidim/generators/install_generator.rb

@@ -0,0 +1,170 @@
+# 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("app_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
+        copy_file "carrierwave.rb", "config/initializers/carrierwave.rb"
+        copy_file "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 disable_precompilation_on_demand
+        %w(development test).each do |environment|
+          inject_into_file "config/environments/#{environment}.rb",
+                           before: /^end$/ do
+            cut <<~RUBY, strip: false
+              |
+              |  # No precompilation on demand on first request
+              |  config.assets.check_precompiled_asset = false
+            RUBY
+          end
+        end
+      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"
+
+        # In order to ensure that migrations don't eager load models with not
+        # yet fully populated schemas (which could break commands which load
+        # migrations and seeds in the same process, such as `rails db:migrate
+        # db:seed`), we make sure to run them in the same process if seeds are
+        # requested so that we can catch these situations earlier than end
+        # users.
+        if options[:seed_db]
+          rails "db:migrate", "db:seed"
+        else
+          rails "db:migrate"
+        end
+
+        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, strip: true)
+        cutted = text.gsub(/^ *\|/, "")
+        return cutted unless strip
+
+        cutted.rstrip
+      end
+    end
+  end
+end