tattoo 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 zbelzer
+
+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,41 @@
+## Tattoo
+
+A fun little gem for adding links to text based off of regular expressions and template URLs. It is important
+to note that I know very little about Tattoos and their terminology. I thought it would be a fun theme since
+you're simply adding some awesomness to regular old text.
+
+## Usage
+
+It is important to note that the Gun works both ways, you can get at the markings in a piece of text as well
+as produce a marked up version. This is why it's not a JQuery plugin.
+
+Create some "Ink" by supplying a name and a regexp. If you want it to go somewhere, give it a `:host` and `:url` as well:
+    tags = Tattoo::Ink.new(:tags, /([a-z]+)/i, :host => "example.com", :url => "/tags/:id")
+
+Create a gun and load up some Ink:
+    gun = Tattoo::Gun.new("Some #sweet tags", [tags])
+
+The gun can either produce a 'tattoo' for you:
+    gun.tattoo => "Some <a href="http://example.com/tags/sweet">#sweet</a> tags"
+
+Or you can look at what you would have written:
+    gun.look => {:tags => ["sweet"]}
+
+To specify a different prefix or token, supply them to the Ink (defaults to '#' and 'id' respectively):
+    Tattoo::Ink.new(:users, /([a-z]+)/i, :host => "example.com", :url => "/users/:user", :token => "user", :prefix => "@")
+
+The latter is useful in parsing things like tweets and saving the tags or whatnot to the database.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 Zachary Belzer (zbelzer). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tattoo"
+    gem.summary = %Q{Tattoo: Ink some mad links on everyday text}
+    gem.description = %Q{Tattoo is a (very) simple tool to decorate text as links based off of regular expressions and url templates.}
+    gem.email = "zbelzer@gmail.com"
+    gem.homepage = "http://github.com/zbelzer/tattoo"
+    gem.authors = ["zbelzer"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tattoo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/tattoo.rb

@@ -0,0 +1,6 @@
+$:.unshift File.dirname(__FILE__) + "/lib"
+
+require 'uri'
+
+require 'tattoo/gun'
+require 'tattoo/ink'

data/lib/tattoo/gun.rb

@@ -0,0 +1,27 @@
+module Tattoo
+  class Gun
+    def initialize(text, ink=[])
+      @text = text
+      @ink = ink.inject({}) {|coll, i| coll[i.name] = i; coll} 
+    end
+
+    def look
+      @ink.values.inject({}) do |markings, ink|
+        markings[ink.name] = ink.find_markings(@text)
+        markings
+      end
+    end
+
+    def tattoo
+      text = @text.dup
+
+      look.each do |name, markings|
+        markings.each do |marking|
+          text = @ink[name].mark(marking, text)
+        end
+      end
+
+      text
+    end
+  end
+end

data/lib/tattoo/ink.rb

@@ -0,0 +1,48 @@
+module Tattoo
+  DEFAULT_HOST = "www.example.com"
+  DEFAULT_MARK_IDENTIFIER = "#"
+  DEFAULT_TOKEN = "id"
+
+  class Ink
+    attr_reader :name
+
+    def initialize(name, regexp, opts={})
+      @name = name.to_sym
+      @regexp = regexp
+
+      options = opts.dup
+      @prefix = options.delete(:prefix) || DEFAULT_MARK_IDENTIFIER
+      @token = options.delete(:token) || DEFAULT_TOKEN
+      @host = options.delete(:host) || DEFAULT_HOST
+      @url = options.delete(:url).to_s
+      @attributes = options
+    end
+
+    def mark(marking, text)
+      text.gsub(/#{@prefix}#{marking}/, link_tag_for(marking))
+    end
+
+    def find_markings(text)
+      text.scan(/#{prefix_regexp}#{@regexp}/).flatten
+    end
+
+    private
+    def prefix_regexp
+      self.class.create_prefix_regexp(@prefix)
+    end
+
+    def link_tag_for(tag)
+      attributes = @attributes.map {|k, v| " #{k}=\"#{v}\""}
+      %{<a href="#{url_for(tag)}"#{attributes}>#{@prefix}#{tag}</a>}
+    end
+
+    def url_for(tag)
+      tag_url = @url.gsub(/:#{@token}/, tag)
+      URI.join("http://#{@host}", tag_url).to_s
+    end
+
+    def self.create_prefix_regexp(prefix)
+      /(?:\s?#{prefix})/
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tattoo'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/tattoo_spec.rb

@@ -0,0 +1,118 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+TAG_REGEXP = /([a-z][a-z\-_0-9]+)/i
+USER_REGEXP = /([a-z\-\._0-9]+)/i
+
+module Tattoo
+  describe Gun do
+    describe "single marking" do
+      before do
+        @tags = [Ink.new(:tags, TAG_REGEXP)]
+      end
+
+      it "should find leading tag" do
+        text = "#foo"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo"]
+      end
+
+      it "should find tag between words" do
+        text = "lorem #foo ipsum"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo"]
+      end
+
+      it "should find tag with dashes" do
+        text = "lorem #foo-bar ipsum"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo-bar"]
+      end
+
+      it "should find tag with underbar words" do
+        text = "lorem #foo_bar ipsum"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo_bar"]
+      end
+
+      it "should find tag with numbers" do
+        text = "lorem #foo23 ipsum"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo23"]
+      end
+
+      it "should not find tag starting with number" do
+        text = "lorem #23foo ipsum"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should be_empty
+      end
+
+      it "should find tags next to eachother" do
+        text = "#foo #bar"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo", "bar"]
+      end
+
+      it "should find multiple tags" do
+        text = "lorem #foo ipsum #bar"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo", "bar"]
+      end
+
+      it "should find tags next to non word characters" do
+        text = "[#bar]"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["bar"]
+      end
+    end
+
+    describe "prefixes" do
+      before do
+        @tags = [Ink.new(:tags, TAG_REGEXP), Ink.new(:users, USER_REGEXP, :prefix => "@")]
+      end
+
+      it "should find all markings" do
+        text = "#foo @bar"
+        gun = Gun.new(text, @tags)
+        gun.look[:tags].should == ["foo"]
+        gun.look[:users].should == ["bar"]
+      end
+    end
+
+    describe "tattoo" do
+      before do
+        @tags = Ink.new(:tags, TAG_REGEXP)
+      end
+
+      it "should use host" do
+        tags = Ink.new(:tags, TAG_REGEXP, :host => "example.com")
+
+        gun = Gun.new("#foo", [tags])
+        gun.tattoo.should == '<a href="http://example.com">#foo</a>'
+      end
+
+      it "should substitute :id with tag" do
+        tags = Ink.new(:tags, TAG_REGEXP, :host => "example.com", :url => "/tags/:id")
+        gun = Gun.new("#foo", [tags])
+        gun.tattoo.should == '<a href="http://example.com/tags/foo">#foo</a>'
+      end
+      
+      it "should substitute :tag with tag" do
+        tags = Ink.new(:tags, TAG_REGEXP, :host => "example.com", :url => "/tags/:tag", :token => "tag")
+        gun = Gun.new("#foo", [tags])
+        gun.tattoo.should == '<a href="http://example.com/tags/foo">#foo</a>'
+      end
+
+      it "should decorate as substitution" do
+        tags = Ink.new(:tags, TAG_REGEXP, :host => "example.com", :url => "/tags/:id")
+        gun = Gun.new("lorem #foo ipsum", [tags])
+        gun.tattoo.should == 'lorem <a href="http://example.com/tags/foo">#foo</a> ipsum'
+      end
+
+      it "should consider other options html attributes" do
+        tags = Ink.new(:tags, TAG_REGEXP, :host => "example.com", :name => "some name")
+        gun = Gun.new("#foo", [tags])
+        gun.tattoo.should == '<a href="http://example.com" name="some name">#foo</a>'
+      end
+    end
+  end
+end

data/tattoo.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tattoo}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["zbelzer"]
+  s.date = %q{2009-12-29}
+  s.description = %q{Tattoo is a (very) simple tool to decorate text as links based off of regular expressions and url templates.}
+  s.email = %q{zbelzer@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/tattoo.rb",
+     "lib/tattoo/gun.rb",
+     "lib/tattoo/ink.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/tattoo_spec.rb",
+     "tattoo.gemspec"
+  ]
+  s.homepage = %q{http://github.com/zbelzer/tattoo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Tattoo: Ink some mad links on everyday text}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/tattoo_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: tattoo
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- zbelzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-29 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Tattoo is a (very) simple tool to decorate text as links based off of regular expressions and url templates.
+email: zbelzer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/tattoo.rb
+- lib/tattoo/gun.rb
+- lib/tattoo/ink.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tattoo_spec.rb
+- tattoo.gemspec
+has_rdoc: true
+homepage: http://github.com/zbelzer/tattoo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Tattoo: Ink some mad links on everyday text"
+test_files: 
+- spec/spec_helper.rb
+- spec/tattoo_spec.rb