ree_lib 1.0.39 → 1.0.40

data/lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_routing_tree_spec.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal = true
+
+RSpec.describe :build_routing_tree do
+  link :build_routing_tree, from: :ree_roda
+  link :except, from: :ree_hash
+  link :is_blank, from: :ree_object
+  link :not_blank, from: :ree_object
+  link :to_hash, from: :ree_object
+
+  before :all do
+    Ree.enable_irb_mode
+
+    module ReeRodaTestTree
+      include Ree::PackageDSL
+
+      package
+    end
+
+    class ReeRodaTestTree::Cmd
+      include ReeActions::DSL
+
+      action :cmd
+
+      ActionCaster = build_mapper.use(:cast) do
+        integer :id
+        integer? :task_id
+      end
+
+      def call(access, attrs)
+      end
+    end
+
+    class ReeRodaTestTree::TestRoutes
+      include ReeRoutes::DSL
+
+      routes :test_routes do
+        default_warden_scope :identity
+        opts = { from: :ree_roda_test_tree }
+
+        get "api/actions/:id" do
+          summary "Some action"
+          warden_scope :visitor
+          sections "some_action"
+          action :cmd, **opts
+        end
+
+        post "api/actions" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        delete "api/actions/:id" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/actions/:id/types" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        post "api/actions/:id/types" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/tasks" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/tasks/:id" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        delete "api/tasks/:task_id" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/tasks/:id/types" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/users/:id" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/users/collection/:id" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/users/collection/:id/info" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+
+        get "api/accounts" do
+          summary "Some action"
+          action :cmd, **opts
+        end
+      end
+    end
+
+    class TestTreeApp < ReeRoda::App
+      plugin :ree_routes
+
+      ree_routes ReeRodaTestTree::TestRoutes.new
+
+      route do |r|
+        r.get "health" do
+          "success"
+        end
+
+        r.ree_routes
+      end
+    end
+  end
+
+  after :all do
+    Ree.disable_irb_mode
+  end
+
+  let(:routes) { TestTreeApp.instance_variable_get(:@ree_routes) }
+
+  let(:hsh_tree) {
+    {
+      value: "api",
+      depth: 0,
+      parent: nil,
+      type: :string,
+      children: [
+        {
+          value: "actions",
+          depth: 1,
+          parent: "api",
+          type: :string,
+          children: [
+            {
+              value: ":id",
+              depth: 2,
+              parent: "actions",
+              type: :param,
+              children: [
+                {
+                  value: "types",
+                  depth: 3,
+                  parent: ":id",
+                  type: :string,
+                  children: []
+                }
+              ]
+            }
+          ]
+        },
+        {
+          value: "tasks",
+          depth: 1,
+          parent: "api",
+          type: :string,
+          children: [
+            {
+              value: ":id",
+              depth: 2,
+              parent: "tasks",
+              type: :param,
+              children: [
+                {
+                  value: "types",
+                  depth: 3,
+                  parent: ":id",
+                  type: :string,
+                  children: []
+                }
+              ]
+            }
+          ]
+        },
+        {
+          value: "users",
+          depth: 1,
+          parent: "api",
+          type: :string,
+          children: [
+            {
+              value: "collection",
+              depth: 2,
+              parent: "users",
+              type: :string,
+              children: [
+                {
+                  value: ":id",
+                  depth: 3,
+                  parent: "collection",
+                  type: :param,
+                  children: [
+                    {
+                      value: "info",
+                      depth: 4,
+                      parent: ":id",
+                      type: :string,
+                      children: []
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              value: ":id",
+              depth: 2,
+              parent: "users",
+              type: :param,
+              children: []
+            }
+          ]
+        },
+        {
+          value: "accounts",
+          depth: 1,
+          parent: "api",
+          type: :string,
+          children: []
+        }
+      ]
+    }
+  }
+
+  it {
+    tree = build_routing_tree(routes)
+
+    # check that all end nodes have routes
+    # and that not end nodes don't have route
+    id_nodes = [*tree.find_by_value(value: ":id", depth: 2), *tree.find_by_value(value: ":id", depth: 4)]
+    types_node = tree.find_by_value(value: "types", depth: 3)
+    actions_node = tree.find_by_value(value: "actions", depth: 1)
+    tasks_node = tree.find_by_value(value: "tasks", depth: 1)
+
+    def count_tree_routes(tree, count = 0)
+      count += tree.routes.count
+      if tree.children.length > 0
+        return tree.children.map do |children|
+          count_tree_routes(children, count)
+        end.sum
+      end
+      return count
+    end
+
+    expect(is_blank(tree.routes)).to eq(true)
+    expect(not_blank(actions_node.routes)).to eq(true)
+    expect(not_blank(tasks_node.routes)).to eq(true)
+    expect(id_nodes.all? { not_blank(_1.routes) }).to eq(true)
+    expect(count_tree_routes(tree)).to eq(13)
+
+    hsh = to_hash(tree)
+    expect(except(hsh, global_except: [:routes])).to eq(hsh_tree)
+  }
+end

data/lib/ree_lib/packages/ree_routes/.rspec

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

data/lib/ree_lib/packages/ree_routes/Package.schema.json

@@ -0,0 +1,20 @@
+{
+  "schema_type": "package",
+  "schema_version": "1.1",
+  "name": "ree_routes",
+  "entry_path": "packages/ree_routes/package/ree_routes.rb",
+  "tags": [
+    "ree_routes"
+  ],
+  "depends_on": [
+    {
+      "name": "ree_mapper"
+    }
+  ],
+  "env_vars": [
+
+  ],
+  "objects": [
+
+  ]
+}

data/lib/ree_lib/packages/ree_routes/bin/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "ree"
+
+Ree.init(__dir__, irb: true)

data/lib/ree_lib/packages/ree_routes/package/ree_routes/dsl.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "route_builder"
+require "uri"
+
+module ReeRoutes
+  module DSL
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.extended(base)
+      base.extend(ClassMethods)
+    end
+
+    module FactoryMethod
+      def build
+        self.class.instance_variable_get(:@routes) || []
+      end
+    end
+
+    module ClassMethods
+      include Ree::Contracts::Core
+      include Ree::Contracts::ArgContracts
+
+      def routes(name, &proc)
+        raise ArgumentError.new("block is required") if !block_given?
+
+        @dsl = Ree::ObjectDsl.new(
+          Ree.container.packages_facade, name, self, :object
+        )
+
+        @dsl.singleton
+        @dsl.factory(:build)
+        @dsl.tags(["routes"])
+
+        instance_exec(&proc)
+
+        klass = @dsl.object.klass
+        klass.send(:include, FactoryMethod)
+
+
+        Ree.container.compile(@dsl.package, name)
+      end
+
+      def default_warden_scope(method_name)
+        @default_warden_scope = method_name
+      end
+
+      [:get, :post, :put, :delete, :patch, :head, :options].each do |request_method|
+        define_method request_method do |path, &proc|
+          define_route(request_method, path, &proc)
+        end
+      end
+
+      private
+
+      contract Symbol, String, Block => ReeRoutes::Route
+      def define_route(request_method, path, &proc)
+        raise ArgumentError.new("routes should be called") if !@dsl
+        raise ArgumentError.new("block is required") if !block_given?
+
+        @routes ||= []
+
+        builder = ReeRoutes::RouteBuilder.new
+        builder.instance_exec(&proc)
+
+        if @default_warden_scope && !builder.get_route.warden_scope
+          builder.warden_scope(@default_warden_scope)
+        end
+
+        uri = URI.parse(path) rescue nil
+
+        if uri.nil? || uri.path != path
+          raise ArgumentError.new("invalid path provided #{path}")
+        end
+
+        if uri.query && !uri.query.empty?
+          raise ArgumentError.new("route path should not include query params: #{path}")
+        end
+
+        builder.get_route.path = path
+        builder.get_route.request_method = request_method
+
+        if !builder.get_route.valid?
+          raise ArgumentError.new("action, summary and auth scope should be provided for #{builder.get_route.inspect}")
+        end
+
+        route = builder.get_route
+
+        @dsl.link(route.action.name, from: route.action.package_name)
+
+        if route.serializer
+          @dsl.link(route.serializer.name, from: route.serializer.package_name)
+        end
+
+        @routes << route
+        route
+      end
+    end
+  end
+end

data/lib/ree_lib/packages/ree_routes/package/ree_routes/route.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class ReeRoutes::Route
+  attr_accessor :summary, :request_method, :serializer, :respond_to,
+                :sections, :action, :route, :warden_scope, :path
+
+  def valid?
+    !action.nil? && !summary.nil? && !warden_scope.nil?
+  end
+end

data/lib/ree_lib/packages/{ree_actions/package/ree_actions/action_builder.rb → ree_routes/package/ree_routes/route_builder.rb}

@@ -1,65 +1,65 @@
 # frozen_string_literal: true
 
-require_relative "action"
+require_relative "route"
 
-class ReeActions::ActionBuilder
+class ReeRoutes::RouteBuilder
   Redirect = Struct.new(:path, :code)
 
   def initialize
-    @action = ReeActions::Action.new
-    @action.respond_to = :json
+    @route = ReeRoutes::Route.new
+    @route.respond_to = :json
   end
 
   contract Symbol => Symbol
   def warden_scope(scope)
-    @action.warden_scope = scope
+    @route.warden_scope = scope
   end
 
   contract Symbol => Symbol
   def respond_to(v)
-    @action.respond_to = v
+    @route.respond_to = v
   end
 
-  contract None => ReeActions::Action
-  def get_action
-    @action
+  contract None => ReeRoutes::Route
+  def get_route
+    @route
   end
 
   contract Block => nil
   def before(&proc)
-    @action.before = proc
+    @route.before = proc
     nil
   end
 
   contract String => String
   def summary(str)
-    @action.summary = str
+    @route.summary = str
   end
 
   contract Symbol, Symbol => nil
   def serializer(name, from:)
     object = Ree.container.packages_facade.get_object(from, name)
-    @action.serializer = object
+    @route.serializer = object
     nil
   end
 
   contract SplatOf[String] => nil
   def sections(*names)
-    @action.sections = names
+    @route.sections = names
     nil
   end
 
   contract Symbol, Symbol => nil
   def action(name, from:)
     object = Ree.container.packages_facade.get_object(from, name)
-    @action.action = object
+    @route.action = object
     nil
   end
 
   contract String, Kwargs[code: Integer] => nil
   def redirect(path, code: 301)
     raise ArgumentError if ![301, 302, 303, 307, 308].include?(code)
-    @action.redirect = Redirect.new(path, code)
+    @route.redirect = Redirect.new(path, code)
     nil
   end
 end

data/lib/ree_lib/packages/ree_routes/package/ree_routes.rb

@@ -0,0 +1,9 @@
+module ReeRoutes
+  include Ree::PackageDSL
+
+  package do
+    depends_on :ree_mapper
+  end
+end
+
+require_relative "ree_routes/dsl"

data/lib/ree_lib/packages/ree_routes/spec/package_schema_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe "ReeRoutes" do
+  it "generates package schema" do
+    require 'fileutils'
+
+    packages_schema_path = Ree.locate_packages_schema(__dir__)
+    packages_schema_dir = Pathname.new(packages_schema_path).dirname.to_s
+
+    FileUtils.cd packages_schema_dir do
+      expect(
+        system("bundle exec ree gen.package_json ree_routes --silence")
+      ).to eq(true)
+    end
+  end
+end

data/lib/ree_lib/packages/ree_routes/spec/ree_routes/dsl_spec.rb

@@ -0,0 +1,93 @@
+package_require("ree_routes/dsl")
+
+RSpec.describe ReeRoutes::DSL, type: [:autoclean] do
+  before :all do
+    Ree.enable_irb_mode
+
+    module ReeRoutesTest
+      include Ree::PackageDSL
+
+      package
+    end
+
+    class ReeRoutesTest::EmptyRoutes
+      include ReeRoutes::DSL
+
+      routes :empty_routes do
+      end
+    end
+
+    class ReeRoutesTest::Cmd
+      include Ree::FnDSL
+
+      fn :cmd
+
+      def call
+      end
+    end
+
+    class ReeRoutesTest::Serializer
+      include ReeMapper::DSL
+
+      mapper :serializer
+
+      build_mapper.use(:serialize) do
+        integer :id
+      end
+    end
+
+    class ReeRoutesTest::Caster
+      include ReeMapper::DSL
+
+      mapper :caster
+
+      build_mapper.use(:cast) do
+        integer :id
+      end
+    end
+
+    class ReeRoutesTest::Routes
+      include ReeRoutes::DSL
+
+      routes :routes do
+        default_warden_scope :user
+
+        post "users" do
+          summary "Test route"
+          action :cmd, from: :ree_routes_test
+          serializer :serializer, from: :ree_routes_test
+          respond_to :json
+        end
+
+        get "files.csv" do
+          summary "Test route"
+          action :cmd, from: :ree_routes_test
+          respond_to :csv
+        end
+      end
+    end
+  end
+
+  after :all do
+    Ree.disable_irb_mode
+  end
+
+  it {
+    expect(ReeRoutesTest::EmptyRoutes.new).to eq([])
+  }
+
+  it {
+    routes = ReeRoutesTest::Routes.new
+
+    expect(routes.size).to eq(2)
+
+    post_route = routes.first
+    csv_route = routes.last
+
+    expect(post_route.serializer.name).to eq(:serializer)
+    expect(post_route.action.name).to eq(:cmd)
+    expect(post_route.respond_to).to eq(:json)
+
+    expect(csv_route.respond_to).to eq(:csv)
+  }
+end

data/lib/ree_lib/packages/ree_routes/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.extend Ree::RSpecLinkDSL
+end

data/lib/ree_lib/packages/ree_text/spec/ree_text/functions/safe_join_spec.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal = true
+# frozen_string_literal: true
 
 RSpec.describe :safe_join do
   link :safe_join, from: :ree_text

data/lib/ree_lib/packages/ree_text/spec/ree_text/functions/to_sentence_spec.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal = true
+# frozen_string_literal: true
 
 RSpec.describe :to_sentence do
   link :to_sentence, from: :ree_text

data/lib/ree_lib/packages/ree_validator/spec/ree_validator/functions/validate_password_spec.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal = true
+# frozen_string_literal: true
 
 package_require('ree_validator/functions/validate_password')
 

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.0.39"
+  VERSION = "1.0.40"
 end