orm_adapter-cequel 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0715546dcf2c15587035b28d0ef9503c9b37701
+  data.tar.gz: 06a2ec17fba0eafac9ceb751da34b350afd5bdf3
+SHA512:
+  metadata.gz: aa6af41e99ba6ef4ac3b7e7b9deb14340d404b275fcf045556a42a80e4e06b1bf039bc8cbfacc3b75033437b1b7b2b87db82d74c2ef35154347a7d6f03eb8eb4
+  data.tar.gz: 2404ea503cfa0a3a4ed7d5a6e6789ab561dc63189a92b91a774374bf88e07eaf82b45a57c3fb2e69093b58e89540721adc97b18c4382e2d28e2ee327357aaaf8

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in orm_adapter-cequel.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    orm_adapter-cequel (1.0.0)
+      cequel (~> 1.0)
+      orm_adapter (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    ast (1.1.0)
+    atomic (1.1.14)
+    builder (3.1.4)
+    cassandra-cql (1.2.2)
+      simple_uuid (>= 0.2.0)
+      thrift_client (>= 0.7.1, < 0.9)
+    cequel (1.0.0)
+      activemodel
+      activesupport (>= 3.1)
+      cassandra-cql (~> 1.2)
+      connection_pool (~> 1.1)
+      i18n
+    coderay (1.1.0)
+    connection_pool (1.2.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    orm_adapter (0.5.0)
+    parser (2.1.4)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    rubocop (0.18.0)
+      json (>= 1.7.7, < 2)
+      parser (~> 2.1.3)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+    simple_uuid (0.4.0)
+    slop (3.4.7)
+    thread_safe (0.1.3)
+      atomic
+    thrift (0.8.0)
+    thrift_client (0.8.4)
+      thrift (~> 0.8.0)
+    tzinfo (0.3.38)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  orm_adapter-cequel!
+  pry
+  rake
+  rspec
+  rubocop
+  yard

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mat Brown
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# OrmAdapter::Cequel
+
+A plugin for [OrmAdapter](https://github.com/ianwhite/orm_adapter) adding
+support for the [Cequel](https://github.com/cequel/cequel) Cassandra ORM.
+
+## Usage
+
+The primary audience of this library is library developers who want a
+consistent interface to various ORMs. You probably don't need to add this to
+your application directly.
+
+## Supported features
+
+This adapter supports all OrmAdapter features except for the `:order` and
+`:offset` options for the `#find_first` and `#find_every` methods.
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,68 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rubocop/rake_task'
+require File.expand_path('../lib/orm_adapter-cequel/version', __FILE__)
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :release
+task :release => [
+  :rubocop,
+  :"test:concise",
+  :build,
+  :tag,
+  :update_stable,
+  :push,
+  :cleanup
+]
+
+desc 'Build gem'
+task :build do
+  system 'gem build orm_adapter-cequel.gemspec'
+end
+
+desc 'Create git release tag'
+task :tag do
+  system "git tag -a -m 'Version #{OrmAdapterCequel::VERSION}' #{OrmAdapterCequel::VERSION}"
+  system "git push origin #{OrmAdapterCequel::VERSION}:#{OrmAdapterCequel::VERSION}"
+end
+
+desc 'Update stable branch on GitHub'
+task :update_stable do
+  if OrmAdapterCequel::VERSION =~ /^(\d+\.)+\d+$/ # Don't push for prerelease
+    system "git push -f origin HEAD:stable"
+  end
+end
+
+desc 'Push gem to repository'
+task :push do
+  system "gem push orm_adapter-cequel-#{OrmAdapterCequel::VERSION}.gem"
+end
+
+task 'Remove packaged gems'
+task :cleanup do
+  system "rm -v *.gem"
+end
+
+desc 'Check style with Rubocop'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib']
+  task.formatters = ['files']
+  task.fail_on_error = true
+end
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = './spec/examples/**/*_spec.rb'
+  t.rspec_opts = '--fail-fast'
+  t.fail_on_error = true
+end
+
+namespace :test do
+  desc 'Run the specs with progress formatter'
+  RSpec::Core::RakeTask.new(:concise) do |t|
+    t.pattern = './spec/examples/**/*_spec.rb'
+    t.rspec_opts = '--fail-fast --format=progress'
+    t.fail_on_error = true
+  end
+end

data/lib/cequel/record/orm_adapter.rb

@@ -0,0 +1,155 @@
+require 'cequel/record'
+require 'orm_adapter'
+
+module Cequel
+  module Record
+    module ClassMethods # rubocop:disable Documentation
+      include ::OrmAdapter::ToAdapter
+    end
+
+    #
+    # ORM adapter for Cequel, the Ruby ORM for Cassandra
+    #
+    class OrmAdapter < ::OrmAdapter::Base
+      extend Forwardable
+
+      #
+      # @return [Array<Symbol>] names of columns on this model
+      #
+      def column_names
+        klass.columns.map { |column| column.name }
+      end
+
+      #
+      # @param key_values [Array] values for each primary key column on this
+      #   record
+      # @return [Cequel::Record] a record instance corresponding to this
+      #   primary key
+      # @raise [Cequel::Record::RecordNotFound] if the key is not present
+      #
+      # @see #get
+      #
+      def get!(key_values)
+        klass.find(*key_values)
+      end
+
+      #
+      # @param key_values [Array] values for each primary key column on this
+      #   record
+      # @return [Cequel::Record] a record instance corresponding to this
+      #   primary key or nil if not present
+      #
+      # @see #get
+      #
+      def get(key_values)
+        get!(key_values)
+      rescue Cequel::Record::RecordNotFound
+        nil
+      end
+
+      #
+      # Find the first record instance with the given conditions
+      #
+      # @param options [Options] options for query
+      # @option options [Hash] :conditions map of column names to column
+      #   values. This can either be a one-element hash specifying a secondary
+      #   index lookup, or a mapping of primary key columns to values.
+      # @return [Cequel::Record] the first record matching the query, or nil if
+      #   none present
+      #
+      def find_first(options = {})
+        construct_scope(options).first
+      end
+
+      #
+      # Find all records with the given conditions and limit
+      #
+      # @param options [Options] options for query
+      # @option options [Hash] :conditions map of column names to column
+      #   values. This can either be a one-element hash specifying a secondary
+      #   index lookup, or a mapping of primary key columns to values.
+      # @option options [Integer] :limit maximum number of rows to return
+      # @return [Array<Cequel::Record>] all records matching the conditions
+      #
+      def find_all(options = {})
+        construct_scope(options).to_a
+      end
+
+      #
+      # @!method create!(attributes = {})
+      #   Create a new instance of the record class and save it to the database
+      #
+      #   @param attributes [Hash] map of column names to values
+      #   @return [Cequel::Record] the newly created
+      #   @raise [Cequel::Record::RecordInvalid] if the record fails
+      #     validations
+      #
+      def_delegator :klass, :create!
+
+      #
+      # Destroy the given record
+      #
+      # @param record [Cequel::Record] the record to destroy
+      # @return [void]
+      #
+      def destroy(record)
+        record.destroy
+      end
+
+      private
+
+      def construct_scope(options)
+        conditions, _, limit, _ =
+          extract_conditions!(options.deep_symbolize_keys)
+        scope = klass.all
+        scope = apply_secondary_index_scope(scope, conditions) ||
+          apply_primary_key_scope(scope, conditions)
+        scope = scope.limit(limit) if limit
+        scope
+      end
+
+      def extract_conditions!(options)
+        super.tap do |_, order, _, offset|
+          if order.present?
+            fail ArgumentError,
+                 "Cassandra does not support ordering of results by " \
+                 "arbitrary columns"
+          end
+          if offset.present?
+            fail ArgumentError, 'Cassandra does not support row offsets'
+          end
+        end
+      end
+
+      def apply_primary_key_scope(scope, conditions)
+        conditions = conditions.dup
+        conditions.assert_valid_keys(*klass.key_column_names)
+
+        klass.key_column_names.each do |column_name|
+          column_value = conditions.delete(column_name)
+          break unless column_value
+          scope = scope[column_value]
+        end
+
+        assert_conditions_empty!(conditions)
+
+        scope
+      end
+
+      def apply_secondary_index_scope(scope, conditions)
+        return unless conditions.one?
+        condition_column = klass.reflect_on_column(conditions.keys.first)
+        if condition_column.data_column? && condition_column.indexed?
+          scope.where(*conditions.first)
+        end
+      end
+
+      def assert_conditions_empty!(conditions)
+        unless conditions.empty?
+          fail ArgumentError,
+               "Invalid columns for conditions: #{conditions.keys.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/orm_adapter-cequel/version.rb

@@ -0,0 +1,3 @@
+module OrmAdapterCequel
+  VERSION = '1.0.0'
+end

data/lib/orm_adapter-cequel.rb

@@ -0,0 +1 @@
+require 'cequel/record/orm_adapter'

data/spec/examples/orm_adapter_spec.rb

@@ -0,0 +1,145 @@
+require_relative './spec_helper'
+
+describe Cequel::Record::OrmAdapter do
+  let!(:blog) { Blog.create!(subdomain: 'cassandra', name: 'Cassandra') }
+  let!(:posts) do
+    5.times.map do |i|
+      Post.create!(blog: blog, title: "Cequel #{i}")
+    end
+  end
+  let(:post) { posts.first }
+  let(:blog_adapter) { Blog.to_adapter }
+  let(:post_adapter) { Post.to_adapter }
+  subject { post_adapter }
+
+  its(:column_names) { should == [:blog_subdomain, :id, :title, :author_id] }
+
+  describe '#get!' do
+    it 'should get a simple primary key' do
+      blog_adapter.get!([blog.subdomain]).should == blog
+    end
+
+    it 'should get a simple primary key not specified as an array' do
+      blog_adapter.get!(blog.subdomain).should == blog
+    end
+
+    it 'should get a compound primary key' do
+      post_adapter.get!(post.key_values).should == post
+    end
+
+    it 'should raise an error if key not found' do
+      expect { blog_adapter.get!(['foo']) }.to raise_error
+    end
+  end
+
+  describe '#get' do
+    it 'should get a simple primary key' do
+      blog_adapter.get([blog.subdomain]).should == blog
+    end
+
+    it 'should return nil if key not found' do
+      blog_adapter.get(['foo']).should be_nil
+    end
+  end
+
+  describe '#find_first' do
+    let!(:other_post) do
+      Post.create!(blog_subdomain: 'postgres', title: 'Sequel', author_id: 1)
+    end
+
+    it 'should find first with no conditions' do
+      post_adapter.find_first.should == post
+    end
+
+    it 'should find first with conditions' do
+      post_adapter.find_first(conditions: {blog_subdomain: 'postgres'})
+        .should == other_post
+    end
+
+    it 'should find first with secondary index condition' do
+      post_adapter.find_first(conditions: {author_id: 1})
+        .should == other_post
+    end
+
+    it 'should accept bare conditions' do
+      post_adapter.find_first(blog_subdomain: 'postgres')
+        .should == other_post
+    end
+
+    it 'should raise an error if key prefix missing' do
+      expect { post_adapter.find_first(id: post.id) }
+        .to raise_error(ArgumentError)
+    end
+
+    it 'should raise an error if order passed' do
+      expect { post_adapter.find_first(
+        conditions: {blog_subdomain: 'postgres'}, order: [:title, :asc])}
+        .to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#find_all' do
+    let!(:other_posts) do
+      5.times.map do |i|
+        Post.create!(blog_subdomain: 'postgres', title: "Sequel #{i}",
+                     author_id: 1)
+      end
+    end
+
+    it 'should find all with no conditions' do
+      post_adapter.find_all.should =~ posts + other_posts
+    end
+
+    it 'should find all with conditions' do
+      post_adapter.find_all(conditions: {blog_subdomain: 'postgres'})
+        .should == other_posts
+    end
+
+    it 'should find all with bare conditions' do
+      post_adapter.find_all(blog_subdomain: 'postgres')
+        .should == other_posts
+    end
+
+    it 'should find first with secondary index condition' do
+      post_adapter.find_all(author_id: 1)
+        .should == other_posts
+    end
+
+    it 'should find all with limit' do
+      post_adapter.find_all(blog_subdomain: 'postgres', limit: 2)
+        .should == other_posts.first(2)
+    end
+
+    it 'should raise an error if key prefix missing' do
+      expect { post_adapter.find_all(id: post.id) }
+        .to raise_error(ArgumentError)
+    end
+
+    it 'should raise an error if order passed' do
+      expect { post_adapter.find_all(
+        conditions: {blog_subdomain: 'postgres'}, order: [:title, :asc]) }
+        .to raise_error(ArgumentError)
+    end
+
+    it 'should raise an error if offset passed' do
+      expect { post_adapter.find_all(
+        conditions: {blog_subdomain: 'postgres'}, offset: 2) }
+        .to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#create!' do
+    it 'should create instance' do
+      post = post_adapter.create!(blog: blog, title: 'New Post')
+      Post.find(*post.to_key).title.should == 'New Post'
+    end
+  end
+
+  describe '#destroy' do
+    it 'should destroy instance' do
+      post_adapter.destroy(post)
+      expect { Post.find(*post.to_key) }
+        .to raise_error(Cequel::Record::RecordNotFound)
+    end
+  end
+end

data/spec/examples/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler.require(:default, :development)
+
+RSpec.configure do |config|
+  config.before :all do
+    Cequel::Record.establish_connection(keyspace: 'orm_helper_cequel')
+    Cequel::Record.connection.schema.create!
+    Cequel::Record.connection.logger = Logger.new(STDOUT) if ENV['LOG_QUERIES']
+
+    Dir.glob(File.expand_path('../../models/**/*.rb', __FILE__)).each do |model|
+      require model
+      File.basename(model, '.rb').classify.constantize.synchronize_schema
+    end
+  end
+
+  config.after :each do
+    Dir.glob(File.expand_path('../../models/**/*.rb', __FILE__)).each do |model|
+      File.basename(model, '.rb').classify.constantize.destroy_all
+    end
+  end
+
+  config.after :all do
+    Cequel::Record.connection.schema.drop!
+  end
+end

data/spec/models/blog.rb

@@ -0,0 +1,8 @@
+class Blog
+  include Cequel::Record
+
+  key :subdomain, :ascii
+  column :name, :text
+
+  has_many :posts
+end

data/spec/models/post.rb

@@ -0,0 +1,8 @@
+class Post
+  include Cequel::Record
+
+  belongs_to :blog
+  key :id, :timeuuid, auto: true
+  column :title, :text
+  column :author_id, :int, index: true
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter-cequel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mat Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: cequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ORM adapter for Cequel, the CQL3 ORM for Ruby
+email:
+- mat.a.brown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cequel/record/orm_adapter.rb
+- lib/orm_adapter-cequel/version.rb
+- lib/orm_adapter-cequel.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- README.md
+- spec/examples/orm_adapter_spec.rb
+- spec/examples/spec_helper.rb
+- spec/models/blog.rb
+- spec/models/post.rb
+homepage: https://github.com/cequel/orm_adapter-cequel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: ORM adapter for Cequel
+test_files:
+- spec/examples/orm_adapter_spec.rb
+- spec/examples/spec_helper.rb
+- spec/models/blog.rb
+- spec/models/post.rb
+has_rdoc: