snidely_whiplash 1.0.0

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bob Matcuk
+
+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,110 @@
+# SnidelyWhiplash
+
+Let's say you have a partial view for displaying one of your models (written in your favorite templating language... [haml](http://haml.info/) perhaps?). But, hey, this 2013! Wouldn't it be nice if you could do some fancy, AJAXy thing to load new instances of your model and automatically format them the same way?
+
+So you could use some fancypants javascript to make that happen, but that's ugly. So you Google around and find [mustache](http://mustache.github.io/). Mustache takes a string with some HTML and `{{variables}}` and replaces all of those variables with data from a javascript object. Ok cool.
+
+But what are you going to do? Rewrite your partial view in some large boring javascript string so you can pass it to mustache? Yuck. If only you can haz your mustache template inline with your HTML. That would look prettier. Oh, wait! [You can haz that!](http://icanhazjs.com/)
+
+Ok, but that doesn't solve the fact that you have to have two versions of your partial view: one for ruby, and one for ICanHaz/Mustache. That's not very "dry". Lame.
+
+It's a good thing you have a friend that understands mustaches: good ol' Snidely Whiplash! He'll teach you proper grooming technique... right after he's done tying Nell to the railroad tracks!
+
+SnidelyWhiplash is a brain-dead simple mock class that causes all of your `model.property` lines in your partial view to output as `{{model.property}}`. The end result is that you get a block of HTML which you can shove in a `<script type="text/html">` for use with ICanHaz/Mustache. SnidelyWhiplash understands any simple outputs in your template (like `<%= model.property %>`), but doesn't understand anything more complicated than that. This is really just a simple solution to converting simple partial views to mustache templates so they can be used both server-side, and client-side.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snidely_whiplash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snidely_whiplash
+
+## Usage
+
+Let's say you have a partial view that looks like this:
+
+```erb
+<div class="user">
+  <h2><%= user.full_name %></h2>
+  <dl>
+    <dt>Address:</dt>
+    <dd><%= user.address %></dd>
+    <dt>Email:</dt>
+    <dd><%= user.email %></dd>
+  </dl>
+</div>
+```
+
+... or maybe in haml:
+
+```haml
+.user
+  %h2= user.full_name
+  %dl
+    %dt Address:
+    %dd= user.address
+    %dt Email:
+    %dd= user.email
+```
+
+And perhaps you render it by running: `render partial: 'user', locals: {user: @user}`.
+
+You could create an ICanHaz/Mustache template by adding the following, in ERB:
+
+```erb
+<script id="user_template" type="text/html">
+  <%= render partial: 'user', locals: {user: SnidelyWhiplash.new} %>
+</script>
+```
+
+... or in haml:
+
+```haml
+%script#user_template{type: 'text/html'}
+  = render partial: 'user', locals: {user: SnidelyWhiplash.new}
+```
+
+Either way would cause the following output:
+
+```html
+<script id="user_template" type="text/html">
+  <div class="user">
+    <h2>{{full_name}}</h2>
+    <dl>
+      <dt>Address:</dt>
+      <dd>{{address}}</dd>
+      <dt>Email:</dt>
+      <dd>{{email}}</dd>
+    </dl>
+  </div>
+</script>
+```
+
+... which you could then use in javascript with something like:
+
+```javascript
+data = {
+  full_name: 'Nell Fenwick',
+  address: 'Canada',
+  email: 'nell@example.org'
+};
+
+var user = ich.user_template(data);
+```
+
+The `SnidelyWhiplash` constructor can take one argument which can be used to specify the parent path for properties. For example, if you had used `SnidelyWhiplash.new('user')` in the examples above, the mustache outputs would have all been in the form `user.full_name`, `user.address`, and `user.email`. Your path can contain dots for those cases when your data is very deeply nested (for example: `SnidelyWhiplash.new('result.user')` would cause output like `{{result.user.full_name}}`, etc).
+
+## 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/lib/snidely_whiplash/version.rb

@@ -0,0 +1,3 @@
+class SnidelyWhiplash
+  VERSION = "1.0.0"
+end

data/lib/snidely_whiplash.rb

@@ -0,0 +1,17 @@
+require "snidely_whiplash/version"
+
+class SnidelyWhiplash
+  
+  def initialize(path=nil)
+    @path = path
+  end
+  
+  def to_s
+    "{{#{@path || ''}}}"
+  end
+  
+  def method_missing(method, *args, &block)
+    SnidelyWhiplash.new(@path.nil? ? method.to_s : "#{@path}.#{method.to_s}")
+  end
+  
+end

data/snidely_whiplash.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snidely_whiplash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "snidely_whiplash"
+  gem.version       = SnidelyWhiplash::VERSION
+  gem.authors       = ["Bob Matcuk"]
+  gem.email         = ["snidelywhiplash@squeg.net"]
+  gem.description   = %q{Convert simple partial views into a mustache template.}
+  gem.summary       = %q{Convert simple partial views into a mustache template.}
+  gem.homepage      = "https://github.com/bmatcuk/snidely_whiplash"
+
+  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"]
+  
+  gem.add_development_dependency('rspec-core')
+  gem.add_development_dependency('rspec-expectations')
+end

data/spec/snidely_whiplash_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'snidely_whiplash'
+
+describe SnidelyWhiplash do
+  it "should respond to a method with a new instance of itself" do
+    obj = SnidelyWhiplash.new
+    obj.example.should be_an_instance_of SnidelyWhiplash
+    obj.nested.example.should be_an_instance_of SnidelyWhiplash
+  end
+  
+  it "should return a mustache-escaped string describing the method calls" do
+    obj = SnidelyWhiplash.new
+    obj.example.to_s.should eql '{{example}}'
+    obj.nested.example.to_s.should eql '{{nested.example}}'
+  end
+  
+  it "should allow the caller to specify a parent path" do
+    obj = SnidelyWhiplash.new 'parent'
+    obj.example.to_s.should eql '{{parent.example}}'
+    obj.nested.example.to_s.should eql '{{parent.nested.example}}'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: snidely_whiplash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bob Matcuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert simple partial views into a mustache template.
+email:
+- snidelywhiplash@squeg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/snidely_whiplash.rb
+- lib/snidely_whiplash/version.rb
+- snidely_whiplash.gemspec
+- spec/snidely_whiplash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bmatcuk/snidely_whiplash
+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.24
+signing_key: 
+specification_version: 3
+summary: Convert simple partial views into a mustache template.
+test_files:
+- spec/snidely_whiplash_spec.rb
+- spec/spec_helper.rb