snippetize 0.0.3 → 0.0.4

data/README.md

@@ -2,6 +2,14 @@
 
 Snippetize allows you to include re-usable code and partials in html or plain text fields. Stay dry and reuse your partials using shortcode. Use it for including forms, videos, maps or simply preformated html snippets.
 
+## Why
+
+If you want dynamic partials to be displayed and you save your html output to a, let's say, a content column of a Article instance.
+
+    Article.new(content: "<div class='widget'>I need my awesome widget that displays everywhere on the site.</div>")
+
+Or sometimes you want a form and want to keep the authentication token for instance or any ruby code that has to stay dynamic and can't be kept static in the database.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,9 +24,25 @@ Or install it yourself as:
 
     $ gem install snippetize
 
+## Defaults
+
+All partials will be taken from a `snippets` folder in views. For instance, `{{awesome_widget}}` assumes you have the following file:
+
+    app/views/snippets/_awesome_widget.html.erb
+
 ## Usage
 
-{googlemap address=your_address_goes_here}
+Insert the name of the partial within double brackets `{{}}`
+
+    text = "<div class='widget'>{{awesome_widget}}</div>"
+
+Call `snippetize` and pass it your string
+
+    snippetize(text).html_safe
+
+The result could look like this:
+
+    "<div class='widget'><div class='my-awesome-widget'>This lives in my partial.</div></div>"
 
 ## Contributing
 

data/lib/snippetize/action_view_extensions/snippetize_helper.rb

@@ -2,8 +2,10 @@ module Snippetize
   module ActionViewExtensions
     module SnippetizeHelper
 
-      def snippetize string
-        string.gsub(/\{(.*?)\}/) do |s|
+      # Renders the first expression within double brackets {{}} as a partial
+      # Other variables are passed as parameters to the partial
+      def snippetize string=''
+        string.gsub(/\{\{(.*?)\}\}/) do |s|
           snippet = Snippetize::Snippet.new($1)
           render partial: snippet.path, locals: snippet.locals
         end

data/lib/snippetize/version.rb

@@ -1,3 +1,3 @@
 module Snippetize
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/snippetize.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Snippetize::VERSION
   gem.authors       = ["Mathieu Gagné"]
   gem.email         = ["mathieu@motioneleven.com"]
-  gem.description   = %q{Snippetize allows you to include re-usable code and partials in html or plain text fields.}
-  gem.summary       = %q{Snippetize allows you to include re-usable code and partials in html or plain text fields. Stay dry and reuse your partials using shortcode. Use it for including forms, videos, maps or simply preformated html snippets.}
+  gem.description   = %q{Ruby gem allowing you to include re-usable code and partials in html or plain text fields.}
+  gem.summary       = %q{Ruby gem allowing you to include re-usable code and partials in html or plain text fields. Stay dry and reuse your partials using shortcode. Use it for including forms, videos, maps or simply preformated html snippets.}
   gem.homepage      = "https://github.com/motioneleven/snippetize"
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippetize
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies: []
-description: Snippetize allows you to include re-usable code and partials in html
+description: Ruby gem allowing you to include re-usable code and partials in html
   or plain text fields.
 email:
 - mathieu@motioneleven.com
@@ -52,7 +52,7 @@ rubyforge_project:
 rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
-summary: Snippetize allows you to include re-usable code and partials in html or plain
+summary: Ruby gem allowing you to include re-usable code and partials in html or plain
   text fields. Stay dry and reuse your partials using shortcode. Use it for including
   forms, videos, maps or simply preformated html snippets.
 test_files: []