render_as_js 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55470de919d2e60b0b86a22edc2efbecd1a994aa
+  data.tar.gz: 0bd906e93f06845832281d3877398fa8711eed2d
+SHA512:
+  metadata.gz: e3c2d308d47d3edb76bccdc3cde8ae915280a9062723086bf6cff4a96acb9bdd3342e3cd1679f37b33e4d47941d245e81f660b5963bcf7b032d6ce9ee0e55085
+  data.tar.gz: 7788773ea550a41b00e4286cc5d93e74964dd89ee75b3920a6b228d9fce341c6fac582278abf76502483e538497826a0ca3fea5fcc7dd78a6f9f65e17b951618

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at github.com@murb.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Maarten Brouwers
+
+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,71 @@
+# RenderAsJs
+
+Simple Rails helper to render a ruby hash to a ES5/JavaScript object. While a hash like `{a:2}` in ruby looks like an acceptable object in JS-terms, `{a:2}.to_s`
+renders to a string something along the lines of `{:a=>2}`. Which fails badly in any JS-interpreter. So try `{a:2}.to_json` and parse it in JS. Might work 90% of
+the time, but not for e.g. Dates (which turn into strings, which need to be re-evaluated without type-information at the frontend before further interpretation).
+
+Besides converting ruby's Hashes, this gem attempts to rerender the following things nicely in JS:
+
+- Strings
+- Date(Time)s
+- Numbers
+- Symbols
+- Booleans
+- `nil`s
+
+Note: this is no attempt to recompile ruby to JavaScript, I don't want to get near there.
+
+### Alternative
+
+This almost does the same trick: `let data = JSON.parse(<%= @data.to_json %>)`. Sadly that doesn't work very nicely for dates.
+
+### Warning
+
+While sanitizing is done using the Rails `sanitize` helper; be really careful when passing unknown data through this gem (numbers and dates will (probably) be fine, but be careful with strings).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'render_as_js'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install render_as_js
+
+## Usage
+
+In your views try:
+
+```ruby
+complex_hash = [{y: 12, x:Date.new(2017,1,1)}, {y: 12, x: Date.new(2017,1,2)}]
+render_as_js complex_hash
+```
+
+This should output in your generated html:
+
+```javascript
+[{y: 12, x: new Date('2017-01-01')}, {y: 12, x: new Date('2017-01-02')}]
+```
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/murb/render_as_js. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "render_as_js"
+
+# 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(__FILE__)

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_as_js.rb

@@ -0,0 +1,6 @@
+require "render_as_js/version"
+
+module RenderAsJs
+  require 'render_as_js/railtie' if defined?(Rails)
+  # Your code goes here...
+end

data/lib/render_as_js/railtie.rb

@@ -0,0 +1,9 @@
+require 'render_as_js/view_helpers'
+module RenderAsJs
+  class Railtie < Rails::Railtie
+    initializer "render_as_js.view_helpers" do
+      ActionView::Base.send :include, RenderAsJs::ViewHelpers
+    end
+  end
+end
+

data/lib/render_as_js/version.rb

@@ -0,0 +1,3 @@
+module RenderAsJs
+  VERSION = "0.1.0"
+end

data/lib/render_as_js/view_helpers.rb

@@ -0,0 +1,57 @@
+module RenderAsJs
+  module ViewHelpers
+    def render_as_js obj, options={}
+      if obj.is_a?(Hash)
+        return hash_to_js_obj obj
+      elsif obj.is_a?(Array)
+        return array_to_js_obj obj
+      elsif obj.is_a?(Date)
+        date_to_js_obj obj
+      elsif obj.is_a?(DateTime)
+        date_to_js_obj obj
+      elsif obj.is_a?(String)
+        string_to_js_obj obj
+      elsif obj.is_a?(Symbol)
+        symbol_to_js_obj obj, options
+      elsif obj.is_a?(NilClass)
+        nil_to_js_obj obj
+      else
+        return sanitize(obj.to_s)
+      end
+    end
+
+    private
+
+    def string_to_js_obj string
+      return "\'#{sanitize string}\'".html_safe
+    end
+
+    def nil_to_js_obj obj
+      return 'null'
+    end
+
+    def symbol_to_js_obj symbol, options={}
+      if options[:key] and !symbol.inspect.match?(/\"/)
+        return symbol.to_s.html_safe
+      else
+        return string_to_js_obj symbol.to_s
+      end
+    end
+
+    def date_to_js_obj date
+      return "new Date('#{date}')".html_safe
+    end
+
+    def array_to_js_obj arr
+      "[#{arr.collect{|a| render_as_js(a)}.join(", ")}]".html_safe
+    end
+
+    def hash_to_js_obj hash
+      rv = []
+      hash.each do |k,v|
+        rv << "#{render_as_js k, {key: true}}: #{render_as_js v}"
+      end
+      return "{#{rv.join(', ')}}".html_safe
+    end
+  end
+end

data/render_as_js.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'render_as_js/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "render_as_js"
+  spec.version       = RenderAsJs::VERSION
+  spec.authors       = ["Maarten Brouwers"]
+  spec.email         = ["github.com@murb.nl"]
+
+  spec.summary       = "Simple Rails helper to render a ruby hash to a ES5/JavaScript object"
+  spec.description   = "Simple Rails helper to render a ruby hash to a ES5/JavaScript object"
+  spec.homepage      = "https://github.com/murb/render_as_js"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "actionview"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: render_as_js
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maarten Brouwers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    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: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple Rails helper to render a ruby hash to a ES5/JavaScript object
+email:
+- github.com@murb.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/render_as_js.rb
+- lib/render_as_js/railtie.rb
+- lib/render_as_js/version.rb
+- lib/render_as_js/view_helpers.rb
+- render_as_js.gemspec
+homepage: https://github.com/murb/render_as_js
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Simple Rails helper to render a ruby hash to a ES5/JavaScript object
+test_files: []