js_info 0.1.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chuyi Huang
+
+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,96 @@
+# JsInfo
+
+JsInfo is a simple gem that trys to integrate javascript alert, confirm and prompt functions into Rails controller level. You can alert the users with a message without showing it in the view like the Flash of ActionDispatch does by using javascript functions.
+
+The principles of JsInfo are:
+
+1. Easy to use
+2. Call from the controller
+3. No extra codes in View layer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'js_info'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install js_info
+
+## Usage
+
+You can call JsInfo functions in the controllers:
+
+    js_alert("Your subscription is ok!")
+    js_confirm("Are you sure you want to visit google?", "http://www.google.com")
+    js_prompt("Please enter your name", "http://example.com")
+
+
+### js_alert
+
+And here is a typical example in the users controller:
+
+    def create
+      @user = User.find(params[:id])
+      if @user.save
+        js_alert("Your profile created successfully!")
+      else
+        render :new
+      end
+    end
+
+You can specify the target url as the second parameter:
+
+    js_alert("We are moving to github!", "https://github.com")
+    
+
+or more conventional way:
+
+    js_alert("Welcome Back!", root_path)
+    
+
+Please note that the default of the target url is *request.referer*
+
+### js_confirm
+
+Sometimes a yes-no question is required:
+
+    js_confirm("Are you sure you want to sign up?", new_subscription_path)
+    
+As for js_confirm, the second parameter is necessary. If you want to redirect to another path when the user click **no** or **cancel**, it is possible to use the third parameter:
+
+    js_confirm("Are you sure you want sign up?", new_subscription_path, cancel_subscription_path)
+        
+Also note that the default value for third parameter is *request.referer*, so when the user click **cancel** will return to the previous page.
+
+### js_prompt
+
+js_prompt is a method that will carry user's input to developer's target url with specified parameter name, here is an example:
+
+    js_prompt("what is your name?", new_user_path)
+    
+
+The typical javascript prompt will pop up with a dialog as you expected. As you can key in some values in the input box. When the user press the **Enter**, it will redirect to the new_user_path with a parameter named *params_name* with the value of user's input, say, *Chuyi* is the value of the input. it might look like **"http://example.com?params_name=Chuyi"** in the location bar. 
+
+Of course we can define the default value of the input or change the parameter to fit our needs:
+
+    js_prompt("Enter your email", new_user_path, "email", "yourname@example.com")
+
+After pressing the confirm button the page will be redirected to **"http://example.com?email=yourname@example.com"**. As you can see, the third parameter is the parameter name and the forth one is the default value, simple as that.
+
+##What you need to know
+
+I test it in the rails development environment, so please let me know if there is any improvement or bug I need to fix, thank you. 
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/js_info.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js_info/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "js_info"
+  gem.version       = JsInfo::VERSION
+  gem.authors       = ["Chuyi Huang"]
+  gem.email         = ["chuyihuang@gmail.com"]
+  gem.description   = %q{Make javascript alert, confirm and prompt as controller level methods}
+  gem.summary       = %q{Instead of using flash as the alert to the users, you can replace it with js_info which is simplier and code free in the view layers}
+  gem.homepage      = "https://github.com/chuyihuang/js_info"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  #require rails
+  gem.add_dependency "actionpack", ">= 3.0.0"
+
+end

data/lib/js_info.rb

@@ -0,0 +1,84 @@
+require "js_info/version"
+
+module JsInfo
+
+	protected
+
+	def js_alert(message, url = request.referer)
+		if message.blank?
+			raise "Unable to find any message for js_info!"
+		end
+
+		script = %Q{alert("#{message}");document.location.href="#{url}";}
+		html = html(script)
+		render text: html
+		return
+	end
+
+	def js_confirm(message, url, false_url = nil)
+		if message.blank? || url.blank?
+			raise "wrong parameter values for js_info!"
+		end
+
+		false_action = false_url.blank? ? "document.location.href=\"#{request.referer}\"" : "document.location.href=\"#{false_url}\""
+
+		script = %Q{
+			var r = confirm("#{message}");
+			if (r == true) {
+				document.location.href="#{url}";
+			}
+			else {
+				#{false_action}
+			}
+		}
+		html = html(script)
+		render text: html
+		return
+	end	
+
+	def js_prompt(message, url, params_name = "prompt_name", params_value = nil)
+		
+		if message.blank? || url.blank?
+			raise "wrong parameter values for js_info!"
+		end
+
+		script = %Q{
+			var url = "#{url}";
+			var params_name = "#{params_name}";
+			var params_value = prompt("#{message}", "#{params_value}");
+			var target_url = url + "?" + params_name + "=" + params_value;
+			//check is params_value is existed
+			if (params_value !== null) {
+			  document.location.href=target_url;	
+			}			
+			else {
+				document.location.href="#{request.referer}";
+			}
+		}
+		html = html(script)
+		render text: html
+		return
+	end		
+
+	private
+
+	def html(script)
+		%Q{
+			<!DOCTYPE html>
+			<head></head>
+			<body>
+			<script type="text/javascript">
+			<!--
+			#{script}
+			//-->
+			</script>
+			</body>
+			</html>
+		}		
+	end
+
+end
+
+class ActionController::Base
+	include JsInfo
+end

data/lib/js_info/version.rb

@@ -0,0 +1,3 @@
+module JsInfo
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: js_info
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Chuyi Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Make javascript alert, confirm and prompt as controller level methods
+email:
+- chuyihuang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- js_info.gemspec
+- lib/js_info.rb
+- lib/js_info/version.rb
+homepage: https://github.com/chuyihuang/js_info
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Instead of using flash as the alert to the users, you can replace it with
+  js_info which is simplier and code free in the view layers
+test_files: []