dry-web-roda 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e348dfce9fa4b251b883b90b61878d6ceee1af35
-  data.tar.gz: 2cea77e0744f93b64bee61faae24f6369b213328
+  metadata.gz: d51d0133c498a3b101e824cbb91adfc1b7a87cfc
+  data.tar.gz: 747565954671456f454dcfb0e12e42ff5bc24565
 SHA512:
-  metadata.gz: 5cf1e0afb685e830f0a60a8516188939d744c3ba79c93da3983fe40229eebeb2e2c473880cd4cdc66d99d1394d37e46cb01cfc75e41c8914ca725c8c39078ec1
-  data.tar.gz: 4c01ed9ce85496b9daca4a8dfab49b377490017aec8ad4c8cf9020aca368a2fb25abe7c2df5671591ab3d78787a2e05cb2b88f0bcfa418ec6c58d2dfdc215746
+  metadata.gz: 61b414798d0270f2e71dd81e7d54a27ccecf272975f0e43e773a06ee064e74f5dfebb500733bf6e96f1fd723b2306f2e9925392f29f0571238554653e4a79ad9
+  data.tar.gz: fc6d2c99bc0af374820a297e4350fb0c60fe49df08c560ec1603ffc6a0949136b3d1cfa1cfee9352500ac2f8f30aa40777cda699fc718ff786224380c0045328

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 0.9.0 - 2017-10-27
+
+### Changed
+
+- `Dry::Web::Roda::Application` no longer automatically enables `error_handler` and `multi_route` Roda plugins (timriley)
+- `DryView` Roda plugin no longer automatically enables `csrf` and `flash` Roda plugins (timriley)
+- `DryView` Roda plugin no longer populates its `#view_context_options` with flash and CSRF data (timriley)
+
+In generated projects:
+
+- Nest sub-apps under the root project namespace (e.g. `MyApp::Main`) instead of keeping them at the top-level (`Main`) (timriley)
+- Rename `Dry::Web::Roda::Application` subclasses from `Application` to `Web` (timriley)
+- Comment out `r.multi_route` routing instruction in `Web` classes by default, to avoid future Roda exceptions (timriley)
+- Enable more Roda plugins (`csrf`, `error_handler`, `flash`, `multi_route`) directly in `Web` classes (timriley)
+- Add default implementation of `#view_context_options` to `Web` classes for `dry_view` Roda plugin  (timriley)
+
 # 0.8.0 - 2017-10-26
 
 ### Changed

data/lib/dry/web/roda/application.rb

@@ -11,9 +11,7 @@ module Dry
         setting :container, reader: true
         setting :routes
 
-        plugin :multi_route
         plugin :flow
-        plugin :error_handler
 
         def self.configure(&block)
           super.tap do

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

@@ -53,8 +53,8 @@ module Dry
             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_controller.rb.tt', "lib/#{underscored_project_name}/view/controller.rb")
+            add_template('view__context.rb.tt', "lib/#{underscored_project_name}/view/context.rb")
+            add_template('view__controller.rb.tt', "lib/#{underscored_project_name}/view/controller.rb")
           end
 
           def add_log

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

@@ -19,7 +19,7 @@ module Dry
           end
 
           def add_application
-            add_template("flat_project/application.rb.tt", "system/#{underscored_project_name}/application.rb")
+            add_template("flat_project/web.rb.tt", "system/#{underscored_project_name}/web.rb")
           end
 
           def add_views

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

@@ -21,22 +21,33 @@ module Dry
             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/view_context.rb.tt', "lib/#{underscored_project_name}/view/context.rb")
-            add_template('subapp/view_controller.rb.tt', "lib/#{underscored_project_name}/view/controller.rb")
-            add_template('welcome.rb.tt', "lib/#{underscored_project_name}/views/welcome.rb")
+            add_template('subapp/view__context.rb.tt', "#{lib_path}/view/context.rb")
+            add_template('subapp/view__controller.rb.tt', "#{lib_path}/view/controller.rb")
+            add_template('subapp/welcome.rb.tt', "#{lib_path}/views/welcome.rb")
           end
 
           def add_system
-            %w(application container).each do |file|
-              add_template("subapp/#{file}.rb.tt", "system/#{underscored_project_name}/#{file}.rb")
-            end
-            add_template('import.rb.tt', "system/#{underscored_project_name}/import.rb")
+            add_template('subapp/web.rb.tt', "#{system_lib_path}/web.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('example_routes.rb.tt', 'web/routes/example.rb')
+            add_template('subapp/example_routes.rb.tt', 'web/routes/example.rb')
             add_template('application.html.slim', 'web/templates/layouts/application.html.slim')
             add_template('welcome.html.slim', 'web/templates/welcome.html.slim')
           end
@@ -45,7 +56,7 @@ module Dry
             {
               underscored_project_name: underscored_project_name,
               camel_cased_app_name: Inflections.camel_cased_name(target_dir),
-              underscored_umbrella_name: Inflections.underscored_name(umbrella_name),
+              underscored_umbrella_name: underscored_umbrella_name,
               camel_cased_umbrella_name: Inflections.camel_cased_name(umbrella_name),
             }
           end

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

@@ -14,7 +14,7 @@ module Dry
           end
 
           def add_application
-            add_template("umbrella_project/application.rb.tt", "system/#{underscored_project_name}/application.rb")
+            add_template("umbrella_project/web.rb.tt", "system/#{underscored_project_name}/web.rb")
           end
 
           def post_process_callback

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

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

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

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

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

@@ -7,4 +7,4 @@ require_relative "<%= config[:underscored_project_name] %>/container"
 
 <%= config[:camel_cased_app_name] %>::Container.finalize!
 
-require "<%= config[:underscored_project_name] %>/application"
+require "<%= config[:underscored_project_name] %>/web"

data/lib/dry/web/roda/templates/flat_project/{application.rb.tt → web.rb.tt}

@@ -2,7 +2,7 @@ require "dry/web/roda/application"
 require_relative "container"
 
 module <%= config[:camel_cased_app_name] %>
-  class Application < Dry::Web::Roda::Application
+  class Web < Dry::Web::Roda::Application
     configure do |config|
       config.container = Container
       config.routes = "web/routes".freeze
@@ -13,11 +13,14 @@ module <%= config[:camel_cased_app_name] %>
     use Rack::Session::Cookie, key: "<%= config[:underscored_project_name] %>.session", secret: self["settings"].session_secret
 
     plugin :csrf, raise: true
-    plugin :flash
     plugin :dry_view
+    plugin :error_handler
+    plugin :flash
+    plugin :multi_route
 
     route do |r|
-      r.multi_route
+      # Enable this after writing your first web/routes/ file
+      # r.multi_route
 
       r.root do
         r.view "welcome"
@@ -29,6 +32,16 @@ module <%= config[:camel_cased_app_name] %>
       raise e
     end
 
+    # Request-specific options for dry-view context object
+    def view_context_options
+      {
+        flash:        flash,
+        csrf_token:   Rack::Csrf.token(request.env),
+        csrf_metatag: Rack::Csrf.metatag(request.env),
+        csrf_tag:     Rack::Csrf.tag(request.env),
+      }
+    end
+
     load_routes!
   end
 end

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

@@ -6,6 +6,6 @@ require "<%= config[:underscored_project_name] %>/import"
 
 module <%= config[:camel_cased_app_name] %>
   class Repository < ROM::Repository::Root
-    include <%= config[:camel_cased_app_name] %>::Import.args["persistence.rom"]
+    include Import.args["persistence.rom"]
   end
 end

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

@@ -3,7 +3,7 @@ module Test
     module_function
 
     def app
-      <%= config[:camel_cased_app_name] %>::Application.app
+      <%= config[:camel_cased_app_name] %>::Web.app
     end
   end
 end

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

@@ -1,5 +1,5 @@
-require_relative "<%= config[:underscored_project_name] %>/container"
+require_relative "<%= config[:underscored_umbrella_name] %>/<%= config[:underscored_project_name] %>/container"
 
-<%= config[:camel_cased_app_name] %>::Container.finalize!
+<%= config[:camel_cased_umbrella_name] %>::<%= config[:camel_cased_app_name] %>::Container.finalize!
 
-require "<%= config[:underscored_project_name] %>/application"
+require "<%= config[:underscored_umbrella_name] %>/<%= config[:underscored_project_name] %>/web"

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

@@ -2,18 +2,20 @@ require "pathname"
 require "dry/web/container"
 require "dry/system/components"
 
-module <%= config[:camel_cased_app_name] %>
-  class Container < Dry::Web::Container
-    require root.join("system/<%= config[:underscored_umbrella_name] %>/container")
-    import core: <%= config[:camel_cased_umbrella_name] %>::Container
+module <%= config[:camel_cased_umbrella_name] %>
+  module <%= config[:camel_cased_app_name] %>
+    class Container < Dry::Web::Container
+      require root.join("system/<%= config[:underscored_umbrella_name] %>/container")
+      import core: <%= config[:camel_cased_umbrella_name] %>::Container
 
-    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_project_name] %>"
-      config.auto_register = %w[lib/<%= config[:underscored_project_name] %>]
-    end
+      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_umbrella_name] %>.<%= config[:underscored_project_name] %>"
+        config.auto_register = %w[lib/<%= config[:underscored_umbrella_name] %>/<%= config[:underscored_project_name] %>]
+      end
 
-    load_paths! "lib"
+      load_paths! "lib"
+    end
   end
 end

data/lib/dry/web/roda/templates/subapp/example_routes.rb.tt

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

data/lib/dry/web/roda/templates/subapp/import.rb.tt

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

data/lib/dry/web/roda/templates/subapp/view__context.rb.tt

@@ -0,0 +1,10 @@
+require "<%= config[:underscored_umbrella_name] %>/view/context"
+
+module <%= config[:camel_cased_umbrella_name] %>
+  module <%= config[:camel_cased_app_name] %>
+    module View
+      class Context < <%= config[:camel_cased_umbrella_name] %>::View::Context
+      end
+    end
+  end
+end

data/lib/dry/web/roda/templates/subapp/view__controller.rb.tt

@@ -0,0 +1,19 @@
+# auto_register: false
+
+require "slim"
+require "dry/view/controller"
+require "<%= config[:underscored_umbrella_name] %>/<%= config[:underscored_project_name] %>/container"
+
+module <%= config[:camel_cased_umbrella_name] %>
+  module <%= config[:camel_cased_app_name] %>
+    module View
+      class Controller < Dry::View::Controller
+        configure do |config|
+          config.paths = [Container.root.join("web/templates")]
+          config.context = Container["view.context"]
+          config.layout = "application"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require "dry/web/roda/application"
+require_relative "container"
+
+module <%= config[:camel_cased_umbrella_name] %>
+  module <%= config[:camel_cased_app_name] %>
+    class Web < Dry::Web::Roda::Application
+      configure do |config|
+        config.container = Container
+        config.routes = "web/routes".freeze
+      end
+
+      opts[:root] = Pathname(__FILE__).join("../../..").realpath.dirname
+
+      use Rack::Session::Cookie, key: "<%= config[:underscored_umbrella_name] %>.<%= config[:underscored_project_name] %>.session", secret: self["core.settings"].session_secret
+
+      plugin :csrf, raise: true
+      plugin :dry_view
+      plugin :error_handler
+      plugin :flash
+      plugin :multi_route
+
+      route do |r|
+        # Enable this after writing your first web/routes/ file
+        # r.multi_route
+
+        r.root do
+          r.view "welcome"
+        end
+      end
+
+      # Request-specific options for dry-view context object
+      def view_context_options
+        {
+          flash:        flash,
+          csrf_token:   Rack::Csrf.token(request.env),
+          csrf_metatag: Rack::Csrf.metatag(request.env),
+          csrf_tag:     Rack::Csrf.tag(request.env),
+        }
+      end
+
+      load_routes!
+    end
+  end
+end

data/lib/dry/web/roda/templates/subapp/welcome.rb.tt

@@ -0,0 +1,13 @@
+require "<%= config[:underscored_umbrella_name] %>/<%= config[:underscored_project_name] %>/view/controller"
+
+module <%= config[:camel_cased_umbrella_name] %>
+  module <%= config[:camel_cased_app_name] %>
+    module Views
+      class Welcome < View::Controller
+        configure do |config|
+          config.template = "welcome"
+        end
+      end
+    end
+  end
+end

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

@@ -13,4 +13,4 @@ Dir[app_paths].each do |f|
   require "#{f}/system/boot"
 end
 
-require "<%= config[:underscored_project_name] %>/application"
+require "<%= config[:underscored_project_name] %>/web"

data/lib/dry/web/roda/templates/umbrella_project/{application.rb.tt → web.rb.tt}

@@ -2,13 +2,15 @@ require "dry/web/roda/application"
 require_relative "container"
 
 module <%= config[:camel_cased_app_name] %>
-  class Application < Dry::Web::Roda::Application
+  class Web < Dry::Web::Roda::Application
     configure do |config|
       config.container = Container
     end
 
+    plugin :error_handler
+
     route do |r|
-      r.run ::Main::Application.freeze.app
+      r.run <%= config[:camel_cased_app_name] %>::Main::Web.freeze.app
     end
 
     error do |e|

data/lib/dry/web/roda/templates/{view_controller.rb.tt → view__controller.rb.tt}

@@ -1,7 +1,7 @@
 # auto_register: false
 
 require "slim"
-require "dry-view"
+require "dry/view/controller"
 require "<%= config[:underscored_project_name] %>/container"
 
 module <%= config[:camel_cased_app_name] %>

data/lib/dry/web/roda/version.rb

@@ -1,7 +1,7 @@
 module Dry
   module Web
     module Roda
-      VERSION = "0.8.0".freeze
+      VERSION = "0.9.0".freeze
     end
   end
 end

data/lib/roda/plugins/dry_view.rb

@@ -2,8 +2,6 @@ class Roda
   module RodaPlugins
     module DryView
       def self.load_dependencies(app)
-        app.plugin :csrf
-        app.plugin :flash
         app.plugin :flow
       end
 
@@ -13,12 +11,7 @@ class Roda
         end
 
         def view_context_options
-          {
-            flash:        flash,
-            csrf_token:   Rack::Csrf.token(request.env),
-            csrf_metatag: Rack::Csrf.metatag(request.env),
-            csrf_tag:     Rack::Csrf.tag(request.env),
-          }
+          {}
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-web-roda
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -207,8 +207,8 @@ files:
 - lib/dry/web/roda/templates/console.tt
 - lib/dry/web/roda/templates/container.rb.tt
 - lib/dry/web/roda/templates/example_routes.rb.tt
-- lib/dry/web/roda/templates/flat_project/application.rb.tt
 - lib/dry/web/roda/templates/flat_project/boot.rb.tt
+- lib/dry/web/roda/templates/flat_project/web.rb.tt
 - lib/dry/web/roda/templates/import.rb.tt
 - lib/dry/web/roda/templates/monitor.rb.tt
 - lib/dry/web/roda/templates/operation.rb.tt
@@ -225,17 +225,19 @@ files:
 - lib/dry/web/roda/templates/spec/support/db/helpers.rb.tt
 - lib/dry/web/roda/templates/spec/support/web/helpers.rb.tt
 - lib/dry/web/roda/templates/spec/web_spec_helper.rb
-- lib/dry/web/roda/templates/subapp/application.rb.tt
 - lib/dry/web/roda/templates/subapp/boot.rb.tt
 - lib/dry/web/roda/templates/subapp/container.rb.tt
-- lib/dry/web/roda/templates/subapp/transactions.rb.tt
-- lib/dry/web/roda/templates/subapp/view_context.rb.tt
-- lib/dry/web/roda/templates/subapp/view_controller.rb.tt
+- lib/dry/web/roda/templates/subapp/example_routes.rb.tt
+- lib/dry/web/roda/templates/subapp/import.rb.tt
+- lib/dry/web/roda/templates/subapp/view__context.rb.tt
+- lib/dry/web/roda/templates/subapp/view__controller.rb.tt
+- lib/dry/web/roda/templates/subapp/web.rb.tt
+- lib/dry/web/roda/templates/subapp/welcome.rb.tt
 - lib/dry/web/roda/templates/types.rb
-- lib/dry/web/roda/templates/umbrella_project/application.rb.tt
 - lib/dry/web/roda/templates/umbrella_project/boot.rb.tt
-- lib/dry/web/roda/templates/view_context.rb.tt
-- lib/dry/web/roda/templates/view_controller.rb.tt
+- lib/dry/web/roda/templates/umbrella_project/web.rb.tt
+- lib/dry/web/roda/templates/view__context.rb.tt
+- lib/dry/web/roda/templates/view__controller.rb.tt
 - lib/dry/web/roda/templates/welcome.html.slim
 - lib/dry/web/roda/templates/welcome.rb.tt
 - lib/dry/web/roda/version.rb

data/lib/dry/web/roda/templates/subapp/application.rb.tt

@@ -1,29 +0,0 @@
-require "dry/web/roda/application"
-require_relative "container"
-
-module <%= config[:camel_cased_app_name] %>
-  class Application < Dry::Web::Roda::Application
-    configure do |config|
-      config.container = Container
-      config.routes = "web/routes".freeze
-    end
-
-    opts[:root] = Pathname(__FILE__).join("../..").realpath.dirname
-
-    use Rack::Session::Cookie, key: "<%= config[:underscored_project_name] %>.session", secret: self["core.settings"].session_secret
-
-    plugin :csrf, raise: true
-    plugin :flash
-    plugin :dry_view
-
-    route do |r|
-      r.multi_route
-
-      r.root do
-        r.view "welcome"
-      end
-    end
-
-    load_routes!
-  end
-end

data/lib/dry/web/roda/templates/subapp/transactions.rb.tt

@@ -1,11 +0,0 @@
-require "dry-transaction"
-require "<%= config[:underscored_project_name] %>/container"
-require "<%= config[:underscored_project_name] %>/import"
-
-module <%= config[:camel_cased_app_name] %>
-  class Transactions < <%= config[:camel_cased_umbrella_name] %>::Transactions
-    configure do |config|
-      config.container = <%= config[:camel_cased_app_name] %>::Container
-    end
-  end
-end

data/lib/dry/web/roda/templates/subapp/view_context.rb.tt

@@ -1,8 +0,0 @@
-require "<%= config[:underscored_umbrella_name] %>/view/context"
-
-module <%= config[:camel_cased_app_name] %>
-  module View
-    class Context < <%= config[:camel_cased_umbrella_name] %>::View::Context
-    end
-  end
-end

data/lib/dry/web/roda/templates/subapp/view_controller.rb.tt

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