whi-cassie 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8392ef6b34920bdde8a689495610115ba637c300
-  data.tar.gz: ccf179a324199af0f1af5c81589634efc44f89a5
+SHA256:
+  metadata.gz: cc03cb8a9fdac75018c3c31a5466a681a7e57f4584c5d3c4540d012da48c8bc9
+  data.tar.gz: 7576c9d2d998329cc918cc8c7dad45eda0012d420c123b7cfb9412c82873ab24
 SHA512:
-  metadata.gz: 715926f6cead3063ea00a364c0b7f30f67c0cf81be18288a78dd16431d95d2496fa845d928afdfd3b206dea78efb6e9d45a41c943d332a138f47225066c4d5da
-  data.tar.gz: 2da40bc6fbc2c2c02594c76cc8c719c495db90a5b5983cf791e0b243bf47ce21e85d693c53398b051b4576479bb46c9467e25b60e5caac4d203266617c07ab18
+  metadata.gz: c60020caa9c11330c2c5713bbd0962cf1682f07f351815b60975b608af50031627a08c27d50e1175ffc02d44da368cc64e71f7a337164cf1dddd75da415e6dc6
+  data.tar.gz: 2690d2fb060d226a11d81cba9db78251bce6ca0a744e27ddd1975e82b2db7376bc247c58b6a1af895da0b81a2d21e1e3b6f3eda64234e52a973b3d0ce221743b

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Dependabot update strategy
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    allow:
+      # Automatically keep all runtime dependencies updated
+      - dependency-name: "*"
+        dependency-type: "production"
+    versioning-strategy: lockfile-only

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,63 @@
+name: Continuous Integration
+on:
+  push:
+    branches:
+      - master
+      - actions-*
+    tags:
+      - v*
+  pull_request:
+env:
+  BUNDLE_CLEAN: "true"
+  BUNDLE_PATH: vendor/bundle
+  BUNDLE_JOBS: 3
+  BUNDLE_RETRY: 3
+jobs:
+  specs:
+    name: ${{ matrix.job }} ruby-${{ matrix.ruby }} ${{ matrix.activemodel && format('activemodel-{0}', matrix.activemodel) }} cassandra-${{ matrix.cassandra_version }}
+    runs-on: ubuntu-latest
+    services:
+      cassandra:
+        image: cassandra:${{ matrix.cassandra_version }}
+        ports:
+          - 9042:9042
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7]
+        activemodel: [6]
+        job: [rspec]
+        cassandra_version: ["4.0"]
+        include:
+          - ruby: 2.6
+            activemodel: 5
+            job: rspec
+            cassandra_version: "3"
+          - ruby: 2.4
+            activemodel: 4
+            job: rspec
+            cassandra_version: "2"
+          - ruby: 2.7
+            job: standardrb
+            cassandra_version: "latest"
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: inject activemodel ${{ matrix.activemodel }}
+        if:   matrix.activemodel != 'original' && matrix.activemodel != null
+        run: | # inject a specific version of activemodel into the Gemfile
+          bundle update
+          bundle exec appraisal generate
+          bundle config set gemfile "gemfiles/activemodel_${{ matrix.activemodel }}.gemfile"
+      - name: install dependencies
+        run:  bundle install
+      - name: specs
+        if:   matrix.job == 'rspec'
+        run:  bundle exec rake spec
+      - name: standardrb
+        if:   matrix.job == 'standardrb'
+        run:  bundle exec rake standard

data/.gitignore

@@ -1,17 +1,6 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
 pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
 tmp
+rdoc
+*.rbc
+.tm_properties
+.DS_Store

data/.standard.yml

@@ -0,0 +1,11 @@
+# I really just have issues with the automatic "semantic blocks"
+
+ruby_version: 2.4
+
+format: progress
+
+ignore:
+  - '**/*':
+    - Standard/SemanticBlocks
+  - 'spec/**/*':
+    - Lint/UselessAssignment

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise "activemodel-6" do
+  gem "activemodel", "~> 6.0"
+end
+
+appraise "activemodel-5" do
+  gem "activemodel", "~> 5.0"
+end
+
+appraise "activemodel-4" do
+  gem "activemodel", "~> 4.0"
+end

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "appraisal"
+  gem "standard", "~>0.8.1"
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    whi-cassie (1.2.0)
+      activemodel (>= 4.0)
+      cassandra-driver (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.1)
+    cassandra-driver (3.2.5)
+      ione (~> 1.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    ione (1.2.4)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (1.0.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.10.1)
+    standard (0.8.1)
+      rubocop (= 1.0.0)
+      rubocop-performance (= 1.8.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 2.0)
+  rake
+  rspec
+  standard (~> 0.8.1)
+  whi-cassie!
+
+BUNDLED WITH
+   2.1.4

data/HISTORY.md

@@ -0,0 +1,49 @@
+## 1.2.0
+
+* Update schema queries to support Cassandra 3.x+
+* Require Ruby 2.4 or greater
+
+## 1.1.1
+* Update dependencies to support Rails 5.
+
+## 1.1.0
+
+* Bump supported version of cassandra-driver to 3.x.
+
+* Add more control over consistency settings.
+
+* Add read and write consistency on model definitions.
+
+## 1.0.7
+
+* Add find_subscribers to Cassie::Model for instrumenting model find calls.
+
+## 1.0.6
+
+* Wrap raw CQL in a Simple statement for code consistency in subscribers.
+
+## 1.0.5
+
+* Add subscribers for instumenting code.
+
+* Remove hardcoded log warnings for long running statements since this can now be better handled with instrumentation.
+
+## 1.0.4
+
+* Set less cryptic error message for invalid records exceptions.
+
+## 1.0.3
+
+* Fix bugs preventing counter and set data types from working on models.
+
+## 1.0.2
+
+* Set cluster logger on the Cassandra cluster if not already set.
+
+## 1.0.1
+
+* Allow finding the offset to the row from a range.
+
+## 1.0.0
+
+* Initial Release

data/README.md

@@ -1,3 +1,7 @@
+![Continuous Integration](https://github.com/weheartit/cassie/workflows/Continuous%20Integration/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/129ede20094ea298c687/maintainability)](https://codeclimate.com/github/weheartit/cassie/maintainability)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+
 # Cassie
 
 The short and sweet Cassandra object mapper from [We Heart It](http://weheartit.com/)
@@ -8,34 +12,34 @@ The short and sweet Cassandra object mapper from [We Heart It](http://weheartit.
 class Thing
   # Your model must include this
   include Cassie::Model
-  
+
   # Set the table name where the data lives.
   self.table_name = "things"
-  
+
   # Set the keyspace where the table lives. Keyspaces can be defined abstractly and mapped
   # and mapped in a configuration file. This can allow you to have different keyspace names
   # between different environments and still use the same code.
   self.keyspace = "default"
-  
+
   # You must defind the primary key. They columns must be listed in the order that they apper
   # in the Cassandra CQL PRIMARY KEY clause defining the table.
   self.primary_key = [:owner, :id]
-  
+
   # All columns are explicitly defined with their name and data type and an optional
   # alias name.
   column :owner, :int
   column :id, :int, :as => :identifier
   column :val, :varchar, :as => :value
-  
+
   # The ordering keys should also be defined along with how they are ordered.
   ordering_key :id, :desc
-  
+
   # You can use all the standard ActiveModel validations.
   validates_presence_of :owner, :id
-  
+
   # You also get before and after callbacks for create, update, save, and destroy.
   before_save :some_callback_method
-  
+
   ...
 end
 
@@ -83,7 +87,17 @@ You can use all the standard ActiveModel validation methods on your models. You
 Note that one difference between Cassandra and other data stores is that data is only eventually consistent. Some subtle results of this:
 
 1. You won't get an error if you try to create a record with the same primary key twice. Cassandra will simple use the second insert as an update statement.
-2. If you perform any queries in your validation logic (e.g. to ensure a value is unique), you really need to use a high consistency level like quorum. If you use a low consistency level, there is a chance that your query can hit a node in the cluster that hasn't been replicated to and your validation could make decisions based on the wrong data. You can control the consistency level on most of the query methods or you can use `Cassie.consistency` to set a default consistency within a block.
+2. If you perform any queries in your validation logic (e.g. to ensure a value is unique), you really need to use a high consistency level like quorum. If you use a low consistency level, there is a chance that your query can hit a node in the cluster that hasn't been replicated to and your validation could make decisions based on the wrong data.
+
+### Consistency
+
+You can specify the consistency for the connection when it is created in the options. This will default to `:local_one`. You can override the global consistency at runtime by setting a new consistency on the instance `Cassie.instance.consistency = :local_quorum`. This will be the default consistency used if nothing else specifies a consistency.
+
+You can override the default consistency within a block by using the `Cassie.consistency` method. This method will set the default consistency within a block and can be used in instances where you want to force a specific consistency on all queries within a specific scope.
+
+Finally, you can force a specific consistency by specifying `:consistency` in the options to any of the statements that execute a query. This consistency will override any default consistency you've specified. However, if the statement is a write statement and is wrapped in a batch block, the consistency option will have no effect. You can, though, specify the `:consistency` option in the `batch` call to apply a consistency to all statements in the batch.
+
+In `Cassie::Model` classes, you can specify `read_consistency` and `write_consistency` that will be applied to all statements generated by the model. You could use this, for instance, to force all write operations to use `:quorum` while letting all read operations user `:one`. These consistency levels will override any default levels if they are set.
 
 ### Prepared statements
 
@@ -166,13 +180,13 @@ To use it with rspec you should add this code to your spec_helper.rb file:
     end
     Cassie::Testing.prepare!
   end
-  
+
   config.after(:suite) do
     Cassie::Schema.all do |keyspace|
       Cassie::Schema.drop!(keyspace)
     end
   end
-  
+
   config.around(:each) do |example|
     Cassie::Testing.cleanup! do
       example.run
@@ -212,6 +226,11 @@ You can add instrumentation via subscribers to the `Cassie.instance`. Subscriber
 Cassie.instance.subscribers << lambda{|message| logger.warn("CQL: #{message.statement.cql} with #{message.options} took #{message.elapsed_time}s") if message.elapsed_time > 0.5 && message.statement.cql}
 ```
 
+You can instrument the finding code on your model by adding a find subscriber either to the model or to Cassie::Model. These subscribers take a block which is yielded to with the CQL, arguments, options, elapsed time, and rows returned.
+```
+Cassie::Model.find_subscribers << lambda{|message| logger.warn("CQL: #{message.cql}; Rows: #{message.rows}; Time: #{message.elapsed_time}")
+```
+
 ### Limitations
 
 Ruby 2.0 (or compatible) required.

data/Rakefile

@@ -1,18 +1,19 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
-desc 'Default: run unit tests.'
-task :default => :test
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'RVM likes to call it tests'
-task :tests => :test
+task default: :spec
 
-begin
-  require 'rspec'
-  require 'rspec/core/rake_task'
-  desc 'Run the unit tests'
-  RSpec::Core::RakeTask.new(:test)
-rescue LoadError
-  task :test do
-    STDERR.puts "You must have rspec 2.0 installed to run the tests"
+desc "run the specs using appraisal"
+task :appraisals do
+  exec "bundle exec appraisal rake spec"
+end
+
+namespace :appraisals do
+  desc "install all the appraisal gemspecs"
+  task :install do
+    exec "bundle exec appraisal install"
   end
 end

data/VERSION

@@ -1 +1 @@
-1.0.5
+1.2.0

data/gemfiles/activemodel_4.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", "~> 4.0"
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "appraisal"
+  gem "standard", "~>0.8.1"
+end
+
+gemspec path: "../"

data/gemfiles/activemodel_5.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", "~> 5.0"
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "appraisal"
+  gem "standard", "~>0.8.1"
+end
+
+gemspec path: "../"