taggart 0.0.4 → 0.0.5

data/README.markdown

@@ -0,0 +1,195 @@
+Taggart allows you to tag Strings with HTML
+===========================================
+How and what
+------------
+```ruby
+  "Hello World!".h1
+```
+
+returns
+
+```html
+  <h1>Hello World!</h1>
+```
+
+or try (in bad typographical taste) 
+
+```ruby
+  "Important!".em.strong
+```
+
+to get 
+
+```html
+  <em><strong>Important!</em></strong>
+```
+
+or do some more nesting 
+
+```ruby
+  ("Label".td + "Value".td).tr.table
+```
+
+to render a small table
+
+```html
+  <table><tr><td>Label</td><td>Value</td></tr></table>
+```
+
+Add HTML attributes as Ruby parameters.
+
+```ruby
+  "hello".span(class: 'stuff', id: 'thing')
+```
+
+to get a nice HTML string like this
+
+```html
+  <span class="stuff" id="thing">hello</span>
+```
+
+You can also use arrays, how about this table?
+
+```ruby
+  (%w(r1c1 r1c2 r1c3).td.tr + %w(r2c1 r2c2 r2c3).td.tr).table
+```
+
+will produce this HTML (author's line breaks and indentation)
+
+```html
+  <table>
+    <tr>
+      <td>r1c1</td>
+      <td>r1c2</td>
+      <td>r1c3</td>
+    </tr>
+    <tr>
+      <td>r2c1</td>
+      <td>r2c2</td>
+      <td>r2c3</td>
+    </tr>
+  </table>
+```
+
+Naturally we can do single tags too.
+
+```ruby
+  "Gimme a".br
+```
+
+will return.
+
+```html
+  Gimme a<br />
+```
+
+Also try some of the 'cleverness', for example calling `.script` on a `.js` file will yield a different result compared to running it on a Javascript. 
+Like this:
+
+```ruby
+  "alert('This string will pop up an alert!')".script
+```
+gives you
+```html
+  <script id="pants_pants" type="text/javascript">alert('This string will pop up an alert!')</script>"
+```
+
+whereas this string
+
+```ruby
+  "/script/awesomes_script.js".script
+```
+
+gives you this
+
+```html
+  "<script type="text/javascript" src="/script/awesomes_script.js"></script>"
+```
+
+Naturally this also works with attributes.
+
+See the `spec/taggart_spec.rb` for more examples (until I have time to do a bigger-better-faster-example file).
+
+Background:
+-----------
+I have a lot of Ruby code that marks some String in an HTML tag, usually with a 
+specific CSS class. Or perhaps a link or so.
+It's not particularly nice to write `"<strong>#{my_variable}</strong>"`. The more 
+complex the Ruby code is, the worse it is to have `"`, `#`, `{` or `}` soiling the code.
+I was looking at the code and I thought, wouldn't it be nice if I could just tell that piece
+of String that it's supposed to be a `<span>` or some other tag. One could simply 
+write `my_variable.strong` to get the job done. **Taggart** was born.
+
+The Idea
+--------
+The idea was to simplify the code and make it easier and faster for me to add arbitrary HTML into my
+non-HTML code. I wanted to stop breaking my fingers trying to get the _quote-string-hash-curlybrackets-code-curlybrackets-morestrings-quote_
+right on my keyboard.
+It was _never_ intended to be a full-fledged HTML page renderer. If you want to use it for that, I'd love to see the result, though.
+
+
+Installation:
+-------------
+Install the gem:
+
+```
+  gem install taggart
+```
+  
+Then load Taggart with:
+
+```
+  require 'taggart'
+```
+
+Taggart is now active, which means you can play around.
+
+
+History
+-------
+- Added <script>-tag. You can now add ``"my-script.js".script`` and ``"alert('Hello World!')".script`.
+- Added several tags (still not a complete list, tweet or send a pull request for more tags.)
+- Removed several 'if DEBUG' lines
+- Removed examples and most comments from taggart.rb file
+- Converted the README to markdown for a bit better formatting fun.
+- Added `.href` and `.img` feature.
+- 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.
+
+
+Future???
+---------
+With your blessing. Like Ozzy said; _"The crazier you get, the crazier Ozzy gets!"_, or something.
+
+* Potential validations, could check file, size, etc
+* Switch between HTML and XHTML.
+* Full fledged examples.
+* Please send suggestions.
+
+
+Issues:
+-------
+- `"hello".sub('world', 'world')` returns `<sub  world  world>hello</sub>`. Not really perfect.
+- Please help me test it out.
+
+
+Feedback welcome!!
+
+Author: Jocke Selin <jocke@selincite.com> @jockeselin
+
+Date: 2012-03-09
+
+Version: 0.0.5 Build 010
+
+Github: <https://github.com/jocke/taggart>

data/lib/taggart.rb

@@ -1,74 +1,22 @@
-# 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)
-# - Potential validations - could check file, size, etc
-# 
-# History
-#  - Added href and img feature.
-#  - 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!!
-# 
+# Taggart allows you to tag Strings with HTML
+# ===========================================
 #    Author: Jocke Selin <jocke@selincite.com>
-#      Date: 2012-03-05
-#   Version: 0.0.4 Build 009
+#            @jockeselin
+#      Date: 2012-03-09
+#   Version: 0.0.5 Build 010
 #    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
@@ -76,14 +24,11 @@ module Taggart
 
     # 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
@@ -105,12 +50,23 @@ module Taggart
       "<img#{option_str} />"
     end
     
+    
+    def script(*args)
+      if self[-3, 3] == '.js' # We've got a Jabbarscript file (could/should cater for all script types. VBScript, heheeh!)
+        option_str = parse_options(args << {type: "text/javascript", src: self})
+        "<script#{option_str}></script>"
+      else
+        option_str = parse_options(args << {type: "text/javascript"})
+        "<script#{option_str}>#{self}</script>"
+      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|
@@ -122,7 +78,7 @@ module Taggart
             output << "#{key.to_s}=\"#{value}\""
           end
         else
-          puts "Argument of type #{argument.class.name} is not implemented"
+          raise "Argument of type #{argument.class.name} is not implemented"
         end
       end
       return "" if output.empty?
@@ -132,7 +88,6 @@ module Taggart
     
     # 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} />"
@@ -151,10 +106,12 @@ module Taggart
     end
   
   
-    standard_tags   = %w{ h1 h2 h3 h4 h5 h6 strong p a 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']]
+    standard_tags = %w{ h1 h2 h3 h4 h5 h6 a title html head table thead tfoot button fieldset form label 
+                        select legend option textarea body blockquote q tbody th td tfoot style div
+                        span abbr acronym address dd dl dt li ol caption ul em strong p tt pre sup del
+                        small cite code } # This is not a complete list - please tweet or pull req.
+    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)
@@ -163,7 +120,7 @@ module Taggart
       end
     end
     
-    %w{br hr}.each do |tag|
+    %w{br hr input link meta}.each do |tag|
       self.single_attribute_tag(tag)
     end
     
@@ -174,16 +131,15 @@ module Taggart
     
     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
@@ -196,11 +152,8 @@ module Taggart
       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)
+    
+    # Defines tags for the Array class.
     %w{td li}.each do |tag|
       self.array_attribute_tag(tag)
     end
@@ -227,4 +180,4 @@ end
 
 class Array
   include Taggart::Array
-end
+end

data/spec/taggart_spec.rb

@@ -175,6 +175,20 @@ describe Taggart::Array, "#array_attribute_tag" do
       end
     end
     
+    context "script tags" do
+      it "should render a script tag with src-attribute when the string ends in .js" do
+        "/jabbarscript/waste_cpu_cycles.js".script.should == "<script type=\"text/javascript\" src=\"/jabbarscript/waste_cpu_cycles.js\"></script>"
+      end
+      
+      it "should render a script tag with src-attribute and an id-attribute  when the string ends in .js" do
+        "/jabbarscript/fancy_pants.js".script(id: 'fancy_fancy').should == "<script id=\"fancy_fancy\" type=\"text/javascript\" src=\"/jabbarscript/fancy_pants.js\"></script>"
+      end
+      
+      it "should render a script tag with when the string does not ends in .js" do
+        "document.write(\"Hello World!\");".script(id: 'pants_pants').should == "<script id=\"pants_pants\" type=\"text/javascript\">document.write(\"Hello World!\");</script>"
+      end
+    end
+    
     context "combinations" do
       it "renders a clickable image" do
         "/path/to/img.png".img({class: :thumbnail}).a(href: '/hello/world.html').should == "<a href=\"/hello/world.html\"><img class=\"thumbnail\" src=\"/path/to/img.png\" /></a>"

data/taggart.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name        = "taggart"
-  s.version     = "0.0.4"
-  s.date        = "2012-03-05"
-  s.summary     = "Simple HTML tag by String extension."
+  s.version     = "0.0.5"
+  s.date        = "2012-03-09"
+  s.summary     = "Tag Strings with HTML; 'Hello World'.h1"
   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.files       = ["lib/taggart.rb", "Rakefile", "taggart.gemspec", "README.markdown"]
   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!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taggart
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70119724335800 !ruby/object:Gem::Requirement
+  requirement: &70190373434460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70119724335800
+  version_requirements: *70190373434460
 description: Tag your strings in a simple and easy way by running "Hello World".h1
   for example.
 email:
@@ -33,7 +33,7 @@ files:
 - lib/taggart.rb
 - Rakefile
 - taggart.gemspec
-- README
+- README.markdown
 - spec/taggart_spec.rb
 homepage: https://github.com/jocke/taggart
 licenses: []
@@ -59,7 +59,7 @@ rubyforge_project:
 rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: Simple HTML tag by String extension.
+summary: Tag Strings with HTML; 'Hello World'.h1
 test_files:
 - spec/taggart_spec.rb
 has_rdoc: 

data/README

@@ -1,57 +0,0 @@
-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)
- - Potential validations - could check file, size, etc
-
-History
- - Added href and img feature.
- - 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.4 Build 009
-   Github: https://github.com/jocke/taggart