whi-cassie 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68fe9feda088a468e88c2bc6d49b5b56a48bb590
-  data.tar.gz: 3ae674573e37aa5720d8d7bf679d17d40f843693
+SHA256:
+  metadata.gz: cc03cb8a9fdac75018c3c31a5466a681a7e57f4584c5d3c4540d012da48c8bc9
+  data.tar.gz: 7576c9d2d998329cc918cc8c7dad45eda0012d420c123b7cfb9412c82873ab24
 SHA512:
-  metadata.gz: 895d127cf90199a9f2b7d9f9d4743bd1c0772d3d1200c675531e55b485a09b9f2c950e49d963653b0ecef1db0678cf95e242b0e7c1154aa29bac147e641ed330
-  data.tar.gz: 1491b655db43141efe27587f40ffa382cddecc44715ff79628129cc021ad36683ca9fc52c3b01d6ad5eef7df0d5e3c7d5984695f99905e741632a5ae31f17276
+  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

@@ -1,3 +1,8 @@
+## 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.
 

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
 
@@ -176,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

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.1.1
+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: "../"

data/gemfiles/activemodel_6.gemfile

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

data/lib/cassie.rb

@@ -1,4 +1,6 @@
-require 'cassandra'
+# frozen_string_literal: true
+
+require "cassandra"
 
 # This class provides a lightweight wrapper around the Cassandra driver. It provides
 # a foundation for maintaining a connection and constructing CQL statements.
@@ -9,35 +11,35 @@ class Cassie
   require File.expand_path("../cassie/schema.rb", __FILE__)
   require File.expand_path("../cassie/testing.rb", __FILE__)
   require File.expand_path("../cassie/railtie.rb", __FILE__) if defined?(Rails)
-  
+
   class RecordNotFound < StandardError
   end
-  
+
   class RecordInvalid < StandardError
     attr_reader :record
-    
+
     def initialize(record)
       super("Errors on #{record.class.name}: #{record.errors.to_hash.inspect}")
       @record = record
     end
   end
-  
+
   # Message passed to subscribers with the statement, options, and time for each statement
   # to execute. Note that if statements are batched they will be packed into one message
   # with a Cassandra::Statements::Batch statement and empty options.
   class Message
     attr_reader :statement, :options, :elapsed_time
-    
+
     def initialize(statement, options, elapsed_time)
       @statement = statement
       @options = options
       @elapsed_time = elapsed_time
     end
   end
-  
+
   attr_reader :config, :subscribers
   attr_accessor :consistency
-  
+
   class << self
     # A singleton instance that can be shared to communicate with a Cassandra cluster.
     def instance
@@ -47,7 +49,7 @@ class Cassie
       end
       @instance
     end
-    
+
     # Call this method to load the Cassie::Config from the specified file for the
     # specified environment.
     def configure!(options)
@@ -58,7 +60,7 @@ class Cassie
       end
       @config = Cassie::Config.new(options)
     end
-    
+
     # This method can be used to set a consistency level for all Cassandra queries
     # within a block that don't explicitly define them. It can be used where consistency
     # is important (i.e. on validation queries) but where a higher level method
@@ -72,18 +74,16 @@ class Cassie
         Thread.current[:cassie_consistency] = save_val
       end
     end
-    
+
     # Get a Logger compatible object if it has been set.
     def logger
       @logger if defined?(@logger)
     end
-    
+
     # Set a logger with a Logger compatible object.
-    def logger=(value)
-      @logger = value
-    end
+    attr_writer :logger
   end
-  
+
   def initialize(config)
     @config = config
     @monitor = Monitor.new
@@ -93,14 +93,14 @@ class Cassie
     @subscribers = Subscribers.new
     @consistency = ((config.cluster || {})[:consistency] || :local_one)
   end
-  
+
   # Open a connection to the Cassandra cluster.
   def connect
     start_time = Time.now
     cluster_config = config.cluster
-    cluster_config = cluster_config.merge(:logger => logger) if logger
+    cluster_config = cluster_config.merge(logger: logger) if logger
     cluster = Cassandra.cluster(cluster_config)
-    logger.info("Cassie.connect with #{config.sanitized_cluster} in #{((Time.now - start_time) * 1000).round}ms") if logger
+    logger&.info("Cassie.connect with #{config.sanitized_cluster} in #{((Time.now - start_time) * 1000).round}ms")
     @monitor.synchronize do
       @session = cluster.connect(config.default_keyspace)
       @prepared_statements = {}
@@ -109,19 +109,19 @@ class Cassie
 
   # Close the connections to the Cassandra cluster.
   def disconnect
-    logger.info("Cassie.disconnect from #{config.sanitized_cluster}") if logger
+    logger&.info("Cassie.disconnect from #{config.sanitized_cluster}")
     @monitor.synchronize do
-      @session.close if @session
+      @session&.close
       @session = nil
       @prepared_statements = {}
     end
   end
-  
+
   # Return true if the connection to the Cassandra cluster has been established.
   def connected?
     !!@session
   end
-  
+
   # Force reconnection. If you're using this code in conjunction in a forking server environment
   # like passenger or unicorn you should call this method after forking.
   def reconnect
@@ -150,13 +150,13 @@ class Cassie
         end
       end
     end
-    
+
     if cache_filled_up && logger && Time.now > @last_prepare_warning + 10
       # Set a throttle on how often this message is logged so we don't kill performance enven more.
       @last_prepare_warning = Time.now
       logger.warn("Cassie.prepare cache filled up. Consider increasing the size from #{config.max_prepared_statements}.")
     end
-    
+
     statement
   end
 
@@ -210,22 +210,22 @@ class Cassie
     columns = []
     values = []
     values_hash.each do |column, value|
-      if !value.nil?
+      unless value.nil?
         columns << column
         values << value
       end
     end
-    cql = "INSERT INTO #{table} (#{columns.join(', ')}) VALUES (#{question_marks(columns.size)})"
-    
-    if options && options.include?(:ttl)
+    cql = "INSERT INTO #{table} (#{columns.join(", ")}) VALUES (#{question_marks(columns.size)})"
+
+    if options&.include?(:ttl)
       options = options.dup
       ttl = options.delete(:ttl)
       if ttl
-        cql << " USING TTL ?"
+        cql += " USING TTL ?"
         values << Integer(ttl)
       end
     end
-    
+
     batch_or_execute(cql, values, options)
   end
 
@@ -248,20 +248,20 @@ class Cassie
       end
     end
     values = update_values + key_values
-    
+
     cql = "UPDATE #{table}"
-    
-    if options && options.include?(:ttl)
+
+    if options&.include?(:ttl)
       options = options.dup
       ttl = options.delete(:ttl)
       if ttl
-        cql << " USING TTL ?"
+        cql += " USING TTL ?"
         values.unshift(Integer(ttl))
       end
     end
 
-    cql << " SET #{update_cql.join(', ')} WHERE #{key_cql}"
-    
+    cql += " SET #{update_cql.join(", ")} WHERE #{key_cql}"
+
     batch_or_execute(cql, values, options)
   end
 
@@ -281,31 +281,31 @@ class Cassie
     start_time = Time.now
     begin
       statement = nil
-      if cql.is_a?(String)
+      statement = if cql.is_a?(String)
         if values.present?
-          statement = prepare(cql)
+          prepare(cql)
         else
-          statement = Cassandra::Statements::Simple.new(cql)
+          Cassandra::Statements::Simple.new(cql)
         end
       else
-        statement = cql
+        cql
       end
-    
+
       if values.present?
         values = Array(values)
-        options = (options ? options.merge(:arguments => values) : {:arguments => values})
+        options = (options ? options.merge(arguments: values) : {arguments: values})
       end
-    
+
       # Set a default consistency from a block context if it isn't explicitly set.
       statement_consistency = current_consistency
       if statement_consistency
         if options
-          options = options.merge(:consistency => statement_consistency) if options[:consistency].nil?
+          options = options.merge(consistency: statement_consistency) if options[:consistency].nil?
         else
-          options = {:consistency => statement_consistency}
+          options = {consistency: statement_consistency}
         end
       end
-      
+
       session.execute(statement, options || {})
     rescue Cassandra::Errors::IOError => e
       disconnect
@@ -313,18 +313,18 @@ class Cassie
     ensure
       if statement.is_a?(Cassandra::Statement) && !subscribers.empty?
         payload = Message.new(statement, options, Time.now - start_time)
-        subscribers.each{|subscriber| subscriber.call(payload)}
+        subscribers.each { |subscriber| subscriber.call(payload) }
       end
     end
   end
-  
+
   # Return the current consistency level that has been set for statements.
   def current_consistency
     Thread.current[:cassie_consistency] || consistency
   end
 
   private
-  
+
   def logger
     self.class.logger
   end
@@ -333,7 +333,7 @@ class Cassie
     connect unless connected?
     @session
   end
-  
+
   def batch_or_execute(cql, values, options = nil)
     batch = Thread.current[:cassie_batch]
     if batch
@@ -345,9 +345,7 @@ class Cassie
   end
 
   def question_marks(size)
-    q = '?'
-    (size - 1).times{ q << ',?' }
-    q
+    "?#{",?" * (size - 1)}"
   end
 
   def key_clause(key_hash)
@@ -357,9 +355,9 @@ class Cassie
       cql << "#{key} = ?"
       values << value
     end
-    [cql.join(' AND '), values]
+    [cql.join(" AND "), values]
   end
-  
+
   # Extract the CQL from a statement
   def statement_cql(statement, previous = nil)
     cql = nil
@@ -368,7 +366,7 @@ class Cassie
     elsif statement.respond_to?(:statements) && (previous.nil? || !previous.include?(statement))
       previous ||= []
       previous << statement
-      cql = statement.statements.collect{|s| statement_cql(s, previous)}.join('; ')
+      cql = statement.statements.collect { |s| statement_cql(s, previous) }.join("; ")
     end
     cql
   end