bespoke 0.1.0

data/bespoke.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bespoke/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name         = "bespoke"
+  gem.summary      = "Bespoke does in-memory object joins using mustache templates"
+  gem.description  = "Bespoke does in-memory object joins using mustache templates"
+  gem.authors      = ['Duane Johnson']
+  gem.email        = ['duane@instructure.com']
+
+  gem.files = %w[bespoke.gemspec readme.md]
+  gem.files += Dir.glob("lib/**/*")
+  gem.files += Dir.glob("spec/**/*")
+
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.require_paths = ["lib"]
+  gem.version       = Bespoke::VERSION
+  gem.required_ruby_version = '>= 1.9.0'
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'docile'
+  gem.add_dependency 'mustache'
+end

data/lib/bespoke.rb

@@ -0,0 +1,39 @@
+require "bespoke/version"
+require "bespoke/indexed_collection"
+require "bespoke/exportable"
+
+class Bespoke
+  attr_reader :collection, :exports
+
+  def initialize(hash)
+    @collection = IndexedCollection.new
+    hash["index"].each_pair do |name, column|
+      @collection.index name, column
+    end
+    @exports = {}
+    hash["export"].each_pair do |output_name, exportable_configs|
+      outputs = @exports[output_name] = []
+      exportable_configs.each do |config|
+        config.each_pair do |collection_name, attrs|
+          outputs << (export = Exportable.new(collection_name))
+          (attrs["fields"] || {}).each_pair do |field, template|
+            export.field field, template
+          end
+          (attrs["joins"] || {}).each_pair do |join, template|
+            export.join join, template
+          end
+        end
+      end
+    end
+  end
+
+  def add(type, object)
+    @collection.add(type, object)
+  end
+
+  def export(name, &block)
+    @exports[name].each do |e|
+      e.export(@collection.collections, &block)
+    end
+  end
+end

data/lib/bespoke/dsl.rb

@@ -0,0 +1,9 @@
+require "bespoke"
+
+def indexed_collection(&block)
+  Docile.dsl_eval(Bespoke::IndexedCollection.new, &block)
+end
+
+def exportable(name, &block)
+  Docile.dsl_eval(Bespoke::Exportable.new(name), &block)
+end

data/lib/bespoke/exportable.rb

@@ -0,0 +1,54 @@
+require 'csv'
+require 'docile'
+require 'mustache'
+
+class Bespoke
+  class Error < StandardError; end
+  MissingTable = Class.new(Error)
+  MissingJoin = Class.new(Error)
+
+  class Exportable
+    attr_accessor :name, :fields, :joins
+
+    def initialize(name)
+      @name = name.to_sym
+      @fields = {}
+      @joins = {}
+    end
+
+    def headers
+      @fields.keys
+    end
+
+    def field(name, template_string)
+      fields[name] = Mustache::Template.new(template_string)
+    end
+
+    def join(name, key)
+      joins[name] = key
+    end
+
+    def export(hashes={}, &block)
+      raise "hashes missing #{@name.inspect} (of: #{hashes.keys.inspect})" unless hashes.has_key?(@name)
+      hashes[@name].map do |main_key, row|
+        context = { @name => row }
+        @joins.each_pair do |join_name, key|
+          if other_table = hashes[join_name.to_sym]
+            if other_table.has_key?(row[key])
+              context[join_name.to_sym] = other_table[row[key]]
+            else
+              raise MissingJoin, "Expected foreign key #{key} with value #{row[key]} in table #{join_name}"
+            end
+          else
+            raise MissingTable, "Expected #{join_name}"
+          end
+        end
+        fields.map do |name, template|
+          Mustache.render(template, context)
+        end.tap do |output_row|
+          yield output_row if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/bespoke/indexed_collection.rb

@@ -0,0 +1,45 @@
+require 'docile'
+
+class Bespoke
+  class IndexedCollection
+    attr_reader :collections
+    
+    def initialize
+      @index_columns = {}
+      @collections = {}
+    end
+
+    def proc_for_key(key)
+      return Proc.new{ |x| nil } unless key
+      key = key.first if key.is_a?(Array) and key.size == 1
+      if key.is_a?(Array)
+        Proc.new{ |x| key.map{ |k| (x[k] rescue x.send(k)) } }
+      else
+        Proc.new{ |x| (x[key] rescue x.send(key)) }
+      end
+    end
+
+    def index(collection_name, index_key_method=nil, &block)
+      col_sym = collection_name.to_sym
+      @index_columns[col_sym] = block || proc_for_key(index_key_method)
+      @collections[col_sym] = {}
+    end
+
+    def add(collection_name, object)
+      col_sym = collection_name.to_sym
+      key_from_object = @index_columns[col_sym]
+      key = key_from_object.call(object)
+      begin
+        @collections[col_sym][key] = object
+      rescue NoMethodError
+        raise "Can't find collection #{col_sym} with key #{key}"
+      end
+    end
+
+    def find(collection_name, key)
+      if collection = @collections[collection_name.to_sym]
+        collection[key]
+      end
+    end
+  end
+end

data/lib/bespoke/version.rb

@@ -0,0 +1,3 @@
+class Bespoke
+  VERSION = '0.1.0' unless defined?(Bespoke::VERSION)
+end

data/readme.md

@@ -0,0 +1,125 @@
+Bespoke
+=======
+
+Getting Started
+---------------
+
+```ruby
+config = {
+  "index" => {
+    "student" => ["id"],
+    "staff"   => ["id"],
+    "school"  => ["id"]
+  },
+  "export" => {
+    "users" => [
+      {
+        "student" => {
+          "fields" => {
+            "user_id" => "{{student.id}}",
+            "name"    => "{{student.first_name}} {{student.last_name}}"
+          }
+        }
+      },
+      {
+        "staff" => {
+          "fields" => {
+            "user_id" => "{{staff.id}}",
+            "name"    => "{{school.district}} Professor {{staff.last_name}}"
+          },
+          "joins" => {
+            "school" => "school_id"
+          }
+        }
+      }
+    ],
+    "schools" => [
+      {
+        "school" => {
+          "fields" => {
+            "school_id" => "{{school.id}}",
+            "district"  => "D:{{school.district}}"
+          },
+          "joins" => {
+            "school" => "school_id"
+          }
+        }
+      }
+    ]
+  }
+}
+
+data = {
+  "student" => [
+    { "id" => 1, "first_name" => "Eric",  "last_name" => "Adams" },
+    { "id" => 2, "first_name" => "Duane", "last_name" => "Johnson" },
+    { "id" => 3, "first_name" => "Ken",   "last_name" => "Romney" }
+  ],
+  "staff" => [
+    { "id" => 1, "last_name" => "Baxter", "school_id" => 1 },
+    { "id" => 2, "last_name" => "Summer", "school_id" => 2 }
+  ],
+  "school" => [
+    { "id" => 1, "district" => "North" },
+    { "id" => 2, "district" => "East" },
+    { "id" => 3, "district" => "South" }
+  ]
+}
+
+bespoke = Bespoke.new(config)
+
+data.each_pair do |type, rows|
+  rows.each do |row|
+    bespoke.add type, row
+  end
+end
+
+rows = []
+bespoke.export("users") do |row|
+  rows << row
+end
+
+# rows:
+#  ["1", "Eric Adams"]
+#  ["2", "Duane Johnson"]
+#  ["3", "Ken Romney"]
+#  ["1", "North Professor Baxter"]
+#  ["2", "East Professor Summer"]
+
+```
+
+DSL
+---
+
+Note that there is also an easy-to-use DSL if you don't want to use a json config. Use ```indexed_collection``` to declare an IndexedCollection and ```exportable``` to declare an Exportable.
+
+```ruby
+require 'bespoke/dsl'
+
+indexed = indexed_collection do
+  index :student,   :id
+  index :staff,     :id
+  index :school,    :id
+end
+
+exports = {
+  users: [
+    exportable(:student) {
+      field :user_id, "{{student.id}}"
+      field :name,    "{{student.first_name}} {{student.last_name}}"
+    },
+    exportable(:staff) {
+      field :user_id, "{{staff.id}}"
+      field :name,    "{{school.district}} Professor {{staff.last_name}}"
+    }
+  ],
+  schools: [
+    exportable(:school) {
+      field :school_id, "{{school.id}}"
+      field :district,  "D:{{school.district}}"
+
+      join :school, :school_id
+    }
+  ]
+}
+```

data/spec/bespoke_spec.rb

@@ -0,0 +1,112 @@
+require_relative 'spec_helper'
+
+describe Bespoke do
+  let(:data) {
+    {
+      "student" => [
+        { "id" => 1, "first_name" => "Eric",  "last_name" => "Adams" },
+        { "id" => 2, "first_name" => "Duane", "last_name" => "Johnson" },
+        { "id" => 3, "first_name" => "Ken",   "last_name" => "Romney" }
+      ],
+      "staff" => [
+        { "id" => 1, "last_name" => "Baxter", "school_id" => 1 },
+        { "id" => 2, "last_name" => "Summer", "school_id" => 2 }
+      ],
+      "school" => [
+        { "id" => 1, "district" => "North" },
+        { "id" => 2, "district" => "East" },
+        { "id" => 3, "district" => "South" }
+      ]
+    }
+  }
+  let(:config) {
+    {
+      "index" => {
+        "student" => ["id"],
+        "staff"   => ["id"],
+        "school"  => ["id"]
+      },
+      "export" => {
+        "users" => [
+          {
+            "student" => {
+              "fields" => {
+                "user_id" => "{{student.id}}",
+                "name"    => "{{student.first_name}} {{student.last_name}}"
+              }
+            }
+          },
+          {
+            "staff" => {
+              "fields" => {
+                "user_id" => "{{staff.id}}",
+                "name"    => "{{school.district}} Professor {{staff.last_name}}"
+              },
+              "joins" => {
+                "school" => "school_id"
+              }
+            }
+          }
+        ],
+        "schools" => [
+          {
+            "school" => {
+              "fields" => {
+                "school_id" => "{{school.id}}",
+                "district"  => "D:{{school.district}}"
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+  let(:bespoke) { Bespoke.new(config) }
+
+  it "initializes" do
+    Bespoke.new(config)
+  end
+
+  context "with loaded data" do
+    before do
+      data.each_pair do |type, rows|
+        rows.each do |row|
+          bespoke.add type, row
+        end
+      end
+    end
+
+    it "creates a collection in memory" do
+      bespoke.collection.collections.should == {
+        :student => {
+          1 => {"id"=>1, "first_name"=>"Eric", "last_name"=>"Adams"},
+          2 => {"id"=>2, "first_name"=>"Duane", "last_name"=>"Johnson"},
+          3 => {"id"=>3, "first_name"=>"Ken", "last_name"=>"Romney"}
+        },
+        :staff => {
+          1 => {"id"=>1, "last_name"=>"Baxter", "school_id"=>1},
+          2 => {"id"=>2, "last_name"=>"Summer", "school_id"=>2}
+        },
+        :school => {
+          1 => {"id"=>1, "district"=>"North"},
+          2 => {"id"=>2, "district"=>"East"},
+          3 => {"id"=>3, "district"=>"South"}
+        }
+      }
+    end
+
+    it "exports" do
+      rows = []
+      bespoke.export("users") do |row|
+        rows << row
+      end
+      rows.should == [
+        ["1", "Eric Adams"],
+        ["2", "Duane Johnson"],
+        ["3", "Ken Romney"],
+        ["1", "North Professor Baxter"],
+        ["2", "East Professor Summer"]
+      ]
+    end
+  end
+end

data/spec/exportable_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+
+describe Bespoke::Exportable do
+  let(:export) { Bespoke::Exportable.new(:test) }
+
+  it "initializes" do
+    Bespoke::Exportable.new(:test)
+  end
+
+  it "exports templated rows" do
+    export.field(:column, "{{test.one}}-{{test.two}}")
+    data = export.export({:test => {
+      1 => {:one => 1, :two => 2},
+      2 => {:one => 5, :two => 10}
+    }})
+    data.should == [["1-2"], ["5-10"]]
+  end
+end

data/spec/indexed_collection_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe Bespoke::IndexedCollection do
+  it "initializes" do
+    Bespoke::IndexedCollection.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
+
+require 'bespoke'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: bespoke
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Duane Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bespoke does in-memory object joins using mustache templates
+email:
+- duane@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bespoke.gemspec
+- readme.md
+- lib/bespoke/dsl.rb
+- lib/bespoke/exportable.rb
+- lib/bespoke/indexed_collection.rb
+- lib/bespoke/version.rb
+- lib/bespoke.rb
+- spec/bespoke_spec.rb
+- spec/exportable_spec.rb
+- spec/indexed_collection_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Bespoke does in-memory object joins using mustache templates
+test_files:
+- spec/bespoke_spec.rb
+- spec/exportable_spec.rb
+- spec/indexed_collection_spec.rb
+- spec/spec_helper.rb
+has_rdoc: