ki_middleman 0.0.13 → 1.0.0

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format nested

data/bin/ki_middleman

@@ -8,12 +8,14 @@ module KiMiddleman
     include Methadone::Main
     include Methadone::CLILogging
 
+    DEFAULT_TRANSFORMS_FILE = 'default_transforms.rb'
+    TRANSFORMS_FILE = 'transforms.rb'
+
     def self.init
       config_dir = Kiseru::ConfigDir.new
       assets_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'assets'))
-      assets_file = File.join(assets_dir, 'default_transforms.rb')
-      # TODO - duplicated file name here!
-      new_file = config_dir.file('transforms.rb')
+      assets_file = File.join(assets_dir, DEFAULT_TRANSFORMS_FILE)
+      new_file = config_dir.file(TRANSFORMS_FILE)
       if File.exists?(new_file)
         $stdout.puts "Cannot write #{new_file}. File already exists."
       else
@@ -28,14 +30,14 @@ module KiMiddleman
       if options[:init]
         init
       elsif options[:list]
-        config = KiMiddleman::Config.from_file(Kiseru::ConfigDir.new.file('transforms.rb'))
+        config = KiMiddleman::Config.from_file(Kiseru::ConfigDir.new.file(TRANSFORMS_FILE))
         $stdout.puts(config.textual_mapping)
       elsif options[:to]
         begin
           pretty = true
 
           output_type = options[:to]
-          config = KiMiddleman::Config.from_file(Kiseru::ConfigDir.new.file('transforms.rb'))
+          config = KiMiddleman::Config.from_file(Kiseru::ConfigDir.new.file(TRANSFORMS_FILE))
           if options[:file]
             input = MultiJson.load(File.read(options[:file]))
           else

data/lib/ki_middleman.rb

@@ -8,5 +8,6 @@ autoload :Kiseru, 'ki_middleman/kiseru'
 module KiMiddleman
 
   autoload :Config, 'ki_middleman/config'
+  autoload :TransformationsRenderer, 'ki_middleman/transformations_renderer'
 
 end

data/lib/ki_middleman/config.rb

@@ -4,33 +4,21 @@ module KiMiddleman
 
   class Config
 
+    FROM_BLOCK_KEY = :outer_blocks
+
     def self.from_file(path)
       code = File.read(path)
       parse(code)
     end
 
-    def textual_mapping
-      output = ""
-      @mapping.each do |key, sub_hash|
-        subkeys = sub_hash.keys.reject  { |x| x.to_s=="outer_block"}
-        subkeys.each_with_index do |sub_key, i|
-          case i
-          when 0
-            output << "#{key} +-> #{sub_key}\n"
-          when subkeys.length - 1
-            output << "#{' '*key.length} \\-> #{sub_key}\n"
-          else
-            output << "#{' '*key.length} |-> #{sub_key}\n"
-          end
-        end
-      end
-      output
-    end
-
     def self.parse(code)
       Config.new(code)
     end
 
+    def textual_mapping
+      TransformationsRenderer.render(simple_mapping)
+    end
+
     def detect_from_format(data)
       @from_format = data['ki_type']
       raise ConfigError, "Cannot convert from unknown type. Include 'ki_type' in JSON" if @from_format.nil?
@@ -44,7 +32,7 @@ module KiMiddleman
       @parsing = false
     end
 
-    def convert_data_to_format(data, format, constants)
+    def convert_data_to_format(data, format, constants='')
       self.detect_from_format(data)
 
       raise ConfigError, "No transform from '#{@from_format}' found." unless @mapping.has_key?(@from_format.to_sym)
@@ -56,12 +44,18 @@ module KiMiddleman
       end
 
       @format_to_evaluate = best_to_format
+
       self.set_evaluation_context
-      evaluation_context = @mapping[@from_format.to_sym][:outer_block]
+      evaluation_contexts = @mapping[@from_format.to_sym][FROM_BLOCK_KEY]
       instance_eval constants
-      converted_data = evaluation_context.call Map.new(data)
+      converted_data = nil
+      evaluation_contexts.each do |evaluation_context|
+        converted_data = evaluation_context.call(Map.new(data))
+        break if converted_data
+      end
       converted_data['ki_type'] = best_to_format
 
+      @evaluation = nil
       converted_data
     end
 
@@ -69,10 +63,13 @@ module KiMiddleman
       keys = @mapping[from_format].keys.map(&:to_s)
       matching = keys.select { |key| key.include?(format.to_s) }
 
-      if matching.length == 1
+      case matching.length
+      when 0
+        raise "Cannot convert '#{from_format}' to '#{format}'. No matching transformations."
+      when 1
         match = matching.first
       else
-        format
+        raise "Cannot pick a transformation for '#{from_format}' to '#{format}'.\nPossible options are #{matching.map{|x| %Q{'#{x}'} }.join(', ')}."
       end
     end
 
@@ -84,9 +81,10 @@ module KiMiddleman
 
     def from(from_format, &block)
       @current_from = from_format
-      @mapping[@current_from] = {
-        :outer_block => block
+      @mapping[@current_from] ||= {
       }
+      @mapping[@current_from][FROM_BLOCK_KEY] ||= []
+      @mapping[@current_from][FROM_BLOCK_KEY] << block
       yield
     end
 
@@ -96,12 +94,28 @@ module KiMiddleman
       if @parsing
         @mapping[@current_from][to_format] = block
       else
+        #return @evaluation if @evaluation
         if @format_to_evaluate.to_s == to_format.to_s
-           @evaluation = block.call
-           @format_to_evaluate = nil
+          @evaluation = block.call
+          @format_to_evaluate = nil
+        end
+        @evaluation
+      end
+    end
+
+    private
+
+    def simple_mapping
+      map = {}
+      @mapping.each do |origin_format, data|
+        data.each do |key, value|
+          next if key.to_s == FROM_BLOCK_KEY.to_s
+          map[origin_format] ||= []
+          map[origin_format] << key
         end
-           @evaluation
       end
+      map
     end
+
   end
 end

data/lib/ki_middleman/transformations_renderer.rb

@@ -0,0 +1,44 @@
+module KiMiddleman
+
+  class TransformationsRenderer
+
+    def self.render(transformations)
+      output = []
+      longest_origin_format_length = transformations.keys.map(&:length).max
+      transformations.each do |origin_format, destination_format_array|
+        last_index = destination_format_array.length - 1
+        destination_format_array.each_with_index do |destination_format, index|
+          output <<
+            "%-#{longest_origin_format_length}s %s %s" %
+            [render_origin_format(origin_format, index),
+             render_arrows(index, last_index),
+             destination_format]
+        end
+      end
+      output.map {|o| o + "\n"}.join
+    end
+
+    def self.render_arrows(index, last_index)
+      return "--->" if last_index == 0
+      case index
+      when 0
+        "-+->"
+      when last_index
+        " \\->"
+      else
+        " |->"
+      end
+    end
+
+    def self.render_origin_format(origin_format, index)
+      if index == 0
+        origin_format
+      else
+        ""
+      end
+    end
+    private_class_method :render_origin_format
+
+  end
+
+end

data/lib/ki_middleman/version.rb

@@ -1,3 +1,3 @@
 module KiMiddleman
-  VERSION = "0.0.13"
+  VERSION = "1.0.0"
 end

data/spec/integration/convert_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 include KiMiddleman
 
-describe "converting JSON" do
+describe KiMiddleman::Config do
 
   it "converts to a base format" do
     config = KiMiddleman::Config.parse <<-RUBY
@@ -14,24 +14,37 @@ from(:bug) do |bug|
   end
   to(:something_else) do
     {
+       'foo' => 'bar'
     }
   end
 end
 RUBY
-    input_json =<<-JSON
-{
-  "ki_type" : "bug",
-  "name" : "Something broke",
-  "id"   : "123"
-}
-JSON
-
-    input = MultiJson.load(input_json)
-
-    output = config.convert_data_to_format(input, 'story', '')
+    input = {
+      "ki_type" => "bug",
+      "name" => "Something broke",
+      "id"   => "123"
+    }
 
+    output = config.convert_data_to_format(input, 'story')
     output['ki_type'].should == 'story'
     output['summary'].should == "[123] Something broke"
+
+    output = config.convert_data_to_format(input, 'something_else')
+    output['foo'].should == "bar"
+  end
+
+  it "raises error if 'to' format cannot be found" do
+    config = KiMiddleman::Config.parse <<-RUBY
+from(:bug) do |bug|
+  to(:story) do
+    {}
+  end
+end
+RUBY
+    input = { "ki_type" => "bug" }
+    expect {
+      output = config.convert_data_to_format(input, 'card')
+    }.to raise_error /Cannot convert 'bug' to 'card'\. No matching transformations/
   end
 
   it "can use . syntax" do
@@ -44,21 +57,39 @@ from(:bug) do |bug|
   end
 end
 RUBY
-    input_json =<<-JSON
-{
-  "ki_type" : "bug",
-  "name" : "Hello"
-}
-JSON
-
-    input = MultiJson.load(input_json)
+    input = {
+      "ki_type" => "bug",
+      "name" => "Hello"
+    }
 
-    output = config.convert_data_to_format(input, 'story', '')
+    output = config.convert_data_to_format(input, 'story')
 
     output['summary'].should == "Hello"
   end
 
-  it "can subsitute in constants" do
+  it "can define transforms in separate blocks" do
+    config = KiMiddleman::Config.parse <<-RUBY
+from(:bug) do |bug|
+  to(:story) do
+    {
+       :name => 'story'
+    }
+  end
+end
+from(:bug) do |bug|
+  to(:card) do
+    {
+      :name => 'card'
+    }
+  end
+end
+RUBY
+    input = {'ki_type' => 'bug'}
+    config.convert_data_to_format(input, 'story')[:name].should == 'story'
+    config.convert_data_to_format(input, 'card')[:name].should == 'card'
+  end
+
+  it "can substitute in constants" do
     config = KiMiddleman::Config.parse <<-RUBY
 CONSTANT = "first"
 from(:bug) do |bug|
@@ -69,23 +100,89 @@ from(:bug) do |bug|
   end
 end
 RUBY
-    input_json =<<-JSON
-{
-  "ki_type" : "bug",
-  "name" : "Hello"
-}
-JSON
-
-    input = MultiJson.load(input_json)
+    input = {
+      "ki_type" => "bug",
+      "name" => "Hello"
+    }
 
-    output = config.convert_data_to_format(input, 'story', '')
+    output = config.convert_data_to_format(input, 'story')
 
     output['summary'].should == "first"
 
-    output = config.convert_data_to_format(input, 'story', 'CONSTANT = "second";')
+    capture_io do
+      output = config.convert_data_to_format(input, 'story', 'CONSTANT = "second";')
+    end
 
     output['summary'].should == "second"
 
   end
 
+  it "raises error if unique transformation cannot be found" do
+    config = KiMiddleman::Config.parse <<-RUBY
+from(:bug) do |foo|
+  to(:card1) { {'message' => 'hi'} }
+  to(:card2) {}
+end
+RUBY
+    input = {
+      "ki_type" => "bug",
+    }
+
+    expect {
+      config.convert_data_to_format(input, "card")
+    }.to raise_error(/Cannot pick a transformation for/)
+
+    output = config.convert_data_to_format(input, "card1")
+    output['message'].should == 'hi'
+  end
+
+
+  it "can choose transformation with substring" do
+    config = KiMiddleman::Config.parse <<-RUBY
+from(:bug) do |foo|
+  to(:foobar) { {'message' => 'hi'} }
+end
+RUBY
+    input = {
+      "ki_type" => "bug",
+    }
+
+    capture_io do
+      output = config.convert_data_to_format(input, "foo")
+      output['message'].should == 'hi'
+      output = config.convert_data_to_format(input, "bar")
+      output['message'].should == 'hi'
+    end
+  end
+
+  it "can list transitions" do
+    config = KiMiddleman::Config.parse <<-RUBY
+from(:foo) do |foo|
+  to(:bar) {}
+  to(:baz) {}
+end
+from(:foo) do |foo|
+  to(:foobar) {}
+end
+from(:a) do
+  to(:d) {}
+  to(:c) {}
+  to(:b) {}
+end
+from(:x) do
+  to(:z) {}
+end
+RUBY
+    output = config.textual_mapping
+    output.should include("foo -+-> bar")
+    output.should include("     |-> baz")
+    output.should include("     \\-> foobar")
+
+    output.should include("a   -+-> d")
+    output.should include("     |-> c")
+    output.should include("     \\-> b")
+
+    output.should include("x   ---> z")
+  end
+
 end

data/spec/spec_helper.rb

@@ -17,6 +17,24 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  def capture_io
+    require 'stringio'
+
+    captured_stdout, captured_stderr = StringIO.new, StringIO.new
+
+    orig_stdout, orig_stderr = $stdout, $stderr
+    $stdout, $stderr         = captured_stdout, captured_stderr
+
+    begin
+      yield
+    ensure
+      $stdout = orig_stdout
+      $stderr = orig_stderr
+    end
+
+    return captured_stdout.string, captured_stderr.string
+  end
 end
 
 if ENV['COVERAGE']

data/spec/unit/transformation_renderer.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe KiMiddleman::TransformationsRenderer do
+
+  it "renders a single transformation" do
+    map  = {
+      :a => [:b]
+    }
+    TransformationsRenderer.render(map).should == "a ---> b\n"
+  end
+
+  it "renders two transformations from the same format" do
+    map = {
+      :a => [:b, :c]
+    }
+    TransformationsRenderer.render(map).should == <<-EOS
+a -+-> b
+   \\-> c
+EOS
+  end
+
+  it "renders many transformations from the same format" do
+    map = {
+      :a => [:b, :c, :d, :e]
+    }
+    TransformationsRenderer.render(map).should == <<-EOS
+a -+-> b
+   |-> c
+   |-> d
+   \\-> e
+EOS
+  end
+
+  it "aligns all arrows" do
+    map = {
+      :a => [:b, :c],
+      :foobar => [:bar]
+    }
+    TransformationsRenderer.render(map).should == <<-EOS
+a      -+-> b
+        \\-> c
+foobar ---> bar
+EOS
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ki_middleman
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70261199979280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 1.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *70261199979280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: methadone
-  requirement: &70261199978560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: 1.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70261199978560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: map
-  requirement: &70261199977900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: 4.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70261199977900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.1
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70261199977140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +70,15 @@ dependencies:
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *70261199977140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70261199976680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +86,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70261199976680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70261199975980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +102,15 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70261199975980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70261199975260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +118,12 @@ dependencies:
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: *70261199975260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 description: Transforms JSON into other JSON
 email:
 - ben@freeagent.com
@@ -110,9 +145,11 @@ files:
 - lib/ki_middleman.rb
 - lib/ki_middleman/config.rb
 - lib/ki_middleman/kiseru.rb
+- lib/ki_middleman/transformations_renderer.rb
 - lib/ki_middleman/version.rb
 - spec/integration/convert_spec.rb
 - spec/spec_helper.rb
+- spec/unit/transformation_renderer.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -125,18 +162,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2635587134579891059
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2635587134579891059
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Transforms JSON into other JSON
 test_files:
 - spec/integration/convert_spec.rb
 - spec/spec_helper.rb
+- spec/unit/transformation_renderer.rb