RubyGems - microdata_fu - Versions diffs - 0.2.5 - Mend

microdata_fu 0.2.5

Files changed (6) hide show

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Wolfger Schramm <wolfger@spearwolf.de>
+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.rdoc ADDED Viewed

@@ -0,0 +1,58 @@
+= microdata_fu (rails plugin)
+A simple rails plugin which enables you to..
+- store <em>non-visible data</em> (microdata) into your html
+- read-out the data from javascript
+== How to Install
+First, add microdata_fu to your list of gems in <tt>config/environment.rb</tt>:
+    config.gem 'spearwolf-microdata_fu', :lib => 'microdata_fu', :source => 'http://gems.github.com'
+Then insert into your html layout the microdata_fu tag (<em>e.g.</em> <tt>app/views/layouts/application.html.erb</tt>):
+    <head>
+      ..
+      <%= microdata_fu %>
+      ..
+    </head>
+== Usage Example
+=== Define microdata in your controller
+    class MyController << ApplicationController
+      def index
+        microdata :foo, 'foo'
+        microdata :bar, { :abc => 'ABC', :xyz => 123 }
+        microdata :user, User.find(params[:id])
+      end
+    end
+=== Set microdata storage type
+    microdata :foo, 'bar'                      # by default values are stored in controller instance
+    microdata :plah, 'foo', :flash => true     # use rails flash storage
+    microdata :bar, 'plah!', :session => true  # use session storage
+=== Read-out microdata from javascript
+In javascript you can read-out the microdata through the microdata_fu api:
+    var foo = microdata_fu.read('foo');
+or use the optional callback function:
+    mircodata_fu.read('bar', function(bar) {
+        /* ...do whatever you want with bar here...
+           if bar is undefined this callback won't be executed */
+    });
+== Author
+Copyright (c) 2008-2010 Wolfger Schramm <wolfger@spearwolf.de>, released under the MIT license

data/lib/microdata_fu.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# MicrodataFu
+module MicrodataFu
+  def self.included(base)
+    base.instance_eval "helper_method :microdata_values"
+  end
+  def microdata key, value, options = {}
+    value = value.respond_to?(:to_json) ? value.to_json : value.to_s.to_json
+    if options[:flash] == true
+      (flash[:microdata] ||= {})[key.to_s] = value
+    elsif options[:session] == true
+      (session[:microdata] ||= {})[key.to_s] = value
+    else
+      (@microdata_values ||= {})[key.to_s] = value
+    end
+  end
+  private
+  def microdata_values
+    returning({}) do |h|
+      h.merge!(session[:microdata]) unless session[:microdata].nil?
+      h.merge!(flash[:microdata]) unless flash[:microdata].nil?
+      h.merge!(@microdata_values) if @microdata_values
+    end
+  end
+end

data/lib/microdata_fu_helper.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module MicrodataFuHelper
+  def microdata_fu
+    md = microdata_values.map {|k,v| "'#{escape_javascript(k)}':#{v}" }.join(",")
+    javascript_tag "var microdata_fu = /* http://github.com/spearwolf/microdata_fu/tree/master */(function(){var _md_fu={#{md}};var md={get:function(k){return _md_fu[k];}};return{read:function(k,fn){var v=md.get(k);if(fn!=undefined&&v!=undefined){v=fn(v);}return v;}}})();"
+  end
+end

data/rails/init.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# microdata_fu rails hooks
+ActionView::Base.send :include, MicrodataFuHelper
+ActionController::Base.send :include, MicrodataFu
+RAILS_DEFAULT_LOGGER.debug "** microdata_fu loaded"

metadata ADDED Viewed

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: microdata_fu
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 2
+  - 5
+  version: 0.2.5
+platform: ruby
+authors:
+- Wolfger Schramm
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-03-23 00:00:00 +01:00
+default_executable:
+dependencies: []
+description: Read-out (rails generated) microdata from javascript
+email: wolfger@spearwolf.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- MIT-LICENSE
+- README.rdoc
+- lib/microdata_fu.rb
+- lib/microdata_fu_helper.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/spearwolf/microdata_fu
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.6
+signing_key:
+specification_version: 3
+summary: Passing microdata from rails to javascript
+test_files: []