html_meta 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html_meta.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Brewer
+
+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,87 @@
+# HtmlMeta (beta)
+
+Helps with constructing meta tags
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'html_meta'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html_meta
+
+## Usage
+
+In an initializer file set any configuration options:
+
+	HtmlMeta.configure do |config|	
+		config.title_separator = ' | '
+	end
+
+Set some defaults in an initializer file:
+
+	HtmlMeta.define do
+		meta :title, '21purple Web Studios'
+		meta :keywords, 'expressionengine developer development php custom web application'
+		meta :description, 'We are an awesome web development shop'
+	end
+
+And then later in a controller action or where ever modify the meta tag values:
+
+	HtmlMeta.define do
+		meta :title, 'Ruby Development', prepend: true
+		meta :keywords, 'ruby rails padrino', append: true
+		meta :description, 'We are an awesome ruby web development shop'
+		open_graph :title, 'Ruby Developer'
+	end
+
+You can also use the shorthand method og for setting open graph tags:
+
+	HtmlMeta.define do
+		og :title, 'Ruby Developer'
+	end
+
+You can also set a single meta tag value:
+
+	HtmlMeta.meta :title, 'Rails Development', prepend: true
+
+Or you can get a meta tag value:
+
+	HtmlMeta.meta :title
+	
+The open graph tags have similar setters:
+	
+	HtmlMeta.open_graph :title, 'Rails Development', prepend: true
+	
+	or 
+	
+	HtmlMeta.og :title, 'Rails Development', prepend: true
+
+ And getters:
+
+	HtmlMeta.open_graph :title
+	
+	or 
+	
+	HtmlMeta.og :title
+
+
+And then render the html for the meta tags:
+
+	HtmlMeta.render
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/html_meta.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/html_meta/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas Brewer"]
+  gem.email         = ["tom@21purple.com"]
+  gem.description   = %q{Helps with constructing meta tags}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "html_meta"
+  gem.require_paths = ["lib"]
+  gem.version       = HtmlMeta::VERSION
+  gem.add_development_dependency('rspec')
+  gem.add_dependency('arbre')
+end

data/lib/html_meta.rb

@@ -0,0 +1,66 @@
+require "html_meta/version"
+require "html_meta/configuration"
+require "html_meta/data"
+require "arbre"
+
+module HtmlMeta
+  	
+	class << self
+
+		def configuration
+			self.configuration
+		end
+
+    	attr_accessor :configuration, :data
+
+    	def configure
+    		self.configuration ||= Configuration.new
+	   	 	yield(self.configuration) if block_given?
+	    	self.configuration
+		end
+
+		def define(&block)
+			self.data ||= Data.new
+			raise ArgumentError.new("You must pass a block to the method") unless block_given?
+			self.data.instance_eval(&block)
+		end
+
+		def meta(key, value = nil, options = {})
+			self.data ||= Data.new
+			self.data.meta(key, value, options)
+		end
+
+		def open_graph(key, value = nil, options = {})
+			self.data ||= Data.new
+			self.data.open_graph(key, value, options)
+		end
+
+		alias :og :open_graph
+
+		def reset
+			self.data ||= Data.new
+			self.data.reset
+		end
+
+		def render
+			self.data ||= Data.new
+			default = self.data.get(:default)
+			open_graph = self.data.get(:og)
+			html = Arbre::Context.new do
+				default.each do |key, value| 
+					if key == :title
+						title value
+					else
+						meta(name: key.to_s, content: value)
+					end
+				end
+				open_graph.each do |key, value| 				
+					meta(property: 'og:' + key.to_s, content: value)
+				end
+			end
+			html.to_s
+		end
+
+  	end
+
+end

data/lib/html_meta/configuration.rb

@@ -0,0 +1,5 @@
+module HtmlMeta
+	class Configuration
+		attr_accessor :title_separator
+	end
+end

data/lib/html_meta/data.rb

@@ -0,0 +1,62 @@
+module HtmlMeta
+
+	class Data
+
+		def initialize
+	  		@data = {}
+	  	end
+
+	  	def reset
+	  		@data = {}
+	  	end
+
+	  	def data(scope = :default)
+	  		@data[scope] ||= {}
+	  	end
+
+	  	def get(scope, key = nil)
+	  		if key.nil?
+				data(scope)
+			else
+	  			data(scope).fetch(key) { nil } 
+	  		end
+	  	end
+
+	  	def set(scope, key, value = nil, options = {})
+			separator = options.fetch(:separator, ' ')
+			value = Array(value)
+			if options.fetch(:prepend, false)
+				value << data(scope).fetch(key, '')
+			elsif options.fetch(:append, false)
+				value.insert(0, data(scope).fetch(key, ''))
+			end
+			data(scope)[key] = value.compact.join(separator)
+	  	end
+
+	  	def meta(key, value = nil, options = {})
+			if value.nil?
+	  			return get(:default, key)
+	  		else
+		  		if key == :title && 
+		  			unless options.key?(:separator)
+						options[:separator] = HtmlMeta.configuration.title_separator 
+					end
+				end
+	  			set(:default, key, value, options)	  			
+	  		end
+	  	end
+
+	  	def open_graph(key, value = nil, options = {})
+	  		if value.nil?
+	  			return get(:og, key)
+	  		else
+	  			#we are setting a value
+	  			set(:og, key, value, options)	  			
+	  		end
+	  	end
+
+	  	alias :og :open_graph
+
+	end
+
+end

data/lib/html_meta/version.rb

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

data/spec/html_meta_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe HtmlMeta do
+	
+	context "Configuration" do	
+
+		it "should present a configuration object via a block" do
+			configuration = nil
+			HtmlMeta.configure do |config|
+				configuration = config			
+			end
+			configuration.should be_instance_of(HtmlMeta::Configuration)
+		end
+
+		it "should let me set a title_separator option on the configuration object" do
+			configuration = nil
+			HtmlMeta.configure do |config|
+				configuration = config			
+				config.title_separator = ' | '
+			end
+			configuration.title_separator.should eq(' | ')
+		end
+
+	end
+
+	context "Defining" do
+
+		before do
+			HtmlMeta.reset
+		end
+
+		it "should allow you to set meta tag data via a define block" do
+			title = '21purple'
+			HtmlMeta.define do
+				meta :title, title
+			end
+			HtmlMeta.meta(:title).should eq(title)
+		end
+
+	end
+
+	context "ReDefining" do
+
+		before do
+			HtmlMeta.reset
+			HtmlMeta.define do
+				meta :keywords, 'rails development'
+			end
+		end
+
+		it "should allow you to set new values for meta tag data that has already been set" do
+			HtmlMeta.define do
+				meta :keywords, 'rails padrino development'
+			end
+			HtmlMeta.meta(:keywords).should_not eq('rails development')
+			HtmlMeta.meta(:keywords).should eq('rails padrino development')
+		end
+
+		it "should allow you to pass a prepend option to prepend the new value for a meta tag" do
+			HtmlMeta.define do
+				meta :keywords, 'padrino', prepend: true 
+			end
+			HtmlMeta.meta(:keywords).should_not eq('rails development')
+			HtmlMeta.meta(:keywords).should eq('padrino rails development')
+		end
+
+		it "should allow you to pass a append option to prepend the new value for a meta tag" do
+			HtmlMeta.define do
+				meta :keywords, 'padrino', append: true 
+			end
+			HtmlMeta.meta(:keywords).should_not eq('rails development')
+			HtmlMeta.meta(:keywords).should eq('rails development padrino')
+		end
+
+		it "should allow you to pass a separator option" do
+			HtmlMeta.define do
+				meta :keywords, 'padrino', append: true, separator: ',' 
+			end
+			HtmlMeta.meta(:keywords).should_not eq('rails development')
+			HtmlMeta.meta(:keywords).should eq('rails development,padrino')
+		end
+
+		it "should use the configuration title_separator when modifying the :title" do
+			HtmlMeta.define do
+				meta :title, '21purple'
+			end
+			HtmlMeta.define do
+				meta :title, 'Blog', prepend: true
+			end
+			HtmlMeta.meta(:title).should eq('Blog | 21purple')
+		end
+
+		it "should not use the configuration title_separator when modifying the :title if a separator options is passed" do
+			HtmlMeta.define do
+				meta :title, '21purple'
+			end
+			HtmlMeta.define do
+				meta :title, 'Blog', prepend: true, separator: ' - '
+			end
+			HtmlMeta.meta(:title).should_not eq('Blog | 21purple')
+			HtmlMeta.meta(:title).should eq('Blog - 21purple')
+		end
+
+	end
+
+	context "OpenGraph" do
+
+		before do
+			HtmlMeta.reset
+		end
+
+		it "should allow you to set open graph meta tags" do
+			HtmlMeta.define do
+				open_graph :title, '21purple'
+			end
+			HtmlMeta.open_graph(:title).should eq('21purple')
+		end
+
+		it "should allow you to set open graph meta tags with the shorthand method" do
+			HtmlMeta.define do
+				og :title, '21purple'
+			end
+			HtmlMeta.og(:title).should eq('21purple')
+		end
+
+	end
+
+	context "Rendering" do
+
+		before do
+			HtmlMeta.reset
+		end
+
+		it "should render the proper html for the meta tags set" do
+		
+			HtmlMeta.define do
+				meta :title, '21purple'
+			end
+
+			HtmlMeta.define do
+				meta :title, 'Blog', prepend: true
+				meta :keywords, 'rails development'
+				og :title, '21purple'
+			end
+
+			HtmlMeta.render.should eq("<title>Blog | 21purple</title>\n<meta name=\"keywords\" content=\"rails development\"/>\n<meta property=\"og:title\" content=\"21purple\"/>\n")
+		end
+
+	end
+
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'html_meta'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: html_meta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70367021747960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70367021747960
+- !ruby/object:Gem::Dependency
+  name: arbre
+  requirement: &70367021747540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70367021747540
+description: Helps with constructing meta tags
+email:
+- tom@21purple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- html_meta.gemspec
+- lib/html_meta.rb
+- lib/html_meta/configuration.rb
+- lib/html_meta/data.rb
+- lib/html_meta/version.rb
+- spec/html_meta_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Helps with constructing meta tags
+test_files:
+- spec/html_meta_spec.rb
+- spec/spec_helper.rb