taggart 0.0.3

data/README

@@ -0,0 +1,57 @@
+Taggart is a proof-of-concept to "decorate" strings with HTML tags.
+===================================================================
+Background:
+It's not particularly nice to write "<strong>#{my_variable}</strong>" when
+One could simply write my_variable.strong. The more complex the Ruby code
+is, the nicer it is to not have ", #, { or } soiling the code.
+
+
+Playtime:
+  Install the gem:
+    gem install taggart
+  Then load Taggart with:
+    require 'taggart'
+  Taggart is now active, which means you can play around.
+  Try: 
+    "Hello World".h1
+  Or (typographically bad taste): 
+    "Important".em.strong
+  Or do some proper nesting:
+    ("Label".td + "Value".td)._tr.table
+  Add attributes
+    "hello".span(class: 'stuff', id: 'thing')
+  How about a table using arrays?:
+     (%w(r1c1 r1c2 r1c3).td.tr + %w(r2c1 r2c2 r2c3).td.tr).table
+  We can also do single tags.
+     "Gimme a".br
+
+Issues:
+ - "hello"._sub('world', 'world') returns 
+      "<sub  world  world>hello</sub>"
+     Not really perfect
+
+Future??? (with your blessing)
+ - Extending to other HTML elements. "/images/company_logo.jpg".img (could check file, size, etc.)
+                                     "/pages/about_us.html".href
+
+History
+ - Created Gem
+ - Pushed code to Git.
+ - Created test Gem.
+ - Added files to create Gem and reorganised the file structure.
+ - Made dual_sub pass all the tests, and added the examples from .tr (translate) Ruby docs to the test.
+ - More work on the "dynamic namespace clash resolver", in other words, tr and sub work in both classic and Taggart way.
+ - Initial version of "dynamic namespace clash resolver" to fix issues with .tr
+ - Added basic RSpec test.
+ - Added namespacing for Strings and Arrays
+ - Implemented arrays; ["Label", "Value"].td.tr.table and ["First", "Second", "Third"].li.ol
+ - Tidied up things a bit.
+ - Added a version of attributes ("Red".span(class: 'red'))
+ - First version. Basic tags.
+
+Feedback welcome!!
+
+   Author: Jocke Selin <jocke@selincite.com>
+     Date: 2012-02-16
+  Version: 0.0.3 Build 008
+   Github: https://github.com/jocke/taggart

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/taggart.rb

@@ -0,0 +1,217 @@
+# Taggart is a proof-of-concept to "decorate" strings with HTML tags.
+# ===================================================================
+# Background:
+# It's not particularly nice to write "<strong>#{my_variable}</strong>" when
+# One could simply write my_variable.strong. The more complex the Ruby code
+# is, the nicer it is to not have ", #, { or } soiling the code.
+# 
+# 
+# Playtime:
+#   Install the gem:
+#     gem install taggart
+#   Then load Taggart with:
+#     require 'taggart'
+#   Taggart is now active, which means you can play around.
+#   Try: 
+#     "Hello World".h1
+#   Or (typographically bad taste): 
+#     "Important".em.strong
+#   Or do some proper nesting:
+#     ("Label".td + "Value".td)._tr.table
+#   Add attributes
+#     "hello".span(class: 'stuff', id: 'thing')
+#   How about a table using arrays?:
+#      (%w(r1c1 r1c2 r1c3).td.tr + %w(r2c1 r2c2 r2c3).td.tr).table
+#   We can also do single tags.
+#      "Gimme a".br
+# 
+# Issues:
+#  - "hello"._sub('world', 'world') returns 
+#       "<sub  world  world>hello</sub>"
+#      Not really perfect
+# 
+# Future??? (with your blessing)
+#  - Extending to other HTML elements. "/images/company_logo.jpg".img (could check file, size, etc.)
+#                                      "/pages/about_us.html".href
+# 
+# History
+#  - Created Gem
+#  - Pushed code to Git.
+#  - Created test Gem.
+#  - Added files to create Gem and reorganised the file structure.
+#  - Made dual_sub pass all the tests, and added the examples from .tr (translate) Ruby docs to the test.
+#  - More work on the "dynamic namespace clash resolver", in other words, tr and sub work in both classic and Taggart way.
+#  - Initial version of "dynamic namespace clash resolver" to fix issues with .tr
+#  - Added basic RSpec test.
+#  - Added namespacing for Strings and Arrays
+#  - Implemented arrays; ["Label", "Value"].td.tr.table and ["First", "Second", "Third"].li.ol
+#  - Tidied up things a bit.
+#  - Added a version of attributes ("Red".span(class: 'red'))
+#  - First version. Basic tags.
+# 
+# Feedback welcome!!
+# 
+#    Author: Jocke Selin <jocke@selincite.com>
+#      Date: 2012-02-16
+#   Version: 0.0.3 Build 008s
+#    Github: https://github.com/jocke/taggart
+ 
+module Taggart
+  module String
+  
+    DEBUG = false
+
+    # Redefining <tr> to work with both translate-tr and tag-tr
+    def dual_tr(*args)
+      puts "Args size: #{args.size}" if DEBUG
+      if ((args.size == 2) && (args[0].is_a? String) && (args[1].is_a? String))
+        puts "Send '#{args[0]}', '#{args[1]}' to translate-tr" if DEBUG
+        self.translate(args[0], args[1])
+      else
+        puts "Send to tag-tr" if DEBUG
+        self._tr(args.first)
+      end
+    end
+
+
+    # Redefining <sub> to work with both substitute-sub and tag-sub
+    def dual_sub(*args, &block)
+      puts "Args size: #{args.size}" if DEBUG
+      if (args[0].is_a? Hash)
+        puts "Send to tag-sub" if DEBUG
+        self._sub(args.first)
+      elsif args.empty?
+        self._sub
+      else
+        puts "Send '#{args[0]}', '#{args[1]}' to substitute-sub" if DEBUG
+        if block_given?
+          self.substitute(args[0]) { |*args| block.call(*args) }
+        else
+          self.substitute(args[0], args[1])
+        end
+      end
+    end
+    
+  
+    private 
+  
+    # Parses the options for the tags
+    def parse_options(args)
+      # puts "parse_options: args #{args.inspect})" if DEBUG
+      return "" if args.nil?
+      output = []
+      args.each do |argument|
+        if argument.nil? # Do nothing
+        elsif argument.is_a? String
+          output << " " + argument
+        elsif argument.is_a? Hash
+          argument.each do |key, value|
+            output << "#{key.to_s}=\"#{value}\""
+          end
+        else
+          puts "Argument of type #{argument.class.name} is not implemented"
+        end
+      end
+      return "" if output.empty?
+      " " + output.join(' ')
+    end
+    
+    
+    # Defines a single tag, such as <br /> or <hr />
+    def self.single_attribute_tag(tag)
+      puts "Defining single-tag '#{tag}'"  if DEBUG
+      define_method(tag) do |*args|
+        option_str = parse_options(args)
+        "#{self}<#{tag}#{option_str} />"
+      end
+    end
+  
+  
+    # Defines a standard tag that can have attributes
+    def self.attribute_tag(tag, tag_name = nil)
+      tag_name ||= tag
+      puts "Defining tag '#{(tag + "',").ljust(12)} with method name: '#{tag_name}'" if DEBUG
+      define_method(tag_name) do |*args|
+        option_str = parse_options(args)
+        "<#{tag}#{option_str}>#{self}</#{tag}>"
+      end
+    end
+  
+  
+    standard_tags   = %w{ h1 h2 h3 h4 h5 h6 strong p em title table thead tbody th td tfoot div span abbr acronym address dd dl dt li ol ul tt pre sup }
+    special_tags    = [['tr', '_tr'], ['sub', '_sub']]
+    tags = standard_tags + special_tags
+    puts "Tag definitions: #{tags.inspect}" if DEBUG
+    tags.each do |tag|
+      if tag.class.name == 'String'
+        self.attribute_tag(tag)
+      else
+        self.attribute_tag(tag[0], tag[1])
+      end
+    end
+    
+    %w{br hr}.each do |tag|
+      self.single_attribute_tag(tag)
+    end
+    
+  end # End String module
+  
+  
+  module Array
+    
+    DEBUG = false
+    
+    # Defines a standard tag that can create attributes
+    def self.array_attribute_tag(tag, tag_name = nil)
+      tag_name ||= tag
+      puts "Defining array tag '#{(tag + "',").ljust(12)} with method name: '#{tag_name}'" if DEBUG
+      define_method(tag_name) do |*args|
+        args = args.first if args # Only using the first of the array
+        puts "Array:#{tag_name} (with args #{args.inspect})" if DEBUG
+        result = []
+        self.each do |object|
+          puts "Object: #{object.inspect} (Type: #{object.class.name})" if DEBUG
+          if object.is_a? String
+            result << object.send(tag_name.to_sym, args)
+          elsif object.is_a? Symbol
+            result << object.to_s.send(tag_name.to_sym, args)
+          elsif object.is_a? Array # I don't know why you'd want to do this, but here it is.
+            result << (object.send(tag_name.to_sym, args)).send(tag_name.to_sym, args)
+          end
+        end
+        result.join
+      end
+    end
+    
+    # Test examples:  
+    #   [:aaa, 'hellloooo'].td
+    #   [:aaaa, [:bbb, :ccc, :ddd], :fff, :ggg].td
+    #   ["Joe", "Marcus", "Chris", "Jim", "Aaron"] 
+    #   %w{One Two Three Four}.td(class: :numbers)
+    %w{td li}.each do |tag|
+      self.array_attribute_tag(tag)
+    end
+    
+    
+  end # End Array module
+end
+
+  
+class String
+  alias_method :translate, :tr
+  alias_method :substitute, :sub
+  include Taggart::String
+
+  def tr(*args) 
+    dual_tr(*args)
+  end
+  
+  def sub(*args, &block) 
+    dual_sub(*args, &block)
+  end
+end
+
+
+class Array
+  include Taggart::Array
+end

data/spec/taggart_spec.rb

@@ -0,0 +1,139 @@
+# Run with: rspec -fd -c taggart_spec.rb 
+require 'taggart.rb'
+
+describe Taggart::String, "#attribute_tags" do
+  
+  it "returns a standard tag without any attributes" do
+    "hello world".h1.should == '<h1>hello world</h1>'
+  end
+  
+  it "returns a standard tag with one attribute" do
+    "hello world".h1(class: :header).should == "<h1 class=\"header\">hello world</h1>"
+  end
+  
+  it "returns a standard tag with two attribute" do
+    "hello world".h1(class: :header, id: :title).should == "<h1 class=\"header\" id=\"title\">hello world</h1>"
+  end
+end
+
+
+describe Taggart::String, "#single_attribute_tag" do
+  
+  it "returns a single tag without any attributes" do
+    "hello world".br.should == 'hello world<br />'
+  end
+  
+  it "returns a standard tag with one attribute" do
+    "hello world".br(class: :header).should == "hello world<br class=\"header\" />"
+  end
+  
+  it "returns a standard tag with two attribute" do
+    "hello world".br(class: :header, id: :title).should == "hello world<br class=\"header\" id=\"title\" />"
+  end
+end
+
+describe Taggart::Array, "#array_attribute_tag" do
+  
+  it "returns a the array elements as tags without any attributes" do
+    %w{one two three}.li.should == "<li>one</li><li>two</li><li>three</li>"
+  end
+  
+  it "returns a the array elements as tags with one attribute" do
+    %w{one two three}.td(class: :programmers).should == "<td class=\"programmers\">one</td><td class=\"programmers\">two</td><td class=\"programmers\">three</td>"
+  end
+  
+  it "returns a the array elements as tags with two attribute" do
+    %w{one two three}.td(class: :programmers, id: :unpossible).should == "<td class=\"programmers\" id=\"unpossible\">one</td><td class=\"programmers\" id=\"unpossible\">two</td><td class=\"programmers\" id=\"unpossible\">three</td>"
+  end
+  
+  it "returns a the array symbol elements as tags without attributes" do
+    [:one, :two, :three].td.should == "<td>one</td><td>two</td><td>three</td>"
+  end
+  
+  it "returns a the nested array elements as tags without attributes" do
+    [:one, [:nine, :eight, :seven], :two, :three].td.should == "<td>one</td><td><td>nine</td><td>eight</td><td>seven</td></td><td>two</td><td>three</td>"
+  end
+  
+  
+  describe Taggart::String, "#dual_tr" do
+    it "executes translate-tr when two parameters of string is passed in" do
+      "Jolly Roger".tr('J','G').tr('R', 'B').should == "Golly Boger"
+    end
+    
+    it "executes tag-tr when no parameters are passed in" do
+      "Jolly Roger".tr.should == "<tr>Jolly Roger</tr>"
+    end
+    
+    it "executes tag-tr when hash parameters are passed in" do
+      "Jolly Roger".tr(id: :jolly_roger).should == "<tr id=\"jolly_roger\">Jolly Roger</tr>"
+    end
+    
+    it "executes translate-tr when the first example from the Ruby documentation is executed" do
+      "hello".tr('el', 'ip').should == "hippo"
+    end
+    
+    it "executes translate-tr when the second example from the Ruby documentation is executed" do
+      "hello".tr('aeiou', '*').should == "h*ll*"
+    end
+    
+    it "executes translate-tr when the third example from the Ruby documentation is executed" do
+      "hello".tr('a-y', 'b-z').should == "ifmmp"
+    end
+    
+    it "executes translate-tr when the fourth example from the Ruby documentation is executed" do
+      "hello".tr('^aeiou', '*').should == "*e**o"
+    end
+  end
+  
+  
+  describe Taggart::String, "#dual_sub" do
+    it "executes substitute-sub when the first example from the documentation is passed in" do
+      "hello".sub(/[aeiou]/, '*').should == "h*llo"
+    end
+    
+    it "executes substitute-sub when the 2nd example from the documentation is passed in" do
+      "hello".sub(/([aeiou])/, '<\1>').should == "h<e>llo"
+    end
+    
+    it "executes substitute-sub when a simple block is provided" do
+      "hello".sub(/./) {|s| "-#{s}-" }.should == "-h-ello"
+    end
+    
+    it "executes substitute-sub when the third example, with a block, from the documentation is passed in" do
+      "hello".sub(/./) {|s| s.ord.to_s + ' ' }.should == "104 ello"
+    end
+    
+    it "executes substitute-sub when the fourth example, with a regexp, from the documentation is passed in" do
+      'Is SHELL your preferred shell?'.sub(/[[:upper:]]{2,}/, ENV).should == "Is /bin/bash your preferred shell?"
+    end
+    
+    it "executes substitute-sub when the fifth example, with a regexp, from the documentation is passed in" do
+      "hello".sub(/(?<foo>[aeiou])/, '*\k<foo>*').should == "h*e*llo"
+    end
+    
+    it "executes tag-sub when no parameters are passed in" do
+      "You're just a substitute".sub.should == "<sub>You're just a substitute</sub>"
+    end
+
+    it "executes tag-sub when a hash of attribute-values are passed in" do
+      "You're just a substitute".sub(id: :thingy).should == "<sub id=\"thingy\">You're just a substitute</sub>"
+    end
+    
+    it "executes tag-sub when a hash of two attribute-values are passed in" do
+      "You're just a substitute".sub(id: :thingy, class: :lowlowlow).should == "<sub id=\"thingy\" class=\"lowlowlow\">You're just a substitute</sub>"
+    end
+  end
+  
+  
+  describe Taggart::String, "More complex use" do
+    it "builds a small table HTML" do
+      row_1 = %w(r1c1 r1c2 r1c3)
+      row_2 = %w(r2c1 r2c2 r2c3)
+      (row_1.td.tr + row_2.td.tr).table.should == "<table><tr><td>r1c1</td><td>r1c2</td><td>r1c3</td></tr><tr><td>r2c1</td><td>r2c2</td><td>r2c3</td></tr></table>" 
+    end
+    
+    it "builds an ordered list HTML" do
+      %w(First Second Third Fourth Fifth Sizt Seventh).li.ol.should == "<ol><li>First</li><li>Second</li><li>Third</li><li>Fourth</li><li>Fifth</li><li>Sizt</li><li>Seventh</li></ol>" 
+    end
+  end
+end

data/taggart.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = "taggart"
+  s.version     = "0.0.3"
+  s.date        = "2012-02-16"
+  s.summary     = "Simple HTML tag by String extension."
+  s.description = "Tag your strings in a simple and easy way by running \"Hello World\".h1 for example."
+  s.authors     = ["Jocke Selin"]
+  s.email       = ["jocke@selincite.com"]
+  s.homepage    = "https://github.com/jocke/taggart"
+  s.require_paths = ["lib"]
+  s.files       = ["lib/taggart.rb", "Rakefile", "taggart.gemspec", "README"]
+  s.test_files  = ["spec/taggart_spec.rb"]
+  s.add_development_dependency "rspec"
+  s.post_install_message = "Thanks for showing interest in Taggart! Please provide feedback to jocke@selincite.com!"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: taggart
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jocke Selin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70231726621400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231726621400
+description: Tag your strings in a simple and easy way by running "Hello World".h1
+  for example.
+email:
+- jocke@selincite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/taggart.rb
+- Rakefile
+- taggart.gemspec
+- README
+- spec/taggart_spec.rb
+homepage: https://github.com/jocke/taggart
+licenses: []
+post_install_message: Thanks for showing interest in Taggart! Please provide feedback
+  to jocke@selincite.com!
+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.16
+signing_key: 
+specification_version: 3
+summary: Simple HTML tag by String extension.
+test_files:
+- spec/taggart_spec.rb
+has_rdoc: