erb_sandbox 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d74516bb4e1f4a7bc8f2efffca222574b08c49
-  data.tar.gz: 2214f9c1c879a8674cd004972ab487e725cf96e4
+  metadata.gz: a5a17355b42bb940a844b091c3153ab90e978d20
+  data.tar.gz: f1e0b695e0d31d539cdb20665259aa90073697b4
 SHA512:
-  metadata.gz: 0a899b05b68bf4ec9c6a15082c157ff7bbb2e7a3234af8382c3485ff678bcf2bb969a70cbfc7562215ba78423a398086d9420cebe082fa1a071c43405155c97c
-  data.tar.gz: ea9f09eea725328c770fc35449153fd4353cbecbc34d6a64fcb64718ce3f896d3c2e16bcbb818fa3a668f1efaef711809ad0ddcc131912247d452915b6dc341a
+  metadata.gz: 2461110f8d61b154b9c51732a80cfd08a88c680d4fd4be5b3b2b34d8e8b548029f4acf3d41a152462ce46999c4b3650a700e17504c7c725c1d95052981cc088e
+  data.tar.gz: 331decddf5e4906777361a187aa22ad4aa6101af6f238c2646399ce50b210c33e167887bb69a4ea3da8a3f78af393fce0a25920434ec74632c44e975b1cdb018

data/LICENSE.txt

@@ -0,0 +1,25 @@
+Copyright (c) 2015 Dmitriy Non
+
+
+
+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,49 @@
+# ERB Sandbox v0.0.1
+ERB Sandbox allows you to encapsulate your program from ERB.
+
+### Problem
+
+When you use `ERB.new(code).result` "code" can use all parts of your program.
+For example:
+```Ruby
+class ImportantClass
+   def self.nuke_world
+      launch_rockets
+   end
+end
+
+ERB.new('<% ImportantClass.nuke_world %>').result
+```
+
+World is being **bombed**!!! It makes me cry:(
+
+### Solution
+
+So, I just wanna render some template with some predefined variables.
+
+With `erb_sandbox` gem I can do:
+```Ruby
+class ImportantClass
+   def self.nuke_world
+      launch_rockets
+   end
+end
+
+begin
+  ErbSandbox.render('<% ImportantClass.nuke_world %>')
+  laugh # it will never happen
+rescue
+  # HA-HA-HA ImportantClass is undefined!
+end
+```
+
+## Usage
+
+It's pretty simple:
+
+```Ruby
+ErbSandbox.render 'Hello, <%=user_name%>', user_name: 'dude' # => 'Hello, dude'
+```
+
+# Copyright
+Copyright (c) 2015 Dmitriy Non. See [LICENSE.txt](LICENSE.txt)

data/erb_sandbox.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name          = 'erb_sandbox'
-  s.version       = '0.0.1'
-  s.date          = '2015-12-03'
+  s.version       = '0.0.2'
+  s.date          = '2015-12-04'
   s.summary       = 'ERB Sandbox'
-  s.description   = 'Allows you to render ERB templates in sandbox with predefined vars'
-  s.authors       = ['Non Dmitriy']
+  s.description   = 'Gem allows you to render ERB templates in sandbox with predefined vars'
+  s.authors       = ['Dmitriy Non']
   s.email         = 'non.dmitriy@gmail.com'
   s.files         = `git ls-files`.split("\n")
   s.homepage      = 'https://github.com/Nondv/erb_sandbox'

data/lib/erb_sandbox/exceptions.rb

@@ -0,0 +1,6 @@
+module ErbSandbox
+  #
+  # for executing erb
+  #
+  class StatusIsNotZero < StandardError; end
+end

data/lib/erb_sandbox.rb

@@ -1,4 +1,6 @@
 require 'tempfile'
+require 'open3'
+require_relative 'erb_sandbox/exceptions'
 
 #
 # Module contains methods for rendering ERB templates in "sandbox"
@@ -8,21 +10,34 @@ require 'tempfile'
 module ErbSandbox
   #
   # uses `erb` (yes-yes, it's slow:( ) to render template with some predefined variables
+  # example:
+  #   ErbSandbox.render 'Hello, <%= user %>', user: 'dude' # => "Hello, dude"
+  #
   # @param template [String]
   # @param variables [Hash]
   # @return [String] result of using `erb`
+  # @raise [ErbSandbox::StatusIsNotZero]
   #
   def self.render(template, variables = {})
     file = Tempfile.new 'erb_sandbox'
     file.write variables_init_code variables
     file.write template
     file.close
-    result = `erb #{file.path}`
+
+    output, status = Open3.capture2e "erb #{file.path}" # supress stderr
     file.unlink
-    result
-  rescue
-    # TODO: do something useful
-    nil
+
+    fail(StatusIsNotZero, output) unless status.to_i.zero?
+    output
+  end
+
+  #
+  # wrapping on ErbSandbox.render(File.read(path), variables)
+  # @raise [ErbSandbox::StderrIsNotEmpty] from ErbSandbox.render
+  # @raise [Exceptions] from File.read
+  #
+  def self.render_file(path, variables = {})
+    render File.read(path), variables
   end
 
   private
@@ -31,10 +46,14 @@ module ErbSandbox
   # generates code, that will define vars with values.
   # @param variables [Hash] var_name => value
   # @return [String] erb code (in <% %>)
+  # @raise [TypeError] from Marshal.dump
   #
   def self.variables_init_code(variables)
-    # TODO: validate values
-    variables = variables.map { |key, value| "#{key} = #{value.inspect}" }
-    "<%\n#{variables.join "\n"}\n%>"
+    lines = variables.map do |key, value|
+      marshal_string = Marshal.dump value
+      "#{key} = Marshal.load(#{marshal_string.inspect})" # inspect - like escape string
+    end
+
+    "<%\n#{lines.join "\n"}\n%>"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_sandbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- Non Dmitriy
+- Dmitriy Non
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.35'
-description: Allows you to render ERB templates in sandbox with predefined vars
+description: Gem allows you to render ERB templates in sandbox with predefined vars
 email: non.dmitriy@gmail.com
 executables: []
 extensions: []
@@ -32,8 +32,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- LICENSE.txt
+- README.md
 - erb_sandbox.gemspec
 - lib/erb_sandbox.rb
+- lib/erb_sandbox/exceptions.rb
 homepage: https://github.com/Nondv/erb_sandbox
 licenses:
 - MIT