cequel 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ca34779c245ed3e27bb1e4a848d6339e24fb3b
-  data.tar.gz: 0a05736a716c5cd814cdf2023bd839638cda5295
+  metadata.gz: a7ff155091be0d5464305a705c0ec81c48f43b63
+  data.tar.gz: 6ddea2f0ae77a64b050cb77d44ead1970b3b1fec
 SHA512:
-  metadata.gz: d57a0397a6b72febadce5c620605d65f55e63b37825564fd55e5fc1131178ee59a65112fcc0ea3957da877116b47afb7db431b27180978c3edf1dc40165c4ed9
-  data.tar.gz: ab9cc098f8b0ed157f513ded783d523975703f779296f5b68ce3dd3e62715292f602c5da9e9c6ca60a8adada1432eadfa7eed29ca1b30837eedae18155ccd914
+  metadata.gz: dc693f1b953c426aaac6b65d51f5ae7038933d8040efe7272733f809784522a60b5575ff3fb9744f2f69c1a51f9c5348eb7195e9a4149faa1ad6f0a8c827e4ce
+  data.tar.gz: b91aee5ec4d83c483a733cac281d1b1c91ac326f63f3b44a95458707edade557420ffcdcd1cd7018421d02504ea8861e585c0e516ad589c426469014664f1912

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.10.0
+
+* `:foreign_key` option for belongs_to associations
+  ([PR 287](https://github.com/cequel/cequel/pull/287))
+* `:client_compression` option in cequel.yaml
+  ([PR 304](https://github.com/cequel/cequel/pull/304))
+
 ## 1.9.1
 
 * fix dirty checking for timestamps more precise than Cassandra can store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cequel (1.9.1)
+    cequel (1.10.0)
       activemodel (~> 4.0)
       cassandra-driver (~> 2.0)
 

data/README.md

@@ -83,6 +83,9 @@ The `auto` option for the `key` declaration means Cequel will initialize new
 records with a UUID already generated. This option is only valid for `:uuid` and
 `:timeuuid` key columns.
 
+The `belongs_to` association accepts a `:foreign_key` option which allows you to
+specify the attribute used as the partition key.
+
 Note that the `belongs_to` declaration must come *before* the `key` declaration.
 This is because `belongs_to` defines the
 [partition key](http://www.datastax.com/documentation/cql/3.0/webhelp/index.html#cql/ddl/../../cassandra/glossary/gloss_glossary.html#glossentry_dhv_s24_bk); the `id` column is
@@ -382,6 +385,20 @@ Post.consistency(:one).find_each { |post| puts post.title }
 
 Both read and write consistency default to `QUORUM`.
 
+### Compression ###
+
+Cassandra supports [frame compression](http://datastax.github.io/ruby-driver/features/#compression),
+which can give you a performance boost if your requests or responses are big. To enable it you can 
+specify `client_compression` to use in cequel.yaml.
+
+```yaml
+development:
+  host: '127.0.0.1'
+  port: 9042
+  keyspace: Blog
+  client_compression: :lz4
+```
+
 ### ActiveModel Support ###
 
 Cequel supports ActiveModel functionality, such as callbacks, validations,

data/lib/cequel/metal/keyspace.rb

@@ -32,6 +32,8 @@ module Cequel
       attr_reader :credentials
       # @return [Hash] SSL Configuration options
       attr_reader :ssl_config
+      # @return [Symbol] The client compression option
+      attr_reader :client_compression
 
       #
       # @!method write(statement, *bind_vars)
@@ -139,6 +141,7 @@ module Cequel
 
         @name = configuration[:keyspace]
         @default_consistency = configuration[:default_consistency].try(:to_sym)
+        @client_compression = configuration[:client_compression].try(:to_sym)
 
         # reset the connections
         clear_active_connections!
@@ -284,6 +287,7 @@ module Cequel
         {hosts: hosts, port: port}.tap do |options|
           options.merge!(credentials) if credentials
           options.merge!(ssl_config) if ssl_config
+          options.merge!(compression: client_compression) if client_compression
         end
       end
 

data/lib/cequel/record/associations.rb

@@ -108,14 +108,16 @@ module Cequel
                  "belongs_to association must be declared before declaring " \
                  "key(s)"
           end
-          
+
           key_options = options.extract!(:partition)
 
           self.parent_association =
             BelongsToAssociation.new(self, name.to_sym, options)
 
-          parent_association.association_key_columns.each do |column|
-            key :"#{name}_#{column.name}", column.type, key_options
+          parent_association.association_key_columns.each_with_index do |column, i|
+            foreign_key_parts = self.parent_association.foreign_keys
+            foreign_key = foreign_key_parts.any? ? foreign_key_parts[i] : "#{name}_#{column.name}"
+            key foreign_key.to_sym, column.type, key_options
           end
           def_parent_association_accessors
         end

data/lib/cequel/record/belongs_to_association.rb

@@ -17,6 +17,8 @@ module Cequel
       attr_reader :name
       # @return [String] name of parent class
       attr_reader :association_class_name
+      # @return [Array] array of foreign key symbols
+      attr_reader :foreign_keys
 
       # @!attribute [r] association_key_columns
       #   @return [Array<Schema::Column>] key columns on the parent class
@@ -31,8 +33,9 @@ module Cequel
       # @api private
       #
       def initialize(owner_class, name, options = {})
-        options.assert_valid_keys(:class_name)
+        options.assert_valid_keys(:class_name, :foreign_key)
 
+        @foreign_keys = Array(options.fetch(:foreign_key, [])).map { |x| x.to_sym }
         @owner_class, @name = owner_class, name.to_sym
         @association_class_name =
           options.fetch(:class_name, @name.to_s.classify)

data/lib/cequel/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Cequel
   # The current version of the library
-  VERSION = '1.9.1'
+  VERSION = '1.10.0'
 end

data/spec/examples/metal/keyspace_spec.rb

@@ -104,6 +104,18 @@ describe Cequel::Metal::Keyspace do
     end
   end
 
+  describe "#client_compression" do
+    let(:client_compression) { :lz4 }
+    let(:connect) do
+      Cequel.connect host: Cequel::SpecSupport::Helpers.host,
+          port: Cequel::SpecSupport::Helpers.port,
+          client_compression: client_compression
+    end
+    it "client compression settings get extracted correctly for sending to cluster" do
+      expect(connect.client_compression).to eq client_compression
+    end
+  end
+
   describe "#execute" do
     let(:statement) { "SELECT id FROM posts" }
 

data/spec/examples/record/associations_spec.rb

@@ -186,6 +186,51 @@ describe Cequel::Record::Associations do
       end
     end
 
+    context 'with foreign_key option' do
+      model :Parent do
+        key :parent_id, :uuid, auto: true
+        column :name, :text
+        has_many :children, class_name: 'Child'
+      end
+
+      model :Child do
+        belongs_to :parent, partition: true, foreign_key: [:parent_id]
+        key :child_id, :uuid, auto: true
+        column :name, :text
+      end
+
+      it "should add parent's keys as first keys" do
+        expect(Child.key_column_names.first(2)).to eq([:parent_id, :child_id])
+      end
+
+      it "should add parent's keys as partition keys" do
+        expect(Child.partition_key_column_names).to eq([:parent_id])
+      end
+
+      context 'with multiple foreign_keys' do
+        model :Foo do
+          key :account_id, :uuid, auto: true
+          key :parent_id, :uuid, auto: true
+          column :name, :text
+          has_many :children, class_name: 'Child'
+        end
+
+        model :Bar do
+          belongs_to :foo, partition: true, foreign_key: [:account_id, :parent_id]
+          key :child_id, :uuid, auto: true
+          column :name, :text
+        end
+
+        it "should add parent's keys as first keys" do
+          expect(Bar.key_column_names).to eq([:account_id, :parent_id, :child_id])
+        end
+
+        it "should add parent's keys as partition keys" do
+          expect(Bar.partition_key_column_names).to eq([:account_id, :parent_id])
+        end
+      end
+    end
+
   end
 
   describe '::has_many' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cequel
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Mat Brown
@@ -29,7 +29,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel