tag_formatter 0.0.1

data/HISTORY.md

@@ -0,0 +1,13 @@
+HISTORY
+=======
+
+0.0.1.pre-1 - January 21, 2012
+------------------------------
+* Initial prerelease commit
+
+0.0.1 - May 01, 2012
+--------------------
+* Full release commit
+* Removed pre identifier
+* Updated readme with new instructions
+* Updating gemspec with proper repo url and description

data/README.md

@@ -0,0 +1,57 @@
+Tag Formatter
+=============
+**Tag Formatter** (for a lack of a better name) is—of course—a basic templating system that takes in text input with "tags", and replaces those tags with text as defined by the programmer.
+
+Installation
+------------
+
+### Installation via `gem`
+    gem install tag_formatter
+
+### Installation via GIT
+    git clone git://github.com/mseymour/tag_formatter.git
+    cd tag_formatter/
+    gem build tag_formatter.gemspec
+    gem install tag_formatter-0.0.1.pre1.gem
+
+Usage
+-----
+Valid option symbols for configuring an instance of `TagFormatter`:
+
+* `tags` (`Hash`)
+* `tag_start` (`String`)
+* `tag_end` (`String`)
+* `inline_comment_delimiter` (`String`)
+* `block_comment_start` (`String`)
+* `block_comment_end` (`String`)
+
+Formatting a block of text using the default options:
+
+    text = <<-HEREDOC
+    Hello, I am {firstname} {lastname}.
+    I like {something}. #Something can be anything.
+    /*I do not know about you,
+    but block comments are pretty rad.*/
+    HEREDOC
+    
+    tf = TagFormatter.new text, tags: {firstname: "Mark", lastname: "Seymour", something: "listening to music"}
+    
+    puts tf.parse! #=> Hello, I am Mark Seymour.\nI like listening to music.
+
+Formatting a block of text using user-supplied options:
+
+    tf = TagFormatter.new "I like to %verb% it, %verb% it!", tags: {verb: "move"}, tag_start: '%', tag_end: '%'
+    puts tf.parse! #=> I like to move it, move it!
+
+Contribute
+----------
+Any and all issues should be reported via the Issues tab in Github.
+
+Fixes, additions, patches, etc. are greatly welcome.
+
+Author information
+------------------
+* Mark Seymour ('Azure')
+* Email: mark.seymour.ns@gmail.com
+* WWW: http://lain.rustedlogic.net/
+* IRC: #shakesoda @ irc.freenode.net

data/lib/tag_formatter/formatter.rb

@@ -0,0 +1,81 @@
+# coding: utf-8
+# @author Mark Seymour
+
+module TagFormatter
+  class Formatter
+    @@_known_params = [:tags, :tag_start, :tag_end, :inline_comment_delimiter, :block_comment_start, :block_comment_end]
+    attr_accessor :input
+    attr_accessor *@@_known_params
+    
+    # Creates a new instance of TagFormatter::Formatter.
+    #
+    # @param [String, File] input The input; may be either a String or a File.
+    # @param [Hash] params The options for parsing the String or File.
+    # @option params [Hash] :tags ({}) Key+value pairs representing the tags and values associated with the tags.
+    # @option params [String] :tag_start ({) The character(s) denoting the beginning of a tag.
+    # @option params [String] :tag_end (}) The character(s) denoting the end of a tag.
+    # @option params [String] :inline_comment_delimiter (#) The character(s) denoting an inline comment
+    # @option params [String] :block_comment_start (/*) The character(s) denoting the beginning of a comment block.
+    # @option params [String] :block_comment_end (*/) The character(s) denoting the end of a comment block.
+    # @raise [TypeError] #input must be a String or File.
+    def initialize input, params={}
+      params = {
+        tags: {},
+        tag_start: '{',
+        tag_end: '}',
+        inline_comment_delimiter: '#',
+        block_comment_start: '/*',
+        block_comment_end: '*/'
+      }.merge(params)
+      
+      # Assigning input to @input if string
+      @input = if input.is_a? String
+        input
+      # Reading input and assigning the resultant string to @input
+      elsif input.is_a? File
+        input.read.to_s
+      # Raise a TypeError.
+      else
+        raise TypeError, "input was an `#{input.class.name}', expected a `String' or `File'."
+      end
+      # Assign the param values to the (known) attributes.
+      @@_known_params.each do |attr|
+        self.send(attr.to_s + "=", params[attr])
+      end
+    end
+
+    # Parses the supplied input and returned a decommented, tagified, cleaned string.
+    #
+    # @return A string with the parsed input.
+    def parse!
+      tagify(decommentify(@input)).strip
+    end
+
+    private
+
+    # Decommentifies the supplied input.
+    #
+    # @param [String] input The string to decommentify.
+    # @return A string with the decommented input.
+    def decommentify input
+      output = input.dup
+      # Remove multiline comments:
+      output.gsub!(/(#{Regexp.quote @block_comment_start}.+?#{Regexp.quote @block_comment_end})/m, "")
+      # Remove inline comments:
+      output.gsub!(/(#{Regexp.quote @inline_comment_delimiter}.+$)/,"")
+      return output.lines.map(&:strip).join($/)
+    end
+
+    # Tagifies the supplied input.
+    #
+    # @param [String] input The string to tagify.
+    # @raise [StandardError] @tags must not be empty.
+    # @return A string with the tags replaced with their values.
+    def tagify input
+      output = input.dup
+      raise StandardError, "@tags is empty!" if @tags.empty? #improve on this
+      @tags.each {|key,value| output.gsub!(tag_start.to_s+key.to_s+tag_end.to_s, value.to_s)}
+      return output
+    end
+  end
+end

data/lib/tag_formatter/version.rb

@@ -0,0 +1,30 @@
+module TagFormatter
+  class Version
+
+    # @return [Integer]
+    def self.major
+      0
+    end
+
+    # @return [Integer]
+    def self.minor
+      0
+    end
+
+    # @return [Integer]
+    def self.patch
+      1
+    end
+
+    # @return [String, NilClass]
+    def self.pre
+      nil
+    end
+
+    # @return [String]
+    def self.to_s
+      [major, minor, patch, pre].compact.join('.')
+    end
+
+  end
+end

data/lib/tag_formatter.rb

@@ -0,0 +1,22 @@
+require 'tag_formatter/formatter.rb'
+
+module TagFormatter
+  class << self
+    # Alias for TagFormatter::Formatter.new
+    #
+    # @return [TagFormatter::Formatter]
+    def new(input, params={})
+      TagFormatter::Formatter.new(input, params)
+    end
+
+    # Delegate to TagFormatter::Formatter
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/test/test_tag_formatter.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'tag_formatter'
+
+class TagFormatterTest < Test::Unit::TestCase
+  
+  def test_default_parser
+    input = "\n\n{test} #inline comment\n{test}/*multiline\nblockcomment*/{test2}{test3}\n{test4}+{unknowntest}"
+    expected_output = "Hello, World!\nHello, World!Test 2...Test 3\nTest 4+{unknowntest}"
+    my_tags = {
+      test: "Hello, World!",
+      test2: "Test 2...",
+      test3: "Test 3",
+      test4: "Test 4",
+      unusedtest5: "Unused test 5"
+    }
+    options = {
+      tags: my_tags
+    }
+    assert_equal expected_output,
+      TagFormatter.new(input, options).parse!
+  end
+
+  def test_parser_with_options
+    input = "\n\n%test% \/\/inline comment\n%test%(=multiline\nblockcomment=)%test2%%test3%\n%test4%+%unknowntest%"
+    expected_output = "Hello, World!\nHello, World!Test 2...Test 3\nTest 4+%unknowntest%"
+    my_tags = {
+      test: "Hello, World!",
+      test2: "Test 2...",
+      test3: "Test 3",
+      test4: "Test 4",
+      unusedtest5: "Unused test 5"
+    }
+    options = {
+      tags: my_tags,
+      tag_start: '%',
+      tag_end: '%',
+      inline_comment_delimiter: '//',
+      block_comment_start: '(=',
+      block_comment_end: '=)'
+    }
+    assert_equal expected_output,
+      TagFormatter.new(input, options).parse!
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: tag_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Seymour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies: []
+description: A simple file/string templating system.
+email:
+- mark.seymour.ns@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- HISTORY.md
+- lib/tag_formatter/formatter.rb
+- lib/tag_formatter/version.rb
+- lib/tag_formatter.rb
+- test/test_tag_formatter.rb
+homepage: https://github.com/mseymour/tag_formatter
+licenses:
+- MIT
+post_install_message: Happy tagging!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Tag Formatter
+test_files: []