chartkick-remote 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e2aecd2927354c657db8bd089ea21ae93c195b8
+  data.tar.gz: a82b9562e69548bb9ebe01c86dc78d6e946d760c
+SHA512:
+  metadata.gz: 132590888dad96644b1409a157b0fb1e616df4f8e73e8c4246fd9f540c18cb3d892136bb08446111a952b8e6d788712ae7d3dda11fcf11fbf0fd9e4738641f2d
+  data.tar.gz: 7689dabb3a643727d697ceafff7357ea1faf50fb6276d94e82b967a0404a9ccf331c1a4f8a248c31f27ccc7784cc7a10949cb545d5986ec872feebcfe1359130

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby*
+.idea*
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec
+
+script:
+  CODECLIMATE_REPO_TOKEN=25d03499fa4fad3f1edcd9d382e7a8d98a340b313cf9384ca2c679c8bf25d721 bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chartkick.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Brown based on work by Andrew Kane
+
+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,77 @@
+# Chartkick Remote
+
+[![Travis CI Status](https://travis-ci.org/dontfidget/chartkick-remote.svg?branch=master)](https://travis-ci.org/dontfidget/chartkick-remote)
+
+[![Code Climate](https://codeclimate.com/github/dontfidget/chartkick-remote.png)](https://codeclimate.com/github/dontfidget/chartkick-remote)
+
+## Usage
+
+This is an add-on to ankane's Chartkick to allow the user to specify chart data in a block and have it automatically sourced remotely to avoid making too many queries in the original page render.
+
+For more on the fabulous Chartkick library, see http://ankane.github.io/chartkick/.
+
+
+In your controller, add the following to tell the controller to respond to json requests for chart data:
+
+```ruby
+include Chartkick::Remote
+chartkick_remote
+```
+
+Then in your views, pass your data as a block:
+
+```ruby
+<%= line_chart { Task.group_by_day(:completed_at).count } %>
+```
+
+To prevent remote requests for a particular chart, set `remote` to `false` in the chart options:
+
+```ruby
+<%= line_chart(remote: false) { Task.group_by_day(:completed_at).count } %>
+```
+
+This will generate the data set immediately when the page is rendered.
+
+
+You can also pass arguments to chartkick for all views on your controller as options for the `chartkick_remote` call:
+
+```ruby
+<%= chartkick_remote height: "500px" %>
+```
+
+Finally, if you need to, you can restrict chartkick_remote to particular views: 
+
+```ruby
+<%= chartkick_remote only: :show %>
+```
+
+This will prevent the remote requests for other views.
+
+## Installation
+
+First, set up 'chartkick' as described at http://ankane.github.io/chartkick/.
+
+Then, add this line to your application's Gemfile:
+
+```
+gem 'chartkick-remote'
+```
+
+## How it Works
+
+This gem works by *not* executing "remote" blocks when initially rendering your html page or when making any json request other than the single request that actually needs the data generated in that block.  When responding to a json request, the controller will actually render your template, but only to a string that it will discard, and only so that it can find and execute the one block that is generating the data for this json request.  This means that:
+  
+  * You can't use results from any code included in any prior "remote" blocks.
+  * You should try to do minimal work outside of your block, so that it doesn't get executed unnecessarily for each json request.  Specifically, if you define partial results that you will use in your block, make sure that they are lazily evaluated.
+
+## Handling *Many* Requests at Once
+
+Using this methodology, it's easy to write a page that makes many, many json requests, which may swamp your server and possibly even time out if you have a global `timeout` value set for your ajax requests.  @maccman's jquery.ajax.queue.coffee script provides a basic queueing transport layer for ajax requests which I've modified to provide an option to set the maximum number of requests that can be made in parallel (see https://gist.github.com/dontfidget/1ad9ab33971b64fe6fef).  If you include the javascript in this gist on your page, you can then specify the maximum number of allowable requests globally for your page as follows:
+
+```
+  $.ajaxSetup({queue: true, queueMaxConcurrency: 2});
+```
+
+
+
+

data/Rakefile

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

data/chartkick_remote.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chartkick/remote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chartkick-remote"
+  spec.version       = Chartkick::Remote::VERSION
+  spec.authors       = ["Andrew S. Brown"]
+  spec.email         = ["andrew@dontfidget.com"]
+  spec.description   = %q{Automatically generate remote json for chartkick}
+  spec.summary       = %q{Automatically generate remote json for chartkick}
+  spec.homepage      = ""
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "chartkick"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "travis-lint"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rspec-html-matchers"
+end

data/lib/chartkick/remote.rb

@@ -0,0 +1,6 @@
+require 'chartkick/remote/helper'
+require 'chartkick/remote/remote'
+
+ActiveSupport.on_load(:action_view) do
+  include Chartkick::Remote::Helper
+end

data/lib/chartkick/remote/helper.rb

@@ -0,0 +1,59 @@
+require 'active_support/core_ext'
+require 'chartkick'
+
+module Chartkick::Remote
+  module Helper
+    include Chartkick::Helper
+
+    %w{line_chart pie_chart column_chart bar_chart area_chart geo_chart}.each do |type|
+      define_method :"#{type}_with_remote" do |data_source = nil, options = {}, &block|
+        chartkick_remote_chart type, data_source, options, &block
+      end
+
+      alias_method_chain :"#{type}", :remote
+    end
+
+    private
+
+    def chartkick_remote_chart(type, data_source, options, &block)
+      if block_given? && data_source.is_a?(Hash)
+        options = data_source
+      end
+
+      options = options.dup
+      options.reverse_merge!(controller.chartkick_options) if controller.respond_to?(:chartkick_options)
+
+      standalone = options.delete(:standalone)
+      remote = options.delete(:remote)
+      skip = false
+
+      if remote
+        @remote_chart_id = (@remote_chart_id || 0) + 1
+        chart_id = controller.params[:_chartkick_remote_chart_id]
+        if chart_id # json request
+          controller.chartkick_remote_blocks ||= {}
+          controller.chartkick_remote_blocks[@remote_chart_id] = block
+          skip = standalone && chart_id.to_s != @remote_chart_id.to_s
+        else
+          data_source = url_for(params.merge(_chartkick_remote_chart_id: @remote_chart_id, format: :json))
+        end
+      elsif block_given?
+        data_source = block.call
+      end
+
+      result = send(:"#{type}_without_remote", data_source, options)
+
+      if remote && standalone
+        result = '<div>Skipped</div>'.html_safe if skip
+
+        standalone_link = link_to 'Standalone',
+                                  url_for(params.merge(_chartkick_remote_chart_id: @remote_chart_id,
+                                                       _chartkick_remote_standalone: 1))
+
+        result += standalone_link.html_safe
+      end
+
+      result
+    end
+  end
+end

data/lib/chartkick/remote/remote.rb

@@ -0,0 +1,46 @@
+module Chartkick::Remote
+  extend ActiveSupport::Concern
+  attr_accessor :chartkick_remote_blocks
+  attr_accessor :chartkick_options
+
+  included do
+    class_attribute :chartkick_options
+  end
+
+  module Responder
+    def to_json
+      controller.render_to_string(options.merge(formats: [:html], layout: false))
+      data_source = controller.chartkick_remote_blocks[controller.params[:_chartkick_remote_chart_id].to_i].call
+      data_source = data_source.chart_json if data_source.respond_to?(:chart_json)
+      render json: data_source
+    end
+  end
+
+  def default_render(*)
+    if params[:_chartkick_remote_chart_id] && !params[:_chartkick_remote_standalone]
+      respond_with nil
+    else
+      super
+    end
+  end
+
+  module ClassMethods
+    def chartkick_remote(options = {})
+      options = options.dup
+
+      action_filter_options = options.extract!(:only, :except)
+
+      respond_to :json, action_filter_options
+
+      self.responder = Class.new(responder) do
+        include Responder
+      end
+
+      before_filter action_filter_options do
+        self.chartkick_options = self.class.chartkick_options
+      end
+
+      self.chartkick_options = {remote: true}.merge(options)
+    end
+  end
+end

data/lib/chartkick/remote/version.rb

@@ -0,0 +1,5 @@
+module Chartkick
+  module Remote
+    VERSION = "1.0.2"
+  end
+end

data/spec/controllers/remote_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'chartkick/remote'
+
+AnonymousRoutes = ActionDispatch::Routing::RouteSet.new.tap do |routes|
+  routes.draw { resources :anonymous }
+end
+
+describe Chartkick::Remote, type: :controller do
+  render_views
+
+  AnonymousController = Class.new(ActionController::Base) do
+    include Chartkick::Remote
+
+    prepend_view_path 'spec/controllers/views'
+
+    include AnonymousRoutes.url_helpers
+    helper AnonymousRoutes.url_helpers
+
+    def index
+    end
+  end
+
+  controller AnonymousController do
+    chartkick_remote
+  end
+
+  describe "GET" do
+    routes { AnonymousRoutes }
+
+    it "generates a remote data source" do
+      get :index, format: :html
+      expect(response.body).to include '_chartkick_remote_chart_id=1'
+    end
+
+    it "returns the remote data source as json" do
+      get :index, _chartkick_remote_chart_id: 1, format: :json
+      expect(JSON.parse(response.body)).to eq [[0,1]]
+    end
+
+    describe "when the standalone option is set" do
+      controller AnonymousController do
+        chartkick_remote standalone: true
+      end
+
+      it "does not show any other charts but the selected chart" do
+        get :index, _chartkick_remote_chart_id: 1, _chartkick_remote_standalone: 1, format: :html
+
+        expect(response.body).to have_tag :div, 'Skipped' #, count: 1
+      end
+    end
+  end
+end

data/spec/controllers/views/anonymous/index.html.erb

@@ -0,0 +1,2 @@
+<%= line_chart { [[0,1]] } %>
+<%= line_chart { [[1,2]] } %>

data/spec/helpers/helper_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'chartkick/remote'
+
+AnonymousRoutes = ActionDispatch::Routing::RouteSet.new.tap do |routes|
+  routes.draw { resources :anonymous }
+end
+
+describe Chartkick::Remote::Helper, type: :helper do
+  describe "when the standalone option is set" do
+    it "includes a link to the standalone version of the chart" do
+
+      @controller.singleton_class.class_eval do
+        include Chartkick::Remote
+        include AnonymousRoutes.url_helpers
+        chartkick_remote
+      end
+
+      helper.singleton_class.class_eval do
+        include AnonymousRoutes.url_helpers
+      end
+
+      @controller.params.merge!(
+        action: :index,
+        controller: :anonymous
+      )
+
+      expect(helper.line_chart(standalone: true) { [[0,1]] }).to have_tag :a #, with: { href: /_chartkick_remote_standalone/ }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'active_support'
+require 'action_view'
+require 'action_controller'
+require 'rails/engine'
+require 'rspec/rails'
+require 'rspec-html-matchers'
+require 'pry'
+
+module Rails
+  def self.application
+    OpenStruct.new(routes: nil, env_config: {})
+  end
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: chartkick-remote
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Andrew S. Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: chartkick
+  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: activesupport
+  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: 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: rspec-rails
+  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: pry
+  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: pry-doc
+  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: travis-lint
+  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: codeclimate-test-reporter
+  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: rspec-html-matchers
+  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'
+description: Automatically generate remote json for chartkick
+email:
+- andrew@dontfidget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chartkick_remote.gemspec
+- lib/chartkick/remote.rb
+- lib/chartkick/remote/helper.rb
+- lib/chartkick/remote/remote.rb
+- lib/chartkick/remote/version.rb
+- spec/controllers/remote_spec.rb
+- spec/controllers/views/anonymous/index.html.erb
+- spec/helpers/helper_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically generate remote json for chartkick
+test_files:
+- spec/controllers/remote_spec.rb
+- spec/controllers/views/anonymous/index.html.erb
+- spec/helpers/helper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: