deas-erbtags 0.1.0 → 0.2.0

data/README.md

@@ -24,26 +24,61 @@ class MyDeasServer
 end
 ```
 
-## Tags
+## Methods
 
-All helpers are based off of the basic `tag` helper:
+All helper methods are based off of the basic `tag` method.  Tag calls should be invoked with `<%= ... -%>`:
+
+```erb
+<%= tag(:br) -%>                             # => <br />
+<%= tag(:h1, 'shizam', :title => "boom") -%> # => <h1 title="boom">shizam</h1>
+```
+
+**Note**: all tag methods take an option hash of html attributes (like above).  This use-case is assumed in the examples below.
+
+### `capture_tag`
+
+The `capture_tag` method is used to create tags with nested erb markup.  Like the `tag` method, it creates other tags with a similar API.  Unlike the `tag` method, it takes a block that contains nested markup and does not take content as an arg.  Capture tags should be invoked with the `<% ... %>`:
+
+```erb
+<% content_tag(:div, :id => 'outer') do %>
+  <%= tag(:div, 'inner') -%>
+<% end %>
+  # => <div id="outer">\n  <div>inner</div>\n</div>\n
+```
+
+**Note**: the convention is that if a tag method is called with a block, `capture_tag` will be used to generate the tag and it should be invoked with `<% ... %>`.
+
+### `link_to`
 
 ```ruby
-tag(:br)                             # => <br />
-tag(:h1, 'shizam', :title => "boom") # => <h1 title="boom">shizam</h1>
+link_to "http://google.com"
+  # => <a href="http://google.com">http://google.com</a>
+
+link_to "google", "http://google.com"
+  # => <a href="http://google.com">google</a>
+
+link_to("http://google.com"){ tag(:span, 'google') }
+  # => <a href="http://google.com">\n<span>google</span>\n</a>\n
 ```
 
-### LinkTo
+### `mail_to`
 
-TODO
+```ruby
+mail_to "me@domain.com"
+  # => <a href="mailto:me@domain.com">me@domain.com</a>
 
-### MailTo
+mail_to "me@domain.com", :at => "_at_", :dot => "_dot_"
+  # => <a href="mailto:me@domain.com">me_at_domain_dot_com</a>
 
-TODO
+mail_to "me@domain.com", :disabled => true
+  # => me@domain.com
+```
 
-### ImageTag
+### `image_tag`
 
-TODO
+```ruby
+image_tag '/logo.jpg'  #  => <img src="/logo.jpg" />
+```
 
 ### FormTags
 

data/lib/deas-erbtags/capture_tag.rb

@@ -0,0 +1,37 @@
+require 'deas-erbtags/tag'
+
+module Deas::ErbTags
+  module CaptureTag
+
+    def self.included(receiver)
+      receiver.class_eval{ include Tag, Method }
+    end
+
+    module Method
+
+      def capture_tag(name, *args)
+        opts = args.last.kind_of?(::Hash) ? args.pop : {}
+        outvar = self.sinatra_call.settings.erb[:outvar]
+        captured_content = begin
+          orig_outvar = instance_variable_get(outvar)
+          instance_variable_set(outvar, "\n")
+
+          result = yield if block_given?
+
+          if instance_variable_get(outvar) == "\n"
+            "\n#{result}"
+          else
+            instance_variable_get(outvar)
+          end
+        ensure
+          instance_variable_set(outvar, orig_outvar)
+        end
+
+        tag_markup = tag(name, "#{captured_content}\n", opts)
+        instance_variable_get(outvar) << "#{tag_markup}\n"
+      end
+
+    end
+
+  end
+end

data/lib/deas-erbtags/image_tag.rb

@@ -0,0 +1,22 @@
+require 'deas-erbtags/tag'
+
+module Deas::ErbTags
+  module ImageTag
+
+    def self.included(receiver)
+      receiver.class_eval{ include Tag, Method }
+    end
+
+    module Method
+
+      def image_tag(source, *args)
+        opts = args.last.kind_of?(::Hash) ? args.pop : {}
+        opts.update(:src => source.to_s)
+
+        tag(:img, opts)
+      end
+
+    end
+
+  end
+end

data/lib/deas-erbtags/link_to.rb

@@ -0,0 +1,31 @@
+require 'deas-erbtags/tag'
+require 'deas-erbtags/capture_tag'
+
+module Deas::ErbTags
+  module LinkTo
+
+    def self.included(receiver)
+      receiver.class_eval{ include Tag, CaptureTag, Method }
+    end
+
+    module Method
+
+      def link_to(*args, &block)
+        opts, href, content = [
+          args.last.kind_of?(::Hash) ? args.pop : {},
+          args.pop,
+          args.last
+        ]
+        opts.update(:href => href.to_s) if !href.nil?
+
+        if block_given?
+          capture_tag(:a, opts, &block)
+        else
+          tag(:a, content || href, opts)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/deas-erbtags/mail_to.rb

@@ -0,0 +1,30 @@
+require 'deas-erbtags/tag'
+require 'deas-erbtags/link_to'
+
+module Deas::ErbTags
+  module MailTo
+
+    def self.included(receiver)
+      receiver.class_eval{ include Tag, LinkTo, Method }
+    end
+
+    module Method
+
+      def mail_to(*args)
+        opts, email, content = [
+          args.last.kind_of?(::Hash) ? args.pop : {},
+          args.pop,
+          args.last
+        ]
+        display = (content || email).dup
+        display.gsub!(/@/, opts.delete(:at)) if opts.has_key?(:at)
+        display.gsub!(/\./, opts.delete(:dot)) if opts.has_key?(:dot)
+
+        return display if opts.delete(:disabled)
+        link_to(display, "mailto: #{email}", opts)
+      end
+
+    end
+
+  end
+end

data/lib/deas-erbtags/tag.rb

@@ -10,7 +10,7 @@ module Deas::ErbTags
       ]
       attrs = U.html_attrs(opts)
 
-      "<#{name}#{attrs}#{content ? ">#{content}</#{name}" : ' /'}>"
+      "<#{name}#{attrs}#{content.nil? ? ' /' : ">#{content}</#{name}"}>"
     end
 
   end

data/lib/deas-erbtags/utils.rb

@@ -3,6 +3,16 @@ module Deas::ErbTags
 
   module Utils
 
+    ESCAPE_ATTRS = {
+      "&" => "&",
+      "<" => "&lt;",
+      '"' => "&quot;"
+    }
+    ESCAPE_ATTRS_PATTERN = Regexp.union(*ESCAPE_ATTRS.keys)
+    def self.escape_attr_value(value)
+      value.to_s.gsub(ESCAPE_ATTRS_PATTERN){|c| ESCAPE_ATTRS[c] }
+    end
+
     def self.html_attrs(attrs="", ns=nil)
       return attrs.to_s if !attrs.kind_of?(::Hash)
 
@@ -19,16 +29,6 @@ module Deas::ErbTags
       end.join
     end
 
-    ESCAPE_ATTRS = {
-      "&" => "&amp;",
-      "<" => "&lt;",
-      '"' => "&quot;"
-    }
-    ESCAPE_ATTRS_PATTERN = Regexp.union(*ESCAPE_ATTRS.keys)
-    def self.escape_attr_value(value)
-      value.to_s.gsub(ESCAPE_ATTRS_PATTERN){|c| ESCAPE_ATTRS[c] }
-    end
-
   end
 
   # alias for brevity

data/lib/deas-erbtags/version.rb

@@ -1,4 +1,4 @@
 module Deas; end
 module Deas::ErbTags
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/deas-erbtags.rb

@@ -2,6 +2,10 @@ require 'deas-erbtags/version'
 require 'deas-erbtags/utils'
 
 require 'deas-erbtags/tag'
+require 'deas-erbtags/capture_tag'
+require 'deas-erbtags/link_to'
+require 'deas-erbtags/mail_to'
+require 'deas-erbtags/image_tag'
 
 module Deas; end
 module Deas::ErbTags
@@ -10,7 +14,7 @@ module Deas::ErbTags
 
   def self.included(receiver)
     receiver.class_eval do
-      include Tag
+      include Tag, CaptureTag, LinkTo, MailTo, ImageTag
     end
   end
 

data/test/support/factory.rb

@@ -1,3 +1,4 @@
+require 'ostruct'
 require 'deas-erbtags/utils'
 require 'deas-erbtags/tag'
 
@@ -6,7 +7,22 @@ module Factory
   def self.template(*included_modules)
     template_class = Class.new do
       include *included_modules
+
+      attr_reader :_out_buf
+      def initialize
+        @_out_buf = ""
+      end
+
+      # he expected API for the Deas template scope to access erb settings
+      def sinatra_call
+        OpenStruct.new({
+          :settings => OpenStruct.new({
+            :erb => { :outvar => '@_out_buf' }
+          })
+        })
+      end
     end
+
     template_class.new
   end
 

data/test/unit/capture_tag_tests.rb

@@ -0,0 +1,49 @@
+require 'assert'
+require 'deas-erbtags/tag'
+require 'deas-erbtags/capture_tag'
+
+module Deas::ErbTags::CaptureTag
+
+  class BaseTests < Assert::Context
+    desc "the `CaptureTag` module"
+    setup do
+      @template = Factory.template(Deas::ErbTags::CaptureTag)
+    end
+    subject{ @template }
+
+    should have_imeth :capture_tag
+
+    should "include the `Tag` module" do
+      assert_includes Deas::ErbTags::Tag, subject.class.included_modules
+    end
+
+    should "create content by capturing content from a given block" do
+      div_div = subject.tag(:div, "\n#{subject.tag(:div, "\ninner\n")}\n\n", {
+        :id => 'outer'
+      }) + "\n"
+      buf_content_div = subject.capture_tag(:div, :id => 'outer') do
+        subject.capture_tag(:div){ subject._out_buf << 'inner' }
+      end
+
+      assert_equal div_div, buf_content_div
+    end
+
+    should "create content by returning content from a given block" do
+      div_div = subject.tag(:div, "\n#{subject.tag(:div, "\ninner\n")}\n\n", {
+        :id => 'outer'
+      }) + "\n"
+      returned_content_div = subject.capture_tag(:div, :id => 'outer') do
+        subject.capture_tag(:div){ 'inner' }
+      end
+
+      assert_equal div_div, returned_content_div
+    end
+
+    should "create empty tags if no block given" do
+      empty_div = subject.tag(:div, "\n\n", :id => 'outer') + "\n"
+      assert_equal empty_div, subject.capture_tag(:div, :id => 'outer')
+    end
+
+  end
+
+end

data/test/unit/deas-erbtags_tests.rb

@@ -10,11 +10,11 @@ module Deas::ErbTags
     end
     subject{ @template }
 
-    should have_imeths :tag
+    should have_imeths :tag, :link_to, :mail_to, :image_tag
 
     should "include all of the individual modules" do
       exp_modules = [
-        Tag
+        Tag, CaptureTag, LinkTo, MailTo, ImageTag
       ]
 
       exp_modules.each do |m|

data/test/unit/image_tag_tests.rb

@@ -0,0 +1,35 @@
+require 'assert'
+require 'deas-erbtags/tag'
+require 'deas-erbtags/image_tag'
+
+module Deas::ErbTags::ImageTag
+
+  class BaseTests < Assert::Context
+    desc "the `ImageTag` module"
+    setup do
+      @template = Factory.template(Deas::ErbTags::ImageTag)
+    end
+    subject{ @template }
+
+    should have_imeth :image_tag
+
+    should "include the `Tag` module" do
+      assert_includes Deas::ErbTags::Tag, subject.class.included_modules
+    end
+
+    should "create an img tag with the given src" do
+      img = subject.tag(:img, {:src => '/logo.jpg'})
+      assert_equal img, subject.image_tag('/logo.jpg')
+    end
+
+    should "create an img tag with attrs" do
+      img = subject.tag(:img, {
+        :src => '/logo.jpg',
+        :id => 'image'
+      })
+      assert_equal img, subject.image_tag('/logo.jpg', :id => 'image')
+    end
+
+  end
+
+end

data/test/unit/link_to_tests.rb

@@ -0,0 +1,60 @@
+require 'assert'
+require 'deas-erbtags/tag'
+require 'deas-erbtags/capture_tag'
+require 'deas-erbtags/link_to'
+
+module Deas::ErbTags::LinkTo
+
+  class BaseTests < Assert::Context
+    desc "the `LinkTo` module"
+    setup do
+      @template = Factory.template(Deas::ErbTags::LinkTo)
+    end
+    subject{ @template }
+
+    should have_imeth :link_to
+
+    should "include the `Tag` module" do
+      assert_includes Deas::ErbTags::Tag, subject.class.included_modules
+    end
+
+    should "include the `CaptureTag` module" do
+      assert_includes Deas::ErbTags::CaptureTag, subject.class.included_modules
+    end
+
+    should "create an anchor tag with no content or href" do
+      no_href_content = subject.tag(:a)
+      assert_equal no_href_content, subject.link_to
+    end
+
+    should "create an anchor tag with just an href" do
+      href = subject.tag(:a, 'www.google.com', {:href => 'www.google.com'})
+      assert_equal href, subject.link_to('www.google.com')
+    end
+
+    should "create an anchor tag with an href and content" do
+      href_content = subject.tag(:a, 'google', {:href => 'www.google.com'})
+      assert_equal href_content, subject.link_to('google', 'www.google.com')
+    end
+
+    should "create an anchor tag with an href, content, and attrs" do
+      href_content_opts = subject.tag(:a, 'google', {
+        :href => 'www.google.com',
+        :id => 'google_link'
+      })
+      link_to = subject.link_to('google', 'www.google.com', {
+        :id => 'google_link'
+      })
+      assert_equal href_content_opts, link_to
+    end
+
+    should "create an anchor tag with an href and captured content" do
+      span = subject.tag(:span, 'google')
+      exp = subject.tag(:a, "\n#{span}\n", {:href => 'www.google.com'}) + "\n"
+
+      assert_equal exp, subject.link_to('www.google.com'){ span }
+    end
+
+  end
+
+end

data/test/unit/mail_to_tests.rb

@@ -0,0 +1,51 @@
+require 'assert'
+require 'deas-erbtags/tag'
+require 'deas-erbtags/link_to'
+require 'deas-erbtags/mail_to'
+
+module Deas::ErbTags::MailTo
+
+  class BaseTests < Assert::Context
+    desc "the `MailTo` module"
+    setup do
+      @link_content = "my email"
+      @email = "me@domain.com"
+      @template = Factory.template(Deas::ErbTags::MailTo)
+    end
+    subject{ @template }
+
+    should have_imeth :mail_to
+
+    should "include the `Tag` module" do
+      assert_includes Deas::ErbTags::Tag, subject.class.included_modules
+    end
+
+    should "include the `LinkTo` module" do
+      assert_includes Deas::ErbTags::LinkTo, subject.class.included_modules
+    end
+
+    should "render with just an email address" do
+      link_tag = subject.link_to(@email, "mailto: #{@email}")
+      assert_equal link_tag, subject.mail_to(@email)
+    end
+
+    should "render with custom display value" do
+      link_tag = subject.link_to(@link_content, "mailto: #{@email}")
+      assert_equal link_tag, subject.mail_to(@link_content, @email)
+    end
+
+    should "render obfuscating the email address displayed" do
+      obfus = "me_at_domain_dot_com"
+      link_tag = subject.link_to(obfus, "mailto: #{@email}")
+      mailto = subject.mail_to(@email, :at => "_at_", :dot => "_dot_")
+
+      assert_equal link_tag, mailto
+    end
+
+    should "render with link disabled" do
+      assert_equal @email, subject.mail_to(@email, :disabled => true)
+    end
+
+  end
+
+end

data/test/unit/tag_tests.rb

@@ -7,8 +7,8 @@ module Deas::ErbTags::Tag
     desc "the basic tag method"
     setup do
       @opts = { :class => 'big', :id => '1234' }
-      @content = "Loud Noises"
       @opts_attrs = Factory.html_attrs(@opts)
+      @content = "Loud Noises"
       @template = Factory.template(Deas::ErbTags::Tag)
     end
     subject{ @template }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deas-erbtags
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-16 00:00:00 Z
+date: 2013-05-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -50,13 +50,21 @@ files:
 - Rakefile
 - deas-tags.gemspec
 - lib/deas-erbtags.rb
+- lib/deas-erbtags/capture_tag.rb
+- lib/deas-erbtags/image_tag.rb
+- lib/deas-erbtags/link_to.rb
+- lib/deas-erbtags/mail_to.rb
 - lib/deas-erbtags/tag.rb
 - lib/deas-erbtags/utils.rb
 - lib/deas-erbtags/version.rb
 - log/.gitkeep
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/capture_tag_tests.rb
 - test/unit/deas-erbtags_tests.rb
+- test/unit/image_tag_tests.rb
+- test/unit/link_to_tests.rb
+- test/unit/mail_to_tests.rb
 - test/unit/tag_tests.rb
 - test/unit/utils_tests.rb
 - tmp/.gitkeep
@@ -96,6 +104,10 @@ summary: Deas template helpers for creating HTML tags using Erb.
 test_files: 
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/capture_tag_tests.rb
 - test/unit/deas-erbtags_tests.rb
+- test/unit/image_tag_tests.rb
+- test/unit/link_to_tests.rb
+- test/unit/mail_to_tests.rb
 - test/unit/tag_tests.rb
 - test/unit/utils_tests.rb