decidim-generators 0.11.0.pre1

data/README.md

@@ -0,0 +1,76 @@
+# Decidim::Generators
+
+This gem provides several generators to create decidim applications & components
+
+## Installation
+
+```console
+gem install decidim-generators
+```
+
+## Usage
+
+### Generating decidim applications
+
+Use the command
+
+```console
+decidim my_new_application
+```
+
+to generate a fresh new decidim application.
+
+### Generating decidim components
+
+This repo helps you generating the scheleton of a decidim component. It will
+generate a folder with a plugin's code skeleton that you then need to properly
+require in your final decidim application in order to use it. To do that, you
+need to include the plugin in your application's `Gemfile`.
+
+For example, if you generated your component at
+`~/decidim-module-experimental_component`, you'll need to edit your `Gemfile` like
+this in order for the component to be used:
+
+```ruby
+gem "decidim-experimental_plugin", path: "~/decidim-module-experimental_plugin"
+```
+
+Once you do that, and boot your application, you'll see the new component being
+offered in the "New component" selector on the "Components" section of any
+participatory space in the admin dashboard.
+
+#### Generate a new component
+
+```console
+decidim --component my_component
+```
+
+#### Generate a new component in a specific folder
+
+You may do this when you want to point to an existing folder or give it a custom
+name.
+
+```console
+decidim --component my_component --destination_folder ../decidim-module-my_component
+```
+
+#### Generate a new component as a external plugin
+
+You may do this when your plugin is meant to live outside of decidim's core
+repo. The generated application has some particularities as opposed to a plugin
+living in the core repo. For example:
+
+* It has its own Gemfile.
+* The dummy application path is different.
+
+```console
+decidim --component my_component --external
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative "../lib/decidim/gem_manager"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Installs all gems locally."
+task :install_all do
+  Decidim::GemManager.run_all(
+    "gem build %name && mv %name-%version.gem ..",
+    include_root: false
+  )
+
+  Decidim::GemManager.new(File.expand_path("..", __dir__)).run(
+    "gem build %name && gem install *.gem"
+  )
+end
+
+desc "Uninstalls all gems locally."
+task :uninstall_all do
+  Decidim::GemManager.run_all(
+    "gem uninstall %name -v %version --executables --force"
+  )
+
+  Decidim::GemManager.new(File.expand_path("..", __dir__)).run(
+    "rm decidim-*.gem"
+  )
+end

data/exe/decidim

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+if ARGV[0] == "--component"
+  ARGV.replace(["component", *ARGV[1..-1]])
+
+  require "decidim/generators/component_generator"
+
+  Decidim::Generators::ComponentGenerator.start
+else
+  require "decidim/generators/app_generator"
+
+  Decidim::Generators::AppGenerator.start
+end

data/lib/decidim/generators/app_generator.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+require "decidim/generators/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
+        [
+          self.class.source_root,
+          Rails::Generators::AppGenerator.source_root
+        ]
+      end
+
+      source_root File.expand_path("app_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]
+
+        copy_file target_gemfile, "Gemfile", force: true
+        copy_file "#{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::Generators.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"
+        gsub_file "Gemfile", /gem "decidim-([A-z]+)".*/, "# gem \"decidim-\\1\", #{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
+        copy_file "initializer.rb", "config/initializers/decidim.rb"
+
+        copy_file "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
+                 root_path
+               end
+
+        File.join(root, "Gemfile")
+      end
+
+      def expanded_path
+        File.expand_path(options[:path])
+      end
+
+      def root_path
+        File.expand_path(File.join("..", "..", ".."), __dir__)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+# <%= 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/decidim/generators/app_templates/cable.yml.erb

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

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

@@ -0,0 +1,28 @@
+# 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/decidim/generators/app_templates/database.yml.erb

@@ -0,0 +1,87 @@
+# 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'] %>

data/lib/decidim/generators/app_templates/decidim.scss.erb

@@ -0,0 +1,3 @@
+<%= scss_variables %>
+
+@import "decidim/application";