higml 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 1.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (>= 1.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Higginbotham
+
+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.markdown

@@ -0,0 +1,111 @@
+higml
+=====
+
+Overview
+--------
+
+Higml is a terse format for converting an input hash to an output hash.
+
+Example Higml and input:
+
+    # Higml
+    action:show
+      :pageName Search Results
+      :keywords= keywords
+
+      filter
+        :filter_terms= filter_terms
+    
+    # Input hash
+    {
+      :action => "show",
+      :filter => "any value"
+    }
+    
+This output is produced:
+
+    {
+      :pageName => "Search Results",
+      :keywords => ... #depends on value of "keywords" method in given context
+      :filter_terms => ... #depends on value of "filter_terms" method in given context
+    }
+
+To get a better understand of _what_ Higml does, go through spec/higml_spec.rb and the corresponding .higml files in spec/fixtures.
+
+Why would you want to use it? The original use case was generating a json object for analytics. The json object had different fields and values depending on what section of the site and individual page were being viewed. When viewing a profile, the json might be
+
+    {
+      pageName: "Profile: 4320",
+      section: "Profiles"
+    }
+    
+whereas search might look like
+
+    {
+      pageName: "Search: 'robert'",
+      section:  "Search"
+    }
+    
+The actual json was much more complicated, containing about 20 keys. Writing the mapping between input and output in higml allowed my coworkers and I to quickly understand what the json would be for a given page, or why the json was the way it was. Example .higml files can be found in /examples.
+
+Syntax
+------
+
+Example:
+
+    @import application.higml
+    action:show, action:new
+      :pageName Search Results
+      :keywords= keywords
+      
+      q:rutabagas
+        :rutabagas true
+      
+      filter
+        :filter_terms= filter_terms
+
+<dl>
+  <dt>@import appication.higml</dt>
+  <dd>acts as if the contents of application.higml were located where @import is</dd>
+  <dt>action:show, action:new</dt>
+  <dd>If the input hash has a value of "show" _or_ "new" for the key :action, then use the mapping that follows</dd>
+  <dt>:pageName Search Results</dt>
+  <dd>Output hash has a value of "Search Results" for the :pageName key; constant string</dd>
+  <dt>:keywords= keywords</dt>
+  <dd>Value of :keywords in output hash is whatever "keywords" evaluates to in the Higml mapper_context; let's you have dynamic values</dd>
+  <dt>q:rutabagas</dt>
+  <dd>If input hash satisfies action:show _or_ action:new, _and_ it has a value of "rutabagas" for :q, then apply the mapping that follows</dd>
+  <dt>filter</dt>
+  <dd>If input hash has a key of :filter at all (regardless of :q but dependent on :action), then apply mapping that follows</dd>
+</dl>
+
+Config
+------
+Use Higml.config.x to set these
+
+<dl>
+  <dt>config_directory</dt>
+  <dd>Where higml-config.yml is stored #this may be overkill :(</dd>
+  <dt>higml_directory</dt>
+  <dd>Where all the .higml files are stored</dd>
+  <dt>global_pairs</dt>
+  <dd>should be hash; used as base hash that result of mapping is merged on to</dd>
+</dl>
+
+Contributing to higml
+---------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2010 Daniel Higginbotham. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+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 = "higml"
+  gem.homepage = "http://github.com/flyingmachine/higml"
+  gem.license = "MIT"
+  gem.summary = %Q{Higml is a terse format for converting an input hash to an output hash.}
+  gem.description = %Q{Higml is a terse format for converting a static input hash to a dynamic output hash.}
+  gem.email = "daniel@flyingmachinestudios.com"
+  gem.authors = ["Daniel Higginbotham"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "higml #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/affiliations.higml

@@ -0,0 +1,4 @@
+@import application.higml
+
+action:index
+  :pageName ManagePermissions

data/examples/application.higml

@@ -0,0 +1,18 @@
+:charSet UTF-8
+:currencyCode USD
+:linkLeaveQueryString= false
+:linkTrackVars None
+:linkTrackEvents None
+
+:trackDownloadLinks= true
+:trackExternalLinks= true
+:trackInlineStats= true
+:linkDownloadFileTypes zip,wav,mp3,mov,mpg,avi,doc,pdf,xls,ppt
+:linkInternalFilters= "javascript:,#{request.host}"
+
+:pidx= current_user.id
+:skill_level= current_user_type
+:site_name My Site
+:session_id= request.session_options[:id]
+:timestamp= Time.now.strftime("%Y/%m/%d %H:%M:%S %p")
+:country= current_user_country

data/examples/articles.higml

@@ -0,0 +1,4 @@
+@import application.higml
+
+action:show
+  :pageName= @article.title

data/examples/contacts.higml

@@ -0,0 +1,4 @@
+@import application.higml
+
+action:show
+  :pageName ContactUs

data/examples/homes.higml

@@ -0,0 +1,2 @@
+@import application.higml
+:pageName Home

data/examples/messages.higml

@@ -0,0 +1,9 @@
+@import application.higml
+
+:channel Messages
+
+action:index
+  :pageName List Messages
+
+action:show
+  :pageName= "Message #{@message.id}"

data/examples/pages.higml

@@ -0,0 +1,9 @@
+@import application.higml
+
+id:privacy_policy
+  :channel PrivacyPolicy
+  :pageName PrivacyPolicy
+
+id:terms_of_use
+  :channel TermsOfUse
+  :pageName TermsOfUse

data/examples/profiles.higml

@@ -0,0 +1,17 @@
+@import application.higml
+
+action:show
+  :channel Profile_PersonalInformation
+  :pageName= "Profile_PersonalInformation #{@member.id}"
+
+  viewing_own
+    :channel MyProfile_PersonalInformation
+    :pageName= "MyProfile_PersonalInformation #{@member.id}"
+
+action:edit
+  :channel MyProfile_Edit
+  :pageName= "MyProfile_Edit #{@member.id}"
+
+action:edit_preferences
+  :channel ManageSetting
+  :pageName= "ManageSetting #{current_user.id}"

data/examples/searches.higml

@@ -0,0 +1,35 @@
+@import application.higml
+
+action:show, action:new
+  :channel Search
+  :search_term= @parser.keywords
+  :search_count= total_search_results
+  :search_resource_type= @parser.search_type
+  :search_fields= omniture_search_fields
+
+  action:show
+    :pageName= "Saved Search #{params[:id]}"
+    :search_type saved
+
+  action:new
+    :pageName New Search
+
+    search_type
+      :pageName Performed Search
+      :search_type= omniture_search_type
+
+      filter
+        :filter_type= filter_types
+        :filter_term= filter_terms
+        :search_type filtered
+
+action:create
+  :channel Search Saved
+  :pageName= "Search Saved #{@search.id}"
+
+action:destroy
+  :channel Search Deleted
+  :pageName= "Search Deleted #{@search.id}"
+
+search_origin
+  :search_origin= params[:search_origin]

data/examples/simulate.higml

@@ -0,0 +1,4 @@
+@import application.higml
+
+:channel SimulateScenarios
+:pageName SimulateScenarios

data/higml.gemspec

@@ -0,0 +1,92 @@
+# 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 = %q{higml}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Higginbotham"]
+  s.date = %q{2010-12-23}
+  s.description = %q{Higml is a terse format for converting a static input hash to a dynamic output hash.}
+  s.email = %q{daniel@flyingmachinestudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "examples/affiliations.higml",
+    "examples/application.higml",
+    "examples/articles.higml",
+    "examples/contacts.higml",
+    "examples/homes.higml",
+    "examples/messages.higml",
+    "examples/pages.higml",
+    "examples/profiles.higml",
+    "examples/searches.higml",
+    "examples/simulate.higml",
+    "higml.gemspec",
+    "lib/higml.rb",
+    "lib/higml/applier.rb",
+    "lib/higml/config.rb",
+    "lib/higml/node.rb",
+    "lib/higml/parser.rb",
+    "lib/higml/value.rb",
+    "spec/fixtures/application.higml",
+    "spec/fixtures/higml-config.yml",
+    "spec/fixtures/search.higml",
+    "spec/fixtures/selectors_with_groups.higml",
+    "spec/fixtures/with_import.higml",
+    "spec/higml_spec.rb",
+    "spec/lib/higml/applier_spec.rb",
+    "spec/lib/higml/config_spec.rb",
+    "spec/lib/higml/parser_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/flyingmachine/higml}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Higml is a terse format for converting an input hash to an output hash.}
+  s.test_files = [
+    "spec/higml_spec.rb",
+    "spec/lib/higml/applier_spec.rb",
+    "spec/lib/higml/config_spec.rb",
+    "spec/lib/higml/parser_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/higml/applier.rb

@@ -0,0 +1,57 @@
+module Higml
+  class Applier
+    def initialize(input, tree, priority_map, mapper_context)
+      @input = input
+      @tree = tree
+      @mapper_context = mapper_context
+      @priority_map = priority_map
+    end
+    
+    def result
+      @result = {}
+      apply_tree
+      Higml.config.global_pairs.merge@result.merge(@priority_map)
+    end
+    
+    def apply_tree
+      apply_node(@tree)
+    end
+    
+    def apply_node(node)
+      if node.selector.nil? || selector_matches?(node.selector)
+        apply_values(node.values)
+        node.children.each do |child_node|
+          apply_node(child_node)
+        end
+      end
+    end
+    
+    def apply_values(node_values)
+      node_values.each do |value|
+        next if priority_keys.include? value.key
+        if value.static?
+          @result[value.key] = value.raw_value
+        else
+          @result[value.key] = @mapper_context.instance_eval(value.raw_value)
+        end
+      end
+    end
+    
+    # REFACTOR to selector class
+    def selector_matches?(selector)
+      selector.any? do |group|
+        group.keys.all? do |key|
+          input_has_key?(key) && (@input[key] == group[key] || group[key].nil?)
+        end
+      end
+    end
+    
+    def input_has_key?(key)
+      @input.has_key?(key) && (@input[key] == true || !@input[key].empty?)
+    end
+    
+    def priority_keys
+      @priority_keys ||= @priority_map.keys
+    end
+  end
+end

data/lib/higml/config.rb

@@ -0,0 +1,54 @@
+module Higml
+  def self.config
+    @config ||= Config.instance
+  end
+  
+  class Config
+    include Singleton
+    
+    # higml_directory should be a string
+    # global_pairs should be hash; every result is merged to it
+    OPTIONS = %w{higml_directory global_pairs config_directory}
+    attr_accessor *OPTIONS.collect{|o|o.to_sym}
+    
+    def config_path
+      File.expand_path(File.join(self.config_directory, "higml-config.yml"))
+    end
+    
+    def global_pairs
+      @global_pairs ||= {}
+    end
+    
+    def set(config)
+      case config
+      when Hash: set_with_hash(config)
+      when IO: set_with_io(config)
+      when String: set_with_string(config)
+      end
+    end
+    
+    def set_with_hash(config)
+      OPTIONS.each do |option|
+        self.send("#{option}=", config[option]) if config[option]
+      end
+    end
+    
+    # String should be either a filename or YAML
+    def set_with_string(config)
+      if File.exists?(config)
+        set_with_yaml(File.read(config))
+      else
+        set_with_yaml(config)
+      end
+    end
+    
+    def set_with_io(config)
+      set_with_hash(YAML.load(config))
+      config.close
+    end
+    
+    def set_with_yaml(config)
+      set_with_hash(YAML.load(config))
+    end
+  end
+end

data/lib/higml/node.rb

@@ -0,0 +1,9 @@
+module Higml
+  class Node
+    attr_accessor :selector, :children, :values
+    def initialize
+      self.values = []
+      self.children = []
+    end
+  end
+end

data/lib/higml/parser.rb

@@ -0,0 +1,115 @@
+module Higml
+  class Parser
+    attr_accessor :source
+    
+    def initialize(source)
+      @source = source
+      prepend_imports
+    end
+    
+    def prepend_imports
+      already_imported = []
+      process_imports(@source, already_imported)
+    end
+    
+    def process_imports(current_source, already_imported)
+      current_source.each_line do |line|
+        line = Line.new(line)
+        if line.type == :import
+          filename = line.to_import
+          next if already_imported.include?(filename)
+          already_imported << filename
+          new_source = File.read(File.join(Higml.config.higml_directory, filename))
+          @source = new_source + "\n" + @source
+          process_imports(new_source, already_imported)
+        else
+          break
+        end
+      end
+    end
+    
+    def to_tree
+      current_node = Node.new
+      node_stack = [current_node]
+      indentation_level = 0
+      
+      source.each_line do |line|
+        next if line.strip.empty?
+        line = Line.new(line)
+        
+        case line.type 
+        when :value
+          # TODO move this comment
+          # Every drop in indentation corresponds to a new node;
+          # It doesn't make sense to drop indentation level and 
+          # define further values
+          current_node.values << line.to_value
+        when :selector
+          if line.indentation_level >= indentation_level
+            node_stack.push current_node
+          else
+            node_stack_to_pop = indentation_level - line.indentation_level - 1
+            node_stack.slice!(node_stack.size - node_stack_to_pop, node_stack.size)
+          end
+          current_node = Node.new
+          current_node.selector = line.to_selector
+          node_stack.last.children << current_node
+        else
+          next
+        end
+        indentation_level = line.indentation_level        
+      end
+      node_stack[0]
+    end
+    
+    
+    class Line
+      VALUE_INDICATOR = 58
+      IMPORT_INDICATOR = 64
+      COMMENT_INDICATOR = 47
+      
+      attr_reader :source, :stripped_source
+      
+      def initialize(source)
+        @source = source
+        @stripped_source = source.strip
+      end
+      
+      # Every two spaces is one indentation level
+      def indentation_level
+        spaces = (@source.size - @stripped_source.size)
+        spaces == 0 ? 0 : spaces / 2
+      end
+      
+      def type
+        case @stripped_source[0]
+        when VALUE_INDICATOR: :value
+        when IMPORT_INDICATOR: :import
+        when COMMENT_INDICATOR: :comment
+        else
+          :selector
+        end
+      end
+      
+      def to_selector
+        @stripped_source.split(",").collect do |group|
+          selector = {}
+          group = group.strip
+          group.split(" ").each do |pair|
+            key, value = pair.split(":")
+            selector[key.to_sym] = value || nil
+          end
+          selector
+        end
+      end
+      
+      def to_value
+        Value.new(self)
+      end
+      
+      def to_import
+        /@import (.*)/.match(@stripped_source)[1]
+      end
+    end
+  end
+end

data/lib/higml/value.rb

@@ -0,0 +1,21 @@
+module Higml
+  class Value
+    attr_accessor :type, :key, :raw_value
+    
+    def initialize(line)
+      match = /:(.*?)(=?) (.*)$/.match(line.stripped_source)
+      @key = match[1].to_sym
+      @raw_value = match[3]
+      @type = match[2].empty? ? :static : :dynamic
+    end
+    
+    def static?
+      @type == :static
+    end
+    
+    def dynamic?
+      @type == :dynamic
+    end
+    
+  end
+end

data/lib/higml.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+require 'yaml'
+require 'higml/applier'
+require 'higml/config'
+require 'higml/node'
+require 'higml/parser'
+require 'higml/value'
+
+module Higml
+  class << self
+    def values_for(input, selector_config, priority_map, mapper_context)
+      tree = tree_for_selector_config(selector_config)      
+      Higml::Applier.new(input, tree, priority_map, mapper_context).result
+    end
+    
+    def tree_for_selector_config(selector_config)
+      case selector_config
+      when String
+        possible_file_path = File.join(Higml.config.higml_directory, selector_config)
+        selector_config = File.read(possible_file_path) if File.exists?(possible_file_path)
+        Higml::Parser.new(selector_config).to_tree
+      when Higml::Node
+        selector_config
+      end
+    end
+  end
+end

data/spec/fixtures/application.higml

@@ -0,0 +1 @@
+:applicationName WOO Application

data/spec/fixtures/higml-config.yml

@@ -0,0 +1,3 @@
+higml_directory: dir
+global_pairs:
+  :keywords: :chassis

data/spec/fixtures/search.higml

@@ -0,0 +1,12 @@
+/ test comment
+:channel Search
+  
+action:new
+  :pageName New Search
+  
+action:show
+  :pageName Search Results
+  :keywords= keywords
+  
+  filter
+    :filter_terms= filter_terms

data/spec/fixtures/selectors_with_groups.higml

@@ -0,0 +1,2 @@
+action:show filter, action:new filter
+  :filter filtered!

data/spec/fixtures/with_import.higml

@@ -0,0 +1,2 @@
+@import application.higml
+:test yes

data/spec/higml_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HIGML integration" do
+  before :each do
+    @input = {
+      :action => "show",
+      :filter => { :tags => "cat, shakespeare"}
+    }
+    @mapper_context = Context.new
+  end
+  
+  it "should return the final values using input, higml filename, priority values" do
+    priority_map = {:keywords => "tongue paper"}
+    values = Higml.values_for(@input, 'search.higml', priority_map, @mapper_context)
+    
+    values.should == {
+      :channel      => "Search",
+      :pageName     => "Search Results",
+      :keywords     => priority_map[:keywords], # takes priority over @mapper_context.keywords
+      :filter_terms => @mapper_context.filter_terms
+    }
+  end
+
+  it "should allow you to use an existing tree instead of an sc filename" do
+    tree = Higml::Parser.new(File.read(File.join(Higml.config.higml_directory, 'search.higml'))).to_tree
+    values = Higml.values_for(@input, tree, {}, @mapper_context)
+
+    values.should == {
+      :channel      => "Search",
+      :pageName     => "Search Results",
+      :keywords     => @mapper_context.keywords,
+      :filter_terms => @mapper_context.filter_terms
+    }
+  end
+end

data/spec/lib/higml/applier_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Higml::Applier" do
+  it "should use a tree to build a result from input" do
+    tree = Higml::Parser.new(File.read(File.join(Higml.config.higml_directory, 'search.higml'))).to_tree
+    
+    input = {
+      :action => "show",
+      :filter => { :tags => "cat, shakespeare"}
+    }
+    
+    priority_map = {:keywords => "tongue paper"}
+    mapper_context = Context.new
+    
+    values = Higml::Applier.new(input, tree, priority_map, mapper_context).result
+    
+    values.should == {
+      :channel => "Search",
+      :pageName => "Search Results",
+      :keywords => priority_map[:keywords],
+      :filter_terms => mapper_context.filter_terms
+    }
+  end
+  
+  it "should test all groups in a selector" do
+    tree = Higml::Parser.new(File.read(File.join(Higml.config.higml_directory, 'selectors_with_groups.higml'))).to_tree
+    
+    input_group_1 = {
+      :action => "show",
+      :filter => { :tags => "cat, shakespeare"}
+    }
+    
+    input_group_2 = {
+      :action => "new",
+      :filter => { :tags => "cat, shakespeare"}
+    }
+    
+    priority_map = {}
+    
+    mapper_context = Context.new
+    Higml::Applier.new(input_group_1, tree, priority_map, mapper_context).result.should == {:filter => "filtered!"}
+    Higml::Applier.new(input_group_2, tree, priority_map, mapper_context).result.should == {:filter => "filtered!"}
+  end
+end

data/spec/lib/higml/config_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Higml::Config" do
+  before :all do
+    Higml.config.config_directory = FIXTURE_DIRECTORY
+  end
+  before :each do
+    Higml.config.higml_directory = nil
+    Higml.config.global_pairs    = nil
+  end
+  
+  after :all do
+    Higml.config.higml_directory = FIXTURE_DIRECTORY
+  end
+  
+  it "should set the config from a yaml filename" do
+    Higml.config.set(Higml.config.config_path)
+    Higml.config.higml_directory.should == "dir"
+    Higml.config.global_pairs.should == {:keywords => :chassis}
+  end
+  
+  it "should set the config from a file" do
+    Higml.config.set(File.open(Higml.config.config_path))
+    Higml.config.higml_directory.should == "dir"
+    Higml.config.global_pairs.should == {:keywords => :chassis}
+  end
+  
+  it "should set the config from a hash" do
+    Higml.config.set({
+      "higml_directory" => "a",
+      "global_pairs"    => {:k   => :v}
+    })
+    Higml.config.higml_directory.should == "a"
+    Higml.config.global_pairs.should == {:k => :v}
+  end
+end

data/spec/lib/higml/parser_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Higml::Parser" do
+  it "should build a node tree from a properly formatted file" do
+    tree = Higml::Parser.new(File.read(File.join(Higml.config.higml_directory, 'search.higml'))).to_tree
+    
+    tree.values[0].key.should == :channel
+    tree.values[0].raw_value.should == "Search"
+    
+    tree.children[0].selector.should == [{:action => "new"}]
+    tree.children[0].values[0].key.should == :pageName
+    tree.children[0].values[0].raw_value.should == "New Search"
+    
+    tree.children[1].selector.should == [{:action => "show"}]
+    tree.children[1].values[0].key.should == :pageName
+    tree.children[1].values[0].raw_value.should == "Search Results"
+    tree.children[1].values[0].type.should == :static
+    
+    tree.children[1].values[1].key.should == :keywords
+    tree.children[1].values[1].raw_value.should == "keywords"
+    tree.children[1].values[1].type.should == :dynamic
+  end
+  
+  it "should import values" do
+    tree = Higml::Parser.new(File.read(File.join(Higml.config.higml_directory, 'with_import.higml'))).to_tree
+    tree.values[0].key.should == :applicationName
+    tree.values[0].raw_value.should == "WOO Application"
+    tree.values[1].key.should == :test
+    tree.values[1].raw_value.should == "yes"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'higml'
+require 'spec'
+require 'spec/autorun'
+
+FIXTURE_DIRECTORY = File.join(File.dirname(__FILE__), 'fixtures')
+Higml.config.higml_directory = FIXTURE_DIRECTORY
+
+Spec::Runner.configure do |config|
+end
+
+
+class Context
+  def keywords
+    "juice mirror"
+  end
+  def filter_terms
+    "cat shakespeare"
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: higml
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Daniel Higginbotham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: Higml is a terse format for converting a static input hash to a dynamic output hash.
+email: daniel@flyingmachinestudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- examples/affiliations.higml
+- examples/application.higml
+- examples/articles.higml
+- examples/contacts.higml
+- examples/homes.higml
+- examples/messages.higml
+- examples/pages.higml
+- examples/profiles.higml
+- examples/searches.higml
+- examples/simulate.higml
+- higml.gemspec
+- lib/higml.rb
+- lib/higml/applier.rb
+- lib/higml/config.rb
+- lib/higml/node.rb
+- lib/higml/parser.rb
+- lib/higml/value.rb
+- spec/fixtures/application.higml
+- spec/fixtures/higml-config.yml
+- spec/fixtures/search.higml
+- spec/fixtures/selectors_with_groups.higml
+- spec/fixtures/with_import.higml
+- spec/higml_spec.rb
+- spec/lib/higml/applier_spec.rb
+- spec/lib/higml/config_spec.rb
+- spec/lib/higml/parser_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/flyingmachine/higml
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Higml is a terse format for converting an input hash to an output hash.
+test_files: 
+- spec/higml_spec.rb
+- spec/lib/higml/applier_spec.rb
+- spec/lib/higml/config_spec.rb
+- spec/lib/higml/parser_spec.rb
+- spec/spec_helper.rb