manage_meta 0.0.12 → 0.0.13

data/README.markdown

@@ -5,15 +5,24 @@ ManageMeta is yet another meta tag manager for Rails 3.x. Its features are: reco
 should render as HTTP-EQUIV; supports the Google 'canonical' link; is extensible; is non-intrusive
 
 NOTE: ManageMeta works by `include`ing itself into ActionController::Base via an `initializer`
-which is enclosed in ManageMeta::Railtie. This works for Rails 3.0.x - and should also work
-going forward - you're on your own for Rails 2.x
+which is enclosed in ManageMeta::Railtie. This works for Rails 3.0.x and 3.1.x. Don't know if it
+works in Rails 2.x
+
+What's New in Release 0.0.13?
+------------
+
+Support for Facebook Open Graph.
+
+It's a bit clunky, but it will work and can be used to use ManageMeta as a prerequisite
+for an Open Graph metadata handling module. I may do that 'one of these days', but until
+then, see sketch below.
 
 How to use it
 -----------
 
 Include the gem by adding this to your Gemfile file
 
-`gem "manage_meta", ">=0.0.11"`
+`gem "manage_meta", ">=0.0.13"`
 
 or
 
@@ -80,9 +89,9 @@ Here are the ugly details
 
 *add_meta()* accepts values in any of three formats:
 
-* `add_meta(name, value[, :format => :format_name])`
-* `add_meta(name, value[, :format => :format_name]) do ... end`
-* `add_meta(name[, :format => :format_name]) do ... end`
+* `add_meta(name, value[, :format => :format_name] [, :no_capitalize => true/false])`
+* `add_meta(name, value[, :format => :format_name][, :no_capitalize => true/false]) do ... end`
+* `add_meta(name[, :format => :format_name][, :no_capitalize => true/false]) do ... end`
 
 Arguments:
 
@@ -90,9 +99,12 @@ Arguments:
 attribute of the meta tag.
 * *value* must be something which responds to 'to_s' and is not a Hash. Normally it will simply
 be a string. If given, it supplies the leading part of the *content* attribute of the meta tag
-* The single *option* :format must supply an existing key in @manage_meta_format_hash. It is
+* The *option* :format must supply an existing key in @manage_meta_format_hash. It is
 used to associate a meta tag format with *name*. If not given and not currently defined
 in `@manage_meta_format_hash`, it will be set to *:named*. (see below for details)
+* The *option* :no_capitalize controls capitalization of each word in the *name* attribute
+when translated to a String. This was added to deal with Facebook Open Graph *property* tags
+which are of the form 'og:title' and 'fb:admins', etc. :no_capitalize should be a boolean.
 * The *optional block* is evaluated and the return value is used as the second [or only] part
 of the _content_ attribute of the meta tag.
 
@@ -166,3 +178,17 @@ Maps meta tag name symbols to meta tag format string symbols. Contains entries
 such as `:content_length => :http_equiv`
 
 both keys and values are symbols
+
+A Facebook Open Graph Sketch
+-----------------------
+
+First define an appropriate format:
+
+    `add_meta_format :property, '<meta property="#{name}" content="#{content}" char-encoding="utf-8">'`
+
+Then, add each Open Graph meta tag you need, specifying both :format and :no_capitalize options:
+
+    `add_meta 'og:title', 'This is a Title', :format => :property, :no_capitalize => true`
+    
+You can specify the Open Graph property name as a string (above) or as a symbol `:'og:title'`,
+but - inasmuch as they contain colons (:) - you need to enclose them in quotes.

data/Rakefile

@@ -21,14 +21,8 @@ task :gem do
   system 'gem build manage_meta.gemspec'
 end
 
-desc "commit changes"
-task :commit do
-  system 'git add .'
-  system 'git commit -m "checkin"'
-end
-
-desc "commit changes and tag as #{manage_meta_version}"
-task :tag => :commit do
+desc "tag as #{manage_meta_version}"
+task :tag do
   system "git tag #{manage_meta_version}"
 end
 

data/lib/manage_meta/manage_meta.rb

@@ -10,6 +10,7 @@ module ManageMeta
   def _manage_meta_init
     return if @manage_meta_meta_hash.instance_of? Hash
     @manage_meta_meta_hash = {}
+    @manage_meta_options = {}
 
     @manage_meta_format_hash = {
       :named => '<meta name="#{name}" content="#{content}" char-encoding="utf-8" />',
@@ -44,12 +45,13 @@ module ManageMeta
   #  Note: if no both 'value' and 'block' are given, then the content of the meta tag is the concatenation
   #         of both values.
   #  options:
-  #    :format => symbol - where 'symbol' is one of :named, :http_equiv, :canonical, or a format
+  #    :format => symbol - where 'symbol' is one of :named, :http_equiv, :canonical, :property, or a format
   #       added with 'add_meta_format'
+  #    :no-capitalize  =>  true or false - default is false
   #    all other options keys are ignored
   #--
   def add_meta(name, opt_value = nil, options = {}, &block)
-    _manage_meta_init unless @manage_meta_meta_hash.instance_of? Hash
+    _manage_meta_init
     
     # make sure name is a string
     name = _manage_meta_name_to_sym name
@@ -60,11 +62,11 @@ module ManageMeta
       value = opt_value
       value += yield.to_s if block_given?
     when opt_value.is_a?(Hash)
-      raise ArgumentError, "Value for meta tag #{name} missing" if !block_given?
+      raise ArgumentError, "Value for meta tag #{name} missing" unless block_given?
       value = yield.to_s
       options = opt_value
     when opt_value.nil?
-      raise ArgumentError, "Value for meta tag #{name} missing" if !block_given?
+      raise ArgumentError, "Value for meta tag #{name} missing" unless block_given?
       value = yield.to_s
     when opt_value.respond_to?(:to_s)
       value = opt_value.to_s
@@ -74,16 +76,10 @@ module ManageMeta
     end
     @manage_meta_meta_hash[name] = value
 
-    if (options.keys - [:format]).size > 0
-      raise RuntimeError, "add_meta(#{name}, ...): illegal option key(s): #{options.keys - [:format]}"
-    end
+    _manage_meta_set_options name, options
 
     # if format is explicitly called out or if name is not yet known
-    if options.has_key?(:format)
-      raise RuntimeError, "Unsuported Format: #{options[:format]}: formats are #{@manage_meta_format_hash.keys.join(',')}" \
-            if !@manage_meta_format_hash.has_key?(options[:format].to_sym)
-      @manage_meta_name_to_format[name] = options[:format].to_sym
-    elsif !@manage_meta_name_to_format.has_key?(name)
+    unless @manage_meta_name_to_format.has_key?(name)
       @manage_meta_name_to_format[name] = :named
     end
   end
@@ -94,7 +90,7 @@ module ManageMeta
   # if _name_ is in @manage_meta_meta_hash, then it will be deleted
   #--
   def del_meta(name)
-    _manage_meta_init unless @manage_meta_meta_hash.instance_of? Hash
+    _manage_meta_init
     
     name = _manage_meta_name_to_sym name
     @manage_meta_meta_hash.delete name if @manage_meta_meta_hash.has_key? name
@@ -104,12 +100,13 @@ module ManageMeta
   # add_meta_format(key, format)
   #
   # adds the format _format_ to @manage_meta_format_hash using the key _key_
+  #  unless it is already defined
   #--
   def add_meta_format(key, format)
-    _manage_meta_init unless @manage_meta_meta_hash.instance_of? Hash
+    _manage_meta_init
     
-    key = key.to_sym
-    @manage_meta_format_hash[key] = format
+    key = _manage_meta_name_to_sym key
+    @manage_meta_format_hash[key] = format unless @manage_meta_format_hash[key]
   end
 
   #++
@@ -119,7 +116,7 @@ module ManageMeta
   # using their name-specific formats and indented two spaces.
   #--
   def render_meta
-    _manage_meta_init unless @manage_meta_meta_hash.instance_of? Hash
+    _manage_meta_init
     
     '  ' + @manage_meta_meta_hash.map do |name, content|
       @manage_meta_format_hash[@manage_meta_name_to_format[name]].sub('#{name}', _manage_meta_sym_to_name(name)).sub('#{content}', content)
@@ -128,13 +125,31 @@ module ManageMeta
   
   private
   def _manage_meta_sym_to_name(sym)
-    sym.to_s.split(/[_-]/).map {|x| x.capitalize }.join('-')
+    _manage_meta_init
+    @manage_meta_options[sym] && @manage_meta_options[sym][:no_capitalize] ? sym.to_s.gsub(/[-_]+/, '-') : sym.to_s.split(/[_-]/).map {|x| x.capitalize }.join('-')
   end
   
   def _manage_meta_name_to_sym(name)
     name.to_s.downcase.gsub(/[-_]+/, '_').to_sym
   end
 
+  def _manage_meta_set_options name, options
+    _manage_meta_init
+    options.keys.each do |option|
+      case option
+      when :format
+        raise RuntimeError, "Unsuported Format: #{options[:format]}: formats are #{@manage_meta_format_hash.keys.join(',')}" \
+              unless @manage_meta_format_hash.has_key? _manage_meta_name_to_sym(options[:format])
+        @manage_meta_name_to_format[name] = _manage_meta_name_to_sym options[:format]
+      when :no_capitalize
+        @manage_meta_options[name] = {} unless @manage_meta_options[name]
+        @manage_meta_options[name][option] = options[option]
+      else
+        raise RuntimeError, "add_meta(#{name}, ...): illegal option key(s): #{options.keys - [:format]}"
+      end
+    end
+  end
+  
   public :add_meta, :del_meta, :add_meta_format, :render_meta
   private :_manage_meta_init, :_manage_meta_sym_to_name, :_manage_meta_name_to_sym
 

data/test/manage_meta_test.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH << File.expand_path("../../lib",  __FILE__)
 require 'test/unit'
+require 'pry'
 require 'manage_meta'
 
 class NoToS
@@ -28,13 +29,13 @@ class ManageMetaTest < Test::Unit::TestCase
   # include ManageMeta after setup
   include ManageMeta
 
-  def test__manage_meta_init
+  def test_manage_meta_init
     refute self.instance_variables.map {|x| x.to_sym }.include?(:@manage_meta_meta_hash), "self does not contain @manage_meta_meta_hash"
     self.send(:_manage_meta_init)
     assert self.instance_variables.map {|x| x.to_sym }.include?(:@manage_meta_meta_hash), "self contains @manage_meta_meta_hash"
   end
 
-  def test__manage_meta_init_is_itempotent
+  def test_manage_meta_init_is_itempotent
     self.send(:_manage_meta_init)
     h = {}
     self.instance_variables.grep(/manage_meta/).each do |name|
@@ -63,17 +64,30 @@ class ManageMetaTest < Test::Unit::TestCase
     assert self.private_methods.grep(/_manage_meta_sym_to_name/), "has private method _manage_meta_sym_to_name"
   end
   
-  def test__manage_meta_sym_to_name
+  def test__manage_meta_set_options
+    _manage_meta_init
+    _manage_meta_set_options :foo, :format => :canonical, :no_capitalize => true
+    assert_equal :canonical, @manage_meta_name_to_format[:foo], "format of :foo should be canonical"
+    assert @manage_meta_options[:foo][:no_capitalize], ":foo should have no_capitalize flag set"
+  end
+
+  def test_manage_meta_sym_to_name
+    _manage_meta_init
+    @manage_meta_options[:'og:title'] = {}
+    @manage_meta_options[:'og:title'][:no_capitalize] = true
     {:foo => 'Foo', :foo_bar => "Foo-Bar", :foo_bar_baz => "Foo-Bar-Baz", "Foo-Bar" => "Foo-Bar",
-      "Foo_bar" => "Foo-Bar" }.each do |key, val|
-      assert_equal _manage_meta_sym_to_name(key), val, "_manage_meta_sym_to_name(#{key}) == #{val}"
+      "Foo_bar" => "Foo-Bar", :'og:title' => 'og:title'}.each do |key, val|
+      assert_equal val, _manage_meta_sym_to_name(key), "_manage_meta_sym_to_name(#{key}) == #{val}"
     end
   end
   
-  def test__manage_meta_name_to_sym
+  def test_manage_meta_name_to_sym
+    _manage_meta_init
+    @manage_meta_options[:'og:title'] = {}
+    @manage_meta_options[:'og:title'][:no_capitalize] = true
     { 'Foo'  => :foo, 'Foo-Bar' => :foo_bar, 'Foo--Bar_Baz' => :foo_bar_baz,
-      :foo_bar_baz => :foo_bar_baz, :foo____bar => :foo_bar }.each do |key, val|
-      assert_equal _manage_meta_name_to_sym(key), val, "_manage_meta_name_to_sym(#{key}) == #{val}"
+      :foo_bar_baz => :foo_bar_baz, :foo____bar => :foo_bar, 'og:title' => :'og:title' }.each do |key, val|
+      assert_equal val, _manage_meta_name_to_sym(key), "_manage_meta_name_to_sym(#{key}) == #{val}"
     end
   end
 
@@ -140,7 +154,7 @@ class ManageMetaTest < Test::Unit::TestCase
   
   # test 'add_meta_format' do
   def test_add_meta_format_adds_a_format
-    format = '<meta foo-type="#{name}" content="#{content}"'
+    format = '<meta foo-type="#{name}" content="#{content}">'
     add_meta_format(:foo, format)
     assert self.instance_variable_get("@manage_meta_format_hash").key?(:foo),
       "add_meta_format adds key to format_hash using symbol"
@@ -168,4 +182,11 @@ class ManageMetaTest < Test::Unit::TestCase
     refute @@helper_args.nil?, "helper_method called with at least one argument"
   end
 
+  # test open graph metadata
+  def test_adding_og_metadata
+    format = '<meta property="#{name}" content="#{content}">'
+    add_meta_format(:property, format)
+    add_meta "og:title", 'The Grand Octopus', :format => :property, :no_capitalize => true
+    assert_match '<meta property="og:title" content="The Grand Octopus">', render_meta, "og:title metadata should be correct"
+  end
 end

metadata

@@ -1,28 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: manage_meta
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.13
   prerelease: 
-  version: 0.0.12
 platform: ruby
-authors: 
+authors:
 - Mike Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-22 00:00:00 -06:00
-default_executable: 
+date: 2012-01-09 00:00:00.000000000Z
 dependencies: []
-
 description: Provides (semi-)intellegent management of meta tags for Rails 3
 email: mike@clove.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/manage_meta/manage_meta.rb
 - lib/manage_meta/railtie.rb
 - lib/manage_meta.rb
@@ -30,33 +24,28 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.markdown
-has_rdoc: true
 homepage: http://github.com/mikehoward/manage_meta
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: ManageMeta - Yet Another Meta Tag manager for Rails 3
 test_files: []
-