relation_to_struct 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f14569badb2ed3049d91f233ebc208c09bef0251
-  data.tar.gz: 3513ef3efd8d057645db818927a1939338e75f17
+  metadata.gz: 38b9e2235461124930a00545c8f280a149e720e2
+  data.tar.gz: e554b29f4b015da645780962aa44985d751ec177
 SHA512:
-  metadata.gz: 87b088344c4b07d36ef607bd145a6a4480b6397e07c47b3495e40462d7bf9a4ac564e4590d4addd01deae8353c7abd757ac60fbdd5ded1b2a22e3e71355fa37e
-  data.tar.gz: 70b3761d903aee08b8a36a3fd16dc53b8bfb416b23dc8445e26421d38ec289d9e6cc548f1dcda139fba0be407f12a4d90aaccb1632d142394a83954d3815818b
+  metadata.gz: 60d4d55c08833a5c9f875d06df49c307d192f5ea11985201222ecc42a8fdc5b638ca750dfd89767c8add0f5a5b33e4af47e3d4b1b80b032cf75983ffef1448de
+  data.tar.gz: acb30ead089b288b26f417cd985f2da323e95fd996da0a0c3ceca85d83ff123836a6d4480cd6e406dead496e13e1d9992d2797d996a3099c78b8d7d43d13f9d0

data/README.md

@@ -20,13 +20,36 @@ Or install it yourself as:
 
     $ gem install relation_to_struct
 
-## Usage
+## Examples
 
-TODO: Write usage instructions here
+You can query either via direct SQL or from an ActiveRecord relation.
+
+### From an existing relation
+
+```
+UserPostsSummary = Struct.new(:user_name, :post_count)
+relation = User.joins(:blog_posts).where(name: 'Hayek').group('users.id').select('users.name, COUNT(blog_posts.id)')
+relation.to_structs(UserPostsSummary) # => array of structs
+```
+
+### From raw SQL
+
+```
+UserPostsSummary = Struct.new(:user_name, :post_count)
+sql = <<-eos
+  SELECT users.name, COUNT(blog_posts.id)
+  FROM users
+  LEFT OUTER JOIN blog_posts ON blog_posts.user_id = users.id
+  GROUP BY users.id
+eos
+
+ActiveRecord::Base.structs_from_sql(UserPostsSummary, sql) # => array of structs
+ActiveRecord::Base.pluck_from_sql(sql) # => array of tuples
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/relation_to_struct/fork )
+1. Fork it ( https://github.com/jcoleman/relation_to_struct/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/relation_to_struct/active_record_base_extension.rb

@@ -5,12 +5,12 @@ module RelationToStruct::ActiveRecordBaseExtension
     def structs_from_sql(struct_class, sql, binds=[])
       result = connection.select_all(sanitize_sql(sql, nil), "Structs SQL Load", binds)
 
-      if result.columns.size != struct_class.members.size
-        raise ArgumentError, 'Expected struct fields and columns lengths to be equal'
+      if result.columns.size != result.columns.uniq.size
+        raise ArgumentError, 'Expected column names to be unique'
       end
 
-      if result.columns.size != result.column_types.size
-        raise ArgumentError, 'Expected unique column names count and column count to be equal'
+      if result.columns != struct_class.members.collect(&:to_s)
+        raise ArgumentError, 'Expected column names (and their order) to match struct attribute names'
       end
 
       if result.columns.size == 1

data/lib/relation_to_struct/active_record_relation_extension.rb

@@ -11,8 +11,8 @@ module RelationToStruct::ActiveRecordRelationExtension
       raise ArgumentError, 'Expected struct fields and columns lengths to be equal'
     end
 
-    if result.columns.size != result.column_types.size
-      raise ArgumentError, 'Expected unique column names count and column count to be equal'
+    if result.columns.size != result.columns.uniq.size
+      raise ArgumentError, 'Expected column names to be unique'
     end
 
     result.cast_values(klass.column_types)

data/lib/relation_to_struct/version.rb

@@ -1,3 +1,3 @@
 module RelationToStruct
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/spec/active_record_base_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe RelationToStruct do
+  before(:each) do
+    Economist.delete_all
+    EconomicSchool.delete_all
+  end
+
+  it 'ActiveRecord::Base should respond to :structs_from_sql' do
+    expect(ActiveRecord::Base.respond_to?(:structs_from_sql)).to eq(true)
+  end
+
+  it 'should allow querying with SQL directly' do
+    test_struct = Struct.new(:number)
+    sql = "SELECT 1 * 23 AS number"
+    expect(ActiveRecord::Base.structs_from_sql(test_struct, sql)).to eq([test_struct.new(23)])
+  end
+
+  it 'should allow plucking with SQL directly' do
+    sql = "SELECT 1 * 23"
+    expect(ActiveRecord::Base.pluck_from_sql(sql)).to eq([23])
+  end
+
+  it 'should allow plucking multiple columns with SQL directly' do
+    sql = "SELECT 1 * 23, 25"
+    expect(ActiveRecord::Base.pluck_from_sql(sql)).to eq([[23, 25]])
+  end
+
+  it 'structs_from_sql should properly cast a single array column' do
+    Economist.create!(name: 'F.A. Hayek')
+    Economist.create!(name: 'Ludwig von Mises')
+
+    pluck_results = Economist.select('name').order('id').limit(1).pluck('array[name]') rescue nil
+    if pluck_results
+      expect(pluck_results).to eq([['F.A. Hayek']]) # Verify ActiveRecord interface.
+
+      test_struct = Struct.new(:names)
+      structs_results = ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT ARRAY_AGG(name ORDER BY id) AS names FROM economists')
+      expect(structs_results.first.names).to eq(['F.A. Hayek', 'Ludwig von Mises'])
+    else
+      skip "DB selection doesn't support ARRAY[]"
+    end
+  end
+
+  it 'structs_from_sql should raise an error when column count does not match struct size' do
+    expect do
+      test_struct = Struct.new(:id, :name, :extra_field)
+      ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT id, name FROM economists')
+    end.to raise_error(ArgumentError, 'Expected column names (and their order) to match struct attribute names')
+  end
+
+  it 'structs_from_sql should raise an error when column names are not unique' do
+    expect do
+      test_struct = Struct.new(:id, :id2)
+      ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT id, id FROM economists')
+    end.to raise_error(ArgumentError, 'Expected column names to be unique')
+  end
+
+  it 'structs_from_sql should raise an error when the column names do not match the struct attribute names' do
+    Economist.create!(name: 'F.A. Hayek')
+    expect do
+      test_struct = Struct.new(:value_a, :value_b)
+      ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT 1 AS value_a, 2 AS value_b FROM economists')
+    end.not_to raise_error
+
+    expect do
+      test_struct = Struct.new(:value_a, :value_b)
+      ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT 1 AS value_b, 2 AS value_a FROM economists')
+    end.to raise_error(ArgumentError, 'Expected column names (and their order) to match struct attribute names')
+
+    expect do
+      test_struct = Struct.new(:value_a, :value_b)
+      ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT 1 AS value_a, 2 AS value_c FROM economists')
+    end.to raise_error(ArgumentError, 'Expected column names (and their order) to match struct attribute names')
+  end
+end

data/spec/active_record_relation_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe RelationToStruct do
+  before(:each) do
+    Economist.delete_all
+    EconomicSchool.delete_all
+  end
+
+  it 'should respond to :to_structs' do
+    expect(Economist.all.respond_to?(:to_structs)).to eq(true)
+  end
+
+  it '#to_structs should raise an error when the relation has no select_values' do
+    expect do
+      Economist.all.to_structs(Struct.new(:test_struct))
+    end.to raise_error
+  end
+
+  it '#to_structs should return an empty array when no results are returned' do
+    expect(Economist.where('1 = 0').select(:id).to_structs(Struct.new(:test_struct))).to eq([])
+  end
+
+  it '#to_structs should return an array with struct instances' do
+    hayek = Economist.create!(name: 'F.A. Hayek')
+    id_struct = Struct.new(:id)
+    expect(Economist.all.select(:id).to_structs(id_struct)).to eq([id_struct.new(hayek.id)])
+  end
+
+  it '#to_structs should handle joined elements properly' do
+    austrian = EconomicSchool.create!(name: 'Austrian Economics')
+    hayek = Economist.create!(name: 'F.A. Hayek', economic_school: austrian)
+    test_struct = Struct.new(:name, :school)
+    expect(
+      Economist
+        .joins(:economic_school)
+        .select('economists.name', 'economic_schools.name as school_name')
+        .to_structs(test_struct)
+    ).to eq([test_struct.new(hayek.name, austrian.name)])
+  end
+
+  it '#to_structs should properly cast values from arbitrary calculated columns' do
+    hayek = Economist.create!(name: 'F.A. Hayek')
+    scope = Economist.all
+    pluck_results = scope.pluck("date('now')")
+    pluck_column_klass = pluck_results.first.class
+
+    date_struct = Struct.new(:date)
+    struct_scope = scope.select("date('now')")
+    structs_results = struct_scope.to_structs(date_struct)
+    struct_column_klass = structs_results.first.date.class
+    expect(pluck_column_klass).to eq(struct_column_klass)
+  end
+
+  it '#to_structs should properly cast a single array column' do
+    Economist.create!(name: 'F.A. Hayek')
+
+    pluck_results = Economist.select('name').pluck('array[name]') rescue nil
+    if pluck_results
+      expect(pluck_results).to eq([['F.A. Hayek']]) # Verify ActiveRecord interface.
+
+      test_struct = Struct.new(:names)
+      structs_results = Economist.select('array[name]').to_structs(test_struct)
+      expect(structs_results.first.names).to eq(['F.A. Hayek'])
+    else
+      skip "DB selection doesn't support ARRAY[]"
+    end
+  end
+
+  it '#to_structs should raise an error when column count does not match struct size' do
+    expect do
+      test_struct = Struct.new(:id, :name, :extra_field)
+      Economist.select('id, name').to_structs(test_struct)
+    end.to raise_error(ArgumentError, 'Expected struct fields and columns lengths to be equal')
+  end
+
+  it '#to_structs should raise an error when column names are not unique' do
+    expect do
+      test_struct = Struct.new(:id, :id2)
+      Economist.select('id, id').to_structs(test_struct)
+    end.to raise_error(ArgumentError, 'Expected column names to be unique')
+  end
+end

data/spec/relation_to_struct_spec.rb

@@ -1,144 +1,7 @@
 require 'spec_helper'
 
 describe RelationToStruct do
-  before(:each) do
-    Economist.delete_all
-    EconomicSchool.delete_all
-  end
-
   it 'has a version number' do
     expect(RelationToStruct::VERSION).not_to be nil
   end
-
-  describe 'relation' do
-    it 'should respond to :to_structs' do
-      expect(Economist.all.respond_to?(:to_structs)).to eq(true)
-    end
-
-    it 'should respond to :to_structs' do
-      pending 'next version'
-    end
-
-    it '#to_structs should raise an error when the relation has no select_values' do
-      expect do
-        Economist.all.to_structs(Struct.new(:test_struct))
-      end.to raise_error
-    end
-
-    it '#to_structs should return an empty array when no results are returned' do
-      expect(Economist.where('1 = 0').select(:id).to_structs(Struct.new(:test_struct))).to eq([])
-    end
-
-    it '#to_structs should return an array with struct instances' do
-      hayek = Economist.create!(name: 'F.A. Hayek')
-      id_struct = Struct.new(:id)
-      expect(Economist.all.select(:id).to_structs(id_struct)).to eq([id_struct.new(hayek.id)])
-    end
-
-    it '#to_structs should handle joined elements properly' do
-      austrian = EconomicSchool.create!(name: 'Austrian Economics')
-      hayek = Economist.create!(name: 'F.A. Hayek', economic_school: austrian)
-      test_struct = Struct.new(:name, :school)
-      expect(
-        Economist
-          .joins(:economic_school)
-          .select('economists.name', 'economic_schools.name as school_name')
-          .to_structs(test_struct)
-      ).to eq([test_struct.new(hayek.name, austrian.name)])
-    end
-
-    it '#to_structs should properly cast values from arbitrary calculated columns' do
-      hayek = Economist.create!(name: 'F.A. Hayek')
-      scope = Economist.all
-      pluck_results = scope.pluck("date('now')")
-      pluck_column_klass = pluck_results.first.class
-
-      date_struct = Struct.new(:date)
-      struct_scope = scope.select("date('now')")
-      structs_results = struct_scope.to_structs(date_struct)
-      struct_column_klass = structs_results.first.date.class
-      expect(pluck_column_klass).to eq(struct_column_klass)
-    end
-
-    it '#to_structs should properly cast a single array column' do
-      Economist.create!(name: 'F.A. Hayek')
-
-      pluck_results = Economist.select('name').pluck('array[name]') rescue nil
-      if pluck_results
-        expect(pluck_results).to eq([['F.A. Hayek']]) # Verify ActiveRecord interface.
-
-        test_struct = Struct.new(:names)
-        structs_results = Economist.select('array[name]').to_structs(test_struct)
-        expect(structs_results.first.names).to eq(['F.A. Hayek'])
-      else
-        skip "DB selection doesn't support ARRAY[]"
-      end
-    end
-
-    it '#to_structs should raise an error when column count does not match struct size' do
-      expect do
-        test_struct = Struct.new(:id, :name, :extra_field)
-        Economist.select('id, name').to_structs(test_struct)
-      end.to raise_error(ArgumentError, 'Expected struct fields and columns lengths to be equal')
-    end
-
-    it '#to_structs should raise an error when column_type count does not match the column count' do
-      expect do
-        test_struct = Struct.new(:id, :id2)
-        Economist.select('id, id').to_structs(test_struct)
-      end.to raise_error(ArgumentError, 'Expected unique column names count and column count to be equal')
-    end
-  end
-
-  describe 'non-model specific querying' do
-    it 'ActiveRecord::Base should respond to :structs_from_sql' do
-      expect(ActiveRecord::Base.respond_to?(:structs_from_sql)).to eq(true)
-    end
-
-    it 'should allow querying with SQL directly' do
-      test_struct = Struct.new(:number)
-      sql = "SELECT 1 * 23"
-      expect(ActiveRecord::Base.structs_from_sql(test_struct, sql)).to eq([test_struct.new(23)])
-    end
-
-    it 'should allow plucking with SQL directly' do
-      sql = "SELECT 1 * 23"
-      expect(ActiveRecord::Base.pluck_from_sql(sql)).to eq([23])
-    end
-
-    it 'should allow plucking multiple columns with SQL directly' do
-      sql = "SELECT 1 * 23, 25"
-      expect(ActiveRecord::Base.pluck_from_sql(sql)).to eq([[23, 25]])
-    end
-
-    it 'structs_from_sql should properly cast a single array column' do
-      Economist.create!(name: 'F.A. Hayek')
-      Economist.create!(name: 'Ludwig von Mises')
-
-      pluck_results = Economist.select('name').order('id').limit(1).pluck('array[name]') rescue nil
-      if pluck_results
-        expect(pluck_results).to eq([['F.A. Hayek']]) # Verify ActiveRecord interface.
-
-        test_struct = Struct.new(:names)
-        structs_results = ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT ARRAY_AGG(name ORDER BY id) FROM economists')
-        expect(structs_results.first.names).to eq(['F.A. Hayek', 'Ludwig von Mises'])
-      else
-        skip "DB selection doesn't support ARRAY[]"
-      end
-    end
-
-    it 'structs_from_sql should raise an error when column count does not match struct size' do
-      expect do
-        test_struct = Struct.new(:id, :name, :extra_field)
-        ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT id, name FROM economists')
-      end.to raise_error(ArgumentError, 'Expected struct fields and columns lengths to be equal')
-    end
-
-    it 'structs_from_sql should raise an error when column_type count does not match the column count' do
-      expect do
-        test_struct = Struct.new(:id, :id2)
-        ActiveRecord::Base.structs_from_sql(test_struct, 'SELECT id, id FROM economists')
-      end.to raise_error(ArgumentError, 'Expected unique column names count and column count to be equal')
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relation_to_struct
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - James Coleman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,10 +140,12 @@ files:
 - lib/relation_to_struct/active_record_relation_extension.rb
 - lib/relation_to_struct/version.rb
 - relation_to_struct.gemspec
+- spec/active_record_base_spec.rb
 - spec/active_record_helper/economic_school.rb
 - spec/active_record_helper/economist.rb
 - spec/active_record_helper/schema.rb
 - spec/active_record_helper/setup.rb
+- spec/active_record_relation_spec.rb
 - spec/relation_to_struct_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -166,14 +168,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Return struct results from ActiveRecord relation queries
 test_files:
+- spec/active_record_base_spec.rb
 - spec/active_record_helper/economic_school.rb
 - spec/active_record_helper/economist.rb
 - spec/active_record_helper/schema.rb
 - spec/active_record_helper/setup.rb
+- spec/active_record_relation_spec.rb
 - spec/relation_to_struct_spec.rb
 - spec/spec_helper.rb
+has_rdoc: