entangled 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5061458f7fad47437868c5e5c445d05c1e25060a
-  data.tar.gz: 4a5ea5580591c4d01aba2686a1392d1257bd818f
+  metadata.gz: b346ba92b1c5fd0eb643177f578387de48a74150
+  data.tar.gz: f7beb07dcc9533e1aa1d991b677cfbf3dc864517
 SHA512:
-  metadata.gz: eb26c2be5a2e95619dfae839f8929672fdc6e403cef4025212a1a992eac53fab21d81074b04f7ec1fc40a7caee96e83f244d70675da242ee3835d602a20e899a
-  data.tar.gz: 83a79396d556515b2a4124e15160fe513f2d12f87ef0ac0236f383a16633cdb01744b228817b4fa1d42a59b72db72d3ef3398f2eeddf1d22d81715ad03bac3c5
+  metadata.gz: 666d0fdf3236a271286c3cba63734af5c5d0d2edc4408fc9206b3cf1bfa0964a749e3ae1e0bbb0c9136d0a5233732556de4fe482c7566d56a469a7bf469a6e85
+  data.tar.gz: 6f2504708a1feb5b2efcac74d6f5c12e8300dcf23ea522a88c4c1b64fd6a8708d8689abf9e6d339c282e42feae8cf87c3e499260d85438d89aaa48db88ad01ba

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
     $ gem install entangled
 
 ## Usage
-Entangled is needed in three parts of your app. Given the example of a `MessagesController` and a `Message` model for a chat app, you will need:
+Entangled is needed in three parts of your app: Routes, models, and controllers. Given the example of a `MessagesController` and a `Message` model for a chat app, you will need:
 
 ### Routes
 Add the following to your routes file:
@@ -37,8 +37,6 @@ Add the following to your routes file:
 sockets_for :messages
 ```
 
-Replace `messages` with your resource name.
-
 Under the hood, this creates the following routes:
 
 ```ruby
@@ -49,9 +47,15 @@ get '/messages/:id/destroy', to: 'messages#destroy', as: :destroy_message
 get '/messages/:id/update', to: 'messages#update', as: :update_message
 ```
 
+The options `:only` and `:except` are available just like when using `resources`, so you can say something like:
+
+```ruby
+sockets_for :messages, only: :index # or use an array
+```
+
 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.
 
-### Model
+### Models
 Add the following to the top inside your model (e.g., a `Message` model):
 
 ```ruby
@@ -63,7 +67,7 @@ end
 
 This will create the callbacks needed to push changes to data to all clients who are subscribed. This is essentially where the data binding is set up.
 
-### Controller
+### Controllers
 Your controllers will be a little more lightweight than in a standard restful Rails app. A restful-style controller is expected and should look like this:
 
 ```ruby

data/Rakefile

@@ -1,2 +1,18 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/entangled.gemspec

@@ -15,12 +15,14 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files = Dir["spec/**/*"]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-rails', '~> 3.2'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'byebug'
   spec.add_dependency 'tubesock', '~> 0.2'
   spec.add_dependency 'rails', '~> 4.2'
 end

data/lib/entangled.rb

@@ -6,21 +6,66 @@ require 'active_support/concern'
 
 module ActionDispatch::Routing
   class Mapper
-    def sockets_for(resource, &block)
-      resources = resource.to_s.underscore.pluralize.to_sym
-      resource = resource.to_s.underscore.singularize.to_sym
-
-      get :"/#{resources}", to: "#{resources}#index", as: resources
-      get :"/#{resources}/create", to: "#{resources}#create", as: :"create_#{resource}"
-      get :"/#{resources}/:id", to: "#{resources}#show", as: resource
-      get :"/#{resources}/:id/destroy", to: "#{resources}#destroy", as: :"destroy_#{resource}"
-      get :"/#{resources}/:id/update", to: "#{resources}#update", as: :"update_#{resource}"
-
-      if block_given?
-        namespace resources do
-          yield
+    private
+    def sockets_for(resource, options = {})
+      @resources = resource.to_s.underscore.pluralize.to_sym
+      @resource = resource.to_s.underscore.singularize.to_sym
+
+      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
+          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
+          end
         end
+      else
+        draw_all
       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
+    end
+
+    def draw_create
+      get :"/#{@resources}/create", to: "#{@resources}#create", as: :"create_#{@resource}"
+    end
+
+    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
+
+    def draw_update
+      get :"/#{@resources}/:id/update", to: "#{@resources}#update", as: :"update_#{@resource}"
+    end
   end
 end

data/lib/entangled/controller.rb

@@ -1,4 +1,5 @@
 require 'tubesock'
+require 'tubesock/hijack'
 
 module Entangled
   module Controller

data/lib/entangled/model.rb

@@ -3,7 +3,6 @@ module Entangled
     module ClassMethods
       # Create after_ callbacks for options
       def entangle(options = {})
-
         # If :only is specified, the options can either
         # be an array or a symbol
         if options[:only].present?
@@ -24,7 +23,6 @@ module Entangled
         # Instead of :only, :except can be specified; similarly,
         # the options can either be an array or a symbol
         elsif options[:except].present?
-
           # If it is a symbol, it has to be taken out of the default
           # options. A callback has to be defined for each of the
           # remaining options

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/foo_controller.rb

@@ -0,0 +1,4 @@
+# This controller only serves to test the sockets_for
+# inclusion and exclusion options
+class FooController < ApplicationController
+end

data/spec/dummy/app/controllers/messages_controller.rb

@@ -0,0 +1,4 @@
+# This controller serves as fully restful example
+# controller with all five actions
+class MessagesController < ApplicationController
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "entangled"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5000
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end