cassandra_object_rails 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjY5MDAwZDcwYmFlYmYxYjhjYWZlY2Y2YjNhZWM2MmI0YjQzN2Y2Yw==
+  data.tar.gz: !binary |-
+    MDRkMDJiYmE2OTg2ODhjZDlmYWYxMzk2ZjM4MmI2YjQ0YzA3ZTk4Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzA5YjVmZTI3MzUzYmJiNTI2YjAyMjM5OWRlNzc2NGE5M2M4MzRlN2NiMzli
+    NGE0MjA1OTAwMDNhOTY1NzZhMzEzMTA1OWJjZWNkMTgzMDI4NDE5YmZhYjY2
+    OGE3OTRjY2I3NmMxOWFlY2JhY2E4NmM5Yzk4ZDk3OWM2NGNmZDg=
+  data.tar.gz: !binary |-
+    NDE0YjU3ZTQ3NjY0MjU2MDkxZWM1M2JiMDI0ZjRjZjc0MDE4MDJiMTJlZDQ5
+    NDNlZGQ4NGUxY2NhNDdkNDk2ZWQ0OTExNmJmOWY3ZDU5ODY4M2Y5MjJlODcz
+    Njk2MDBjMmNmNzczNWUyYWEwYzI2YjlhOTUzODMyZWNkNGQ5ZTY=

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+*.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+services:
+  - cassandra
+rvm:
+  - 1.9.2
+  - 1.9.3
+env: CQLSH=/usr/local/cassandra/bin/cqlsh

data/CHANGELOG

@@ -0,0 +1,5 @@
+September 22th 2013 - cassandra_object_rails v0.0.1
+
+cassandra_object_rails gem released. This gem is an improvement of
+gotime-cassandra_object that offers a better rails integration and much more
+resources.

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'rake'
+gem 'mocha'
+# group :development, :test do
+#   gem 'pry'
+# end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2009 Koziarski Software Ltd
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [Michael Koziarski]
+
+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.rdoc

@@ -0,0 +1,97 @@
+== Cassandra Object Rails
+
+Cassandra Object uses ActiveModel to mimic much of the behavior in ActiveRecord.
+
+=== Installation
+
+Add the following to your Gemfile:
+
+  gem 'cassandra_object_rails'
+
+=== Defining Models
+
+  class Widget < CassandraObject::Base
+    string :name
+    string :description
+    integer :price
+    array :colors, unique: true
+
+    validates :name, presence: :true
+
+    before_create do
+      self.description = "#{name} is the best product ever"
+    end
+  end
+
+=== Connecting to the Server
+
+  CassandraObject::Base.config = {
+    keyspace: 'my_app_development',
+    servers: '127.0.0.1:9160',
+    thrift: {
+      timeout: 20,
+      retries: 2
+    }
+  }
+
+=== Connecting your rails application with Cassandra
+
+  in your config/cassandra.yml
+
+  development:
+    keyspace: 'my_app_development'
+    servers: '127.0.0.1:9160'
+
+  test:
+    keyspace: 'my_app_development'
+    servers: '127.0.0.1:9160'
+
+  production:
+    keyspace: 'my_app_development'
+    servers: '127.0.0.1:9160'
+
+
+=== Creating and updating records
+
+Cassandra Object has equivalent methods as ActiveRecord:
+
+  widget = Widget.new
+  widget.valid?
+  widget = Widget.create(name: 'Acme', price: 100)
+  widget.update_attribute(:price, 1200)
+  widget.update_attributes(price: 1200, name: 'Acme Corporation')
+  widget.attributes = {price: 300}
+  widget.price_was
+  widget.save
+  widget.save!
+
+=== Finding records
+
+  widget = Widget.find(uuid)
+  widget = Widget.first
+  widgets = Widget.all
+  Widget.find_each do |widget|
+    ...
+  end
+
+=== Query
+
+Some lightweight scoping features are available:
+
+  Widget.where('color' => 'red')
+  Widget.select(['name', 'color'])
+  Widget.limit(10)
+
+=== Keyspace
+
+Creating cassandra keyspace defined on cassandra.yml
+
+  rake cassandra:create
+
+Droping cassandra keyspace
+
+  rake cassandra:drop
+
+=== Adding column family
+
+  CassandraObject::Schema.create_column_family 'Widgets'

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'rake'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/unit/**/*_test.rb'
+  t.verbose = true
+end

data/cassandra_object_rails.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'cassandra_object_rails'
+  s.version = '0.0.1'
+  s.description = 'Cassandra ActiveModel'
+  s.summary = 'Cassandra ActiveModel'
+  s.authors = ["Lucas Allan Amorim"]
+  s.email = 'lucas.allan@gmail.com'
+  s.homepage = 'http://github.com/lucasallan/cassandra_object'
+
+  s.required_ruby_version     = '>= 1.9.2'
+  s.required_rubygems_version = '>= 1.3.5'
+
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('activemodel', '>= 3.0')
+  s.add_runtime_dependency('cassandra-cql')
+  s.add_runtime_dependency('thrift_client', '~> 0.9.2')
+  s.add_runtime_dependency('thin')
+
+  s.add_development_dependency('bundler')
+end

data/lib/cassandra_object/attribute_methods.rb

@@ -0,0 +1,87 @@
+module CassandraObject
+  module AttributeMethods
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    included do
+      if ActiveModel::VERSION::STRING < '3.2'
+        attribute_method_suffix("", "=")
+      else
+        attribute_method_suffix("=")
+      end
+
+      # (Alias for the protected read_attribute method).
+      def [](attr_name)
+        read_attribute(attr_name)
+      end
+
+      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
+      # (Alias for the protected write_attribute method).
+      def []=(attr_name, value)
+        write_attribute(attr_name, value)
+      end
+    end
+
+    module ClassMethods
+      def define_attribute_methods
+        return if attribute_methods_generated?
+        super(attribute_definitions.keys)
+        @attribute_methods_generated = true
+      end
+
+      def attribute_methods_generated?
+        @attribute_methods_generated ||= false
+      end
+    end
+
+    def write_attribute(name, value)
+      @attributes[name.to_s] = self.class.typecast_attribute(self, name, value)
+    end
+
+    def read_attribute(name)
+      @attributes[name.to_s]
+    end
+
+    def attribute_exists?(name)
+      @attributes.key?(name.to_s)
+    end
+
+    def attributes
+      Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
+    end
+
+    def attributes=(attributes)
+      attributes.each do |(name, value)|
+        send("#{name}=", value)
+      end
+    end
+
+    def method_missing(method_id, *args, &block)
+      if !self.class.attribute_methods_generated?
+        self.class.define_attribute_methods
+        send(method_id, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(*args)
+      self.class.define_attribute_methods unless self.class.attribute_methods_generated?
+      super
+    end
+
+    protected
+      def attribute_method?(name)
+        !!attribute_definitions[name.to_sym]
+      end
+
+    private
+      def attribute(name)
+        read_attribute(name)
+      end
+
+      def attribute=(name, value)
+        write_attribute(name, value)
+      end
+  end
+end

data/lib/cassandra_object/attribute_methods/definition.rb

@@ -0,0 +1,19 @@
+module CassandraObject
+  module AttributeMethods
+    class Definition
+      attr_reader :name, :coder
+      def initialize(name, coder, options)
+        @name   = name.to_s
+        @coder  = coder.new(options)
+      end
+
+      def instantiate(record, value)
+        value = value.nil? ? coder.default : value
+        return if value.nil?
+
+        value = value.kind_of?(String) ? coder.decode(value) : value
+        coder.wrap(record, name, value)
+      end
+    end
+  end
+end

data/lib/cassandra_object/attribute_methods/dirty.rb

@@ -0,0 +1,44 @@
+module CassandraObject
+  module AttributeMethods
+    module Dirty
+      extend ActiveSupport::Concern
+      include ActiveModel::Dirty
+
+      # Attempts to +save+ the record and clears changed attributes if successful.
+      def save(*) #:nodoc:
+        if status = super
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+        status
+      end
+
+      # Attempts to <tt>save!</tt> the record and clears changed attributes if successful.
+      def save!(*) #:nodoc:
+        super.tap do
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+      end
+
+      # <tt>reload</tt> the record and clears changed attributes.
+      def reload
+        super.tap do
+          @previously_changed.try :clear
+          @changed_attributes.try :clear
+        end
+      end
+
+      def write_attribute(name, value)
+        name = name.to_s
+        old = read_attribute(name)
+
+        super
+
+        unless attribute_changed?(name) || old == read_attribute(name)
+          changed_attributes[name] = old
+        end
+      end
+    end
+  end
+end

data/lib/cassandra_object/attribute_methods/primary_key.rb

@@ -0,0 +1,25 @@
+module CassandraObject
+  module AttributeMethods
+    module PrimaryKey
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def primary_key
+          'id'
+        end
+      end
+
+      def id
+        @id ||= self.class._generate_key(self)
+      end
+
+      def id=(id)
+        @id = id
+      end
+
+      def attributes
+        super.update(self.class.primary_key => id)
+      end
+    end
+  end
+end

data/lib/cassandra_object/attribute_methods/typecasting.rb

@@ -0,0 +1,59 @@
+module CassandraObject
+  module AttributeMethods
+    module Typecasting
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :attribute_definitions
+        self.attribute_definitions = {}
+
+        %w(array boolean date float integer json string time).each do |type|
+          instance_eval <<-EOV, __FILE__, __LINE__ + 1
+            def #{type}(*args)
+              options = args.extract_options!
+              args.each do |name|
+                attribute(name, options.merge(:type => :#{type}))
+              end
+            end
+          EOV
+        end
+      end
+
+      module ClassMethods
+        def inherited(child)
+          super
+          child.attribute_definitions = attribute_definitions.dup
+        end
+
+        #
+        # attribute :name, type: :string
+        # attribute :ammo, type: Ammo, coder: AmmoCodec
+        #
+        def attribute(name, options)
+          type  = options[:type]
+          coder = options[:coder]
+
+          if type.is_a?(Symbol)
+            coder = CassandraObject::Type.get_coder(type) || (raise "Unknown type #{type}")
+          elsif coder.nil?
+            raise "Must supply a :coder for #{name}"
+          end
+
+          attribute_definitions[name.to_sym] = AttributeMethods::Definition.new(name, coder, options)
+        end
+
+        def typecast_attribute(record, name, value)
+          if attribute_definition = attribute_definitions[name.to_sym]
+            attribute_definition.instantiate(record, value)
+          else
+            raise NoMethodError, "Unknown attribute #{name.inspect}"
+          end
+        end
+
+        def coder_for(attribute)
+          attribute_definitions[attribute.to_sym].coder
+        end
+      end
+    end
+  end
+end