shortcodes 0.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Amiel Martin
+
+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,58 @@
+# Shortcodes
+
+Wordpress style shortcodes for your Ruby CMS.
+
+A simple ruby gem that will parse your cms content for wordpress style shortcodes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shortcodes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shortcodes
+
+## Usage
+
+```ruby
+  Shortcodes.shortcode(content)
+```
+
+## Built-in Shortcodes
+
+### Youtube
+
+Example:
+
+```
+[youtube url="https://www.youtube.com/watch?v=Gzj723LkRJY#t=3m21s"]
+```
+
+Attributes:
+
+* `url` - required
+* `width`, `height` - optional. defaults to 560x315
+
+### Wufoo
+
+Copying and pasting the Wufoo Wordpress shortcode should work.
+
+Example:
+
+```
+[wufoo username="awesome_user" formhash="a04909c" autoresize="true" height="961" header="show" ssl="true"]
+```
+
+## 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/shortcodes/all.rb

@@ -0,0 +1,4 @@
+require 'shortcodes'
+
+require 'shortcodes/wufoo'
+require 'shortcodes/youtube'

data/lib/shortcodes/handler.rb

@@ -0,0 +1,22 @@
+module Shortcodes
+  # Abstract Handler
+  class Handler
+
+    def self.call(shortcode)
+      new(shortcode).render
+    end
+
+    attr_reader :shortcode
+    def initialize(shortcode)
+      @shortcode = shortcode
+    end
+
+    def attributes
+      shortcode.attributes
+    end
+
+    def render
+      raise NotImplementedError
+    end
+  end
+end

data/lib/shortcodes/parser.rb

@@ -0,0 +1,47 @@
+require 'active_support/core_ext/class/attribute'
+
+module Shortcodes
+  class Parser
+    autoload 'Nokogiri', 'nokogiri'
+    autoload 'Sanitize', 'sanitize'
+
+    class_attribute :handlers
+    class_attribute :default_handler
+    self.handlers ||= {}
+
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    Shortcode = Struct.new(:code, :attributes)
+
+    def to_html
+      content.gsub(/\[[^\]]+\]/) do |code|
+        shortcode = parse_shortcode(code)
+
+        get_handler(shortcode).call shortcode
+      end
+    end
+
+    private
+
+    def parse_attributes(node)
+      Hash[node.to_a]
+    end
+
+    def get_handler(shortcode)
+      handlers.fetch(shortcode.code) { default_handler }
+    end
+
+    def parse_shortcode(code)
+      code = Sanitize.clean(code).gsub(/^\[/, '<').gsub(/\]$/, '>')
+      doc = Nokogiri::XML.parse(code)
+      node = doc.root
+
+      Shortcode.new(node.name, parse_attributes(node))
+    end
+
+  end
+end

data/lib/shortcodes/version.rb

@@ -0,0 +1,3 @@
+module Shortcodes
+  VERSION = "0.0.1"
+end

data/lib/shortcodes/wufoo.rb

@@ -0,0 +1,50 @@
+require 'erb'
+require 'shortcodes/handler'
+
+module Shortcodes
+  class Wufoo < Handler
+
+    View = Struct.new(:username, :formhash, :autoresize, :height, :header, :ssl) do
+      def self.new_with_attributes(attributes)
+        new(*attributes.values_at(*members.map(&:to_s)))
+      end
+    end
+
+    def view
+      erb = ERB.new(template)
+      klass = erb.def_class(View)
+
+      klass.new_with_attributes(attributes)
+    end
+
+    def render
+      view.result
+    end
+
+    def template
+      <<-HTML
+        <div id="wufoo-<%= formhash %>">
+           Fill out my <a href="http://<%= username %>.wufoo.com/forms/<%= formhash %>">online form</a>.
+        </div>
+        <script type="text/javascript">var <%= formhash %>;(function(d, t) {
+        var s = d.createElement(t), options = {
+        'userName':'<%= username %>',
+        'formHash':'<%= formhash %>',
+        'autoResize':<%= autoresize %>,
+        'height':'<%= height %>',
+        'async':true,
+        'header':'<%= header %>',
+        'ssl':<%= ssl %>};
+        s.src = ('https:' == d.location.protocol ? 'https://' : 'http://') + 'wufoo.com/scripts/embed/form.js';
+        s.onload = s.onreadystatechange = function() {
+        var rs = this.readyState; if (rs) if (rs != 'complete') if (rs != 'loaded') return;
+        try { <%= formhash %> = new WufooForm();<%= formhash %>.initialize(options);<%= formhash %>.display(); } catch (e) {}};
+        var scr = d.getElementsByTagName(t)[0], par = scr.parentNode; par.insertBefore(s, scr);
+        })(document, 'script');</script>
+      HTML
+    end
+
+
+    Shortcodes.register_shortcode('wufoo', self)
+  end
+end

data/lib/shortcodes/youtube.rb

@@ -0,0 +1,36 @@
+require 'shortcodes/handler'
+
+module Shortcodes
+  class Youtube < Handler
+
+    def url
+      # TODO: Provide a better interface for missing url
+      url = shortcode.attributes.fetch('url')
+    end
+
+    def youtube_id
+      match = url.match(/(v=|youtu.be\/)(\w+)/)
+
+      match ? match[2] : nil
+    end
+
+    def time
+      t = url[/(t=[0-9msh]+)/]
+      t ? "##{t}" : nil
+    end
+
+    def height
+      attributes.fetch('height', 315)
+    end
+
+    def width
+      attributes.fetch('width', 560)
+    end
+
+    def render
+      %Q{<iframe width="#{width}" height="#{height}" src="http://www.youtube.com/embed/#{youtube_id}#{time}" frameborder="0" allowfullscreen></iframe>}
+    end
+
+    Shortcodes.register_shortcode('youtube', self)
+  end
+end

data/lib/shortcodes.rb

@@ -0,0 +1,17 @@
+require "shortcodes/version"
+
+require 'shortcodes/parser'
+
+module Shortcodes
+
+  def self.shortcode(content)
+    Parser.new(content).to_html
+  end
+
+  def self.register_shortcode(tag, klass)
+    Parser.handlers[tag] = klass
+  end
+
+  Parser.default_handler = ->(shortcode) { '' }
+end
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: shortcodes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Amiel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 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
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+email:
+- amiel@carnesmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shortcodes/all.rb
+- lib/shortcodes/handler.rb
+- lib/shortcodes/parser.rb
+- lib/shortcodes/version.rb
+- lib/shortcodes/wufoo.rb
+- lib/shortcodes/youtube.rb
+- lib/shortcodes.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+homepage: https://github.com/carnesmedia/shortcodes
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1083873180484645285
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1083873180484645285
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Shortcodes is a simple ruby gem that will parse your cms content for wordpress
+  style shortcodes.
+test_files: []
+has_rdoc: