bespoke 0.2.0 → 0.2.1

data/spec/lib/bespoke/export/filter_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+module Bespoke
+  class Export
+    describe Filter do
+      let(:join) { basic_join }
+      let(:db) { join.database }
+      let(:table) { db[:two] }
+      let(:templates) { {} }
+      let(:filter) { Filter.new(table, templates) }
+
+      describe '#apply' do
+        before do
+          join.load_csv(:one, fixture('one.csv'))
+          join.load_csv(:two, fixture('two.csv'))
+        end
+
+        it 'must not allow SQLi vulnerabilities into clients through the selects templates' do
+          templates[:selects] = { foo_id: '* FROM `two` -- ' }
+          dataset = filter.apply
+          expect(dataset.first).to eq({foo_id: '* FROM `two` -- '})
+        end
+
+        it 'must not allow SQLi vulnerabilities into clients through the joins templates as strings' do
+          templates[:joins] = 'foos; SELECT * FROM `one`;'
+          dataset = filter.apply
+          expect { dataset.all }.to raise_error
+        end
+
+        it 'must not allow SQLi vulnerabilities into clients through the joins templates as a hash' do
+          templates[:joins] = { one: ['one_id', 'id` WHERE 1=1; -- `'] }
+          dataset = filter.apply
+          expect { dataset.all }.to raise_error
+        end
+
+        it 'must not allow SQLi vulnerabilities into clients through the where template' do
+          templates[:where] = '1=1); (DROP TABLE `one`'
+          dataset = filter.apply
+          expect(dataset.first).to eq({description: 'Cryptocurrency', id: 1, one_id: 1})
+          expect(db[:one].all).to_not be_empty
+        end
+      end
+
+      describe '#sql' do
+        it 'must default to selecting all fields from the table' do
+          expect(filter.sql).to start_with 'SELECT * FROM'
+        end
+
+        it 'must select from the specified table' do
+          expect(filter.sql).to end_with 'FROM `two`'
+        end
+
+        context 'when processing the selects key from the template hash' do
+          it 'must select the columns with the ailases specified' do
+            templates[:selects] = {course_id: :bar, user_id: :baz}
+            expect(filter.sql).to include "`bar` AS 'course_id'"
+            expect(filter.sql).to include "`baz` AS 'user_id'"
+          end
+        end
+
+        context 'processing the joins key of the template hash' do
+          it 'must not include any joins if the key is nil' do
+            templates[:joins] = nil
+            expect(filter.sql).to_not include 'JOIN'
+          end
+
+          it 'must apply a left join for each element in an array' do
+            templates[:joins] = [:two, :three]
+            expect(filter.sql).to include 'LEFT JOIN `two`'
+            expect(filter.sql).to include 'LEFT JOIN `three`'
+          end
+
+          it 'must apply a hash of joins using the columns supplied' do
+            templates[:joins] = {'one' => ['id', 'two_id']}
+            expect(filter.sql).to include 'LEFT JOIN `one` ON (`two`.`id` = `one`.`two_id`)'
+          end
+        end
+
+        context 'processing the where key of the template hash' do
+          it 'must not include a where clause when the key is nil' do
+            templates[:where] = nil
+            expect(filter.sql).to_not include 'WHERE'
+          end
+
+          it 'must directly apply a string SQL fragment' do
+            fragment = '`two`.`id` IS NOT NULL'
+            templates[:where] = fragment
+            expect(filter.sql).to include fragment
+          end
+        end
+      end
+
+      describe 'custom functions' do
+        it "uses :functions" do
+          templates[:selects] = { course_id: "<myfn()>" }
+          templates[:functions] = { myfn: ->(args) { "MYFN" } }
+          expect(filter.sql).to include "MYFN"
+        end
+      end
+    end
+  end
+end

data/spec/lib/bespoke/export_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Bespoke
+  describe Export do
+  end
+end

data/spec/lib/bespoke/join_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Bespoke::Join do
+  let(:join) { basic_join }
+
+  context "table 'one'" do
+    before { join.load_csv('one', fixture('one.csv')) }
+
+    it "loads csv" do
+      join.database[:one].count.should == 2
+    end
+
+    context "and table 'two'" do
+      before { join.load_csv('two', fixture('two.csv')) }
+
+      it "loads csv" do
+        join.database[:two].count.should == 3
+      end
+
+      it "joins" do
+        sql = "SELECT name, description FROM one LEFT JOIN two ON one.id = two.one_id"
+        join.query(sql).map { |row| row }.
+          should == [
+            {:name=>"bitcoin", :description=>"Cryptocurrency"},
+            {:name=>"bitcoin", :description=>"Investment"},
+            {:name=>"nxt", :description=>"Alternate Cryptocurrency"}
+          ]
+      end
+    end
+  end
+
+  describe '#database' do
+    let(:db) { join.database }
+
+    describe 'the concat_ws() function added to the database' do
+      it 'must join strings using the specified delemeter' do
+        result = db.get{ concat_ws('foo', 'bar', 'baz', '-') }
+        expect(result).to eq 'foo-bar-baz'
+      end
+
+      it 'must eliminate nulls from the args before joining' do
+        result = db.get{ concat_ws('foo', nil, 'baz', '-') }
+        expect(result).to eq 'foo-baz'
+      end
+    end
+  end
+
+  describe '#projection_named(table_name)' do
+    it 'must return the table with the specified name' do
+      table = join.projection_named 'one'
+      expect(table.opts[:from]).to eq [:one]
+    end
+
+    it 'must return nil when the projection requested does not exist' do
+      table = join.projection_named 'foos'
+      expect(table).to be_nil
+    end
+  end
+end

data/spec/lib/bespoke/projection_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module Bespoke
+  describe Projection do
+    before do
+      @projection = Projection.new(:foo)
+    end
+
+    describe '#initialize' do
+      it 'must evaluate the supplied block in the context of the new object' do
+        projection = Projection.new(:bar) do
+          field :foo, :integer
+          field :bar, :string
+          field :id, :integer, primary_key: true
+        end
+
+        foo_field = projection.fields.find{|f| f.name == :foo}
+        expect(foo_field).to_not be_nil
+
+        bar_field = projection.fields.find{|f| f.name == :bar}
+        expect(bar_field).to_not be_nil
+
+        id_field = projection.fields.find{|f| f.name == :id}
+        expect(id_field).to_not be_nil
+        expect(id_field).to be_primary_key
+      end
+
+      it 'must yeild the projdction to the block if its arity is 1' do
+        projection = Projection.new(:bar) do |p|
+          p.field :foo, :integer
+          p.field :bar, :string
+          p.field :id, :integer, primary_key: true
+        end
+
+        foo_field = projection.fields.find{|f| f.name == :foo}
+        expect(foo_field).to_not be_nil
+
+        bar_field = projection.fields.find{|f| f.name == :bar}
+        expect(bar_field).to_not be_nil
+
+        id_field = projection.fields.find{|f| f.name == :id}
+        expect(id_field).to_not be_nil
+        expect(id_field).to be_primary_key
+      end
+    end
+
+    describe '#field' do
+      it 'must add a new field to the fields array with the supplied attributes' do
+        @projection.field(:foo, :integer)
+        field = @projection.fields.last
+        expect(field.name).to eq :foo
+        expect(field.type).to eq :integer
+      end
+    end
+
+    describe '#ensure_primary_key!' do
+      it 'must raise an exception if there are no fields present' do
+        expect { @projection.ensure_primary_key! }.to raise_error Projection::NoPrimaryKeyError
+      end
+
+      context "when there is a ref_id column specified but isn't tagged as the PK" do
+        before do
+          @original_stderr = $stderr
+          $stderr = @new_stderr = StringIO.new
+          @projection.field :ref_id, :string
+          @projection.field :name, :string
+          @projection.field :birth_date, :date
+        end
+
+        after do
+          $stderr = @original_stderr
+        end
+
+        it 'must add the primary key specification to the ref_id column' do
+          @projection.ensure_primary_key!
+          ref_field = @projection.fields.find{|f| f.name == :ref_id }
+          expect(ref_field).to be_primary_key
+        end
+
+        it 'must issue a deprecation warning when setting the implied primary key' do
+          @projection.ensure_primary_key!
+          expect(@new_stderr.string).to_not be_empty
+        end
+
+        it 'must not set the primary key specification if another is already supplied' do
+          @projection.field :id, :integer, primary_key: true
+          @projection.ensure_primary_key!
+          ref_field = @projection.fields.find{|f| f.name == :ref_id }
+          expect(ref_field).to_not be_primary_key
+        end
+      end
+    end
+  end
+end

data/spec/{template_spec.rb → lib/bespoke/template_spec.rb}

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 
 describe Bespoke::Template do
   let(:projection) {
@@ -21,8 +21,8 @@ describe Bespoke::Template do
 
   it "last element is the only element where 'last' is true" do
     first = fields[0..-2].map{ |f| f[:last] }
-    first.all?{ |x| x == false }.should be_true
-    fields[-1][:last].should be_true
+    expect(first).to be_all {|item| item == false}
+    expect(fields[-1][:last]).to eq true
   end
 
   it "has optional function field" do

data/spec/lib/bespoke/typed_field_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+module Bespoke
+  describe TypedField do
+    describe '#initialize(name, type, options_or_xpath = )' do
+      context 'when passed an xpath string as the last argument' do
+        before do
+          @original_stderr = $stderr
+          $stderr = @new_stderr = StringIO.new
+          @field = TypedField.new(:foo, :integer, '/foo/bar*')
+        end
+
+        after do
+          $stderr = @original_stderr
+        end
+
+        it 'must set the xpath attribute' do
+          expect(@field.xpath).to eq '/foo/bar*'
+        end
+
+        it 'must issue a deprecation warning to stderr indicating this is a deprecated use' do
+          expect($stderr.string).to_not be_empty
+        end
+
+        it 'must set the column_options to an empty hash' do
+          expect(@field.column_options).to eq Hash.new
+        end
+      end
+
+      context 'when passed an xpath array as the last argument' do
+        before do
+          @original_stderr = $stderr
+          $stderr = @new_stderr = StringIO.new
+          @field = TypedField.new(:foo, :integer, ["sif:EmailList/sif:Email[@Type='Primary']", 'split-get-first'])
+        end
+
+        after do
+          $stderr = @original_stderr
+        end
+
+        it 'must set the xpath attribute' do
+          expect(@field.xpath).to eq ["sif:EmailList/sif:Email[@Type='Primary']", 'split-get-first']
+        end
+
+        it 'must issue a deprecation warning to stderr indicating this is a deprecated use' do
+          expect($stderr.string).to_not be_empty
+        end
+
+        it 'must set the column_options to an empty hash' do
+          expect(@field.column_options).to eq Hash.new
+        end
+      end
+
+      context ' when passed a hash as the last argument' do
+        it 'must extract the xpath from the supplied hash' do
+          field = TypedField.new(:foo, :string, xpath: '/foo/bar/baz')
+          expect(field.xpath).to eq '/foo/bar/baz'
+        end
+
+        it 'must keep the rest of the options for use by sequel in the column_options attribute' do
+          field = TypedField.new(:foo, :string, {
+            null: false,
+            unique: true,
+            xpath: '/bar/qux/flubble',
+          })
+          expect(field.column_options).to eq({null: false, unique: true})
+        end
+      end
+    end
+
+    describe '#make_primary_key!' do
+      before do
+        @field = TypedField.new(:foo, :string)
+      end
+
+      specify { expect(@field).to_not be_primary_key }
+
+      it 'must make the field indicate it is a primary key' do
+        @field.make_primary_key!
+        expect(@field).to be_primary_key
+      end
+    end
+
+    describe '#primary_key?' do
+      it 'must return false when not specified by the column options' do
+        field = TypedField.new(:foo, :string)
+        expect(field).to_not be_primary_key
+      end
+
+      it 'must return false when specified as false in the column options' do
+        field = TypedField.new(:foo, :string, primary_key: false)
+        expect(field).to_not be_primary_key
+      end
+
+      it 'must return true when specified as true in the column options' do
+        field = TypedField.new(:foo, :string, primary_key: true)
+        expect(field).to be_primary_key
+      end
+    end
+  end
+end

data/spec/{xsltproc_spec.rb → lib/bespoke/xsltproc_spec.rb}

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 
 describe Bespoke::XSLTProc do
   let(:xslt) { File.read(fixture('books_to_csv.xslt')) }

data/spec/spec_helper.rb

@@ -1,8 +1,21 @@
-$LOAD_PATH << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
+require 'pry'
+
+if ENV['CHECK_SPEC_COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
 
 require "bespoke"
 require "bespoke/dsl"
 
-def fixture(*fileparts)
-  File.join(File.dirname(__FILE__), 'fixtures', *fileparts)
+Dir.glob(File.expand_path(File.join(*%w{.. support ** *.rb}), __FILE__)).each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.include FixtureHelpers
+  config.filter_run_including focus: true
+  config.run_all_when_everything_filtered = true
 end

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,24 @@
+module FixtureHelpers
+  def fixture(*fileparts)
+    File.join(File.dirname(__FILE__), '..', 'fixtures', *fileparts)
+  end
+
+  def basic_join
+    Bespoke::Join.new(basic_projections)
+  end
+
+  def basic_projections
+    [
+      Bespoke::Projection.new(:one) {
+        field :id, :integer, primary_key: true
+        field :name, :string
+      },
+      Bespoke::Projection.new(:two) {
+        field :id, :integer, primary_key: true
+        field :one_id, :integer
+        field :description, :string
+      }
+    ]
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bespoke
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,14 +60,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: docile
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -139,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
@@ -149,9 +165,17 @@ files:
 - bespoke.gemspec
 - readme.md
 - lib/bespoke/dsl.rb
+- lib/bespoke/export/filter/function_call.rb
+- lib/bespoke/export/filter/identifier.rb
+- lib/bespoke/export/filter/select_template.rb
+- lib/bespoke/export/filter/string_literal.rb
+- lib/bespoke/export/filter.rb
+- lib/bespoke/export.rb
 - lib/bespoke/join.rb
+- lib/bespoke/mustache.rb
 - lib/bespoke/projection.rb
 - lib/bespoke/template.rb
+- lib/bespoke/typed_field.rb
 - lib/bespoke/version.rb
 - lib/bespoke/xsltproc.rb
 - lib/bespoke.rb
@@ -161,10 +185,18 @@ files:
 - spec/fixtures/sif.student_personal.xslt
 - spec/fixtures/sif.xslt.mustache
 - spec/fixtures/two.csv
-- spec/join_spec.rb
+- spec/lib/bespoke/export/filter/function_call_spec.rb
+- spec/lib/bespoke/export/filter/identifier_spec.rb
+- spec/lib/bespoke/export/filter/select_template_spec.rb
+- spec/lib/bespoke/export/filter_spec.rb
+- spec/lib/bespoke/export_spec.rb
+- spec/lib/bespoke/join_spec.rb
+- spec/lib/bespoke/projection_spec.rb
+- spec/lib/bespoke/template_spec.rb
+- spec/lib/bespoke/typed_field_spec.rb
+- spec/lib/bespoke/xsltproc_spec.rb
 - spec/spec_helper.rb
-- spec/template_spec.rb
-- spec/xsltproc_spec.rb
+- spec/support/fixture_helpers.rb
 homepage: 
 licenses: []
 post_install_message: 
@@ -196,8 +228,16 @@ test_files:
 - spec/fixtures/sif.student_personal.xslt
 - spec/fixtures/sif.xslt.mustache
 - spec/fixtures/two.csv
-- spec/join_spec.rb
+- spec/lib/bespoke/export/filter/function_call_spec.rb
+- spec/lib/bespoke/export/filter/identifier_spec.rb
+- spec/lib/bespoke/export/filter/select_template_spec.rb
+- spec/lib/bespoke/export/filter_spec.rb
+- spec/lib/bespoke/export_spec.rb
+- spec/lib/bespoke/join_spec.rb
+- spec/lib/bespoke/projection_spec.rb
+- spec/lib/bespoke/template_spec.rb
+- spec/lib/bespoke/typed_field_spec.rb
+- spec/lib/bespoke/xsltproc_spec.rb
 - spec/spec_helper.rb
-- spec/template_spec.rb
-- spec/xsltproc_spec.rb
+- spec/support/fixture_helpers.rb
 has_rdoc: