shortcodes 0.0.3 → 0.0.4

data/README.md

@@ -8,20 +8,32 @@ A simple ruby gem that will parse your cms content for wordpress style shortcode
 
 Add this line to your application's Gemfile:
 
-    gem 'shortcodes'
+```ruby
+gem 'shortcodes'
+```
 
-And then execute:
+Then require the shortcodes you intend on using.
 
-    $ bundle
+To automatically load all built-in shortcodes use:
 
-Or install it yourself as:
+```ruby
+# Gemfile
+gem 'shortcodes', require: 'shortcodes/all'
+```
 
-    $ gem install shortcodes
+To only load specified shortcodes do not use `require: 'shortcodes/all'`, and
+instead require only the shortcodes you intend to use. In rails, you can do this
+in an initialize like so:
+
+```ruby
+# config/initializers/shortcodes.rb
+require 'shortcodes/youtube'
+```
 
 ## Usage
 
 ```ruby
-  Shortcodes.shortcode(content)
+Shortcodes.shortcode(content)
 ```
 
 ## Built-in Shortcodes
@@ -49,6 +61,32 @@ Example:
 [wufoo username="awesome_user" formhash="a04909c" autoresize="true" height="961" header="show" ssl="true"]
 ```
 
+### Custom shortcodes
+
+Either create an object that responds to `call`, or subclass `Shortcodes::Handler` and implement
+`render`. Register the shortcode using `Shortcodes.register\_shortcode`. Example:
+
+```ruby
+require 'shortcodes/handler'
+
+class MyShortcode < Shortcodes::Handler
+  def render
+    "Attributes can be accessed with <tt>#attributes</tt>: <pre>#{attributes.inspect}</pre>"
+  end
+end
+
+Shortcodes.register_shortcode('my-shortcode', MyShortcode)
+```
+
+Also see
+[lib/shortcodes/youtube.rb](https://github.com/carnesmedia/shortcodes/blob/master/lib/shortcodes/youtube.rb)
+for a good real-world example.
+
+#### Please PR new shortcodes!
+
+If you write a custom that might be useful to other people, please submit
+a pull-request!
+
 ## Contributing
 
 1. Fork it

data/lib/shortcodes/version.rb

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

data/lib/shortcodes/youtube.rb

@@ -28,7 +28,7 @@ module Shortcodes
     end
 
     def render
-      %Q{<iframe width="#{width}" height="#{height}" src="http://www.youtube.com/embed/#{youtube_id}#{time}" frameborder="0" allowfullscreen></iframe>}
+      %Q{<iframe width="#{width}" height="#{height}" src="//www.youtube.com/embed/#{youtube_id}#{time}" frameborder="0" allowfullscreen></iframe>}
     end
 
     Shortcodes.register_shortcode('youtube', self)

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: shortcodes
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
+  prerelease: 
 platform: ruby
 authors:
 - Amiel Martin
@@ -9,53 +10,60 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,6 +71,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,15 +79,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: Wordpress style shortcodes for your Ruby CMS
@@ -102,26 +113,28 @@ files:
 homepage: https://github.com/carnesmedia/shortcodes
 licenses:
 - MIT
-metadata: {}
 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: 2.0.3
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Shortcodes is a simple ruby gem that will parse your cms content for wordpress
   style shortcodes.
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: d8f82b3f07bc8293d42800d6f2f476810aa10d44
-  data.tar.gz: 49688b4b0501a90fca1f0c270d19eafd092e1b25
-SHA512:
-  metadata.gz: 7b4de3826b7eaa68bff95453a3c243faff5e74d138243e75e70f81a38a6caeb6dd601dfb1673e0202e84b8dac8fb38f3e87494832dcfda6f558a05bf0efbe5d2
-  data.tar.gz: 8beac9f1b0e6bc2f6225eeb581a721ccda606403c11a00d117de9a9501becbcf3c3196f2946ae9419fbfc670def62ee2600697a242f6dd24c5282e363888eab8