RubyGems - manage_meta - Versions diffs - 0.0.13 → 0.0.14 - Mend

manage_meta 0.0.13 → 0.0.14

Files changed (7) hide show

data/README.markdown +99 -27
data/Rakefile +10 -15
data/lib/manage_meta.rb +1 -0
data/lib/manage_meta/manage_meta.rb +56 -7
data/lib/manage_meta/version.rb +3 -0
data/test/manage_meta_test.rb +37 -0
metadata +4 -3

data/README.markdown CHANGED

@@ -1,21 +1,23 @@
-ManageMeta
+ManageMeta - Version: 0.0.14
 ============
-ManageMeta is yet another meta tag manager for Rails 3.x. Its features are: recognizes tags
-should render as HTTP-EQUIV; supports the Google 'canonical' link; is extensible; is non-intrusive
+ManageMeta is yet another meta tag manager for Rails 3.x. Its features
+are: recognizes tags 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 3.1.x. Don't know if it
-works in Rails 2.x
+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 3.1.x. Don't know
+if it works in Rails 2.x
-What's New in Release 0.0.13?
+What's New in Release 0.0.14?
 ------------
 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.
+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
 -----------
@@ -28,37 +30,55 @@ or
 `gem "manage_meta", :git => "git://github.com/mikehoward/manage_meta.git"`
-Then, in your controller actions, call *add_meta()* for each meta tag you want
-to define.
+Then, in your controller actions, call *add_meta()* for each meta tag
+you want to define.
 `add_meta :author, 'Fred Fink'`
-If there are meta tags you don't want to define, you can use *del_meta()* to remove them.
-At present there are only two automatically defined: 'robots' and 'generator'. You may
-also redefine them by using *add_meta()* to give them new values.
+If there are meta tags you don't want to define, you can use
+*del_meta()* to remove them.  At present there are only two
+automatically defined: 'robots' and 'generator'. You may also redefine
+them by using *add_meta()* to give them new values.
-If there is a meta tag which requires a currently unsupported format, you may add the
-format using *add_meta_format()*, and then add the tag using *add_meta()*.
+If there is a meta tag which requires a currently unsupported format,
+you may add the format using *add_meta_format()*, and then add the tag
+using *add_meta()*.
 Finally, edit app/views/layouts/application.html.erb - or equivalent - to insert
 `<%= render_meta %>`
-into the _head_ section of your HTML output. This will render and return all of the
-defined meta tags.
+into the _head_ section of your HTML output. This will render and
+return all of the defined meta tags.
+NOTE: `manage_meta` now creates `charset` meta tags for HTML5 and (if
+desired) HTML4.01 and XHTML output. These tags should be placed early
+in the <head> section of your page.
+`manage_meta` does this by inserting the appropriate meta tag at the
+head of the rendered metadata. Consequently, you should put the `<%=
+render_meta %>` statement IMMEDIATELY after the <head> tag if (1) your
+document is an HTML5 OR (2) it is HTML 4 or XHTML and you
+`add_meta(:content_type, ...)`.
 What it Adds
 ------------
-ManageMeta defines seven (7) methods and three (3) instance variables into all classes
-derived from ApplicationController
+ManageMeta defines seven (9) methods and three (6) instance variables
+into all classes derived from ApplicationController
 The public methods are:
 * `add_meta()` - adds a meta tag
 * `del_meta()` - which deletes a meta tag
 * `add_meta_format()` - which adds a meta tag format
-* `render_meta()` - which returns a string rendering all currently defined meta tags.
+* `render_meta()` - which returns a string rendering all currently
+* defined meta tags.
+* `manage_meta_set_emit_encoding(bool)` - sets @@manage_meta_emit_encoding.
+(set to false if you want to include your encoding by hand) [default is `true`]
+* `manage_meta_set_encoding()` - allows setting character encoding
+* `manage_meta_set_html_version()` - allows setting html version to
+html5, html4, or xhtml
 private methods:
@@ -83,6 +103,23 @@ The Details
 Here are the ugly details
+### charset meta tags ###
+`charset` meta tags are ONLY emitted if the class variable
+`@@manage_meta_set_encoding` is `true`.  Inasmuch as `ManageMeta` is
+included in ApplicationController::Base, this effects all controllers.
+You control the value of this variable using
+`manage_meta_set_emit_encoding()`. The default is `true`, so the
+charset meta tags are emitted - subject to . . .
+NOTE: If @@manage_meta_emit_encoding is `true`, character encoding
+strings are
+* always emitted for HTML 5 pages
+* Only emitted for HTML 4.01 and XHTML pages IF a `:content_type` meta
+tag is added via `add_meta()`
 ### Methods in Detail ###
 #### `add_meta()` ####
@@ -110,8 +147,8 @@ of the _content_ attribute of the meta tag.
 Three meta tag formats are defined automatically:
-* `:named => '<meta name="#{name}" content="#{content}" char-encoding="utf-8" />'`
-* `:http_equiv => '<meta http-equiv="#{name}" content="#{content}" char-encoding="utf-8" />'`
+* `:named => '<meta name="#{name}" content="#{content}" charset="utf-8" />'`
+* `:http_equiv => '<meta http-equiv="#{name}" content="#{content}" charset="utf-8" />'`
 * `:canonical => '<link rel="canonical" href="#{content}" />'`
 The _@manage_meta_name_to_format_ is populated with entries mapping known HTTP-EQUIV tags
@@ -146,11 +183,31 @@ simply goes through all the defined key, value pairs in @manage_meta_meta_hash a
 returns their associated format strings after replacing the `#{name}` and `#{content}`
 symbols with their values.
-`#{name}` is replaced with the meta tag key [as in `:content_type`] passed through
-`_manage_meta_sym_to_name()`.
+`#{name}` is replaced with the meta tag key [as in `:content_type`]
+passed through `_manage_meta_sym_to_name()`.
 `#{value}` is replaced by the value assigned in `@manage_meta_meta_hash`.
+#### manage_meta_set_encoding( encoding ) ####
+Sets the instance variable `@manage_meta_encoding` to `encoding`.
+The default value is `utf-8`, so don't bother unless you're using
+something else.
+#### manage_meta_set_html_version( version ) ####
+sets the instance variable `@manage_meta_html_version` to the symbol
+associated with string `version`. Version is decoded using regular
+expressions which match strings like html5, html 5, HTML  5, html 4,
+etc.
+The actual value is one of the symbols: :html5, :html4, or :xhtml.
+An ArgumentError is raised if `version` does not match a known string.
+The value of `@manage_meta_html_version` is used in prepending a
+`charset` meta tag to string emitted by `render_meta`.
 ### Instance Variables in Detail ###
 All three hashes use symbols for keys.
@@ -179,12 +236,27 @@ such as `:content_length => :http_equiv`
 both keys and values are symbols
+#### `@@manage_meta_emit_encoding` ####
+Boolean which is `true` or `false`. Controls whether or not an
+encoding meta tag is emitted
+#### `@manage_meta_encoding` ####
+String which is used in the `charset` meta tag which is emitted
+#### `@manage_meta_html_version` ####
+Symbol which represents the html version used in the page. Possible
+values are `html4`, `html4`, and `xhtml`.  Currently only used to
+control what type of `charset` encoding meta tag to emit.
 A Facebook Open Graph Sketch
 -----------------------
 First define an appropriate format:
-    `add_meta_format :property, '<meta property="#{name}" content="#{content}" char-encoding="utf-8">'`
+    `add_meta_format :property, '<meta property="#{name}" content="#{content}" charset="utf-8">'`
 Then, add each Open Graph meta tag you need, specifying both :format and :no_capitalize options:

data/Rakefile CHANGED

@@ -1,33 +1,28 @@
 require 'rake'
+require './lib/manage_meta/version'
 # snarf gemspec and set version
-x = eval File.new('manage_meta.gemspec').read
-manage_meta_version = x.version.to_s
+manage_meta_version = ManageMeta::VERSION.to_s
 task :default => :test
 desc "Run ManageMeta unit tests"
 task :test do
+  puts "Version: #{manage_meta_version}"
   require './test/manage_meta_test'
 end
-desc "run rdoc to create doc"
-task :doc do
-  system 'rdoc'
+desc "build README"
+task :readme do
+  system "sed -e s/VERSION/#{manage_meta_version}/ README.markdown.src >README.markdown"
 end
 desc "build gem"
-task :gem do
+task :gem => :readme do
   system 'gem build manage_meta.gemspec'
 end
-desc "tag as #{manage_meta_version}"
-task :tag do
-  system "git tag #{manage_meta_version}"
-end
-desc "distribute to github and rubygems"
-task :distribute => [:tag, :gem] do
-  system "gem push manage_meta-#{manage_meta_version}.gem"
-  system "git push manage_meta"
+desc "prep for distributions"
+task :prep => :readme do
+  puts "push it by hand - in case you are on a branch or something"
 end

data/lib/manage_meta.rb CHANGED

@@ -1,2 +1,3 @@
 require 'manage_meta/manage_meta'
+require 'manage_meta/version'
 require 'manage_meta/railtie' if defined? Rails

data/lib/manage_meta/manage_meta.rb CHANGED

@@ -1,4 +1,9 @@
 module ManageMeta
+  LEGAL_HTML_VALUES = {
+    html4: /^html\s*4(.01)?$/i,
+    html5: /^html\s*5$/i,
+    xhtml: /^xhtml\s*(1(\.0)?)?$/i
+  }
   def self.included(mod)
     begin
       mod.send(:helper_method, :render_meta)
@@ -9,12 +14,15 @@ module ManageMeta
   #- initialize instance variables
   def _manage_meta_init
     return if @manage_meta_meta_hash.instance_of? Hash
+    @manage_meta_html_version = :html5
+    @manage_meta_encoding = 'utf-8'
+    @@manage_meta_emit_encoding = true
     @manage_meta_meta_hash = {}
     @manage_meta_options = {}
     @manage_meta_format_hash = {
-      :named => '<meta name="#{name}" content="#{content}" char-encoding="utf-8" />',
-      :http_equiv => '<meta http-equiv="#{name}" content="#{content}" char-encoding="utf-8" />',
+      :named => '<meta name="#{name}" content="#{content}" />',
+      :http_equiv => '<meta http-equiv="#{name}" content="#{content}" />',
       :canonical => '<link rel="canonical" href="#{content}" />',
     }
@@ -56,7 +64,7 @@ module ManageMeta
     # make sure name is a string
     name = _manage_meta_name_to_sym name
-    # handle optional nonsense
+    # handle optional
     case
     when opt_value.is_a?(String)
       value = opt_value
@@ -113,16 +121,57 @@ module ManageMeta
   # render_meta
   #
   # returns a string consisting of all defined meta names in @manage_meta_meta_hash, formatted
-  # using their name-specific formats and indented two spaces.
+  # using their name-specific formats and indented with two spaces.
   #--
   def render_meta
     _manage_meta_init
-    '  ' + @manage_meta_meta_hash.map do |name, content|
+    leader = '  '
+    if @@manage_meta_emit_encoding
+      if @manage_meta_html_version == :html5
+        # insert charset meta tag immediately after <head>
+        leader += "<meta charset=\"#{@manage_meta_encoding}\">\n  "
+      else  # covers both xhtml and html 4.01
+        # augment content_type meta tag with charset encoding and move to top of meta tags
+        if (value = @manage_meta_meta_hash.delete(:content_type)) \
+          and value !~ /charset/i
+          leader += "<meta http-equiv=\"Content-type\" content=\"text/html; charset=#{@manage_meta_encoding}\" />\n  "
+        end
+      end
+    end
+    leader + @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)
     end.join("\n  ") + "  \n"
   end
+  def manage_meta_set_emit_encoding bool
+    @@manage_meta_emit_encoding = !!bool
+  end
+  #++
+  # manage_meta_set_encoding encoding - sets character encoding for page
+  #--
+  def manage_meta_set_encoding encoding
+    @manage_meta_encoding = encoding
+  end
+  #++
+  # manage_meta_set_html_version version
+  #
+  #
+  #--
+  def manage_meta_set_html_version version = 'html5'
+    version_downcase = version.to_s.downcase.strip
+    LEGAL_HTML_VALUES.each do |html_key, regx|
+      next unless version_downcase =~ regx
+      @manage_meta_html_version = html_key
+      return
+    end
+    raise ArgumentError.new("Illegal html version: #{version}")
+  end
   private
   def _manage_meta_sym_to_name(sym)
     _manage_meta_init
@@ -153,4 +202,4 @@ module ManageMeta
   public :add_meta, :del_meta, :add_meta_format, :render_meta
   private :_manage_meta_init, :_manage_meta_sym_to_name, :_manage_meta_name_to_sym
-end
+end

data/lib/manage_meta/version.rb ADDED

@@ -0,0 +1,3 @@
+module ManageMeta
+  VERSION = '0.0.14'
+end

data/test/manage_meta_test.rb CHANGED

@@ -189,4 +189,41 @@ class ManageMetaTest < Test::Unit::TestCase
     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
+  # test_set_encoding
+  def test_set_encoding
+    self.manage_meta_set_encoding 'foobar'
+    assert_equal 'foobar', self.instance_variable_get('@manage_meta_encoding')
+  end
+  # test html version
+  def test_set_html_version
+    self.send :_manage_meta_init
+    assert_equal :html5, self.instance_variable_get('@manage_meta_html_version')
+    ['html5/HTML 5', 'html5/HTML5',
+     'html4/html 4', 'html4/ html 4.01', 'xhtml/ xhtml/xhtml 1.0',
+     'xhtml/xhtml1' ].each do |str|
+      key, version = str.split('/')
+      self.manage_meta_set_html_version version
+      assert_equal key.to_sym, self.instance_variable_get('@manage_meta_html_version')
+    end
+  end
+  # test charset encoding in render_meta
+  def test_charset_encoding_in_render_meta
+    self.send :_manage_meta_init
+    assert_match /<meta charset="utf-8">/, self.render_meta
+    self.manage_meta_set_html_version 'html4'
+    self.add_meta :content_type, 'text/html'
+    assert_match /<meta http-equiv="Content-Type" content="text\/html; charset=utf-8"/i, self.render_meta
+  end
+  # test set emit encoding
+  def test_emit_encoding
+    self.send :_manage_meta_init
+    assert @@manage_meta_emit_encoding
+    self.manage_meta_set_emit_encoding false
+    assert_equal false, @@manage_meta_emit_encoding
+  end
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: manage_meta
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies: []
 description: Provides (semi-)intellegent management of meta tags for Rails 3
 email: mike@clove.com
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - lib/manage_meta/manage_meta.rb
 - lib/manage_meta/railtie.rb
+- lib/manage_meta/version.rb
 - lib/manage_meta.rb
 - test/manage_meta_test.rb
 - MIT-LICENSE
@@ -44,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.6
+rubygems_version: 1.8.11
 signing_key:
 specification_version: 3
 summary: ManageMeta - Yet Another Meta Tag manager for Rails 3