taggart 0.0.6 → 0.0.7

data/README.markdown

@@ -126,6 +126,21 @@ Naturally they all also work with attributes.
 See the `spec/taggart_spec.rb` for more examples (until I have time to do a bigger-better-faster-example file).
 
 
+Informational:
+--------------
+If you get lost in Taggart or if you're just curious about what Taggart
+can do, I've created a few informational things for you. In the IRB
+console you can now run:
+
+```ruby
+   Taggart.help  # For generic information about Taggart (or Taggart.info)
+   Taggart.tags  # For a list of different tags and other curious
+things.
+```
+
+There's also some constants that you can access, such as `VERSION`, and
+tags, see the aforementioned `Taggart.help` and `Taggart.tags`.
+
 Background:
 -----------
 I have a lot of Ruby code that marks some String in an HTML tag, usually with a 
@@ -164,6 +179,10 @@ Taggart is now active, which means you can play around.
 History
 -------
 
+- Added informational Taggart.help and Taggart.tags.
+- Moved several tags into arrays for easier reference.
+- Created Taggart::VERSION and Taggart::BUILD for reference and DRYness.
+- Changed some of the labels in the test file.
 - Added `<table>` to Array that creates single or multi row tables.
 - Added `<ol>` and `<ul>` tags to the Array so you can now generate lists in one fast action.
 - Added `<script>`-tag. You can now add `"my-script.js".script` and `"alert('Hello World!')".script`.
@@ -207,8 +226,8 @@ Feedback welcome!!
 
 Author: Jocke Selin <jocke@selincite.com> @jockeselin
 
-Date: 2012-03-14
+Date: 2012-05-09
 
-Version: 0.0.6 Build 011
+Version: 0.0.7 Build 012
 
 Github: <https://github.com/jocke/taggart>

data/lib/taggart.rb

@@ -2,15 +2,153 @@
 # ===========================================
 #    Author: Jocke Selin <jocke@selincite.com>
 #            @jockeselin
-#      Date: 2012-03-14
-#   Version: 0.0.6 Build 011
+#      Date: 2012-05-09
+#   Version: 0.0.7 Build 012
 #    Github: https://github.com/jocke/taggart
  
 module Taggart
+
+  VERSION = '0.0.7'
+  BUILD = '012'
+
+  def self.help
+    puts "Welcome to Taggart (#{VERSION} Build #{BUILD})"
+    puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+    puts "Taggart is a library that allows you to easily"
+    puts "turn a string (or array) into an HTML tag or more tags"
+    puts "by simply calling the 'tag-method' on the string."
+    puts "Examples:"
+    puts "  'Hello World!'.h1  -->  <h1>Hello World!</h1>'"
+    puts "  'Important'.span(class: :important) " 
+    puts "                     --> <span class=\"important\">Important</span>"
+    puts "  'Break'.br         --> Break<br />"
+    puts "  %w(a b c).ul       --> <ul><li>a</li><li>b</li><li>c</li></ul>"
+    puts "\nFor a list of tags run Taggart.tags"
+    puts "Other informational stuff:"
+    puts "  - Version:  Taggart::VERSION"
+    puts "  - Build:    Taggart::BUILD"
+    puts "\nPlease note that Taggart is considered 'experimental' (but"
+    puts "fairly stable) and in early development, so please help make"
+    puts "Taggart better; send suggestions, bug fixes, improvements, etc"
+    puts "to the author, and do fork the code and send pull requests if"
+    puts "you've made an improvement - Thanks!"
+    puts "\n\nAuthor: Jocke Selin <jocke@selincite.com> @jockeselin"
+  end
+
+  def self.info
+    self.help
+  end
+
+  def self.tags
+    puts "Taggart's tags:"
+    puts "~~~~~~~~~~~~~~~"
+    puts "This is a list of the tags that Taggart can generate, for your pleasure"
+    puts "\nStandard tags:"
+    puts "--------------"
+    puts "These tags have a start- and end-tag and the take any number of"
+    puts "attributes in the form of a hash with key-value pairs."
+    output_tags(Taggart::String::STANDARD_TAGS)
+    puts "\nSpecial tags"
+    puts "------------"
+    puts "These tags behave like the Standard tags, but there's already a"
+    puts "method defined for the String instance so these tags have to be"
+    puts "treated in a slightly special way, in that the tag that's ouputted"
+    puts "doesn't have the same method name. I.e to output <tr> you call '._tr'"
+    puts "however, you don't really need to bother with knowing this as Taggart"
+    puts "does some magic behind the scenes to determine wheter you are asking"
+    puts "for a Taggart tag or the original method."
+    Taggart::String::SPECIAL_TAGS.sort.each do |tag_pair|
+      puts "  Tag: #{('<' + tag_pair[0] + '>').ljust(6)}  Method: .#{tag_pair[1]}"
+    end
+    puts "\nSingle Tags"
+    puts "-------------"
+    puts "Single tags are tags that do not an end tag, <br> is one such tag"
+    puts "In Taggart Single Tags behave just like Standard tags; you can"
+    puts "add attributes to them."
+    output_tags(Taggart::String::SINGLE_TAGS)
+    puts "\nSmart Tags"
+    puts "------------"
+    puts "These tags go to the gifted class and can speak elvish. They know what"
+    puts "you want from them. They don't behave like the other ones in the sense"
+    puts "that you have a string that you want to turn into something, not just a"
+    puts "simple tag."
+    puts "Here's the pupils of the gifted class:"
+    puts ".img    - Turns a URL to an image into an img tag."
+    puts ".href   - turns a URL into the href-portion of an A-tag, takes the link"
+    puts "          content as a parameter, and also other attributes as 2nd argument."
+    puts ".script - Either turns a URL to a script file into a <script src..></script>"
+    puts "          tag, or embeds a script source in <script></script> tags. Smart!"
+    puts "\nArray tags"
+    puts "----------"
+    puts "The Array Tags generate HTML tags out of a list of strings in an array."
+    puts "For example, you can turn an array into list items by callin the .li-"
+    puts "method on the array."
+    puts "You can also pass attributes to the tags as with the Standard Tags"
+    puts "The tags are:"
+    puts "   td        li"
+    puts "\nSmart Array Tags"
+    puts "-----------------"
+    puts "The Smart Array Tags are all a bit more smartly dressed than the"
+    puts "proletarian Array Tags. Namely, they figure out what you do."
+    puts "Here's the honour roll"
+    puts "Method   Tag   Special powers"
+    puts ".ol    - Turns an array into an ordered list, wrapping the array elements"
+    puts "         in <li> tags so you get your awesome list in one go"
+    puts ".ul    - The almost identical twin of .ol"
+    puts ".tr    - Like .ol and .li, but wraps the array in <tr> tags with every"
+    puts "         element wrapped in a <td> tag."
+    puts ".table - The smartest of them all. Creates a complete table from a, one or"
+    puts "         two dimensional Array. Each array is wrapped in the <tr> tag with"
+    puts "         every element in the Array in <td> tags. It's all finished off"
+    puts "         with a decoration of <table>."
+    puts "\nTag arrays and methods"
+    puts "----------------------"
+    puts "You can access the following arrays and methods containing the tags."
+    puts "Tags           Array                            Method"
+    puts "Standard tags  Taggart::String::STANDARD_TAGS   Taggart.standard_tags"
+    puts "Special tags   Taggart::String::SPECIAL_TAGS    Taggart.special_tags"
+    puts "Single tags    Taggart::String::SINGLE_TAGS     Taggart.single_tags"
+  end
+
+
+  def self.standard_tags
+    Taggart::String::STANDARD_TAGS
+  end
+
+  def self.special_tags
+    Taggart::String::SPECIAL_TAGS
+  end
+
+  def self.single_tags
+    Taggart::String::SINGLE_TAGS 
+  end
+
+
+  private
+
+  def self.output_tags(tags)
+    columns = 4
+    padding = 14
+    
+    print "  "
+    tags.sort.each_with_index do |tag, index| 
+      index += 1
+      print "#{tag.ljust(padding)}" 
+      print "\n  " if ((index % columns) == 0) and (index > 0)
+    end
+    puts "\n\n"
+  end
+
   module String
   
     DEBUG = false
-    
+    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
+    SINGLE_TAGS = %w{br hr input link meta}
 
     # Redefining <tr> to work with both translate-tr and tag-tr
     def dual_tr(*args)
@@ -60,11 +198,11 @@ module Taggart
         "<script#{option_str}>#{self}</script>"
       end
     end
-    
-  
+
+
     private 
-    
-  
+
+
     # Parses the options for the tags
     def parse_options(args)
       return "" if args.nil?
@@ -106,13 +244,7 @@ module Taggart
     end
   
   
-    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
-    tags.each do |tag|
+    TAGS.each do |tag|
       if tag.class.name == 'String'
         self.attribute_tag(tag)
       else
@@ -120,7 +252,8 @@ module Taggart
       end
     end
     
-    %w{br hr input link meta}.each do |tag|
+
+    SINGLE_TAGS.each do |tag|
       self.single_attribute_tag(tag)
     end
     

data/spec/taggart_spec.rb

@@ -1,7 +1,31 @@
-# Run with rake or  with: rspec -fd -c taggart_spec.rb 
+# Run with rake or with: rspec -fd -c taggart_spec.rb 
 
 require 'taggart.rb'
 
+describe Taggart, "informational" do
+
+  it "should respond to help" do
+    Taggart.should respond_to(:help)
+  end
+
+  it "should respond to tags" do
+    Taggart.should respond_to(:tags)
+  end
+
+  it "returns an array when asked for standard tags" do
+    Taggart.standard_tags.should be_an(Array)
+  end
+
+  it "returns an array when asked for special tags" do
+    Taggart.special_tags.should be_an(Array)
+  end
+
+  it "returns an array when asked for single tags" do
+    Taggart.single_tags.should be_an(Array)
+  end
+
+end
+
 describe Taggart::String, "#attribute_tags" do
   
   it "returns a standard tag without any attributes" do
@@ -35,23 +59,23 @@ end
 
 describe Taggart::Array, "#array_attribute_tag" do
   
-  it "returns a the array elements as tags without any attributes" do
+  it "returns the elements in the array wrapped with li-tags when calling .li method" 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
+  it "returns the elements with an attribute wrapped in td when calling the td method on the array" 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
+  it "returns the array elements wrapped in td tags and two attributes when called with two attribute parameters" 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
+  it "returns the elements in the array wrapped with td when calling the td method" 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
+  it "renders a nested set of td-tags when the td method is called no a nested array" 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
   
@@ -139,7 +163,7 @@ describe Taggart::Array, "#array_attribute_tag" do
   end
   
   
-  describe Taggart::String, "Special tags" do
+  describe Taggart::String, "Smart tags" do
     context "href tags" do
       it "renders a basic <a href>-tag." do 
         "/hello/world.html".href("Hello World").should == "<a href=\"/hello/world.html\">Hello World</a>"
@@ -243,4 +267,4 @@ describe Taggart::Array, "#array_attribute_tag" do
       end
     end
   end
-end
+end

data/taggart.gemspec

@@ -1,15 +1,18 @@
+require 'date'
+require './lib/taggart.rb'
+
 Gem::Specification.new do |s|
-  s.name        = "taggart"
-  s.version     = "0.0.6"
-  s.date        = "2012-03-14"
-  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.name          = "taggart"
+  s.version       = Taggart::VERSION
+  s.date          =  Date.today.strftime('%Y-%m-%d') 
+  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.markdown"]
-  s.test_files  = ["spec/taggart_spec.rb"]
+  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!"
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taggart
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70344203614200 !ruby/object:Gem::Requirement
+  requirement: &70207965639160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70344203614200
+  version_requirements: *70207965639160
 description: Tag your strings in a simple and easy way by running "Hello World".h1
   for example.
 email: