render_async 0.0.2 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1519f96a0247273fcf694f6a85bae9d668ee92db
+  data.tar.gz: 4a709ff43dbb29a8bccf09e285fe0e63f224aa2b
+SHA512:
+  metadata.gz: 69aa88dbe5172447b87eb4da7cdf4b0869daa8d17b890f119e11b3a97b3ada3d35938f9f13cd54998596add714fd6cf270f3114ed1cc9054c74ff007fa9a1547
+  data.tar.gz: c3cafb358d191c916c8e57d1819e967e241811c1020f27f6b36830412dfa51640c02eb0402465dabb566509461021fcddd66fd30b6a94694baa7e1623462776c

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "spec/fixtures/restaurant-reservations"]
+	path = spec/fixtures/restaurant-reservations
+	url = git@github.com:nikolalsvk/restaurant-reservations.git
+	branch = nd/render-async

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Rendered Text
+
+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

@@ -1,62 +1,93 @@
+[![Build Status](https://semaphoreci.com/api/v1/renderedtext/render_async/branches/master/badge.svg)](https://semaphoreci.com/renderedtext/render_async)
+
 # RenderAsync
 
-Lets you render paths asynchronously in Rails with an AJAX call. You use it like this:
+Renders partials to your views **asynchronously**. This is done through adding
+Javascript code that does AJAX request to your controller which then renders
+your partial.
 
-```
-# routes.rb:
-match 'articles/counter' => 'articles#counter', :as => :articles_counter
-# ^ Of course you won't use match, but you get the idea.
+Workflow:
 
-# In a view template:
-<%= render_async articles_counter_path %>
-```
+1. user visits a page => 
+2. AJAX request on the controller action => 
+3. controller renders a partial => 
+4. partials renders in the place where you put `render_async` helper
 
-This will generate the following HTML:
-
-```html
-<div id="render_async_1a931cec881377296672"></div>
-
-<script type="text/javascript">
-(function($){
-  div_elem = $("#render_async_1a931cec881377296672");
-  $.ajax({
-    url: "/articles/counter",
-    success: function(response, status) {
-      div_elem.html(response);
-    }
-  });
-}(jQuery));
-</script>
-```
+Javascript is injected into `<%= content_for :render_async %>` so you choose
+where to put it.
 
-## Requirements
+## Installation
 
-RenderAsync depends on a footer-block in your application-wide template, like this:
+Add this line to your application's Gemfile:
 
-```erb
-<%= yield :footer %>
+```ruby
+gem 'render_async', :source => "https://gem.fury.io/renderedtext/"
 ```
 
-And it also depends on you having included jQuery on the page.
+And then execute:
 
-## Installation
+    $ bundle
 
-Add this line to your application's Gemfile:
+## Usage
 
-    gem 'render_async'
+1. Include `render_async` view helper somewhere in your views:
 
-And then execute:
+    ```ruby
+    # app/views/comments/show.html.erb
 
-    $ bundle
+    <%= render_async comment_stats_path %>
+    ```
 
-Or install it yourself as:
+2. Then create a route that will `config/routes.rb`
+    ```ruby
+    # config/routes.rb
 
-    $ gem install render_async
+    get :comment_stats, :controller => :comments
+    ```
+
+3. Fill in the logic in your controller
+    ```ruby
+    # app/controllers/comments_controller.rb
+
+    def comment_stats
+      @stats = Comment.get_stats
+
+      render :patial => "comment_stats"
+    end
+    ```
+
+4. Create a partial that will render
+    ```ruby
+    # app/views/comments/_comment_stats.html.erb
+
+    <div class="col-md-6">
+      <%= @stats %>
+    </div>
+    ```
+
+5. Add `content_for` in your base view file
+    ```ruby
+    # application.html.erb
+
+    <%= content_for :render_async %>
+    ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/renderedtext/render_async.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/views/render_async/_render_async.html.erb

@@ -1,15 +1,25 @@
-<div id="<%= container_name %>"></div>
+<div id="<%= container_name %>">
+  <div id="<%= container_name %>_spinner" class="sk-spinner sk-spinner-double-bounce">
+    <div class="sk-double-bounce1"></div>
+    <div class="sk-double-bounce2"></div>
+  </div>
+</div>
 
-<% content_for :footer do %>
+<% content_for :render_async do %>
   <script type="text/javascript">
     (function($){
-      div_elem = $("#<%= container_name %>");
       $.ajax({
-        url: "<%= path %>",
-        success: function(response, status) {
-          div_elem.html(response);
-        }
-      });
+          url: "<%= path %>",
+        })
+        .done(function(response, status) {
+          $("#<%= container_name %>").html(response);
+        })
+        .fail(function(response, status) {
+          $("#<%= container_name %>").html(response);
+        })
+        .always(function(response, status) {
+          $("#<%= container_name %>_spinner").hide();
+        });
     }(jQuery));
   </script>
 <% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "render_async"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/render_async.rb

@@ -1,3 +1,5 @@
 require "render_async/version"
+require "render_async/view_helper"
+require "render_async/engine" if defined? Rails
 
-require 'render_async/railtie' if defined?(Rails)
+ActionView::Base.send :include, RenderAsync::ViewHelper if defined? ActionView::Base

data/lib/render_async/engine.rb

@@ -0,0 +1,5 @@
+module RenderAsync
+  class Engine < Rails::Engine
+    # Make it a Rails Engine
+  end
+end

data/lib/render_async/version.rb

@@ -1,3 +1,3 @@
 module RenderAsync
-  VERSION = "0.0.2"
+  VERSION = "0.1.1"
 end

data/lib/render_async/view_helper.rb

@@ -0,0 +1,14 @@
+require 'securerandom'
+
+module RenderAsync
+  module ViewHelper
+
+    def render_async(path)
+      container_name = "render_async_#{SecureRandom.hex(5)}#{Time.now.to_i}"
+
+      render "render_async/render_async", :container_name => container_name,
+                                          :path => path
+    end
+
+  end
+end

data/render_async.gemspec

@@ -6,18 +6,22 @@ require 'render_async/version'
 Gem::Specification.new do |spec|
   spec.name          = "render_async"
   spec.version       = RenderAsync::VERSION
-  spec.authors       = ["Kasper Grubbe"]
-  spec.email         = ["kawsper@gmail.com"]
-  spec.description   = %q{RenderAsync lets you include pages asynchronously with AJAX}
-  spec.summary       = %q{RenderAsync lets you include pages asynchronously with AJAX}
-  spec.homepage      = "https://github.com/kaspergrubbe/render_async"
+  spec.authors       = ["Kasper Grubbe", "nikolalsvk"]
+  spec.email         = ["nikolaseap@gmail.com"]
+
+  spec.summary       = "Render parts of the page asynchronously with AJAX"
+  spec.description   = "Load parts of your page through simple Javascript and Rails pipeline"
+  spec.homepage      = "https://github.com/renderedtext/render_async"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
 end

metadata

@@ -1,91 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: render_async
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Kasper Grubbe
+- nikolalsvk
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '1.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: RenderAsync lets you include pages asynchronously with AJAX
+        version: '3.2'
+description: Load parts of your page through simple Javascript and Rails pipeline
 email:
-- kawsper@gmail.com
+- nikolaseap@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - app/views/render_async/_render_async.html.erb
+- bin/console
+- bin/setup
 - lib/render_async.rb
-- lib/render_async/rails/engine.rb
-- lib/render_async/railtie.rb
+- lib/render_async/engine.rb
 - lib/render_async/version.rb
+- lib/render_async/view_helper.rb
 - lib/render_async/view_helpers.rb
 - render_async.gemspec
-homepage: https://github.com/kaspergrubbe/render_async
+homepage: https://github.com/renderedtext/render_async
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.2
 signing_key: 
-specification_version: 3
-summary: RenderAsync lets you include pages asynchronously with AJAX
+specification_version: 4
+summary: Render parts of the page asynchronously with AJAX
 test_files: []
-has_rdoc: 

data/lib/render_async/rails/engine.rb

@@ -1,7 +0,0 @@
-module RenderAsync
-  module Rails
-    class Engine < ::Rails::Engine
-      # auto wire
-    end
-  end
-end

data/lib/render_async/railtie.rb

@@ -1,11 +0,0 @@
-require 'render_async/view_helpers'
-
-module RenderAsync
-  class Railtie < Rails::Railtie
-    initializer "render_async.view_helpers" do
-      ActionView::Base.send :include, ViewHelpers
-    end
-  end
-end
-
-require 'render_async/rails/engine'