spread_beaver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44dcd6c05da8f54db561229e1656865172be4d9e
+  data.tar.gz: bbd1b31028cbe167fa9cae3441dd62eab5162d2c
+SHA512:
+  metadata.gz: 103d3a26a8d6aab84d105c3e594e2f7152283d0a0a122de0a51d5f9326b01dcc2621f7e2bc389d98b20526a2009e3bbcc5f453d387ba62c57cf58f6888a8d4b8
+  data.tar.gz: 986c790139c16dc2546846318943778678cda0cad5fe670b3d646e6cceacb9a2d35d5ea06ead47ac285dacabadb1a179f1d3e61bd11a61c490dc236a5e5ded47

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 shinya takahashi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# SpreadBeaver
+Server side Javascript runner in Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spread_beaver'
+```
+
+## Getting Started
+
+### Edit config/application.rb
+```
+# These are the defaults if you dont specify any yourself
+config.spread_beaver.pool_size = 10 #ExecJS instance size
+config.spread_beaver.timeout = 20 #ExecJS timeout
+config.spread_beaver.bundle = "server-side-bundle.js" #Javascript file placed at under app/assets/javascripts
+```
+
+### Create config/initializers/spread_beaver.rb
+```
+module SpreadBeaver
+  class Runner
+    # Execute javascript in javascript context before every SpreadBeaver::Runner.exec
+    def initialize_script
+      "clearAllStores();"
+    end
+
+    # Execute queued javascript in javascript context before every SpreadBeaver::Runner.exec
+    def exec_queued_module module_name, props
+      "#{module_name}.init(#{props_to_s(props)});"
+    end
+
+    # Execute javascript by SpreadBeaver::Runner.exec
+    def exec_module module_name, props
+      "#{module_name}.render(#{props_to_s(props)});"
+    end
+  end
+end
+```
+
+## API
+
+- **SpreadBeaver::Runner.queue(module_name, props)**:  
+Push hash that has passed values to request store.  
+Execute `exec_queued_module` with stored hash data.
+
+- **SpreadBeaver::Runner.exec(module_name, props)**:  
+Execute `exec_module` with connection pooling.
+
+## Example
+Rails, Browserify, React, Flux, Server side rendering example.  
+Go to https://github.com/oreshinya/spread_beaver/tree/master/example !

data/lib/spread_beaver.rb

@@ -0,0 +1,9 @@
+require "active_support/core_ext/class/attribute_accessors"
+require "active_support/core_ext/string/output_safety"
+require "connection_pool"
+require "execjs"
+require "request_store"
+
+require "spread_beaver/version"
+require "spread_beaver/runner"
+require "spread_beaver/railtie"

data/lib/spread_beaver/railtie.rb

@@ -0,0 +1,27 @@
+require "rails"
+
+module SpreadBeaver
+  class Railtie < ::Rails::Railtie
+    config.spread_beaver = ActiveSupport::OrderedOptions.new
+    config.spread_beaver.pool_size = 10
+    config.spread_beaver.timeout = 20
+    config.spread_beaver.bundle = "server-side-bundle.js"
+
+    initializer "spread_beaver.add_watchable_files", group: :all do |app|
+      watch_file = "#{Rails.root}/app/assets/javascripts/#{app.config.spread_beaver.bundle}"
+      app.config.watchable_files.push watch_file
+    end
+
+    config.after_initialize do |app|
+      cnf = config.spread_beaver
+      setup = -> {
+        SpreadBeaver::Runner.setup!(
+          app.assets[cnf.bundle].to_s,
+          {size: cnf[:pool_size], timeout: cnf[:timeout]}
+        )
+      }
+      setup.call
+      ActionDispatch::Reloader.to_prepare(&setup)
+    end
+  end
+end

data/lib/spread_beaver/runner.rb

@@ -0,0 +1,71 @@
+module SpreadBeaver
+  class Runner
+    QUEUE_KEY = :_spread_beaver_queue
+
+    cattr_accessor :pool
+
+    def self.setup! bundle, opts={size: 10, timeout: 20}
+      @@bundle = bundle
+      @@pool.shutdown{} if @@pool
+      @@pool = ConnectionPool.new(opts) { self.new }
+    end
+
+    def self.exec module_name, props
+      @@pool.with do |r|
+        r.exec module_name, props
+      end
+    end
+
+    def self.queue module_name, props
+      if RequestStore.store[QUEUE_KEY].nil?
+        RequestStore.store[QUEUE_KEY] = []
+      end
+      RequestStore.store[QUEUE_KEY].push module_name: module_name, props: props
+    end
+
+    def exec module_name, props
+      js_code = "(function() {"
+      js_code += initialize_script if !initialize_script.nil?
+      if !RequestStore.store[self.class::QUEUE_KEY].nil?
+        RequestStore.store[self.class::QUEUE_KEY].each do |store|
+          str = exec_queued_module store[:module_name], store[:props]
+          js_code += str if !str.nil?
+        end
+      end
+      js_code += "return #{exec_module module_name, props}"
+      js_code += "})()"
+      context.eval(js_code).html_safe
+    end
+
+    private
+
+    def context
+      @context ||= ExecJS.compile <<-JS
+        var global = {};
+        #{@@bundle}
+      JS
+    end
+
+    def initialize_script
+      #Override this.
+      nil
+    end
+
+    def exec_queued_module module_name, props
+      #Override this.
+      nil
+    end
+
+    def exec_module module_name, props
+      raise "Override this."
+    end
+
+    def props_to_s props
+      if props.is_a? String
+        props
+      else
+        props.to_json
+      end
+    end
+  end
+end

data/lib/spread_beaver/version.rb

@@ -0,0 +1,3 @@
+module SpreadBeaver
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: spread_beaver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- shinya takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Server side Javascript runner in Ruby on Rails.
+email:
+- s.takahashi313@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/spread_beaver.rb
+- lib/spread_beaver/railtie.rb
+- lib/spread_beaver/runner.rb
+- lib/spread_beaver/version.rb
+homepage: https://github.com/oreshinya/spread_beaver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Server side Javascript runner in Ruby on Rails.
+test_files: []