higml 0.0.0 → 0.0.1

data/README.markdown

@@ -4,7 +4,7 @@ higml
 Overview
 --------
 
-Higml is a terse format for converting an input hash to an output hash.
+Higml is a concise format for "cascading configuration" - it uses cascading rules to create an output hash from an input hash.
 
 Example Higml and input:
 
@@ -30,7 +30,7 @@ This output is produced:
       :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.
+To get a better understandung 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
 
@@ -46,7 +46,7 @@ whereas search might look like
       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.
+The actual json was much more complicated, containing about 20 keys. Writing the mapping between input and output in separate higml files (one for each Rails controller) 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
 ------

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/higml.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{higml}
-  s.version = "0.0.0"
+  s.version = "0.0.1"
 
   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.date = %q{2011-06-09}
   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 = [

data/lib/higml.rb

@@ -8,9 +8,9 @@ require 'higml/value'
 
 module Higml
   class << self
-    def values_for(input, selector_config, priority_map, mapper_context)
+    def values_for(input, selector_config, mapper_context = nil, priority_map = {})
       tree = tree_for_selector_config(selector_config)      
-      Higml::Applier.new(input, tree, priority_map, mapper_context).result
+      Higml::Applier.new(input, tree, mapper_context, priority_map).result
     end
     
     def tree_for_selector_config(selector_config)

data/lib/higml/applier.rb

@@ -1,6 +1,6 @@
 module Higml
   class Applier
-    def initialize(input, tree, priority_map, mapper_context)
+    def initialize(input, tree, mapper_context = nil, priority_map = {})
       @input = input
       @tree = tree
       @mapper_context = mapper_context
@@ -31,6 +31,8 @@ module Higml
         next if priority_keys.include? value.key
         if value.static?
           @result[value.key] = value.raw_value
+        elsif @mapper_context.nil?
+          raise ArgumentError, "you're trying to evaluate code without providing a context"
         else
           @result[value.key] = @mapper_context.instance_eval(value.raw_value)
         end

data/spec/higml_spec.rb

@@ -11,7 +11,7 @@ describe "HIGML integration" do
   
   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 = Higml.values_for(@input, 'search.higml', @mapper_context, priority_map)
     
     values.should == {
       :channel      => "Search",
@@ -23,7 +23,7 @@ describe "HIGML integration" do
 
   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 = Higml.values_for(@input, tree, @mapper_context)
 
     values.should == {
       :channel      => "Search",
@@ -32,4 +32,12 @@ describe "HIGML integration" do
       :filter_terms => @mapper_context.filter_terms
     }
   end
+  
+  it "should work ok without mapper context or priority map" do
+    lambda{Higml.values_for({:action => "new"}, 'search.higml')}.should_not raise_error
+  end
+  
+  it "should raise an error if applying a rule which requires a context, where none is provided" do
+    lambda{Higml.values_for({:action => "show", :keywords => "what"}, 'search.higml')}.should raise_error
+  end
 end

data/spec/lib/higml/applier_spec.rb

@@ -12,7 +12,7 @@ describe "Higml::Applier" do
     priority_map = {:keywords => "tongue paper"}
     mapper_context = Context.new
     
-    values = Higml::Applier.new(input, tree, priority_map, mapper_context).result
+    values = Higml::Applier.new(input, tree, mapper_context, priority_map).result
     
     values.should == {
       :channel => "Search",
@@ -38,7 +38,7 @@ describe "Higml::Applier" do
     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!"}
+    Higml::Applier.new(input_group_1, tree, mapper_context, priority_map).result.should == {:filter => "filtered!"}
+    Higml::Applier.new(input_group_2, tree, mapper_context, priority_map).result.should == {:filter => "filtered!"}
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: higml
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,14 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-23 00:00:00 -05:00
+date: 2011-06-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: rspec
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,12 +30,12 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
   type: :development
-  name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,12 +46,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  name: bundler
   prerelease: false
   type: :development
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,12 +62,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  name: jeweler
   prerelease: false
   type: :development
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,7 +76,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  name: rcov
+  prerelease: false
+  type: :development
+  version_requirements: *id004
 description: Higml is a terse format for converting a static input hash to a dynamic output hash.
 email: daniel@flyingmachinestudios.com
 executables: []