dry-web-roda 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd98b628eb646092627a0322e5d9fec5d5df8922
-  data.tar.gz: e68b854855b73288d83dd46e337dea8352890d6f
+  metadata.gz: 33b31bfd006852b040b770a7ca5b7967af9b3686
+  data.tar.gz: de42647467c74034df0503398cac8d7d25f3dbe1
 SHA512:
-  metadata.gz: 49f813b5b909bc6b4d9f6772cc7a3a51560f2a440f60dfbbdbbe28ea4f653ccdc596453cc0fb51f2866c77467e923493e9a166103466d61527f38440ccf832d5
-  data.tar.gz: 8aee21a881953339e3e5552183ecf2b1ab2675d274dede6f8e0474def29e7fc98644f55af30b77d463c5032c4e19b15f37679fcbd12f14689d37ccd903aa0b64
+  metadata.gz: a4b4caae50823f09588968a7027f88e4b1e5dfe1df21b70c5bccb749c9c753db05f2e7656248f4f54aa31ebf0789dea1415fac4ff24c47df7f7049129b56f413
+  data.tar.gz: b76fe02ea98f0399ed6a4fb4606ebfe18700ec60d6eb2f2aaf3f8fcef95cca4ed700fa2cb3dbf860c2088c11231e82e7aee566d082cb79f891ea444f8965c933

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 0.7.0 - 2017-06-16
+
+### Added
+
+In generated app:
+
+- Shared `Operation` class for all application operations to inherit from (timriley)
+- Enable `auto_restrictions` relation plugin for ROM (timriley)
+- Register low-level database connection object as "persistence.db" in core container (timriley)
+
+### Changed
+
+In generated app:
+
+- Use full database URL to include credentials in pg_dump (lukkor)
+- Move view controller and context classes into main lib/ dirs (timriley)
+- Use dry-system 0.7.0 magic comments to prevent auto-registration of base repository, view controller and view context classes (timriley)
+- Update dry-system dependency to support string paths for container root configs (timriley)
+- [BREAKING] Use Dry::Web::Settings from dry-web 0.7.0, which loads settings from .env files instead of .yml files (timriley)
+- [BREAKING] Provide settings object via a bootable component
+- [BREAKING] Remove special transactions setup harness, since dry-transaction 0.10.0 supports class-based transactions
+
 # 0.6.3 - 2017-03-02
 
 ### Changed

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/Gemfile

@@ -7,7 +7,8 @@ gem 'byebug', platform: :mri
 gem 'codeclimate-test-reporter', platform: :rbx
 
 # Generated application dependencies
-gem "dry-web", ">= 0.6.0"
+gem "dry-system", ">= 0.7.1"
+gem "dry-web", ">= 0.7.0"
 gem "puma"
 gem "rack_csrf"
 gem "rack", ">= 2.0"
@@ -18,10 +19,10 @@ gem "rom-sql"
 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"
 gem "pry-byebug", platform: :mri
 gem "capybara"

data/README.md

@@ -11,7 +11,7 @@
 [![Test Coverage](https://codeclimate.com/github/dry-rb/dry-web-roda/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-web-roda.svg?branch=master&style=flat)][inchpages]
 
-Integration between dry-web and roda.
+Integration between [dry-web](https://github.com/dry-rb/dry-web) and [roda](https://github.com/jeremyevans/roda).
 
 dry-web-roda offers a CLI for generating new projects.
 

data/dry-web-roda.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_runtime_dependency "dry-web", "~> 0.6", ">= 0.6.0"
-  spec.add_runtime_dependency "dry-monitor"
   spec.add_runtime_dependency "dry-configurable", "~> 0.2"
   spec.add_runtime_dependency "inflecto", "~> 0.0"
   spec.add_runtime_dependency "roda", "~> 2.14"

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

@@ -10,10 +10,10 @@ module Dry
           case options[:arch]
           when "umbrella"
             require "dry/web/roda/generators/umbrella_project"
-            Generators::UmbrellaProject.new.(app_name)
+            Generators::UmbrellaProject.new(app_name).call
           when "flat"
             require "dry/web/roda/generators/flat_project"
-            Generators::FlatProject.new.(app_name)
+            Generators::FlatProject.new(app_name).call
           end
         end
 

data/lib/dry/web/roda/cli/generate.rb

@@ -9,7 +9,7 @@ module Dry
           option :umbrella, required: true, banner: "UMBRELLA_NAME", desc: "Provide the name of the umbrella app, e.g. my_project"
           def sub_app(app_name)
             require "dry/web/roda/generators/sub_app"
-            Dry::Web::Roda::Generators::SubApp.new.(app_name, umbrella: options[:umbrella])
+            Dry::Web::Roda::Generators::SubApp.new(app_name, umbrella: options[:umbrella]).call
           end
         end
       end

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

@@ -5,48 +5,46 @@ module Dry
   module Web
     module Roda
       class Generate
-        SKELETONS_DIR = "skeletons".freeze
+        TEMPLATES_DIR = "templates".freeze
+        SOURCE_DIR = Pathname(__FILE__).dirname.join(TEMPLATES_DIR)
 
-        attr_reader :source_dir
-        attr_reader :processor
+        attr_reader :target_dir, :template_scope, :template_files, :processor
 
-        def initialize(skeleton_name)
-          @source_dir = Pathname(__FILE__).dirname.join(SKELETONS_DIR).join(skeleton_name)
+        def initialize(target_dir, template_scope)
+          @target_dir = target_dir
+          @template_scope = template_scope
+          @template_files = Dir[SOURCE_DIR.join('**/{.,}*')]
 
           @processor = Class.new(Thor) do
             include Thor::Actions
           end.new
-          @processor.class.source_root source_dir
+          @processor.class.source_root SOURCE_DIR
         end
 
-        def call(target_dir, scope = {})
-          target_dir = Pathname.getwd + target_dir
-          source_files = Dir[source_dir.join("**/{.,}*")]
-
-          source_files.select { |f| File.file?(f) }.each do |source_file|
-            source_file = Pathname(source_file)
-            relative_source_file = source_file.relative_path_from(source_dir)
-            target_file = target_dir + relative_source_file
-
-            if scope.any?
-              target_file = target_file.to_s.gsub(/__#{Regexp.union(scope.keys.map(&:to_s))}__/) { |match|
-                scope_key = match.gsub(/^__/, "").gsub(/__$/, "")
-                scope.fetch(scope_key.to_sym)
-              }
-            end
-
-            if relative_source_file.extname == Thor::TEMPLATE_EXTNAME
-              target_file = target_file.sub(/#{Thor::TEMPLATE_EXTNAME}$/, "")
-
-              processor.template relative_source_file, target_file, scope
-            else
-              processor.copy_file relative_source_file, target_file
-            end
-
-            if source_file.file? && source_file.executable?
-              FileUtils.chmod "a+x", target_file
-            end
-          end
+        def call(source, target)
+          source = Pathname(source)
+          aboslute_source_path = source.expand_path(SOURCE_DIR)
+          target_file = get_target_file(target)
+          template_file = template_files.find { |f| f == aboslute_source_path.to_s } or raise "missing template file +#{source}+"
+          template_file = Pathname(template_file)
+
+          processor.template template_file, target_file, template_scope
+
+          create_executable(target_file) if executable?(template_file)
+        end
+
+        private
+
+        def get_target_file(target)
+          Pathname.getwd.join(target_dir, target)
+        end
+
+        def create_executable(file)
+          FileUtils.chmod "a+x", file
+        end
+
+        def executable?(file)
+          file.file? && file.executable?
         end
       end
     end

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

@@ -0,0 +1,54 @@
+require "dry/web/roda/generate"
+require "dry/web/roda/generators/inflections"
+
+module Dry
+  module Web
+    module Roda
+      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/roda/generators/abstract_project.rb

@@ -0,0 +1,118 @@
+require "securerandom"
+require "dry/web/roda/generators/abstract_generator"
+
+module Dry
+  module Web
+    module Roda
+      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/persistance/relations/.keep')
+            add_template('.keep', 'lib/persistance/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('welcome.rb.tt', "lib/#{underscored_project_name}/views/welcome.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")
+            add_template("settings.rb.tt", "system/#{underscored_project_name}/settings.rb")
+          end
+
+          def add_system_boot
+            add_template("monitor.rb.tt", "system/boot/monitor.rb")
+            add_template("rom.rb.tt", "system/boot/rom.rb")
+            add_template("boot__settings.rb.tt", "system/boot/settings.rb")
+          end
+
+          def add_config_files
+            add_template('.gitignore', '.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/roda/generators/flat_project.rb

@@ -1,29 +1,35 @@
 require "securerandom"
-require "dry/web/roda/generate"
-require "dry/web/roda/generators/inflections"
+require "dry/web/roda/generators/abstract_project"
 
 module Dry
   module Web
     module Roda
       module Generators
-        class FlatProject
-          attr_reader :generate
+        class FlatProject < AbstractProject
+          def populate_templates
+            super
+            add_views
+            add_web
+          end
+
+          private
 
-          def initialize
-            @generate = Generate.new("flat_project")
+          def add_boot
+            add_template("flat_project/boot.rb.tt", "system/boot.rb")
           end
 
-          def call(target_dir)
-            generate.(target_dir, prepare_scope(target_dir))
+          def add_application
+            add_template("flat_project/application.rb.tt", "system/#{underscored_project_name}/application.rb")
           end
 
-          private
+          def add_views
+            add_template('welcome.rb.tt', "lib/#{underscored_project_name}/views/welcome.rb")
+          end
 
-          def prepare_scope(target_dir)
-            {
-              underscored_app_name: Inflections.underscored_name(target_dir),
-              camel_cased_app_name: Inflections.camel_cased_name(target_dir)
-            }
+          def add_web
+            add_template('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
         end
       end

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

@@ -1,29 +1,50 @@
-require "dry/web/roda/generate"
-require "dry/web/roda/generators/inflections"
+require "dry/web/roda/generators/abstract_generator"
 
 module Dry
   module Web
     module Roda
       module Generators
-        class SubApp
-          attr_reader :generate
+        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 initialize
-            @generate = Dry::Web::Roda::Generate.new("sub_app")
+          def umbrella_name
+            options.fetch(:umbrella)
           end
 
-          def call(target_dir, options = {})
-            umbrella_name = options.fetch(:umbrella)
-            generate_to = options.fetch(:to) { File.join("apps", target_dir) }
+          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('.keep', "lib/#{underscored_project_name}/.keep")
+          end
 
-            generate.(generate_to, prepare_scope(target_dir, umbrella_name))
+          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/boot.rb.tt', 'system/boot.rb')
           end
 
-          private
+          def add_web
+            add_template('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
 
-          def prepare_scope(target_dir, umbrella_name)
+          def template_scope
             {
-              underscored_app_name: Inflections.underscored_name(target_dir),
+              underscored_project_name: underscored_project_name,
               camel_cased_app_name: Inflections.camel_cased_name(target_dir),
               underscored_umbrella_name: Inflections.underscored_name(umbrella_name),
               camel_cased_umbrella_name: Inflections.camel_cased_name(umbrella_name),