entangled 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c26b49537871a591ca346338518c72959721f39a
-  data.tar.gz: b1edc3cd5f06358c30ce85ef8146da53db890704
+  metadata.gz: dd3064c1f6e0a2646581f73b82460adadd183021
+  data.tar.gz: a7de74b2b66c782d00af12c4c6ca6788e068b37c
 SHA512:
-  metadata.gz: 54880c5779d9979ac8f97728b5e939fa3af5ffff4e76a5f330314cf3eb9b1fd7d609cd15e2be8ba6273019c5441db8d59788013763f2c4c15758024bb70c4e31
-  data.tar.gz: 98ab954df3d7f04be3bd6a8f0662a33f0b88626e5ab06c6b5351d3721a3c7de63350af215da5ead09d6e29c2c61434b2aefe1ff9bc5eb11d2f12de68281da86d
+  metadata.gz: 1b5c9a3d4f5b9a6b3706653162c143cad14f308d5293041faf42058a0e960d87d32b04ae6e04f31dc6101bffe15449e9ef217f3c50749fd647bb6edf82f0e9cf
+  data.tar.gz: cc0882bc886ac6aca547bb34eb398731ce8fa912acffa270f80b0d97d774b66efb473d18053b2503731c53339d72f885d9654967a5aa9abc471d247416fbb6db

data/README.md

@@ -43,24 +43,40 @@ sockets_for :messages
 
 Under the hood, this creates the following routes:
 
-```ruby
-get '/messages', to: 'messages#index', as: :messages
-get '/messages/create', to: 'messages#create', as: :create_message
-get '/messages/:id', to: 'messages#show', as: :message
-get '/messages/:id/destroy', to: 'messages#destroy', as: :destroy_message
-get '/messages/:id/update', to: 'messages#update', as: :update_message
+```shell
+         Prefix Verb URI Pattern                      Controller#Action
+       messages GET  /messages(.:format)              messages#index
+        message GET  /messages/:id(.:format)          messages#show
+create_messages GET  /messages/create(.:format)       messages#create
+ update_message GET  /messages/:id/update(.:format)   messages#update
+destroy_message GET  /messages/:id/destroy(.:format)  messages#destroy
 ```
 
-The options `:only` and `:except` are available just like when using `resources`, so you can say something like:
+Note that websockets don't speak HTTP, so only GET requests are available. That's why these routes deviate slightly from restful routes. Also note that there are no `edit` and `new` actions, since an Entangled controller is only concerned with rendering data, not views.
+
+You can use `sockets_for` just like `resources`, including the following features:
 
 ```ruby
-sockets_for :messages, only: :index # or use an array
-```
+# Inclusion/exclusion
+sockets_for :messages, only: :index
+sockets_for :messages, only: [:index, :show]
+
+sockets_for :messages, except: :index
+sockets_for :messages, except: [:index, :show]
 
-Note that Websockets don't speak HTTP, so only GET requests are available. That's why these routes deviate slightly from restful routes. Also note that there are no `edit` and `new` actions, since an Entangled controller is only concerned with rendering data, not views.
+# Nesting
+sockets_for :parents do
+  sockets_for :children
+end
+
+# Multiple routes at once
+sockets_for :foos, :bars
+
+# ...etc
+```
 
 ### Models
-Add the following to the top inside your model (e.g., a `Message` model):
+Add the following to the top of your model (e.g., a `Message` model):
 
 ```ruby
 class Message < ActiveRecord::Base
@@ -80,7 +96,8 @@ By default, the following callbacks will be added:
 You can limit this behavior by specifying `:only` or `:except` options. For example, if you don't want to propagate the destruction or update of an object to all connected clients, you can do the following:
 
 ```ruby
-entangle only: :create # or use an array
+entangle only: :create
+entangled only: [:create, :update]
 ```
 
 ### Controllers

data/lib/entangled/routes.rb

@@ -1,65 +1,89 @@
 module ActionDispatch::Routing
   class Mapper
     private
-    def sockets_for(resource, options = {})
-      @resources = resource.to_s.underscore.pluralize.to_sym
-      @resource = resource.to_s.underscore.singularize.to_sym
 
+    # Generates five routes that all use GET requests.
+    # For example:
+    # 
+    #   sockets_for :messages
+    # 
+    # will create the following routes:
+    # 
+    #          Prefix Verb URI Pattern                     Controller#Action
+    # create_messages GET  /messages/create(.:format)      messages#create
+    #  update_message GET  /messages/:id/update(.:format)  messages#update
+    # destroy_message GET  /messages/:id/destroy(.:format) messages#destroy
+    #        messages GET  /messages(.:format)             messages#index
+    #         message GET  /messages/:id(.:format)         messages#show
+    # 
+    # This method can nested by passing a block, and
+    # the options :only and :except can be used just like
+    # with the method 'resources'
+    def sockets_for(*args, &block)
+      options = args.extract_options!
+      routes = infer_routes(options)
+      resource_routes = infer_resource_routes(routes)
+
+      # Generate index and show routes
+      resources *args, only: resource_routes do
+        # Generate create route
+        collection do
+          get 'create', as: :create if routes.include?(:create)
+        end
+
+        # Generate update and destroy routes
+        member do
+          get 'update', as: :update if routes.include?(:update)
+          get 'destroy', as: :destroy if routes.include?(:destroy)
+        end
+
+        # Nest routes
+        yield if block_given?
+      end
+    end
+
+    def default_routes
+      [:index, :create, :show, :destroy, :update]
+    end
+
+    # Find out which routes should be generated
+    # inside resources method. These can be :create,
+    # :update, and :destroy, and are the ones that
+    # need to be overridden to use GET requests
+    # instead of PATCH, POST and DELETE
+    def infer_routes(options)
       if options.any?
         if options[:only]
-          if options[:only].is_a? Symbol
-            send :"draw_#{options[:only]}"
-          elsif options[:only].is_a? Array
-            options[:only].each do |option|
-              send :"draw_#{option}"
-            end
+          if options[:only].is_a?(Symbol)
+            routes = [options[:only]]
+          elsif options[:only].is_a?(Array)
+            routes = options[:only]
           end
         elsif options[:except]
-          if options[:except].is_a? Symbol
-            (default_options - [options[:except]]).each do |option|
-              send :"draw_#{option}"
-            end
-          elsif options[:except].is_a? Array
-            (default_options - options[:except]).each do |option|
-              send :"draw_#{option}"
-            end
+          if options[:except].is_a?(Symbol)
+            routes = default_routes - [options[:except]]
+          elsif options[:except].is_a?(Array)
+            routes = default_routes - options[:except]
           end
         end
       else
-        draw_all
+        routes = default_routes
       end
-    end
-
-    def default_options
-      [:index, :create, :show, :destroy, :update]
-    end
-
-    def draw_all
-      draw_index
-      draw_create
-      draw_show
-      draw_destroy
-      draw_update
-    end
 
-    def draw_index
-      get :"/#{@resources}", to: "#{@resources}#index", as: @resources
+      routes
     end
 
-    def draw_create
-      get :"/#{@resources}/create", to: "#{@resources}#create", as: :"create_#{@resource}"
-    end
+    # Find out if the resources method should create
+    # :index and :show routes. These two do not need
+    # to be overridden since they use GET requests
+    # by default
+    def infer_resource_routes(routes)
+      resource_routes = []
 
-    def draw_show
-      get :"/#{@resources}/:id", to: "#{@resources}#show", as: @resource
-    end
-
-    def draw_destroy
-      get :"/#{@resources}/:id/destroy", to: "#{@resources}#destroy", as: :"destroy_#{@resource}"
-    end
+      resource_routes << :index if routes.include?(:index)
+      resource_routes << :show if routes.include?(:show)
 
-    def draw_update
-      get :"/#{@resources}/:id/update", to: "#{@resources}#update", as: :"update_#{@resource}"
+      resource_routes
     end
   end
 end

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/spec/dummy/config/routes.rb

@@ -8,4 +8,9 @@ Rails.application.routes.draw do
   sockets_for :bars, only: [:index, :show]
   sockets_for :foobars, except: :index
   sockets_for :barfoos, except: [:index, :show]
+
+  # Test nested routes
+  sockets_for :lists do
+    sockets_for :items
+  end
 end

data/spec/routing/messages_routing_spec.rb

@@ -12,8 +12,8 @@ RSpec.describe MessagesController, type: :routing do
   end
 
   describe '#create' do
-    it 'matches the create_message_path' do
-      expect(create_message_path).to eq '/messages/create'
+    it 'matches the create_messages_path' do
+      expect(create_messages_path).to eq '/messages/create'
     end
 
     it 'routes to #create' do

data/spec/routing/nested_routing_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+RSpec.describe 'Nested routes', type: :routing do
+  before(:context) do
+    # Create arbitrary controllers here rather than
+    # having a separate file for each in app/controllers
+    class ListsController < ApplicationController; end
+    class ItemsController < ApplicationController; end
+  end
+
+  describe 'parent routes' do
+    describe '#index' do
+      it 'matches the lists_path' do
+        expect(lists_path).to eq '/lists'
+      end
+
+      it 'routes to #index' do
+        expect(get: '/lists').to route_to 'lists#index'
+      end
+    end
+
+    describe '#create' do
+      it 'matches the create_list_path' do
+        expect(create_lists_path).to eq '/lists/create'
+      end
+
+      it 'routes to #create' do
+        expect(get: '/lists/create').to route_to 'lists#create'
+      end
+    end
+
+    describe '#show' do
+      it 'matches the list_path' do
+        expect(list_path('1')).to eq '/lists/1'
+      end
+
+      it 'routes to #show' do
+        expect(get: '/lists/1').to route_to 'lists#show', id: '1'
+      end
+    end
+
+    describe '#destroy' do
+      it 'matches the destroy_list_path' do
+        expect(destroy_list_path('1')).to eq '/lists/1/destroy'
+      end
+
+      it 'routes to #destroy' do
+        expect(get: '/lists/1/destroy').to route_to 'lists#destroy', id: '1'
+      end
+    end
+
+    describe '#update' do
+      it 'matches the update_list_path' do
+        expect(update_list_path('1')).to eq '/lists/1/update'
+      end
+
+      it 'routes to #update' do
+        expect(get: '/lists/1/update').to route_to 'lists#update', id: '1'
+      end
+    end
+  end
+
+  describe 'child routes' do
+    describe '#index' do
+      it 'matches the list_item_path' do
+        expect(list_items_path('1')).to eq '/lists/1/items'
+      end
+
+      it 'routes to #index' do
+        expect(get: '/lists/1/items').to route_to 'items#index', list_id: '1'
+      end
+    end
+
+    describe '#create' do
+      it 'matches the create_list_item_path' do
+        expect(create_list_items_path('1')).to eq '/lists/1/items/create'
+      end
+
+      it 'routes to #create' do
+        expect(get: '/lists/1/items/create').to route_to 'items#create', list_id: '1'
+      end
+    end
+
+    describe '#show' do
+      it 'matches the list_item_path' do
+        expect(list_item_path(id: '1', list_id: '1')).to eq '/lists/1/items/1'
+      end
+
+      it 'routes to #show' do
+        expect(get: '/lists/1/items/1').to route_to 'items#show', list_id: '1', id: '1'
+      end
+    end
+
+    describe '#destroy' do
+      it 'matches the destroy_list_item_path' do
+        expect(destroy_list_item_path(id: '1', list_id: '1')).to eq '/lists/1/items/1/destroy'
+      end
+
+      it 'routes to #destroy' do
+        expect(get: '/lists/1/items/1/destroy').to route_to 'items#destroy', list_id: '1', id: '1'
+      end
+    end
+
+    describe '#update' do
+      it 'matches the update_list_item_path' do
+        expect(update_list_item_path(id: '1', list_id: '1')).to eq '/lists/1/items/1/update'
+      end
+
+      it 'routes to #update' do
+        expect(get: '/lists/1/items/1/update').to route_to 'items#update', list_id: '1', id: '1'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entangled
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Dennis Charles Hackethal
@@ -232,6 +232,7 @@ files:
 - spec/models/message_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb
 - spec/routing/messages_routing_spec.rb
+- spec/routing/nested_routing_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dchacke/entangled
 licenses:
@@ -318,4 +319,5 @@ test_files:
 - spec/models/message_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb
 - spec/routing/messages_routing_spec.rb
+- spec/routing/nested_routing_spec.rb
 - spec/spec_helper.rb