cleanroom 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f611b9683805a4330c66fdf770e643d708000e5
+  data.tar.gz: 767bc0ba13fd9353126926340b0a70f7cd0756aa
+SHA512:
+  metadata.gz: 72132627920374fcc949aca0c453c09ae891e4e9da28c58356e4e8846974c2599705b589e9a0d1f91efb908c7a8f63e4221e642c6d04ee070bfbbccbdca0f221
+  data.tar.gz: c16576092728a82074a7ea0a4864ed1d5bcbed4098e5b09c245d17de2302506de5562b628675ed8f0b94ddcac69867dbfbab8615023e9d0c05be007e5240e5cd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+bundler_args: --jobs 7
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake travis:ci

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Cleanroom CHANGELOG
+===================
+
+v1.0.0 (August, 12, 2014)
+-------------------------
+- Initial public release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,229 @@
+Ruby Cleanroom
+==============
+[![Gem Version](http://img.shields.io/gem/v/cleanroom.svg)][gem]
+[![Build Status](http://img.shields.io/travis/sethvargo/cleanroom.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/sethvargo/cleanroom.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/sethvargo/cleanroom.svg)][codeclimate]
+[![Gittip](http://img.shields.io/gittip/sethvargo.svg)][gittip]
+
+[gem]: https://rubygems.org/gems/cleanroom
+[travis]: http://travis-ci.org/sethvargo/chef-suguar
+[gemnasium]: https://gemnasium.com/sethvargo/cleanroom
+[codeclimate]: https://codeclimate.com/github/sethvargo/cleanroom
+[gittip]: https://www.gittip.com/sethvargo
+
+Ruby is an excellent programming language for creating and managing custom DSLs, but how can you securely evaluate a DSL while explicitly controlling the methods exposed to the user? Our good friends `instance_eval` and `instance_exec` are great, but they expose all methods - public, protected, and private - to the user. Even worse, they expose the ability to accidentally or intentionally alter the behavior of the system! The cleanroom pattern is a safer, more convenient, Ruby-like approach for limiting the information exposed by a DSL while giving users the ability to write awesome code!
+
+The cleanroom pattern is a unique way for more safely evaluating Ruby DSLs without adding additional overhead.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cleanroom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cleanroom
+
+
+Usage
+-----
+
+### Setup
+In order to use the cleanroom, you must first load the cleanroom gem:
+
+```ruby
+require 'cleanroom'
+```
+
+Next, for any file you wish to be evaluated as a DSL, include the module:
+
+```ruby
+class MyDSL
+  include Cleanroom
+end
+```
+
+### Writing DSLs
+For each public method you with to expose as a DSL method, call `expose` after the method definition in your class:
+
+```ruby
+class MyDSL
+  include Cleanroom
+
+  def my_method
+    # ...
+  end
+  expose :my_method
+
+  def public_method
+    # ...
+  end
+
+  private
+
+  def private_method
+    # ...
+  end
+end
+```
+
+In this example, `MyDSL` exposes two public API methods:
+
+- `my_method`
+- `public_method`
+
+which would be accessible via:
+
+```ruby
+instance = MyDSL.new
+instance.my_method
+instance.public_method
+```
+
+MyDSL also exposes one DSL method:
+
+- `my_method`
+
+which would be accessible in a DSL file:
+
+```ruby
+my_method
+```
+
+The use of the `expose` method has the added advantage of clearly identifying which methods are available as part of the DSL.
+
+The method `private_method` is never accessible in the DSL or as part of the public API.
+
+### Evaluating DSLs
+The cleanroom also includes the ability to more safely evaluate DSL files. Given an instance of a class, you can call `evaluate` or `evaluate_file` to read a DSL.
+
+```ruby
+instance = MyDSL.new
+
+# Using a Ruby block
+instance.evaluate do
+  my_method
+end
+
+# Using a String
+instance.evaluate "my_method"
+
+# Given a file at /file
+instance.evaluate_file('/file')
+```
+
+These same methods are available on the class as well, but require you pass in the instance:
+
+```ruby
+instance = MyDSL.new
+
+# Using a Ruby block
+MyDSL.evaluate(instance) do
+  my_method
+end
+
+# Using a String
+MyDSL.evaluate(instance) "my_method"
+
+# Given a file at /file
+MyDSL.evaluate_file(instance, '/file')
+```
+
+For both of these examples, _the given instance is modified_, meaning `instance` holds the values after the evaluation took place.
+
+
+"Security"
+----------
+The cleanroom gem tries to prevent unauthorized variable access and attempts to alter the behavior of the system.
+
+First, the underlying instance object is never stored in an instance variable. Due to the nature of `instance_eval`, it would be trivial for a malicious user to directly access methods on the delegate class.
+
+```ruby
+# Some DSL file
+@instance #=> nil
+```
+
+Second, access to the underlying `instance` in the cleanroom is restricted to `self` by inspecting the `caller` attempts to access `__instance__` from outside of a method in the cleanroom will result in an error.
+
+```ruby
+# Some DSL file
+__instance__ #=> Cleanroom::InaccessibleError
+send(:__instance__) #=> Cleanroom::InaccessibleError
+```
+
+Third, the ability to create new methods on the cleanroom is also disabled:
+
+```ruby
+# Some DSL file
+self.class.class_eval { } #=> Cleanroom::InaccessibleError
+self.class.instance_eval { } #=> Cleanroom::InaccessibleError
+```
+
+Fourth, when delegating to the underlying instance object, `public_send` (as opposed to `send` or `__send__`) is used. Even if an attacker could somehow bypass the previous safeguards, they would be unable to call non-public methods on the delegate object.
+
+If you find a security hole in the cleanroom implementation, please email me at the contact info found in my [GitHub profile](https://github.com/sethvargo). **Do not open an issue!**
+
+
+Testing
+-------
+If you are using cleanroom in your DSLs, you will likely want to test a particular DSL method is exposed. Cleanroom packages some RSpec matchers for your convienence:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec'
+require 'cleanroom/rspec'
+```
+
+This will define the following matchers:
+
+```ruby
+# Check against an instance
+expect(:my_method).to be_an_exposed_method_on(instance)
+
+# Check against a class
+expect(:my_method).to be_an_exposed_method_on(klass)
+
+# Check against an instance
+expect(instance).to have_exposed_method(:my_method)
+
+# Check against a class
+expect(klass).to have_exposed_method(:my_method)
+```
+
+
+Contributing
+------------
+1. Fork the project
+1. Write tests
+1. Run tests
+1. Create a new Pull Request
+
+
+License
+-------
+```text
+Copyright 2014 Seth Vargo <sethvargo@gmail.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+