dry-web-roda 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 726ea7f39f9d491d5e7681d9842ea0b0d466eb4f
-  data.tar.gz: 288314be9441cb36682f5c863634013e5565fcc9
+  metadata.gz: 02425c79e7cb73bc2c6ba4828c849613926f4bd6
+  data.tar.gz: 45b4248b401fb991c9d9d6eee49379486c5a24d5
 SHA512:
-  metadata.gz: 219b11b37b13bc7116425604ef6e98a9bf44e98c7e0e2ca362636cb4c880ecce42fec9fbd61a282d9b60563620cbba7b025f7d4fb0aeacff6b27a76359f47875
-  data.tar.gz: dfd793d774f1528e0c3a8983c0f6d51dff8df1b133738a3644883323c4482970270d634cfe1889b4042c12c0fb1e5bcb6803b97f624db4e20a29fb1ef89a4d40
+  metadata.gz: 31397fe8d8dfcf700a5d567ff522addacc68f6e2c64b2b538c06848fdfb30a8e1fc0813c5c9dd55a9c4181dc33fb946aa5167956d776a0beb9e0e2de43eef110
+  data.tar.gz: 82928af236cdc3916ee453b91de9d4446c59ad9e5f0470e08266ca9473d0eaab06a15dd9fb02ed943971c0d377ac91313072cda8ef7a150a45a217c936f33024

data/CHANGELOG.md

@@ -1,3 +1,22 @@
-# 0.1.0, 2016-06-12
+# 0.2.0 / 2016-06-22
+
+### Added
+
+- Added a `dry-web-roda` executable CLI command, which can generate new dry-web-roda projects and apps within projects (timriley)
+
+    To generate a new project:
+
+    ```sh
+    dry-web-roda new my_new_project
+    ```
+
+    And to generate a new app within an existing project:
+
+    ```sh
+    dry-web-roda generate app my_sub_app --umbrella=my_new_project
+    ```
+- Added the beginnings of a skeleton-based code generator, to support the above (timriley)
+
+# 0.1.0 / 2016-06-12
 
 - Extracted from dry-web (timriley)

data/README.md

@@ -1,9 +1,23 @@
 # dry-web-roda [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+Integration between dry-web and roda.
+
+dry-web-roda offers a CLI for generating new projects:
+
+```sh
+$ dry-web-roda new <project_name>
+```
+
+And building apps within projects:
+
+```sh
+$ dry-web-roda generate app <my_sub_app_name>
+```
+
 ## LICENSE
 
 See `LICENSE` file.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dry-rb/dry-web.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dry-rb/dry-web-roda.

data/bin/dry-web-roda

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/web/roda/cli"
+
+Dry::Web::Roda::CLI.start ARGV

data/dry-web-roda.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "dry-configurable", "~> 0.1"
+  spec.add_runtime_dependency "inflecto", "~> 0.0"
   spec.add_runtime_dependency "roda", "~> 2.14"
   spec.add_runtime_dependency "roda-flow", "~> 0.3"
+  spec.add_runtime_dependency "thor", "~> 0.19"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 11.0"

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

@@ -0,0 +1,18 @@
+require "thor"
+
+module Dry
+  module Web
+    module Roda
+      class CLI
+        class Generate < Thor
+          desc "generate app APP", "Generate an app within a dry-web umbrella"
+          option :umbrella, required: true, banner: "UMBRELLA_NAME", desc: "Provide the name of the umbrella app, e.g. my_project"
+          def app(app_name)
+            require "dry/web/roda/generators/app"
+            Dry::Web::Roda::Generators::App.new.(app_name, umbrella: options[:umbrella])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "thor"
+
+module Dry
+  module Web
+    module Roda
+      class CLI < Thor
+        desc "new APP", "Generate a new dry-web-roda project"
+        def new(app_name)
+          require "dry/web/roda/generators/umbrella"
+          Generators::Umbrella.new.(app_name)
+        end
+
+        desc "generate GENERATOR", "Generate a new component for an existing dry-web-roda project"
+        require "dry/web/roda/cli/generate"
+        subcommand "generate", CLI::Generate
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require "pathname"
+require "thor"
+
+module Dry
+  module Web
+    module Roda
+      class Generate
+        SKELETONS_DIR = "skeletons".freeze
+
+        attr_reader :source_dir
+        attr_reader :processor
+
+        def initialize(skeleton_name)
+          @source_dir = Pathname(__FILE__).dirname.join(SKELETONS_DIR).join(skeleton_name)
+
+          @processor = Class.new(Thor) do
+            include Thor::Actions
+          end.new
+          @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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require "inflecto"
+require "dry/web/roda/generate"
+
+module Dry
+  module Web
+    module Roda
+      module Generators
+        class App
+          attr_reader :generate
+
+          def initialize
+            @generate = Dry::Web::Roda::Generate.new("app")
+          end
+
+          def call(target_dir, options = {})
+            umbrella_name = options.fetch(:umbrella)
+            generate_to = options.fetch(:to) { File.join("apps", target_dir) }
+
+            generate.(generate_to, prepare_scope(target_dir, umbrella_name))
+          end
+
+          private
+
+          def prepare_scope(target_dir, umbrella_name)
+            {
+              underscored_app_name: Inflecto.underscore(target_dir),
+              camel_cased_app_name: Inflecto.camelize(target_dir),
+              underscored_umbrella_name: Inflecto.underscore(umbrella_name),
+              camel_cased_umbrella_name: Inflecto.camelize(umbrella_name),
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require "inflecto"
+require "securerandom"
+require "dry/web/roda/generate"
+require "dry/web/roda/generators/app"
+
+module Dry
+  module Web
+    module Roda
+      module Generators
+        class Umbrella
+          attr_reader :generate, :app_generator
+
+          def initialize
+            @generate = Generate.new("umbrella")
+            @app_generator = Generators::App.new
+          end
+
+          def call(target_dir)
+            generate.(target_dir, prepare_scope(target_dir))
+
+            Dir.chdir(target_dir) do
+              app_generator.("main", umbrella: target_dir)
+            end
+          end
+
+          private
+
+          def prepare_scope(target_dir)
+            {
+              underscored_app_name: Inflecto.underscore(target_dir),
+              camel_cased_app_name: Inflecto.camelize(target_dir)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/app/component/__underscored_app_name__/application.rb.tt

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

data/lib/dry/web/roda/skeletons/app/component/__underscored_app_name__/container.rb.tt

@@ -0,0 +1,19 @@
+require "pathname"
+require "dry/web/container"
+
+module <%= config[:camel_cased_app_name] %>
+  class Container < Dry::Web::Container
+    require root.join("component/<%= config[:underscored_umbrella_name] %>/container")
+    import <%= config[:camel_cased_umbrella_name] %>::Container
+
+    configure do |config|
+      config.root = Pathname(__FILE__).join("../..").realpath.dirname.freeze
+
+      config.auto_register = %w[
+        lib/<%= config[:underscored_app_name] %>
+      ]
+    end
+
+    load_paths! "lib", "component"
+  end
+end

data/lib/dry/web/roda/skeletons/app/component/__underscored_app_name__/import.rb.tt

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

data/lib/dry/web/roda/skeletons/app/component/__underscored_app_name__/page.rb.tt

@@ -0,0 +1,6 @@
+require "<%= config[:underscored_umbrella_name] %>/page"
+
+module <%= config[:camel_cased_app_name] %>
+  class Page < <%= config[:camel_cased_umbrella_name] %>::Page
+  end
+end

data/lib/dry/web/roda/skeletons/app/component/__underscored_app_name__/transactions.rb.tt

@@ -0,0 +1,12 @@
+require "dry-transaction"
+require "<%= config[:underscored_umbrella_name] %>/transactions"
+require "<%= config[:underscored_app_name] %>/container"
+require "<%= config[:underscored_app_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/skeletons/app/component/__underscored_app_name__/view.rb.tt

@@ -0,0 +1,19 @@
+require "slim"
+require "dry-view"
+require "<%= config[:underscored_app_name] %>/container"
+require "<%= config[:underscored_app_name] %>/page"
+
+module Main
+  Container.register "page", Page.new
+
+  class View < Dry::View::Layout
+    setting :root, Container.root.join("web/templates")
+    setting :scope, Container["page"]
+    setting :formats, {html: :slim}
+    setting :name, "application"
+
+    def locals(options)
+      super.merge(options[:scope].view_locals)
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/app/component/boot.rb.tt

@@ -0,0 +1,10 @@
+require_relative "main/container"
+
+<%= config[:camel_cased_app_name] %>::Container.finalize! do |container|
+end
+
+require "<%= config[:underscored_app_name] %>/application"
+require "<%= config[:underscored_app_name] %>/view"
+require "<%= config[:underscored_app_name] %>/transactions"
+
+<%= config[:camel_cased_app_name] %>::Container.require "transactions/**/*.rb"

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

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

data/lib/dry/web/roda/skeletons/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/app/web/templates/layouts/application.html.slim

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

data/lib/dry/web/roda/skeletons/umbrella/.gitignore

@@ -0,0 +1,5 @@
+# Ignore secrets in app settings (copy a version to settings.example.yml if you want to check one in)
+/config/settings.yml
+
+# RSpec
+/spec/examples.txt

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

@@ -0,0 +1,39 @@
+source "https://rubygems.org"
+
+gem "rake"
+
+# Web framework
+gem "dry-web", "~> 0.3.0"
+gem "dry-web-roda", "~> 0.2.0"
+gem "puma"
+gem "rack_csrf"
+gem "shotgun"
+
+# Database persistence
+gem "pg"
+gem "rom",            github: "rom-rb/rom"
+gem "rom-mapper",     github: "rom-rb/rom-mapper"
+gem "rom-repository", github: "rom-rb/rom-repository"
+gem "rom-sql",        github: "rom-rb/rom-sql"
+gem "rom-support",    github: "rom-rb/rom-support"
+
+# Application dependencies
+gem "dry-result_matcher"
+gem "dry-transaction"
+gem "dry-types"
+gem "dry-validation"
+gem "dry-view"
+gem "slim"
+
+group :development, :test do
+  gem "guard-rspec"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "capybara"
+  gem "capybara-screenshot"
+  gem "database_cleaner"
+  gem "poltergeist"
+  gem "rspec"
+end

data/lib/dry/web/roda/skeletons/umbrella/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/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 "component/<%= 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} -i -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/bin/console.tt

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

data/lib/dry/web/roda/skeletons/umbrella/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/component/__underscored_app_name__/application.rb.tt

@@ -0,0 +1,7 @@
+module <%= config[:camel_cased_app_name] %>
+  class Application < Roda
+    route do |r|
+      r.run Main::Application.freeze.app
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/umbrella/component/__underscored_app_name__/container.rb.tt

@@ -0,0 +1,17 @@
+require "dry/web/umbrella"
+require_relative "settings"
+
+module <%= config[:camel_cased_app_name] %>
+  class Container < Dry::Web::Umbrella
+    configure do
+      config.name = :core
+      config.settings_loader = <%= config[:camel_cased_app_name] %>::Settings
+    end
+
+    load_paths! "lib", "component"
+
+    def self.settings
+      config.settings
+    end
+  end
+end

data/lib/dry/web/roda/skeletons/umbrella/component/__underscored_app_name__/import.rb.tt

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

data/lib/dry/web/roda/skeletons/umbrella/component/__underscored_app_name__/settings.rb.tt

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

data/lib/dry/web/roda/skeletons/umbrella/component/boot/logger.rb.tt

@@ -0,0 +1,5 @@
+require "logger"
+
+<%= config[:camel_cased_app_name] %>::Container.finalize :logger do |container|
+  container.register "logger", Logger.new(container.root.join("log/#{container.config.env}.log"))
+end

data/lib/dry/web/roda/skeletons/umbrella/component/boot/rom.rb.tt

@@ -0,0 +1,16 @@
+require "sequel"
+require "rom"
+
+Sequel.database_timezone = :utc
+Sequel.application_timezone = :local
+
+<%= config[:camel_cased_app_name] %>::Container.namespace "persistence" do |container|
+  config = ROM::Configuration.new(:sql, container.settings.database_url, extensions: [:error_sql])
+
+  container.register "config", config
+
+  container.finalize :rom do
+    config.auto_registration container.root.join("lib/persistence")
+    container.register "rom", ROM.container(config)
+  end
+end

data/lib/dry/web/roda/skeletons/umbrella/component/boot.rb.tt

@@ -0,0 +1,12 @@
+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! do |container|
+end
+
+app_paths = Pathname(__FILE__).dirname.join("../apps").realpath.join("*")
+Dir[app_paths].each { |f| require "#{f}/component/boot" }
+
+require_relative "<%= config[:underscored_app_name] %>/application"

data/lib/dry/web/roda/skeletons/umbrella/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/config.ru.tt

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

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

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