dry-web-roda 0.6.3 → 0.7.0

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

@@ -1,36 +1,27 @@
 require "securerandom"
-require "dry/web/roda/generate"
-require "dry/web/roda/generators/inflections"
+require "dry/web/roda/generators/abstract_project"
 require "dry/web/roda/generators/sub_app"
 
 module Dry
   module Web
     module Roda
       module Generators
-        class UmbrellaProject
-          attr_reader :generate, :sub_app_generator
+        class UmbrellaProject < AbstractProject
+          private
 
-          def initialize
-            @generate = Generate.new("umbrella_project")
-            @sub_app_generator = Generators::SubApp.new
+          def add_boot
+            add_template("umbrella_project/boot.rb.tt", "system/boot.rb")
           end
 
-          def call(target_dir)
-            generate.(target_dir, prepare_scope(target_dir))
+          def add_application
+            add_template("umbrella_project/application.rb.tt", "system/#{underscored_project_name}/application.rb")
+          end
 
+          def post_process_callback
             Dir.chdir(target_dir) do
-              sub_app_generator.("main", umbrella: target_dir)
+              Generators::SubApp.new("main", umbrella: target_dir).call
             end
           end
-
-          private
-
-          def prepare_scope(target_dir)
-            {
-              underscored_app_name: Inflections.underscored_name(target_dir),
-              camel_cased_app_name: Inflections.camel_cased_name(target_dir)
-            }
-          end
         end
       end
     end

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

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

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

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

data/lib/dry/web/roda/templates/.gitignore

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

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

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

data/lib/dry/web/roda/{skeletons/flat_project → templates}/Gemfile

@@ -3,7 +3,8 @@ source "https://rubygems.org"
 gem "rake"
 
 # Web framework
-gem "dry-web", ">= 0.6.0"
+gem "dry-system", ">= 0.7.1"
+gem "dry-web", ">= 0.7.0"
 gem "dry-web-roda", ">= 0.6.0"
 gem "puma"
 gem "rack_csrf"
@@ -21,10 +22,10 @@ gem "rom-sql", ">= 1.1.0"
 gem "dry-matcher"
 gem "dry-monads"
 gem "dry-struct"
-gem "dry-transaction"
+gem "dry-transaction", ">= 0.10.0"
 gem "dry-types"
 gem "dry-validation"
-gem "dry-view", ">= 0.2.2"
+gem "dry-view", ">= 0.3.0"
 gem "slim"
 
 group :development, :test do

data/lib/dry/web/roda/{skeletons/umbrella_project → templates}/README.md.tt

@@ -5,8 +5,8 @@ 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. Review `.env` & `.env.test` (and make a copy to e.g. `.example.env` if you want example settings checked in)
+1. Create a `blog_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/templates/Rakefile.tt

@@ -0,0 +1,66 @@
+require "bundler/setup"
+require "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
+
+namespace :db do
+  task :setup do
+    <%= config[:camel_cased_app_name] %>::Container.boot :rom
+  end
+
+  desc "Prints current 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 "Perform migration 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)
+        system(%(pg_dump -s -x -O #{Shellwords.escape(db.url)} > db/structure.sql))
+      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/roda/templates/boot__settings.rb.tt

@@ -0,0 +1,10 @@
+<%= config[:camel_cased_app_name] %>::Container.finalize :settings do |container|
+  init do
+    require "<%= config[:underscored_project_name] %>/settings"
+  end
+
+  start do
+    settings = <%= config[:camel_cased_app_name] %>::Settings.load(container.config.root, container.config.env)
+    container.register "settings", settings
+  end
+end

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

@@ -0,0 +1,14 @@
+require "dry/web/container"
+
+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/roda/{skeletons/flat_project/system/__underscored_app_name__ → templates/flat_project}/application.rb.tt

@@ -10,7 +10,7 @@ module <%= config[:camel_cased_app_name] %>
 
     opts[:root] = Pathname(__FILE__).join("../..").realpath.dirname
 
-    use Rack::Session::Cookie, key: "<%= config[:underscored_app_name] %>.session", secret: <%= config[:camel_cased_app_name] %>::Container.settings.session_secret
+    use Rack::Session::Cookie, key: "<%= config[:underscored_project_name] %>.session", secret: self["settings"].session_secret
 
     plugin :csrf, raise: true
     plugin :flash
@@ -24,6 +24,11 @@ module <%= config[:camel_cased_app_name] %>
       end
     end
 
+    error do |e|
+      self.class[:rack_monitor].instrument(:error, exception: e)
+      raise e
+    end
+
     load_routes!
   end
 end

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

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

data/lib/dry/web/roda/templates/operation.rb.tt

@@ -0,0 +1,9 @@
+# auto_register: false
+
+require "dry/transaction/operation"
+
+module <%= config[:camel_cased_app_name] %>
+  class Operation
+    include Dry::Transaction::Operation
+  end
+end

data/lib/dry/web/roda/{skeletons/flat_project/system/__underscored_app_name__ → templates}/repository.rb.tt

@@ -1,6 +1,8 @@
+# auto_register: false
+
 require "rom-repository"
-require "<%= config[:underscored_app_name] %>/container"
-require "<%= config[:underscored_app_name] %>/import"
+require "<%= config[:underscored_project_name] %>/container"
+require "<%= config[:underscored_project_name] %>/import"
 
 <%= config[:camel_cased_app_name] %>::Container.boot! :rom
 

data/lib/dry/web/roda/templates/rom.rb.tt

@@ -0,0 +1,39 @@
+<%= config[:camel_cased_app_name] %>::Container.namespace "persistence" do |container|
+  container.finalize :rom do
+    init do
+      require "sequel"
+      require "rom"
+      require "rom/sql"
+
+      use :settings
+      use :monitor
+
+      ROM::SQL.load_extensions :postgres
+
+      Sequel.database_timezone = :utc
+      Sequel.application_timezone = :local
+
+      rom_config = ROM::Configuration.new(
+        :sql,
+        container["settings"].database_url,
+        extensions: %i[error_sql pg_array pg_json],
+      )
+
+      rom_config.plugin :sql, relations: :instrumentation do |plugin_config|
+        plugin_config.notifications = notifications
+      end
+
+      rom_config.plugin :sql, relations: :auto_restrictions
+
+      container.register "config", rom_config
+      container.register "db", rom_config.gateways[:default].connection
+    end
+
+    start do
+      config = container["persistence.config"]
+      config.auto_registration container.root.join("lib/persistence")
+
+      container.register "rom", ROM.container(config)
+    end
+  end
+end

data/lib/dry/web/roda/templates/settings.rb.tt

@@ -0,0 +1,9 @@
+require "dry/web/settings"
+require "types"
+
+module <%= config[:camel_cased_app_name] %>
+  class Settings < Dry::Web::Settings
+    setting :database_url, Types::Strict::String.constrained(filled: true)
+    setting :session_secret, Types::Strict::String.constrained(filled: true)
+  end
+end

data/lib/dry/web/roda/{skeletons/umbrella_project/spec/db_helper.rb.tt → templates/spec/db_spec_helper.rb.tt}

@@ -6,11 +6,10 @@ Dir[SPEC_ROOT.join("support/db/*.rb").to_s].each(&method(:require))
 Dir[SPEC_ROOT.join("shared/db/*.rb").to_s].each(&method(:require))
 
 require "database_cleaner"
-DatabaseCleaner[:sequel, connection: TestHelpers.db_connection].strategy = :truncation
+DatabaseCleaner[:sequel, connection: Test::DatabaseHelpers.db].strategy = :truncation
 
 RSpec.configure do |config|
-  config.include TestHelpers
-  config.include TestFactories
+  config.include Test::DatabaseHelpers
 
   config.before :suite do
     DatabaseCleaner.clean_with :truncation

data/lib/dry/web/roda/templates/spec/factories/example.rb

@@ -0,0 +1,9 @@
+# Define your factories here, e.g.
+#
+# Factory.define :article do |f|
+#   f.sequence(:slug) { |i| "article-#{i}" }
+#   f.title { fake(:lorem, :words, 5) }
+#   f.body { fake(:lorem, :paragraphs, 1) }
+# end
+#
+# See https://github.com/rom-rb/rom-factory for more.

data/lib/dry/web/roda/{skeletons/flat_project → templates}/spec/spec_helper.rb.tt

@@ -7,7 +7,7 @@ SPEC_ROOT = Pathname(__FILE__).dirname
 Dir[SPEC_ROOT.join("support/*.rb").to_s].each(&method(:require))
 Dir[SPEC_ROOT.join("shared/*.rb").to_s].each(&method(:require))
 
-require SPEC_ROOT.join("../system/<%= config[:underscored_app_name] %>/container")
+require SPEC_ROOT.join("../system/<%= config[:underscored_project_name] %>/container")
 
 RSpec.configure do |config|
   config.disable_monkey_patching!

data/lib/dry/web/roda/templates/spec/support/db/factory.rb

@@ -0,0 +1,8 @@
+require "rom-factory"
+require_relative "helpers"
+
+Factory = ROM::Factory.configure do |config|
+  config.rom = Test::DatabaseHelpers.rom
+end
+
+Dir[Pathname(__FILE__).dirname.join("../../factories/**/*.rb")].each(&method(:require))

data/lib/dry/web/roda/templates/spec/support/db/helpers.rb.tt

@@ -0,0 +1,13 @@
+module Test
+  module DatabaseHelpers
+    module_function
+
+    def rom
+      <%= config[:camel_cased_app_name] %>::Container["persistence.rom"]
+    end
+
+    def db
+      <%= config[:camel_cased_app_name] %>::Container["persistence.db"]
+    end
+  end
+end

data/lib/dry/web/roda/templates/spec/support/web/helpers.rb.tt

@@ -0,0 +1,9 @@
+module Test
+  module WebHelpers
+    module_function
+
+    def app
+      <%= config[:camel_cased_app_name] %>::Container::Application.app
+    end
+  end
+end

data/lib/dry/web/roda/{skeletons/umbrella_project/spec/app_helper.rb → templates/spec/web_spec_helper.rb}

@@ -1,16 +1,16 @@
-require_relative "db_helper"
+require_relative "db_spec_helper"
 
 require "rack/test"
 require "capybara/rspec"
 require "capybara-screenshot/rspec"
 require "capybara/poltergeist"
 
-Dir[SPEC_ROOT.join("support/app/*.rb").to_s].each(&method(:require))
-Dir[SPEC_ROOT.join("shared/app/*.rb").to_s].each(&method(:require))
+Dir[SPEC_ROOT.join("support/web/*.rb").to_s].each(&method(:require))
+Dir[SPEC_ROOT.join("shared/web/*.rb").to_s].each(&method(:require))
 
 require SPEC_ROOT.join("../system/boot").realpath
 
-Capybara.app = TestHelpers.app
+Capybara.app = Test::WebHelpers.app
 Capybara.server_port = 3001
 Capybara.save_and_open_page_path = "#{File.dirname(__FILE__)}/../tmp/capybara-screenshot"
 Capybara.javascript_driver = :poltergeist
@@ -21,15 +21,17 @@ Capybara.register_driver :poltergeist do |app|
     app,
     js_errors: false,
     phantomjs_logger: File.open(SPEC_ROOT.join("../log/phantomjs.log"), "w"),
-    phantomjs_options: %w(--load-images=no)
+    phantomjs_options: %w(--load-images=no),
+    window_size: [1600, 768],
   )
 end
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods, type: :request
   config.include Rack::Test::Methods, Capybara::DSL, type: :feature
+  config.include Test::WebHelpers
 
   config.before :suite do
-    TestHelpers.app.freeze
+    Test::WebHelpers.app.freeze
   end
 end