RubyGems - merb_meta - Versions diffs - 0.0.4 - Mend

merb_meta 0.0.4

Files changed (8) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Cory ODaniel
+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 ADDED Viewed

@@ -0,0 +1,66 @@
+merb_meta
+========
+A plugin for merb that allows super easy manipulation of Meta tags on a controller by controller,
+page-by-page basis
+Merb::Controller#meta
+### ... from app/controllers/application.rb
+class Application < Merb::Controller
+  meta  :title     => "My default page title",
+        :description  => "My default page description",
+        :keywords     => "cool, default keywords, web 2.0"
+end
+### ... from app/views/layout/application.html.erb
+#       meta tags can be output via 'meta' or 'meta :tagname'
+#       using 'meta' will output all the meta data in html tags like
+<html>
+  <head>
+    <%= meta %>
+    <!--
+      Would render;
+      <title>My default page title</title>
+      <meta name="keywords" content="cool, default keywords, web 2.0" />
+      <meta name="description" content="My default page description" />
+    -->
+  </head>
+  ...
+</html>
+#       optionally you can get the value of a particular tag like so:
+<html>
+  <head>
+    <title><%= meta :title %></title>
+    <meta name="keywords" content="<%= meta :keywords %>" />
+    <meta name="description" content="<%= meta :description %>" />
+  </head>
+  <body>
+  ...
+  </body>
+</html>
+### ... the tags can be overriden on a per controller or per action basis.
+class ControllerA < Application
+  meta :title => "This is controller a"
+  def action_a
+    meta :title => "this is action a", :keywords => "action a, action"
+    render
+    # :title => "this is action a"
+    # :keywords => "action a, action"
+    # :description => "My default page description"
+  end
+  def action_b
+    render
+    # :title => "This is controller a"
+    # :description => "My default page description"
+    # :keywords => "cool, default keywords, web 2.0"
+  end
+end

data/Rakefile ADDED Viewed

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'merb-core/version'
+require 'merb-core/tasks/merb_rake_helper'
+require "extlib"
+require "spec/rake/spectask"
+NAME = "merb_meta"
+GEM_VERSION = "0.0.4"
+AUTHOR = "Cory ODaniel"
+EMAIL = "merb-meta@coryodaniel.com"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "A plugin for the Merb framework that provides easy access to setting per-page meta tags."
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  #s.add_dependency('merb', '>= 0.0.0')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+desc "install the plugin locally"
+task :install => [:package] do
+  sh %{sudo gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+namespace :jruby do
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+end
+##############################################################################
+# Specs
+##############################################################################
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+end
+desc "Run all specs and generate an rcov report"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts = ['--exclude', 'gems', '--exclude', 'spec']
+end

data/TODO ADDED Viewed

	@@ -0,0 +1 @@
1	+ # Im sure there is a sneakier less verbose method of doing this, I was in a rush :)

data/lib/merb_meta.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  module Merb
+    class Controller
+      class << self
+        alias :orig_inherited :inherited
+        # Default any subclasses meta tags to that of the parent
+        def inherited(klass)
+          orig_inherited(klass)
+          klass.meta(self.meta)
+        end
+        # Setter/Getter for meta Tags
+        #
+        # @param tags [Hash|Symbol|Nil]
+        #   Hash      => Sets the given meta tags
+        #   NilClass  => Returns the full hash of meta tags
+        #   Symbol    => Returns the specific meta tag
+        #
+        # @api public
+        def meta(tags = nil)
+          @meta_tags ||={}
+          if tags.is_a? Hash
+            @meta_tags.merge!(tags)
+          elsif tags.is_a? Symbol
+            return @meta_tags[tags]
+          end
+          @meta_tags
+        end
+      end
+      # Getter/Setter for a controller instance's meta tags
+      #
+      # @param tags [Hash|NilClass|Symbol]
+      #   Hash      => Sets the given meta tags
+      #   NilClass  => Outputs the HTML
+      #   Symbol    => Returns the specific meta tag
+      #
+      # @returns [Hash|String]
+      #
+      # @api public
+      def meta(tags = nil)
+        @meta_tags ||= self.class.meta.clone
+        if tags.is_a? Hash
+          @meta_tags.merge!(tags)
+          @meta_tags
+        elsif tags.is_a? Symbol
+          return @meta_tags[tags]
+        else
+          output_meta_tags @meta_tags
+        end
+      end
+      protected
+      # Outputs meta tags
+      #
+      # @param meta_data [Hash]
+      #   Meta Tags to output
+      #
+      # @api private
+      def output_meta_tags(meta_data)
+        _meta_data = meta_data.clone
+        meta_title = _meta_data.delete :title
+        markup = meta_title ? %{<title>#{meta_title}</title>} : ''
+        _meta_data.each{|name,content|
+          markup << %{<meta name="#{name}" content="#{content}" />}
+        }
+        markup
+      end
+    end
+  end
+end

data/spec/merb_meta_spec.rb ADDED Viewed

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe "merb_meta" do
+  class Application < Merb::Controller
+    meta :title     => 'My default title',
+      :description  => 'An awesome description',
+      :keywords     => 'awesome, test, controller'
+  end
+  class DefaultPerController < Application
+    meta :title     => 'Woo, the Internet!!!',
+      :description  => "its a fun place to make fun of people and find pr0n",
+      :keywords     => "fun,place,people,pr0n"
+  end
+  class OverrideSomeController < Application
+    meta :title     => "This is different, Arbys is different"
+  end
+  class OverridePerActionController < Application
+    meta :title     => 'Override this plz.'
+    def index
+      meta :keywords => "something fantastic"
+    end
+  end
+  it "should be able to have default meta information for all controllers" do
+    Application.meta.class.should be(Hash)
+    Application.meta(:title).should == 'My default title'
+  end
+  it "should be able to have default meta information for a controller" do
+    Application.meta(:keywords).should == 'awesome, test, controller'
+    DefaultPerController.meta(:keywords).should == "fun,place,people,pr0n"
+    default_per_controller = DefaultPerController.new fake_request
+    default_per_controller.meta(:keywords).should == "fun,place,people,pr0n"
+  end
+  it 'should be able to override meta info on a tag-by-tag basis' do
+    Application.meta(:title).should == 'My default title'
+    OverrideSomeController.meta(:title).should == "This is different, Arbys is different"
+    #OverrideSomeController.meta(:keywords).should == Application.meta(:keywords)
+    override_some = OverrideSomeController.new fake_request
+    override_some.meta(:title).should == OverrideSomeController.meta(:title)
+    override_some.meta :keywords => "super, awesome, keywords"
+    override_some.meta(:keywords).should_not == OverrideSomeController.meta(:keywords)
+  end
+  it 'should default meta tags to that of the parent class' do
+    Application.meta(:keywords).should == 'awesome, test, controller'
+    OverrideSomeController.meta(:keywords).should == Application.meta(:keywords)
+  end
+  it "should be able to have meta information on an action-by-action basis" do
+    override_per_action = OverridePerActionController.new fake_request
+    override_per_action.index
+    override_per_action.meta(:keywords).should == "something fantastic"
+  end
+  it "should be able to output all meta data as HTML" do
+    override_some_meta_html     = OverrideSomeController.new(fake_request).meta
+    index_not_called_meta_html  = OverridePerActionController.new(fake_request).meta
+    opa_controller = OverridePerActionController.new fake_request
+    opa_controller.index
+    index_called_meta_html = opa_controller.meta
+    override_some_meta_html.class.should be(String)
+    index_not_called_meta_html.class.should be(String)
+    index_called_meta_html.class.should be(String)
+    override_some_meta_html.should    == %{<title>This is different, Arbys is different</title><meta name="description" content="An awesome description" /><meta name="keywords" content="awesome, test, controller" />}
+    index_not_called_meta_html.should == %{<title>Override this plz.</title><meta name="description" content="An awesome description" /><meta name="keywords" content="awesome, test, controller" />}
+    index_called_meta_html.should     == %{<title>Override this plz.</title><meta name="description" content="An awesome description" /><meta name="keywords" content="something fantastic" />}
+  end
+  it "should be able to retrieve meta data for a specific tag" do
+    DefaultPerController.meta(:keywords).class.should be(String)
+    DefaultPerController.meta(:title).class.should be(String)
+    DefaultPerController.meta(:description).class.should be(String)
+    DefaultPerController.meta(:title).should        == 'Woo, the Internet!!!'
+    DefaultPerController.meta(:description).should  == "its a fun place to make fun of people and find pr0n"
+    DefaultPerController.meta(:keywords).should     == "fun,place,people,pr0n"
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'rubygems'
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'merb-core'
+require 'merb_meta'
+Spec::Runner.configure do |config|
+  config.include(Merb::Test::ViewHelper)
+  config.include(Merb::Test::RouteHelper)
+  config.include(Merb::Test::ControllerHelper)
+end
+def new_controller(action = 'index', controller = nil, additional_params = {})
+  request = OpenStruct.new
+  request.params = {:action => action, :controller => (controller.to_s || "Test")}
+  request.params.update(additional_params)
+  request.cookies = {}
+  request.accept ||= '*/*'
+  yield request if block_given?
+  response = OpenStruct.new
+  response.read = ""
+  (controller || Merb::Controller).build(request, response)
+end
+class Merb::Controller
+end

metadata ADDED Viewed

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: merb_meta
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Cory ODaniel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2008-10-15 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: A plugin for the Merb framework that provides easy access to setting per-page meta tags.
+email: merb-meta@coryodaniel.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+- LICENSE
+- TODO
+files:
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_meta
+- lib/merb_meta.rb
+- spec/merb_meta_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://merbivore.com/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: merb
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: A plugin for the Merb framework that provides easy access to setting per-page meta tags.
+test_files: []