js_vars 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f71b2c15cc0201d4ffcbdc17171abc365ee5c6d
+  data.tar.gz: 5aff28da3fa50d61a2fae6b3ea44861af14039cc
+SHA512:
+  metadata.gz: 0f3868ce7bbb482d4a5cd18c07230b6051953cb7e5f941c448cecc09adad450adf87b94f58ac4fd3356ca724f298666f076348b8ed7af872e26c04a853559341
+  data.tar.gz: 133c2d5be7efa9cfbf4c6f09fb6202d580f82cd99364c305350cddb17801ca69e3643dcc18dd7e2b0aaffbdf22e265814e29ed8dad71e0d8377e9dadbefbec68

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 jsvars.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jiren Patel
+
+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,78 @@
+# JsVars
+
+It is view helper to render javascript variables in one place with namespaces. 
+
+How to add js variables.  `@user.to_jsvar(:user)` this will add `@user` json value to variable map and it is render by `js_vars_tag` in view 
+
+i.e
+    APP = { user: {name: 'jiren', id: 1}, address: {city: 'pune'} }
+
+### Why?
+
+Many times we are using `javascript_tag` or `:javascript` to render javascript variables or json data in view.
+
+i.e
+
+  	:javascript
+      var users = #{@users.to_json}  
+    
+  OR 
+    
+  	javascript_tag do
+    	var users = #{@users.to_json} 
+  	end  
+  
+So here there are no namespace for javascript variables i.e `var APP = {users: [....]}` and they are global. May be there are chances to conflict with other variables with same name. Also in debugging we find difficulties to find variable because variables are not define in namespace. If there are namespace so we can view all variables in namespace from debugging console.
+
+To solve this problems I have written gem `jsvars`.
+
+## Usage
+
+- Add any object to js var map
+
+  		@users.to_jsvars(:users)
+     	@address.to_jsvars(:address)
+
+- For rendering all added variables in html. Add following tag to end of the layout.
+     
+     	= js_vars_tag 
+     
+     OR
+     
+     	<%= js_vars_tag %>
+    
+     Output in html 
+
+     		<script jsvars="jsvars">//<![CDATA[ if(!window.APP){ window.APP = {}};APP.users = [1,2,3]; window.address = 'pune'//]]></script>
+     
+ 
+  Here `APP` is a namespace which hold `users` and `address` variables. 
+
+- `to_jsvars` options
+     
+    @users.to_jsvars(:users, namespace: 'User', json: { only: [:id]})  
+
+  namespace: To change particular variable namespace
+  json: To change rendering object fields.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsvars'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsvars
+
+### 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_vars.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js_vars/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "js_vars"
+  spec.version       = JsVars::VERSION
+  spec.authors       = ["Jiren Patel"]
+  spec.email         = ["jirenpatel@gmail.com"]
+  spec.description   = %q{Manage javascript variables in html templates}
+  spec.summary       = %q{Manage javascript variables in html templates}
+  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"
+end

data/lib/js_vars/obj_ext.rb

@@ -0,0 +1,14 @@
+module  JsVars
+  module ObjExt
+
+    def to_jsvar(var_name, options = {})
+      JsVars.add(
+        { 
+          var_name => self.to_json(options[:json] || {} ) 
+        },
+        options[:namespace]
+      )
+    end
+
+  end
+end

data/lib/js_vars/rails/engine.rb

@@ -0,0 +1,6 @@
+module JsVars
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/js_vars/rails/railtie.rb

@@ -0,0 +1,17 @@
+module JsVars 
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'js_vars.view_helpers' do
+        ActionView::Base.send(:include, JsVars::TagHelper)
+      end
+
+=begin
+      config.before_configuration do
+        if config.action_view.javascript_expansions
+          config.action_view.javascript_expansions[:defaults] << ['js_vars']
+        end
+      end
+=end
+    end
+  end
+end

data/lib/js_vars/rails.rb

@@ -0,0 +1,2 @@
+require 'js_vars/rails/engine' if ::Rails.version >= '3.1'
+require 'js_vars/rails/railtie'

data/lib/js_vars/tag_helper.rb

@@ -0,0 +1,23 @@
+module JsVars
+  module TagHelper
+
+    def js_vars_tag(default_namespace = 'APP')
+      script_data = '' 
+
+      JsVars::VarMap.get.each do |namespace, vars|
+        namespace ||= default_namespace
+        script_data += "if(!window.#{namespace}){ window.#{namespace} = {}};"
+        script_data = vars.inject(script_data) {|s, (k, v)| s += "#{namespace}.#{k} = #{v.is_a?(String) ? v : v.to_json};" } if vars
+      end
+
+      return '' if JsVars::VarMap.empty?
+
+      JsVars::VarMap.clear
+
+      return script_data.html_safe if request.xhr?
+
+      raw javascript_tag(jsvars: :jsvars){ script_data.html_safe }
+    end
+
+  end
+end

data/lib/js_vars/var_map.rb

@@ -0,0 +1,27 @@
+module JsVars
+  class VarMap < Hash
+
+    class << self
+
+      def get
+        Thread.current['[jsvar]:map'] ||= JsVars::VarMap.new
+      end
+
+      def add(vars, namepsace)
+        var_map = self.get
+        var_map[namepsace] ||= {}
+        var_map[namepsace].merge!(vars)
+      end
+
+      def clear
+        self.get.clear
+      end
+
+      def empty?
+        self.get.empty?
+      end
+
+    end
+
+  end
+end

data/lib/js_vars/version.rb

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

data/lib/js_vars.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'js_vars/version'
+require 'js_vars/tag_helper'
+require 'js_vars/var_map'
+require 'js_vars/obj_ext'
+require 'js_vars/rails'
+
+module JsVars
+
+  class << self
+
+    def add(vars, namepsace = 'APP')
+      VarMap.add(vars, namepsace) if vars.is_a?(Hash) 
+    end
+
+    def clear
+      VarMap.clear
+    end
+
+  end
+end
+
+Object.send(:include, JsVars::ObjExt) unless Object.respond_to?(:to_jsvar)

data/vendor/assets/javascripts/js_vars.js

@@ -0,0 +1,17 @@
+
+(function(w) {
+
+  if ( w.jsVars !== undefined ) {
+    return false;
+  }
+
+  var jsVars;
+  jsVars = {
+    add: function(vars, options){
+      
+    }
+  }
+
+  w.jsVars = jsVars;
+
+})(window);

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: js_vars
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jiren Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 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'
+description: Manage javascript variables in html templates
+email:
+- jirenpatel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- js_vars.gemspec
+- lib/js_vars.rb
+- lib/js_vars/obj_ext.rb
+- lib/js_vars/rails.rb
+- lib/js_vars/rails/engine.rb
+- lib/js_vars/rails/railtie.rb
+- lib/js_vars/tag_helper.rb
+- lib/js_vars/var_map.rb
+- lib/js_vars/version.rb
+- vendor/assets/javascripts/js_vars.js
+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.0
+signing_key: 
+specification_version: 4
+summary: Manage javascript variables in html templates
+test_files: []