dry-web-web_pipe 0.1.0

data/lib/dry/web/web_pipe/generators/abstract_generator.rb

@@ -0,0 +1,54 @@
+require "dry/web/web_pipe/generate"
+require "dry/web/web_pipe/generators/inflections"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        class AbstractGenerator
+          attr_reader :target_dir, :options
+
+          def initialize(target_dir, options = {})
+            @target_dir = target_dir
+            @options = options
+            @templates = []
+            populate_templates
+            @templates.freeze
+          end
+
+          def call
+            templates.each do |source, target|
+              generator.(source, target)
+            end
+            post_process_callback
+          end
+
+          private
+          attr_reader :templates
+
+          def add_template(source, target)
+            templates << [source, target]
+          end
+
+          def generator
+            @generator ||= Generate.new(destination, template_scope)
+          end
+
+          def post_process_callback; end
+
+          def underscored_project_name
+            @underscored_project_name ||= Inflections.underscored_name(target_dir)
+          end
+
+          def template_scope
+            fail NotImplementedError
+          end
+
+          def destination
+            fail NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/generators/abstract_project.rb

@@ -0,0 +1,116 @@
+require "securerandom"
+require "dry/web/web_pipe/generators/abstract_generator"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        class AbstractProject < AbstractGenerator
+          def populate_templates
+            add_bin
+            add_config
+            add_db
+            add_log
+            add_spec
+            add_lib
+            add_system
+            add_boot
+            add_application
+            add_config_files
+          end
+
+          private
+
+          def destination
+            target_dir
+          end
+
+          def template_scope
+            {
+              underscored_project_name: underscored_project_name,
+              camel_cased_app_name: Inflections.camel_cased_name(target_dir)
+            }
+          end
+
+          def add_bin
+            add_template('console.tt', 'bin/console')
+            add_template('setup', 'bin/setup')
+          end
+
+          def add_config
+            add_template('.env.tt', '.env')
+            add_template('.env.test.tt', '.env.test')
+          end
+
+          def add_db
+            add_template('sample_data.rb', 'db/sample_data.rb')
+            add_template('seed.rb', 'db/seed.rb')
+          end
+
+          def add_lib
+            add_template('types.rb', 'lib/types.rb')
+            add_template('operation.rb.tt', "lib/#{underscored_project_name}/operation.rb")
+            add_template('repository.rb.tt', "lib/#{underscored_project_name}/repository.rb")
+            add_template('.keep', 'lib/persistence/relations/.keep')
+            add_template('.keep', 'lib/persistence/commands/.keep')
+            add_template('view_context.rb.tt', "lib/#{underscored_project_name}/view_context.rb")
+            add_template('view.rb.tt', "lib/#{underscored_project_name}/view.rb")
+          end
+
+          def add_log
+            add_template('.keep', 'log/.keep')
+          end
+
+          def add_spec
+            add_template('.rspec', '.rspec')
+
+            # Base spec helpers
+            add_template('spec/web_spec_helper.rb', 'spec/web_spec_helper.rb')
+            add_template('spec/db_spec_helper.rb.tt', 'spec/db_spec_helper.rb')
+            add_template('spec/spec_helper.rb.tt', 'spec/spec_helper.rb')
+
+            # DB support
+            add_template('spec/support/db/factory.rb', 'spec/support/db/factory.rb')
+            add_template('spec/support/db/helpers.rb.tt', 'spec/support/db/helpers.rb')
+            add_template('spec/factories/example.rb', 'spec/factories/example.rb')
+
+            # Web support
+            add_template('spec/support/web/helpers.rb.tt', 'spec/support/web/helpers.rb')
+          end
+
+          def add_system
+            add_system_lib
+            add_system_boot
+          end
+
+          def add_boot
+            raise NotImplementedError
+          end
+
+          def add_application
+            raise NotImplementedError
+          end
+
+          def add_system_lib
+            add_template("container.rb.tt", "system/#{underscored_project_name}/container.rb")
+            add_template("import.rb.tt", "system/#{underscored_project_name}/import.rb")
+          end
+
+          def add_system_boot
+            add_template("monitor.rb.tt", "system/boot/monitor.rb")
+            add_template("persistence.rb.tt", "system/boot/persistence.rb")
+            add_template("settings.rb.tt", "system/boot/settings.rb")
+          end
+
+          def add_config_files
+            add_template('.gitignore.tt', '.gitignore')
+            add_template('Gemfile', 'Gemfile')
+            add_template('Rakefile.tt', 'Rakefile')
+            add_template('config.ru.tt', 'config.ru')
+            add_template('README.md.tt', 'README.md')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/generators/flat_project.rb

@@ -0,0 +1,43 @@
+require "securerandom"
+require "dry/web/web_pipe/generators/abstract_project"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        class FlatProject < AbstractProject
+          def populate_templates
+            super
+            add_views
+            add_actions
+            add_web
+          end
+
+          private
+
+          def add_boot
+            add_template("flat_project/boot.rb.tt", "system/boot.rb")
+          end
+
+          def add_application
+            add_template("flat_project/router.rb.tt", "system/#{underscored_project_name}/router.rb")
+          end
+
+          def add_views
+            add_template('welcome.rb.tt', "lib/#{underscored_project_name}/views/welcome.rb")
+          end
+
+          def add_actions
+            add_template('flat_project/web.rb.tt', "lib/#{underscored_project_name}/web.rb")
+            add_template('flat_project/root.rb.tt', "lib/#{underscored_project_name}/actions/root.rb")
+          end
+
+          def add_web
+            add_template('application.html.slim', 'web/templates/layouts/application.html.slim')
+            add_template('welcome.html.slim', 'web/templates/welcome.html.slim')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/generators/inflections.rb

@@ -0,0 +1,21 @@
+require "inflecto"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        module Inflections
+          module_function
+
+          def underscored_name(name)
+            Inflecto.underscore(name)
+          end
+
+          def camel_cased_name(name)
+            Inflecto.camelize(underscored_name(name))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/generators/sub_app.rb

@@ -0,0 +1,68 @@
+require "dry/web/web_pipe/generators/abstract_generator"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        class SubApp < AbstractGenerator
+          def populate_templates
+            add_lib
+            add_system
+            add_web
+          end
+
+          private
+
+          def destination
+            options.fetch(:to) { File.join("apps", target_dir) }
+          end
+
+          def umbrella_name
+            options.fetch(:umbrella)
+          end
+
+          def underscored_umbrella_name
+            Inflections.underscored_name(umbrella_name)
+          end
+
+          def lib_path
+            "lib/#{underscored_umbrella_name}/#{underscored_project_name}"
+          end
+
+          def system_lib_path
+            "system/#{underscored_umbrella_name}/#{underscored_project_name}"
+          end
+
+          def add_lib
+            add_template('subapp/web.rb.tt', "#{lib_path}/web.rb")
+            add_template('subapp/root.rb.tt', "#{lib_path}/actions/root.rb")
+            add_template('subapp/view_context.rb.tt', "#{lib_path}/view_context.rb")
+            add_template('subapp/view.rb.tt', "#{lib_path}/view.rb")
+            add_template('subapp/welcome.rb.tt', "#{lib_path}/views/welcome.rb")
+          end
+
+          def add_system
+            add_template("subapp/router.rb.tt", "#{system_lib_path}/router.rb")
+            add_template('subapp/container.rb.tt', "#{system_lib_path}/container.rb")
+            add_template('subapp/import.rb.tt', "#{system_lib_path}/import.rb")
+            add_template('subapp/boot.rb.tt', 'system/boot.rb')
+          end
+
+          def add_web
+            add_template('application.html.slim', 'web/templates/layouts/application.html.slim')
+            add_template('welcome.html.slim', 'web/templates/welcome.html.slim')
+          end
+
+          def template_scope
+            {
+              underscored_project_name: underscored_project_name,
+              camel_cased_app_name: Inflections.camel_cased_name(target_dir),
+              underscored_umbrella_name: underscored_umbrella_name,
+              camel_cased_umbrella_name: Inflections.camel_cased_name(umbrella_name),
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/generators/umbrella_project.rb

@@ -0,0 +1,29 @@
+require "securerandom"
+require "dry/web/web_pipe/generators/abstract_project"
+require "dry/web/web_pipe/generators/sub_app"
+
+module Dry
+  module Web
+    module WebPipe
+      module Generators
+        class UmbrellaProject < AbstractProject
+          private
+
+          def add_boot
+            add_template("umbrella_project/boot.rb.tt", "system/boot.rb")
+          end
+
+          def add_application
+            add_template("umbrella_project/router.rb.tt", "system/#{underscored_project_name}/router.rb")
+          end
+
+          def post_process_callback
+            Dir.chdir(target_dir) do
+              Generators::SubApp.new("main", umbrella: target_dir).call
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/templates/.env.test.tt

@@ -0,0 +1 @@
+DATABASE_URL='postgres://localhost/<%= config[:underscored_project_name] %>_test'

data/lib/dry/web/web_pipe/templates/.env.tt

@@ -0,0 +1,2 @@
+DATABASE_URL='postgres://localhost/<%= config[:underscored_project_name] %>_development'
+SESSION_SECRET='<%= SecureRandom.hex %>'

data/lib/dry/web/web_pipe/templates/.gitignore.tt

@@ -0,0 +1,11 @@
+# Ignore app settings (copy to .example.env.* to check in example files)
+/.env*
+
+# RSpec
+/spec/examples.txt
+
+# Logs
+/log/*.log
+
+# Temp files
+tmp/*

data/lib/dry/web/web_pipe/templates/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/dry/web/web_pipe/templates/Gemfile

@@ -0,0 +1,47 @@
+source "https://rubygems.org"
+
+gem "rake"
+
+# Web framework
+gem "dry-system", "~> 0.9"
+gem "dry-web", "~> 0.7"
+gem "dry-web-web_pipe", "~> 0.1"
+gem "puma"
+gem "rack_csrf"
+gem "hanami-router", "~> 1.3"
+gem "web_pipe", "~> 0.8"
+gem "rack-flash3", "~> 1.0"
+
+gem "rack", ">= 2.0"
+
+# Database persistence
+gem "pg"
+gem "rom", "~> 5.1"
+gem "rom-sql", "~> 3.0"
+
+# Application dependencies
+gem "dry-matcher", "~> 0.7"
+gem "dry-monads", "~> 1.2"
+gem "dry-struct", "~> 1.0"
+gem "dry-transaction", "~> 0.13"
+gem "dry-types", "~> 1.1"
+gem "dry-validation", "~> 1.0"
+gem "dry-view", "~> 0.7"
+gem "slim"
+
+group :development, :test do
+  gem "pry-byebug", platform: :mri
+end
+
+group :development do
+  gem "rerun"
+end
+
+group :test do
+  gem "capybara"
+  gem "capybara-screenshot"
+  gem "database_cleaner"
+  gem "poltergeist"
+  gem "rspec"
+  gem "rom-factory", "~> 0.5"
+end

data/lib/dry/web/web_pipe/templates/README.md.tt

@@ -0,0 +1,15 @@
+# <%= config[:camel_cased_app_name] %>
+
+Welcome! You’ve generated an app using dry-web-web_pipe.
+
+## First steps
+
+1. Run `bundle`
+2. Review `.env` & `.env.test` (and make a copy to e.g. `.example.env` if you want example settings checked in). In
+particular, ensure that your PostgreSQL username and password are specified in the `DATABASE_URL` variable as follows:
+`postgres://username:password@your_host/...`.
+3. Run `bundle exec rake db:create` to create the development database.
+4. Run `RACK_ENV=test bundle exec rake db:create` to create the test database.
+5. Add your own steps to `bin/setup`
+6. Run the app with `bundle exec rerun -- rackup --port 4000 config.ru`
+7. Initialize git with `git init` and make your initial commit

data/lib/dry/web/web_pipe/templates/Rakefile.tt

@@ -0,0 +1,109 @@
+require "bundler/setup"
+require "pry-byebug" unless ENV["RACK_ENV"] == "production"
+require "rom/sql/rake_task"
+require "shellwords"
+require_relative "system/<%= config[:underscored_project_name] %>/container"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new :spec
+  task default: [:spec]
+rescue LoadError
+end
+
+def db
+  <%= config[:camel_cased_app_name] %>::Container["persistence.db"]
+end
+
+def settings
+  <%= config[:camel_cased_app_name] %>::Container["settings"]
+end
+
+def database_uri
+  require "uri"
+  URI.parse(settings.database_url)
+end
+
+def postgres_env_vars(uri)
+  {}.tap do |vars|
+    vars["PGHOST"] = uri.host.to_s
+    vars["PGPORT"] = uri.port.to_s if uri.port
+    vars["PGUSER"] = uri.user.to_s if uri.user
+    vars["PGPASSWORD"] = uri.password.to_s if uri.password
+  end
+end
+
+namespace :db do
+  task :setup do
+    <%= config[:camel_cased_app_name] %>::Container.init :persistence
+  end
+
+  desc "Print current database schema version"
+  task version: :setup do
+    version =
+      if db.tables.include?(:schema_migrations)
+        db[:schema_migrations].order(:filename).last[:filename]
+      else
+        "not available"
+      end
+
+    puts "Current schema version: #{version}"
+  end
+
+  desc "Create database"
+  task :create do
+    if system("which createdb", out: File::NULL)
+      uri = database_uri
+      system(postgres_env_vars(uri), "createdb #{Shellwords.escape(uri.path[1..-1])}")
+    else
+      puts "You must have Postgres installed to create a database"
+      exit 1
+    end
+  end
+
+  desc "Drop database"
+  task :drop do
+    if system("which dropdb", out: File::NULL)
+      uri = database_uri
+      system(postgres_env_vars(uri), "dropdb #{Shellwords.escape(uri.path[1..-1])}")
+    else
+      puts "You must have Postgres installed to drop a database"
+      exit 1
+    end
+  end
+
+  desc "Migrate database up to latest migration available"
+  task :migrate do
+    # Enhance the migration task provided by ROM
+
+    # Once it finishes, dump the db structure
+    Rake::Task["db:structure:dump"].execute
+
+    # And print the current migration version
+    Rake::Task["db:version"].execute
+  end
+
+  namespace :structure do
+    desc "Dump database structure to db/structure.sql"
+    task :dump do
+      if system("which pg_dump", out: File::NULL)
+        uri = database_uri
+        system(postgres_env_vars(uri), "pg_dump -s -x -O #{Shellwords.escape(uri.path[1..-1])}", out: "db/structure.sql")
+      else
+        puts "You must have pg_dump installed to dump the database structure"
+      end
+    end
+  end
+
+  desc "Load seed data into the database"
+  task :seed do
+    seed_data = File.join("db", "seed.rb")
+    load(seed_data) if File.exist?(seed_data)
+  end
+
+  desc "Load a small, representative set of data so that the application can start in a useful state (for development)."
+  task :sample_data do
+    sample_data = File.join("db", "sample_data.rb")
+    load(sample_data) if File.exist?(sample_data)
+  end
+end

data/lib/dry/web/web_pipe/templates/application.html.slim

@@ -0,0 +1,3 @@
+html
+  body
+    == yield

data/lib/dry/web/web_pipe/templates/config.ru.tt

@@ -0,0 +1,7 @@
+require_relative "system/boot"
+
+# MethodOverride middleware has to be used at the router level, so that
+# `hanami-router` can be aware of it
+use Rack::MethodOverride
+
+run <%= config[:camel_cased_app_name] %>::ROUTER

data/lib/dry/web/web_pipe/templates/console.tt

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/web/console"
+require_relative "../system/boot"
+
+Dry::Web::Console.start

data/lib/dry/web/web_pipe/templates/container.rb.tt

@@ -0,0 +1,17 @@
+require "dry/web/container"
+require "dry/system/components"
+require 'dry-monitor'
+Dry::Monitor.load_extensions(:rack)
+
+module <%= config[:camel_cased_app_name] %>
+  class Container < Dry::Web::Container
+    configure do
+      config.name = :<%= config[:underscored_project_name] %>
+      config.listeners = true
+      config.default_namespace = "<%= config[:underscored_project_name] %>"
+      config.auto_register = %w[lib/<%= config[:underscored_project_name] %>]
+    end
+
+    load_paths! "lib"
+  end
+end

data/lib/dry/web/web_pipe/templates/flat_project/boot.rb.tt

@@ -0,0 +1,12 @@
+require "bundler/setup"
+
+begin
+  require "pry-byebug"
+rescue LoadError
+end
+
+require_relative "<%= config[:underscored_project_name] %>/container"
+
+<%= config[:camel_cased_app_name] %>::Container.finalize!
+
+require_relative "<%= config[:underscored_project_name] %>/router"

data/lib/dry/web/web_pipe/templates/flat_project/root.rb.tt

@@ -0,0 +1,16 @@
+require "web_pipe"
+require "<%= config[:underscored_project_name] %>/web"
+
+module <%= config[:camel_cased_app_name] %>
+  module Actions
+    class Root
+      include WebPipe
+
+      compose :web, Web.new
+
+      plug(:view) do |conn|
+        conn.view('views.welcome')
+      end
+    end
+  end
+end

data/lib/dry/web/web_pipe/templates/flat_project/router.rb.tt

@@ -0,0 +1,8 @@
+require "hanami/router"
+require "<%= config[:underscored_project_name] %>/container"
+
+module <%= config[:camel_cased_app_name] %>
+  ROUTER = Hanami::Router.new do
+    root to: Container["actions.root"]
+  end
+end

data/lib/dry/web/web_pipe/templates/flat_project/web.rb.tt

@@ -0,0 +1,52 @@
+require "web_pipe"
+require 'web_pipe/plugs/content_type'
+require "web_pipe/plugs/config"
+require "rack/csrf"
+require "rack/session/cookie"
+require 'rack-flash'
+require "<%= config[:underscored_project_name] %>/container"
+
+WebPipe.load_extensions(
+  :container,
+  :cookies,
+  :flash,
+  :dry_schema,
+  :dry_view,
+  :params,
+  :redirect,
+  :router_params,
+  :session,
+  :url
+)
+
+module <%= config[:camel_cased_app_name] %>
+  class Web
+    include WebPipe
+
+    use :cookies, Rack::Session::Cookie, key: "<%= config[:underscored_project_name] %>.session", secret: Container["settings"].session_secret
+    use :csrf, Rack::Csrf, raise: true
+    use :flash, Rack::Flash
+
+    plug :config, WebPipe::Plugs::Config.(
+      container: Container,
+
+      view_context: lambda do |conn|
+        {
+          flash: conn.flash,
+          csrf_token: Rack::Csrf.token(conn.env),
+          csrf_metatag: Rack::Csrf.metatag(conn.env),
+          csrf_tag: Rack::Csrf.tag(conn.env)
+        }
+      end,
+
+      sanitization_handler: lambda do |conn, result|
+        conn.
+          set_status(500).
+          set_response_body("Params #{conn.params} do not conform with the schema: #{result.errors.inspect}").
+          halt
+      end
+    )
+
+    plug :content_type, WebPipe::Plugs::ContentType.('text/html')
+  end
+end

data/lib/dry/web/web_pipe/templates/import.rb.tt

@@ -0,0 +1,5 @@
+require_relative "container"
+
+module <%= config[:camel_cased_app_name] %>
+  Import = <%= config[:camel_cased_app_name] %>::Container.injector
+end