dry-web-roda 0.6.0 → 0.6.1

data/lib/dry/web/roda/skeletons/flat_project/system/__underscored_app_name__/container.rb.tt

@@ -0,0 +1,23 @@
+require "dry/web/umbrella"
+require_relative "settings"
+
+module <%= config[:camel_cased_app_name] %>
+  class Container < Dry::Web::Umbrella
+    configure do
+      config.name = :<%= config[:underscored_app_name] %>
+      config.default_namespace = "<%= config[:underscored_app_name] %>"
+      config.settings_loader = <%= config[:camel_cased_app_name] %>::Settings
+      config.listeners = true
+
+      config.auto_register = %w[
+        lib/<%= config[:underscored_app_name] %>
+      ]
+    end
+
+    load_paths! "lib", "system"
+
+    def self.settings
+      config.settings
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/flat_project/system/__underscored_app_name__/transactions.rb.tt

@@ -0,0 +1,34 @@
+require "dry-configurable"
+require "dry-transaction"
+require "<%= config[:underscored_app_name] %>/container"
+
+module <%= config[:camel_cased_app_name] %>
+  class Transactions
+    extend Dry::Configurable
+
+    attr_reader :options
+
+    setting :container, <%= config[:camel_cased_app_name] %>::Container
+    setting :options, {}
+
+    def self.define(&block)
+      yield(new(options))
+    end
+
+    def self.options
+      {container: config.container}.merge(config.options)
+    end
+
+    def initialize(options)
+      @options = options
+    end
+
+    def container
+      options[:container]
+    end
+
+    def define(name, &block)
+      container.register(name, Dry.Transaction(options, &block))
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/flat_project/system/boot.rb.tt

@@ -0,0 +1,11 @@
+require "byebug" if ENV["RACK_ENV"] == "development"
+require "pry" if ENV["RACK_ENV"] == "development"
+
+require_relative "<%= config[:underscored_app_name] %>/container"
+
+<%= config[:camel_cased_app_name] %>::Container.finalize!
+
+require "<%= config[:underscored_app_name] %>/application"
+
+require "<%= config[:underscored_app_name] %>/transactions"
+<%= config[:camel_cased_app_name] %>::Container.require "transactions/**/*.rb"

data/lib/dry/web/roda/skeletons/flat_project/system/boot/monitor.rb.tt

@@ -0,0 +1,10 @@
+<%= config[:camel_cased_app_name] %>::Container.finalize :monitor do |_container|
+  init do
+    require "dry/monitor"
+    require "rom/instrumentation"
+  end
+
+  start do
+    Dry::Monitor::SQL::Logger.new(logger).subscribe(notifications)
+  end
+end

data/lib/dry/web/roda/skeletons/flat_project/transactions/example.rb.tt

@@ -0,0 +1,10 @@
+require "<%= config[:underscored_app_name] %>/transactions"
+
+<%= config[:camel_cased_app_name] %>::Transactions.define do |t|
+  # Define your dry-transaction objects here:
+  #
+  # t.define "transactions.users.sign_up" do
+  #   step :persist, with: "users.operations.sign_up"
+  #   # other steps here
+  # end
+end

data/lib/dry/web/roda/skeletons/sub_app/lib/__underscored_app_name__/views/welcome.rb.tt

@@ -0,0 +1,11 @@
+require "<%= config[:underscored_app_name] %>/view_controller"
+
+module <%= config[:camel_cased_app_name] %>
+  module Views
+    class Welcome < <%= config[:camel_cased_app_name] %>::ViewController
+      configure do |config|
+        config.template = "welcome"
+      end
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/{app → sub_app}/system/__underscored_app_name__/application.rb.tt

@@ -4,8 +4,8 @@ require_relative "container"
 module <%= config[:camel_cased_app_name] %>
   class Application < Dry::Web::Roda::Application
     configure do |config|
-      config.routes = "web/routes".freeze
       config.container = Container
+      config.routes = "web/routes".freeze
     end
 
     opts[:root] = Pathname(__FILE__).join("../..").realpath.dirname

data/lib/dry/web/roda/skeletons/{app → sub_app}/system/__underscored_app_name__/container.rb.tt

@@ -9,6 +9,8 @@ module <%= config[:camel_cased_app_name] %>
     configure do |config|
       config.root = Pathname(__FILE__).join("../..").realpath.dirname.freeze
 
+      config.logger = <%= config[:camel_cased_umbrella_name] %>::Container[:logger]
+
       config.default_namespace = "<%= config[:underscored_app_name] %>"
 
       config.auto_register = %w[

data/lib/dry/web/roda/skeletons/sub_app/system/__underscored_app_name__/view_controller.rb.tt

@@ -0,0 +1,13 @@
+require "slim"
+require "dry-view"
+require "<%= config[:underscored_app_name] %>/container"
+
+module <%= config[:camel_cased_app_name] %>
+  class ViewController < Dry::View::Controller
+    configure do |config|
+      config.paths = [Container.root.join("web/templates")]
+      config.context = Container["view_context"]
+      config.layout = "application"
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/{app → sub_app}/system/boot.rb.tt

@@ -1,7 +1,6 @@
 require_relative "<%= config[:underscored_app_name] %>/container"
 
-<%= config[:camel_cased_app_name] %>::Container.finalize! do |container|
-end
+<%= config[:camel_cased_app_name] %>::Container.finalize!
 
 require "<%= config[:underscored_app_name] %>/application"
 require "<%= config[:underscored_app_name] %>/transactions"

data/lib/dry/web/roda/skeletons/sub_app/system/boot/view.rb.tt

@@ -0,0 +1,3 @@
+require "<%= config[:underscored_app_name] %>/view_context"
+
+<%= config[:camel_cased_app_name] %>::Container.register "view_context", <%= config[:camel_cased_app_name] %>::ViewContext.new

data/lib/dry/web/roda/skeletons/sub_app/web/routes/example.rb.tt

@@ -0,0 +1,7 @@
+# Define your routes like this:
+#
+# class <%= config[:camel_cased_app_name] %>::Application
+#   route "example" do |r|
+#     # Routes go here
+#   end
+# end

data/lib/dry/web/roda/skeletons/sub_app/web/templates/layouts/application.html.slim

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

data/lib/dry/web/roda/skeletons/sub_app/web/templates/welcome.html.slim

@@ -0,0 +1 @@
+h1 Welcome to dry-web-roda!

data/lib/dry/web/roda/skeletons/umbrella_project/Gemfile

@@ -0,0 +1,39 @@
+source "https://rubygems.org"
+
+gem "rake"
+
+# Web framework
+gem "dry-web", ">= 0.6.0"
+gem "dry-web-roda", ">= 0.6.0"
+gem "puma"
+gem "rack_csrf"
+
+gem "rack", ">= 2.0"
+gem "shotgun", ">= 0.9.2"
+
+# Database persistence
+gem "pg"
+gem "rom-repository"
+gem "rom-sql"
+
+# Application dependencies
+gem "dry-matcher"
+gem "dry-monads"
+gem "dry-struct"
+gem "dry-transaction"
+gem "dry-types"
+gem "dry-validation"
+gem "dry-view", ">= 0.2.2"
+gem "slim"
+
+group :development, :test do
+  gem "pry-byebug", platform: :mri
+end
+
+group :test do
+  gem "capybara"
+  gem "capybara-screenshot"
+  gem "database_cleaner"
+  gem "poltergeist"
+  gem "rspec"
+end

data/lib/dry/web/roda/skeletons/umbrella_project/README.md.tt

@@ -0,0 +1,12 @@
+# <%= config[:camel_cased_app_name] %>
+
+Welcome! You’ve generated an app using dry-web-roda.
+
+## First steps
+
+1. Run `bundle`
+1. Review `config/settings.yml` (and make a copy at `config/settings.example.yml` if you want to keep example settings checked in)
+1. Create a `<%= config[:underscored_app_name] %>_development` database
+1. Add your own steps to `bin/setup`
+1. Run the app with `bundle exec shotgun -p 3000 -o 0.0.0.0 config.ru`
+1. Initialize git with `git init` and make your initial commit

data/lib/dry/web/roda/skeletons/umbrella_project/Rakefile.tt

@@ -0,0 +1,81 @@
+require "bundler/setup"
+
+require "byebug" unless ENV["RACK_ENV"] == "production"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new :spec
+  task default: [:spec]
+rescue LoadError
+end
+
+require_relative "system/<%= config[:underscored_app_name] %>/container"
+
+require "rom/sql/rake_task"
+require "sequel"
+namespace :db do
+  task :setup do
+    <%= config[:camel_cased_app_name] %>::Container.boot! :rom
+  end
+
+  # The following migration tasks are adapted from https://gist.github.com/kalmbach/4471560
+  Sequel.extension :migration
+  DB = Sequel.connect(<%= config[:camel_cased_app_name] %>::Container.settings.database_url)
+
+  desc "Prints current schema version"
+  task :version do
+    version = if DB.tables.include?(:schema_migrations)
+      DB[:schema_migrations].order(:filename).last[:filename]
+    end || "not available"
+
+    puts "Current schema version: #{version}"
+  end
+
+  namespace :structure do
+    desc "Dump database structure to db/structure.sql"
+    task :dump do
+      require "uri"
+      uri = URI(DB.url)
+
+      dump = `pg_dump -h #{uri.hostname} -s -x -O #{uri.path.tr("/", "")}`
+      File.open "db/structure.sql", "w" do |file|
+        file.write dump
+      end
+    end
+  end
+
+  task :check_migrations_exist do
+    unless Dir["db/migrate/*.rb"].any?
+      puts "No migrations found"
+      exit 1
+    end
+  end
+
+  # Enhance the migration task provided by ROM
+  desc "Perform migration up to latest migration available"
+  task :migrate => [:check_migrations_exist] do
+    # Once db:migrate finishes, dump the db structure:
+    Rake::Task["db:structure:dump"].execute
+
+    # And print the current migration version:
+    Rake::Task["db:version"].execute
+  end
+
+  desc "Perform rollback to specified target"
+  task :rollback, :target do |t, args|
+    Sequel::Migrator.run(DB, "db/migrate", :target => args[:target].to_i)
+    Rake::Task["db:version"].execute
+  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/roda/skeletons/umbrella_project/bin/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/roda/skeletons/umbrella_project/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+APP_ROOT = File.expand_path("../../", __FILE__)
+
+Dir.chdir(APP_ROOT) do
+  # Set up your app for development here
+end

data/lib/dry/web/roda/skeletons/umbrella_project/config.ru.tt

@@ -0,0 +1,2 @@
+require_relative "system/boot"
+run <%= config[:camel_cased_app_name] %>::Application.freeze.app

data/lib/dry/web/roda/skeletons/umbrella_project/config/settings.yml.tt

@@ -0,0 +1,8 @@
+development: &base
+  database_url: 'postgres://localhost/<%= config[:underscored_app_name] %>_development'
+  session_secret: '<%= SecureRandom.hex %>'
+test:
+  <<: *base
+  database_url: 'postgres://localhost/<%= config[:underscored_app_name] %>_test'
+production:
+  <<: *base

data/lib/dry/web/roda/skeletons/umbrella_project/db/sample_data.rb

@@ -0,0 +1 @@
+# Build your sample data here

data/lib/dry/web/roda/skeletons/umbrella_project/db/seed.rb

@@ -0,0 +1 @@
+# Build your seed data here

data/lib/dry/web/roda/skeletons/umbrella_project/lib/__underscored_app_name__/repository.rb.tt

@@ -0,0 +1,11 @@
+require "rom-repository"
+require "<%= config[:underscored_app_name] %>/container"
+require "<%= config[:underscored_app_name] %>/import"
+
+<%= config[:camel_cased_app_name] %>::Container.boot! :rom
+
+module <%= config[:camel_cased_app_name] %>
+  class Repository < ROM::Repository::Root
+    include <%= config[:camel_cased_app_name] %>::Import.args["persistence.rom"]
+  end
+end

data/lib/dry/web/roda/skeletons/umbrella_project/lib/__underscored_app_name__/view_context.rb.tt

@@ -0,0 +1,39 @@
+module <%= config[:camel_cased_app_name] %>
+  class ViewContext
+    attr_reader :attrs
+
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+
+    def csrf_token
+      self[:csrf_token]
+    end
+
+    def csrf_metatag
+      self[:csrf_metatag]
+    end
+
+    def csrf_tag
+      self[:csrf_tag]
+    end
+
+    def flash
+      self[:flash]
+    end
+
+    def flash?
+      %i[notice alert].any? { |type| flash[type] }
+    end
+
+    def with(new_attrs)
+      self.class.new(attrs.merge(new_attrs))
+    end
+
+    private
+
+    def [](name)
+      attrs.fetch(name)
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/umbrella_project/lib/rom/instrumentation.rb.tt

@@ -0,0 +1,22 @@
+require "rom-sql"
+
+module ROM
+  class Relation
+    # Monkey patch ROM::SQL to support query logs until an official API is available
+    module Instrumentation
+      def self.included(klass)
+        klass.option :notifications, reader: true, optional: false, default: proc {
+          <%= config[:camel_cased_app_name] %>::Container[:notifications]
+        }
+      end
+
+      def to_a
+        notifications.instrument(:sql, name: name.relation, query: dataset.sql) do
+          super
+        end
+      end
+    end
+
+    SQL::Relation.include(Instrumentation)
+  end
+end