axtags 0.1.0

data/Gemfile

@@ -0,0 +1,17 @@
+# AWEXOME LABS AX TAGS
+# Gemfile
+
+source "http://rubygems.org"
+
+# Runtime dependencies:
+
+# The gem builds a different API to Radius:
+gem "radius", "~> 0.7.3"
+
+# Development dependencies:
+group :development do
+  gem "bundler", "~> 1.2.1"
+  gem "jeweler", "~> 1.8.4"
+  gem "rdoc", "~> 3.12"
+  gem "rspec", ">= 2.11.0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    radius (0.7.3)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.1)
+  jeweler (~> 1.8.4)
+  radius (~> 0.7.3)
+  rdoc (~> 3.12)
+  rspec (>= 2.11.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Awexome Labs, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,9 @@
+
+== Ax Tags
+
+Flexible, extensible custom tag and template-parsing framework built around the
+{Radius templating framework}[https://github.com/jlong/radius].
+
+
+
+Copyright (C) 2013 Awexome Labs, LLC

data/Rakefile

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "rake"
+
+require "jeweler"
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "axtags"
+  gem.homepage = "http://github.com/mccolin/axtags"
+  gem.license = "MIT"
+  gem.summary = %Q{Flexible, extensible custom tag and template framework with safe execution and HTML-like style}
+  gem.description = %Q{Flexible, extensible custom tag and template framework with safe execution and HTML-like style. Wraps a cleaner API around the Radius templating framework.}
+  gem.email = "engineering@awexomelabs.com"
+  gem.authors = ["Awexome Labs"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+# require "rake/testtask"
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << "lib" << "test"
+#   test.pattern = "test/**/test_*.rb"
+#   test.verbose = true
+# end
+
+# require "rcov/rcovtask"
+# Rcov::RcovTask.new do |test|
+#   test.libs << "test"
+#   test.pattern = "test/**/test_*.rb"
+#   test.verbose = true
+#   test.rcov_opts << "--exclude "gems/*""
+# end
+
+# task :default => :test
+
+require "rdoc/task"
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "AxTags #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("LICENSE*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/axtags.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "axtags"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Awexome Labs"]
+  s.date = "2013-01-16"
+  s.description = "Flexible, extensible custom tag and template framework with safe execution and HTML-like style. Wraps a cleaner API around the Radius templating framework."
+  s.email = "engineering@awexomelabs.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "axtags.gemspec",
+    "lib/axtags.rb",
+    "lib/axtags/ax_context.rb",
+    "lib/axtags/ax_parser.rb",
+    "lib/axtags/tag_library.rb",
+    "spec/axtags_spec.rb"
+  ]
+  s.homepage = "http://github.com/mccolin/axtags"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Flexible, extensible custom tag and template framework with safe execution and HTML-like style"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<radius>, ["~> 0.7.3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rspec>, [">= 2.11.0"])
+    else
+      s.add_dependency(%q<radius>, ["~> 0.7.3"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rspec>, [">= 2.11.0"])
+    end
+  else
+    s.add_dependency(%q<radius>, ["~> 0.7.3"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rspec>, [">= 2.11.0"])
+  end
+end
+

data/lib/axtags.rb

@@ -0,0 +1,19 @@
+# AWEXOME LABS
+# AxTags
+#
+# A flexible, extensible custom tag and template framework with safe execution of user
+# submitting templating.
+
+require "radius"
+
+require "axtags/ax_context"
+require "axtags/ax_parser"
+require "axtags/tag_library"
+
+module AxTags
+
+  def self.version
+    Gem.loaded_specs["axtags"].version.to_s
+  end
+
+end # AxTags

data/lib/axtags/ax_context.rb

@@ -0,0 +1,24 @@
+# AX TAGS
+# Flexible, extensible custom tag and template-parsing framework built
+# around the Radius templating framework.
+#
+# AxContext - A context contains a dictionary of tags that can be used
+#  in template parsing. Context objects are passed to parsers alongside
+#  templates to enable parsing.
+#
+
+module AxTags
+  class AxContext < Radius::Context
+
+    # A catch-call for handling an unsupported tag included in a template:
+    def tag_missing(tag, attr, &block)
+      %{<span class="error parse-error ui-state-error">Tag "#{tag}" is unknown. Attributes provided: #{attr.inspect}</span>}
+    end
+
+    # A method in-reserve for generic error-reporting to the end-user:
+    def tag_error(tag, error_text)
+      %{<span class="error parse-error ui-state-error">Error in rendering tag \"#{tag}\"; #{error_text}</span>}
+    end
+
+  end
+end

data/lib/axtags/ax_parser.rb

@@ -0,0 +1,13 @@
+# AX TAGS
+# Flexible, extensible custom tag and template-parsing framework built
+# around the Radius templating framework.
+#
+# AxParser - Does the heavy lifting of sifting tags out of template
+#  documents and leverages the contents of a context object to build an
+#  output result document
+#
+
+module AxTags
+  class AxParser < Radius::Parser
+  end # AxParser
+end # AxTags

data/lib/axtags/tag_library.rb

@@ -0,0 +1,68 @@
+# AX TAGS
+# Flexible, extensible custom tag and template-parsing framework built
+# around the Radius templating framework.
+#
+# TagLibrary - Composed of an AxContext and an AxParser, each library
+#  class provides the direct interface for defining tags in a given context,
+#  passing local variables to the parser, and managing the parsing process. Best
+#  use calls for the application to create any number of descendant classes of
+#  this class in which they define tags and call parsing actions upon. For
+#  example:
+#
+#     class MyTagLibrary < AxTags::TagLibrary
+#       tag "myanchor" do |t|
+#         "<a class='awesome_anchor' href='http://awesometown.com/'>I am Awesome!</a>"
+#       end
+#     end
+#
+#     MyTagLibrary.parse("Here is an awesome link: <ax:myanchor/>")
+#     => "Here is an awesome link: <a class='awesome_anchor' href='http://awesometown.com/'>I am awesome!</a>"
+#
+#  Because tags are defined at a class level, it's not generally recommended to
+#  use the parent class as your API to tag definition and parsing, though it is
+#  possible to access the context and parsers directly and define tags and call
+#  parsing on them. That would look some like this:
+#
+#    AxTags::TagLibrary.context.with do |c|
+#      c.define_tag "myanchor" do |t|
+#        "<a class='awesome_anchor' href='http://awesometown.com/'>I am Awesome!</a>"
+#      end
+#    end
+#    AxTags::TagLibrary.parse("Here is an awesome link: <ax:myanchor/>")
+#    => "Here is an awesome link: <a class='awesome_anchor' href='http://awesometown.com/'>I am awesome!</a>"
+#
+# This introduces the complication of having only one global tag library in which
+# all tags in your system would exist, which is why the first example is the preferred
+# method for optimal extensibility and namespacing.
+#
+
+module AxTags
+  class TagLibrary
+
+    def self.context
+      @@context ||= AxContext.new
+    end
+
+    def self.parser
+      @@parser ||= AxParser.new(context, :tag_prefix=>"ax")
+    end
+
+    def self.parse(document, options={})
+      if locals = options.delete(:locals)
+        locals.each {|arg, value| context.globals.send("#{arg}=", value) }
+      end
+      parser.parse(document)
+    end
+
+    def self.build_tags(&block)
+      yield context
+    end
+
+    def self.tag(name, options={}, &block)
+      build_tags do |c|
+        c.define_tag(name, options, &block)
+      end
+    end
+
+  end
+end

data/spec/axtags_spec.rb

@@ -0,0 +1,59 @@
+# AWEXOME LABS
+# AxTags Test Suite
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :development)
+
+require "axtags"
+require "rspec"
+require "rspec/autorun"
+
+root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+RSpec.configure do |config|
+end
+
+
+# Create a testable tag library:
+class TestLibrary < AxTags::TagLibrary
+  tag "anchor" do |t|
+    %{<a class="awesome_anchor" href="http://awesometown.com/">I am Awesome!</a>}
+  end
+end
+
+# Test AxTags parsing and management:
+describe "axtags" do
+
+  before(:each) do
+  end
+
+  after(:each) do
+  end
+
+
+  it "defines simple tags" do
+  end
+
+  it "defines content tags" do
+  end
+
+  it "defines nested tags" do
+  end
+
+  it "properly renders simple tag content" do
+    tmpl = %{<ax:anchor/>}
+    TestLibrary.parse(tmpl) == %{<a class="awesome_anchor" href="http://awesometown.com/">I am Awesome!</a>}
+  end
+
+  it "properly renders content tags" do
+  end
+
+  it "properly renders nested tag content" do
+  end
+
+
+end # axtags

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: axtags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Awexome Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: radius
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: Flexible, extensible custom tag and template framework with safe execution
+  and HTML-like style. Wraps a cleaner API around the Radius templating framework.
+email: engineering@awexomelabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- axtags.gemspec
+- lib/axtags.rb
+- lib/axtags/ax_context.rb
+- lib/axtags/ax_parser.rb
+- lib/axtags/tag_library.rb
+- spec/axtags_spec.rb
+homepage: http://github.com/mccolin/axtags
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2603607807429614524
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Flexible, extensible custom tag and template framework with safe execution
+  and HTML-like style
+test_files: []