async_data_fetch 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84b341f341c0822c374b7e8bb13527f3664f5984
+  data.tar.gz: 67e69dcde23cf0d7d9824846ad1082c709deb530
+SHA512:
+  metadata.gz: 1be16bb5a8e03ce3fa8f07df79b59763b22fe4bffacf4f3d863ccde6119868f997cb893c4f7a891ab817b7dc848c14a427b5d948c78b85b79d7a6ac10cf251f3
+  data.tar.gz: 76a6164092546ae174931ed6a45ce1f3f1b21d40456e88d1304c96bbd3d41ad2329be13e6676f92332f3947d56e5304e03b36333c564fef1d9bc4bb19c2bf6ed

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Leo Benkel
+
+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.rdoc

@@ -0,0 +1,17 @@
+= AsyncDataFetch
+
+This project rocks and uses MIT-LICENSE.
+
+To use:
+
+<%= fetch_async(model_name: "Wickwall", model_id: 90 , model_method: "plop", tag: "span", display_error: true) %>
+
+model_name is the name of your model you want to fetch data from
+model_id is the id of the row
+model_method is the method you want to call
+tag is the wrapper tag, if absent, will be 'span'
+display_error is for debug, you'll see more information into the html and into the javascript console.
+
+
+TODO:
+make the controller test work. I am having issues with routing if someone want to help me.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AsyncDataFetch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/async_data_fetch/fetcher.js

@@ -0,0 +1,30 @@
+$(document).ready(function(){
+	$('.fetch_data_async').each(function(i, elem){
+		var model_name = $(elem).data().model_name;
+		var model_id = $(elem).data().model_id;
+		var model_method = $(elem).data().model_method;
+		var display_error = $(elem).data().display_error;
+
+		$.ajax({
+			url: '/async_data_fetch/get_async_data',
+			data: 'model_name=' + model_name + "&model_id=" + model_id + "&model_method=" + model_method,
+			method: 'post',
+			//dataType:"html",
+			async:true,
+			success: function(data){
+				//console.log("SUCCEED: " + data.success)
+				$(elem).text(data.success);
+			},
+			error: function(data){
+				if(display_error) {
+					console.log("ERROR: " + data.responseJSON.error);
+					$(elem).text("ERROR: " + data.responseJSON.error);
+				} else {
+					$(elem).text("FAILED");
+					console.log("You can use 'display_error: true' to get more detailed on the error.")
+				}
+			},
+
+		})
+	})
+})

data/app/assets/javascripts/async_data_fetch/index.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require jquery_ujs
+//= require ./fetcher

data/app/controllers/async_data_fetch/application_controller.rb

@@ -0,0 +1,5 @@
+module AsyncDataFetch
+	class ApplicationController < ::ApplicationController #ActionController::Base
+		protect_from_forgery
+	end
+end

data/app/controllers/async_data_fetch/fetchers_controller.rb

@@ -0,0 +1,49 @@
+
+require_dependency "async_data_fetch/application_controller"
+
+module AsyncDataFetch
+	class FetchersController < ApplicationController # ::ApplicationController
+
+		def get_async_data
+			model = fetcher_params[:model_name].classify.constantize
+			if model == nil then
+				respond_to do |format|
+					format.json { render :json => { :error => t( "async_data_fetch.Wrong_model")}, :status => 422 }
+				end
+				return
+			end
+
+			item = model.find_by(id: fetcher_params[:model_id])
+			if item == nil then
+				respond_to do |format|
+					format.json { render :json => { :error => t( "async_data_fetch.Wrong_id")}, :status => 422}
+				end
+				return
+			end
+
+			result = nil
+			if item != nil && model.available_methods != nil && model.available_methods.include?(fetcher_params[:model_method]) then
+				result = item.send(fetcher_params[:model_method])
+				respond_to do |format|
+					format.json { render :json => { :success => result }, :status => 200 }
+				end
+				return
+			end
+
+			respond_to do |format|
+				format.json { render :json => { :error => t( "async_data_fetch.Invalid_method") }, :status => 422 }
+			end
+			return
+		end
+
+		private
+		def fetcher_params
+			params.require(:model_method)
+			params.require(:model_id)
+			params.require(:model_name)
+			return params
+		end
+
+	end
+end
+

data/app/views/async_data_fetch/_fetch_async_data.html.erb

@@ -0,0 +1 @@
+<<%= _tag %> class="<%= _class %>" data-model_name="<%= _model_name %>" data-model_id="<%= _model_id %>" data-model_method="<%= _model_method %>" data-display_error="<%= _display_error %>" ><%= _placeholder %></<%= _tag %>>

data/config/locales/async_data_fetch.yml

@@ -0,0 +1,13 @@
+en:
+  async_data_fetch:
+    Wrong_model: "Wrong model"
+    Wrong_id: "Wrong ID"
+    Wrong_method: "Wrong method"
+    Invalid_method: "Invalid method"
+
+fr:
+  async_data_fetch:
+    Wrong_model: "Mauvais modele"
+    wrong_id: "Mauvais ID"
+    wrong_method: "Mauvaise methode"
+    Invalid_method: "Methode invalide"

data/config/routes.rb

@@ -0,0 +1,4 @@
+AsyncDataFetch::Engine.routes.draw do
+#Rails.application.routes.draw do
+	post '/get_async_data' => 'fetchers#get_async_data', as: :get_async_data
+end

data/lib/async_data_fetch.rb

@@ -0,0 +1,9 @@
+require 'async_data_fetch/acts_as_async'
+require 'async_data_fetch/view_helpers'
+
+module AsyncDataFetch
+	require 'async_data_fetch/engine'
+
+	I18n.available_locales = [:en, :fr]
+	I18n.default_locale = :en
+end

data/lib/async_data_fetch/acts_as_async.rb

@@ -0,0 +1,20 @@
+module AsyncDataFetch
+	module ActsAsAsync
+		extend ActiveSupport::Concern
+
+		included do
+		end
+
+		module ClassMethods
+
+			available_methods = nil
+
+			def acts_as_async(*queries)
+				cattr_accessor :available_methods
+				self.available_methods = queries.map(&:to_s)
+			end
+		end
+	end
+end
+
+ActiveRecord::Base.send :include, AsyncDataFetch::ActsAsAsync

data/lib/async_data_fetch/engine.rb

@@ -0,0 +1,11 @@
+module AsyncDataFetch
+  class Engine < ::Rails::Engine
+  	isolate_namespace AsyncDataFetch
+
+	initializer "async_data_fetch", before: :load_config_initializers do |app|
+		Rails.application.routes.append do
+			mount AsyncDataFetch::Engine, at: "/async_data_fetch"
+		end
+	end
+  end
+end

data/lib/async_data_fetch/version.rb

@@ -0,0 +1,3 @@
+module AsyncDataFetch
+  VERSION = "0.0.5"
+end

data/lib/async_data_fetch/view_helpers.rb

@@ -0,0 +1,9 @@
+module AsyncDataFetch
+	module ViewHelpers
+		def fetch_async(model_name: , model_id: , model_method: , tag: "span", placeholder: "?", display_error: false)
+			render partial: 'async_data_fetch/fetch_async_data', locals: {_tag: tag, _model_name: model_name.to_s, _model_id: model_id.to_s, _model_method: model_method.to_s, _placeholder: placeholder.to_s, _class: 'fetch_data_async', _display_error: display_error }
+		end
+	end
+end
+
+ActionView::Base.send :include, AsyncDataFetch::ViewHelpers

data/lib/tasks/async_data_fetch_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :async_data_fetch do
+#   # Task goes here
+# end

data/test/acts_as_async_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class ActsAsAsyncTest < ActiveSupport::TestCase
+
+	def test_hickwalls_as_async
+		assert_equal ["last_squawk", "test_method"], Hickwall.available_methods
+	end
+
+	def test_wickwalls_as_async
+		assert_equal ["plop"], Wickwall.available_methods
+	end
+end

data/test/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/test/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/test/dummy/_Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'async_data_fetch', :path => '../../.'
+

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

@@ -0,0 +1,14 @@
+// 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require async_data_fetch
+//= require_tree .

data/test/dummy/app/assets/javascripts/hickwalls.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/javascripts/wickwalls.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/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/test/dummy/app/assets/stylesheets/hickwalls.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/wickwalls.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,8 @@
+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
+
+  def root
+  end
+end

data/test/dummy/app/controllers/hickwalls_controller.rb

@@ -0,0 +1,2 @@
+class HickwallsController < ApplicationController
+end

data/test/dummy/app/controllers/wickwalls_controller.rb

@@ -0,0 +1,2 @@
+class WickwallsController < ApplicationController
+end

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

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

data/test/dummy/app/helpers/hickwalls_helper.rb

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

data/test/dummy/app/helpers/wickwalls_helper.rb

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

data/test/dummy/app/models/hickwall.rb

@@ -0,0 +1,8 @@
+class Hickwall < ActiveRecord::Base
+	acts_as_async :last_squawk, :test_method
+
+	def test_method
+		return "houha"
+	end
+
+end

data/test/dummy/app/models/wickwall.rb

@@ -0,0 +1,7 @@
+class Wickwall < ActiveRecord::Base
+	acts_as_async :plop
+
+	def plop
+		return 12
+	end
+end

data/test/dummy/app/views/application/root.html.erb

@@ -0,0 +1,11 @@
+<p>SUCCESS: <%= fetch_async(model_name: "Hickwall", model_id: 1 , model_method: "test_method", display_error: true) %></p>
+
+<p>FAILED: <%= fetch_async(model_name: "Hickwall", model_id: 1 , model_method: "failing", tag: "span", display_error: true) %></p>
+
+<p>FAILED: <%= fetch_async(model_name: "Hickwall", model_id: 9999 , model_method: "test_method", tag: "span", display_error: true) %></p>
+
+<p>SUCCESS: <%= fetch_async(model_name: "Hickwall", model_id: 1 , model_method: "last_squawk", tag: "span", display_error: true) %></p>
+
+<p>SUCCESS: <%= fetch_async(model_name: "Wickwall", model_id: 1 , model_method: "plop", tag: "span", display_error: true) %></p>
+
+<p>FAILED: <%= fetch_async(model_name: "Wickwall", model_id: 90 , model_method: "plop", tag: "span", display_error: true) %></p>